@workos-inc/node 2.9.1 → 2.12.0

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

@@ -1,7 +1,11 @@
 import { WorkOS } from '../workos';
 import { CreateAuditLogEventOptions, CreateAuditLogEventRequestOptions } from './interfaces';
+import { AuditLogExportOptions } from './interfaces/audit-log-export-options.interface';
+import { AuditLogExport } from './interfaces/audit-log-export.interface';
 export declare class AuditLogs {
     private readonly workos;
     constructor(workos: WorkOS);
     createEvent(organization: string, event: CreateAuditLogEventOptions, options?: CreateAuditLogEventRequestOptions): Promise<void>;
+    createExport(options: AuditLogExportOptions): Promise<AuditLogExport>;
+    getExport(auditLogExportId: string): Promise<AuditLogExport>;
 }

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

@@ -22,5 +22,17 @@ class AuditLogs {
             }, options);
         });
     }
+    createExport(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/audit_logs/exports', options);
+            return data;
+        });
+    }
+    getExport(auditLogExportId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.get(`/audit_logs/exports/${auditLogExportId}`);
+            return data;
+        });
+    }
 }
 exports.AuditLogs = AuditLogs;

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

@@ -8,6 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -107,4 +118,101 @@ describe('AuditLogs', () => {
             }));
         });
     });
+    describe('createExport', () => {
+        const serializeExportOptions = (_a) => {
+            var { range_end, range_start } = _a, options = __rest(_a, ["range_end", "range_start"]);
+            return (Object.assign({ range_start: range_start.toISOString(), range_end: range_end.toISOString() }, options));
+        };
+        describe('when the api responds with a 201', () => {
+            it('returns `audit_log_export`', () => __awaiter(void 0, void 0, void 0, function* () {
+                const options = {
+                    organization_id: 'org_123',
+                    range_start: new Date(),
+                    range_end: new Date(),
+                };
+                const auditLogExport = {
+                    object: 'audit_log_export',
+                    id: 'audit_log_export_1234',
+                    state: 'pending',
+                    url: undefined,
+                    created_at: new Date().toISOString(),
+                    updated_at: new Date().toISOString(),
+                };
+                mock
+                    .onPost('/audit_logs/exports', serializeExportOptions(options))
+                    .replyOnce(201, auditLogExport);
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.auditLogs.createExport(options)).resolves.toEqual(auditLogExport);
+            }));
+        });
+        describe('when additional filters are defined', () => {
+            it('returns `audit_log_export`', () => __awaiter(void 0, void 0, void 0, function* () {
+                const options = {
+                    actions: ['foo', 'bar'],
+                    actors: ['Jon', 'Smith'],
+                    organization_id: 'org_123',
+                    range_end: new Date(),
+                    range_start: new Date(),
+                    targets: ['user', 'team'],
+                };
+                const auditLogExport = {
+                    object: 'audit_log_export',
+                    id: 'audit_log_export_1234',
+                    state: 'pending',
+                    url: undefined,
+                    created_at: new Date().toISOString(),
+                    updated_at: new Date().toISOString(),
+                };
+                mock
+                    .onPost('/audit_logs/exports', serializeExportOptions(options))
+                    .replyOnce(201, auditLogExport);
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.auditLogs.createExport(options)).resolves.toEqual(auditLogExport);
+            }));
+        });
+        describe('when the api responds with a 401', () => {
+            it('throws an UnauthorizedException', () => __awaiter(void 0, void 0, void 0, function* () {
+                const options = {
+                    organization_id: 'org_123',
+                    range_start: new Date(),
+                    range_end: new Date(),
+                };
+                mock
+                    .onPost('/audit_logs/exports', serializeExportOptions(options))
+                    .replyOnce(401, {
+                    message: 'Unauthorized',
+                }, { 'X-Request-ID': 'a-request-id' });
+                const workos = new workos_1.WorkOS('invalid apikey');
+                yield expect(workos.auditLogs.createExport(options)).rejects.toStrictEqual(new exceptions_1.UnauthorizedException('a-request-id'));
+            }));
+        });
+    });
+    describe('getExport', () => {
+        describe('when the api responds with a 201', () => {
+            it('returns `audit_log_export`', () => __awaiter(void 0, void 0, void 0, function* () {
+                const auditLogExport = {
+                    object: 'audit_log_export',
+                    id: 'audit_log_export_1234',
+                    state: 'pending',
+                    url: undefined,
+                    created_at: new Date().toISOString(),
+                    updated_at: new Date().toISOString(),
+                };
+                mock
+                    .onGet(`/audit_logs/exports/${auditLogExport.id}`)
+                    .replyOnce(200, auditLogExport);
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.auditLogs.getExport(auditLogExport.id)).resolves.toEqual(auditLogExport);
+            }));
+        });
+        describe('when the api responds with a 401', () => {
+            it('throws an UnauthorizedException', () => __awaiter(void 0, void 0, void 0, function* () {
+                mock.onGet('/audit_logs/exports/audit_log_export_1234').replyOnce(401, {
+                    message: 'Unauthorized',
+                }, { 'X-Request-ID': 'a-request-id' });
+                const workos = new workos_1.WorkOS('invalid apikey');
+                yield expect(workos.auditLogs.getExport('audit_log_export_1234')).rejects.toStrictEqual(new exceptions_1.UnauthorizedException('a-request-id'));
+            }));
+        });
+    });
 });

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

