@workos-inc/node 2.5.0-alpha.1 → 2.6.0

package/README.md

@@ -33,6 +33,10 @@ import WorkOS from '@workos-inc/node';
 const workos = new WorkOS('sk_1234');
 ```
 
+## SDK Versioning
+
+For our SDKs WorkOS follows a Semantic Versioning ([SemVer](https://semver.org/)) process where all releases will have a version X.Y.Z (like 1.0.0) pattern wherein Z would be a bug fix (e.g., 1.0.1), Y would be a minor release (1.1.0) and X would be a major release (2.0.0). We permit any breaking changes to only be released in major versions and strongly recommend reading changelogs before making any major version upgrades.
+
 ## More Information
 
 - [Single Sign-On Guide](https://workos.com/docs/sso/guide)

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

@@ -28,12 +28,15 @@ const event = {
     action_type: 'U',
     action: 'document.updated',
 };
+const serializeEventOptions = (options) => (Object.assign(Object.assign({}, options), { occurred_at: options.occurred_at.toISOString() }));
 describe('AuditTrail', () => {
     describe('createEvent', () => {
         describe('when the api responds with a 201 CREATED', () => {
             describe('with an idempotency key', () => {
                 it('includes an idempotency key with request', () => __awaiter(void 0, void 0, void 0, function* () {
-                    mock.onPost().reply(201, { success: true });
+                    mock
+                        .onPost('/events', serializeEventOptions(event))
+                        .replyOnce(201, { success: true });
                     const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                     yield expect(workos.auditTrail.createEvent(event, {
                         idempotencyKey: 'the-idempotency-key',
@@ -42,14 +45,16 @@ describe('AuditTrail', () => {
                 }));
             });
             it('posts Event successfully', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onPost().reply(201, { success: true });
+                mock
+                    .onPost('/events', serializeEventOptions(event))
+                    .replyOnce(201, { success: true });
                 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                 yield expect(workos.auditTrail.createEvent(event)).resolves.toBeUndefined();
             }));
         });
         describe('when the api responds with a 401', () => {
             it('throws an UnauthorizedException', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onPost().reply(401, {
+                mock.onPost('/events', serializeEventOptions(event)).replyOnce(401, {
                     message: 'Unauthorized',
                 }, { 'X-Request-ID': 'a-request-id' });
                 const workos = new workos_1.WorkOS('invalid apikey');
@@ -68,7 +73,7 @@ describe('AuditTrail', () => {
                         code: 'occurred_at must be an ISO 8601 date string',
                     },
                 ];
-                mock.onPost().reply(422, {
+                mock.onPost('/events', serializeEventOptions(event)).replyOnce(422, {
                     message: 'Validation failed',
                     errors,
                 }, { 'X-Request-ID': 'a-request-id' });
@@ -80,7 +85,7 @@ describe('AuditTrail', () => {
     describe('listEvents', () => {
         describe('With no filters', () => {
             it('Returns all events', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onGet().reply(200, {
+                mock.onGet('/events').replyOnce(200, {
                     data: [
                         {
                             object: 'event',
@@ -136,7 +141,11 @@ describe('AuditTrail', () => {
         });
         describe('With a filter', () => {
             it('Returns events that match the filter', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onGet().reply(200, {
+                mock
+                    .onGet('/events', {
+                    action: ['user.searched_directories'],
+                })
+                    .replyOnce(200, {
                     data: [
                         {
                             object: 'event',

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

@@ -15,7 +15,6 @@ export interface Event {
     actor_id: string;
     target_name: string;
     target_id: string;
-    environment_id: string;
     occurred_at: Date;
     action: EventAction;
     metadata?: {

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

@@ -18,81 +18,149 @@ const workos_1 = require("../workos");
 const mock = new axios_mock_adapter_1.default(axios_1.default);
 describe('DirectorySync', () => {
     afterEach(() => mock.resetHistory());
+    const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+    const directoryResponse = {
+        id: 'directory_123',
+        created_at: '2020-05-06 04:21:48.649164',
+        domain: 'foo-corp.com',
+        external_key: '9asBRBVHz2ASEkgg',
+        name: 'Foo',
+        object: 'directory',
+        organization_id: 'org_01EXSR7M9QTKCC5D531SMCWMYG',
+        state: 'linked',
+        type: 'okta scim v1.1',
+        updated_at: '2021-10-27 15:21:50.640958',
+    };
+    const groupResponse = {
+        id: 'dir_grp_123',
+        directory_id: 'dir_123',
+        name: 'Foo Group',
+        raw_attributes: {
+            foo: 'bar',
+        },
+    };
+    const userWithGroupResponse = {
+        id: 'user_123',
+        custom_attributes: {
+            custom: true,
+        },
+        directory_id: 'dir_123',
+        emails: [
+            {
+                primary: true,
+                type: 'type',
+                value: 'jonsnow@workos.com',
+            },
+        ],
+        first_name: 'Jon',
+        groups: [groupResponse],
+        idp_id: 'idp_foo',
+        last_name: 'Snow',
+        raw_attributes: {},
+        state: 'active',
+        username: 'jonsnow',
+    };
     describe('listDirectories', () => {
         describe('with options', () => {
             it('requests Directories with query parameters', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onGet().reply(200, {});
-                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
-                yield workos.directorySync.listDirectories({
+                const directoryListResponse = {
+                    object: 'list',
+                    data: [directoryResponse],
+                    list_metadata: {},
+                };
+                mock
+                    .onGet('/directories', {
                     domain: 'google.com',
-                });
-                expect(mock.history.get[0].params).toEqual({
+                })
+                    .replyOnce(200, directoryListResponse);
+                const directories = yield workos.directorySync.listDirectories({
                     domain: 'google.com',
                 });
-                expect(mock.history.get[0].url).toEqual('/directories');
+                expect(directories).toEqual(directoryListResponse);
             }));
         });
     });
     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');
+            mock
+                .onGet('/directories/directory_123')
+                .replyOnce(200, directoryResponse);
+            const directory = yield workos.directorySync.getDirectory('directory_123');
+            expect(directory).toEqual(directoryResponse);
         }));
     });
     describe('deleteDirectory', () => {
         it('sends a request to delete the directory', () => __awaiter(void 0, void 0, void 0, function* () {
-            mock.onDelete().reply(202, {});
-            const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+            mock.onDelete('/directories/directory_123').replyOnce(202, {});
             yield workos.directorySync.deleteDirectory('directory_123');
             expect(mock.history.delete[0].url).toEqual('/directories/directory_123');
         }));
     });
+    describe('getGroup', () => {
+        it(`requests a Directory Group`, () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onGet('/directory_groups/dir_grp_123').replyOnce(200, groupResponse);
+            const group = yield workos.directorySync.getGroup('dir_grp_123');
+            expect(group).toEqual(groupResponse);
+        }));
+    });
     describe('listGroups', () => {
+        const groupListResponse = {
+            object: 'list',
+            data: [groupResponse],
+            list_metadata: {},
+        };
         describe('with a Directory', () => {
             it(`requests a Directory's Groups`, () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onGet().reply(200, {});
