@workos-inc/node 2.11.0 → 2.13.0

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/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", "directory_id": "directory_01F9M7F68PZP8QXP8G7X5QRHS7", "raw_attributes": { "name": { "givenName": "Blair", "familyName": "Lunchford", "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": "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,13 +38,13 @@ describe('Webhooks', () => {
             idp_id: '00u1e8mutl6wlH3lL4x7',
             object: 'directory_user',
             username: 'blair@foo-corp.com',
-            last_name: 'Lunceford',
+            last_name: 'Lunchford',
             first_name: 'Blair',
             directory_id: 'directory_01F9M7F68PZP8QXP8G7X5QRHS7',
             raw_attributes: {
                 name: {
                     givenName: 'Blair',
-                    familyName: 'Lunceford',
+                    familyName: 'Lunchford',
                     middleName: 'Elizabeth',
                     honorificPrefix: 'Ms.',
                 },
@@ -66,18 +66,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 +151,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,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.11.0';
+const VERSION = '2.13.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.11.0",
+  "version": "2.13.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -40,14 +40,14 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "14.18.22",
+    "@types/node": "14.18.29",
     "@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",
     "ts-jest": "27.1.5",
     "tslint": "6.1.3",
-    "typescript": "4.7.4"
+    "typescript": "4.8.3"
   }
 }