@@ -0,0 +1,8 @@
+export interface AuditLogExportOptions {
+    actions?: string[];
+    actors?: string[];
+    organization_id: string;
+    range_end: Date;
+    range_start: Date;
+    targets?: string[];
+}

package/lib/audit-logs/interfaces/audit-log-export-options.interface.js

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

package/lib/audit-logs/interfaces/audit-log-export.interface.d.ts

@@ -0,0 +1,8 @@
+export interface AuditLogExport {
+    object: 'audit_log_export';
+    id: string;
+    state: 'pending' | 'ready' | 'error';
+    url?: string;
+    created_at: string;
+    updated_at: string;
+}

package/lib/audit-logs/interfaces/audit-log-export.interface.js

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

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

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

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

@@ -1,2 +1,19 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./audit-log-export-options.interface"), exports);
+__exportStar(require("./audit-log-export.interface"), exports);
+__exportStar(require("./create-audit-log-event-options.interface"), exports);

package/lib/common/interfaces/workos-options.interface.d.ts

@@ -1,5 +1,7 @@
+import { AxiosRequestConfig } from 'axios';
 export interface WorkOSOptions {
     apiHostname?: string;
     https?: boolean;
     port?: number;
+    axios?: Omit<AxiosRequestConfig, 'baseURL'>;
 }

package/lib/organizations/interfaces/create-organization-options.interface.d.ts

@@ -1,5 +1,8 @@
+import { PostOptions } from '../../common/interfaces';
 export interface CreateOrganizationOptions {
     name: string;
     allow_profiles_outside_organization?: boolean;
     domains?: string[];
 }
+export interface CreateOrganizationRequestOptions extends Pick<PostOptions, 'idempotencyKey'> {
+}

package/lib/organizations/organizations.d.ts

@@ -1,11 +1,11 @@
 import { List } from '../common/interfaces/list.interface';
 import { WorkOS } from '../workos';
-import { CreateOrganizationOptions, ListOrganizationsOptions, Organization, UpdateOrganizationOptions } from './interfaces';
+import { CreateOrganizationOptions, CreateOrganizationRequestOptions, ListOrganizationsOptions, Organization, UpdateOrganizationOptions } from './interfaces';
 export declare class Organizations {
     private readonly workos;
     constructor(workos: WorkOS);
     listOrganizations(options?: ListOrganizationsOptions): Promise<List<Organization>>;
-    createOrganization(payload: CreateOrganizationOptions): Promise<Organization>;
+    createOrganization(payload: CreateOrganizationOptions, requestOptions?: CreateOrganizationRequestOptions): Promise<Organization>;
     deleteOrganization(id: string): Promise<void>;
     getOrganization(id: string): Promise<Organization>;
     updateOrganization(options: UpdateOrganizationOptions): Promise<Organization>;

package/lib/organizations/organizations.js

@@ -33,9 +33,9 @@ class Organizations {
             return data;
         });
     }
