@workos-inc/node 2.17.0 → 2.19.0

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

@@ -150,6 +150,8 @@ describe('AuditLogs', () => {
                 const options = {
                     actions: ['foo', 'bar'],
                     actors: ['Jon', 'Smith'],
+                    actor_names: ['Jon', 'Smith'],
+                    actor_ids: ['user_foo', 'user_bar'],
                     organization_id: 'org_123',
                     range_end: new Date(),
                     range_start: new Date(),

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

@@ -1,6 +1,11 @@
 export interface AuditLogExportOptions {
     actions?: string[];
+    /**
+     * @deprecated Please use `actor_names` instead.
+     */
     actors?: string[];
+    actor_names?: string[];
+    actor_ids?: string[];
     organization_id: string;
     range_end: Date;
     range_start: Date;

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

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

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

@@ -1,9 +1,9 @@
-export interface EventAction {
+export interface AuditTrailEventAction {
     object: 'event_action';
     id: string;
     name: string;
 }
-export interface Event {
+export interface AuditTrailEvent {
     object: 'event';
     id: string;
     group: string;
@@ -16,7 +16,7 @@ export interface Event {
     target_name: string;
     target_id: string;
     occurred_at: Date;
-    action: EventAction;
+    action: AuditTrailEventAction;
     metadata?: {
         [key: string]: string;
     };

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

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

package/lib/events/events.d.ts

@@ -0,0 +1,9 @@
+import { WorkOS } from '../workos';
+import { Event } from './interfaces/event.interface';
+import { List } from '../common/interfaces/list.interface';
+import { ListEventOptions } from './interfaces';
+export declare class Events {
+    private readonly workos;
+    constructor(workos: WorkOS);
+    listEvents(options: ListEventOptions): Promise<List<Event>>;
+}

package/lib/events/events.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.Events = void 0;
+class Events {
+    constructor(workos) {
+        this.workos = workos;
+    }
+    listEvents(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.get(`/events`, {
+                query: options,
+            });
+            return data;
+        });
+    }
+}
+exports.Events = Events;

package/lib/events/events.spec.d.ts

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

package/lib/events/events.spec.js

@@ -0,0 +1,49 @@
+"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 workos_1 = require("../workos");
+const mock = new axios_mock_adapter_1.default(axios_1.default);
+describe('Event', () => {
+    afterEach(() => mock.resetHistory());
+    const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+    const eventResponse = {
+        id: 'event_01234ABCD',
+        created_at: '2020-05-06 04:21:48.649164',
+        event: 'dsync.user.created',
+        data: {
+            id: 'event_01234ABCD',
+        },
+    };
+    describe('listEvents', () => {
+        const eventsListResponse = {
+            object: 'list',
+            data: [eventResponse],
+            list_metadata: {},
+        };
+        it(`requests Events`, () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onGet('/events', {}).replyOnce(200, eventsListResponse);
+            const list = yield workos.events.listEvents({});
+            expect(list).toEqual(eventsListResponse);
+        }));
+        it(`requests Events with a valid event name`, () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onGet('/events').replyOnce(200, eventsListResponse);
+            const list = yield workos.events.listEvents({
+                events: ['connection.activated'],
+            });
+            expect(list).toEqual(eventsListResponse);
+        }));
+    });
+});

package/lib/events/interfaces/event.interface.d.ts

@@ -0,0 +1,63 @@
+interface EventBase {
+    id: string;
+    created_at: string;
+}
+export interface ConnectionActivatedEvent extends EventBase {
+    event: 'connection.activated';
+    data: Record<string, unknown>;
+}
+export interface ConnectionDeactivatedEvent extends EventBase {
+    event: 'connection.deactivated';
+    data: Record<string, unknown>;
+}
+export interface ConnectionDeletedEvent extends EventBase {
+    event: 'connection.deleted';
+    data: Record<string, unknown>;
+}
+export interface DsyncActivatedEvent extends EventBase {
+    event: 'dsync.activated';
+    data: Record<string, unknown>;
+}
+export interface DsyncDeactivatedEvent extends EventBase {
+    event: 'dsync.deactivated';
+    data: Record<string, unknown>;
+}
+export interface DsyncDeletedEvent extends EventBase {
+    event: 'dsync.deleted';
+    data: Record<string, unknown>;
+}
+export interface DsyncGroupCreatedEvent extends EventBase {
+    event: 'dsync.group.created';
+    data: Record<string, unknown>;
+}
+export interface DsyncGroupDeletedEvent extends EventBase {
+    event: 'dsync.group.deleted';
+    data: Record<string, unknown>;
+}
+export interface DsyncGroupUpdatedEvent extends EventBase {
+    event: 'dsync.group.updated';
+    data: Record<string, unknown>;
+}
+export interface DsyncGroupUserAddedEvent extends EventBase {
+    event: 'dsync.group.user_added';
+    data: Record<string, unknown>;
+}
+export interface DsyncGroupUserRemovedEvent extends EventBase {
+    event: 'dsync.group.user_removed';
+    data: Record<string, unknown>;
+}
+export interface DsyncUserCreatedEvent extends EventBase {
+    event: 'dsync.user.created';
+    data: Record<string, unknown>;
+}
+export interface DsyncUserDeletedEvent extends EventBase {
+    event: 'dsync.user.deleted';
+    data: Record<string, unknown>;
+}
+export interface DsyncUserUpdatedEvent extends EventBase {
+    event: 'dsync.user.updated';
+    data: Record<string, unknown>;
+}
+export type Event = ConnectionActivatedEvent | ConnectionDeactivatedEvent | ConnectionDeletedEvent | DsyncActivatedEvent | DsyncDeactivatedEvent | DsyncDeletedEvent | DsyncGroupCreatedEvent | DsyncGroupUpdatedEvent | DsyncGroupDeletedEvent | DsyncGroupUserAddedEvent | DsyncGroupUserRemovedEvent | DsyncUserCreatedEvent | DsyncUserUpdatedEvent | DsyncUserDeletedEvent;
+export type EventNames = 'connection.activated' | 'connection.deactivated' | 'connection.deleted' | 'dsync.activated' | 'dsync.deactivated' | 'dsync.deleted' | 'dsync.group.created' | 'dsync.group.deleted' | 'dsync.group.updated' | 'dsync.group.user_added' | 'dsync.group.user_removed' | 'dsync.user.created' | 'dsync.user.deleted' | 'dsync.user.updated';
+export {};

package/lib/events/interfaces/event.interface.js

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

package/lib/events/interfaces/index.d.ts

@@ -0,0 +1,2 @@
+export * from './list-events-options.interface';
+export * from './event.interface';

package/lib/events/interfaces/index.js

@@ -0,0 +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("./list-events-options.interface"), exports);
+__exportStar(require("./event.interface"), exports);

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

@@ -0,0 +1,8 @@
+import { EventNames } from './event.interface';
+export interface ListEventOptions {
+    events?: EventNames[];
+    rangeStart?: string;
+    rangeEnd?: string;
+    limit?: number;
+    after?: string;
+}

package/lib/events/interfaces/list-events-options.interface.js

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

package/lib/index.d.ts

@@ -5,6 +5,7 @@ export * from './common/exceptions';
 export * from './common/interfaces';
 export * from './directory-sync/interfaces';
 export * from './directory-sync/utils/get-primary-email';
+export * from './events/interfaces';
 export * from './organizations/interfaces';
 export * from './passwordless/interfaces';
 export * from './portal/interfaces';

package/lib/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./common/exceptions"), exports);
 __exportStar(require("./common/interfaces"), exports);
 __exportStar(require("./directory-sync/interfaces"), exports);
 __exportStar(require("./directory-sync/utils/get-primary-email"), exports);
+__exportStar(require("./events/interfaces"), exports);
 __exportStar(require("./organizations/interfaces"), exports);
 __exportStar(require("./passwordless/interfaces"), exports);
 __exportStar(require("./portal/interfaces"), exports);

package/lib/workos.d.ts

@@ -2,6 +2,7 @@ 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';
 import { Organizations } from './organizations/organizations';
 import { Passwordless } from './passwordless/passwordless';
 import { Portal } from './portal/portal';
@@ -23,6 +24,7 @@ export declare class WorkOS {
     readonly sso: SSO;
     readonly webhooks: Webhooks;
     readonly mfa: Mfa;
+    readonly events: Events;
     constructor(key?: string | undefined, options?: WorkOSOptions);
     post(path: string, entity: any, options?: PostOptions): Promise<AxiosResponse>;
     get(path: string, options?: GetOptions): Promise<AxiosResponse>;

package/lib/workos.js

@@ -17,6 +17,7 @@ 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");
 const organizations_1 = require("./organizations/organizations");
 const passwordless_1 = require("./passwordless/passwordless");
 const portal_1 = require("./portal/portal");
@@ -25,7 +26,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.17.0';
+const VERSION = '2.19.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {
@@ -41,6 +42,7 @@ class WorkOS {
         this.sso = new sso_1.SSO(this);
         this.webhooks = new webhooks_1.Webhooks();
         this.mfa = new mfa_1.Mfa(this);
+        this.events = new events_1.Events(this);
         if (!key) {
             this.key = process.env.WORKOS_API_KEY;
             if (!this.key) {

package/package.json

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