@workos-inc/node 3.9.1 → 4.0.0

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,54 @@
+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 } 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';
+import { Factor, FactorWithSecrets } from './interfaces/factor.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: FactorWithSecrets;
+        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;
+}

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

@@ -0,0 +1,215 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserManagement = void 0;
+const pagination_1 = require("../common/utils/pagination");
+const serializers_1 = require("./serializers");
+const fetch_and_deserialize_1 = require("../common/utils/fetch-and-deserialize");
+const serializers_2 = require("../mfa/serializers");
+const organization_membership_serializer_1 = require("./serializers/organization-membership.serializer");
+const list_organization_memberships_options_serializer_1 = require("./serializers/list-organization-memberships-options.serializer");
+const create_organization_membership_options_serializer_1 = require("./serializers/create-organization-membership-options.serializer");
+const invitation_serializer_1 = require("./serializers/invitation.serializer");
+const list_invitations_options_serializer_1 = require("./serializers/list-invitations-options.serializer");
+const send_invitation_options_serializer_1 = require("./serializers/send-invitation-options.serializer");
+const list_users_options_serializer_1 = require("./serializers/list-users-options.serializer");
+const authenticate_with_email_verification_serializer_1 = require("./serializers/authenticate-with-email-verification.serializer");
+const authenticate_with_organization_selection_options_serializer_1 = require("./serializers/authenticate-with-organization-selection-options.serializer");
+const factor_serializer_1 = require("./serializers/factor.serializer");
+const toQueryString = (options) => {
+    const searchParams = new URLSearchParams();
+    const keys = Object.keys(options).sort();
+    for (const key of keys) {
+        const value = options[key];
+        if (value) {
+            searchParams.append(key, value);
+        }
+    }
+    return searchParams.toString();
+};
+class UserManagement {
+    constructor(workos) {
+        this.workos = workos;
+    }
+    getUser(userId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.get(`/user_management/users/${userId}`);
+            return (0, serializers_1.deserializeUser)(data);
+        });
+    }
+    listUsers(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new pagination_1.AutoPaginatable(yield (0, fetch_and_deserialize_1.fetchAndDeserialize)(this.workos, '/user_management/users', serializers_1.deserializeUser, options ? (0, list_users_options_serializer_1.serializeListUsersOptions)(options) : undefined), (params) => (0, fetch_and_deserialize_1.fetchAndDeserialize)(this.workos, '/user_management/users', serializers_1.deserializeUser, params), options);
+        });
+    }
+    createUser(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/user_management/users', (0, serializers_1.serializeCreateUserOptions)(payload));
+            return (0, serializers_1.deserializeUser)(data);
+        });
+    }
+    authenticateWithMagicAuth(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/user_management/authenticate', (0, serializers_1.serializeAuthenticateWithMagicAuthOptions)(Object.assign(Object.assign({}, payload), { clientSecret: this.workos.key })));
+            return (0, serializers_1.deserializeAuthenticationResponse)(data);
+        });
+    }
+    authenticateWithPassword(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/user_management/authenticate', (0, serializers_1.serializeAuthenticateWithPasswordOptions)(Object.assign(Object.assign({}, payload), { clientSecret: this.workos.key })));
+            return (0, serializers_1.deserializeAuthenticationResponse)(data);
+        });
+    }
+    authenticateWithCode(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/user_management/authenticate', (0, serializers_1.serializeAuthenticateWithCodeOptions)(Object.assign(Object.assign({}, payload), { clientSecret: this.workos.key })));
+            return (0, serializers_1.deserializeAuthenticationResponse)(data);
+        });
+    }
+    authenticateWithTotp(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/user_management/authenticate', (0, serializers_1.serializeAuthenticateWithTotpOptions)(Object.assign(Object.assign({}, payload), { clientSecret: this.workos.key })));
+            return (0, serializers_1.deserializeAuthenticationResponse)(data);
+        });
+    }
+    authenticateWithEmailVerification(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/user_management/authenticate', (0, authenticate_with_email_verification_serializer_1.serializeAuthenticateWithEmailVerificationOptions)(Object.assign(Object.assign({}, payload), { clientSecret: this.workos.key })));
+            return (0, serializers_1.deserializeAuthenticationResponse)(data);
+        });
+    }
+    authenticateWithOrganizationSelection(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/user_management/authenticate', (0, authenticate_with_organization_selection_options_serializer_1.serializeAuthenticateWithOrganizationSelectionOptions)(Object.assign(Object.assign({}, payload), { clientSecret: this.workos.key })));
+            return (0, serializers_1.deserializeAuthenticationResponse)(data);
+        });
+    }
+    sendVerificationEmail({ userId, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post(`/user_management/users/${userId}/email_verification/send`, {});
+            return { user: (0, serializers_1.deserializeUser)(data.user) };
+        });
+    }
+    sendMagicAuthCode(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.workos.post('/user_management/magic_auth/send', (0, serializers_1.serializeSendMagicAuthCodeOptions)(options));
+        });
+    }
+    verifyEmail({ code, userId, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post(`/user_management/users/${userId}/email_verification/confirm`, {
+                code,
+            });
+            return { user: (0, serializers_1.deserializeUser)(data.user) };
+        });
+    }
+    sendPasswordResetEmail(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.workos.post('/user_management/password_reset/send', (0, serializers_1.serializeSendPasswordResetEmailOptions)(payload));
+        });
+    }
+    resetPassword(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/user_management/password_reset/confirm', (0, serializers_1.serializeResetPasswordOptions)(payload));
+            return { user: (0, serializers_1.deserializeUser)(data.user) };
+        });
+    }
+    updateUser(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.put(`/user_management/users/${payload.userId}`, (0, serializers_1.serializeUpdateUserOptions)(payload));
+            return (0, serializers_1.deserializeUser)(data);
+        });
+    }
+    enrollAuthFactor(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post(`/user_management/users/${payload.userId}/auth_factors`, (0, serializers_1.serializeEnrollAuthFactorOptions)(payload));
+            return {
+                authenticationFactor: (0, serializers_1.deserializeFactorWithSecrets)(data.authentication_factor),
+                authenticationChallenge: (0, serializers_2.deserializeChallenge)(data.authentication_challenge),
+            };
+        });
+    }
+    listAuthFactors(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new pagination_1.AutoPaginatable(yield (0, fetch_and_deserialize_1.fetchAndDeserialize)(this.workos, `/user_management/users/${options.userId}/auth_factors`, factor_serializer_1.deserializeFactor, options), (params) => (0, fetch_and_deserialize_1.fetchAndDeserialize)(this.workos, `/user_management/users/${options.userId}/auth_factors`, factor_serializer_1.deserializeFactor, params), options);
+        });
+    }
+    deleteUser(userId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.workos.delete(`/user_management/users/${userId}`);
+        });
+    }
+    getOrganizationMembership(organizationMembershipId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.get(`/user_management/organization_memberships/${organizationMembershipId}`);
+            return (0, organization_membership_serializer_1.deserializeOrganizationMembership)(data);
+        });
+    }
+    listOrganizationMemberships(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new pagination_1.AutoPaginatable(yield (0, fetch_and_deserialize_1.fetchAndDeserialize)(this.workos, '/user_management/organization_memberships', organization_membership_serializer_1.deserializeOrganizationMembership, options
+                ? (0, list_organization_memberships_options_serializer_1.serializeListOrganizationMembershipsOptions)(options)
+                : undefined), (params) => (0, fetch_and_deserialize_1.fetchAndDeserialize)(this.workos, '/user_management/organization_memberships', organization_membership_serializer_1.deserializeOrganizationMembership, params), options);
+        });
+    }
+    createOrganizationMembership(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/user_management/organization_memberships', (0, create_organization_membership_options_serializer_1.serializeCreateOrganizationMembershipOptions)(options));
+            return (0, organization_membership_serializer_1.deserializeOrganizationMembership)(data);
+        });
+    }
+    deleteOrganizationMembership(organizationMembershipId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.workos.delete(`/user_management/organization_memberships/${organizationMembershipId}`);
+        });
+    }
+    getInvitation(invitationId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.get(`/user_management/invitations/${invitationId}`);
+            return (0, invitation_serializer_1.deserializeInvitation)(data);
+        });
+    }
+    listInvitations(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new pagination_1.AutoPaginatable(yield (0, fetch_and_deserialize_1.fetchAndDeserialize)(this.workos, '/user_management/invitations', invitation_serializer_1.deserializeInvitation, options ? (0, list_invitations_options_serializer_1.serializeListInvitationsOptions)(options) : undefined), (params) => (0, fetch_and_deserialize_1.fetchAndDeserialize)(this.workos, '/user_management/invitations', invitation_serializer_1.deserializeInvitation, params), options);
+        });
+    }
+    sendInvitation(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/user_management/invitations', (0, send_invitation_options_serializer_1.serializeSendInvitationOptions)(Object.assign({}, payload)));
+            return (0, invitation_serializer_1.deserializeInvitation)(data);
+        });
+    }
+    revokeInvitation(invitationId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post(`/user_management/invitations/${invitationId}/revoke`, null);
+            return (0, invitation_serializer_1.deserializeInvitation)(data);
+        });
+    }
+    getAuthorizationUrl({ connectionId, clientId, domainHint, loginHint, organizationId, provider, redirectUri, state, }) {
+        if (!provider && !connectionId && !organizationId) {
+            throw new Error(`Incomplete arguments. Need to specify either a 'connectionId', 'organizationId', or 'provider'.`);
+        }
+        const query = toQueryString({
+            connection_id: connectionId,
+            organization_id: organizationId,
+            domain_hint: domainHint,
+            login_hint: loginHint,
+            provider,
+            client_id: clientId,
+            redirect_uri: redirectUri,
+            response_type: 'code',
+            state,
+        });
+        return `${this.workos.baseURL}/user_management/authorize?${query}`;
+    }
+}
+exports.UserManagement = UserManagement;