@workos-inc/node 7.47.0 → 7.49.0

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

@@ -5,6 +5,7 @@ import { AuthenticationEvent, AuthenticationEventResponse, EmailVerificationEven
 import { OrganizationMembership, OrganizationMembershipResponse } from '../../user-management/interfaces/organization-membership.interface';
 import { RoleEvent, RoleEventResponse } from '../../roles/interfaces/role.interface';
 import { OrganizationDomain, OrganizationDomainResponse } from '../../organization-domains/interfaces';
+import { AuthenticationRadarRiskDetectedEventData, AuthenticationRadarRiskDetectedEventResponseData } from '../../user-management/interfaces/authentication-radar-risk-detected-event.interface';
 export interface EventBase {
     id: string;
     createdAt: string;
@@ -77,6 +78,14 @@ export interface AuthenticationPasswordSucceededEventResponse extends EventRespo
     event: 'authentication.password_succeeded';
     data: AuthenticationEventResponse;
 }
+export interface AuthenticationRadarRiskDetectedEvent extends EventBase {
+    event: 'authentication.radar_risk_detected';
+    data: AuthenticationRadarRiskDetectedEventData;
+}
+export interface AuthenticationRadarRiskDetectedEventResponse extends EventResponseBase {
+    event: 'authentication.radar_risk_detected';
+    data: AuthenticationRadarRiskDetectedEventResponseData;
+}
 export interface AuthenticationSSOFailedEvent extends EventBase {
     event: 'authentication.sso_failed';
     data: AuthenticationEvent;
@@ -409,7 +418,7 @@ 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 | 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 | OrganizationCreatedEvent | OrganizationUpdatedEvent | OrganizationDeletedEvent | OrganizationDomainVerifiedEvent | OrganizationDomainVerificationFailedEvent;
-export type EventResponse = AuthenticationEmailVerificationSucceededEventResponse | AuthenticationMagicAuthFailedEventResponse | AuthenticationMagicAuthSucceededEventResponse | AuthenticationMfaSucceededEventResponse | AuthenticationOAuthFailedEventResponse | AuthenticationOAuthSucceededEventResponse | AuthenticationPasswordFailedEventResponse | AuthenticationPasswordSucceededEventResponse | AuthenticationSSOFailedEventResponse | AuthenticationSSOSucceededEventResponse | 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 | OrganizationCreatedResponse | OrganizationUpdatedResponse | OrganizationDeletedResponse | OrganizationDomainVerifiedEventResponse | OrganizationDomainVerificationFailedEventResponse;
+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 | 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 | OrganizationCreatedResponse | OrganizationUpdatedResponse | OrganizationDeletedResponse | OrganizationDomainVerifiedEventResponse | OrganizationDomainVerificationFailedEventResponse;
 export type EventName = Event['event'];
 export {};

package/lib/common/interfaces/unknown-record.interface.d.ts

@@ -0,0 +1 @@
+export type UnknownRecord = Record<string, unknown>;

package/lib/common/interfaces/unknown-record.interface.js

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

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

@@ -9,6 +9,7 @@ const organization_domain_serializer_1 = require("../../organization-domains/ser
 const organization_membership_serializer_1 = require("../../user-management/serializers/organization-membership.serializer");
 const role_serializer_1 = require("../../user-management/serializers/role.serializer");
 const session_serializer_1 = require("../../user-management/serializers/session.serializer");
+const authentication_radar_risk_event_serializer_1 = require("../../user-management/serializers/authentication-radar-risk-event-serializer");
 const deserializeEvent = (event) => {
     const eventBase = {
         id: event.id,
@@ -26,6 +27,8 @@ const deserializeEvent = (event) => {
         case 'authentication.sso_failed':
         case 'authentication.sso_succeeded':
             return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, serializers_4.deserializeAuthenticationEvent)(event.data) });
+        case 'authentication.radar_risk_detected':
+            return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, authentication_radar_risk_event_serializer_1.deserializeAuthenticationRadarRiskDetectedEvent)(event.data) });
         case 'connection.activated':
         case 'connection.deactivated':
         case 'connection.deleted':

package/lib/sso/interfaces/profile-and-token.interface.d.ts

@@ -1,9 +1,10 @@
+import { UnknownRecord } from '../../common/interfaces/unknown-record.interface';
 import { Profile, ProfileResponse } from './profile.interface';
