@workos-inc/node 8.0.0-beta.2 → 8.0.0-beta.4

package/lib/workos.spec.js

@@ -0,0 +1,336 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const jest_fetch_mock_1 = __importDefault(require("jest-fetch-mock"));
+const test_utils_1 = require("./common/utils/test-utils");
+const promises_1 = __importDefault(require("fs/promises"));
+const exceptions_1 = require("./common/exceptions");
+const parse_error_1 = require("./common/exceptions/parse-error");
+const index_1 = require("./index");
+const index_worker_1 = require("./index.worker");
+const rate_limit_exceeded_exception_1 = require("./common/exceptions/rate-limit-exceeded.exception");
+const fetch_client_1 = require("./common/net/fetch-client");
+const node_client_1 = require("./common/net/node-client");
+const subtle_crypto_provider_1 = require("./common/crypto/subtle-crypto-provider");
+describe('WorkOS', () => {
+    beforeEach(() => jest_fetch_mock_1.default.resetMocks());
+    describe('constructor', () => {
+        const OLD_ENV = process.env;
+        beforeEach(() => {
+            jest.resetModules();
+            process.env = Object.assign({}, OLD_ENV);
+            delete process.env.NODE_ENV;
+        });
+        afterEach(() => {
+            process.env = OLD_ENV;
+        });
+        describe('when no API key is provided', () => {
+            it('throws a NoApiKeyFoundException error', () => __awaiter(void 0, void 0, void 0, function* () {
+                expect(() => new index_1.WorkOS()).toThrowError(exceptions_1.NoApiKeyProvidedException);
+            }));
+        });
+        describe('when API key is provided with environment variable', () => {
+            it('initializes', () => __awaiter(void 0, void 0, void 0, function* () {
+                process.env.WORKOS_API_KEY = 'sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU';
+                expect(() => new index_1.WorkOS()).not.toThrow();
+            }));
+        });
+        describe('when API key is provided with constructor', () => {
+            it('initializes', () => __awaiter(void 0, void 0, void 0, function* () {
+                expect(() => new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU')).not.toThrow();
+            }));
+        });
+        describe('with https option', () => {
+            it('sets baseURL', () => {
+                const workos = new index_1.WorkOS('foo', { https: false });
+                expect(workos.baseURL).toEqual('http://api.workos.com');
+            });
+        });
+        describe('with apiHostname option', () => {
+            it('sets baseURL', () => {
+                const workos = new index_1.WorkOS('foo', { apiHostname: 'localhost' });
+                expect(workos.baseURL).toEqual('https://localhost');
+            });
+        });
+        describe('with port option', () => {
+            it('sets baseURL', () => {
+                const workos = new index_1.WorkOS('foo', {
+                    apiHostname: 'localhost',
+                    port: 4000,
+                });
+                expect(workos.baseURL).toEqual('https://localhost:4000');
+            });
+        });
+        describe('when the `config` option is provided', () => {
+            it('applies the configuration to the fetch client', () => __awaiter(void 0, void 0, void 0, function* () {
+                (0, test_utils_1.fetchOnce)('{}', { headers: { 'X-Request-ID': 'a-request-id' } });
+                const workos = new index_1.WorkOS('sk_test', {
+                    config: {
+                        headers: {
+                            'X-My-Custom-Header': 'Hey there!',
+                        },
+                    },
+                });
+                yield workos.post('/somewhere', {});
+                expect((0, test_utils_1.fetchHeaders)()).toMatchObject({
+                    'X-My-Custom-Header': 'Hey there!',
+                });
+            }));
+        });
+        describe('when the `appInfo` option is provided', () => {
+            it('applies the configuration to the fetch client user-agent', () => __awaiter(void 0, void 0, void 0, function* () {
+                (0, test_utils_1.fetchOnce)('{}');
+                const packageJson = JSON.parse(yield promises_1.default.readFile('package.json', 'utf8'));
+                const workos = new index_1.WorkOS('sk_test', {
+                    appInfo: {
+                        name: 'fooApp',
+                        version: '1.0.0',
+                    },
+                });
+                yield workos.post('/somewhere', {});
+                expect((0, test_utils_1.fetchHeaders)()).toMatchObject({
+                    'User-Agent': `workos-node/${packageJson.version}/fetch fooApp: 1.0.0`,
+                });
+            }));
+        });
+        describe('when no `appInfo` option is provided', () => {
+            it('adds the HTTP client name to the user-agent', () => __awaiter(void 0, void 0, void 0, function* () {
+                (0, test_utils_1.fetchOnce)('{}');
+                const packageJson = JSON.parse(yield promises_1.default.readFile('package.json', 'utf8'));
+                const workos = new index_1.WorkOS('sk_test');
+                yield workos.post('/somewhere', {});
+                expect((0, test_utils_1.fetchHeaders)()).toMatchObject({
+                    'User-Agent': `workos-node/${packageJson.version}/fetch`,
+                });
+            }));
+        });
+        describe('when no `appInfo` option is provided', () => {
+            it('adds the HTTP client name to the user-agent', () => __awaiter(void 0, void 0, void 0, function* () {
+                (0, test_utils_1.fetchOnce)('{}');
+                const packageJson = JSON.parse(yield promises_1.default.readFile('package.json', 'utf8'));
+                const workos = new index_1.WorkOS('sk_test');
+                yield workos.post('/somewhere', {});
+                expect((0, test_utils_1.fetchHeaders)()).toMatchObject({
+                    'User-Agent': `workos-node/${packageJson.version}/fetch`,
+                });
+            }));
+        });
+        describe('when using an environment that supports fetch', () => {
+            it('automatically uses the fetch HTTP client', () => {
+                const workos = new index_1.WorkOS('sk_test');
+                // Bracket notation gets past private visibility
+                // tslint:disable-next-line
+                expect(workos['client']).toBeInstanceOf(fetch_client_1.FetchHttpClient);
+            });
+        });
+    });
+    describe('version', () => {
+        it('matches the version in `package.json`', () => __awaiter(void 0, void 0, void 0, function* () {
+            const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+            // Read `package.json` using file I/O instead of `require` so we don't run
+            // into issues with the `require` cache.
+            const packageJson = JSON.parse(yield promises_1.default.readFile('package.json', 'utf8'));
+            expect(workos.version).toBe(packageJson.version);
+        }));
+    });
+    describe('post', () => {
+        describe('when the api responds with a 404', () => {
+            it('throws a NotFoundException', () => __awaiter(void 0, void 0, void 0, function* () {
+                const message = 'Not Found';
+                (0, test_utils_1.fetchOnce)({ message }, { status: 404, headers: { 'X-Request-ID': 'a-request-id' } });
+                const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.post('/path', {})).rejects.toStrictEqual(new exceptions_1.NotFoundException({
+                    message,
+                    path: '/path',
+                    requestID: 'a-request-id',
+                }));
+            }));
+            it('preserves the error code, status, and message from the underlying response', () => __awaiter(void 0, void 0, void 0, function* () {
+                const message = 'The thing you are looking for is not here.';
+                const code = 'thing-not-found';
+                (0, test_utils_1.fetchOnce)({ code, message }, { status: 404, headers: { 'X-Request-ID': 'a-request-id' } });
+                const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.post('/path', {})).rejects.toMatchObject({
+                    code,
+                    message,
+                    status: 404,
+                });
+            }));
+            it('includes the path in the message if there is no message in the response', () => __awaiter(void 0, void 0, void 0, function* () {
+                const code = 'thing-not-found';
+                const path = '/path/to/thing/that-aint-there';
+                (0, test_utils_1.fetchOnce)({ code }, { status: 404, headers: { 'X-Request-ID': 'a-request-id' } });
+                const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.post(path, {})).rejects.toMatchObject({
+                    code,
+                    message: `The requested path '${path}' could not be found.`,
+                    status: 404,
+                });
+            }));
+        });
+        describe('when the api responds with a 500 and no error/error_description', () => {
+            it('throws an GenericServerException', () => __awaiter(void 0, void 0, void 0, function* () {
+                (0, test_utils_1.fetchOnce)({}, {
+                    status: 500,
+                    headers: { 'X-Request-ID': 'a-request-id' },
+                });
+                const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.post('/path', {})).rejects.toStrictEqual(new exceptions_1.GenericServerException(500, undefined, {}, 'a-request-id'));
+            }));
+        });
+        describe('when the api responds with a 400 and an error/error_description', () => {
+            it('throws an OauthException', () => __awaiter(void 0, void 0, void 0, function* () {
+                (0, test_utils_1.fetchOnce)({ error: 'error', error_description: 'error description' }, {
+                    status: 400,
+                    headers: { 'X-Request-ID': 'a-request-id' },
+                });
+                const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.post('/path', {})).rejects.toStrictEqual(new exceptions_1.OauthException(400, 'a-request-id', 'error', 'error description', { error: 'error', error_description: 'error description' }));
+            }));
+        });
+        describe('when the api responses with a 429', () => {
+            it('throws a RateLimitExceededException', () => __awaiter(void 0, void 0, void 0, function* () {
+                (0, test_utils_1.fetchOnce)({
+                    message: 'Too many requests',
+                }, {
+                    status: 429,
+                    headers: { 'X-Request-ID': 'a-request-id', 'Retry-After': '10' },
+                });
+                const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.get('/path')).rejects.toStrictEqual(new rate_limit_exceeded_exception_1.RateLimitExceededException('Too many requests', 'a-request-id', 10));
+            }));
+        });
+        describe('when the entity is null', () => {
+            it('sends an empty string body', () => __awaiter(void 0, void 0, void 0, function* () {
+                (0, test_utils_1.fetchOnce)();
+                const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield workos.post('/somewhere', null);
+                expect((0, test_utils_1.fetchBody)({ raw: true })).toBe('');
+            }));
+        });
+        describe('when the api responds with invalid JSON', () => {
+            it('throws a ParseError', () => __awaiter(void 0, void 0, void 0, function* () {
+                const mockResponse = {
+                    ok: true,
+                    status: 200,
+                    headers: new Headers({
+                        'X-Request-ID': 'a-request-id',
+                        'content-type': 'application/json',
+                    }),
+                    text: () => Promise.resolve('invalid json{'),
+                    json: () => Promise.reject(new SyntaxError('Invalid JSON')),
+                };
+                jest_fetch_mock_1.default.mockResolvedValueOnce(mockResponse);
+                const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                const error = yield workos.post('/path', {}).catch((e) => e);
+                expect(error).toBeInstanceOf(parse_error_1.ParseError);
+                expect(error.rawBody).toBe('invalid json{');
+                expect(error.requestID).toBe('a-request-id');
+            }));
+        });
+    });
+    describe('get', () => {
+        describe('when the api responds with invalid JSON', () => {
+            it('throws a ParseError', () => __awaiter(void 0, void 0, void 0, function* () {
+                const mockResponse = {
+                    ok: true,
+                    status: 200,
+                    headers: new Headers({
+                        'X-Request-ID': 'a-request-id',
+                        'content-type': 'application/json',
+                    }),
+                    text: () => Promise.resolve('malformed json}'),
+                    json: () => Promise.reject(new SyntaxError('Invalid JSON')),
+                };
+                jest_fetch_mock_1.default.mockResolvedValueOnce(mockResponse);
+                const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                const error = yield workos.get('/path').catch((e) => e);
+                expect(error).toBeInstanceOf(parse_error_1.ParseError);
+                expect(error.rawBody).toBe('malformed json}');
+                expect(error.requestID).toBe('a-request-id');
+            }));
+        });
+    });
+    describe('put', () => {
+        describe('when the api responds with invalid JSON', () => {
+            it('throws a ParseError', () => __awaiter(void 0, void 0, void 0, function* () {
+                const mockResponse = {
+                    ok: true,
+                    status: 200,
+                    headers: new Headers({
+                        'X-Request-ID': 'a-request-id',
+                        'content-type': 'application/json',
+                    }),
+                    text: () => Promise.resolve('broken json['),
+                    json: () => Promise.reject(new SyntaxError('Invalid JSON')),
+                };
+                jest_fetch_mock_1.default.mockResolvedValueOnce(mockResponse);
+                const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                const error = yield workos.put('/path', {}).catch((e) => e);
+                expect(error).toBeInstanceOf(parse_error_1.ParseError);
+                expect(error.rawBody).toBe('broken json[');
+                expect(error.requestID).toBe('a-request-id');
+            }));
+        });
+    });
+    describe('when in an environment that does not support fetch', () => {
+        const fetchFn = globalThis.fetch;
+        beforeEach(() => {
+            // @ts-ignore
+            delete globalThis.fetch;
+        });
+        afterEach(() => {
+            globalThis.fetch = fetchFn;
+        });
+        it('automatically uses the node HTTP client', () => {
+            const workos = new index_1.WorkOS('sk_test_key');
+            // tslint:disable-next-line
+            expect(workos['client']).toBeInstanceOf(node_client_1.NodeHttpClient);
+        });
+        it('uses a fetch function if provided', () => {
+            const workos = new index_1.WorkOS('sk_test_key', {
+                fetchFn,
+            });
+            // tslint:disable-next-line
+            expect(workos['client']).toBeInstanceOf(fetch_client_1.FetchHttpClient);
+        });
+    });
+    describe('when in a worker environment', () => {
+        it('uses the worker client', () => {
+            const workos = new index_worker_1.WorkOS('sk_test_key');
+            // tslint:disable-next-line
+            expect(workos['client']).toBeInstanceOf(fetch_client_1.FetchHttpClient);
+            expect(
+            // tslint:disable-next-line
+            workos.webhooks['signatureProvider']['cryptoProvider']).toBeInstanceOf(subtle_crypto_provider_1.SubtleCryptoProvider);
+            expect(
+            // tslint:disable-next-line
+            workos.actions['signatureProvider']['cryptoProvider']).toBeInstanceOf(subtle_crypto_provider_1.SubtleCryptoProvider);
+        });
+        it('uses console.warn to emit warnings', () => {
+            const workos = new index_worker_1.WorkOS('sk_test_key');
+            const warnSpy = jest.spyOn(console, 'warn');
+            workos.emitWarning('foo');
+            expect(warnSpy).toHaveBeenCalledWith('WorkOS: foo');
+        });
+    });
+    describe('when in a node environment', () => {
+        it('uses process.emitWarning to emit warnings', () => {
+            const workos = new index_1.WorkOS('sk_test_key');
+            const warnSpy = jest.spyOn(process, 'emitWarning');
+            workos.emitWarning('foo');
+            expect(warnSpy).toHaveBeenCalledWith('foo', 'WorkOS');
+        });
+    });
+});

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "8.0.0-beta.2",
+  "version": "8.0.0-beta.4",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -8,17 +8,13 @@
   "keywords": [
     "workos"
   ],
