produce TS types

.github/workflows/npm-publish.yml

@@ -54,6 +54,7 @@ jobs:
           npm ci
           npm run fmt:check
           npm run lint
+          npm run build
           npm run test
       - run: npm publish
         env:

.github/workflows/push.yml

@@ -50,6 +50,7 @@ jobs:
           npm ci
           npm run fmt:check
           npm run lint
+          npm run build
           npm run test
           ./clapp migrate down
       - run: ./clapp deinit -v

.gitignore

@@ -1,5 +1,6 @@
 /node_modules
 /coverage
+/types
 
 # misc
 .DS_Store

lib/index.js

@@ -4,6 +4,10 @@ import util from "node:util";
 import Redis from "ioredis";
 import mysql from "mysql";
 
+/**
+ * @typedef {import('ioredis').Cluster} RedisCluster
+ */
+
 function resolveEndpoint(shard) {
   let portNum = 3306 - 1 + shard;
   if (process.env[`DB_SHARD_${shard}_INTERNAL_PORT`]) {
@@ -79,8 +83,32 @@ export class DB {
   }
 }
 
+//eslint-disable-next-line no-unused-vars
+class MEMConfig {
+  /**
+   * @type {string}
+   */
+  MEM_SHARD_1_INTERNAL_HOST;
+  /**
+   * @type {string}
+   */
+  MEM_SHARD_2_INTERNAL_HOST;
+  /**
+   * @type {string}
+   */
+  MEM_SHARD_3_INTERNAL_HOST;
+  /**
+   * @type {number}
+   */
+  MEM_INTERNAL_PORT;
+}
+
 export class MEM {
   #conf;
+  /**
+   * constructor.
+   * @param {MEMConfig} [conf]
+   */
   constructor(conf) {
     if (!conf) {
       conf = {
@@ -107,7 +135,7 @@ export class MEM {
 
   /**
    * connect.
-   * @returns {Promise<Redis.Cluster>}
+   * @returns {Promise<RedisCluster>}
    */
   async connect() {
     const ports = [

package.json

@@ -1,10 +1,12 @@
 {
   "name": "@clusterlean/clusterlean-sdk-js",
   "version": "0.3.5",
-  "main": "lib/index.js",
+  "main": "./lib/index.js",
   "type": "module",
+  "types": "./types/index.d.ts",
   "scripts": {
-    "lint": "eslint --max-warnings=0 '{src,test}/**/*.{js,jsx}' && tsc -p ./jsconfig.json",
+    "build": "tsc --declaration --emitDeclarationOnly --outDir types --allowJs --declarationMap lib/index.js",
+    "lint": "eslint --max-warnings=0 '{src,test}/**/*.{js,jsx}' && tsc --noEmit -p ./tsconfig.json",
     "test": "mocha 'test/**/*.spec.{js,jsx}'",
     "test:watch": "npm run test -- --watch --watch-files src,test",
     "fmt:base": "prettier '{src,test}/**/*.{js,jsx}'",
@@ -43,14 +45,6 @@
   },
   "license": "MIT",
   "description": "Clusterlean App SDK for JavaScript",
-  "files": [
-    "lib"
-  ],
-  "keywords": [
-    "api",
-    "clusterlean",
-    "db",
-    "memory",
-    "sql"
-  ]
+  "files": ["lib", "types"],
+  "keywords": ["api", "clusterlean", "db", "memory", "sql"]
 }

jsconfig.json → tsconfig.json

@@ -1,14 +1,14 @@
 {
   "compilerOptions": {
+    "typeRoots": ["./types", "./node_modules/@types"],
     "baseUrl": ".",
     "moduleResolution": "nodenext",
     "checkJs": true,
     "explainFiles": false,
     "target": "esnext",
     "module": "nodenext",
     "strictNullChecks": true,
-    "resolveJsonModule": true,
-    "noEmit": true
+    "resolveJsonModule": true
   },
-  "exclude": ["node_modules"]
+  "exclude": ["node_modules", "types"]
 }