-    createOrganization(payload) {
+    createOrganization(payload, requestOptions = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.post('/organizations', payload);
+            const { data } = yield this.workos.post('/organizations', payload, requestOptions);
             return data;
         });
     }

package/lib/organizations/organizations.spec.js

@@ -108,6 +108,23 @@ describe('Organizations', () => {
         });
     });
     describe('createOrganization', () => {
+        describe('with an idempotency key', () => {
+            it('includes an idempotency key with request', () => __awaiter(void 0, void 0, void 0, function* () {
+                mock
+                    .onPost('/organizations', {
+                    domains: ['example.com'],
+                    name: 'Test Organization',
+                })
+                    .replyOnce(201, create_organization_json_1.default);
+                yield workos.organizations.createOrganization({
+                    domains: ['example.com'],
+                    name: 'Test Organization',
+                }, {
+                    idempotencyKey: 'the-idempotency-key',
+                });
+                expect(mock.history.post[0].headers['Idempotency-Key']).toEqual('the-idempotency-key');
+            }));
+        });
         describe('with a valid payload', () => {
             it('creates an organization', () => __awaiter(void 0, void 0, void 0, function* () {
                 mock

package/lib/workos.js

@@ -25,10 +25,11 @@ const webhooks_1 = require("./webhooks/webhooks");
 const mfa_1 = require("./mfa/mfa");
 const audit_logs_1 = require("./audit-logs/audit-logs");
 const bad_request_exception_1 = require("./common/exceptions/bad-request.exception");
-const VERSION = '2.9.1';
+const VERSION = '2.12.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {
+        var _a;
         this.key = key;
         this.options = options;
         this.auditLogs = new audit_logs_1.AuditLogs(this);
@@ -56,13 +57,7 @@ class WorkOS {
         if (port) {
             this.baseURL = this.baseURL + `:${port}`;
         }
-        this.client = axios_1.default.create({
-            baseURL: this.baseURL,
-            headers: {
-                Authorization: `Bearer ${this.key}`,
-                'User-Agent': `workos-node/${VERSION}`,
-            },
-        });
+        this.client = axios_1.default.create(Object.assign(Object.assign({}, options.axios), { baseURL: this.baseURL, headers: Object.assign(Object.assign({}, (_a = options.axios) === null || _a === void 0 ? void 0 : _a.headers), { Authorization: `Bearer ${this.key}`, 'User-Agent': `workos-node/${VERSION}` }) }));
     }
     post(path, entity, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {

package/lib/workos.spec.js

@@ -65,6 +65,22 @@ describe('WorkOS', () => {
                 expect(workos.baseURL).toEqual('https://localhost:4000');
             });
         });
+        describe('when the `axios` option is provided', () => {
+            it('applies the configuration to the Axios client', () => __awaiter(void 0, void 0, void 0, function* () {
+                mock.onPost().reply(200, 'OK', { 'X-Request-ID': 'a-request-id' });
+                const workos = new workos_1.WorkOS('sk_test', {
+                    axios: {
+                        headers: {
+                            'X-My-Custom-Header': 'Hey there!',
+                        },
+                    },
+                });
+                yield workos.post('/somewhere', {});
+                expect(mock.history.post[0].headers).toMatchObject({
+                    'X-My-Custom-Header': 'Hey there!',
+                });
+            }));
+        });
     });
     describe('post', () => {
         describe('when the api responds with a 404', () => {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.9.1",
+  "version": "2.12.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -40,9 +40,9 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "14.18.22",
+    "@types/node": "14.18.24",
     "@types/pluralize": "0.0.29",
-    "axios-mock-adapter": "1.21.1",
+    "axios-mock-adapter": "1.21.2",
     "jest": "27.5.1",
     "prettier": "2.7.1",
     "supertest": "6.2.3",