@workos-inc/node 2.5.0 → 2.5.1

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/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

@@ -144,7 +144,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 +161,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 +176,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 +197,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 +218,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 +239,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/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';
+const VERSION = '2.5.1';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.5.0",
+  "version": "2.5.1",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -44,10 +44,10 @@
     "@types/pluralize": "0.0.29",
     "axios-mock-adapter": "1.20.0",
     "jest": "27.5.1",
-    "prettier": "2.6.0",
+    "prettier": "2.6.1",
     "supertest": "6.2.2",
-    "ts-jest": "27.1.3",
+    "ts-jest": "27.1.4",
     "tslint": "6.1.3",
-    "typescript": "4.6.2"
+    "typescript": "4.6.3"
   }
 }