@workos-inc/node 3.9.1 → 4.0.0

package/lib/workos.d.ts

@@ -1,5 +1,4 @@
 import { AxiosResponse } from 'axios';
-import { AuditTrail } from './audit-trail/audit-trail';
 import { GetOptions, PostOptions, PutOptions, WorkOSOptions } from './common/interfaces';
 import { DirectorySync } from './directory-sync/directory-sync';
 import { Events } from './events/events';
@@ -11,14 +10,13 @@ import { SSO } from './sso/sso';
 import { Webhooks } from './webhooks/webhooks';
 import { Mfa } from './mfa/mfa';
 import { AuditLogs } from './audit-logs/audit-logs';
-import { Users } from './users/users';
+import { UserManagement } from './user-management/user-management';
 export declare class WorkOS {
     readonly key?: string | undefined;
     readonly options: WorkOSOptions;
     readonly baseURL: string;
     private readonly client;
     readonly auditLogs: AuditLogs;
-    readonly auditTrail: AuditTrail;
     readonly directorySync: DirectorySync;
     readonly organizations: Organizations;
     readonly organizationDomains: OrganizationDomains;
@@ -28,7 +26,7 @@ export declare class WorkOS {
     readonly webhooks: Webhooks;
     readonly mfa: Mfa;
     readonly events: Events;
-    readonly users: Users;
+    readonly userManagement: UserManagement;
     constructor(key?: string | undefined, options?: WorkOSOptions);
     get version(): string;
     post<T = any, D = any, P = any>(path: string, entity: P, options?: PostOptions): Promise<AxiosResponse<T, D>>;

package/lib/workos.js

@@ -14,7 +14,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkOS = void 0;
 const axios_1 = __importDefault(require("axios"));
-const audit_trail_1 = require("./audit-trail/audit-trail");
 const exceptions_1 = require("./common/exceptions");
 const directory_sync_1 = require("./directory-sync/directory-sync");
 const events_1 = require("./events/events");
@@ -26,9 +25,9 @@ const sso_1 = require("./sso/sso");
 const webhooks_1 = require("./webhooks/webhooks");
 const mfa_1 = require("./mfa/mfa");
 const audit_logs_1 = require("./audit-logs/audit-logs");
-const users_1 = require("./users/users");
+const user_management_1 = require("./user-management/user-management");
 const bad_request_exception_1 = require("./common/exceptions/bad-request.exception");
-const VERSION = '3.9.1';
+const VERSION = '4.0.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {
@@ -36,7 +35,6 @@ class WorkOS {
         this.key = key;
         this.options = options;
         this.auditLogs = new audit_logs_1.AuditLogs(this);
-        this.auditTrail = new audit_trail_1.AuditTrail(this);
         this.directorySync = new directory_sync_1.DirectorySync(this);
         this.organizations = new organizations_1.Organizations(this);
         this.organizationDomains = new organization_domains_1.OrganizationDomains(this);
@@ -46,7 +44,7 @@ class WorkOS {
         this.webhooks = new webhooks_1.Webhooks();
         this.mfa = new mfa_1.Mfa(this);
         this.events = new events_1.Events(this);
-        this.users = new users_1.Users(this);
+        this.userManagement = new user_management_1.UserManagement(this);
         if (!key) {
             this.key = process.env.WORKOS_API_KEY;
             if (!this.key) {

package/package.json

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

package/lib/audit-trail/audit-trail.d.ts

@@ -1,12 +0,0 @@
-import { CreateEventOptions } from './interfaces/create-event-options.interface';
-import { AuditTrailEvent } from './interfaces/event.interface';
-import { EventOptions } from './interfaces/event-options.interface';
-import { ListResponse } from '../common/interfaces';
-import { ListEventsOptions } from './interfaces/list-events-options.interface';
-import { WorkOS } from '../workos';
-export declare class AuditTrail {
-    private readonly workos;
-    constructor(workos: WorkOS);
-    createEvent(event: EventOptions, { idempotencyKey }?: CreateEventOptions): Promise<void>;
-    listEvents(options?: ListEventsOptions): Promise<ListResponse<AuditTrailEvent>>;
-}

package/lib/audit-trail/audit-trail.js

@@ -1,31 +0,0 @@
-"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.AuditTrail = void 0;
-class AuditTrail {
-    constructor(workos) {
-        this.workos = workos;
-    }
-    createEvent(event, { idempotencyKey } = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.workos.post('/events', event, { idempotencyKey });
-        });
-    }
-    listEvents(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.get('/events', {
-                query: options,
-            });
-            return data;
-        });
-    }
-}
-exports.AuditTrail = AuditTrail;

package/lib/audit-trail/audit-trail.spec.js

@@ -1,183 +0,0 @@
-"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());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const axios_1 = __importDefault(require("axios"));
-const axios_mock_adapter_1 = __importDefault(require("axios-mock-adapter"));
-const exceptions_1 = require("../common/exceptions");
-const workos_1 = require("../workos");
-const mock = new axios_mock_adapter_1.default(axios_1.default);
-const event = {
-    group: 'WorkOS',
-    actor_name: 'WorkOS@example.com',
-    actor_id: 'user_1',
-    location: ' 192.0.0.8',
-    occurred_at: new Date(0),
-    target_name: 'Security Audit 2018',
-    target_id: 'document_39127',
-    action_type: 'U',
-    action: 'document.updated',
-};
-const serializeEventOptions = (options) => (Object.assign(Object.assign({}, options), { occurred_at: options.occurred_at.toISOString() }));
-describe('AuditTrail', () => {
-    describe('createEvent', () => {
-        describe('when the api responds with a 201 CREATED', () => {
-            describe('with an idempotency key', () => {
-                it('includes an idempotency key with request', () => __awaiter(void 0, void 0, void 0, function* () {
-                    var _a;
-                    mock
-                        .onPost('/events', serializeEventOptions(event))
-                        .replyOnce(201, { success: true });
-                    const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
-                    yield expect(workos.auditTrail.createEvent(event, {
-                        idempotencyKey: 'the-idempotency-key',
-                    })).resolves.toBeUndefined();
-                    expect((_a = mock.history.post[0].headers) === null || _a === void 0 ? void 0 : _a['Idempotency-Key']).toEqual('the-idempotency-key');
-                }));
-            });
-            it('posts Event successfully', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock
-                    .onPost('/events', serializeEventOptions(event))
-                    .replyOnce(201, { success: true });
-                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
-                yield expect(workos.auditTrail.createEvent(event)).resolves.toBeUndefined();
-            }));
-        });
-        describe('when the api responds with a 401', () => {
-            it('throws an UnauthorizedException', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onPost('/events', serializeEventOptions(event)).replyOnce(401, {
-                    message: 'Unauthorized',
-                }, { 'X-Request-ID': 'a-request-id' });
-                const workos = new workos_1.WorkOS('invalid apikey');
-                yield expect(workos.auditTrail.createEvent(event)).rejects.toStrictEqual(new exceptions_1.UnauthorizedException('a-request-id'));
-            }));
-        });
-        describe('when the api responds with a 422', () => {
-            it('throws an UnprocessableEntity', () => __awaiter(void 0, void 0, void 0, function* () {
-                const errors = [
-                    {
-                        field: 'target_id',
-                        code: 'target_id must be a string',
-                    },
-                    {
-                        field: 'occurred_at',
-                        code: 'occurred_at must be an ISO 8601 date string',
-                    },
-                ];
-                mock.onPost('/events', serializeEventOptions(event)).replyOnce(422, {
-                    message: 'Validation failed',
-                    errors,
-                }, { 'X-Request-ID': 'a-request-id' });
-                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
-                yield expect(workos.auditTrail.createEvent(event)).rejects.toMatchSnapshot();
-            }));
-        });
-    });
-    describe('listEvents', () => {
-        describe('With no filters', () => {
-            it('Returns all events', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onGet('/events').replyOnce(200, {
-                    data: [
-                        {
-                            object: 'event',
-                            id: 'evt_0',
-                            group: 'foo-corp.com',
-                            latitude: null,
-                            longitude: null,
-                            location: '::1',
-                            type: 'r',
-                            actor_name: 'demo@foo-corp.com',
-                            actor_id: 'user_0',
-                            target_name: 'http_request',
-                            target_id: '',
-                            metadata: {},
-                            occurred_at: new Date(),
-                            action: {
-                                object: 'event_action',
-                                id: 'evt_action_0',
-                                name: 'user.searched_directories',
-                            },
-                        },
-                        {
-                            object: 'event',
-                            id: 'evt_1',
-                            group: 'workos.com',
-                            location: '::1',
-                            latitude: null,
-                            longitude: null,
-                            type: 'r',
-                            actor_name: 'foo@example.com',
-                            actor_id: 'user_1',
-                            target_name: 'api_key_query',
-                            target_id: 'key_0',
-                            metadata: {
-                                description: 'User viewed API key.',
-                                x_request_id: '',
-                            },
-                            occurred_at: new Date('2020-07-31T14:27:00.384Z'),
-                            action: {
-                                object: 'event_action',
-                                id: 'evt_action_1',
-                                name: 'user.viewed_api_key',
-                                project_id: 'project_0',
-                            },
-                        },
-                    ],
-                    list_metadata: { before: null, after: null },
-                });
-                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
-                const events = yield workos.auditTrail.listEvents();
-                expect(events.data).toHaveLength(2);
-            }));
-        });
-        describe('With a filter', () => {
-            it('Returns events that match the filter', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock
-                    .onGet('/events', {
-                    action: ['user.searched_directories'],
-                })
-                    .replyOnce(200, {
-                    data: [
-                        {
-                            object: 'event',
-                            id: 'evt_0',
-                            group: 'foo-corp.com',
-                            latitude: null,
-                            longitude: null,
-                            location: '::1',
-                            type: 'r',
-                            actor_name: 'demo@foo-corp.com',
-                            actor_id: 'user_0',
-                            target_name: 'http_request',
-                            target_id: '',
-                            metadata: {},
-                            occurred_at: new Date(),
-                            action: {
-                                object: 'event_action',
-                                id: 'evt_action_0',
-                                name: 'user.searched_directories',
-                            },
-                        },
-                    ],
-                    list_metadata: { before: null, after: null },
-                });
-                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
-                const events = yield workos.auditTrail.listEvents({
-                    action: ['user.searched_directories'],
-                });
-                expect(events.data).toHaveLength(1);
-                expect(events.data[0].action.name).toEqual('user.searched_directories');
-            }));
-        });
-    });
-});