-                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
-                yield workos.directorySync.listGroups({
+                mock
+                    .onGet('/directory_groups', {
                     directory: 'directory_123',
-                });
-                expect(mock.history.get[0].params).toEqual({
+                })
+                    .replyOnce(200, groupListResponse);
+                const list = yield workos.directorySync.listGroups({
                     directory: 'directory_123',
                 });
-                expect(mock.history.get[0].url).toEqual('/directory_groups');
+                expect(list).toEqual(groupListResponse);
             }));
         });
         describe('with a User', () => {
             it(`requests a Directory's Groups`, () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onGet().reply(200, {});
-                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
-                yield workos.directorySync.listGroups({
+                mock
+                    .onGet('/directory_groups', {
                     user: 'directory_usr_123',
-                });
-                expect(mock.history.get[0].params).toEqual({
+                })
+                    .replyOnce(200, groupListResponse);
+                const list = yield workos.directorySync.listGroups({
                     user: 'directory_usr_123',
                 });
-                expect(mock.history.get[0].url).toEqual('/directory_groups');
+                expect(list).toEqual(groupListResponse);
             }));
         });
     });
     describe('listUsers', () => {
+        const userWithGroupListResponse = {
+            object: 'list',
+            data: [userWithGroupResponse],
+            list_metadata: {},
+        };
         describe('with a Directory', () => {
             it(`requests a Directory's Users`, () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onGet().reply(200, {});
-                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
-                yield workos.directorySync.listUsers({
+                mock
+                    .onGet('/directory_users', {
                     directory: 'directory_123',
-                });
-                expect(mock.history.get[0].params).toEqual({
+                })
+                    .replyOnce(200, userWithGroupListResponse);
+                const list = yield workos.directorySync.listUsers({
                     directory: 'directory_123',
                 });
-                expect(mock.history.get[0].url).toEqual('/directory_users');
+                expect(list).toEqual(userWithGroupListResponse);
             }));
             describe('with custom attributes', () => {
                 it('returns the custom attributes, using the provided type', () => __awaiter(void 0, void 0, void 0, function* () {
-                    mock.onGet().reply(200, {
+                    mock
+                        .onGet('/directory_users', {
+                        directory: 'directory_123',
+                    })
+                        .replyOnce(200, {
                         data: [
                             {
                                 object: 'directory_user',
@@ -144,7 +212,6 @@ describe('DirectorySync', () => {
                             },
                         ],
                     });
-                    const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                     const users = yield workos.directorySync.listUsers({
                         directory: 'directory_123',
                     });
@@ -158,32 +225,25 @@ describe('DirectorySync', () => {
         });
         describe('with a Group', () => {
             it(`requests a Directory's Users`, () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onGet().reply(200, {});
-                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
-                yield workos.directorySync.listUsers({
+                mock
+                    .onGet('/directory_users', {
                     group: 'directory_grp_123',
-                });
-                expect(mock.history.get[0].params).toEqual({
+                })
+                    .replyOnce(200, userWithGroupListResponse);
+                const list = yield workos.directorySync.listUsers({
                     group: 'directory_grp_123',
                 });
-                expect(mock.history.get[0].url).toEqual('/directory_users');
+                expect(list).toEqual(userWithGroupListResponse);
             }));
         });
     });
     describe('getUser', () => {
         it(`requests a Directory User`, () => __awaiter(void 0, void 0, void 0, function* () {
-            mock.onGet().reply(200, {});
-            const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
-            yield workos.directorySync.getUser('dir_usr_123');
-            expect(mock.history.get[0].url).toEqual('/directory_users/dir_usr_123');
-        }));
-    });
-    describe('getGroup', () => {
-        it(`requests a Directory Group`, () => __awaiter(void 0, void 0, void 0, function* () {
-            mock.onGet().reply(200, {});
-            const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
-            yield workos.directorySync.getGroup('dir_grp_123');
-            expect(mock.history.get[0].url).toEqual('/directory_groups/dir_grp_123');
+            mock
+                .onGet('/directory_users/dir_usr_123')
+                .replyOnce(200, userWithGroupResponse);
+            const user = yield workos.directorySync.getUser('dir_usr_123');
+            expect(user).toEqual(userWithGroupResponse);
         }));
     });
 });

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

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

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

@@ -1,9 +1,9 @@
 import { Group } from './group.interface';
 export declare type DefaultCustomAttributes = Record<string, unknown>;
-export interface User<TCustomAttributes extends object = DefaultCustomAttributes> {
+export interface User<TCustomAttributes extends object = DefaultCustomAttributes, TRawAttributes = any> {
     id: string;
     directory_id: string;
-    raw_attributes: any;
+    raw_attributes: TRawAttributes;
     custom_attributes: TCustomAttributes;
     idp_id: string;
     first_name: string;

package/lib/mfa/interfaces/challenge-factor-options.d.ts

@@ -1,6 +1,6 @@
 export declare type ChallengeFactorOptions = {
-    authentication_factor_id: string;
+    authenticationFactorId: string;
 } | {
-    authentication_factor_id: string;
-    sms_template: string;
+    authenticationFactorId: string;
+    smsTemplate: string;
 };

package/lib/mfa/interfaces/factor.interface.d.ts

@@ -6,7 +6,6 @@ export interface Factor {
     created_at: string;
     updated_at: string;
     type: string;
-    environment_id: string;
     sms: Sms;
     totp: Totp;
 }

package/lib/mfa/interfaces/verify-factor-options.d.ts

@@ -1,4 +1,4 @@
 export declare type VerifyFactorOptions = {
-    authentication_challenge_id: string;
+    authenticationChallengeId: string;
     code: string;
 };

package/lib/mfa/mfa.js

@@ -27,19 +27,39 @@ class Mfa {
     }
     enrollFactor(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.post('/auth/factors/enroll', options);
+            const { data } = yield this.workos.post('/auth/factors/enroll', Object.assign({ type: options.type }, (() => {
+                switch (options.type) {
+                    case 'sms':
+                        return {
+                            phone_number: options.phoneNumber,
+                        };
+                    case 'totp':
+                        return {
+                            totp_issuer: options.issuer,
+                            totp_user: options.user,
+                        };
+                    default:
+                        return {};
+                }
+            })()));
             return data;
         });
     }
     challengeFactor(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.post('/auth/factors/challenge', options);
+            const { data } = yield this.workos.post('/auth/factors/challenge', {
+                authentication_factor_id: options.authenticationFactorId,
+                sms_template: 'smsTemplate' in options ? options.smsTemplate : undefined,
+            });
             return data;
         });
     }
     verifyFactor(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.post('/auth/factors/verify', options);
+            const { data } = yield this.workos.post('/auth/factors/verify', {
+                authentication_challenge_id: options.authenticationChallengeId,
+                code: options.code,
+            });
             return data;
         });
     }

package/lib/mfa/mfa.spec.js

@@ -44,7 +44,6 @@ describe('MFA', () => {
                     created_at: '2022-03-15T20:39:19.892Z',
                     updated_at: '2022-03-15T20:39:19.892Z',
                     type: 'generic_otp',
-                    environment_id: 'environment_1234',
                 });
                 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU', {
                     apiHostname: 'api.workos.dev',
@@ -55,7 +54,6 @@ describe('MFA', () => {
                 expect(enrollResponse).toMatchInlineSnapshot(`
           Object {
             "created_at": "2022-03-15T20:39:19.892Z",
-            "environment_id": "environment_1234",
             "id": "auth_factor_1234",
             "object": "authentication_factor",
             "type": "generic_otp",
@@ -73,7 +71,6 @@ describe('MFA', () => {
                     created_at: '2022-03-15T20:39:19.892Z',
                     updated_at: '2022-03-15T20:39:19.892Z',
                     type: 'totp',
-                    environment_id: 'environment_1234',
                     totp: {
                         qr_code: 'qr-code-test',
                         secret: 'secret-test',
@@ -90,7 +87,6 @@ describe('MFA', () => {
                 expect(enrollResponse).toMatchInlineSnapshot(`
           Object {
             "created_at": "2022-03-15T20:39:19.892Z",
-            "environment_id": "environment_1234",
             "id": "auth_factor_1234",
             "object": "authentication_factor",
             "totp": Object {
@@ -112,7 +108,6 @@ describe('MFA', () => {
                     created_at: '2022-03-15T20:39:19.892Z',
                     updated_at: '2022-03-15T20:39:19.892Z',
                     type: 'sms',
-                    environment_id: 'environment_1234',
                     sms: {
                         phone_number: '+15555555555',
                     },
@@ -127,7 +122,6 @@ describe('MFA', () => {
                 expect(enrollResponse).toMatchInlineSnapshot(`
           Object {
             "created_at": "2022-03-15T20:39:19.892Z",
-            "environment_id": "environment_1234",
             "id": "auth_factor_1234",
             "object": "authentication_factor",
             "sms": Object {
@@ -144,7 +138,11 @@ describe('MFA', () => {
         describe('with no sms template', () => {
             it('challenge a factor with no sms template', () => __awaiter(void 0, void 0, void 0, function* () {
                 const mock = new axios_mock_adapter_1.default(axios_1.default);
-                mock.onPost('/auth/factors/challenge').reply(200, {
+                mock
+                    .onPost('/auth/factors/challenge', {
+                    authentication_factor_id: 'auth_factor_1234',
+                })
+                    .reply(200, {
                     object: 'authentication_challenge',
                     id: 'auth_challenge_1234',
                     created_at: '2022-03-15T20:39:19.892Z',
@@ -157,7 +155,7 @@ describe('MFA', () => {
                     apiHostname: 'api.workos.dev',
                 });
                 const challengeResponse = yield workos.mfa.challengeFactor({
-                    authentication_factor_id: 'auth_factor_1234',
+                    authenticationFactorId: 'auth_factor_1234',
                 });
                 expect(challengeResponse).toMatchInlineSnapshot(`
           Object {
@@ -172,10 +170,15 @@ describe('MFA', () => {
         `);
             }));
         });
-        describe('with totp', () => {
+        describe('with sms template', () => {
             it('challenge a factor with sms template', () => __awaiter(void 0, void 0, void 0, function* () {
                 const mock = new axios_mock_adapter_1.default(axios_1.default);
-                mock.onPost('/auth/factors/challenge').reply(200, {
+                mock
+                    .onPost('/auth/factors/challenge', {
+                    authentication_factor_id: 'auth_factor_1234',
+                    sms_template: 'This is your code: 12345',
+                })
+                    .reply(200, {
                     object: 'authentication_challenge',
                     id: 'auth_challenge_1234',
                     created_at: '2022-03-15T20:39:19.892Z',
@@ -188,8 +191,8 @@ describe('MFA', () => {
                     apiHostname: 'api.workos.dev',
                 });
                 const challengeResponse = yield workos.mfa.challengeFactor({
-                    authentication_factor_id: 'auth_factor_1234',
-                    sms_template: 'This is your code: 12345',
+                    authenticationFactorId: 'auth_factor_1234',
+                    smsTemplate: 'This is your code: 12345',
                 });
                 expect(challengeResponse).toMatchInlineSnapshot(`
           Object {
@@ -209,7 +212,12 @@ describe('MFA', () => {
         describe('verify with successful response', () => {
             it('verifies a successful factor', () => __awaiter(void 0, void 0, void 0, function* () {
                 const mock = new axios_mock_adapter_1.default(axios_1.default);
-                mock.onPost('/auth/factors/verify').reply(200, {
+                mock
+                    .onPost('/auth/factors/verify', {
+                    authentication_challenge_id: 'auth_challenge_1234',
+                    code: '12345',
+                })
+                    .reply(200, {
                     challenge: {
                         object: 'authentication_challenge',
                         id: 'auth_challenge_1234',
@@ -225,7 +233,7 @@ describe('MFA', () => {
                     apiHostname: 'api.workos.dev',
                 });
                 const verifyResponse = yield workos.mfa.verifyFactor({
-                    authentication_challenge_id: 'auth_challenge_1234',
+                    authenticationChallengeId: 'auth_challenge_1234',
                     code: '12345',
                 });
                 expect(verifyResponse).toMatchInlineSnapshot(`

package/lib/organizations/organizations.spec.js

@@ -27,7 +27,7 @@ describe('Organizations', () => {
     describe('listOrganizations', () => {
         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);
+                mock.onGet('/organizations').replyOnce(200, list_organizations_json_1.default);
                 const { data, list_metadata: listMetadata } = yield workos.organizations.listOrganizations();
                 expect(mock.history.get[0].params).toBeUndefined();
                 expect(mock.history.get[0].url).toEqual('/organizations');
@@ -40,7 +40,11 @@ describe('Organizations', () => {
         });
         describe('with the domain option', () => {
             it('forms the proper request to the API', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onGet().reply(200, list_organizations_json_1.default);
+                mock
+                    .onGet('/organizations', {
+                    domains: ['example.com'],
+                })
+                    .replyOnce(200, list_organizations_json_1.default);
                 const { data } = yield workos.organizations.listOrganizations({
                     domains: ['example.com'],
                 });
@@ -53,7 +57,11 @@ describe('Organizations', () => {
         });
         describe('with the before option', () => {
             it('forms the proper request to the API', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onGet().reply(200, list_organizations_json_1.default);
+                mock
+                    .onGet('/organizations', {
+                    before: 'before-id',
+                })
+                    .replyOnce(200, list_organizations_json_1.default);
                 const { data } = yield workos.organizations.listOrganizations({
                     before: 'before-id',
                 });
@@ -66,7 +74,11 @@ describe('Organizations', () => {
         });
         describe('with the after option', () => {
             it('forms the proper request to the API', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onGet().reply(200, list_organizations_json_1.default);
+                mock
+                    .onGet('/organizations', {
+                    after: 'after-id',
+                })
+                    .replyOnce(200, list_organizations_json_1.default);
                 const { data } = yield workos.organizations.listOrganizations({
                     after: 'after-id',
                 });
@@ -79,7 +91,11 @@ describe('Organizations', () => {
         });
         describe('with the limit option', () => {
             it('forms the proper request to the API', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onGet().reply(200, list_organizations_json_1.default);
+                mock
+                    .onGet('/organizations', {
+                    limit: 10,
+                })
+                    .replyOnce(200, list_organizations_json_1.default);
                 const { data } = yield workos.organizations.listOrganizations({
                     limit: 10,
                 });
@@ -94,7 +110,12 @@ describe('Organizations', () => {
     describe('createOrganization', () => {
         describe('with a valid payload', () => {
             it('creates an organization', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onPost().reply(201, create_organization_json_1.default);
+                mock
+                    .onPost('/organizations', {
+                    domains: ['example.com'],
+                    name: 'Test Organization',
+                })
+                    .replyOnce(201, create_organization_json_1.default);
                 const subject = yield workos.organizations.createOrganization({
                     domains: ['example.com'],
                     name: 'Test Organization',
@@ -106,7 +127,12 @@ describe('Organizations', () => {
         });
         describe('with an invalid payload', () => {
             it('returns an error', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onPost().reply(409, create_organization_invalid_json_1.default, {
+                mock
+                    .onPost('/organizations', {
+                    domains: ['example.com'],
+                    name: 'Test Organization',
+                })
+                    .replyOnce(409, create_organization_invalid_json_1.default, {
                     'X-Request-ID': 'a-request-id',
                 });
                 yield expect(workos.organizations.createOrganization({
@@ -119,7 +145,9 @@ describe('Organizations', () => {
     describe('getOrganization', () => {
         it(`requests an Organization`, () => __awaiter(void 0, void 0, void 0, function* () {
             const mock = new axios_mock_adapter_1.default(axios_1.default);
-            mock.onGet().reply(200, get_organization_json_1.default);
+            mock
+                .onGet('/organizations/org_01EHT88Z8J8795GZNQ4ZP1J81T')
+                .replyOnce(200, get_organization_json_1.default);
             const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
             const subject = yield workos.organizations.getOrganization('org_01EHT88Z8J8795GZNQ4ZP1J81T');
             expect(mock.history.get[0].url).toEqual('/organizations/org_01EHT88Z8J8795GZNQ4ZP1J81T');
@@ -132,7 +160,9 @@ describe('Organizations', () => {
     describe('deleteOrganization', () => {
         it('sends request to delete an Organization', () => __awaiter(void 0, void 0, void 0, function* () {
             const mock = new axios_mock_adapter_1.default(axios_1.default);
-            mock.onDelete().reply(200, {});
+            mock
+                .onDelete('/organizations/org_01EHT88Z8J8795GZNQ4ZP1J81T')
+                .replyOnce(200, {});
             const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
             yield workos.organizations.deleteOrganization('org_01EHT88Z8J8795GZNQ4ZP1J81T');
             expect(mock.history.delete[0].url).toEqual('/organizations/org_01EHT88Z8J8795GZNQ4ZP1J81T');
@@ -141,7 +171,12 @@ describe('Organizations', () => {
     describe('updateOrganization', () => {
         describe('with a valid payload', () => {
             it('updates an organization', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onPut().reply(201, update_organization_json_1.default);
+                mock
+                    .onPut('/organizations/org_01EHT88Z8J8795GZNQ4ZP1J81T', {
+                    domains: ['example.com'],
+                    name: 'Test Organization 2',
+                })
+                    .replyOnce(201, update_organization_json_1.default);
                 const subject = yield workos.organizations.updateOrganization({
                     organization: 'org_01EHT88Z8J8795GZNQ4ZP1J81T',
                     domains: ['example.com'],

package/lib/passwordless/passwordless.spec.js

@@ -22,10 +22,16 @@ describe('Passwordless', () => {
     describe('createSession', () => {
         describe('with valid options', () => {
             it('creates a passwordless session', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onPost().reply(201, create_session_json_1.default);
-                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                 const email = 'passwordless-session-email@workos.com';
                 const redirectURI = 'https://example.com/passwordless/callback';
+                mock
+                    .onPost('/passwordless/sessions', {
+                    type: 'MagicLink',
+                    email,
+                    redirect_uri: redirectURI,
+                })
+                    .replyOnce(201, create_session_json_1.default);
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                 const session = yield workos.passwordless.createSession({
                     type: 'MagicLink',
                     email,
@@ -42,7 +48,7 @@ describe('Passwordless', () => {
     describe('sendEmail', () => {
         describe('with a valid session id', () => {
             it(`sends a request to send a magic link email`, () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onPost().reply(200);
+                mock.onPost('/passwordless/sessions/session_123/send').replyOnce(200);
                 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                 const sessionId = 'session_123';
                 yield workos.passwordless.sendSession(sessionId);

package/lib/portal/portal.spec.js

@@ -26,7 +26,13 @@ describe('Portal', () => {
         describe('with a valid organization', () => {
             describe('with the sso intent', () => {
                 it('returns an Admin Portal link', () => __awaiter(void 0, void 0, void 0, function* () {
-                    mock.onPost().reply(201, generate_link_json_1.default);
+                    mock
+                        .onPost('/portal/generate_link', {
+                        intent: generate_portal_link_intent_interface_1.GeneratePortalLinkIntent.SSO,
+                        organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3',
+                        return_url: 'https://www.example.com',
+                    })
+                        .replyOnce(201, generate_link_json_1.default);
                     const { link } = yield workos.portal.generateLink({
                         intent: generate_portal_link_intent_interface_1.GeneratePortalLinkIntent.SSO,
                         organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3',
@@ -37,7 +43,13 @@ describe('Portal', () => {
             });
             describe('with the dsync intent', () => {
                 it('returns an Admin Portal link', () => __awaiter(void 0, void 0, void 0, function* () {
-                    mock.onPost().reply(201, generate_link_json_1.default);
+                    mock
+                        .onPost('/portal/generate_link', {
+                        intent: generate_portal_link_intent_interface_1.GeneratePortalLinkIntent.DSync,
+                        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.DSync,
                         organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3',
@@ -49,7 +61,13 @@ describe('Portal', () => {
         });
         describe('with an invalid organization', () => {
             it('throws an error', () => __awaiter(void 0, void 0, void 0, function* () {
-                mock.onPost().reply(400, generate_link_invalid_json_1.default, {
+                mock
+                    .onPost('/portal/generate_link', {
+                    intent: generate_portal_link_intent_interface_1.GeneratePortalLinkIntent.SSO,
+                    organization: 'bogus-id',
+                    return_url: 'https://www.example.com',
+                })
+                    .reply(400, generate_link_invalid_json_1.default, {
                     'X-Request-ID': 'a-request-id',
                 });
                 yield expect(workos.portal.generateLink({

package/lib/sso/sso.spec.js

@@ -134,23 +134,40 @@ describe('SSO', () => {
             describe('with all information provided', () => {
                 it('sends a request to the WorkOS api for a profile', () => __awaiter(void 0, void 0, void 0, function* () {
                     const mock = new axios_mock_adapter_1.default(axios_1.default);
-                    mock.onPost('/sso/token').reply(200, {
-                        access_token: '01DMEK0J53CVMC32CK5SE0KZ8Q',
-                        profile: {
-                            id: 'prof_123',
-                            idp_id: '123',
-                            organization_id: 'org_123',
-                            connection_id: 'conn_123',
-                            connection_type: 'OktaSAML',
-                            email: 'foo@test.com',
-                            first_name: 'foo',
-                            last_name: 'bar',
-                            raw_attributes: {
-                                email: 'foo@test.com',
-                                first_name: 'foo',
-                                last_name: 'bar',
-                            },
-                        },
+                    const expectedBody = new URLSearchParams({
+                        client_id: 'proj_123',
+                        client_secret: 'sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU',
+                        code: 'authorization_code',
+                        grant_type: 'authorization_code',
+                    });
+                    expectedBody.sort();
+                    mock.onPost('/sso/token').replyOnce((config) => {
+                        const actualBody = new URLSearchParams(config.data);
+                        actualBody.sort();
+                        if (actualBody.toString() === expectedBody.toString()) {
+                            return [
+                                200,
+                                {
+                                    access_token: '01DMEK0J53CVMC32CK5SE0KZ8Q',
+                                    profile: {
+                                        id: 'prof_123',
+                                        idp_id: '123',
+                                        organization_id: 'org_123',
+                                        connection_id: 'conn_123',
+                                        connection_type: 'OktaSAML',
+                                        email: 'foo@test.com',
+                                        first_name: 'foo',
+                                        last_name: 'bar',
+                                        raw_attributes: {
+                                            email: 'foo@test.com',
+                                            first_name: 'foo',
+                                            last_name: 'bar',
+                                        },
+                                    },
+                                },
+                            ];
+                        }
+                        return [404];
                     });
                     const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                     const { access_token: accessToken, profile } = yield workos.sso.getProfileAndToken({
@@ -169,7 +186,11 @@ describe('SSO', () => {
         describe('getProfile', () => {
             it('calls the `/sso/profile` endpoint with the provided access token', () => __awaiter(void 0, void 0, void 0, function* () {
                 const mock = new axios_mock_adapter_1.default(axios_1.default);
-                mock.onGet().reply(200, {
+                mock
+                    .onGet('/sso/profile', {
+                    accessToken: 'access_token',
+                })
+                    .replyOnce(200, {
                     id: 'prof_123',
                     idp_id: '123',
                     organization_id: 'org_123',
@@ -197,7 +218,7 @@ describe('SSO', () => {
         describe('deleteConnection', () => {
             it('sends request to delete a Connection', () => __awaiter(void 0, void 0, void 0, function* () {
                 const mock = new axios_mock_adapter_1.default(axios_1.default);
-                mock.onDelete().reply(200, {});
+                mock.onDelete('/connections/conn_123').replyOnce(200, {});
                 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                 yield workos.sso.deleteConnection('conn_123');
                 expect(mock.history.delete[0].url).toEqual('/connections/conn_123');
@@ -206,7 +227,7 @@ describe('SSO', () => {
         describe('getConnection', () => {
             it(`requests a Connection`, () => __awaiter(void 0, void 0, void 0, function* () {
                 const mock = new axios_mock_adapter_1.default(axios_1.default);
-                mock.onGet().reply(200, {});
+                mock.onGet('/connections/conn_123').replyOnce(200, {});
                 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                 yield workos.sso.getConnection('conn_123');
                 expect(mock.history.get[0].url).toEqual('/connections/conn_123');
@@ -215,7 +236,7 @@ describe('SSO', () => {
         describe('listConnections', () => {
             it(`requests a list of Connections`, () => __awaiter(void 0, void 0, void 0, function* () {
                 const mock = new axios_mock_adapter_1.default(axios_1.default);
-                mock.onGet().reply(200, {});
+                mock.onGet('/connections').replyOnce(200, {});
                 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                 yield workos.sso.listConnections();
                 expect(mock.history.get[0].url).toEqual('/connections');

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

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

package/lib/webhooks/interfaces/index.js

@@ -16,3 +16,5 @@ 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);
+__exportStar(require("./webhook-directory-group.interface"), exports);
+__exportStar(require("./webhook-directory-user.interface"), exports);

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

@@ -0,0 +1,9 @@
+export interface WebhookDirectoryGroup<TRawAttributes = any> {
+    id: string;
+    idp_id: string;
+    directory_id: string;
+    name: string;
+    created_at: string;
+    updated_at: string;
+    raw_attributes: TRawAttributes;
+}

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

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

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

@@ -0,0 +1,5 @@
+import { User } from '../../directory-sync/interfaces';
+export interface WebhookDirectoryUser extends User {
+    created_at: string;
+    updated_at: string;
+}

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

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

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

@@ -1,4 +1,20 @@
-import { Directory } from '../../directory-sync/interfaces';
-export interface WebhookDirectory extends Omit<Directory, 'state'> {
-    state: 'active' | 'validating' | 'invalid_credentials' | 'inactive' | 'deleting';
+export declare type WebhookDirectoryType = 'okta scim v1.1' | 'okta scim v2.0' | 'azure scim v2.0' | 'bamboohr' | 'breathe hr' | 'cyberark scim v2.0' | 'fourth hr' | 'gsuite directory' | 'generic scim v1.1' | 'generic scim v2.0' | 'gusto' | 'hibob' | 'jump cloud scim v2.0' | 'onelogin scim v2.0' | 'people hr' | 'pingfederate scim v2.0' | 'rippling' | 's3' | 'workday';
+export declare type WebhookDirectoryState = 'active' | 'validating' | 'invalid_credentials' | 'inactive' | 'deleting';
+interface WebhookDirectoryDomain {
+    object: 'organization_domain';
+    id: string;
+    domain: string;
 }
+export interface WebhookDirectory {
+    object: 'directory';
+    id: string;
+    external_key: string;
+    type: WebhookDirectoryType;
+    state: WebhookDirectoryState;
+    name: string;
+    organization_id?: string;
+    domains: WebhookDirectoryDomain[];
+    created_at: string;
+    updated_at: string;
+}
+export {};

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

@@ -1,5 +1,6 @@
-import { Group, User } from '../../directory-sync/interfaces';
 import { Connection } from '../../sso/interfaces';
+import { WebhookDirectoryGroup as Group } from './webhook-directory-group.interface';
+import { WebhookDirectoryUser as User } from './webhook-directory-user.interface';
 import { WebhookDirectory as Directory } from './webhook-directory.interface';
 interface WebhookBase {
     id: string;
@@ -26,7 +27,7 @@ export interface DsyncDeactivatedWebhook extends WebhookBase {
 }
 export interface DsyncDeletedWebhook extends WebhookBase {
     event: 'dsync.deleted';
-    data: Directory;
+    data: Omit<Directory, 'domains' | 'external_key'>;
 }
 export interface DsyncGroupCreatedWebhook extends WebhookBase {
     event: 'dsync.group.created';
@@ -38,14 +39,14 @@ export interface DsyncGroupDeletedWebhook extends WebhookBase {
 }
 export interface DsyncGroupUpdatedWebhook extends WebhookBase {
     event: 'dsync.group.updated';
-    data: Group;
+    data: Group & Record<'previous_attributes', any>;
 }
 export interface DsyncGroupUserAddedWebhook extends WebhookBase {
     event: 'dsync.group.user_added';
     data: {
         directory_id: string;
         user: User;
-        group: Group;
+        group: Pick<Group, 'id' | 'name'>;
     };
 }
 export interface DsyncGroupUserRemovedWebhook extends WebhookBase {
@@ -53,7 +54,7 @@ export interface DsyncGroupUserRemovedWebhook extends WebhookBase {
     data: {
         directory_id: string;
         user: User;
-        group: Group;
+        group: Pick<Group, 'id' | 'name'>;
     };
 }
 export interface DsyncUserCreatedWebhook extends WebhookBase {
@@ -66,7 +67,7 @@ export interface DsyncUserDeletedWebhook extends WebhookBase {
 }
 export interface DsyncUserUpdatedWebhook extends WebhookBase {
     event: 'dsync.user.updated';
-    data: User;
+    data: User & Record<'previous_attributes', any>;
 }
 export declare type Webhook = ConnectionActivatedWebhook | ConnectionDeactivatedWebhook | ConnectionDeletedWebhook | DsyncActivatedWebhook | DsyncDeactivatedWebhook | DsyncDeletedWebhook | DsyncGroupCreatedWebhook | DsyncGroupUpdatedWebhook | DsyncGroupDeletedWebhook | DsyncGroupUserAddedWebhook | DsyncGroupUserRemovedWebhook | DsyncUserCreatedWebhook | DsyncUserUpdatedWebhook | DsyncUserDeletedWebhook;
 export {};

package/lib/workos.js

@@ -23,7 +23,7 @@ const portal_1 = require("./portal/portal");
 const sso_1 = require("./sso/sso");
 const webhooks_1 = require("./webhooks/webhooks");
 const mfa_1 = require("./mfa/mfa");
-const VERSION = '2.5.0-alpha.1';
+const VERSION = '2.6.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.5.0-alpha.1",
+  "version": "2.6.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -9,8 +9,8 @@
     "workos"
   ],
   "volta": {
-    "node": "14.19.0",
-    "yarn": "1.22.17"
+    "node": "14.19.3",
+    "yarn": "1.22.18"
   },
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -39,15 +39,15 @@
     "query-string": "7.1.1"
   },
   "devDependencies": {
-    "@types/jest": "27.4.1",
-    "@types/node": "14.18.12",
+    "@types/jest": "27.5.1",
+    "@types/node": "14.18.18",
     "@types/pluralize": "0.0.29",
     "axios-mock-adapter": "1.20.0",
     "jest": "27.5.1",
-    "prettier": "2.6.0",
-    "supertest": "6.2.2",
-    "ts-jest": "27.1.3",
+    "prettier": "2.6.2",
+    "supertest": "6.2.3",
+    "ts-jest": "27.1.5",
     "tslint": "6.1.3",
-    "typescript": "4.6.2"
+    "typescript": "4.6.4"
   }
 }