@workos-inc/node 2.6.0 → 2.6.1

package/README.md

@@ -1,7 +1,7 @@
 # WorkOS Node.js Library
 
 ![npm](https://img.shields.io/npm/v/@workos-inc/node)
-[![Build Status](https://workos.semaphoreci.com/badges/workos-node/branches/master.svg?style=shields)](https://workos.semaphoreci.com/projects/workos-node)
+[![Build Status](https://workos.semaphoreci.com/badges/workos-node/branches/main.svg?style=shields)](https://workos.semaphoreci.com/projects/workos-node)
 
 The WorkOS library for Node.js provides convenient access to the WorkOS API from applications written in server-side JavaScript.
 

package/lib/common/exceptions/unprocessable-entity.exception.d.ts

@@ -1,8 +1,14 @@
 import { UnprocessableEntityError } from '../interfaces';
 export declare class UnprocessableEntityException extends Error {
-    readonly requestID: string;
     readonly status: number;
     readonly name: string;
     readonly message: string;
-    constructor(errors: UnprocessableEntityError[], requestID: string);
+    readonly code?: string;
+    readonly requestID: string;
+    constructor({ code, errors, message, requestID, }: {
+        code?: string;
+        errors?: UnprocessableEntityError[];
+        message?: string;
+        requestID: string;
+    });
 }

package/lib/common/exceptions/unprocessable-entity.exception.js

@@ -6,15 +6,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnprocessableEntityException = void 0;
 const pluralize_1 = __importDefault(require("pluralize"));
 class UnprocessableEntityException extends Error {
-    constructor(errors, requestID) {
+    constructor({ code, errors, message, requestID, }) {
         super();
-        this.requestID = requestID;
         this.status = 422;
         this.name = 'UnprocessableEntityException';
-        const requirement = (0, pluralize_1.default)('requirement', errors.length);
-        this.message = `The following ${requirement} must be met:\n`;
-        for (const { code } of errors) {
-            this.message = this.message.concat(`\t${code}\n`);
+        this.message = 'Unprocessable entity';
+        this.requestID = requestID;
+        if (message) {
+            this.message = message;
+        }
+        if (code) {
+            this.code = code;
+        }
+        if (errors) {
+            const requirement = (0, pluralize_1.default)('requirement', errors.length);
+            this.message = `The following ${requirement} must be met:\n`;
+            for (const { code } of errors) {
+                this.message = this.message.concat(`\t${code}\n`);
+            }
         }
     }
 }

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

@@ -1,10 +1,5 @@
 import { Challenge } from './challenge.interface';
-export interface VerifyResponseSuccess {
+export interface VerifyResponse {
     challenge: Challenge;
     valid: boolean;
 }
-export interface VerifyResponseError {
-    code: string;
-    message: string;
-}
-export declare type VerifyResponse = VerifyResponseSuccess | VerifyResponseError;

package/lib/mfa/mfa.spec.js

@@ -14,6 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = __importDefault(require("axios"));
 const axios_mock_adapter_1 = __importDefault(require("axios-mock-adapter"));
+const exceptions_1 = require("../common/exceptions");
 const workos_1 = require("../workos");
 describe('MFA', () => {
     describe('getFactor', () => {
@@ -132,6 +133,24 @@ describe('MFA', () => {
           }
         `);
             }));
+            describe('when phone number is invalid', () => {
+                it('throws an exception', () => __awaiter(void 0, void 0, void 0, function* () {
+                    const mock = new axios_mock_adapter_1.default(axios_1.default);
+                    mock.onPost('/auth/factors/enroll').reply(422, {
+                        message: `Phone number is invalid: 'foo'`,
+                        code: 'invalid_phone_number',
+                    }, {
+                        'X-Request-ID': 'req_123',
+                    });
+                    const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU', {
+                        apiHostname: 'api.workos.dev',
+                    });
+                    yield expect(workos.mfa.enrollFactor({
+                        type: 'sms',
+                        phoneNumber: 'foo',
+                    })).rejects.toThrow(exceptions_1.UnprocessableEntityException);
+                }));
+            });
         });
     });
     describe('challengeFactor', () => {
@@ -252,5 +271,79 @@ describe('MFA', () => {
         `);
             }));
         });
+        describe('when the challenge has been previously verified', () => {
+            it('throws an exception', () => __awaiter(void 0, void 0, void 0, function* () {
+                const mock = new axios_mock_adapter_1.default(axios_1.default);
+                mock
+                    .onPost('/auth/factors/verify', {
+                    authentication_challenge_id: 'auth_challenge_1234',
+                    code: '12345',
+                })
+                    .reply(422, {
+                    message: `The authentication challenge '12345' has already been verified.`,
+                    code: 'authentication_challenge_previously_verified',
+                }, {
+                    'X-Request-ID': 'req_123',
+                });
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU', {
+                    apiHostname: 'api.workos.dev',
+                });
+                yield expect(workos.mfa.verifyFactor({
+                    authenticationChallengeId: 'auth_challenge_1234',
+                    code: '12345',
+                })).rejects.toThrow(exceptions_1.UnprocessableEntityException);
+            }));
+        });
+        describe('when the challenge has expired', () => {
+            it('throws an exception', () => __awaiter(void 0, void 0, void 0, function* () {
+                const mock = new axios_mock_adapter_1.default(axios_1.default);
+                mock
+                    .onPost('/auth/factors/verify', {
+                    authentication_challenge_id: 'auth_challenge_1234',
+                    code: '12345',
+                })
+                    .reply(422, {
+                    message: `The authentication challenge '12345' has expired.`,
+                    code: 'authentication_challenge_expired',
+                }, {
+                    'X-Request-ID': 'req_123',
+                });
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU', {
+                    apiHostname: 'api.workos.dev',
+                });
+                yield expect(workos.mfa.verifyFactor({
+                    authenticationChallengeId: 'auth_challenge_1234',
+                    code: '12345',
+                })).rejects.toThrow(exceptions_1.UnprocessableEntityException);
+            }));
+            it('exception has code', () => __awaiter(void 0, void 0, void 0, function* () {
+                const mock = new axios_mock_adapter_1.default(axios_1.default);
+                mock
+                    .onPost('/auth/factors/verify', {
+                    authentication_challenge_id: 'auth_challenge_1234',
+                    code: '12345',
+                })
+                    .reply(422, {
+                    message: `The authentication challenge '12345' has expired.`,
+                    code: 'authentication_challenge_expired',
+                }, {
+                    'X-Request-ID': 'req_123',
+                });
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU', {
+                    apiHostname: 'api.workos.dev',
+                });
+                try {
+                    yield workos.mfa.verifyFactor({
+                        authenticationChallengeId: 'auth_challenge_1234',
+                        code: '12345',
+                    });
+                }
+                catch (error) {
+                    expect(error).toMatchObject({
+                        code: 'authentication_challenge_expired',
+                    });
+                }
+            }));
+        });
     });
 });

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.6.0';
+const VERSION = '2.6.1';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {
@@ -78,14 +78,19 @@ class WorkOS {
                 if (response) {
                     const { status, data, headers } = response;
                     const requestID = headers['X-Request-ID'];
-                    const { error, error_description: errorDescription } = data;
+                    const { code, error_description: errorDescription, error, message, } = data;
                     switch (status) {
                         case 401: {
                             throw new exceptions_1.UnauthorizedException(requestID);
                         }
                         case 422: {
                             const { errors } = data;
-                            throw new exceptions_1.UnprocessableEntityException(errors, requestID);
+                            throw new exceptions_1.UnprocessableEntityException({
+                                code,
+                                errors,
+                                message,
+                                requestID,
+                            });
                         }
                         case 404: {
                             throw new exceptions_1.NotFoundException(path, requestID);
@@ -122,14 +127,19 @@ class WorkOS {
                 if (response) {
                     const { status, data, headers } = response;
                     const requestID = headers['X-Request-ID'];
-                    const { error, error_description: errorDescription } = data;
+                    const { code, error_description: errorDescription, error, message, } = data;
                     switch (status) {
                         case 401: {
                             throw new exceptions_1.UnauthorizedException(requestID);
                         }
                         case 422: {
                             const { errors } = data;
-                            throw new exceptions_1.UnprocessableEntityException(errors, requestID);
+                            throw new exceptions_1.UnprocessableEntityException({
+                                code,
+                                errors,
+                                message,
+                                requestID,
+                            });
                         }
                         case 404: {
                             throw new exceptions_1.NotFoundException(path, requestID);
@@ -165,14 +175,19 @@ class WorkOS {
                 if (response) {
                     const { status, data, headers } = response;
                     const requestID = headers['X-Request-ID'];
-                    const { error, error_description: errorDescription } = data;
+                    const { code, error_description: errorDescription, error, message, } = data;
                     switch (status) {
                         case 401: {
                             throw new exceptions_1.UnauthorizedException(requestID);
                         }
                         case 422: {
                             const { errors } = data;
-                            throw new exceptions_1.UnprocessableEntityException(errors, requestID);
+                            throw new exceptions_1.UnprocessableEntityException({
+                                code,
+                                errors,
+                                message,
+                                requestID,
+                            });
                         }
                         case 404: {
                             throw new exceptions_1.NotFoundException(path, requestID);
@@ -203,14 +218,19 @@ class WorkOS {
                 if (response) {
                     const { status, data, headers } = response;
                     const requestID = headers['X-Request-ID'];
-                    const { error, error_description: errorDescription } = data;
+                    const { code, error_description: errorDescription, error, message, } = data;
                     switch (status) {
                         case 401: {
                             throw new exceptions_1.UnauthorizedException(requestID);
                         }
                         case 422: {
                             const { errors } = data;
-                            throw new exceptions_1.UnprocessableEntityException(errors, requestID);
+                            throw new exceptions_1.UnprocessableEntityException({
+                                code,
+                                errors,
+                                message,
+                                requestID,
+                            });
                         }
                         case 404: {
                             throw new exceptions_1.NotFoundException(path, requestID);

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.6.0",
+  "version": "2.6.1",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",