package/lib/audit-trail/interfaces/create-event-options.interface.d.ts

@@ -1,3 +0,0 @@
-export interface CreateEventOptions {
-    idempotencyKey?: string;
-}

package/lib/audit-trail/interfaces/event-options.interface.d.ts

@@ -1,14 +0,0 @@
-export interface EventOptions {
-    group: string;
-    actor_name: string;
-    actor_id: string;
-    location: string;
-    occurred_at: Date;
-    target_name: string;
-    target_id: string;
-    action: string;
-    action_type: string;
-    metadata?: {
-        [key: string]: string;
-    };
-}

package/lib/audit-trail/interfaces/event.interface.d.ts

@@ -1,23 +0,0 @@
-export interface AuditTrailEventAction {
-    object: 'event_action';
-    id: string;
-    name: string;
-}
-export interface AuditTrailEvent {
-    object: 'event';
-    id: string;
-    group: string;
-    location: string;
-    latitude: string;
-    longitude: string;
-    type: string;
-    actor_name: string;
-    actor_id: string;
-    target_name: string;
-    target_id: string;
-    occurred_at: Date;
-    action: AuditTrailEventAction;
-    metadata?: {
-        [key: string]: string;
-    };
-}

package/lib/audit-trail/interfaces/index.d.ts

@@ -1,4 +0,0 @@
-export { CreateEventOptions } from './create-event-options.interface';
-export { EventOptions } from './event-options.interface';
-export { AuditTrailEvent } from './event.interface';
-export { ListEventsOptions } from './list-events-options.interface';