-  "volta": {
-    "node": "19.9.0",
-    "yarn": "1.22.19"
-  },
   "engines": {
     "node": ">=18"
   },
   "type": "module",
-  "main": "./lib/index.cjs",
-  "module": "./lib/index.js",
-  "types": "./lib/index.d.ts",
+  "main": "./lib/cjs/index.cjs",
+  "module": "./lib/esm/index.js",
+  "types": "./lib/esm/index.d.ts",
   "files": [
     "lib/",
     "package.json"
@@ -37,7 +33,7 @@
     "lint": "eslint",
     "test": "jest",
     "test:watch": "jest --watch",
-    "test:worker": "jest src/worker.spec.ts",
+    "check:runtimes": "tsx scripts/ecosystem-check.ts",
     "prettier": "prettier \"src/**/*.{js,ts,tsx}\" --check",
     "format": "prettier \"src/**/*.{js,ts,tsx}\" --write",
     "prepublishOnly": "npm run build"
@@ -46,7 +42,8 @@
     "iron-session": "^8.0.4",
     "jose": "~5.6.3",
     "leb": "^1.0.0",
-    "pluralize": "8.0.0"
+    "pluralize": "8.0.0",
+    "qs": "6.14.0"
   },
   "devDependencies": {
     "@babel/plugin-transform-modules-commonjs": "^7.26.3",
@@ -54,45 +51,75 @@
     "@babel/preset-typescript": "^7.27.0",
     "@eslint/js": "^9.21.0",
     "@types/cookie": "^0.6.0",
+    "@types/glob": "^8.1.0",
     "@types/jest": "^29.5.14",
     "@types/node": "~18",
     "@types/pluralize": "0.0.33",
+    "@types/qs": "^6.14.0",
     "@typescript-eslint/parser": "^8.25.0",
     "babel-jest": "^29.7.0",
+    "esbuild-fix-imports-plugin": "^1.0.21",
     "eslint": "^9.21.0",
     "eslint-plugin-jest": "^28.11.0",
     "eslint-plugin-n": "^17.15.1",
+    "glob": "^11.0.3",
     "jest": "29.7.0",
     "jest-environment-miniflare": "^2.14.2",
     "jest-fetch-mock": "^3.0.3",
+    "miniflare": "^3.20250408.2",
     "nock": "^13.5.5",
     "prettier": "^3.5.3",
     "supertest": "7.1.0",
     "ts-jest": "29.3.1",
     "tsup": "^8.5.0",
-    "typescript": "5.8.2",
+    "tsx": "^4.19.0",
+    "typescript": "5.9.2",
     "typescript-eslint": "^8.25.0"
   },
   "exports": {
     ".": {
-      "types": "./lib/index.d.ts",
+      "types": {
+        "require": "./lib/cjs/index.d.cts",
+        "import": "./lib/esm/index.d.ts"
+      },
       "workerd": {
-        "import": "./lib/index.worker.js",
-        "require": "./lib/index.worker.cjs"
+        "import": "./lib/esm/index.worker.js",
+        "require": "./lib/cjs/index.worker.cjs"
       },
       "edge-light": {
-        "import": "./lib/index.worker.js",
-        "require": "./lib/index.worker.cjs"
+        "import": "./lib/esm/index.worker.js",
+        "require": "./lib/cjs/index.worker.cjs"
+      },
+      "deno": "./lib/esm/index.js",
+      "bun": {
+        "import": "./lib/esm/index.js",
+        "require": "./lib/cjs/index.cjs"
+      },
+      "node": {
+        "import": "./lib/esm/index.js",
+        "require": "./lib/cjs/index.cjs"
       },
-      "import": "./lib/index.js",
-      "require": "./lib/index.cjs",
-      "default": "./lib/index.js"
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.cjs",
+      "default": "./lib/esm/index.js"
+    },
+    "./client": {
+      "types": {
+        "require": "./lib/cjs/index.client.d.cts",
+        "import": "./lib/esm/index.client.d.ts"
+      },
+      "import": "./lib/esm/index.client.js",
+      "require": "./lib/cjs/index.client.cjs",
+      "default": "./lib/esm/index.client.js"
     },
     "./worker": {
-      "types": "./lib/index.worker.d.ts",
-      "import": "./lib/index.worker.js",
-      "require": "./lib/index.worker.cjs",
-      "default": "./lib/index.worker.js"
+      "types": {
+        "require": "./lib/cjs/index.worker.d.cts",
+        "import": "./lib/esm/index.worker.d.ts"
+      },
+      "import": "./lib/esm/index.worker.js",
+      "require": "./lib/cjs/index.worker.cjs",
+      "default": "./lib/esm/index.worker.js"
     },
     "./package.json": "./package.json"
   }