Merge pull request #104 from smarty/andrew/tsConfig2

updates sdk to handle typescript

Author: smartyandrewb

.github/workflows/node-tests.yml

@@ -22,6 +22,7 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm ci
+    - run: npm run build
     - run: npm test
       env:
         CI: true

.gitignore

@@ -4,4 +4,5 @@ __MACOSX
 /.idea/
 /node_modules/
 /dist/
-.env
+.env
+.rollup.cache/

package-lock.json

@@ -28,6 +28,7 @@
  ],
  "main": "dist/cjs/index.cjs",
  "module": "dist/esm/index.mjs",
+ "types": "dist/types/index.d.ts",
  "exports": {
   ".": {
    "import": "./dist/esm/index.mjs",
@@ -45,18 +46,21 @@
   "url": "github:smartystreets/smartystreets-javascript-sdk"
  },
  "devDependencies": {
-  "@babel/preset-env": "^7.25.8",
-  "@rollup/plugin-commonjs": "^28.0.1",
+  "@babel/preset-env": "^7.27.2",
+  "@rollup/plugin-commonjs": "^28.0.3",
   "@rollup/plugin-json": "^6.1.0",
-  "@rollup/plugin-node-resolve": "^15.3.0",
+  "@rollup/plugin-node-resolve": "^16.0.1",
   "@rollup/plugin-terser": "^0.4.4",
+  "@rollup/plugin-typescript": "^12.1.2",
+  "@types/node": "^22.15.17",
   "chai": "^4.3.6",
-  "mocha": "^10.2.0",
-  "rollup": "^4.22.5",
-  "rollup-plugin-delete": "^2.1.0"
+  "mocha": "^11.2.2",
+  "rollup": "^4.40.2",
+  "rollup-plugin-delete": "^3.0.1",
+  "typescript": "^5.8.3"
  },
  "dependencies": {
-  "axios": "^1.7.7",
+  "axios": "^1.9.0",
   "axios-retry": "^4.5.0"
  }
 }

package.json

@@ -2,27 +2,29 @@ import del from "rollup-plugin-delete";
 import commonjs from "@rollup/plugin-commonjs";
 import json from "@rollup/plugin-json";
 import terser from "@rollup/plugin-terser";
-import { nodeResolve } from '@rollup/plugin-node-resolve';
+import { nodeResolve } from "@rollup/plugin-node-resolve";
+import typescript from "@rollup/plugin-typescript";
 
 export default {
   input: "index.mjs",
   external: ["axios", "axios-retry"],
   output: [
     {
-      dir: "dist/cjs",
-      format: "cjs",
+      dir: "dist",
+      format: "esm",
       preserveModules: true,
       preserveModulesRoot: "src",
       exports: "named",
-      entryFileNames: "[name].cjs",
+      entryFileNames: "esm/[name].mjs",
     },
     {
-      dir: "dist/esm",
-      format: "esm",
+      dir: "dist",
+      format: "cjs",
       preserveModules: true,
       preserveModulesRoot: "src",
       exports: "named",
-      entryFileNames: "[name].mjs",
+      esModule: false,
+      entryFileNames: "cjs/[name].cjs",
     },
   ],
   plugins: [
@@ -33,5 +35,11 @@ export default {
     }),
     json(),
     terser(),
+    typescript({
+      declaration: true,
+      emitDeclarationOnly: true,
+      outDir: "dist/types",
+      rootDir: "src"
+    }),
   ],
 };

rollup.config.mjs

@@ -9,7 +9,7 @@ const StatusCodeSender = require("./StatusCodeSender");
 const LicenseSender = require("./LicenseSender");
 const BadCredentialsError = require("./Errors").BadCredentialsError;
 const RetrySender = require("./RetrySender.js");
-const Sleeper = require("./util/Sleeper.js");
+const Sleeper = require("./util/Sleeper.ts");
 
 //TODO: refactor this to work more cleanly with a bundler.
 const UsStreetClient = require("./us_street/Client");

src/ClientBuilder.js

@@ -0,0 +1,6 @@
+export default class Sleeper {
+	constructor () {}
+	sleep(seconds: number) {
+		return new Promise<void>((resolve)  => setTimeout(resolve, seconds*1000));
+	}
+}

src/util/Sleeper.js

@@ -1,5 +1,5 @@
 import { expect } from "chai"; // Importing expect directly from chai
-import SmartySDK from "../index.mjs"; // Importing SmartySDK
+import SmartySDK from "../dist/esm/index.mjs"; // Importing SmartySDK
 
 describe("Extract example test", () => {
   const authId = "";

src/util/Sleeper.ts

@@ -1,7 +1,6 @@
 const chai = require("chai");
 const expect = chai.expect;
 const Client = require("../../src/us_street/Client");
-const ClientBuilder = require("../../src/ClientBuilder");
 const Lookup = require("../../src/us_street/Lookup");
 const Candidate = require("../../src/us_street/Candidate");
 const Batch = require("../../src/Batch");