package/lib/audit-trail/interfaces/list-events-options.interface.d.ts

@@ -1,16 +0,0 @@
-import { PaginationOptions } from '../../common/interfaces/pagination-options.interface';
-export interface ListEventsOptions extends PaginationOptions {
-    group?: string[];
-    action?: string[];
-    action_type?: string[];
-    actor_name?: string[];
-    actor_id?: string[];
-    target_name?: string[];
-    target_id?: string[];
-    occurred_at?: string;
-    occurred_at_gt?: string;
-    occurred_at_gte?: string;
-    occurred_at_lt?: string;
-    occurred_at_lte?: string;
-    search?: string;
-}

package/lib/users/interfaces/add-user-to-organization-options.interface.d.ts

@@ -1,7 +0,0 @@
-export interface AddUserToOrganizationOptions {
-    userId: string;
-    organizationId: string;
-}
-export interface SerializedAddUserToOrganizationOptions {
-    organization_id: string;
-}

package/lib/users/interfaces/authenticate-with-code-options.interface.d.ts

@@ -1,17 +0,0 @@
-export interface AuthenticateWithCodeOptions {
-    clientId: string;
-    code: string;
-    ipAddress?: string;
-    userAgent?: string;
-}
-export interface AuthenticateUserWithCodeCredentials {
-    clientSecret: string | undefined;
-}
-export interface SerializedAuthenticateWithCodeOptions {
-    grant_type: 'authorization_code';
-    client_id: string;
-    client_secret: string | undefined;
-    code: string;
-    ip_address?: string;
-    user_agent?: string;
-}

