Adding types and updating ci

.github/workflows/node.js.yml

@@ -0,0 +1,30 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm test

lib/index.d.ts

@@ -0,0 +1,45 @@
+export = UuidEncoder;
+declare class UuidEncoder {
+    /**
+     * @private
+     * @param {string} baseEncodingStr
+     * @returns {string}
+     */
+    private static resolveEncodingStr;
+    /**
+     * @public
+     * @param {string} baseEncodingStr
+     * @returns {boolean}
+     */
+    public static isCaseSensitiveBase(baseEncodingStr: string): boolean;
+    /**
+     * @public
+     * @param {string} baseEncodingStr A string containing all usable letters for encoding
+     * @constructor
+     */
+    constructor(baseEncodingStr?: string);
+    /**
+     * Set encoding base
+     * @param {string} baseEncodingStr A string containing all usable letters for encoding
+     * @public
+     */
+    public setBaseEncodingStr(baseEncodingStr: string): void;
+    encStr: string;
+    isCaseSensitive: boolean;
+    base: number;
+    /**
+     * Encode a UUID
+     * @param {string} uuid Properly formatted UUID
+     * @returns {string} Encoded UUID
+     * @public
+     */
+    public encode(uuid: string): string;
+    /**
+     * Decode an encoded UUID
+     * @public
+     * @param {string} str Previously encoded string
+     * @returns {string} Properly formatted UUID
+     * @throws Throws an {Error} when encountering invalid data
+     */
+    public decode(str: string): string;
+}

lib/index.js

@@ -29,7 +29,7 @@ const caseSensitiveBases = {
 class UuidEncoder {
   /**
    * @public
-   * @param [baseEncodingStr] A string containing all usable letters for encoding
+   * @param {string} baseEncodingStr A string containing all usable letters for encoding
    * @constructor
    */
   constructor(baseEncodingStr = 'base36') {
@@ -60,7 +60,7 @@ class UuidEncoder {
 
   /**
    * @public
-   * @param baseEncodingStr
+   * @param {string} baseEncodingStr
    * @returns {boolean}
    */
   static isCaseSensitiveBase(baseEncodingStr) {

package.json

@@ -3,8 +3,10 @@
   "version": "1.2.0",
   "description": "Encode UUIDs into Base36 or any other system",
   "main": "lib/index.js",
+  "types": "lib/types.d.ts",
   "scripts": {
-    "test": "mocha --recursive test/"
+    "test": "mocha --recursive test/",
+    "types": "tsc --emitDeclarationOnly --allowJs --declaration lib/index.js"
   },
   "repository": {
     "type": "git",