@workos-inc/node 7.52.0 → 7.54.0

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

@@ -1,4 +1,4 @@
-export interface AuthorizationURLOptions {
+export interface SSOAuthorizationURLOptions {
     clientId: string;
     connection?: string;
     organization?: string;
@@ -12,3 +12,8 @@ export interface AuthorizationURLOptions {
     redirectUri: string;
     state?: string;
 }
+/**
+ * @deprecated Use SSOAuthorizationURLOptions instead
+ */
+export interface AuthorizationURLOptions extends SSOAuthorizationURLOptions {
+}

package/lib/sso/sso.d.ts

@@ -1,13 +1,13 @@
+import { UnknownRecord } from '../common/interfaces/unknown-record.interface';
 import { AutoPaginatable } from '../common/utils/pagination';
 import { WorkOS } from '../workos';
-import { AuthorizationURLOptions, Connection, GetProfileAndTokenOptions, GetProfileOptions, ListConnectionsOptions, Profile, ProfileAndToken } from './interfaces';
-import { UnknownRecord } from '../common/interfaces/unknown-record.interface';
+import { Connection, GetProfileAndTokenOptions, GetProfileOptions, ListConnectionsOptions, Profile, ProfileAndToken, SSOAuthorizationURLOptions } from './interfaces';
 export declare class SSO {
     private readonly workos;
     constructor(workos: WorkOS);
     listConnections(options?: ListConnectionsOptions): Promise<AutoPaginatable<Connection>>;
     deleteConnection(id: string): Promise<void>;
-    getAuthorizationUrl({ connection, clientId, domain, domainHint, loginHint, organization, provider, redirectUri, state, }: AuthorizationURLOptions): string;
+    getAuthorizationUrl({ connection, clientId, domain, domainHint, loginHint, organization, provider, 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

@@ -10,9 +10,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SSO = void 0;
+const fetch_and_deserialize_1 = require("../common/utils/fetch-and-deserialize");
 const pagination_1 = require("../common/utils/pagination");
 const serializers_1 = require("./serializers");
-const fetch_and_deserialize_1 = require("../common/utils/fetch-and-deserialize");
 const toQueryString = (options) => {
     const searchParams = new URLSearchParams();
     const keys = Object.keys(options).sort();

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

@@ -1,4 +1,4 @@
-export interface AuthorizationURLOptions {
+export interface UserManagementAuthorizationURLOptions {
     clientId: string;
     codeChallenge?: string;
     codeChallengeMethod?: 'S256';
@@ -12,6 +12,7 @@ export interface AuthorizationURLOptions {
     domainHint?: string;
     loginHint?: string;
     provider?: string;
+    providerScopes?: string[];
     redirectUri: string;
     state?: string;
     screenHint?: 'sign-up' | 'sign-in';

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

@@ -8,8 +8,9 @@ export * from './authenticate-with-refresh-token-options.interface';
 export * from './authenticate-with-session-cookie.interface';
 export * from './authenticate-with-totp-options.interface';
 export * from './authentication-event.interface';
-export * from './authentication-response.interface';
 export * from './authentication-radar-risk-detected-event.interface';
+export * from './authentication-response.interface';
+export * from './authorization-url-options.interface';
 export * from './create-magic-auth-options.interface';
 export * from './create-organization-membership-options.interface';
 export * from './create-password-reset-options.interface';
@@ -17,6 +18,7 @@ export * from './create-user-options.interface';
 export * from './email-verification.interface';
 export * from './enroll-auth-factor.interface';
 export * from './factor.interface';
+export * from './identity.interface';
 export * from './impersonator.interface';
 export * from './invitation.interface';
 export * from './list-auth-factors-options.interface';

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

@@ -24,8 +24,9 @@ __exportStar(require("./authenticate-with-refresh-token-options.interface"), exp
 __exportStar(require("./authenticate-with-session-cookie.interface"), exports);
 __exportStar(require("./authenticate-with-totp-options.interface"), exports);
 __exportStar(require("./authentication-event.interface"), exports);
-__exportStar(require("./authentication-response.interface"), exports);
 __exportStar(require("./authentication-radar-risk-detected-event.interface"), exports);
+__exportStar(require("./authentication-response.interface"), exports);
+__exportStar(require("./authorization-url-options.interface"), exports);
 __exportStar(require("./create-magic-auth-options.interface"), exports);
 __exportStar(require("./create-organization-membership-options.interface"), exports);
 __exportStar(require("./create-password-reset-options.interface"), exports);
@@ -33,6 +34,7 @@ __exportStar(require("./create-user-options.interface"), exports);
 __exportStar(require("./email-verification.interface"), exports);
 __exportStar(require("./enroll-auth-factor.interface"), exports);
 __exportStar(require("./factor.interface"), exports);
+__exportStar(require("./identity.interface"), exports);
 __exportStar(require("./impersonator.interface"), exports);
 __exportStar(require("./invitation.interface"), exports);
 __exportStar(require("./list-auth-factors-options.interface"), exports);

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

@@ -1,4 +1,5 @@
 import { createRemoteJWKSet } from 'jose';
+import { IronSessionProvider } from '../common/iron-session/iron-session-provider';
 import { AutoPaginatable } from '../common/utils/pagination';
 import { Challenge } from '../mfa/interfaces';
 import { WorkOS } from '../workos';
@@ -6,7 +7,7 @@ import { AuthenticateWithCodeOptions, AuthenticateWithMagicAuthOptions, Authenti
 import { AuthenticateWithEmailVerificationOptions } from './interfaces/authenticate-with-email-verification-options.interface';
 import { AuthenticateWithOrganizationSelectionOptions } from './interfaces/authenticate-with-organization-selection.interface';
 import { AuthenticateWithSessionCookieFailedResponse, AuthenticateWithSessionCookieOptions, AuthenticateWithSessionCookieSuccessResponse, SessionCookieData } from './interfaces/authenticate-with-session-cookie.interface';
-import { AuthorizationURLOptions } from './interfaces/authorization-url-options.interface';
+import { UserManagementAuthorizationURLOptions } from './interfaces/authorization-url-options.interface';
 import { CreateOrganizationMembershipOptions } from './interfaces/create-organization-membership-options.interface';
 import { Factor, FactorWithSecrets } from './interfaces/factor.interface';
 import { Identity } from './interfaces/identity.interface';
@@ -19,7 +20,6 @@ import { RevokeSessionOptions } from './interfaces/revoke-session-options.interf
 import { SendInvitationOptions } from './interfaces/send-invitation-options.interface';
 import { SessionHandlerOptions } from './interfaces/session-handler-options.interface';
 import { UpdateOrganizationMembershipOptions } from './interfaces/update-organization-membership-options.interface';
-import { IronSessionProvider } from '../common/iron-session/iron-session-provider';
 import { Session } from './session';
 export declare class UserManagement {
     private readonly workos;
@@ -106,7 +106,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, redirectUri, state, screenHint, }: AuthorizationURLOptions): string;
+    getAuthorizationUrl({ connectionId, codeChallenge, codeChallengeMethod, context, clientId, domainHint, loginHint, organizationId, provider, providerScopes, redirectUri, state, screenHint, }: UserManagementAuthorizationURLOptions): string;
     getLogoutUrl({ sessionId, returnTo, }: {
         sessionId: string;
         returnTo?: string;

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

@@ -48,7 +48,12 @@ const toQueryString = (options) => {
     const keys = Object.keys(options).sort();
     for (const key of keys) {
         const value = options[key];
-        if (value) {
+        if (Array.isArray(value)) {
+            value.forEach((item) => {
+                searchParams.append(key, item);
+            });
+        }
+        if (typeof value === 'string') {
             searchParams.append(key, value);
         }
     }
@@ -519,7 +524,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, redirectUri, state, screenHint, }) {
+    getAuthorizationUrl({ connectionId, codeChallenge, codeChallengeMethod, context, clientId, domainHint, loginHint, organizationId, provider, providerScopes, redirectUri, state, screenHint, }) {
         if (!provider && !connectionId && !organizationId) {
             throw new TypeError(`Incomplete arguments. Need to specify either a 'connectionId', 'organizationId', or 'provider'.`);
         }
@@ -539,6 +544,7 @@ class UserManagement {
             domain_hint: domainHint,
             login_hint: loginHint,
             provider,
+            provider_scopes: providerScopes,
             client_id: clientId,
             redirect_uri: redirectUri,
             response_type: 'code',

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

@@ -1545,7 +1545,7 @@ describe('UserManagement', () => {
             it('generates an authorize url with the default api hostname', () => {
                 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                 const url = workos.userManagement.getAuthorizationUrl({
-                    provider: 'Google',
+                    provider: 'GoogleOAuth',
                     clientId: 'proj_123',
                     redirectUri: 'example.com/auth/workos/callback',
                 });
@@ -1566,12 +1566,27 @@ describe('UserManagement', () => {
             it('generates an authorize url with the provider', () => {
                 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                 const url = workos.userManagement.getAuthorizationUrl({
-                    provider: 'Google',
+                    provider: 'GoogleOAuth',
                     clientId: 'proj_123',
                     redirectUri: 'example.com/auth/workos/callback',
                 });
                 expect(url).toMatchSnapshot();
             });
+            describe('with providerScopes', () => {
+                it('generates an authorize url that includes the specified scopes', () => {
+                    const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                    const url = workos.userManagement.getAuthorizationUrl({
+                        provider: 'GoogleOAuth',
+                        providerScopes: [
+                            'https://www.googleapis.com/auth/calendar',
+                            'https://www.googleapis.com/auth/admin.directory.group',
+                        ],
+                        clientId: 'proj_123',
+                        redirectUri: 'example.com/auth/workos/callback',
+                    });
+                    expect(url).toMatchSnapshot();
+                });
+            });
         });
         describe('with a connectionId', () => {
             it('generates an authorize url with the connection', () => {
@@ -1583,6 +1598,18 @@ describe('UserManagement', () => {
                 });
                 expect(url).toMatchSnapshot();
             });
+            describe('with providerScopes', () => {
+                it('generates an authorize url that includes the specified scopes', () => {
+                    const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                    const url = workos.userManagement.getAuthorizationUrl({
+                        connectionId: 'connection_123',
+                        providerScopes: ['read_api', 'read_repository'],
+                        clientId: 'proj_123',
+                        redirectUri: 'example.com/auth/workos/callback',
+                    });
+                    expect(url).toMatchSnapshot();
+                });
+            });
         });
         describe('with an organizationId', () => {
             it('generates an authorization URL with the organization', () => {

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.52.0';
+const VERSION = '7.54.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.52.0",
+  "version": "7.54.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",