package/lib/users/interfaces/authenticate-with-magic-auth-options.interface.d.ts

@@ -1,19 +0,0 @@
-export interface AuthenticateWithMagicAuthOptions {
-    clientId: string;
-    code: string;
-    userId: string;
-    ipAddress?: string;
-    userAgent?: string;
-}
-export interface AuthenticateUserWithMagicAuthCredentials {
-    clientSecret: string | undefined;
-}
-export interface SerializedAuthenticateWithMagicAuthOptions {
-    grant_type: 'urn:workos:oauth:grant-type:magic-auth:code';
-    client_id: string;
-    client_secret: string | undefined;
-    code: string;
-    user_id: string;
-    ip_address?: string;
-    user_agent?: string;
-}

package/lib/users/interfaces/authenticate-with-password-options.interface.d.ts

@@ -1,19 +0,0 @@
-export interface AuthenticateWithPasswordOptions {
-    clientId: string;
-    email: string;
-    password: string;
-    ipAddress?: string;
-    userAgent?: string;
-}
-export interface AuthenticateUserWithPasswordCredentials {
-    clientSecret: string | undefined;
-}
-export interface SerializedAuthenticateWithPasswordOptions {
-    grant_type: 'password';
-    client_id: string;
-    client_secret: string | undefined;
-    email: string;
-    password: string;
-    ip_address?: string;
-    user_agent?: string;
-}

package/lib/users/interfaces/delete-user-options.interface.d.ts

@@ -1,3 +0,0 @@
-export interface DeleteUserOptions {
-    userId: string;
-}

package/lib/users/interfaces/remove-user-from-organization-options.interface.d.ts

@@ -1,4 +0,0 @@
-export interface RemoveUserFromOrganizationOptions {
-    userId: string;
-    organizationId: string;
-}

