@workos-inc/node 7.69.0 → 7.69.2

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

@@ -7,4 +7,5 @@ export interface WorkOSOptions {
     appInfo?: AppInfo;
     fetchFn?: typeof fetch;
     clientId?: string;
+    timeout?: number;
 }

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

@@ -1,10 +1,13 @@
 import { HttpClientInterface, HttpClientResponseInterface, RequestOptions, ResponseHeaders } from '../interfaces/http-client.interface';
 import { HttpClient, HttpClientResponse } from './http-client';
+interface FetchHttpClientOptions extends RequestInit {
+    timeout?: number;
+}
 export declare class FetchHttpClient extends HttpClient implements HttpClientInterface {
     readonly baseURL: string;
-    readonly options?: RequestInit | undefined;
+    readonly options?: FetchHttpClientOptions | undefined;
     private readonly _fetchFn;
-    constructor(baseURL: string, options?: RequestInit | undefined, fetchFn?: typeof fetch);
+    constructor(baseURL: string, options?: FetchHttpClientOptions | undefined, fetchFn?: typeof fetch);
     /** @override */
     getClientName(): string;
     get(path: string, options: RequestOptions): Promise<HttpClientResponseInterface>;
@@ -22,3 +25,4 @@ export declare class FetchHttpClientResponse extends HttpClientResponse implemen
     toJSON(): Promise<any> | null;
     static _transformHeadersToObject(headers: Headers): ResponseHeaders;
 }
+export {};

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

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FetchHttpClientResponse = exports.FetchHttpClient = void 0;
 const http_client_1 = require("./http-client");
 const parse_error_1 = require("../exceptions/parse-error");
