@workos-inc/node 7.58.0 → 7.60.0

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

@@ -12,7 +12,9 @@ export interface UserManagementAuthorizationURLOptions {
     domainHint?: string;
     loginHint?: string;
     provider?: string;
+    providerQueryParams?: Record<string, string | boolean | number>;
     providerScopes?: string[];
+    prompt?: string;
     redirectUri: string;
     state?: string;
     screenHint?: 'sign-up' | 'sign-in';

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, 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, 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,7 +552,9 @@ class UserManagement {
             domain_hint: domainHint,
             login_hint: loginHint,
             provider,
+            provider_query_params: providerQueryParams,
             provider_scopes: providerScopes,
+            prompt,
             client_id: clientId,
             redirect_uri: redirectUri,
             response_type: 'code',

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', () => {
@@ -1758,6 +1774,29 @@ describe('UserManagement', () => {
                 expect(url).toMatchInlineSnapshot(`"https://api.workos.com/user_management/authorize?client_id=proj_123&connection_id=connection_123&login_hint=foo%40workos.com&redirect_uri=example.com%2Fauth%2Fworkos%2Fcallback&response_type=code&state=custom+state"`);
             });
         });
+        describe('with prompt', () => {
+            it('generates an authorize url with the provided prompt', () => {
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                const url = workos.userManagement.getAuthorizationUrl({
+                    prompt: 'login',
+                    connectionId: 'connection_123',
+                    clientId: 'proj_123',
+                    redirectUri: 'example.com/auth/workos/callback',
+                    state: 'custom state',
+                });
+                expect(url).toMatchInlineSnapshot(`"https://api.workos.com/user_management/authorize?client_id=proj_123&connection_id=connection_123&prompt=login&redirect_uri=example.com%2Fauth%2Fworkos%2Fcallback&response_type=code&state=custom+state"`);
+            });
+            it('generates an authorize url with consent prompt', () => {
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                const url = workos.userManagement.getAuthorizationUrl({
+                    prompt: 'consent',
+                    provider: 'GoogleOAuth',
+                    clientId: 'proj_123',
+                    redirectUri: 'example.com/auth/workos/callback',
+                });
+                expect(url).toMatchInlineSnapshot(`"https://api.workos.com/user_management/authorize?client_id=proj_123&prompt=consent&provider=GoogleOAuth&redirect_uri=example.com%2Fauth%2Fworkos%2Fcallback&response_type=code"`);
+            });
+        });
     });
     describe('getLogoutUrl', () => {
         it('returns a logout url', () => {

package/lib/workos.js

@@ -31,7 +31,7 @@ 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.58.0';
+const VERSION = '7.60.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 const HEADER_AUTHORIZATION = 'Authorization';
 const HEADER_IDEMPOTENCY_KEY = 'Idempotency-Key';

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "7.58.0",
+  "version": "7.60.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",