@workos-inc/node 7.15.0 → 7.16.0

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

@@ -1,7 +1,7 @@
 import { DirectoryUser, DirectoryUserResponse, DirectoryGroup, DirectoryGroupResponse, EventDirectory, EventDirectoryResponse } from '../../directory-sync/interfaces';
 import { Organization, OrganizationResponse } from '../../organizations/interfaces';
 import { Connection, ConnectionResponse } from '../../sso/interfaces';
-import { EmailVerificationEvent, EmailVerificationEventResponse, InvitationEvent, InvitationEventResponse, MagicAuthEvent, MagicAuthEventResponse, PasswordResetEvent, PasswordResetEventResponse, Session, SessionResponse, User, UserResponse } from '../../user-management/interfaces';
+import { AuthenticationEvent, AuthenticationEventResponse, EmailVerificationEvent, EmailVerificationEventResponse, InvitationEvent, InvitationEventResponse, MagicAuthEvent, MagicAuthEventResponse, PasswordResetEvent, PasswordResetEventResponse, Session, SessionResponse, User, UserResponse } from '../../user-management/interfaces';
 import { OrganizationMembership, OrganizationMembershipResponse } from '../../user-management/interfaces/organization-membership.interface';
 import { RoleEvent, RoleEventResponse } from '../../roles/interfaces/role.interface';
 export interface EventBase {
@@ -12,6 +12,70 @@ interface EventResponseBase {
     id: string;
     created_at: string;
 }
+export interface AuthenticationEmailVerificationSucceededEvent extends EventBase {
+    event: 'authentication.email_verification_succeeded';
+    data: AuthenticationEvent;
+}
+export interface AuthenticationEmailVerificationSucceededEventResponse extends EventResponseBase {
+    event: 'authentication.email_verification_succeeded';
+    data: AuthenticationEventResponse;
+}
+export interface AuthenticationMagicAuthFailedEvent extends EventBase {
+    event: 'authentication.magic_auth_failed';
+    data: AuthenticationEvent;
+}
+export interface AuthenticationMagicAuthFailedEventResponse extends EventResponseBase {
+    event: 'authentication.magic_auth_failed';
+    data: AuthenticationEventResponse;
+}
+export interface AuthenticationMagicAuthSucceededEvent extends EventBase {
+    event: 'authentication.magic_auth_succeeded';
+    data: AuthenticationEvent;
+}
+export interface AuthenticationMagicAuthSucceededEventResponse extends EventResponseBase {
+    event: 'authentication.magic_auth_succeeded';
+    data: AuthenticationEventResponse;
+}
+export interface AuthenticationMfaSucceededEvent extends EventBase {
+    event: 'authentication.mfa_succeeded';
+    data: AuthenticationEvent;
+}
+export interface AuthenticationMfaSucceededEventResponse extends EventResponseBase {
+    event: 'authentication.mfa_succeeded';
+    data: AuthenticationEventResponse;
+}
+export interface AuthenticationOAuthSucceededEvent extends EventBase {
+    event: 'authentication.oauth_succeeded';
+    data: AuthenticationEvent;
+}
+export interface AuthenticationOAuthSucceededEventResponse extends EventResponseBase {
+    event: 'authentication.oauth_succeeded';
+    data: AuthenticationEventResponse;
+}
+export interface AuthenticationPasswordFailedEvent extends EventBase {
+    event: 'authentication.password_failed';
+    data: AuthenticationEvent;
+}
+export interface AuthenticationPasswordFailedEventResponse extends EventResponseBase {
+    event: 'authentication.password_failed';
+    data: AuthenticationEventResponse;
+}
+export interface AuthenticationPasswordSucceededEvent extends EventBase {
+    event: 'authentication.password_succeeded';
+    data: AuthenticationEvent;
+}
+export interface AuthenticationPasswordSucceededEventResponse extends EventResponseBase {
+    event: 'authentication.password_succeeded';
+    data: AuthenticationEventResponse;
+}
+export interface AuthenticationSSOSucceededEvent extends EventBase {
+    event: 'authentication.sso_succeeded';
+    data: AuthenticationEvent;
+}
+export interface AuthenticationSSOSucceededEventResponse extends EventResponseBase {
+    event: 'authentication.sso_succeeded';
+    data: AuthenticationEventResponse;
+}
 export interface ConnectionActivatedEvent extends EventBase {
     event: 'connection.activated';
     data: Connection;
@@ -296,7 +360,7 @@ export interface SessionCreatedEventResponse extends EventResponseBase {
     event: 'session.created';
     data: SessionResponse;
 }
-export type Event = ConnectionActivatedEvent | ConnectionDeactivatedEvent | ConnectionDeletedEvent | DsyncActivatedEvent | DsyncDeactivatedEvent | DsyncDeletedEvent | DsyncGroupCreatedEvent | DsyncGroupUpdatedEvent | DsyncGroupDeletedEvent | DsyncGroupUserAddedEvent | DsyncGroupUserRemovedEvent | DsyncUserCreatedEvent | DsyncUserUpdatedEvent | DsyncUserDeletedEvent | EmailVerificationCreatedEvent | InvitationCreatedEvent | MagicAuthCreatedEvent | PasswordResetCreatedEvent | UserCreatedEvent | UserUpdatedEvent | UserDeletedEvent | OrganizationMembershipAdded | OrganizationMembershipCreated | OrganizationMembershipDeleted | OrganizationMembershipUpdated | OrganizationMembershipRemoved | RoleCreatedEvent | RoleDeletedEvent | SessionCreatedEvent | OrganizationCreatedEvent | OrganizationUpdatedEvent | OrganizationDeletedEvent;
-export type EventResponse = ConnectionActivatedEventResponse | ConnectionDeactivatedEventResponse | ConnectionDeletedEventResponse | DsyncActivatedEventResponse | DsyncDeactivatedEventResponse | DsyncDeletedEventResponse | DsyncGroupCreatedEventResponse | DsyncGroupUpdatedEventResponse | DsyncGroupDeletedEventResponse | DsyncGroupUserAddedEventResponse | DsyncGroupUserRemovedEventResponse | DsyncUserCreatedEventResponse | DsyncUserUpdatedEventResponse | DsyncUserDeletedEventResponse | EmailVerificationCreatedEventResponse | InvitationCreatedEventResponse | MagicAuthCreatedEventResponse | PasswordResetCreatedEventResponse | UserCreatedEventResponse | UserUpdatedEventResponse | UserDeletedEventResponse | OrganizationMembershipAddedResponse | OrganizationMembershipCreatedResponse | OrganizationMembershipDeletedResponse | OrganizationMembershipUpdatedResponse | OrganizationMembershipRemovedResponse | RoleCreatedEventResponse | RoleDeletedEventResponse | SessionCreatedEventResponse | OrganizationCreatedResponse | OrganizationUpdatedResponse | OrganizationDeletedResponse;
+export type Event = AuthenticationEmailVerificationSucceededEvent | AuthenticationMfaSucceededEvent | AuthenticationOAuthSucceededEvent | AuthenticationSSOSucceededEvent | AuthenticationPasswordFailedEvent | AuthenticationPasswordSucceededEvent | AuthenticationMagicAuthFailedEvent | AuthenticationMagicAuthSucceededEvent | ConnectionActivatedEvent | ConnectionDeactivatedEvent | ConnectionDeletedEvent | DsyncActivatedEvent | DsyncDeactivatedEvent | DsyncDeletedEvent | DsyncGroupCreatedEvent | DsyncGroupUpdatedEvent | DsyncGroupDeletedEvent | DsyncGroupUserAddedEvent | DsyncGroupUserRemovedEvent | DsyncUserCreatedEvent | DsyncUserUpdatedEvent | DsyncUserDeletedEvent | EmailVerificationCreatedEvent | InvitationCreatedEvent | MagicAuthCreatedEvent | PasswordResetCreatedEvent | UserCreatedEvent | UserUpdatedEvent | UserDeletedEvent | OrganizationMembershipAdded | OrganizationMembershipCreated | OrganizationMembershipDeleted | OrganizationMembershipUpdated | OrganizationMembershipRemoved | RoleCreatedEvent | RoleDeletedEvent | SessionCreatedEvent | OrganizationCreatedEvent | OrganizationUpdatedEvent | OrganizationDeletedEvent;
+export type EventResponse = AuthenticationEmailVerificationSucceededEventResponse | AuthenticationMagicAuthFailedEventResponse | AuthenticationMagicAuthSucceededEventResponse | AuthenticationMfaSucceededEventResponse | AuthenticationOAuthSucceededEventResponse | AuthenticationPasswordFailedEventResponse | AuthenticationPasswordSucceededEventResponse | AuthenticationSSOSucceededEventResponse | ConnectionActivatedEventResponse | ConnectionDeactivatedEventResponse | ConnectionDeletedEventResponse | DsyncActivatedEventResponse | DsyncDeactivatedEventResponse | DsyncDeletedEventResponse | DsyncGroupCreatedEventResponse | DsyncGroupUpdatedEventResponse | DsyncGroupDeletedEventResponse | DsyncGroupUserAddedEventResponse | DsyncGroupUserRemovedEventResponse | DsyncUserCreatedEventResponse | DsyncUserUpdatedEventResponse | DsyncUserDeletedEventResponse | EmailVerificationCreatedEventResponse | InvitationCreatedEventResponse | MagicAuthCreatedEventResponse | PasswordResetCreatedEventResponse | UserCreatedEventResponse | UserUpdatedEventResponse | UserDeletedEventResponse | OrganizationMembershipAddedResponse | OrganizationMembershipCreatedResponse | OrganizationMembershipDeletedResponse | OrganizationMembershipUpdatedResponse | OrganizationMembershipRemovedResponse | RoleCreatedEventResponse | RoleDeletedEventResponse | SessionCreatedEventResponse | OrganizationCreatedResponse | OrganizationUpdatedResponse | OrganizationDeletedResponse;
 export type EventName = Event['event'];
 export {};

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

@@ -14,6 +14,15 @@ const deserializeEvent = (event) => {
         createdAt: event.created_at,
     };
     switch (event.event) {
+        case 'authentication.email_verification_succeeded':
+        case 'authentication.magic_auth_failed':
+        case 'authentication.magic_auth_succeeded':
+        case 'authentication.mfa_succeeded':
+        case 'authentication.oauth_succeeded':
+        case 'authentication.password_failed':
+        case 'authentication.password_succeeded':
+        case 'authentication.sso_succeeded':
+            return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, serializers_4.deserializeAuthenticationEvent)(event.data) });
         case 'connection.activated':
         case 'connection.deactivated':
         case 'connection.deleted':

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

