@workos-inc/node 2.12.0 → 2.14.0

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

@@ -61,6 +61,7 @@ describe('DirectorySync', () => {
         groups: [groupResponse],
         idp_id: 'idp_foo',
         last_name: 'Snow',
+        job_title: 'Knight of the Watch',
         raw_attributes: {},
         state: 'active',
         username: 'jonsnow',
@@ -176,6 +177,7 @@ describe('DirectorySync', () => {
                                 emails: [],
                                 first_name: 'Virginia',
                                 last_name: 'Stoltenberg',
+                                job_title: 'Software Engineer',
                                 state: 'active',
                                 raw_attributes: {},
                                 custom_attributes: {
@@ -200,6 +202,7 @@ describe('DirectorySync', () => {
                                 emails: [],
                                 first_name: 'Eli',
                                 last_name: 'Leffler',
+                                job_title: 'Software Engineer',
                                 state: 'active',
                                 raw_attributes: {},
                                 custom_attributes: {

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

@@ -15,6 +15,7 @@ export interface User<TCustomAttributes extends object = DefaultCustomAttributes
     }[];
     username: string;
     last_name: string;
+    job_title: string | null;
     state: 'active' | 'inactive' | 'suspended';
 }
 export interface UserWithGroups<TCustomAttributes extends object = DefaultCustomAttributes> extends User<TCustomAttributes> {

package/lib/directory-sync/utils/get-primary-email.d.ts

@@ -0,0 +1,2 @@
+import { User } from '../interfaces/user.interface';
+export declare function getPrimaryEmail(user: User): string | undefined;

package/lib/directory-sync/utils/get-primary-email.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPrimaryEmail = void 0;
+function getPrimaryEmail(user) {
+    var _a;
+    const primaryEmail = (_a = user.emails) === null || _a === void 0 ? void 0 : _a.find((email) => email.primary);
+    return primaryEmail === null || primaryEmail === void 0 ? void 0 : primaryEmail.value;
+}
+exports.getPrimaryEmail = getPrimaryEmail;

package/lib/directory-sync/utils/get-primary-email.spec.d.ts

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

package/lib/directory-sync/utils/get-primary-email.spec.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const get_primary_email_1 = require("./get-primary-email");
+describe('getPrimaryEmail', () => {
+    const user = {
+        id: 'user_123',
+        custom_attributes: {
+            custom: true,
+        },
+        directory_id: 'dir_123',
+        organization_id: 'org_123',
+        emails: [
+            {
+                primary: true,
+                type: 'type',
+                value: 'jonsnow@workos.com',
+            },
+        ],
+        first_name: 'Jon',
+        idp_id: 'idp_foo',
+        last_name: 'Snow',
+        raw_attributes: {},
+        state: 'active',
+        username: 'jonsnow',
+        job_title: 'Knight of the Watch',
+    };
+    it(`returns primary email value`, () => {
+        const primaryEmail = (0, get_primary_email_1.getPrimaryEmail)(user);
+        expect(primaryEmail).toEqual('jonsnow@workos.com');
+    });
+});

package/lib/index.d.ts

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

package/lib/index.js

@@ -22,6 +22,7 @@ __exportStar(require("./audit-trail/interfaces"), exports);
 __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("./organizations/interfaces"), exports);
 __exportStar(require("./passwordless/interfaces"), exports);
 __exportStar(require("./portal/interfaces"), exports);

package/lib/portal/interfaces/generate-portal-link-intent.interface.d.ts

@@ -1,4 +1,5 @@
 export declare enum GeneratePortalLinkIntent {
-    SSO = "sso",
-    DSync = "dsync"
+    AuditLogs = "audit_logs",
+    DSync = "dsync",
+    SSO = "sso"
 }

package/lib/portal/interfaces/generate-portal-link-intent.interface.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GeneratePortalLinkIntent = void 0;
 var GeneratePortalLinkIntent;
 (function (GeneratePortalLinkIntent) {
-    GeneratePortalLinkIntent["SSO"] = "sso";
+    GeneratePortalLinkIntent["AuditLogs"] = "audit_logs";
     GeneratePortalLinkIntent["DSync"] = "dsync";
+    GeneratePortalLinkIntent["SSO"] = "sso";
 })(GeneratePortalLinkIntent = exports.GeneratePortalLinkIntent || (exports.GeneratePortalLinkIntent = {}));

package/lib/portal/portal.spec.js

@@ -58,6 +58,23 @@ describe('Portal', () => {
                     expect(link).toEqual('https://id.workos.com/portal/launch?secret=secret');
                 }));
             });
+            describe('with the `audit_logs` intent', () => {
+                it('returns an Admin Portal link', () => __awaiter(void 0, void 0, void 0, function* () {
+                    mock
+                        .onPost('/portal/generate_link', {
+                        intent: generate_portal_link_intent_interface_1.GeneratePortalLinkIntent.AuditLogs,
+                        organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3',
+                        return_url: 'https://www.example.com',
+                    })
+                        .reply(201, generate_link_json_1.default);
+                    const { link } = yield workos.portal.generateLink({
+                        intent: generate_portal_link_intent_interface_1.GeneratePortalLinkIntent.AuditLogs,
+                        organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3',
+                        returnUrl: 'https://www.example.com',
+                    });
+                    expect(link).toEqual('https://id.workos.com/portal/launch?secret=secret');
+                }));
+            });
         });
         describe('with an invalid organization', () => {
             it('throws an error', () => __awaiter(void 0, void 0, void 0, function* () {

package/lib/webhooks/fixtures/webhook.json

@@ -1 +1 @@
-{ "id": "wh_123", "data": { "id": "directory_user_01FAEAJCR3ZBZ30D8BD1924TVG", "state": "active", "emails": [{ "type": "work", "value": "blair@foo-corp.com", "primary": true }], "idp_id": "00u1e8mutl6wlH3lL4x7", "object": "directory_user", "username": "blair@foo-corp.com", "last_name": "Lunceford", "first_name": "Blair", "directory_id": "directory_01F9M7F68PZP8QXP8G7X5QRHS7", "raw_attributes": { "name": { "givenName": "Blair", "familyName": "Lunceford", "middleName": "Elizabeth", "honorificPrefix": "Ms." }, "title": "Developer Success Engineer", "active": true, "emails": [{ "type": "work", "value": "blair@foo-corp.com", "primary": true }], "groups": [], "locale": "en-US", "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"], "userName": "blair@foo-corp.com", "addresses": [{ "region": "CO", "primary": true, "locality": "Steamboat Springs", "postalCode": "80487" }], "externalId": "00u1e8mutl6wlH3lL4x7", "displayName": "Blair Lunceford", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": { "manager": { "value": "2", "displayName": "Kathleen Chung" }, "division": "Engineering", "department": "Customer Success" } } }, "event": "dsync.user.created" }
+{ "id": "wh_123", "data": { "id": "directory_user_01FAEAJCR3ZBZ30D8BD1924TVG", "state": "active", "emails": [{ "type": "work", "value": "blair@foo-corp.com", "primary": true }], "idp_id": "00u1e8mutl6wlH3lL4x7", "object": "directory_user", "username": "blair@foo-corp.com", "last_name": "Lunchford", "first_name": "Blair", "job_title": "Software Engineer", "directory_id": "directory_01F9M7F68PZP8QXP8G7X5QRHS7", "raw_attributes": { "name": { "givenName": "Blair", "familyName": "Lunchford", "middleName": "Elizabeth", "honorificPrefix": "Ms." }, "title": "Software Engineer", "active": true, "emails": [{ "type": "work", "value": "blair@foo-corp.com", "primary": true }], "groups": [], "locale": "en-US", "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"], "userName": "blair@foo-corp.com", "addresses": [{ "region": "CA", "primary": true, "locality": "San Francisco", "postalCode": "94016" }], "externalId": "00u1e8mutl6wlH3lL4x7", "displayName": "Blair Lunchford", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": { "manager": { "value": "2", "displayName": "Kate Chapman" }, "division": "Engineering", "department": "Customer Success" } } }, "event": "dsync.user.created" }

package/lib/webhooks/webhooks.d.ts

@@ -6,8 +6,13 @@ export declare class Webhooks {
         secret: string;
         tolerance?: number;
     }): Webhook;
-    private verifyHeader;
-    private getTimestampAndSignatureHash;
-    private computeSignature;
-    private secureCompare;
+    verifyHeader({ payload, sigHeader, secret, tolerance, }: {
+        payload: any;
+        sigHeader: string;
+        secret: string;
+        tolerance?: number;
+    }): boolean;
+    getTimestampAndSignatureHash(sigHeader: string): string[];
+    computeSignature(timestamp: any, payload: any, secret: string): string;
+    secureCompare(stringA: string, stringB: string): boolean;
 }

package/lib/webhooks/webhooks.spec.js

@@ -38,17 +38,18 @@ describe('Webhooks', () => {
             idp_id: '00u1e8mutl6wlH3lL4x7',
             object: 'directory_user',
             username: 'blair@foo-corp.com',
-            last_name: 'Lunceford',
+            last_name: 'Lunchford',
             first_name: 'Blair',
+            job_title: 'Software Engineer',
             directory_id: 'directory_01F9M7F68PZP8QXP8G7X5QRHS7',
             raw_attributes: {
                 name: {
                     givenName: 'Blair',
-                    familyName: 'Lunceford',
+                    familyName: 'Lunchford',
                     middleName: 'Elizabeth',
                     honorificPrefix: 'Ms.',
                 },
-                title: 'Developer Success Engineer',
+                title: 'Software Engineer',
                 active: true,
                 emails: [
                     {
@@ -66,18 +67,18 @@ describe('Webhooks', () => {
                 userName: 'blair@foo-corp.com',
                 addresses: [
                     {
-                        region: 'CO',
+                        region: 'CA',
                         primary: true,
-                        locality: 'Steamboat Springs',
-                        postalCode: '80487',
+                        locality: 'San Francisco',
+                        postalCode: '94016',
                     },
                 ],
                 externalId: '00u1e8mutl6wlH3lL4x7',
-                displayName: 'Blair Lunceford',
+                displayName: 'Blair Lunchford',
                 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User': {
                     manager: {
                         value: '2',
-                        displayName: 'Kathleen Chung',
+                        displayName: 'Kate Chapman',
                     },
                     division: 'Engineering',
                     department: 'Customer Success',
@@ -151,4 +152,27 @@ describe('Webhooks', () => {
             });
         });
     });
+    describe('verifyHeader', () => {
+        it('returns true when the signature is valid', () => {
+            const sigHeader = `t=${timestamp}, v1=${signatureHash}`;
+            const options = { payload, sigHeader, secret };
+            expect(() => workos.webhooks.verifyHeader(options)).toBeTruthy();
+        });
+    });
+    describe('getTimestampAndSignatureHash', () => {
+        it('returns the timestamp and signature when the signature is valid', () => {
+            const sigHeader = `t=${timestamp}, v1=${signatureHash}`;
+            const timestampAndSignature = workos.webhooks.getTimestampAndSignatureHash(sigHeader);
+            expect(timestampAndSignature).toEqual([
+                timestamp.toString(),
+                signatureHash,
+            ]);
+        });
+    });
+    describe('computeSignature', () => {
+        it('returns the computed signature', () => {
+            const signature = workos.webhooks.computeSignature(timestamp, payload, secret);
+            expect(signature).toEqual(signatureHash);
+        });
+    });
 });

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

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.12.0",
+  "version": "2.14.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -9,7 +9,7 @@
     "workos"
   ],
   "volta": {
-    "node": "14.20.0",
+    "node": "14.20.1",
     "yarn": "1.22.19"
   },
   "main": "lib/index.js",
@@ -40,7 +40,7 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "14.18.24",
+    "@types/node": "14.18.32",
     "@types/pluralize": "0.0.29",
     "axios-mock-adapter": "1.21.2",
     "jest": "27.5.1",
@@ -48,6 +48,6 @@
     "supertest": "6.2.3",
     "ts-jest": "27.1.5",
     "tslint": "6.1.3",
-    "typescript": "4.7.4"
+    "typescript": "4.8.4"
   }
 }