@workos-inc/node 7.59.0 → 7.61.0

package/lib/common/exceptions/parse-error.d.ts

@@ -0,0 +1,8 @@
+import { RequestException } from '../interfaces/request-exception.interface';
+export declare class ParseError extends Error implements RequestException {
+    readonly name = "ParseError";
+    readonly status = 500;
+    readonly rawBody: string;
+    readonly requestID: string;
+    constructor(message: string, rawBody: string, requestID: string);
+}

package/lib/common/exceptions/parse-error.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParseError = void 0;
+class ParseError extends Error {
+    constructor(message, rawBody, requestID) {
+        super(message);
+        this.name = 'ParseError';
+        this.status = 500;
+        this.rawBody = rawBody;
+        this.requestID = requestID;
+    }
+}
+exports.ParseError = ParseError;

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

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

package/lib/user-management/user-management.d.ts

@@ -107,7 +107,7 @@ export declare class UserManagement {
     acceptInvitation(invitationId: string): Promise<Invitation>;
     revokeInvitation(invitationId: string): Promise<Invitation>;
     revokeSession(payload: RevokeSessionOptions): Promise<void>;
-    getAuthorizationUrl({ connectionId, codeChallenge, codeChallengeMethod, context, clientId, domainHint, loginHint, organizationId, provider, providerScopes, prompt, redirectUri, state, screenHint, }: UserManagementAuthorizationURLOptions): string;
+    getAuthorizationUrl({ connectionId, codeChallenge, codeChallengeMethod, context, clientId, domainHint, loginHint, organizationId, provider, providerQueryParams, providerScopes, prompt, redirectUri, state, screenHint, }: UserManagementAuthorizationURLOptions): string;
     getLogoutUrl({ sessionId, returnTo, }: {
         sessionId: string;
         returnTo?: string;

package/lib/user-management/user-management.js

@@ -19,9 +19,13 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserManagement = void 0;
 const jose_1 = require("jose");
+const qs_1 = __importDefault(require("qs"));
 const oauth_exception_1 = require("../common/exceptions/oauth.exception");
 const fetch_and_deserialize_1 = require("../common/utils/fetch-and-deserialize");
 const pagination_1 = require("../common/utils/pagination");
@@ -44,20 +48,13 @@ const send_invitation_options_serializer_1 = require("./serializers/send-invitat
 const update_organization_membership_options_serializer_1 = require("./serializers/update-organization-membership-options.serializer");
 const session_1 = require("./session");
 const toQueryString = (options) => {
-    const searchParams = new URLSearchParams();
-    const keys = Object.keys(options).sort();
-    for (const key of keys) {
-        const value = options[key];
-        if (Array.isArray(value)) {
-            value.forEach((item) => {
-                searchParams.append(key, item);
-            });
-        }
-        if (typeof value === 'string') {
-            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 UserManagement {
     constructor(workos, ironSessionProvider) {
@@ -535,7 +532,7 @@ class UserManagement {
             yield this.workos.post('/user_management/sessions/revoke', (0, revoke_session_options_interface_1.serializeRevokeSessionOptions)(payload));
         });
     }
-    getAuthorizationUrl({ connectionId, codeChallenge, codeChallengeMethod, context, clientId, domainHint, loginHint, organizationId, provider, providerScopes, prompt, redirectUri, state, screenHint, }) {
+    getAuthorizationUrl({ connectionId, codeChallenge, codeChallengeMethod, context, clientId, domainHint, loginHint, organizationId, provider, providerQueryParams, providerScopes, prompt, redirectUri, state, screenHint, }) {
         if (!provider && !connectionId && !organizationId) {
             throw new TypeError(`Incomplete arguments. Need to specify either a 'connectionId', 'organizationId', or 'provider'.`);
         }
@@ -555,6 +552,7 @@ class UserManagement {
             domain_hint: domainHint,
             login_hint: loginHint,
             provider,
+            provider_query_params: providerQueryParams,
             provider_scopes: providerScopes,
             prompt,
             client_id: clientId,

package/lib/user-management/user-management.spec.js

@@ -1671,6 +1671,22 @@ describe('UserManagement', () => {
                     });
                     expect(url).toMatchSnapshot();
                 });
+                describe('with providerQueryParams', () => {
+                    it('generates an authorize url that includes the specified query params', () => {
+                        const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                        const url = workos.userManagement.getAuthorizationUrl({
+                            provider: 'GoogleOAuth',
+                            clientId: 'proj_123',
+                            redirectUri: 'example.com/auth/workos/callback',
+                            providerQueryParams: {
+                                foo: 'bar',
+                                baz: 123,
+                                bool: true,
+                            },
+                        });
+                        expect(url).toMatchSnapshot();
+                    });
+                });
             });
         });
         describe('with a connectionId', () => {

package/lib/workos.d.ts

@@ -56,5 +56,6 @@ export declare class WorkOS {
     }>;
     delete(path: string, query?: any): Promise<void>;
     emitWarning(warning: string): void;
+    private handleParseError;
     private handleHttpError;
 }

package/lib/workos.js

@@ -31,7 +31,8 @@ const widgets_1 = require("./widgets/widgets");
 const actions_1 = require("./actions/actions");
 const vault_1 = require("./vault/vault");
 const conflict_exception_1 = require("./common/exceptions/conflict.exception");
-const VERSION = '7.59.0';
+const parse_error_1 = require("./common/exceptions/parse-error");
+const VERSION = '7.61.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 const HEADER_AUTHORIZATION = 'Authorization';
 const HEADER_IDEMPOTENCY_KEY = 'Idempotency-Key';
@@ -115,17 +116,24 @@ class WorkOS {
             if (options.warrantToken) {
                 requestHeaders[HEADER_WARRANT_TOKEN] = options.warrantToken;
             }
+            let res;
             try {
-                const res = yield this.client.post(path, entity, {
+                res = yield this.client.post(path, entity, {
                     params: options.query,
                     headers: requestHeaders,
                 });
-                return { data: yield res.toJSON() };
             }
             catch (error) {
                 this.handleHttpError({ path, error });
                 throw error;
             }
+            try {
+                return { data: yield res.toJSON() };
+            }
+            catch (error) {
+                yield this.handleParseError(error, res);
+                throw error;
+            }
         });
     }
     get(path, options = {}) {
@@ -137,17 +145,24 @@ class WorkOS {
             if (options.warrantToken) {
                 requestHeaders[HEADER_WARRANT_TOKEN] = options.warrantToken;
             }
+            let res;
             try {
-                const res = yield this.client.get(path, {
+                res = yield this.client.get(path, {
                     params: options.query,
                     headers: requestHeaders,
                 });
-                return { data: yield res.toJSON() };
             }
             catch (error) {
                 this.handleHttpError({ path, error });
                 throw error;
             }
+            try {
+                return { data: yield res.toJSON() };
+            }
+            catch (error) {
+                yield this.handleParseError(error, res);
+                throw error;
+            }
         });
     }
     put(path, entity, options = {}) {
@@ -156,17 +171,24 @@ class WorkOS {
             if (options.idempotencyKey) {
                 requestHeaders[HEADER_IDEMPOTENCY_KEY] = options.idempotencyKey;
             }
+            let res;
             try {
-                const res = yield this.client.put(path, entity, {
+                res = yield this.client.put(path, entity, {
                     params: options.query,
                     headers: requestHeaders,
                 });
-                return { data: yield res.toJSON() };
             }
             catch (error) {
                 this.handleHttpError({ path, error });
                 throw error;
             }
+            try {
+                return { data: yield res.toJSON() };
+            }
+            catch (error) {
+                yield this.handleParseError(error, res);
+                throw error;
+            }
         });
     }
     delete(path, query) {
@@ -186,6 +208,17 @@ class WorkOS {
         // tslint:disable-next-line:no-console
         console.warn(`WorkOS: ${warning}`);
     }
+    handleParseError(error, res) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (error instanceof SyntaxError) {
+                const rawResponse = res.getRawResponse();
+                const requestID = (_a = rawResponse.headers.get('X-Request-ID')) !== null && _a !== void 0 ? _a : '';
+                const rawBody = yield rawResponse.text();
+                throw new parse_error_1.ParseError(error.message, rawBody, requestID);
+            }
+        });
+    }
     handleHttpError({ path, error }) {
         var _a;
         if (!(error instanceof http_client_1.HttpClientError)) {

package/lib/workos.spec.js

@@ -16,6 +16,7 @@ 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");
@@ -218,6 +219,70 @@ describe('WorkOS', () => {
                 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;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "7.59.0",
+  "version": "7.61.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -41,7 +41,8 @@
     "iron-session": "~6.3.1",
     "jose": "~5.6.3",
     "leb": "^1.0.0",
-    "pluralize": "8.0.0"
+    "pluralize": "8.0.0",
+    "qs": "6.14.0"
   },
   "devDependencies": {
     "@peculiar/webcrypto": "^1.4.5",