@workos-inc/node 2.7.0 → 2.8.0

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

@@ -0,0 +1,7 @@
+import { WorkOS } from '../workos';
+import { CreateAuditLogEventOptions, CreateAuditLogEventRequestOptions } from './interfaces';
+export declare class AuditLogs {
+    private readonly workos;
+    constructor(workos: WorkOS);
+    createEvent(organization: string, event: CreateAuditLogEventOptions, options?: CreateAuditLogEventRequestOptions): Promise<void>;
+}

package/lib/audit-logs/audit-logs.js

@@ -0,0 +1,26 @@
+"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.AuditLogs = void 0;
+class AuditLogs {
+    constructor(workos) {
+        this.workos = workos;
+    }
+    createEvent(organization, event, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.workos.post('/audit_logs/events', {
+                event,
+                organization_id: organization,
+            }, options);
+        });
+    }
+}
+exports.AuditLogs = AuditLogs;

package/lib/audit-logs/audit-logs.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,110 @@
+"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 bad_request_exception_1 = require("../common/exceptions/bad-request.exception");
+const workos_1 = require("../workos");
+const mock = new axios_mock_adapter_1.default(axios_1.default);
+const event = {
+    action: 'document.updated',
+    occurred_at: new Date(),
+    actor: {
+        id: 'user_1',
+        name: 'Jon Smith',
+        type: 'user',
+    },
+    targets: [
+        {
+            id: 'document_39127',
+            type: 'document',
+        },
+    ],
+    context: {
+        location: ' 192.0.0.8',
+        user_agent: 'Firefox',
+    },
+    metadata: {
+        successful: true,
+    },
+};
+const serializeEventOptions = (options) => (Object.assign(Object.assign({}, options), { occurred_at: options.occurred_at.toISOString() }));
+describe('AuditLogs', () => {
+    describe('createEvent', () => {
+        describe('with an idempotency key', () => {
+            it('includes an idempotency key with request', () => __awaiter(void 0, void 0, void 0, function* () {
+                mock
+                    .onPost('/audit_logs/events', {
+                    event: serializeEventOptions(event),
+                    organization_id: 'org_123',
+                })
+                    .replyOnce(201, { success: true });
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.auditLogs.createEvent('org_123', event, {
+                    idempotencyKey: 'the-idempotency-key',
+                })).resolves.toBeUndefined();
+                expect(mock.history.post[0].headers['Idempotency-Key']).toEqual('the-idempotency-key');
+            }));
+        });
+        describe('when the api responds with a 200', () => {
+            it('returns void', () => __awaiter(void 0, void 0, void 0, function* () {
+                mock
+                    .onPost('/audit_logs/events', {
+                    organization_id: 'org_123',
+                    event: serializeEventOptions(event),
+                })
+                    .replyOnce(201, { success: true });
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.auditLogs.createEvent('org_123', 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('/audit_logs/events', {
+                    organization_id: 'org_123',
+                    event: serializeEventOptions(event),
+                })
+                    .replyOnce(401, {
+                    message: 'Unauthorized',
+                }, { 'X-Request-ID': 'a-request-id' });
+                const workos = new workos_1.WorkOS('invalid apikey');
+                yield expect(workos.auditLogs.createEvent('org_123', event)).rejects.toStrictEqual(new exceptions_1.UnauthorizedException('a-request-id'));
+            }));
+        });
+        describe('when the api responds with a 400', () => {
+            it('throws an BadRequestException', () => __awaiter(void 0, void 0, void 0, function* () {
+                const errors = [
+                    {
+                        field: 'occurred_at',
+                        code: 'occurred_at must be an ISO 8601 date string',
+                    },
+                ];
+                mock
+                    .onPost('/audit_logs/events', {
+                    organization_id: 'org_123',
+                    event: serializeEventOptions(event),
+                })
+                    .replyOnce(400, {
+                    message: 'Audit Log could not be processed due to missing or incorrect data.',
+                    code: 'invalid_audit_log',
+                    errors,
+                }, { 'X-Request-ID': 'a-request-id' });
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.auditLogs.createEvent('org_123', event)).rejects.toThrow(bad_request_exception_1.BadRequestException);
+            }));
+        });
+    });
+});

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

