@workos-inc/node 7.56.0 → 7.58.0

package/lib/common/interfaces/event.interface.d.ts

@@ -426,7 +426,31 @@ export interface OrganizationDomainVerificationFailedEventResponse extends Event
     event: 'organization_domain.verification_failed';
     data: OrganizationDomainResponse;
 }
-export type Event = AuthenticationEmailVerificationSucceededEvent | AuthenticationMfaSucceededEvent | AuthenticationOAuthFailedEvent | AuthenticationOAuthSucceededEvent | AuthenticationSSOFailedEvent | AuthenticationSSOSucceededEvent | AuthenticationPasswordFailedEvent | AuthenticationPasswordSucceededEvent | AuthenticationMagicAuthFailedEvent | AuthenticationMagicAuthSucceededEvent | AuthenticationRadarRiskDetectedEvent | ConnectionActivatedEvent | ConnectionDeactivatedEvent | ConnectionDeletedEvent | DsyncActivatedEvent | DsyncDeactivatedEvent | DsyncDeletedEvent | DsyncGroupCreatedEvent | DsyncGroupUpdatedEvent | DsyncGroupDeletedEvent | DsyncGroupUserAddedEvent | DsyncGroupUserRemovedEvent | DsyncUserCreatedEvent | DsyncUserUpdatedEvent | DsyncUserDeletedEvent | EmailVerificationCreatedEvent | InvitationCreatedEvent | MagicAuthCreatedEvent | PasswordResetCreatedEvent | PasswordResetSucceededEvent | UserCreatedEvent | UserUpdatedEvent | UserDeletedEvent | OrganizationMembershipAdded | OrganizationMembershipCreated | OrganizationMembershipDeleted | OrganizationMembershipUpdated | OrganizationMembershipRemoved | RoleCreatedEvent | RoleDeletedEvent | RoleUpdatedEvent | SessionCreatedEvent | SessionRevokedEvent | OrganizationCreatedEvent | OrganizationUpdatedEvent | OrganizationDeletedEvent | OrganizationDomainVerifiedEvent | OrganizationDomainVerificationFailedEvent;
-export type EventResponse = AuthenticationEmailVerificationSucceededEventResponse | AuthenticationMagicAuthFailedEventResponse | AuthenticationMagicAuthSucceededEventResponse | AuthenticationMfaSucceededEventResponse | AuthenticationOAuthFailedEventResponse | AuthenticationOAuthSucceededEventResponse | AuthenticationPasswordFailedEventResponse | AuthenticationPasswordSucceededEventResponse | AuthenticationSSOFailedEventResponse | AuthenticationSSOSucceededEventResponse | AuthenticationRadarRiskDetectedEventResponse | ConnectionActivatedEventResponse | ConnectionDeactivatedEventResponse | ConnectionDeletedEventResponse | DsyncActivatedEventResponse | DsyncDeactivatedEventResponse | DsyncDeletedEventResponse | DsyncGroupCreatedEventResponse | DsyncGroupUpdatedEventResponse | DsyncGroupDeletedEventResponse | DsyncGroupUserAddedEventResponse | DsyncGroupUserRemovedEventResponse | DsyncUserCreatedEventResponse | DsyncUserUpdatedEventResponse | DsyncUserDeletedEventResponse | EmailVerificationCreatedEventResponse | InvitationCreatedEventResponse | MagicAuthCreatedEventResponse | PasswordResetCreatedEventResponse | PasswordResetSucceededEventResponse | UserCreatedEventResponse | UserUpdatedEventResponse | UserDeletedEventResponse | OrganizationMembershipAddedResponse | OrganizationMembershipCreatedResponse | OrganizationMembershipDeletedResponse | OrganizationMembershipUpdatedResponse | OrganizationMembershipRemovedResponse | RoleCreatedEventResponse | RoleDeletedEventResponse | RoleUpdatedEventResponse | SessionCreatedEventResponse | SessionRevokedEventResponse | OrganizationCreatedResponse | OrganizationUpdatedResponse | OrganizationDeletedResponse | OrganizationDomainVerifiedEventResponse | OrganizationDomainVerificationFailedEventResponse;
+export interface OrganizationDomainCreatedEvent extends EventBase {
+    event: 'organization_domain.created';
+    data: OrganizationDomain;
+}
+export interface OrganizationDomainCreatedEventResponse extends EventResponseBase {
+    event: 'organization_domain.created';
+    data: OrganizationDomainResponse;
+}
+export interface OrganizationDomainUpdatedEvent extends EventBase {
+    event: 'organization_domain.updated';
+    data: OrganizationDomain;
+}
+export interface OrganizationDomainUpdatedEventResponse extends EventResponseBase {
+    event: 'organization_domain.updated';
+    data: OrganizationDomainResponse;
+}
+export interface OrganizationDomainDeletedEvent extends EventBase {
+    event: 'organization_domain.deleted';
+    data: OrganizationDomain;
+}
+export interface OrganizationDomainDeletedEventResponse extends EventResponseBase {
+    event: 'organization_domain.deleted';
+    data: OrganizationDomainResponse;
+}
+export type Event = AuthenticationEmailVerificationSucceededEvent | AuthenticationMfaSucceededEvent | AuthenticationOAuthFailedEvent | AuthenticationOAuthSucceededEvent | AuthenticationSSOFailedEvent | AuthenticationSSOSucceededEvent | AuthenticationPasswordFailedEvent | AuthenticationPasswordSucceededEvent | AuthenticationMagicAuthFailedEvent | AuthenticationMagicAuthSucceededEvent | AuthenticationRadarRiskDetectedEvent | ConnectionActivatedEvent | ConnectionDeactivatedEvent | ConnectionDeletedEvent | DsyncActivatedEvent | DsyncDeactivatedEvent | DsyncDeletedEvent | DsyncGroupCreatedEvent | DsyncGroupUpdatedEvent | DsyncGroupDeletedEvent | DsyncGroupUserAddedEvent | DsyncGroupUserRemovedEvent | DsyncUserCreatedEvent | DsyncUserUpdatedEvent | DsyncUserDeletedEvent | EmailVerificationCreatedEvent | InvitationCreatedEvent | MagicAuthCreatedEvent | PasswordResetCreatedEvent | PasswordResetSucceededEvent | UserCreatedEvent | UserUpdatedEvent | UserDeletedEvent | OrganizationMembershipAdded | OrganizationMembershipCreated | OrganizationMembershipDeleted | OrganizationMembershipUpdated | OrganizationMembershipRemoved | RoleCreatedEvent | RoleDeletedEvent | RoleUpdatedEvent | SessionCreatedEvent | SessionRevokedEvent | OrganizationCreatedEvent | OrganizationUpdatedEvent | OrganizationDeletedEvent | OrganizationDomainVerifiedEvent | OrganizationDomainVerificationFailedEvent | OrganizationDomainCreatedEvent | OrganizationDomainUpdatedEvent | OrganizationDomainDeletedEvent;
+export type EventResponse = AuthenticationEmailVerificationSucceededEventResponse | AuthenticationMagicAuthFailedEventResponse | AuthenticationMagicAuthSucceededEventResponse | AuthenticationMfaSucceededEventResponse | AuthenticationOAuthFailedEventResponse | AuthenticationOAuthSucceededEventResponse | AuthenticationPasswordFailedEventResponse | AuthenticationPasswordSucceededEventResponse | AuthenticationSSOFailedEventResponse | AuthenticationSSOSucceededEventResponse | AuthenticationRadarRiskDetectedEventResponse | ConnectionActivatedEventResponse | ConnectionDeactivatedEventResponse | ConnectionDeletedEventResponse | DsyncActivatedEventResponse | DsyncDeactivatedEventResponse | DsyncDeletedEventResponse | DsyncGroupCreatedEventResponse | DsyncGroupUpdatedEventResponse | DsyncGroupDeletedEventResponse | DsyncGroupUserAddedEventResponse | DsyncGroupUserRemovedEventResponse | DsyncUserCreatedEventResponse | DsyncUserUpdatedEventResponse | DsyncUserDeletedEventResponse | EmailVerificationCreatedEventResponse | InvitationCreatedEventResponse | MagicAuthCreatedEventResponse | PasswordResetCreatedEventResponse | PasswordResetSucceededEventResponse | UserCreatedEventResponse | UserUpdatedEventResponse | UserDeletedEventResponse | OrganizationMembershipAddedResponse | OrganizationMembershipCreatedResponse | OrganizationMembershipDeletedResponse | OrganizationMembershipUpdatedResponse | OrganizationMembershipRemovedResponse | RoleCreatedEventResponse | RoleDeletedEventResponse | RoleUpdatedEventResponse | SessionCreatedEventResponse | SessionRevokedEventResponse | OrganizationCreatedResponse | OrganizationUpdatedResponse | OrganizationDeletedResponse | OrganizationDomainVerifiedEventResponse | OrganizationDomainVerificationFailedEventResponse | OrganizationDomainCreatedEventResponse | OrganizationDomainUpdatedEventResponse | OrganizationDomainDeletedEventResponse;
 export type EventName = Event['event'];
 export {};

