@workos-inc/node 3.0.0-user-management.2 → 3.0.0

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

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

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

@@ -3,12 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const get_primary_email_1 = require("./get-primary-email");
 describe('getPrimaryEmail', () => {
     const user = {
+        object: 'directory_user',
         id: 'user_123',
-        custom_attributes: {
+        customAttributes: {
             custom: true,
         },
-        directory_id: 'dir_123',
-        organization_id: 'org_123',
+        directoryId: 'dir_123',
+        organizationId: 'org_123',
         emails: [
             {
                 primary: true,
@@ -16,13 +17,15 @@ describe('getPrimaryEmail', () => {
                 value: 'jonsnow@workos.com',
             },
         ],
-        first_name: 'Jon',
-        idp_id: 'idp_foo',
-        last_name: 'Snow',
-        raw_attributes: {},
+        firstName: 'Jon',
+        idpId: 'idp_foo',
+        lastName: 'Snow',
+        rawAttributes: {},
         state: 'active',
         username: 'jonsnow',
-        job_title: 'Knight of the Watch',
+        jobTitle: 'Knight of the Watch',
+        createdAt: '2021-10-27 15:21:50.640958',
+        updatedAt: '2021-12-13 12:15:45.531847',
     };
     it(`returns primary email value`, () => {
         const primaryEmail = (0, get_primary_email_1.getPrimaryEmail)(user);

package/lib/events/events.d.ts

@@ -1,7 +1,6 @@
 import { WorkOS } from '../workos';
-import { Event } from './interfaces/event.interface';
-import { List } from '../common/interfaces/list.interface';
 import { ListEventOptions } from './interfaces';
+import { Event, List } from '../common/interfaces';
 export declare class Events {
     private readonly workos;
     constructor(workos: WorkOS);

package/lib/events/events.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Events = void 0;
+const serializers_1 = require("../common/serializers");
 class Events {
     constructor(workos) {
         this.workos = workos;
@@ -19,7 +20,7 @@ class Events {
             const { data } = yield this.workos.get(`/events`, {
                 query: options,
             });
-            return data;
+            return (0, serializers_1.deserializeList)(data, serializers_1.deserializeEvent);
         });
     }
 }

package/lib/events/events.spec.js

@@ -15,16 +15,42 @@ 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 interfaces_1 = require("../sso/interfaces");
 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 event = {
+        id: 'event_01234ABCD',
+        createdAt: '2020-05-06 04:21:48.649164',
+        event: 'connection.activated',
+        data: {
+            object: 'connection',
+            id: 'conn_01234ABCD',
+            organizationId: 'org_1234',
+            name: 'Connection',
+            type: interfaces_1.ConnectionType.OktaSAML,
+            connectionType: interfaces_1.ConnectionType.OktaSAML,
+            state: 'active',
+            domains: [],
+            createdAt: '2020-05-06 04:21:48.649164',
+            updatedAt: '2020-05-06 04:21:48.649164',
+        },
+    };
     const eventResponse = {
         id: 'event_01234ABCD',
         created_at: '2020-05-06 04:21:48.649164',
-        event: 'dsync.user.created',
+        event: 'connection.activated',
         data: {
-            id: 'event_01234ABCD',
+            object: 'connection',
+            id: 'conn_01234ABCD',
+            organization_id: 'org_1234',
+            name: 'Connection',
+            connection_type: interfaces_1.ConnectionType.OktaSAML,
+            state: 'active',
+            domains: [],
+            created_at: '2020-05-06 04:21:48.649164',
+            updated_at: '2020-05-06 04:21:48.649164',
         },
     };
     describe('listEvents', () => {
@@ -35,15 +61,23 @@ describe('Event', () => {
         };
         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);
+            const subject = yield workos.events.listEvents({});
+            expect(subject).toEqual({
+                object: 'list',
+                data: [event],
+                listMetadata: {},
+            });
         }));
         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);
+            expect(list).toEqual({
+                object: 'list',
+                data: [event],
+                listMetadata: {},
+            });
         }));
     });
 });

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

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

package/lib/events/interfaces/index.js

@@ -15,4 +15,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 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

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

package/lib/index.d.ts

@@ -10,6 +10,6 @@ export * from './organizations/interfaces';
 export * from './passwordless/interfaces';
 export * from './portal/interfaces';
 export * from './sso/interfaces';
-export * from './webhooks/interfaces';
+export * from './users/interfaces';
 export { WorkOS };
 export default WorkOS;

package/lib/index.js

@@ -28,6 +28,6 @@ __exportStar(require("./organizations/interfaces"), exports);
 __exportStar(require("./passwordless/interfaces"), exports);
 __exportStar(require("./portal/interfaces"), exports);
 __exportStar(require("./sso/interfaces"), exports);
-__exportStar(require("./webhooks/interfaces"), exports);
+__exportStar(require("./users/interfaces"), exports);
 // tslint:disable-next-line:no-default-export
 exports.default = workos_1.WorkOS;

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