@@ -0,0 +1,26 @@
+import { PostOptions } from '../../common/interfaces';
+export interface AuditLogActor {
+    id: string;
+    name?: string;
+    type: string;
+    metadata?: Record<string, string | number | boolean>;
+}
+export interface AuditLogTarget {
+    id: string;
+    name?: string;
+    type: string;
+    metadata?: Record<string, string | number | boolean>;
+}
+export interface CreateAuditLogEventOptions {
+    action: string;
+    version?: number;
+    occurred_at: Date;
+    actor: AuditLogActor;
+    targets: AuditLogTarget[];
+    context: {
+        location: string;
+        user_agent?: string;
+    };
+    metadata?: Record<string, string | number | boolean>;
+}
+export declare type CreateAuditLogEventRequestOptions = Pick<PostOptions, 'idempotencyKey'>;

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

@@ -0,0 +1 @@
+export { CreateAuditLogEventOptions, CreateAuditLogEventRequestOptions, } from './create-audit-log-event-options.interface';

package/lib/audit-logs/interfaces/index.js

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

package/lib/common/exceptions/bad-request.exception.d.ts

@@ -0,0 +1,14 @@
+export declare class BadRequestException extends Error {
+    readonly status: number;
+    readonly name: string;
+    readonly message: string;
+    readonly code?: string;
+    readonly errors?: unknown[];
+    readonly requestID: string;
+    constructor({ code, errors, message, requestID, }: {
+        code?: string;
+        errors?: unknown[];
+        message?: string;
+        requestID: string;
+    });
+}

package/lib/common/exceptions/bad-request.exception.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BadRequestException = void 0;
+class BadRequestException extends Error {
+    constructor({ code, errors, message, requestID, }) {
+        super();
+        this.status = 400;
+        this.name = 'BadRequestException';
+        this.message = 'Bad request';
+        this.requestID = requestID;
+        if (message) {
+            this.message = message;
+        }
+        if (code) {
+            this.code = code;
+        }
+        if (errors) {
+            this.errors = errors;
+        }
+    }
+}
+exports.BadRequestException = BadRequestException;

package/lib/mfa/interfaces/verify-challenge-options.d.ts

@@ -0,0 +1,4 @@
+export interface VerifyChallengeOptions {
+    authenticationChallengeId: string;
+    code: string;
+}

package/lib/mfa/interfaces/verify-challenge-options.js

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

package/lib/mfa/interfaces/verify-challenge-response.js

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