package/lib/users/interfaces/send-password-reset-options.interface.d.ts

@@ -1,17 +0,0 @@
-import { User, UserResponse } from './user.interface';
-export interface SendPasswordResetEmailOptions {
-    email: string;
-    passwordResetUrl: string;
-}
-export interface SerializedSendPasswordResetEmailOptions {
-    email: string;
-    password_reset_url: string;
-}
-export interface SendPasswordResetEmailResponse {
-    token: string;
-    user: User;
-}
-export interface SendPasswordResetEmailResponseResponse {
-    token: string;
-    user: UserResponse;
-}

package/lib/users/interfaces/verify-email-code-options.interface.d.ts

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

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

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

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

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeSendPasswordResetEmailOptions = exports.deserializeSendPasswordResetEmailResponse = void 0;
-const user_serializer_1 = require("./user.serializer");
-const deserializeSendPasswordResetEmailResponse = (sendPasswordResetEmailResponse) => ({
-    token: sendPasswordResetEmailResponse.token,
-    user: (0, user_serializer_1.deserializeUser)(sendPasswordResetEmailResponse.user),
-});
-exports.deserializeSendPasswordResetEmailResponse = deserializeSendPasswordResetEmailResponse;
-const serializeSendPasswordResetEmailOptions = (options) => ({
-    email: options.email,
-    password_reset_url: options.passwordResetUrl,
-});
-exports.serializeSendPasswordResetEmailOptions = serializeSendPasswordResetEmailOptions;

package/lib/users/users.d.ts

@@ -1,38 +0,0 @@
-import { WorkOS } from '../workos';
-import { AutoPaginatable } from '../common/utils/pagination';
-import { AddUserToOrganizationOptions, AuthenticateWithCodeOptions, AuthenticateWithMagicAuthOptions, AuthenticateWithPasswordOptions, AuthenticateWithTotpOptions, AuthenticationResponse, ResetPasswordOptions, SendPasswordResetEmailOptions, SendPasswordResetEmailResponse, CreateUserOptions, DeleteUserOptions, EnrollAuthFactorOptions, ListAuthFactorsOptions, ListUsersOptions, RemoveUserFromOrganizationOptions, SendMagicAuthCodeOptions, SendVerificationEmailOptions, UpdateUserOptions, UpdateUserPasswordOptions, User, VerifyEmailCodeOptions } from './interfaces';
-import { Challenge, Factor } from '../mfa/interfaces';
-export declare class Users {
-    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>;
-    sendVerificationEmail({ userId, }: SendVerificationEmailOptions): Promise<{
-        user: User;
-    }>;
-    sendMagicAuthCode(options: SendMagicAuthCodeOptions): Promise<{
-        user: User;
-    }>;
-    verifyEmailCode({ code, userId, }: VerifyEmailCodeOptions): Promise<{
-        user: User;
-    }>;
-    sendPasswordResetEmail(payload: SendPasswordResetEmailOptions): Promise<SendPasswordResetEmailResponse>;
-    resetPassword(payload: ResetPasswordOptions): Promise<{
-        user: User;
-    }>;
-    addUserToOrganization({ userId, organizationId, }: AddUserToOrganizationOptions): Promise<User>;
-    removeUserFromOrganization({ userId, organizationId, }: RemoveUserFromOrganizationOptions): Promise<User>;
-    updateUser(payload: UpdateUserOptions): Promise<User>;
-    updateUserPassword(payload: UpdateUserPasswordOptions): Promise<User>;
-    enrollAuthFactor(payload: EnrollAuthFactorOptions): Promise<{
-        authenticationFactor: Factor;
-        authenticationChallenge: Challenge;
-    }>;
-    listAuthFactors(options: ListAuthFactorsOptions): Promise<AutoPaginatable<Factor>>;
-    deleteUser(payload: DeleteUserOptions): Promise<void>;
-}