@workos-inc/node 1.6.0 → 2.2.0

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

@@ -127,7 +127,7 @@ describe('AuditTrail', () => {
                             },
                         },
                     ],
-                    listMetadata: { before: null, after: null },
+                    list_metadata: { before: null, after: null },
                 });
                 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                 const events = yield workos.auditTrail.listEvents();
@@ -159,7 +159,7 @@ describe('AuditTrail', () => {
                             },
                         },
                     ],
-                    listMetadata: { before: null, after: null },
+                    list_metadata: { before: null, after: null },
                 });
                 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                 const events = yield workos.auditTrail.listEvents({

package/lib/common/interfaces/list.interface.d.ts

@@ -1,6 +1,7 @@
 export interface List<T> {
+    readonly object: 'list';
     data: T[];
-    listMetadata: {
+    list_metadata: {
         before?: string;
         after?: string;
     };

package/lib/directory-sync/directory-sync.d.ts

@@ -10,6 +10,7 @@ export declare class DirectorySync {
     private readonly workos;
     constructor(workos: WorkOS);
     listDirectories(options?: ListDirectoriesOptions): Promise<List<Directory>>;
+    getDirectory(id: string): Promise<Directory>;
     deleteDirectory(id: string): Promise<void>;
     listGroups(options: ListGroupsOptions): Promise<List<Group>>;
     listUsers<TCustomAttributes extends object = DefaultCustomAttributes>(options: ListUsersOptions): Promise<List<UserWithGroups<TCustomAttributes>>>;

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

@@ -22,6 +22,12 @@ class DirectorySync {
             return data;
         });
     }
+    getDirectory(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.get(`/directories/${id}`);
+            return data;
+        });
+    }
     deleteDirectory(id) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.workos.delete(`/directories/${id}`);

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

@@ -33,6 +33,14 @@ describe('DirectorySync', () => {
             }));
         });
     });