package/lib/mfa/interfaces/verify-factor-options.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @deprecated Please use `VerifyChallengeOptions` instead.
+ */
 export declare type VerifyFactorOptions = {
     authenticationChallengeId: string;
     code: string;

package/lib/mfa/mfa.d.ts

@@ -4,7 +4,8 @@ import { Challenge } from './interfaces/challenge.interface';
 import { EnrollFactorOptions } from './interfaces/enroll-factor-options';
 import { Factor } from './interfaces/factor.interface';
 import { VerifyFactorOptions } from './interfaces/verify-factor-options';
-import { VerifyResponse } from './interfaces/verify-factor-response';
+import { VerifyResponse } from './interfaces/verify-challenge-response';
+import { VerifyChallengeOptions } from './interfaces/verify-challenge-options';
 export declare class Mfa {
     private readonly workos;
     constructor(workos: WorkOS);
@@ -12,5 +13,9 @@ export declare class Mfa {
     getFactor(id: string): Promise<any>;
     enrollFactor(options: EnrollFactorOptions): Promise<Factor>;
     challengeFactor(options: ChallengeFactorOptions): Promise<Challenge>;
+    /**
+     * @deprecated Please use `verifyChallenge` instead.
+     */
     verifyFactor(options: VerifyFactorOptions): Promise<VerifyResponse>;
+    verifyChallenge(options: VerifyChallengeOptions): Promise<VerifyResponse>;
 }

package/lib/mfa/mfa.js

@@ -47,17 +47,23 @@ class Mfa {
     }
     challengeFactor(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.post('/auth/factors/challenge', {
-                authentication_factor_id: options.authenticationFactorId,
+            const { data } = yield this.workos.post(`/auth/factors/${options.authenticationFactorId}/challenge`, {
                 sms_template: 'smsTemplate' in options ? options.smsTemplate : undefined,
             });
             return data;
         });
     }
+    /**
+     * @deprecated Please use `verifyChallenge` instead.
+     */
     verifyFactor(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.post('/auth/factors/verify', {
-                authentication_challenge_id: options.authenticationChallengeId,
+            return this.verifyChallenge(options);
+        });
+    }
+    verifyChallenge(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post(`/auth/challenges/${options.authenticationChallengeId}/verify`, {
                 code: options.code,
             });
             return data;

package/lib/mfa/mfa.spec.js

@@ -157,11 +157,7 @@ describe('MFA', () => {
         describe('with no sms template', () => {
             it('challenge a factor with no sms template', () => __awaiter(void 0, void 0, void 0, function* () {
                 const mock = new axios_mock_adapter_1.default(axios_1.default);
-                mock
-                    .onPost('/auth/factors/challenge', {
-                    authentication_factor_id: 'auth_factor_1234',
-                })
-                    .reply(200, {
+                mock.onPost('/auth/factors/auth_factor_1234/challenge').reply(200, {
                     object: 'authentication_challenge',
                     id: 'auth_challenge_1234',
                     created_at: '2022-03-15T20:39:19.892Z',
@@ -193,8 +189,7 @@ describe('MFA', () => {
             it('challenge a factor with sms template', () => __awaiter(void 0, void 0, void 0, function* () {
                 const mock = new axios_mock_adapter_1.default(axios_1.default);
                 mock
-                    .onPost('/auth/factors/challenge', {
-                    authentication_factor_id: 'auth_factor_1234',
+                    .onPost('/auth/factors/auth_factor_1234/challenge', {
                     sms_template: 'This is your code: 12345',
                 })
                     .reply(200, {
@@ -227,13 +222,12 @@ describe('MFA', () => {
             }));
         });
     });
-    describe('verifyFactor', () => {
+    describe('verifyChallenge', () => {
         describe('verify with successful response', () => {
             it('verifies a successful factor', () => __awaiter(void 0, void 0, void 0, function* () {
                 const mock = new axios_mock_adapter_1.default(axios_1.default);
                 mock
-                    .onPost('/auth/factors/verify', {
-                    authentication_challenge_id: 'auth_challenge_1234',
+                    .onPost('/auth/challenges/auth_challenge_1234/verify', {
                     code: '12345',
                 })
                     .reply(200, {
@@ -251,7 +245,7 @@ describe('MFA', () => {
                 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU', {
                     apiHostname: 'api.workos.dev',
                 });
-                const verifyResponse = yield workos.mfa.verifyFactor({
+                const verifyResponse = yield workos.mfa.verifyChallenge({
                     authenticationChallengeId: 'auth_challenge_1234',
                     code: '12345',
                 });
@@ -275,8 +269,7 @@ describe('MFA', () => {
             it('throws an exception', () => __awaiter(void 0, void 0, void 0, function* () {
                 const mock = new axios_mock_adapter_1.default(axios_1.default);
                 mock
-                    .onPost('/auth/factors/verify', {
-                    authentication_challenge_id: 'auth_challenge_1234',
+                    .onPost('/auth/challenges/auth_challenge_1234/verify', {
                     code: '12345',
                 })
                     .reply(422, {
@@ -288,7 +281,7 @@ describe('MFA', () => {
                 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU', {
                     apiHostname: 'api.workos.dev',
                 });
-                yield expect(workos.mfa.verifyFactor({
+                yield expect(workos.mfa.verifyChallenge({
                     authenticationChallengeId: 'auth_challenge_1234',
                     code: '12345',
                 })).rejects.toThrow(exceptions_1.UnprocessableEntityException);
@@ -298,8 +291,7 @@ describe('MFA', () => {
             it('throws an exception', () => __awaiter(void 0, void 0, void 0, function* () {
                 const mock = new axios_mock_adapter_1.default(axios_1.default);
                 mock
-                    .onPost('/auth/factors/verify', {
-                    authentication_challenge_id: 'auth_challenge_1234',
+                    .onPost('/auth/challenges/auth_challenge_1234/verify', {
                     code: '12345',
                 })
                     .reply(422, {
@@ -311,7 +303,7 @@ describe('MFA', () => {
                 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU', {
                     apiHostname: 'api.workos.dev',
                 });
-                yield expect(workos.mfa.verifyFactor({
+                yield expect(workos.mfa.verifyChallenge({
                     authenticationChallengeId: 'auth_challenge_1234',
                     code: '12345',
                 })).rejects.toThrow(exceptions_1.UnprocessableEntityException);
@@ -319,8 +311,7 @@ describe('MFA', () => {
             it('exception has code', () => __awaiter(void 0, void 0, void 0, function* () {
                 const mock = new axios_mock_adapter_1.default(axios_1.default);
                 mock
-                    .onPost('/auth/factors/verify', {
-                    authentication_challenge_id: 'auth_challenge_1234',
+                    .onPost('/auth/challenges/auth_challenge_1234/verify', {
                     code: '12345',
                 })
                     .reply(422, {
@@ -333,7 +324,7 @@ describe('MFA', () => {
                     apiHostname: 'api.workos.dev',
                 });
                 try {
-                    yield workos.mfa.verifyFactor({
+                    yield workos.mfa.verifyChallenge({
                         authenticationChallengeId: 'auth_challenge_1234',
                         code: '12345',
                     });

package/lib/workos.d.ts

@@ -8,11 +8,13 @@ import { Portal } from './portal/portal';
 import { SSO } from './sso/sso';
 import { Webhooks } from './webhooks/webhooks';
 import { Mfa } from './mfa/mfa';
+import { AuditLogs } from './audit-logs/audit-logs';
 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;

package/lib/workos.js

@@ -23,12 +23,15 @@ const portal_1 = require("./portal/portal");
 const sso_1 = require("./sso/sso");
 const webhooks_1 = require("./webhooks/webhooks");
 const mfa_1 = require("./mfa/mfa");
-const VERSION = '2.7.0';
+const audit_logs_1 = require("./audit-logs/audit-logs");
+const bad_request_exception_1 = require("./common/exceptions/bad-request.exception");
+const VERSION = '2.8.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {
         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);
@@ -78,7 +81,7 @@ class WorkOS {
                 if (response) {
                     const { status, data, headers } = response;
                     const requestID = headers['X-Request-ID'];
-                    const { code, error_description: errorDescription, error, message, } = data;
+                    const { code, error_description: errorDescription, error, errors, message, } = data;
                     switch (status) {
                         case 401: {
                             throw new exceptions_1.UnauthorizedException(requestID);
@@ -99,6 +102,16 @@ class WorkOS {
                             if (error || errorDescription) {
                                 throw new exceptions_1.OauthException(status, requestID, error, errorDescription);
                             }
+                            else if (code && errors) {
+                                // Note: ideally this should be mapped directly with a `400` status code.
+                                // However, this would break existing logic for the `OauthException` exception.
+                                throw new bad_request_exception_1.BadRequestException({
+                                    code,
+                                    errors,
+                                    message,
+                                    requestID,
+                                });
+                            }
                             else {
                                 throw new exceptions_1.GenericServerException(status, data.message, requestID);
                             }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.7.0",
+  "version": "2.8.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -9,8 +9,8 @@
     "workos"
   ],
   "volta": {
-    "node": "14.19.3",
-    "yarn": "1.22.18"
+    "node": "14.20.0",
+    "yarn": "1.22.19"
   },
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -40,14 +40,14 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "14.18.20",
+    "@types/node": "14.18.21",
     "@types/pluralize": "0.0.29",
     "axios-mock-adapter": "1.21.1",
     "jest": "27.5.1",
-    "prettier": "2.6.2",
+    "prettier": "2.7.1",
     "supertest": "6.2.3",
     "ts-jest": "27.1.5",
     "tslint": "6.1.3",
-    "typescript": "4.7.3"
+    "typescript": "4.7.4"
   }
 }