@workos-inc/node 3.9.2 → 4.0.1

package/lib/{users → user-management}/interfaces/authentication-response.interface.d.ts

@@ -1,7 +1,9 @@
 import { User, UserResponse } from './user.interface';
 export interface AuthenticationResponse {
     user: User;
+    organizationId: string;
 }
 export interface AuthenticationResponseResponse {
     user: UserResponse;
+    organization_id: string;
 }

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

@@ -0,0 +1,10 @@
+export interface AuthorizationURLOptions {
+    clientId: string;
+    connectionId?: string;
+    organizationId?: string;
+    domainHint?: string;
+    loginHint?: string;
+    provider?: string;
+    redirectURI: string;
+    state?: string;
+}

package/lib/user-management/interfaces/create-organization-membership-options.interface.d.ts

@@ -0,0 +1,8 @@
+export interface CreateOrganizationMembershipOptions {
+    organizationId: string;
+    userId: string;
+}
+export interface SerializedCreateOrganizationMembershipOptions {
+    organization_id: string;
+    user_id: string;
+}

package/lib/{users → user-management}/interfaces/enroll-auth-factor.interface.d.ts

@@ -1,11 +1,11 @@
 export interface EnrollAuthFactorOptions {
     userId: string;
     type: 'totp';
-    totpIssuer: string;
-    totpUser: string;
+    totpIssuer?: string;
+    totpUser?: string;
 }
 export interface SerializedEnrollUserInMfaFactorOptions {
     type: 'totp';
-    totp_issuer: string;
-    totp_user: string;
+    totp_issuer?: string;
+    totp_user?: string;
 }

package/lib/{users → user-management}/interfaces/index.d.ts

@@ -1,20 +1,17 @@
-export * from './add-user-to-organization-options.interface';
 export * from './authenticate-with-magic-auth-options.interface';
 export * from './authenticate-with-password-options.interface';
 export * from './authenticate-with-code-options.interface';
 export * from './authenticate-with-totp-options.interface';
 export * from './authentication-response.interface';
 export * from './reset-password-options.interface';
-export * from './send-password-reset-options.interface';
+export * from './send-password-reset-email-options.interface';
 export * from './create-user-options.interface';
-export * from './delete-user-options.interface';
 export * from './enroll-auth-factor.interface';
 export * from './list-users-options.interface';
 export * from './list-auth-factors-options.interface';
-export * from './remove-user-from-organization-options.interface';
 export * from './send-magic-auth-code-options.interface';
 export * from './send-verification-email-options';
 export * from './update-user-options.interface';
 export * from './update-user-password-options.interface';
 export * from './user.interface';
-export * from './verify-email-code-options.interface';
+export * from './verify-email-options.interface';

package/lib/{users → user-management}/interfaces/index.js