@@ -0,0 +1,25 @@
+interface AuthenticationEventError {
+    code: string;
+    message: string;
+}
+type AuthenticationEventType = 'sso' | 'password' | 'oauth' | 'mfa' | 'magic_auth' | 'email_verification';
+type AuthenticationEventStatus = 'failed' | 'succeeded';
+export type AuthenticationEvent = {
+    email: string | null;
+    error?: AuthenticationEventError;
+    ipAddress: string | null;
+    status: AuthenticationEventStatus;
+    type: AuthenticationEventType;
+    userAgent: string | null;
+    userId: string | null;
+};
+export interface AuthenticationEventResponse {
+    email: string | null;
+    error?: AuthenticationEventError;
+    ip_address: string | null;
+    status: AuthenticationEventStatus;
+    type: AuthenticationEventType;
+    user_agent: string | null;
+    user_id: string | null;
+}
+export {};

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

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

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

@@ -1,3 +1,4 @@
+export * from './authentication-event.interface';
 export * from './authenticate-with-magic-auth-options.interface';
 export * from './authenticate-with-password-options.interface';
 export * from './authenticate-with-code-options.interface';

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

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./authentication-event.interface"), exports);
 __exportStar(require("./authenticate-with-magic-auth-options.interface"), exports);
 __exportStar(require("./authenticate-with-password-options.interface"), exports);
 __exportStar(require("./authenticate-with-code-options.interface"), exports);

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