-export interface ProfileAndToken {
+export interface ProfileAndToken<CustomAttributesType extends UnknownRecord> {
     accessToken: string;
-    profile: Profile;
+    profile: Profile<CustomAttributesType>;
 }
-export interface ProfileAndTokenResponse {
+export interface ProfileAndTokenResponse<CustomAttributesType extends UnknownRecord> {
     access_token: string;
-    profile: ProfileResponse;
+    profile: ProfileResponse<CustomAttributesType>;
 }

package/lib/sso/interfaces/profile.interface.d.ts

@@ -1,6 +1,7 @@
+import { UnknownRecord } from '../../common/interfaces/unknown-record.interface';
 import { RoleResponse } from '../../roles/interfaces';
 import { ConnectionType } from './connection-type.enum';
-export interface Profile {
+export interface Profile<CustomAttributesType extends UnknownRecord> {
     id: string;
     idpId: string;
     organizationId?: string;
@@ -11,11 +12,12 @@ export interface Profile {
     lastName?: string;
     role?: RoleResponse;
     groups?: string[];
+    customAttributes?: CustomAttributesType;
     rawAttributes?: {
         [key: string]: any;
     };
 }
-export interface ProfileResponse {
+export interface ProfileResponse<CustomAttributesType extends UnknownRecord> {
     id: string;
     idp_id: string;
     organization_id?: string;
@@ -26,6 +28,7 @@ export interface ProfileResponse {
     last_name?: string;
     role?: RoleResponse;
     groups?: string[];
+    custom_attributes?: CustomAttributesType;
     raw_attributes?: {
         [key: string]: any;
     };

package/lib/sso/serializers/profile-and-token.serializer.d.ts

@@ -1,2 +1,3 @@
+import { UnknownRecord } from '../../common/interfaces/unknown-record.interface';
 import { ProfileAndToken, ProfileAndTokenResponse } from '../interfaces';
-export declare const deserializeProfileAndToken: (profileAndToken: ProfileAndTokenResponse) => ProfileAndToken;
+export declare const deserializeProfileAndToken: <CustomAttributesType extends UnknownRecord>(profileAndToken: ProfileAndTokenResponse<CustomAttributesType>) => ProfileAndToken<CustomAttributesType>;

package/lib/sso/serializers/profile.serializer.d.ts

@@ -1,2 +1,3 @@
+import { UnknownRecord } from '../../common/interfaces/unknown-record.interface';
 import { Profile, ProfileResponse } from '../interfaces';
-export declare const deserializeProfile: (profile: ProfileResponse) => Profile;
+export declare const deserializeProfile: <CustomAttributesType extends UnknownRecord>(profile: ProfileResponse<CustomAttributesType>) => Profile<CustomAttributesType>;

package/lib/sso/serializers/profile.serializer.js

@@ -12,6 +12,7 @@ const deserializeProfile = (profile) => ({
     lastName: profile.last_name,
     role: profile.role,
     groups: profile.groups,
+    customAttributes: profile.custom_attributes,
     rawAttributes: profile.raw_attributes,
 });
 exports.deserializeProfile = deserializeProfile;

package/lib/sso/sso.d.ts

@@ -1,6 +1,7 @@
 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';
 export declare class SSO {
     private readonly workos;
     constructor(workos: WorkOS);
@@ -8,6 +9,6 @@ export declare class SSO {
     deleteConnection(id: string): Promise<void>;
     getAuthorizationUrl({ connection, clientId, domain, domainHint, loginHint, organization, provider, redirectUri, state, }: AuthorizationURLOptions): string;
     getConnection(id: string): Promise<Connection>;
-    getProfileAndToken({ code, clientId, }: GetProfileAndTokenOptions): Promise<ProfileAndToken>;
-    getProfile({ accessToken }: GetProfileOptions): Promise<Profile>;
+    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

@@ -77,7 +77,7 @@ class SSO {
             return (0, serializers_1.deserializeProfileAndToken)(data);
         });
     }
-    getProfile({ accessToken }) {
+    getProfile({ accessToken, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.workos.get('/sso/profile', {
                 accessToken,

package/lib/sso/sso.spec.js

@@ -185,6 +185,10 @@ describe('SSO', () => {
                                 first_name: 'foo',
                                 last_name: 'bar',
                                 groups: ['Admins', 'Developers'],
+                                license: 'professional',
+                            },
+                            custom_attributes: {
+                                license: 'professional',
                             },
                         },
                     });
@@ -221,6 +225,7 @@ describe('SSO', () => {
                                 first_name: 'foo',
                                 last_name: 'bar',
                             },
+                            custom_attributes: {},
                         },
                     });
                     const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
@@ -257,6 +262,7 @@ describe('SSO', () => {
                         last_name: 'bar',
                         groups: ['Admins', 'Developers'],
                     },
+                    custom_attributes: {},
                 });
                 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                 const profile = yield workos.sso.getProfile({

package/lib/user-management/interfaces/authentication-radar-risk-detected-event.interface.d.ts

@@ -0,0 +1,20 @@
+export type AuthenticationRadarRiskDetectedEventData = {
+    authMethod: string;
+    action: 'signup' | 'login';
+    control: string | null;
+    blocklistType: string | null;
+    ipAddress: string | null;
+    userAgent: string | null;
+    userId: string;
+    email: string;
+};
+export interface AuthenticationRadarRiskDetectedEventResponseData {
+    auth_method: string;
+    action: 'signup' | 'login';
+    control: string | null;
+    blocklist_type: string | null;
+    ip_address: string | null;
+    user_agent: string | null;
+    user_id: string;
+    email: string;
+}

package/lib/user-management/interfaces/authentication-radar-risk-detected-event.interface.js

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

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

@@ -3,6 +3,10 @@ export interface AuthorizationURLOptions {
     codeChallenge?: string;
     codeChallengeMethod?: 'S256';
     connectionId?: string;
+    /**
+     *  @deprecated We previously required initiate login endpoints to return the `context`
+     *  query parameter when getting the authorization URL. This is no longer necessary.
+     */
     context?: string;
     organizationId?: string;
     domainHint?: string;

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

@@ -9,6 +9,7 @@ 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 './create-magic-auth-options.interface';
 export * from './create-organization-membership-options.interface';
 export * from './create-password-reset-options.interface';

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

@@ -25,6 +25,7 @@ __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("./create-magic-auth-options.interface"), exports);
 __exportStar(require("./create-organization-membership-options.interface"), exports);
 __exportStar(require("./create-password-reset-options.interface"), exports);

package/lib/user-management/serializers/authentication-radar-risk-event-serializer.d.ts

@@ -0,0 +1,2 @@
+import type { AuthenticationRadarRiskDetectedEventData, AuthenticationRadarRiskDetectedEventResponseData } from '../interfaces';
+export declare const deserializeAuthenticationRadarRiskDetectedEvent: (authenticationRadarRiskDetectedEvent: AuthenticationRadarRiskDetectedEventResponseData) => AuthenticationRadarRiskDetectedEventData;

package/lib/user-management/serializers/authentication-radar-risk-event-serializer.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeAuthenticationRadarRiskDetectedEvent = void 0;
+const deserializeAuthenticationRadarRiskDetectedEvent = (authenticationRadarRiskDetectedEvent) => ({
+    authMethod: authenticationRadarRiskDetectedEvent.auth_method,
+    action: authenticationRadarRiskDetectedEvent.action,
+    control: authenticationRadarRiskDetectedEvent.control,
+    blocklistType: authenticationRadarRiskDetectedEvent.blocklist_type,
+    ipAddress: authenticationRadarRiskDetectedEvent.ip_address,
+    userAgent: authenticationRadarRiskDetectedEvent.user_agent,
+    userId: authenticationRadarRiskDetectedEvent.user_id,
+    email: authenticationRadarRiskDetectedEvent.email,
+});
+exports.deserializeAuthenticationRadarRiskDetectedEvent = deserializeAuthenticationRadarRiskDetectedEvent;

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

@@ -526,6 +526,10 @@ class UserManagement {
         if (provider !== 'authkit' && screenHint) {
             throw new TypeError(`'screenHint' is only supported for 'authkit' provider`);
         }
+        if (context) {
+            this.workos.emitWarning(`\`context\` is deprecated. We previously required initiate login endpoints to return the
+\`context\` query parameter when getting the authorization URL. This is no longer necessary.`);
+        }
         const query = toQueryString({
             connection_id: connectionId,
             code_challenge: codeChallenge,

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