@workos-inc/node 2.8.1 → 2.10.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

@@ -107,4 +107,77 @@ describe('AuditLogs', () => {
             }));
         });
     });
+    describe('createExport', () => {
+        const serializeExportOptions = (options) => ({
+            organization_id: options.organization_id,
+            range_start: options.range_start.toISOString(),
+            range_end: options.range_end.toISOString(),
+        });
+        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 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,5 @@
+export interface AuditLogExportOptions {
+    organization_id: string;
+    range_end: Date;
+    range_start: Date;
+}

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 * from './audit-log-export-options.interface';
+export * from './audit-log-export.interface';
 export { CreateAuditLogEventOptions, CreateAuditLogEventRequestOptions, } from './create-audit-log-event-options.interface';

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

@@ -1,2 +1,18 @@
 "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);

package/lib/directory-sync/directory-sync.spec.js

@@ -35,6 +35,7 @@ describe('DirectorySync', () => {
         id: 'dir_grp_123',
         idp_id: '123',
         directory_id: 'dir_123',
+        organization_id: 'org_123',
         name: 'Foo Group',
         created_at: `2021-10-27 15:21:50.640958`,
         updated_at: '2021-10-27 15:21:50.640959',
@@ -48,6 +49,7 @@ describe('DirectorySync', () => {
             custom: true,
         },
         directory_id: 'dir_123',
+        organization_id: 'org_123',
         emails: [
             {
                 primary: true,

package/lib/directory-sync/interfaces/group.interface.d.ts

@@ -2,6 +2,7 @@ export interface Group {
     id: string;
     idp_id: string;
     directory_id: string;
+    organization_id: string | null;
     name: string;
     created_at: string;
     updated_at: string;

package/lib/directory-sync/interfaces/user.interface.d.ts

@@ -3,6 +3,7 @@ export declare type DefaultCustomAttributes = Record<string, unknown>;
 export interface User<TCustomAttributes extends object = DefaultCustomAttributes, TRawAttributes = any> {
     id: string;
     directory_id: string;
+    organization_id: string | null;
     raw_attributes: TRawAttributes;
     custom_attributes: TCustomAttributes;
     idp_id: string;

package/lib/index.d.ts

@@ -1,4 +1,5 @@
 import { WorkOS } from './workos';
+export * from './audit-logs/interfaces';
 export * from './audit-trail/interfaces';
 export * from './common/exceptions';
 export * from './common/interfaces';

package/lib/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkOS = void 0;
 const workos_1 = require("./workos");
 Object.defineProperty(exports, "WorkOS", { enumerable: true, get: function () { return workos_1.WorkOS; } });
+__exportStar(require("./audit-logs/interfaces"), exports);
 __exportStar(require("./audit-trail/interfaces"), exports);
 __exportStar(require("./common/exceptions"), exports);
 __exportStar(require("./common/interfaces"), exports);

package/lib/webhooks/interfaces/webhook-directory-group.interface.d.ts

@@ -2,6 +2,7 @@ export interface WebhookDirectoryGroup<TRawAttributes = any> {
     id: string;
     idp_id: string;
     directory_id: string;
+    organization_id: string | null;
     name: string;
     created_at: string;
     updated_at: string;

package/lib/workos.js

@@ -25,7 +25,7 @@ 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.8.1';
+const VERSION = '2.10.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.8.1",
+  "version": "2.10.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -40,7 +40,7 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "14.18.21",
+    "@types/node": "14.18.22",
     "@types/pluralize": "0.0.29",
     "axios-mock-adapter": "1.21.1",
     "jest": "27.5.1",