@@ -0,0 +1,2 @@
+import { AuthenticationEvent, AuthenticationEventResponse } from '../interfaces';
+export declare const deserializeAuthenticationEvent: (authenticationEvent: AuthenticationEventResponse) => AuthenticationEvent;

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

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeAuthenticationEvent = void 0;
+const deserializeAuthenticationEvent = (authenticationEvent) => ({
+    email: authenticationEvent.email,
+    error: authenticationEvent.error,
+    ipAddress: authenticationEvent.ip_address,
+    status: authenticationEvent.status,
+    type: authenticationEvent.type,
+    userAgent: authenticationEvent.user_agent,
+    userId: authenticationEvent.user_id,
+});
+exports.deserializeAuthenticationEvent = deserializeAuthenticationEvent;

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

@@ -3,6 +3,7 @@ export * from './authenticate-with-magic-auth-options.serializer';
 export * from './authenticate-with-password-options.serializer';
 export * from './authenticate-with-refresh-token.options.serializer';
 export * from './authenticate-with-totp-options.serializer';
+export * from './authentication-event.serializer';
 export * from './authentication-response.serializer';
 export * from './create-magic-auth-options.serializer';
 export * from './create-password-reset-options.serializer';

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

@@ -19,6 +19,7 @@ __exportStar(require("./authenticate-with-magic-auth-options.serializer"), expor
 __exportStar(require("./authenticate-with-password-options.serializer"), exports);
 __exportStar(require("./authenticate-with-refresh-token.options.serializer"), exports);
 __exportStar(require("./authenticate-with-totp-options.serializer"), exports);
+__exportStar(require("./authentication-event.serializer"), exports);
 __exportStar(require("./authentication-response.serializer"), exports);
 __exportStar(require("./create-magic-auth-options.serializer"), exports);
 __exportStar(require("./create-password-reset-options.serializer"), exports);

package/lib/workos.js

@@ -26,7 +26,7 @@ const bad_request_exception_1 = require("./common/exceptions/bad-request.excepti
 const http_client_1 = require("./common/net/http-client");
 const subtle_crypto_provider_1 = require("./common/crypto/subtle-crypto-provider");
 const fetch_client_1 = require("./common/net/fetch-client");
-const VERSION = '7.15.0';
+const VERSION = '7.16.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "7.15.0",
+  "version": "7.16.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",