@workos-inc/node 7.60.0 → 7.61.0

package/lib/common/exceptions/parse-error.d.ts

@@ -0,0 +1,8 @@
+import { RequestException } from '../interfaces/request-exception.interface';
+export declare class ParseError extends Error implements RequestException {
+    readonly name = "ParseError";
+    readonly status = 500;
+    readonly rawBody: string;
+    readonly requestID: string;
+    constructor(message: string, rawBody: string, requestID: string);
+}

package/lib/common/exceptions/parse-error.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParseError = void 0;
+class ParseError extends Error {
+    constructor(message, rawBody, requestID) {
+        super(message);
+        this.name = 'ParseError';
+        this.status = 500;
+        this.rawBody = rawBody;
+        this.requestID = requestID;
+    }
+}
+exports.ParseError = ParseError;

package/lib/workos.d.ts

@@ -56,5 +56,6 @@ export declare class WorkOS {
     }>;
     delete(path: string, query?: any): Promise<void>;
     emitWarning(warning: string): void;
+    private handleParseError;
     private handleHttpError;
 }

package/lib/workos.js

@@ -31,7 +31,8 @@ const widgets_1 = require("./widgets/widgets");
 const actions_1 = require("./actions/actions");
 const vault_1 = require("./vault/vault");
 const conflict_exception_1 = require("./common/exceptions/conflict.exception");
-const VERSION = '7.60.0';
+const parse_error_1 = require("./common/exceptions/parse-error");
+const VERSION = '7.61.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 const HEADER_AUTHORIZATION = 'Authorization';
 const HEADER_IDEMPOTENCY_KEY = 'Idempotency-Key';
@@ -115,17 +116,24 @@ class WorkOS {
             if (options.warrantToken) {
                 requestHeaders[HEADER_WARRANT_TOKEN] = options.warrantToken;
             }
+            let res;
             try {
-                const res = yield this.client.post(path, entity, {
+                res = yield this.client.post(path, entity, {
                     params: options.query,
                     headers: requestHeaders,
                 });
-                return { data: yield res.toJSON() };
             }
             catch (error) {
                 this.handleHttpError({ path, error });
                 throw error;
             }
+            try {
+                return { data: yield res.toJSON() };
+            }
+            catch (error) {
+                yield this.handleParseError(error, res);
+                throw error;
+            }
         });
     }
     get(path, options = {}) {
@@ -137,17 +145,24 @@ class WorkOS {
             if (options.warrantToken) {
                 requestHeaders[HEADER_WARRANT_TOKEN] = options.warrantToken;
             }
+            let res;
             try {
-                const res = yield this.client.get(path, {
+                res = yield this.client.get(path, {
                     params: options.query,
                     headers: requestHeaders,
                 });
-                return { data: yield res.toJSON() };
             }
             catch (error) {
                 this.handleHttpError({ path, error });
                 throw error;
             }
+            try {
+                return { data: yield res.toJSON() };
+            }
+            catch (error) {
+                yield this.handleParseError(error, res);
+                throw error;
+            }
         });
     }
     put(path, entity, options = {}) {
@@ -156,17 +171,24 @@ class WorkOS {
             if (options.idempotencyKey) {
                 requestHeaders[HEADER_IDEMPOTENCY_KEY] = options.idempotencyKey;
             }
+            let res;
             try {
-                const res = yield this.client.put(path, entity, {
+                res = yield this.client.put(path, entity, {
                     params: options.query,
                     headers: requestHeaders,
                 });
-                return { data: yield res.toJSON() };
             }
             catch (error) {
                 this.handleHttpError({ path, error });
                 throw error;
             }
+            try {
+                return { data: yield res.toJSON() };
+            }
+            catch (error) {
+                yield this.handleParseError(error, res);
+                throw error;
+            }
         });
     }
     delete(path, query) {
@@ -186,6 +208,17 @@ class WorkOS {
         // tslint:disable-next-line:no-console
         console.warn(`WorkOS: ${warning}`);
     }
+    handleParseError(error, res) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (error instanceof SyntaxError) {
+                const rawResponse = res.getRawResponse();
+                const requestID = (_a = rawResponse.headers.get('X-Request-ID')) !== null && _a !== void 0 ? _a : '';
+                const rawBody = yield rawResponse.text();
+                throw new parse_error_1.ParseError(error.message, rawBody, requestID);
+            }
+        });
+    }
     handleHttpError({ path, error }) {
         var _a;
         if (!(error instanceof http_client_1.HttpClientError)) {

package/lib/workos.spec.js

@@ -16,6 +16,7 @@ const jest_fetch_mock_1 = __importDefault(require("jest-fetch-mock"));
 const test_utils_1 = require("./common/utils/test-utils");
 const promises_1 = __importDefault(require("fs/promises"));
 const exceptions_1 = require("./common/exceptions");
+const parse_error_1 = require("./common/exceptions/parse-error");
 const index_1 = require("./index");
 const index_worker_1 = require("./index.worker");
 const rate_limit_exceeded_exception_1 = require("./common/exceptions/rate-limit-exceeded.exception");
@@ -218,6 +219,70 @@ describe('WorkOS', () => {
                 expect((0, test_utils_1.fetchBody)({ raw: true })).toBe('');
             }));
         });
