@workos-inc/node 5.2.0 → 6.0.0-rc.1

package/lib/audit-logs/audit-logs.spec.js

@@ -8,13 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 axios_1 = require("axios");
+const jest_fetch_mock_1 = __importDefault(require("jest-fetch-mock"));
 const exceptions_1 = require("../common/exceptions");
 const bad_request_exception_1 = require("../common/exceptions/bad-request.exception");
 const workos_mock_response_1 = require("../common/utils/workos-mock-response");
 const workos_1 = require("../workos");
 const serializers_1 = require("./serializers");
+const fetch_error_1 = require("../common/utils/fetch-error");
 const event = {
     action: 'document.updated',
     occurredAt: new Date(),
@@ -38,6 +42,7 @@ const event = {
     },
 };
 describe('AuditLogs', () => {
+    beforeEach(() => jest_fetch_mock_1.default.resetMocks());
     describe('createEvent', () => {
         describe('with an idempotency key', () => {
             it('includes an idempotency key with request', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -69,7 +74,10 @@ describe('AuditLogs', () => {
             it('throws an UnauthorizedException', () => __awaiter(void 0, void 0, void 0, function* () {
                 const workosSpy = jest.spyOn(workos_1.WorkOS.prototype, 'post');
                 workosSpy.mockImplementationOnce(() => {
-                    throw new axios_1.AxiosError('Could not authorize the request. Maybe your API key is invalid?', '401');
+                    throw new fetch_error_1.FetchError({
+                        message: 'Could not authorize the request. Maybe your API key is invalid?',
+                        response: { status: 401, headers: new Headers(), data: {} },
+                    });
                 });
                 const workos = new workos_1.WorkOS('invalid apikey');
                 yield expect(workos.auditLogs.createEvent('org_123', event)).rejects.toThrowError(new exceptions_1.UnauthorizedException('a-request-id'));
@@ -172,7 +180,10 @@ describe('AuditLogs', () => {
                     rangeEnd: new Date(),
                 };
                 workosSpy.mockImplementationOnce(() => {
-                    throw new axios_1.AxiosError('Could not authorize the request. Maybe your API key is invalid?', '401');
+                    throw new fetch_error_1.FetchError({
+                        message: 'Could not authorize the request. Maybe your API key is invalid?',
+                        response: { status: 401, headers: new Headers(), data: {} },
+                    });
                 });
                 const workos = new workos_1.WorkOS('invalid apikey');
                 yield expect(workos.auditLogs.createExport(options)).rejects.toThrowError(new exceptions_1.UnauthorizedException('a-request-id'));
@@ -209,7 +220,10 @@ describe('AuditLogs', () => {
             it('throws an UnauthorizedException', () => __awaiter(void 0, void 0, void 0, function* () {
                 const workosSpy = jest.spyOn(workos_1.WorkOS.prototype, 'get');
                 workosSpy.mockImplementationOnce(() => {
-                    throw new axios_1.AxiosError('Could not authorize the request. Maybe your API key is invalid?', '401');
+                    throw new fetch_error_1.FetchError({
+                        message: 'Could not authorize the request. Maybe your API key is invalid?',
+                        response: { status: 401, headers: new Headers(), data: {} },
+                    });
                 });
                 const workos = new workos_1.WorkOS('invalid apikey');
                 yield expect(workos.auditLogs.getExport('audit_log_export_1234')).rejects.toThrowError(new exceptions_1.UnauthorizedException('a-request-id'));

package/lib/common/interfaces/workos-options.interface.d.ts

@@ -1,7 +1,6 @@
-import { AxiosRequestConfig } from 'axios';
 export interface WorkOSOptions {
     apiHostname?: string;
     https?: boolean;
     port?: number;
-    axios?: Omit<AxiosRequestConfig, 'baseURL'>;
+    config?: RequestInit;
 }

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

@@ -0,0 +1,29 @@
+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<void>;
+    private getResourceURL;
+    private fetch;
+}

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

@@ -0,0 +1,97 @@
+"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);
+            const response = yield this.fetch(resourceURL, {
+                headers: options.headers,
+            });
+            return { data: yield response.json() };
+        });
+    }
+    post(path, entity, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resourceURL = this.getResourceURL(path, options.params);
+            const bodyIsSearchParams = entity instanceof URLSearchParams;
+            const contentTypeHeader = bodyIsSearchParams
+                ? { 'Content-Type': 'application/x-www-form-urlencoded;charset=utf-8' }
+                : undefined;
+            const body = bodyIsSearchParams ? entity : JSON.stringify(entity);
+            const response = yield this.fetch(resourceURL, {
+                method: 'POST',
+                headers: Object.assign(Object.assign({}, contentTypeHeader), options.headers),
+                body,
+            });
+            return { data: yield response.json() };
+        });
+    }
+    put(path, entity, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resourceURL = this.getResourceURL(path, options.params);
+            const response = yield this.fetch(resourceURL, {
+                method: 'PUT',
+                headers: options.headers,
+                body: JSON.stringify(entity),
+            });
+            return { data: yield response.json() };
+        });
+    }
+    delete(path, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resourceURL = this.getResourceURL(path, options.params);
+            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(),
+                    },
+                });
+            }
+            return response;
+        });
+    }
+}
+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();
+}

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

@@ -0,0 +1,13 @@
+export declare class FetchError<T> extends Error {
+    readonly name: string;
+    readonly message: string;
+    readonly response: {
+        status: number;
+        headers: Headers;
+        data: T;
+    };
+    constructor({ message, response, }: {
+        message: string;
+        readonly response: FetchError<T>['response'];
+    });
+}

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

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FetchError = void 0;
+class FetchError extends Error {
+    constructor({ message, response, }) {
+        super(message);
+        this.name = 'FetchError';
+        this.message = 'The request could not be completed.';
+        this.message = message;
+        this.response = response;
+    }
+}
+exports.FetchError = FetchError;

package/lib/common/utils/test-utils.d.ts

@@ -0,0 +1,8 @@
+import { MockParams } from 'jest-fetch-mock';
+export declare function fetchOnce(response?: any, { status, ...rest }?: MockParams): import("jest-fetch-mock").FetchMock;
+export declare function fetchURL(): string | Request | undefined;
+export declare function fetchSearchParams(): {
+    [k: string]: string;
+};
+export declare function fetchHeaders(): HeadersInit | undefined;
+export declare function fetchBody(): any;

package/lib/common/utils/test-utils.js

@@ -0,0 +1,45 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchBody = exports.fetchHeaders = exports.fetchSearchParams = exports.fetchURL = exports.fetchOnce = void 0;
+const jest_fetch_mock_1 = __importDefault(require("jest-fetch-mock"));
+function fetchOnce(response = {}, _a = {}) {
+    var { status = 200 } = _a, rest = __rest(_a, ["status"]);
+    return jest_fetch_mock_1.default.once(JSON.stringify(response), Object.assign({ status }, rest));
+}
+exports.fetchOnce = fetchOnce;
+function fetchURL() {
+    return jest_fetch_mock_1.default.mock.calls[0][0];
+}
+exports.fetchURL = fetchURL;
+function fetchSearchParams() {
+    return Object.fromEntries(new URL(String(fetchURL())).searchParams);
+}
+exports.fetchSearchParams = fetchSearchParams;
+function fetchHeaders() {
+    var _a;
+    return (_a = jest_fetch_mock_1.default.mock.calls[0][1]) === null || _a === void 0 ? void 0 : _a.headers;
+}
+exports.fetchHeaders = fetchHeaders;
+function fetchBody() {
+    var _a;
+    const body = (_a = jest_fetch_mock_1.default.mock.calls[0][1]) === null || _a === void 0 ? void 0 : _a.body;
+    if (body instanceof URLSearchParams) {
+        return body.toString();
+    }
+    return JSON.parse(String(body));
+}
+exports.fetchBody = fetchBody;

package/lib/directory-sync/directory-sync.spec.js

@@ -12,12 +12,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const axios_1 = __importDefault(require("axios"));
-const axios_mock_adapter_1 = __importDefault(require("axios-mock-adapter"));
+const jest_fetch_mock_1 = __importDefault(require("jest-fetch-mock"));
+const test_utils_1 = require("../common/utils/test-utils");
 const workos_1 = require("../workos");
-const mock = new axios_mock_adapter_1.default(axios_1.default);
 describe('DirectorySync', () => {
-    afterEach(() => mock.resetHistory());
+    beforeEach(() => jest_fetch_mock_1.default.resetMocks());
     const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
     const directory = {
         id: 'directory_123',
@@ -127,16 +126,15 @@ describe('DirectorySync', () => {
                     data: [directoryResponse],
                     list_metadata: {},
                 };
-                mock
-                    .onGet('/directories', {
-                    domain: 'google.com',
-                    organization_id: 'org_1234',
-                })
-                    .replyOnce(200, directoryListResponse);
+                (0, test_utils_1.fetchOnce)(directoryListResponse);
                 const subject = yield workos.directorySync.listDirectories({
                     domain: 'google.com',
                     organizationId: 'org_1234',
                 });
+                expect((0, test_utils_1.fetchSearchParams)()).toMatchObject({
+                    domain: 'google.com',
+                    organization_id: 'org_1234',
+                });
                 expect(subject).toMatchObject({
                     object: 'list',
                     list: {
@@ -154,23 +152,21 @@ describe('DirectorySync', () => {
     });
     describe('getDirectory', () => {
         it(`requests a Directory`, () => __awaiter(void 0, void 0, void 0, function* () {
-            mock
-                .onGet('/directories/directory_123')
-                .replyOnce(200, directoryResponse);
+            (0, test_utils_1.fetchOnce)(directoryResponse);
             const subject = yield workos.directorySync.getDirectory('directory_123');
             expect(subject).toEqual(directory);
         }));
     });
     describe('deleteDirectory', () => {
         it('sends a request to delete the directory', () => __awaiter(void 0, void 0, void 0, function* () {
-            mock.onDelete('/directories/directory_123').replyOnce(202, {});
+            (0, test_utils_1.fetchOnce)({}, { status: 202 });
             yield workos.directorySync.deleteDirectory('directory_123');
-            expect(mock.history.delete[0].url).toEqual('/directories/directory_123');
+            expect((0, test_utils_1.fetchURL)()).toContain('/directories/directory_123');
         }));
     });
     describe('getGroup', () => {
         it(`requests a Directory Group`, () => __awaiter(void 0, void 0, void 0, function* () {
-            mock.onGet('/directory_groups/dir_grp_123').replyOnce(200, groupResponse);
+            (0, test_utils_1.fetchOnce)(groupResponse);
             const subject = yield workos.directorySync.getGroup('dir_grp_123');
             expect(subject).toEqual(group);
         }));
@@ -183,14 +179,13 @@ describe('DirectorySync', () => {
         };
         describe('with a Directory', () => {
             it(`requests a Directory's Groups`, () => __awaiter(void 0, void 0, void 0, function* () {
-                mock
-                    .onGet('/directory_groups', {
-                    directory: 'directory_123',
-                })
-                    .replyOnce(200, groupListResponse);
+                (0, test_utils_1.fetchOnce)(groupListResponse);
                 const subject = yield workos.directorySync.listGroups({
                     directory: 'directory_123',
                 });
+                expect((0, test_utils_1.fetchSearchParams)()).toMatchObject({
+                    directory: 'directory_123',
+                });
                 expect(subject).toMatchObject({
                     object: 'list',
                     list: {
@@ -207,14 +202,13 @@ describe('DirectorySync', () => {
         });
         describe('with a User', () => {
             it(`requests a Directory's Groups`, () => __awaiter(void 0, void 0, void 0, function* () {
-                mock
-                    .onGet('/directory_groups', {
-                    user: 'directory_usr_123',
-                })
-                    .replyOnce(200, groupListResponse);
+                (0, test_utils_1.fetchOnce)(groupListResponse);
                 const subject = yield workos.directorySync.listGroups({
                     user: 'directory_usr_123',
                 });
+                expect((0, test_utils_1.fetchSearchParams)()).toMatchObject({
+                    user: 'directory_usr_123',
+                });
                 expect(subject).toEqual({
                     object: 'list',
                     list: {
@@ -238,14 +232,13 @@ describe('DirectorySync', () => {
         };
         describe('with a Directory', () => {
             it(`requests a Directory's Users`, () => __awaiter(void 0, void 0, void 0, function* () {
-                mock
-                    .onGet('/directory_users', {
-                    directory: 'directory_123',
-                })
-                    .replyOnce(200, userWithGroupListResponse);
+                (0, test_utils_1.fetchOnce)(userWithGroupListResponse);
                 const subject = yield workos.directorySync.listUsers({
                     directory: 'directory_123',
                 });
+                expect((0, test_utils_1.fetchSearchParams)()).toMatchObject({
+                    directory: 'directory_123',
+                });
                 expect(subject).toMatchObject({
                     object: 'list',
                     list: {
@@ -261,11 +254,7 @@ describe('DirectorySync', () => {
             }));
             describe('with custom attributes', () => {
                 it('returns the custom attributes, using the provided type', () => __awaiter(void 0, void 0, void 0, function* () {
-                    mock
-                        .onGet('/directory_users', {
-                        directory: 'directory_123',
-                    })
-                        .replyOnce(200, {
+                    (0, test_utils_1.fetchOnce)({
                         data: [
                             {
                                 object: 'directory_user',
@@ -322,10 +311,13 @@ describe('DirectorySync', () => {
                                 ],
                             },
                         ],
-                    });
+                    }, { status: 200 });
                     const users = yield workos.directorySync.listUsers({
                         directory: 'directory_123',
                     });
+                    expect((0, test_utils_1.fetchSearchParams)()).toMatchObject({
+                        directory: 'directory_123',
+                    });
                     const managerIds = users.data.map((user) => user.customAttributes.managerId);
                     expect(managerIds).toEqual([
                         '99f1817b-149c-4438-b80f-a272c3406109',
@@ -336,14 +328,13 @@ describe('DirectorySync', () => {
         });
         describe('with a Group', () => {
             it(`requests a Directory's Users`, () => __awaiter(void 0, void 0, void 0, function* () {
-                mock
-                    .onGet('/directory_users', {
-                    group: 'directory_grp_123',
-                })
-                    .replyOnce(200, userWithGroupListResponse);
+                (0, test_utils_1.fetchOnce)(userWithGroupListResponse);
                 const subject = yield workos.directorySync.listUsers({
                     group: 'directory_grp_123',
                 });
+                expect((0, test_utils_1.fetchSearchParams)()).toMatchObject({
+                    group: 'directory_grp_123',
+                });
                 expect(subject).toMatchObject({
                     object: 'list',
                     list: {
@@ -361,9 +352,7 @@ describe('DirectorySync', () => {
     });
     describe('getUser', () => {
         it(`requests a Directory User`, () => __awaiter(void 0, void 0, void 0, function* () {
-            mock
-                .onGet('/directory_users/dir_usr_123')
-                .replyOnce(200, userWithGroupResponse);
+            (0, test_utils_1.fetchOnce)(userWithGroupResponse);
             const subject = yield workos.directorySync.getUser('dir_usr_123');
             expect(subject).toEqual(userWithGroup);
         }));

package/lib/events/events.spec.js

@@ -12,13 +12,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const axios_1 = __importDefault(require("axios"));
-const axios_mock_adapter_1 = __importDefault(require("axios-mock-adapter"));
+const jest_fetch_mock_1 = __importDefault(require("jest-fetch-mock"));
+const test_utils_1 = require("../common/utils/test-utils");
 const workos_1 = require("../workos");
 const interfaces_1 = require("../sso/interfaces");
-const mock = new axios_mock_adapter_1.default(axios_1.default);
 describe('Event', () => {
-    afterEach(() => mock.resetHistory());
+    beforeEach(() => jest_fetch_mock_1.default.resetMocks());
     const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
     const event = {
         id: 'event_01234ABCD',
@@ -60,7 +59,7 @@ describe('Event', () => {
             list_metadata: {},
         };
         it(`requests Events`, () => __awaiter(void 0, void 0, void 0, function* () {
-            mock.onGet('/events', {}).replyOnce(200, eventsListResponse);
+            (0, test_utils_1.fetchOnce)(eventsListResponse);
             const subject = yield workos.events.listEvents({});
             expect(subject).toEqual({
                 object: 'list',
@@ -69,7 +68,7 @@ describe('Event', () => {
             });
         }));
         it(`requests Events with a valid event name`, () => __awaiter(void 0, void 0, void 0, function* () {
-            mock.onGet('/events').replyOnce(200, eventsListResponse);
+            (0, test_utils_1.fetchOnce)(eventsListResponse);
             const list = yield workos.events.listEvents({
                 events: ['connection.activated'],
             });