feat: migrate to typescript

jukbot · Sep 17, 2024 · 590e97b · 590e97b
1 parent 137289e
commit 590e97b
Show file tree

Hide file tree

Showing 29 changed files with 261 additions and 153 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,7 @@ coverage/
 npm-debug.log
 package-lock.json
 .nyc_output
+.idea
+.vscode
+.DS_Store
+coverage.lcov
diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml
diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/project.iml b/.idea/project.iml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/.npmignore b/.npmignore
@@ -1,6 +1,15 @@
 .editorconfig
 .npmignore
+.vscode
+.eslintrc
+.nycrc
 .travis.yml
+.bower.json
+.nyc_output
 package-lock.json
-docs/
-jest_result.png
+test-result.png
+tests
+example
+coverage
+node_modules
+coverage.lcov
diff --git a/.nycrc b/.nycrc
@@ -0,0 +1,13 @@
+{
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "tests/*.test.js"
+  ],
+  "all": true,
+  "sourceMap": true,
+  "cache": false,
+  "check-coverage": true,
+  "extension": [".ts"]
+}
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
-![](https://socialify.git.ci/jukbot/thai-citizen-id-validator/image?description=1&language=1&pattern=Signal&theme=Light)
-
 # Thai Citizen ID Validator
 
+![thai-citizen-id-validator](https://socialify.git.ci/jukbot/thai-citizen-id-validator/image?description=1&font=Inter&language=1&name=1&pattern=Signal&stargazers=1&theme=Light)
+
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/d49ee28fb17b476baeb9387e6888b751)](https://app.codacy.com/gh/jukbot/thai-citizen-id-validator/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/d49ee28fb17b476baeb9387e6888b751)](https://app.codacy.com/gh/jukbot/thai-citizen-id-validator/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
 [![NPM Download](https://img.shields.io/npm/dt/thai-id-validator.svg)](https://www.npmjs.com/package/thai-id-validator)
@@ -10,9 +10,14 @@
 
 A simpler way to validate Thai Citizen Card ID. 🇹🇭
 
-## Further Plans
+## Minimum Node.js Version ⚠️
+
+This package requires Node.js version 16 or later.
+
+## Future Roadmap
 
 - Go Language Implementation Example
+- .NET Language Implementation Example
 - Thai Passport Number Validation
 
 ## Read the article
@@ -39,39 +44,25 @@ $ bun add thai-id-validator
 
 ## Usage
 
-### Javascipt ES5
-
-Just import script with commonjs
-
-```javascript
-var validateThaiID = require('thai-id-validator') // for ES5
-
-var result = validateThaiID(‘1101700207030’);
-
-console.log(result);
-// return true
-```
-
-### Javascript ES6 Module
+### Javascript
 
 In Javascript file, you can use import, export modules
 
 ```javascript
-'use strict';
 import validateThaiID from 'thai-id-validator';
 
 let result = validateThaiID(‘1101700207030’);
 
 console.log(result);
-// return true
+// true
 ```
 
 ## Test
 
 To run all test cases run the following command
 
 ```bash
-npm run test
+bun run test
 ```
 
 You can edit validator.test.js too add your custom test case.
@@ -121,6 +112,6 @@ If you found any 🐞 or feedback, please report the issue [here](https://github
 
 ## License
 
-[Apache2.0](https://www.apache.org/licenses/LICENSE-2.0)
+[MIt](https://opensource.org/license/mit)
 
 Code with love 🦉
diff --git a/bun.lockb b/bun.lockb
diff --git a/bunfig.toml b/bunfig.toml
diff --git a/dist/assets/index-Bjn-ATP8.css b/dist/assets/index-Bjn-ATP8.css
diff --git a/dist/assets/index-ByB4O58P.js b/dist/assets/index-ByB4O58P.js
diff --git a/dist/browser/validator.js b/dist/browser/validator.js
diff --git a/dist/esm/validator.js b/dist/esm/validator.js
diff --git a/dist/index.html b/dist/index.html
@@ -0,0 +1,139 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <meta
+      name="description"
+      content="Example Thai Citizen ID Input Validation with WCAG Support"
+    />
+    <meta name="author" content="Chukkrit V." />
+    <title>Thai Citizen ID Input Validation</title>
+    <script
+      src="https://cdnjs.cloudflare.com/ajax/libs/imask/7.1.3/imask.min.js"
+      crossorigin="anonymous"
+      referrerpolicy="no-referrer"
+    ></script>
+    <script type="module" crossorigin src="./assets/index-ByB4O58P.js"></script>
+    <link rel="stylesheet" crossorigin href="./assets/index-Bjn-ATP8.css">
+  </head>
+
+  <body>
+    <a
+      href="https://github.com/jukbot/thai-citizen-id-validator"
+      class="github-corner"
+      aria-label="View source on Github"
+    >
+      <svg
+        width="80"
+        height="80"
+        viewBox="0 0 250 250"
+        style="
+          fill: #151513;
+          color: #fff;
+          position: absolute;
+          top: 0;
+          border: 0;
+          right: 0;
+        "
+        aria-hidden="true"
+      >
+        <path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
+        <path
+          d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2"
+          fill="currentColor"
+          style="transform-origin: 130px 106px"
+          class="octo-arm"
+        ></path>
+        <path
+          d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z"
+          fill="currentColor"
+          class="octo-body"
+        ></path>
+      </svg>
+    </a>
+    <style>
+      .github-corner:hover .octo-arm {
+        animation: octocat-wave 560ms ease-in-out;
+      }
+
+      @keyframes octocat-wave {
+        0%,
+        100% {
+          transform: rotate(0);
+        }
+        20%,
+        60% {
+          transform: rotate(-25deg);
+        }
+        40%,
+        80% {
+          transform: rotate(10deg);
+        }
+      }
+
+      @media (max-width: 500px) {
+        .github-corner:hover .octo-arm {
+          animation: none;
+        }
+        .github-corner .octo-arm {
+          animation: octocat-wave 560ms ease-in-out;
+        }
+      }
+    </style>
+    <section>
+      <h1>Thai Citizen ID Validation with WCAG Standard</h1>
+
+      <h2>ตรวจสอบความถูกต้องเลขบัตรประชาชน</h2>
+
+      <form id="validator-form" action="/target" method="post">
+        <label class="label" id="InputLabel" for="citizenid"
+          >Enter your 🇹🇭 citizen ID</label
+        >
+        <input
+          class="input"
+          id="citizenid"
+          type="text"
+          name="citizenid"
+          placeholder="X-XXXX-XXXXX-XX-X"
+          autocomplete="off"
+          autofocus
+          title="citizen ID Input"
+          aria-labelledby="InputLabel"
+          aria-invalid
+          aria-required="true"
+          required
+          tabindex="1"
+        />
+        <button
+          type="submit"
+          id="button"
+          value="confirm"
+          tabindex="2"
+          aria-label="Submit"
+          disabled
+        >
+          Submit 🕵️‍♀️
+        </button>
+      </form>
+      <div
+        class="text error"
+        id="errorMessage"
+        aria-hidden="true"
+        aria-label="Invalid ID"
+        role="alert"
+      >
+        <p>ID is invalid format ❌</p>
+      </div>
+      <div
+        class="text success"
+        id="successMessage"
+        aria-hidden="true"
+        aria-label="Valid ID"
+        role="alert"
+      >
+        <p>ID is valid format ✅</p>
+      </div>
+    </section>
+  </body>
+</html>
diff --git a/dist/validator.es.js b/dist/validator.es.js
diff --git a/dist/validator.umd.js b/dist/validator.umd.js
diff --git a/docs/js/script.js b/docs/js/script.js
@@ -1,4 +1,4 @@
-import validateThaiID from '../../lib/validator'
+import validateThaiID from '../../dist/browser/validator.js'
 
 document.addEventListener('DOMContentLoaded', () => {
   const input = document.getElementById('citizenid')

diff --git a/global.d.ts b/global.d.ts
diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,9 @@
+declare function isValidThaiID(input: string | number): boolean;
+
+export interface Window {
+    isValidThaiID: typeof isValidThaiID;
+}
+
+export as namespace isValidThaiID;
+export { isValidThaiID };
+export default isValidThaiID;