+        describe('when the api responds with invalid JSON', () => {
+            it('throws a ParseError', () => __awaiter(void 0, void 0, void 0, function* () {
+                const mockResponse = {
+                    ok: true,
+                    status: 200,
+                    headers: new Headers({
+                        'X-Request-ID': 'a-request-id',
+                        'content-type': 'application/json',
+                    }),
+                    text: () => Promise.resolve('invalid json{'),
+                    json: () => Promise.reject(new SyntaxError('Invalid JSON')),
+                };
+                jest_fetch_mock_1.default.mockResolvedValueOnce(mockResponse);
+                const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                const error = yield workos.post('/path', {}).catch((e) => e);
+                expect(error).toBeInstanceOf(parse_error_1.ParseError);
+                expect(error.rawBody).toBe('invalid json{');
+                expect(error.requestID).toBe('a-request-id');
+            }));
+        });
+    });
+    describe('get', () => {
+        describe('when the api responds with invalid JSON', () => {
+            it('throws a ParseError', () => __awaiter(void 0, void 0, void 0, function* () {
+                const mockResponse = {
+                    ok: true,
+                    status: 200,
+                    headers: new Headers({
+                        'X-Request-ID': 'a-request-id',
+                        'content-type': 'application/json',
+                    }),
+                    text: () => Promise.resolve('malformed json}'),
+                    json: () => Promise.reject(new SyntaxError('Invalid JSON')),
+                };
+                jest_fetch_mock_1.default.mockResolvedValueOnce(mockResponse);
+                const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                const error = yield workos.get('/path').catch((e) => e);
+                expect(error).toBeInstanceOf(parse_error_1.ParseError);
+                expect(error.rawBody).toBe('malformed json}');
+                expect(error.requestID).toBe('a-request-id');
+            }));
+        });
+    });
+    describe('put', () => {
+        describe('when the api responds with invalid JSON', () => {
+            it('throws a ParseError', () => __awaiter(void 0, void 0, void 0, function* () {
+                const mockResponse = {
+                    ok: true,
+                    status: 200,
+                    headers: new Headers({
+                        'X-Request-ID': 'a-request-id',
+                        'content-type': 'application/json',
+                    }),
+                    text: () => Promise.resolve('broken json['),
+                    json: () => Promise.reject(new SyntaxError('Invalid JSON')),
+                };
+                jest_fetch_mock_1.default.mockResolvedValueOnce(mockResponse);
+                const workos = new index_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                const error = yield workos.put('/path', {}).catch((e) => e);
+                expect(error).toBeInstanceOf(parse_error_1.ParseError);
+                expect(error.rawBody).toBe('broken json[');
+                expect(error.requestID).toBe('a-request-id');
+            }));
+        });
     });
     describe('when in an environment that does not support fetch', () => {
         const fetchFn = globalThis.fetch;

package/package.json

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