@workos-inc/node 7.9.0 → 7.11.0

package/lib/workos.spec.js

@@ -16,8 +16,12 @@ 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 workos_1 = require("./workos");
+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', () => {
@@ -32,35 +36,35 @@ describe('WorkOS', () => {
         });
         describe('when no API key is provided', () => {
             it('throws a NoApiKeyFoundException error', () => __awaiter(void 0, void 0, void 0, function* () {
-                expect(() => new workos_1.WorkOS()).toThrowError(exceptions_1.NoApiKeyProvidedException);
+                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 workos_1.WorkOS()).not.toThrow();
+                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 workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU')).not.toThrow();
+                expect(() => new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU')).not.toThrow();
             }));
         });
         describe('with https option', () => {
             it('sets baseURL', () => {
-                const workos = new workos_1.WorkOS('foo', { https: false });
+                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 workos_1.WorkOS('foo', { apiHostname: 'localhost' });
+                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 workos_1.WorkOS('foo', {
+                const workos = new index_1.WorkOS('foo', {
                     apiHostname: 'localhost',
                     port: 4000,
                 });
@@ -70,7 +74,7 @@ describe('WorkOS', () => {
         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 workos_1.WorkOS('sk_test', {
+                const workos = new index_1.WorkOS('sk_test', {
                     config: {
                         headers: {
                             'X-My-Custom-Header': 'Hey there!',
@@ -87,7 +91,7 @@ describe('WorkOS', () => {
             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 workos_1.WorkOS('sk_test', {
+                const workos = new index_1.WorkOS('sk_test', {
                     appInfo: {
                         name: 'fooApp',
                         version: '1.0.0',
@@ -95,14 +99,44 @@ describe('WorkOS', () => {
                 });
                 yield workos.post('/somewhere', {});
                 expect((0, test_utils_1.fetchHeaders)()).toMatchObject({
-                    'User-Agent': `workos-node/${packageJson.version} fooApp: 1.0.0`,
+                    '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 workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+            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'));
@@ -114,7 +148,7 @@ describe('WorkOS', () => {
             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 workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                 yield expect(workos.post('/path', {})).rejects.toStrictEqual(new exceptions_1.NotFoundException({
                     message,
                     path: '/path',
@@ -125,7 +159,7 @@ describe('WorkOS', () => {
                 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 workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                 yield expect(workos.post('/path', {})).rejects.toMatchObject({
                     code,
                     message,
@@ -136,7 +170,7 @@ describe('WorkOS', () => {
                 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 workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                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.`,
@@ -150,7 +184,7 @@ describe('WorkOS', () => {
                     status: 500,
                     headers: { 'X-Request-ID': 'a-request-id' },
                 });
-                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                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'));
             }));
         });
@@ -160,7 +194,7 @@ describe('WorkOS', () => {
                     status: 400,
                     headers: { 'X-Request-ID': 'a-request-id' },
                 });
-                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                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' }));
             }));
         });
@@ -172,17 +206,48 @@ describe('WorkOS', () => {
                     status: 429,
                     headers: { 'X-Request-ID': 'a-request-id', 'Retry-After': '10' },
                 });
-                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                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 a null body', () => __awaiter(void 0, void 0, void 0, function* () {
+            it('sends an empty string body', () => __awaiter(void 0, void 0, void 0, function* () {
                 (0, test_utils_1.fetchOnce)();
-                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                 yield workos.post('/somewhere', null);
-                expect((0, test_utils_1.fetchBody)({ raw: true })).toBeNull();
+                expect((0, test_utils_1.fetchBody)({ raw: true })).toBe('');
             }));
         });
     });
+    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);
+            // tslint:disable-next-line
+            expect(workos.webhooks['cryptoProvider']).toBeInstanceOf(subtle_crypto_provider_1.SubtleCryptoProvider);
+        });
+    });
 });

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "7.9.0",
+  "version": "7.11.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -13,11 +13,8 @@
     "yarn": "1.22.19"
   },
   "engines": {
-    "node": ">=19"
+    "node": ">=16"
   },
-  "engineStrict": true,
-  "main": "lib/index.js",
-  "typings": "lib/index.d.ts",
   "files": [
     "lib/"
   ],
@@ -29,6 +26,7 @@
     "url": "https://github.com/workos-inc/workos-node/issues"
   },
   "scripts": {
+    "clean": "rm -rf lib",
     "build": "tsc -p .",
     "lint": "tslint -p tsconfig.json -c tslint.json",
     "test": "jest",
@@ -52,5 +50,14 @@
     "ts-jest": "29.1.3",
     "tslint": "6.1.3",
     "typescript": "5.1.6"
+  },
+  "exports": {
+    "types": "./types/index.d.ts",
+    "worker": {
+      "import": "./lib/index.worker.js"
+    },
+    "default": {
+      "import": "./lib/index.js"
+    }
   }
 }

package/lib/common/utils/fetch-client.d.ts

@@ -1,31 +0,0 @@
-export declare class FetchClient {
-    readonly baseURL: string;
-    readonly options?: RequestInit | undefined;
-    constructor(baseURL: string, options?: RequestInit | undefined);
-    get(path: string, options: {
-        params?: Record<string, any>;
-        headers?: HeadersInit;
-    }): Promise<{
-        data: any;
-    }>;
-    post<Entity = any>(path: string, entity: Entity, options: {
-        params?: Record<string, any>;
-        headers?: HeadersInit;
-    }): Promise<{
-        data: any;
-    }>;
-    put<Entity = any>(path: string, entity: Entity, options: {
-        params?: Record<string, any>;
-        headers?: HeadersInit;
-    }): Promise<{
-        data: any;
-    }>;
-    delete(path: string, options: {
-        params?: Record<string, any>;
-        headers?: HeadersInit;
-    }): Promise<{
-        data: any;
-    }>;
-    private getResourceURL;
-    private fetch;
-}

package/lib/common/utils/fetch-client.js

@@ -1,108 +0,0 @@
-"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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FetchClient = void 0;
-const fetch_error_1 = require("./fetch-error");
-class FetchClient {
-    constructor(baseURL, options) {
-        this.baseURL = baseURL;
-        this.options = options;
-    }
-    get(path, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const resourceURL = this.getResourceURL(path, options.params);
-            return yield this.fetch(resourceURL, {
-                headers: options.headers,
-            });
-        });
-    }
-    post(path, entity, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const resourceURL = this.getResourceURL(path, options.params);
-            return yield this.fetch(resourceURL, {
-                method: 'POST',
-                headers: Object.assign(Object.assign({}, getContentTypeHeader(entity)), options.headers),
-                body: getBody(entity),
-            });
-        });
-    }
-    put(path, entity, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const resourceURL = this.getResourceURL(path, options.params);
-            return yield this.fetch(resourceURL, {
-                method: 'PUT',
-                headers: Object.assign(Object.assign({}, getContentTypeHeader(entity)), options.headers),
-                body: getBody(entity),
-            });
-        });
-    }
-    delete(path, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const resourceURL = this.getResourceURL(path, options.params);
-            return yield this.fetch(resourceURL, {
-                method: 'DELETE',
-                headers: options.headers,
-            });
-        });
-    }
-    getResourceURL(path, params) {
-        const queryString = getQueryString(params);
-        const url = new URL([path, queryString].filter(Boolean).join('?'), this.baseURL);
-        return url.toString();
-    }
-    fetch(url, options) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield fetch(url, Object.assign(Object.assign(Object.assign({}, this.options), options), { headers: Object.assign(Object.assign({ Accept: 'application/json, text/plain, */*', 'Content-Type': 'application/json' }, (_a = this.options) === null || _a === void 0 ? void 0 : _a.headers), options === null || options === void 0 ? void 0 : options.headers) }));
-            if (!response.ok) {
-                throw new fetch_error_1.FetchError({
-                    message: response.statusText,
-                    response: {
-                        status: response.status,
-                        headers: response.headers,
-                        data: yield response.json(),
-                    },
-                });
-            }
-            const contentType = response.headers.get('content-type');
-            const isJsonResponse = contentType === null || contentType === void 0 ? void 0 : contentType.includes('application/json');
-            if (isJsonResponse) {
-                return { data: yield response.json() };
-            }
-            return { data: null };
-        });
-    }
-}
-exports.FetchClient = FetchClient;
-function getQueryString(queryObj) {
-    if (!queryObj)
-        return undefined;
-    const sanitizedQueryObj = {};
-    Object.entries(queryObj).forEach(([param, value]) => {
-        if (value !== '' && value !== undefined)
-            sanitizedQueryObj[param] = value;
-    });
-    return new URLSearchParams(sanitizedQueryObj).toString();
-}
-function getContentTypeHeader(entity) {
-    if (entity instanceof URLSearchParams) {
-        return {
-            'Content-Type': 'application/x-www-form-urlencoded;charset=utf-8',
-        };
-    }
-    return undefined;
-}
-function getBody(entity) {
-    if (entity === null || entity instanceof URLSearchParams) {
-        return entity;
-    }
-    return JSON.stringify(entity);
-}