@@ -14,23 +14,20 @@ 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("./add-user-to-organization-options.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);
 __exportStar(require("./authenticate-with-totp-options.interface"), exports);
 __exportStar(require("./authentication-response.interface"), exports);
 __exportStar(require("./reset-password-options.interface"), exports);
-__exportStar(require("./send-password-reset-options.interface"), exports);
+__exportStar(require("./send-password-reset-email-options.interface"), exports);
 __exportStar(require("./create-user-options.interface"), exports);
-__exportStar(require("./delete-user-options.interface"), exports);
 __exportStar(require("./enroll-auth-factor.interface"), exports);
 __exportStar(require("./list-users-options.interface"), exports);
 __exportStar(require("./list-auth-factors-options.interface"), exports);
-__exportStar(require("./remove-user-from-organization-options.interface"), exports);
 __exportStar(require("./send-magic-auth-code-options.interface"), exports);
 __exportStar(require("./send-verification-email-options"), exports);
 __exportStar(require("./update-user-options.interface"), exports);
 __exportStar(require("./update-user-password-options.interface"), exports);
 __exportStar(require("./user.interface"), exports);
-__exportStar(require("./verify-email-code-options.interface"), exports);
+__exportStar(require("./verify-email-options.interface"), exports);

package/lib/user-management/interfaces/invitation.interface.d.ts

@@ -0,0 +1,26 @@
+export interface Invitation {
+    object: 'invitation';
+    id: string;
+    email: string;
+    state: 'pending' | 'accepted' | 'expired' | 'revoked';
+    acceptedAt: string | null;
+    revokedAt: string | null;
+    expiresAt: string;
+    organizationId: string | null;
+    token: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface InvitationResponse {
+    object: 'invitation';
+    id: string;
+    email: string;
+    state: 'pending' | 'accepted' | 'expired' | 'revoked';
+    accepted_at: string | null;
+    revoked_at: string | null;
+    expires_at: string;
+    organization_id: string | null;
+    token: string;
+    created_at: string;
+    updated_at: string;
+}

package/lib/user-management/interfaces/list-invitations-options.interface.d.ts

@@ -0,0 +1,9 @@
+import { PaginationOptions } from '../../common/interfaces';
+export interface ListInvitationsOptions extends PaginationOptions {
+    organizationId?: string;
+    email?: string;
+}
+export interface SerializedListInvitationsOptions extends PaginationOptions {
+    organization_id?: string;
+    email?: string;
+}

package/lib/user-management/interfaces/list-organization-memberships-options.interface.d.ts

@@ -0,0 +1,9 @@
+import { PaginationOptions } from '../../common/interfaces';
+export interface ListOrganizationMembershipsOptions extends PaginationOptions {
+    organizationId?: string;
+    userId?: string;
+}
+export interface SerializedListOrganizationMembershipsOptions extends PaginationOptions {
+    organization_id?: string;
+    user_id?: string;
+}

package/lib/{users → user-management}/interfaces/list-users-options.interface.d.ts

@@ -1,5 +1,9 @@
 import { PaginationOptions } from '../../common/interfaces/pagination-options.interface';
 export interface ListUsersOptions extends PaginationOptions {
     email?: string;
-    organization?: string;
+    organizationId?: string;
+}
+export interface SerializedListUsersOptions extends PaginationOptions {
+    email?: string;
+    organization_id?: string;
 }

package/lib/user-management/interfaces/organization-membership.interface.d.ts

@@ -0,0 +1,16 @@
+export interface OrganizationMembership {
+    object: 'organization_membership';
+    id: string;
+    organizationId: string;
+    userId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface OrganizationMembershipResponse {
+    object: 'organization_membership';
+    id: string;
+    organization_id: string;
+    user_id: string;
+    created_at: string;
+    updated_at: string;
+}

package/lib/user-management/interfaces/send-invitation-options.interface.d.ts

@@ -0,0 +1,12 @@
+export interface SendInvitationOptions {
+    email: string;
+    organizationId?: string;
+    expiresInDays?: number;
+    inviterUserId?: string;
+}
+export interface SerializedSendInvitationOptions {
+    email: string;
+    organization_id?: string;
+    expires_in_days?: number;
+    inviter_user_id?: string;
+}

package/lib/user-management/interfaces/send-password-reset-email-options.interface.d.ts

@@ -0,0 +1,8 @@
+export interface SendPasswordResetEmailOptions {
+    email: string;
+    passwordResetUrl: string;
+}
+export interface SerializedSendPasswordResetEmailOptions {
+    email: string;
+    password_reset_url: string;
+}

package/lib/{users → user-management}/interfaces/update-user-options.interface.d.ts

@@ -3,9 +3,15 @@ export interface UpdateUserOptions {
     firstName?: string;
     lastName?: string;
     emailVerified?: boolean;
+    password?: string;
+    passwordHash?: string;
+    passwordHashType?: 'bcrypt';
 }
 export interface SerializedUpdateUserOptions {
     first_name?: string;
     last_name?: string;
     email_verified?: boolean;
+    password?: string;
+    password_hash?: string;
+    password_hash_type?: 'bcrypt';
 }

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

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

package/lib/user-management/interfaces/verify-email-options.interface.d.ts

@@ -0,0 +1,7 @@
+export interface VerifyEmailOptions {
+    code: string;
+    userId: string;
+}
+export interface SerializedVerifyEmailOptions {
+    code: string;
+}

package/lib/user-management/interfaces/verify-email-options.interface.js

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

package/lib/user-management/serializers/authenticate-with-email-verification.serializer.d.ts

@@ -0,0 +1,2 @@
+import { AuthenticateUserWithEmailVerificationCredentials, AuthenticateWithEmailVerificationOptions, SerializedAuthenticateWithEmailVerificationOptions } from '../interfaces/authenticate-with-email-verification-options.interface';
+export declare const serializeAuthenticateWithEmailVerificationOptions: (options: AuthenticateWithEmailVerificationOptions & AuthenticateUserWithEmailVerificationCredentials) => SerializedAuthenticateWithEmailVerificationOptions;

package/lib/user-management/serializers/authenticate-with-email-verification.serializer.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeAuthenticateWithEmailVerificationOptions = void 0;
+const serializeAuthenticateWithEmailVerificationOptions = (options) => ({
+    grant_type: 'urn:workos:oauth:grant-type:email-verification:code',
+    client_id: options.clientId,
+    client_secret: options.clientSecret,
+    pending_authentication_token: options.pendingAuthenticationToken,
+    code: options.code,
+    ip_address: options.ipAddress,
+    user_agent: options.userAgent,
+});
+exports.serializeAuthenticateWithEmailVerificationOptions = serializeAuthenticateWithEmailVerificationOptions;

package/lib/{users → user-management}/serializers/authenticate-with-magic-auth-options.serializer.js

@@ -6,7 +6,8 @@ const serializeAuthenticateWithMagicAuthOptions = (options) => ({
     client_id: options.clientId,
     client_secret: options.clientSecret,
     code: options.code,
-    user_id: options.userId,
+    email: options.email,
+    link_authorization_code: options.linkAuthorizationCode,
     ip_address: options.ipAddress,
     user_agent: options.userAgent,
 });

package/lib/user-management/serializers/authenticate-with-organization-selection-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { AuthenticateUserWithOrganizationSelectionCredentials, AuthenticateWithOrganizationSelectionOptions, SerializedAuthenticateWithOrganizationSelectionOptions } from '../interfaces/authenticate-with-organization-selection.interface';
+export declare const serializeAuthenticateWithOrganizationSelectionOptions: (options: AuthenticateWithOrganizationSelectionOptions & AuthenticateUserWithOrganizationSelectionCredentials) => SerializedAuthenticateWithOrganizationSelectionOptions;

package/lib/user-management/serializers/authenticate-with-organization-selection-options.serializer.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeAuthenticateWithOrganizationSelectionOptions = void 0;
+const serializeAuthenticateWithOrganizationSelectionOptions = (options) => ({
+    grant_type: 'urn:workos:oauth:grant-type:organization-selection',
+    client_id: options.clientId,
+    client_secret: options.clientSecret,
+    pending_authentication_token: options.pendingAuthenticationToken,
+    organization_id: options.organizationId,
+    ip_address: options.ipAddress,
+    user_agent: options.userAgent,
+});
+exports.serializeAuthenticateWithOrganizationSelectionOptions = serializeAuthenticateWithOrganizationSelectionOptions;

package/lib/{users → user-management}/serializers/authentication-response.serializer.js

@@ -4,5 +4,6 @@ exports.deserializeAuthenticationResponse = void 0;
 const user_serializer_1 = require("./user.serializer");
 const deserializeAuthenticationResponse = (authenticationResponse) => ({
     user: (0, user_serializer_1.deserializeUser)(authenticationResponse.user),
+    organizationId: authenticationResponse.organization_id,
 });
 exports.deserializeAuthenticationResponse = deserializeAuthenticationResponse;

package/lib/user-management/serializers/create-organization-membership-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { CreateOrganizationMembershipOptions, SerializedCreateOrganizationMembershipOptions } from '../interfaces/create-organization-membership-options.interface';
+export declare const serializeCreateOrganizationMembershipOptions: (options: CreateOrganizationMembershipOptions) => SerializedCreateOrganizationMembershipOptions;

package/lib/user-management/serializers/create-organization-membership-options.serializer.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeCreateOrganizationMembershipOptions = void 0;
+const serializeCreateOrganizationMembershipOptions = (options) => ({
+    organization_id: options.organizationId,
+    user_id: options.userId,
+});
+exports.serializeCreateOrganizationMembershipOptions = serializeCreateOrganizationMembershipOptions;

package/lib/user-management/serializers/invitation.serializer.d.ts

@@ -0,0 +1,2 @@
+import { Invitation, InvitationResponse } from '../interfaces/invitation.interface';
+export declare const deserializeInvitation: (invitation: InvitationResponse) => Invitation;

package/lib/user-management/serializers/invitation.serializer.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeInvitation = void 0;
+const deserializeInvitation = (invitation) => ({
+    object: invitation.object,
+    id: invitation.id,
+    email: invitation.email,
+    state: invitation.state,
+    acceptedAt: invitation.accepted_at,
+    revokedAt: invitation.revoked_at,
+    expiresAt: invitation.expires_at,
+    organizationId: invitation.organization_id,
+    token: invitation.token,
+    createdAt: invitation.created_at,
+    updatedAt: invitation.updated_at,
+});
+exports.deserializeInvitation = deserializeInvitation;

package/lib/user-management/serializers/list-invitations-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { ListInvitationsOptions, SerializedListInvitationsOptions } from '../interfaces/list-invitations-options.interface';
+export declare const serializeListInvitationsOptions: (options: ListInvitationsOptions) => SerializedListInvitationsOptions;

package/lib/user-management/serializers/list-invitations-options.serializer.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeListInvitationsOptions = void 0;
+const serializeListInvitationsOptions = (options) => ({
+    email: options.email,
+    organization_id: options.organizationId,
+    limit: options.limit,
+    before: options.before,
+    after: options.after,
+    order: options.order,
+});
+exports.serializeListInvitationsOptions = serializeListInvitationsOptions;

package/lib/user-management/serializers/list-organization-memberships-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { ListOrganizationMembershipsOptions, SerializedListOrganizationMembershipsOptions } from '../interfaces/list-organization-memberships-options.interface';
+export declare const serializeListOrganizationMembershipsOptions: (options: ListOrganizationMembershipsOptions) => SerializedListOrganizationMembershipsOptions;

package/lib/user-management/serializers/list-organization-memberships-options.serializer.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeListOrganizationMembershipsOptions = void 0;
+const serializeListOrganizationMembershipsOptions = (options) => ({
+    user_id: options.userId,
+    organization_id: options.organizationId,
+    limit: options.limit,
+    before: options.before,
+    after: options.after,
+    order: options.order,
+});
+exports.serializeListOrganizationMembershipsOptions = serializeListOrganizationMembershipsOptions;

package/lib/user-management/serializers/list-users-options.serializer.d.ts

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

package/lib/user-management/serializers/list-users-options.serializer.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeListUsersOptions = void 0;
+const serializeListUsersOptions = (options) => ({
+    email: options.email,
+    organization_id: options.organizationId,
+    limit: options.limit,
+    before: options.before,
+    after: options.after,
+    order: options.order,
+});
+exports.serializeListUsersOptions = serializeListUsersOptions;

package/lib/user-management/serializers/organization-membership.serializer.d.ts

@@ -0,0 +1,2 @@
+import { OrganizationMembership, OrganizationMembershipResponse } from '../interfaces/organization-membership.interface';
+export declare const deserializeOrganizationMembership: (organizationMembership: OrganizationMembershipResponse) => OrganizationMembership;

package/lib/user-management/serializers/organization-membership.serializer.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeOrganizationMembership = void 0;
+const deserializeOrganizationMembership = (organizationMembership) => ({
+    object: organizationMembership.object,
+    id: organizationMembership.id,
+    userId: organizationMembership.user_id,
+    organizationId: organizationMembership.organization_id,
+    createdAt: organizationMembership.created_at,
+    updatedAt: organizationMembership.updated_at,
+});
+exports.deserializeOrganizationMembership = deserializeOrganizationMembership;

package/lib/user-management/serializers/send-invitation-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { SendInvitationOptions, SerializedSendInvitationOptions } from '../interfaces/send-invitation-options.interface';
+export declare const serializeSendInvitationOptions: (options: SendInvitationOptions) => SerializedSendInvitationOptions;

package/lib/user-management/serializers/send-invitation-options.serializer.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeSendInvitationOptions = void 0;
+const serializeSendInvitationOptions = (options) => ({
+    email: options.email,
+    organization_id: options.organizationId,
+    expires_in_days: options.expiresInDays,
+    inviter_user_id: options.inviterUserId,
+});
+exports.serializeSendInvitationOptions = serializeSendInvitationOptions;

package/lib/user-management/serializers/send-password-reset-email.serializer.d.ts

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

package/lib/user-management/serializers/send-password-reset-email.serializer.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeSendPasswordResetEmailOptions = void 0;
+const serializeSendPasswordResetEmailOptions = (options) => ({
+    email: options.email,
+    password_reset_url: options.passwordResetUrl,
+});
+exports.serializeSendPasswordResetEmailOptions = serializeSendPasswordResetEmailOptions;

package/lib/{users → user-management}/serializers/update-user-options.serializer.js

@@ -5,5 +5,8 @@ const serializeUpdateUserOptions = (options) => ({
     first_name: options.firstName,
     last_name: options.lastName,
     email_verified: options.emailVerified,
+    password: options.password,
+    password_hash: options.passwordHash,
+    password_hash_type: options.passwordHashType,
 });
 exports.serializeUpdateUserOptions = serializeUpdateUserOptions;

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

@@ -0,0 +1,53 @@
+import { WorkOS } from '../workos';
+import { AutoPaginatable } from '../common/utils/pagination';
+import { AuthenticateWithCodeOptions, AuthenticateWithMagicAuthOptions, AuthenticateWithPasswordOptions, AuthenticateWithTotpOptions, AuthenticationResponse, ResetPasswordOptions, SendPasswordResetEmailOptions, CreateUserOptions, EnrollAuthFactorOptions, ListAuthFactorsOptions, ListUsersOptions, SendMagicAuthCodeOptions, SendVerificationEmailOptions, UpdateUserOptions, User, VerifyEmailOptions } from './interfaces';
+import { Challenge, Factor } from '../mfa/interfaces';
+import { OrganizationMembership } from './interfaces/organization-membership.interface';
+import { ListOrganizationMembershipsOptions } from './interfaces/list-organization-memberships-options.interface';
+import { CreateOrganizationMembershipOptions } from './interfaces/create-organization-membership-options.interface';
+import { Invitation } from './interfaces/invitation.interface';
+import { ListInvitationsOptions } from './interfaces/list-invitations-options.interface';
+import { SendInvitationOptions } from './interfaces/send-invitation-options.interface';
+import { AuthorizationURLOptions } from './interfaces/authorization-url-options.interface';
+import { AuthenticateWithEmailVerificationOptions } from './interfaces/authenticate-with-email-verification-options.interface';
+import { AuthenticateWithOrganizationSelectionOptions } from './interfaces/authenticate-with-organization-selection.interface';
+export declare class UserManagement {
+    private readonly workos;
+    constructor(workos: WorkOS);
+    getUser(userId: string): Promise<User>;
+    listUsers(options?: ListUsersOptions): Promise<AutoPaginatable<User>>;
+    createUser(payload: CreateUserOptions): Promise<User>;
+    authenticateWithMagicAuth(payload: AuthenticateWithMagicAuthOptions): Promise<AuthenticationResponse>;
+    authenticateWithPassword(payload: AuthenticateWithPasswordOptions): Promise<AuthenticationResponse>;
+    authenticateWithCode(payload: AuthenticateWithCodeOptions): Promise<AuthenticationResponse>;
+    authenticateWithTotp(payload: AuthenticateWithTotpOptions): Promise<AuthenticationResponse>;
+    authenticateWithEmailVerification(payload: AuthenticateWithEmailVerificationOptions): Promise<AuthenticationResponse>;
+    authenticateWithOrganizationSelection(payload: AuthenticateWithOrganizationSelectionOptions): Promise<AuthenticationResponse>;
+    sendVerificationEmail({ userId, }: SendVerificationEmailOptions): Promise<{
+        user: User;
+    }>;
+    sendMagicAuthCode(options: SendMagicAuthCodeOptions): Promise<void>;
+    verifyEmail({ code, userId, }: VerifyEmailOptions): Promise<{
+        user: User;
+    }>;
+    sendPasswordResetEmail(payload: SendPasswordResetEmailOptions): Promise<void>;
+    resetPassword(payload: ResetPasswordOptions): Promise<{
+        user: User;
+    }>;
+    updateUser(payload: UpdateUserOptions): Promise<User>;
+    enrollAuthFactor(payload: EnrollAuthFactorOptions): Promise<{
+        authenticationFactor: Factor;
+        authenticationChallenge: Challenge;
+    }>;
+    listAuthFactors(options: ListAuthFactorsOptions): Promise<AutoPaginatable<Factor>>;
+    deleteUser(userId: string): Promise<void>;
+    getOrganizationMembership(organizationMembershipId: string): Promise<OrganizationMembership>;
+    listOrganizationMemberships(options: ListOrganizationMembershipsOptions): Promise<AutoPaginatable<OrganizationMembership>>;
+    createOrganizationMembership(options: CreateOrganizationMembershipOptions): Promise<OrganizationMembership>;
+    deleteOrganizationMembership(organizationMembershipId: string): Promise<void>;
+    getInvitation(invitationId: string): Promise<Invitation>;
+    listInvitations(options: ListInvitationsOptions): Promise<AutoPaginatable<Invitation>>;
+    sendInvitation(payload: SendInvitationOptions): Promise<Invitation>;
+    revokeInvitation(invitationId: string): Promise<Invitation>;
+    getAuthorizationUrl({ connectionId, clientId, domainHint, loginHint, organizationId, provider, redirectURI, state, }: AuthorizationURLOptions): string;
+}