+const DEFAULT_FETCH_TIMEOUT = 60000; // 60 seconds
 class FetchHttpClient extends http_client_1.HttpClient {
     constructor(baseURL, options, fetchFn) {
         super(baseURL, options);
@@ -75,47 +76,82 @@ class FetchHttpClient extends http_client_1.HttpClient {
         });
     }
     fetchRequest(url, method, body, headers) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e;
         return __awaiter(this, void 0, void 0, function* () {
             // For methods which expect payloads, we should always pass a body value
             // even when it is empty. Without this, some JS runtimes (eg. Deno) will
             // inject a second Content-Length header.
             const methodHasPayload = method === 'POST' || method === 'PUT' || method === 'PATCH';
             const requestBody = body || (methodHasPayload ? '' : undefined);
-            const { 'User-Agent': userAgent } = (_a = this.options) === null || _a === void 0 ? void 0 : _a.headers;
-            const res = yield this._fetchFn(url, {
-                method,
-                headers: Object.assign(Object.assign(Object.assign({ Accept: 'application/json, text/plain, */*', 'Content-Type': 'application/json' }, (_b = this.options) === null || _b === void 0 ? void 0 : _b.headers), headers), { 'User-Agent': this.addClientToUserAgent(userAgent.toString()) }),
-                body: requestBody,
-            });
-            if (!res.ok) {
-                const requestID = (_c = res.headers.get('X-Request-ID')) !== null && _c !== void 0 ? _c : '';
-                const rawBody = yield res.text();
-                let responseJson;
-                try {
-                    responseJson = JSON.parse(rawBody);
+            const { 'User-Agent': userAgent } = (((_a = this.options) === null || _a === void 0 ? void 0 : _a.headers) ||
+                {});
+            // Create AbortController for timeout if configured
+            let abortController;
+            let timeoutId;
+            // Access timeout from the options with default of 60 seconds
+            const timeout = (_c = (_b = this.options) === null || _b === void 0 ? void 0 : _b.timeout) !== null && _c !== void 0 ? _c : DEFAULT_FETCH_TIMEOUT; // Default 60 seconds
+            abortController = new AbortController();
+            timeoutId = setTimeout(() => {
+                abortController === null || abortController === void 0 ? void 0 : abortController.abort();
+            }, timeout);
+            try {
+                const res = yield this._fetchFn(url, {
+                    method,
+                    headers: Object.assign(Object.assign(Object.assign({ Accept: 'application/json, text/plain, */*', 'Content-Type': 'application/json' }, (_d = this.options) === null || _d === void 0 ? void 0 : _d.headers), headers), { 'User-Agent': this.addClientToUserAgent((userAgent || 'workos-node').toString()) }),
+                    body: requestBody,
+                    signal: abortController === null || abortController === void 0 ? void 0 : abortController.signal,
+                });
+                // Clear timeout if request completed successfully
+                if (timeoutId) {
+                    clearTimeout(timeoutId);
                 }
-                catch (error) {
-                    if (error instanceof SyntaxError) {
-                        throw new parse_error_1.ParseError({
-                            message: error.message,
-                            rawBody,
-                            requestID,
-                            rawStatus: res.status,
-                        });
+                if (!res.ok) {
+                    const requestID = (_e = res.headers.get('X-Request-ID')) !== null && _e !== void 0 ? _e : '';
+                    const rawBody = yield res.text();
+                    let responseJson;
+                    try {
+                        responseJson = JSON.parse(rawBody);
+                    }
+                    catch (error) {
+                        if (error instanceof SyntaxError) {
+                            throw new parse_error_1.ParseError({
+                                message: error.message,
+                                rawBody,
+                                requestID,
+                                rawStatus: res.status,
+                            });
+                        }
+                        throw error;
                     }
-                    throw error;
+                    throw new http_client_1.HttpClientError({
+                        message: res.statusText,
+                        response: {
+                            status: res.status,
+                            headers: res.headers,
+                            data: responseJson,
+                        },
+                    });
                 }
-                throw new http_client_1.HttpClientError({
-                    message: res.statusText,
-                    response: {
-                        status: res.status,
-                        headers: res.headers,
-                        data: responseJson,
-                    },
-                });
+                return new FetchHttpClientResponse(res);
+            }
+            catch (error) {
+                // Clear timeout if request failed
+                if (timeoutId) {
+                    clearTimeout(timeoutId);
+                }
+                // Handle timeout errors
+                if (error instanceof Error && error.name === 'AbortError') {
+                    throw new http_client_1.HttpClientError({
+                        message: `Request timeout after ${timeout}ms`,
+                        response: {
+                            status: 408,
+                            headers: {},
+                            data: { error: 'Request timeout' },
+                        },
+                    });
+                }
+                throw error;
             }
-            return new FetchHttpClientResponse(res);
         });
     }
     fetchRequestWithRetry(url, method, body, headers) {

package/lib/common/net/fetch-client.spec.js

@@ -15,6 +15,7 @@ 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 fetch_client_1 = require("./fetch-client");
+const http_client_1 = require("./http-client");
 const parse_error_1 = require("../exceptions/parse-error");
 const fetchClient = new fetch_client_1.FetchHttpClient('https://test.workos.com', {
     headers: {
@@ -205,3 +206,73 @@ describe('Fetch client', () => {
         }));
     });
 });
+describe('FetchHttpClient with timeout', () => {
+    let client;
+    let mockFetch;
+    beforeEach(() => {
+        mockFetch = jest.fn();
+        client = new fetch_client_1.FetchHttpClient('https://api.example.com', { timeout: 100 }, mockFetch);
+    });
+    it('should timeout requests that take too long', () => __awaiter(void 0, void 0, void 0, function* () {
+        // Mock a fetch that respects AbortController
+        mockFetch.mockImplementation((_, options) => {
+            return new Promise((_, reject) => {
+                if (options.signal) {
+                    options.signal.addEventListener('abort', () => {
+                        const error = new Error('AbortError');
+                        error.name = 'AbortError';
+                        reject(error);
+                    });
+                }
+                // Never resolve - let the timeout trigger
+            });
+        });
+        yield expect(client.post('/test', { data: 'test' }, {})).rejects.toThrow(http_client_1.HttpClientError);
+        // Reset the mock for the second test
+        mockFetch.mockClear();
+        mockFetch.mockImplementation((_, options) => {
+            return new Promise((_, reject) => {
+                if (options.signal) {
+                    options.signal.addEventListener('abort', () => {
+                        const error = new Error('AbortError');
+                        error.name = 'AbortError';
+                        reject(error);
+                    });
+                }
+                // Never resolve - let the timeout trigger
+            });
+        });
+        yield expect(client.post('/test', { data: 'test' }, {})).rejects.toMatchObject({
+            message: 'Request timeout after 100ms',
+            response: {
+                status: 408,
+                data: { error: 'Request timeout' },
+            },
+        });
+    }));
+    it('should not timeout requests that complete quickly', () => __awaiter(void 0, void 0, void 0, function* () {
+        const mockResponse = {
+            ok: true,
+            status: 200,
+            headers: new Map(),
+            json: () => Promise.resolve({ success: true }),
+            text: () => Promise.resolve('{"success": true}'),
+        };
+        mockFetch.mockResolvedValue(mockResponse);
+        const result = yield client.post('/test', { data: 'test' }, {});
+        expect(result).toBeDefined();
+    }));
+    it('should work without timeout configured', () => __awaiter(void 0, void 0, void 0, function* () {
+        const clientWithoutTimeout = new fetch_client_1.FetchHttpClient('https://api.example.com', {}, mockFetch);
+        const mockResponse = {
+            ok: true,
+            status: 200,
+            headers: new Map(),
+            json: () => Promise.resolve({ success: true }),
+            text: () => Promise.resolve('{"success": true}'),
+        };
+        mockFetch.mockResolvedValue(mockResponse);
+        const result = yield clientWithoutTimeout.post('/test', { data: 'test' }, {});
+        expect(result).toBeDefined();
+    }));
+});

package/lib/index.js

@@ -43,7 +43,7 @@ class WorkOSNode extends workos_1.WorkOS {
     /** @override */
     createHttpClient(options, userAgent) {
         var _a;
-        const opts = Object.assign(Object.assign({}, options.config), { headers: Object.assign(Object.assign({}, (_a = options.config) === null || _a === void 0 ? void 0 : _a.headers), { Authorization: `Bearer ${this.key}`, 'User-Agent': userAgent }) });
+        const opts = Object.assign(Object.assign({}, options.config), { timeout: options.timeout, headers: Object.assign(Object.assign({}, (_a = options.config) === null || _a === void 0 ? void 0 : _a.headers), { Authorization: `Bearer ${this.key}`, 'User-Agent': userAgent }) });
         if (typeof fetch !== 'undefined' ||
             typeof options.fetchFn !== 'undefined') {
             return new fetch_client_1.FetchHttpClient(this.baseURL, opts, options.fetchFn);

package/lib/sso/interfaces/authorization-url-options.interface.d.ts

@@ -9,6 +9,7 @@ export interface SSOAuthorizationURLOptions {
     domainHint?: string;
     loginHint?: string;
     provider?: string;
+    providerQueryParams?: Record<string, string | boolean | number>;
     providerScopes?: string[];
     redirectUri: string;
     state?: string;

package/lib/sso/sso.d.ts

@@ -7,7 +7,7 @@ export declare class SSO {
     constructor(workos: WorkOS);
     listConnections(options?: ListConnectionsOptions): Promise<AutoPaginatable<Connection>>;
     deleteConnection(id: string): Promise<void>;
-    getAuthorizationUrl({ connection, clientId, domain, domainHint, loginHint, organization, provider, providerScopes, redirectUri, state, }: SSOAuthorizationURLOptions): string;
+    getAuthorizationUrl({ connection, clientId, domain, domainHint, loginHint, organization, provider, providerQueryParams, providerScopes, redirectUri, state, }: SSOAuthorizationURLOptions): string;
     getConnection(id: string): Promise<Connection>;
     getProfileAndToken<CustomAttributesType extends UnknownRecord = UnknownRecord>({ code, clientId, }: GetProfileAndTokenOptions): Promise<ProfileAndToken<CustomAttributesType>>;
     getProfile<CustomAttributesType extends UnknownRecord = UnknownRecord>({ accessToken, }: GetProfileOptions): Promise<Profile<CustomAttributesType>>;

package/lib/sso/sso.js

@@ -8,21 +8,23 @@ 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 });
 exports.SSO = void 0;
+const qs_1 = __importDefault(require("qs"));
 const fetch_and_deserialize_1 = require("../common/utils/fetch-and-deserialize");
 const pagination_1 = require("../common/utils/pagination");
 const serializers_1 = require("./serializers");
 const toQueryString = (options) => {
-    const searchParams = new URLSearchParams();
-    const keys = Object.keys(options).sort();
-    for (const key of keys) {
-        const value = options[key];
-        if (value) {
-            searchParams.append(key, value);
-        }
-    }
-    return searchParams.toString();
+    return qs_1.default.stringify(options, {
+        arrayFormat: 'repeat',
+        // sorts the keys alphabetically to maintain backwards compatibility
+        sort: (a, b) => a.localeCompare(b),
+        // encodes space as + instead of %20 to maintain backwards compatibility
+        format: 'RFC1738',
+    });
 };
 class SSO {
     constructor(workos) {
@@ -38,7 +40,7 @@ class SSO {
             yield this.workos.delete(`/connections/${id}`);
         });
     }
-    getAuthorizationUrl({ connection, clientId, domain, domainHint, loginHint, organization, provider, providerScopes, redirectUri, state, }) {
+    getAuthorizationUrl({ connection, clientId, domain, domainHint, loginHint, organization, provider, providerQueryParams, providerScopes, redirectUri, state, }) {
         if (!domain && !provider && !connection && !organization) {
             throw new Error(`Incomplete arguments. Need to specify either a 'connection', 'organization', 'domain', or 'provider'.`);
         }
@@ -52,7 +54,8 @@ class SSO {
             domain_hint: domainHint,
             login_hint: loginHint,
             provider,
-            provider_scopes: providerScopes === null || providerScopes === void 0 ? void 0 : providerScopes.join(' '),
+            provider_query_params: providerQueryParams,
+            provider_scopes: providerScopes,
             client_id: clientId,
             redirect_uri: redirectUri,
             response_type: 'code',

package/lib/sso/sso.spec.js

@@ -170,7 +170,7 @@ describe('SSO', () => {
                         clientId: 'proj_123',
                         redirectUri: 'example.com/sso/workos/callback',
                     });
-                    expect(url).toMatchInlineSnapshot(`"https://api.workos.com/sso/authorize?client_id=proj_123&provider=Google&provider_scopes=profile+email+calendar&redirect_uri=example.com%2Fsso%2Fworkos%2Fcallback&response_type=code"`);
+                    expect(url).toMatchSnapshot();
                 });
                 it('handles empty provider scopes array', () => {
                     const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
@@ -183,6 +183,32 @@ describe('SSO', () => {
                     expect(url).toMatchInlineSnapshot(`"https://api.workos.com/sso/authorize?client_id=proj_123&provider=Google&redirect_uri=example.com%2Fsso%2Fworkos%2Fcallback&response_type=code"`);
                 });
             });
+            describe('with providerQueryParams', () => {
+                it('generates an authorize url with the provided provider query params', () => {
+                    const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                    const url = workos.sso.getAuthorizationUrl({
+                        provider: 'Google',
+                        providerQueryParams: {
+                            custom_param: 'custom_value',
+                            another_param: 123,
+                            bool_param: true,
+                        },
+                        clientId: 'proj_123',
+                        redirectUri: 'example.com/sso/workos/callback',
+                    });
+                    expect(url).toMatchInlineSnapshot(`"https://api.workos.com/sso/authorize?client_id=proj_123&provider=Google&provider_query_params%5Banother_param%5D=123&provider_query_params%5Bbool_param%5D=true&provider_query_params%5Bcustom_param%5D=custom_value&redirect_uri=example.com%2Fsso%2Fworkos%2Fcallback&response_type=code"`);
+                });
+                it('handles empty provider query params', () => {
+                    const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                    const url = workos.sso.getAuthorizationUrl({
+                        provider: 'Google',
+                        providerQueryParams: {},
+                        clientId: 'proj_123',
+                        redirectUri: 'example.com/sso/workos/callback',
+                    });
+                    expect(url).toMatchInlineSnapshot(`"https://api.workos.com/sso/authorize?client_id=proj_123&provider=Google&redirect_uri=example.com%2Fsso%2Fworkos%2Fcallback&response_type=code"`);
+                });
+            });
         });
         describe('getProfileAndToken', () => {
             describe('with all information provided', () => {

package/lib/widgets/interfaces/get-token.d.ts

@@ -2,12 +2,12 @@ export type WidgetScope = 'widgets:users-table:manage' | 'widgets:sso:manage' |
 export interface GetTokenOptions {
     organizationId: string;
     userId?: string;
-    scopes?: [WidgetScope];
+    scopes?: WidgetScope[];
 }
 export interface SerializedGetTokenOptions {
     organization_id: string;
     user_id?: string;
-    scopes?: [WidgetScope];
+    scopes?: WidgetScope[];
 }
 export declare const serializeGetTokenOptions: (options: GetTokenOptions) => SerializedGetTokenOptions;
 export interface GetTokenResponse {

package/lib/workos.js

@@ -32,7 +32,7 @@ const actions_1 = require("./actions/actions");
 const vault_1 = require("./vault/vault");
 const conflict_exception_1 = require("./common/exceptions/conflict.exception");
 const parse_error_1 = require("./common/exceptions/parse-error");
-const VERSION = '7.69.0';
+const VERSION = '7.69.2';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 const HEADER_AUTHORIZATION = 'Authorization';
 const HEADER_IDEMPOTENCY_KEY = 'Idempotency-Key';
@@ -99,7 +99,7 @@ class WorkOS {
     }
     createHttpClient(options, userAgent) {
         var _a;
-        return new fetch_client_1.FetchHttpClient(this.baseURL, Object.assign(Object.assign({}, options.config), { headers: Object.assign(Object.assign({}, (_a = options.config) === null || _a === void 0 ? void 0 : _a.headers), { Authorization: `Bearer ${this.key}`, 'User-Agent': userAgent }) }));
+        return new fetch_client_1.FetchHttpClient(this.baseURL, Object.assign(Object.assign({}, options.config), { timeout: options.timeout, headers: Object.assign(Object.assign({}, (_a = options.config) === null || _a === void 0 ? void 0 : _a.headers), { Authorization: `Bearer ${this.key}`, 'User-Agent': userAgent }) }));
     }
     createIronSessionProvider() {
         throw new Error('IronSessionProvider not implemented. Use WorkOSNode or WorkOSWorker instead.');

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "7.69.0",
+  "version": "7.69.2",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",