package/lib/common/serializers/event.serializer.js

@@ -87,6 +87,9 @@ const deserializeEvent = (event) => {
             return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, serializers_2.deserializeOrganization)(event.data) });
         case 'organization_domain.verified':
         case 'organization_domain.verification_failed':
+        case 'organization_domain.created':
+        case 'organization_domain.updated':
+        case 'organization_domain.deleted':
             return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, organization_domain_serializer_1.deserializeOrganizationDomain)(event.data) });
     }
 };

package/lib/organization-domains/interfaces/organization-domain.interface.d.ts

@@ -19,6 +19,8 @@ export interface OrganizationDomain {
     state: OrganizationDomainState;
     verificationToken?: string;
     verificationStrategy: OrganizationDomainVerificationStrategy;
+    createdAt: string;
+    updatedAt: string;
 }
 export interface OrganizationDomainResponse {
     object: 'organization_domain';
@@ -28,4 +30,6 @@ export interface OrganizationDomainResponse {
     state: OrganizationDomainState;
     verification_token?: string;
     verification_strategy: OrganizationDomainVerificationStrategy;
+    created_at: string;
+    updated_at: string;
 }

package/lib/organization-domains/serializers/organization-domain.serializer.js

@@ -9,5 +9,7 @@ const deserializeOrganizationDomain = (organizationDomain) => ({
     state: organizationDomain.state,
     verificationToken: organizationDomain.verification_token,
     verificationStrategy: organizationDomain.verification_strategy,
+    createdAt: organizationDomain.created_at,
+    updatedAt: organizationDomain.updated_at,
 });
 exports.deserializeOrganizationDomain = deserializeOrganizationDomain;

package/lib/user-management/interfaces/authenticate-with-code-and-verifier-options.interface.d.ts

@@ -0,0 +1,12 @@
+import { AuthenticateWithOptionsBase, SerializedAuthenticateWithPKCEBase } from './authenticate-with-options-base.interface';
+export interface AuthenticateWithCodeAndVerifierOptions extends AuthenticateWithOptionsBase {
+    codeVerifier: string;
+    code: string;
+    invitationToken?: string;
+}
+export interface SerializedAuthenticateWithCodeAndVerifierOptions extends SerializedAuthenticateWithPKCEBase {
+    grant_type: 'authorization_code';
+    code_verifier: string;
+    code: string;
+    invitation_token?: string;
+}

package/lib/user-management/interfaces/authenticate-with-code-and-verifier-options.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/user-management/interfaces/authenticate-with-options-base.interface.d.ts

@@ -14,3 +14,8 @@ export interface SerializedAuthenticateWithOptionsBase {
     ip_address?: string;
     user_agent?: string;
 }
+export interface SerializedAuthenticateWithPKCEBase {
+    client_id: string;
+    ip_address?: string;
+    user_agent?: string;
+}

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

@@ -1,4 +1,5 @@
 export * from './authenticate-with-code-options.interface';
+export * from './authenticate-with-code-and-verifier-options.interface';
 export * from './authenticate-with-email-verification-options.interface';
 export * from './authenticate-with-magic-auth-options.interface';
 export * from './authenticate-with-options-base.interface';

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

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./authenticate-with-code-options.interface"), exports);
+__exportStar(require("./authenticate-with-code-and-verifier-options.interface"), exports);
 __exportStar(require("./authenticate-with-email-verification-options.interface"), exports);
 __exportStar(require("./authenticate-with-magic-auth-options.interface"), exports);
 __exportStar(require("./authenticate-with-options-base.interface"), exports);

package/lib/user-management/serializers/authenticate-with-code-and-verifier-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { AuthenticateWithCodeAndVerifierOptions, SerializedAuthenticateWithCodeAndVerifierOptions } from '../interfaces';
+export declare const serializeAuthenticateWithCodeAndVerifierOptions: (options: AuthenticateWithCodeAndVerifierOptions) => SerializedAuthenticateWithCodeAndVerifierOptions;

package/lib/user-management/serializers/authenticate-with-code-and-verifier-options.serializer.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeAuthenticateWithCodeAndVerifierOptions = void 0;
+const serializeAuthenticateWithCodeAndVerifierOptions = (options) => ({
+    grant_type: 'authorization_code',
+    client_id: options.clientId,
+    code: options.code,
+    code_verifier: options.codeVerifier,
+    invitation_token: options.invitationToken,
+    ip_address: options.ipAddress,
+    user_agent: options.userAgent,
+});
+exports.serializeAuthenticateWithCodeAndVerifierOptions = serializeAuthenticateWithCodeAndVerifierOptions;

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

@@ -1,4 +1,5 @@
 export * from './authenticate-with-code-options.serializer';
+export * from './authenticate-with-code-and-verifier-options.serializer';
 export * from './authenticate-with-magic-auth-options.serializer';
 export * from './authenticate-with-password-options.serializer';
 export * from './authenticate-with-refresh-token.options.serializer';

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

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./authenticate-with-code-options.serializer"), exports);
+__exportStar(require("./authenticate-with-code-and-verifier-options.serializer"), exports);
 __exportStar(require("./authenticate-with-magic-auth-options.serializer"), exports);
 __exportStar(require("./authenticate-with-password-options.serializer"), exports);
 __exportStar(require("./authenticate-with-refresh-token.options.serializer"), exports);

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

@@ -3,7 +3,7 @@ import { IronSessionProvider } from '../common/iron-session/iron-session-provide
 import { AutoPaginatable } from '../common/utils/pagination';
 import { Challenge } from '../mfa/interfaces';
 import { WorkOS } from '../workos';
-import { AuthenticateWithCodeOptions, AuthenticateWithMagicAuthOptions, AuthenticateWithPasswordOptions, AuthenticateWithRefreshTokenOptions, AuthenticateWithTotpOptions, AuthenticationResponse, CreateMagicAuthOptions, CreatePasswordResetOptions, CreateUserOptions, EmailVerification, EnrollAuthFactorOptions, ListAuthFactorsOptions, ListUsersOptions, MagicAuth, PasswordReset, ResetPasswordOptions, SendMagicAuthCodeOptions, SendPasswordResetEmailOptions, SendVerificationEmailOptions, UpdateUserOptions, User, VerifyEmailOptions } from './interfaces';
+import { AuthenticateWithCodeOptions, AuthenticateWithCodeAndVerifierOptions, AuthenticateWithMagicAuthOptions, AuthenticateWithPasswordOptions, AuthenticateWithRefreshTokenOptions, AuthenticateWithTotpOptions, AuthenticationResponse, CreateMagicAuthOptions, CreatePasswordResetOptions, CreateUserOptions, EmailVerification, EnrollAuthFactorOptions, ListAuthFactorsOptions, ListUsersOptions, MagicAuth, PasswordReset, ResetPasswordOptions, SendMagicAuthCodeOptions, SendPasswordResetEmailOptions, SendVerificationEmailOptions, UpdateUserOptions, User, VerifyEmailOptions } from './interfaces';
 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';
@@ -47,6 +47,7 @@ export declare class UserManagement {
     authenticateWithMagicAuth(payload: AuthenticateWithMagicAuthOptions): Promise<AuthenticationResponse>;
     authenticateWithPassword(payload: AuthenticateWithPasswordOptions): Promise<AuthenticationResponse>;
     authenticateWithCode(payload: AuthenticateWithCodeOptions): Promise<AuthenticationResponse>;
+    authenticateWithCodeAndVerifier(payload: AuthenticateWithCodeAndVerifierOptions): Promise<AuthenticationResponse>;
     authenticateWithRefreshToken(payload: AuthenticateWithRefreshTokenOptions): Promise<AuthenticationResponse>;
     authenticateWithTotp(payload: AuthenticateWithTotpOptions): Promise<AuthenticationResponse>;
     authenticateWithEmailVerification(payload: AuthenticateWithEmailVerificationOptions): Promise<AuthenticationResponse>;

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

@@ -141,6 +141,16 @@ class UserManagement {
             });
         });
     }
