[v8] Add ESM / CJS dual build (#1287)

Author: nicknisi

README.md

@@ -11,14 +11,14 @@ See the [API Reference](https://workos.com/docs/reference/client-libraries) for
 
 ## Requirements
 
-Node 16 or higher.
+Node 18 or higher.
 
 ## Installation
 
 Install the package with:
 
 ```
-npm i @workos-inc/node
+npm install @workos-inc/node
 ```
 
 ## Configuration

eslint.config.mjs

@@ -33,6 +33,19 @@ export default tseslint.config(
       'n/no-unsupported-features/node-builtins': 'off',
     },
   },
+  {
+    files: ['**/*.cjs'],
+    languageOptions: {
+      globals: {
+        require: 'readonly',
+        module: 'readonly',
+        __dirname: 'readonly',
+        __filename: 'readonly',
+        exports: 'readonly',
+        process: 'readonly',
+      },
+    },
+  },
   {
     files: tests,
     extends: [jestPlugin.configs['flat/recommended']],
@@ -43,6 +56,7 @@ export default tseslint.config(
       'jest/no-disabled-tests': 'off',
       'jest/no-conditional-expect': 'off',
       'jest/valid-expect': 'off',
+      'jest/expect-expect': 'off',
     },
   },
 );

jest-transform-esm.js jest-transform-esm.cjsjest-transform-esm.js renamed to jest-transform-esm.cjs

@@ -1,3 +1,4 @@
+/* eslint-env node */
 const babelJest = require('babel-jest');
 
 module.exports = babelJest.createTransformer({

jest.config.js jest.config.cjsjest.config.js renamed to jest.config.cjs

@@ -1,3 +1,4 @@
+/* eslint-env node */
 module.exports = {
   clearMocks: true,
   resetMocks: true,
@@ -9,12 +10,9 @@ module.exports = {
   setupFilesAfterEnv: ['./setup-jest.ts'],
   transform: {
     '^.+\\.ts?$': 'ts-jest',
-    '^.+\\.m?js$': '<rootDir>/jest-transform-esm.js',
+    '^.+\\.m?js$': '<rootDir>/jest-transform-esm.cjs',
   },
   transformIgnorePatterns: [
-    '/node_modules/(?!(iron-session|uncrypto|cookie-es)/).+\\.m?js$',
+    'node_modules/(?!(iron-session|uncrypto|cookie-es|@noble|@scure|jose)/)',
   ],
-  moduleNameMapper: {
-    '^jose': require.resolve('jose'),
-  },
 };

package.json

@@ -11,9 +11,13 @@
   "engines": {
     "node": ">=18"
   },
-  "typings": "lib/index.d.ts",
+  "type": "module",
+  "main": "./lib/index.cjs",
+  "module": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "files": [
-    "lib/"
+    "lib/",
+    "package.json"
   ],
   "repository": {
     "type": "git",
@@ -24,7 +28,8 @@
   },
   "scripts": {
     "clean": "rm -rf lib",
-    "build": "tsc -p .",
+    "build": "tsup",
+    "build:watch": "tsup --watch",
     "lint": "eslint",
     "test": "jest",
     "test:watch": "jest --watch",
@@ -45,7 +50,6 @@
     "@babel/preset-env": "^7.26.9",
     "@babel/preset-typescript": "^7.27.0",
     "@eslint/js": "^9.21.0",
-    "@peculiar/webcrypto": "^1.4.5",
     "@types/cookie": "^0.6.0",
     "@types/jest": "^29.5.14",
     "@types/node": "~18",
@@ -62,22 +66,31 @@
     "prettier": "^3.5.3",
     "supertest": "7.1.0",
     "ts-jest": "29.3.1",
+    "tsup": "^8.5.0",
     "typescript": "5.8.2",
     "typescript-eslint": "^8.25.0"
   },
   "exports": {
-    "types": "./lib/index.d.ts",
-    "workerd": {
-      "import": "./lib/index.worker.js",
-      "default": "./lib/index.worker.js"
+    ".": {
+      "types": "./lib/index.d.ts",
+      "workerd": {
+        "import": "./lib/index.worker.js",
+        "require": "./lib/index.worker.cjs"
+      },
+      "edge-light": {
+        "import": "./lib/index.worker.js",
+        "require": "./lib/index.worker.cjs"
+      },
+      "import": "./lib/index.js",
+      "require": "./lib/index.cjs",
+      "default": "./lib/index.js"
     },
-    "edge-light": {
+    "./worker": {
+      "types": "./lib/index.worker.d.ts",
       "import": "./lib/index.worker.js",
+      "require": "./lib/index.worker.cjs",
       "default": "./lib/index.worker.js"
     },
-    "default": {
-      "import": "./lib/index.js",
-      "default": "./lib/index.js"
-    }
+    "./package.json": "./package.json"
   }
 }

setup-jest.ts

@@ -1,9 +1,9 @@
 import { enableFetchMocks } from 'jest-fetch-mock';
-import { Crypto } from '@peculiar/webcrypto';
+import { webcrypto } from 'crypto';
 
 enableFetchMocks();
 
-// Assign Node's Crypto to global.crypto if it is not already present
+// Make Node's crypto.webcrypto available as global.crypto for tests
 if (!global.crypto) {
-  global.crypto = new Crypto();
+  global.crypto = webcrypto as unknown as Crypto;
 }

src/user-management/user-management.spec.ts

@@ -873,6 +873,16 @@ describe('UserManagement', () => {
   });
 
   describe('authenticateWithSessionCookie', () => {
+    const OLD_ENV = process.env;
+
+    beforeEach(() => {
+      process.env = { ...OLD_ENV };
+      delete process.env.WORKOS_COOKIE_PASSWORD;
+    });
+
+    afterEach(() => {
+      process.env = OLD_ENV;
+    });
     beforeEach(() => {
       // Mock createRemoteJWKSet
       jest
@@ -1074,6 +1084,16 @@ describe('UserManagement', () => {
   });
 
   describe('getSessionFromCookie', () => {
+    const OLD_ENV = process.env;
+
+    beforeEach(() => {
+      process.env = { ...OLD_ENV };
+      delete process.env.WORKOS_COOKIE_PASSWORD;
+    });
+
+    afterEach(() => {
+      process.env = OLD_ENV;
+    });
     it('throws an error when the cookie password is undefined', async () => {
       await expect(
         workos.userManagement.getSessionFromCookie({

src/worker.spec.ts

@@ -2,8 +2,8 @@
  * @jest-environment miniflare
  */
 
-import { WorkOS } from './index.worker';
-
-test.skip('WorkOS is initialized without errors', () => {
-  expect(() => new WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU')).not.toThrow();
+describe('Worker', () => {
+  test.skip('WorkOS is initialized without errors', () => {
+    // Skipped test - miniflare environment has issues with ESM modules
+  });
 });

src/workos.spec.ts

@@ -32,6 +32,7 @@ describe('WorkOS', () => {
 
     describe('when no API key is provided', () => {
       it('throws a NoApiKeyFoundException error', async () => {
+        delete process.env.WORKOS_API_KEY;
         expect(() => new WorkOS()).toThrowError(NoApiKeyProvidedException);
       });
     });

tsconfig.json

@@ -19,4 +19,4 @@
     "types": ["jest", "jest-environment-miniflare/globals"]
   },
   "include": ["src"]
-}
+}