@@ -1,4 +1,13 @@
 export interface Challenge {
+    object: 'authentication_challenge';
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    expiresAt?: string;
+    code: string;
+    authenticationFactorId: string;
+}
+export interface ChallengeResponse {
     object: 'authentication_challenge';
     id: string;
     created_at: string;

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

@@ -1,11 +1,20 @@
-import { Sms } from './sms.interface';
-import { Totp } from './totp.interface';
+import { Sms, SmsResponse } from './sms.interface';
+import { Totp, TotpResponse } from './totp.interface';
 export interface Factor {
+    object: 'authentication_factor';
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    type: string;
+    sms?: Sms;
+    totp?: Totp;
+}
+export interface FactorResponse {
     object: 'authentication_factor';
     id: string;
     created_at: string;
     updated_at: string;
     type: string;
-    sms: Sms;
-    totp: Totp;
+    sms?: SmsResponse;
+    totp?: TotpResponse;
 }

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

@@ -0,0 +1,9 @@
+export * from './challenge-factor-options';
+export * from './challenge.interface';
+export * from './enroll-factor-options';
+export * from './factor.interface';
+export * from './sms.interface';
+export * from './totp.interface';
+export * from './verify-challenge-options';
+export * from './verify-challenge-response';
+export * from './verify-factor-options';

package/lib/mfa/interfaces/index.js

@@ -0,0 +1,25 @@
+"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("./challenge-factor-options"), exports);
+__exportStar(require("./challenge.interface"), exports);
+__exportStar(require("./enroll-factor-options"), exports);
+__exportStar(require("./factor.interface"), exports);
+__exportStar(require("./sms.interface"), exports);
+__exportStar(require("./totp.interface"), exports);
+__exportStar(require("./verify-challenge-options"), exports);
+__exportStar(require("./verify-challenge-response"), exports);
+__exportStar(require("./verify-factor-options"), exports);

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

@@ -1,3 +1,6 @@
 export interface Sms {
+    phoneNumber: string;
+}
+export interface SmsResponse {
     phone_number: string;
 }

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

@@ -1,4 +1,11 @@
 export interface Totp {
+    issuer: string;
+    user: string;
+    qrCode: string;
+    secret: string;
+    uri: string;
+}
+export interface TotpResponse {
     issuer: string;
     user: string;
     qr_code: string;

package/lib/mfa/interfaces/verify-challenge-response.d.ts

@@ -1,5 +1,9 @@
-import { Challenge } from './challenge.interface';
+import { Challenge, ChallengeResponse } from './challenge.interface';
 export interface VerifyResponse {
     challenge: Challenge;
     valid: boolean;
 }
+export interface VerifyResponseResponse {
+    challenge: ChallengeResponse;
+    valid: boolean;
+}

package/lib/mfa/mfa.d.ts

@@ -1,16 +1,10 @@
 import { WorkOS } from '../workos';
-import { ChallengeFactorOptions } from './interfaces/challenge-factor-options';
-import { Challenge } from './interfaces/challenge.interface';
-import { EnrollFactorOptions } from './interfaces/enroll-factor-options';
-import { Factor } from './interfaces/factor.interface';
-import { VerifyFactorOptions } from './interfaces/verify-factor-options';
-import { VerifyResponse } from './interfaces/verify-challenge-response';
-import { VerifyChallengeOptions } from './interfaces/verify-challenge-options';
+import { ChallengeFactorOptions, Challenge, EnrollFactorOptions, Factor, VerifyChallengeOptions, VerifyFactorOptions, VerifyResponse } from './interfaces';
 export declare class Mfa {
     private readonly workos;
     constructor(workos: WorkOS);
     deleteFactor(id: string): Promise<void>;
-    getFactor(id: string): Promise<any>;
+    getFactor(id: string): Promise<Factor>;
     enrollFactor(options: EnrollFactorOptions): Promise<Factor>;
     challengeFactor(options: ChallengeFactorOptions): Promise<Challenge>;
     /**

package/lib/mfa/mfa.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Mfa = void 0;
+const serializers_1 = require("./serializers");
 class Mfa {
     constructor(workos) {
         this.workos = workos;
@@ -22,7 +23,7 @@ class Mfa {
     getFactor(id) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.workos.get(`/auth/factors/${id}`);
-            return data;
+            return (0, serializers_1.deserializeFactor)(data);
         });
     }
     enrollFactor(options) {
@@ -42,7 +43,7 @@ class Mfa {
                         return {};
                 }
             })()));
-            return data;
+            return (0, serializers_1.deserializeFactor)(data);
         });
     }
     challengeFactor(options) {
@@ -50,7 +51,7 @@ class Mfa {
             const { data } = yield this.workos.post(`/auth/factors/${options.authenticationFactorId}/challenge`, {
                 sms_template: 'smsTemplate' in options ? options.smsTemplate : undefined,
             });
-            return data;
+            return (0, serializers_1.deserializeChallenge)(data);
         });
     }
     /**
@@ -66,7 +67,7 @@ class Mfa {
             const { data } = yield this.workos.post(`/auth/challenges/${options.authenticationChallengeId}/verify`, {
                 code: options.code,
             });
-            return data;
+            return (0, serializers_1.deserializeVerifyResponse)(data);
         });
     }
 }