+    describe('getDirectory', () => {
+        it(`requests a Directory`, () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onGet().reply(200, {});
+            const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+            yield workos.directorySync.getDirectory('directory_123');
+            expect(mock.history.get[0].url).toEqual('/directories/directory_123');
+        }));
+    });
     describe('deleteDirectory', () => {
         it('sends a request to delete the directory', () => __awaiter(void 0, void 0, void 0, function* () {
             mock.onDelete().reply(202, {});

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

@@ -5,7 +5,7 @@ export interface Directory {
     external_key: string;
     name: string;
     environment_id: string;
-    organization_id: string;
+    organization_id?: string;
     state: 'unlinked' | 'linked' | 'invalid_credentials';
     type: string;
     created_at: string;

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

@@ -1,5 +1,6 @@
 export interface Group {
     id: string;
+    directory_id: string;
     name: string;
     raw_attributes: any;
 }

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

@@ -2,6 +2,7 @@ import { Group } from './group.interface';
 export declare type DefaultCustomAttributes = Record<string, unknown>;
 export interface User<TCustomAttributes extends object = DefaultCustomAttributes> {
     id: string;
+    directory_id: string;
     raw_attributes: any;
     custom_attributes: TCustomAttributes;
     idp_id: string;
@@ -13,7 +14,7 @@ export interface User<TCustomAttributes extends object = DefaultCustomAttributes
     }[];
     username: string;
     last_name: string;
-    state: 'active' | 'suspended';
+    state: 'active' | 'inactive' | 'suspended';
 }
 export interface UserWithGroups<TCustomAttributes extends object = DefaultCustomAttributes> extends User<TCustomAttributes> {
     groups: Group[];

package/lib/organizations/fixtures/list-organizations.json

@@ -93,5 +93,5 @@
             ]
         }
     ],
-    "listMetadata": { "before": "before-id", "after": null }
+    "list_metadata": { "before": "before-id", "after": null }
 }

package/lib/organizations/organizations.spec.js

@@ -28,7 +28,7 @@ describe('Organizations', () => {
         describe('without any options', () => {
             it('returns organizations and metadata', () => __awaiter(void 0, void 0, void 0, function* () {
                 mock.onGet().reply(200, list_organizations_json_1.default);
-                const { data, listMetadata } = yield workos.organizations.listOrganizations();
+                const { data, list_metadata: listMetadata } = yield workos.organizations.listOrganizations();
                 expect(mock.history.get[0].params).toBeUndefined();
                 expect(mock.history.get[0].url).toEqual('/organizations');
                 expect(data).toHaveLength(7);

package/lib/sso/interfaces/connection.interface.d.ts

@@ -7,7 +7,7 @@ export interface ConnectionDomain {
 export interface Connection {
     object: 'connection';
     id: string;
-    organization_id: string;
+    organization_id?: string;
     name: string;
     connection_type: ConnectionType;
     state: 'draft' | 'active' | 'inactive';

package/lib/sso/interfaces/profile.interface.d.ts

@@ -2,7 +2,7 @@ import { ConnectionType } from './connection-type.enum';
 export interface Profile {
     id: string;
     idp_id: string;
-    organization_id: string;
+    organization_id?: string;
     connection_id: string;
     connection_type: ConnectionType;
     email: string;

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

@@ -1 +1,2 @@
 export * from './webhook.interface';
+export * from './webhook-directory.interface';

package/lib/webhooks/interfaces/index.js

@@ -11,3 +11,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./webhook.interface"), exports);
+__exportStar(require("./webhook-directory.interface"), exports);

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

@@ -0,0 +1,4 @@
+import { Directory } from '../../directory-sync/interfaces';
+export interface WebhookDirectory extends Omit<Directory, 'state'> {
+    state: 'active' | 'validating' | 'invalid_credentials' | 'inactive' | 'deleting';
+}

package/lib/webhooks/interfaces/webhook-directory.interface.js

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

package/lib/webhooks/interfaces/webhook.interface.d.ts

@@ -1,5 +1,72 @@
-export interface Webhook {
+import { Group, User } from '../../directory-sync/interfaces';
+import { Connection } from '../../sso/interfaces';
+import { WebhookDirectory as Directory } from './webhook-directory.interface';
+interface WebhookBase {
     id: string;
-    event: string;
-    data: Record<string, any>;
 }
+export interface ConnectionActivatedWebhook extends WebhookBase {
+    event: 'connection.activated';
+    data: Connection;
+}
+export interface ConnectionDeactivatedWebhook extends WebhookBase {
+    event: 'connection.deactivated';
+    data: Connection;
+}
+export interface ConnectionDeletedWebhook extends WebhookBase {
+    event: 'connection.deleted';
+    data: Connection;
+}
+export interface DsyncActivatedWebhook extends WebhookBase {
+    event: 'dsync.activated';
+    data: Directory;
+}
+export interface DsyncDeactivatedWebhook extends WebhookBase {
+    event: 'dsync.deactivated';
+    data: Directory;
+}
+export interface DsyncDeletedWebhook extends WebhookBase {
+    event: 'dsync.deleted';
+    data: Directory;
+}
+export interface DsyncGroupCreatedWebhook extends WebhookBase {
+    event: 'dsync.group.created';
+    data: Group;
+}
+export interface DsyncGroupDeletedWebhook extends WebhookBase {
+    event: 'dsync.group.deleted';
+    data: Group;
+}
+export interface DsyncGroupUpdatedWebhook extends WebhookBase {
+    event: 'dsync.group.updated';
+    data: Group;
+}
+export interface DsyncGroupUserAddedWebhook extends WebhookBase {
+    event: 'dsync.group.user_added';
+    data: {
+        directory_id: string;
+        user: User;
+        group: Group;
+    };
+}
+export interface DsyncGroupUserRemovedWebhook extends WebhookBase {
+    event: 'dsync.group.user_removed';
+    data: {
+        directory_id: string;
+        user: User;
+        group: Group;
+    };
+}
+export interface DsyncUserCreatedWebhook extends WebhookBase {
+    event: 'dsync.user.created';
+    data: User;
+}
+export interface DsyncUserDeletedWebhook extends WebhookBase {
+    event: 'dsync.user.deleted';
+    data: User;
+}
+export interface DsyncUserUpdatedWebhook extends WebhookBase {
+    event: 'dsync.user.updated';
+    data: User;
+}
+export declare type Webhook = ConnectionActivatedWebhook | ConnectionDeactivatedWebhook | ConnectionDeletedWebhook | DsyncActivatedWebhook | DsyncDeactivatedWebhook | DsyncDeletedWebhook | DsyncGroupCreatedWebhook | DsyncGroupUpdatedWebhook | DsyncGroupDeletedWebhook | DsyncGroupUserAddedWebhook | DsyncGroupUserRemovedWebhook | DsyncUserCreatedWebhook | DsyncUserUpdatedWebhook | DsyncUserDeletedWebhook;
+export {};

package/lib/webhooks/webhooks.js

@@ -38,6 +38,7 @@ class Webhooks {
         return [timestamp, signatureHash];
     }
     computeSignature(timestamp, payload, secret) {
+        payload = JSON.stringify(payload);
         const signedPayload = `${timestamp}.${payload}`;
         const expectedSignature = crypto_1.default
             .createHmac('sha256', secret)

package/lib/webhooks/webhooks.spec.js

@@ -19,7 +19,7 @@ describe('Webhooks', () => {
         payload = webhook_json_1.default;
         secret = 'secret';
         timestamp = Date.now() * 1000;
-        unhashedString = `${timestamp}.${payload}`;
+        unhashedString = `${timestamp}.${JSON.stringify(payload)}`;
         signatureHash = crypto_1.default
             .createHmac('sha256', secret)
             .update(unhashedString)

package/lib/workos.js

@@ -22,7 +22,7 @@ const passwordless_1 = require("./passwordless/passwordless");
 const portal_1 = require("./portal/portal");
 const sso_1 = require("./sso/sso");
 const webhooks_1 = require("./webhooks/webhooks");
-const VERSION = '1.6.0';
+const VERSION = '2.2.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.6.0",
+  "version": "2.2.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -40,7 +40,7 @@
   },
   "devDependencies": {
     "@types/jest": "27.0.2",
-    "@types/node": "14.17.32",
+    "@types/node": "14.17.33",
     "@types/pluralize": "0.0.29",
     "axios-mock-adapter": "1.20.0",
     "jest": "27.3.1",