+    authenticateWithCodeAndVerifier(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { session } = payload, remainingPayload = __rest(payload, ["session"]);
+            const { data } = yield this.workos.post('/user_management/authenticate', (0, serializers_2.serializeAuthenticateWithCodeAndVerifierOptions)(remainingPayload));
+            return this.prepareAuthenticationResponse({
+                authenticationResponse: (0, serializers_2.deserializeAuthenticationResponse)(data),
+                session,
+            });
+        });
+    }
     authenticateWithRefreshToken(payload) {
         return __awaiter(this, void 0, void 0, function* () {
             const { session } = payload, remainingPayload = __rest(payload, ["session"]);

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

@@ -433,6 +433,90 @@ describe('UserManagement', () => {
             }));
         });
     });
+    describe('authenticateWithCodeAndVerifier', () => {
+        it('sends a token authentication request with required code_verifier', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)({ user: user_json_1.default });
+            const resp = yield workos.userManagement.authenticateWithCodeAndVerifier({
+                clientId: 'proj_whatever',
+                code: 'auth_code_123',
+                codeVerifier: 'required_code_verifier',
+            });
+            expect((0, test_utils_1.fetchURL)()).toContain('/user_management/authenticate');
+            expect((0, test_utils_1.fetchBody)()).toEqual({
+                client_id: 'proj_whatever',
+                code: 'auth_code_123',
+                code_verifier: 'required_code_verifier',
+                grant_type: 'authorization_code',
+            });
+            expect(resp).toMatchObject({
+                user: {
+                    email: 'test01@example.com',
+                },
+            });
+        }));
+        it('sends a token authentication request with invitation token', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)({ user: user_json_1.default });
+            const resp = yield workos.userManagement.authenticateWithCodeAndVerifier({
+                clientId: 'proj_whatever',
+                code: 'auth_code_123',
+                codeVerifier: 'required_code_verifier',
+                invitationToken: 'invitation_123',
+            });
+            expect((0, test_utils_1.fetchURL)()).toContain('/user_management/authenticate');
+            expect((0, test_utils_1.fetchBody)()).toEqual({
+                client_id: 'proj_whatever',
+                code: 'auth_code_123',
+                code_verifier: 'required_code_verifier',
+                invitation_token: 'invitation_123',
+                grant_type: 'authorization_code',
+            });
+            expect(resp).toMatchObject({
+                user: {
+                    email: 'test01@example.com',
+                },
+            });
+        }));
+        describe('when sealSession = true', () => {
+            beforeEach(() => {
+                (0, test_utils_1.fetchOnce)({
+                    user: user_json_1.default,
+                    access_token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ewogICJzdWIiOiAiMTIzNDU2Nzg5MCIsCiAgIm5hbWUiOiAiSm9obiBEb2UiLAogICJpYXQiOiAxNTE2MjM5MDIyLAogICJzaWQiOiAic2Vzc2lvbl8xMjMiLAogICJvcmdfaWQiOiAib3JnXzEyMyIsCiAgInJvbGUiOiAibWVtYmVyIiwKICAicGVybWlzc2lvbnMiOiBbInBvc3RzOmNyZWF0ZSIsICJwb3N0czpkZWxldGUiXQp9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c',
+                });
+            });
+            describe('when the cookie password is undefined', () => {
+                it('throws an error', () => __awaiter(void 0, void 0, void 0, function* () {
+                    yield expect(workos.userManagement.authenticateWithCodeAndVerifier({
+                        clientId: 'proj_whatever',
+                        code: 'auth_code_123',
+                        codeVerifier: 'required_code_verifier',
+                        session: { sealSession: true },
+                    })).rejects.toThrow('Cookie password is required');
+                }));
+            });
+            describe('when successfully authenticated', () => {
+                it('returns the sealed session data', () => __awaiter(void 0, void 0, void 0, function* () {
+                    const cookiePassword = 'alongcookiesecretmadefortestingsessions';
+                    const response = yield workos.userManagement.authenticateWithCodeAndVerifier({
+                        clientId: 'proj_whatever',
+                        code: 'auth_code_123',
+                        codeVerifier: 'required_code_verifier',
+                        session: { sealSession: true, cookiePassword },
+                    });
+                    expect(response).toEqual({
+                        sealedSession: expect.any(String),
+                        accessToken: expect.any(String),
+                        authenticationMethod: undefined,
+                        impersonator: undefined,
+                        organizationId: undefined,
+                        refreshToken: undefined,
+                        user: expect.objectContaining({
+                            email: 'test01@example.com',
+                        }),
+                    });
+                }));
+            });
+        });
+    });
     describe('authenticateWithRefreshToken', () => {
         it('sends a refresh_token authentication request', () => __awaiter(void 0, void 0, void 0, function* () {
             (0, test_utils_1.fetchOnce)({

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