conductor-node 10.0.1 → 10.1.0

package/dist/src/interceptors/errorHandling.js

@@ -8,17 +8,22 @@ function addErrorHandlingInterceptors(httpClient) {
         // The request was made and the server responded with a status code that
         // falls out of the range of 2xx.
         if (error.response) {
+            const headers = { ...error.response.headers };
             const errorData = error.response.data;
-            if (!(0, error_1.isWellFormedConductorServerError)(errorData)) {
-                throw new error_1.ConductorInternalError({
-                    code: "INVALID_JSON_RESPONSE",
-                    message: "Invalid JSON received from the Conductor API.",
-                    httpStatusCode: error.status ?? axios_1.HttpStatusCode.InternalServerError,
+            if ((0, error_1.isWellFormedConductorServerError)(errorData)) {
+                throw (0, error_1.generateConductorErrorFromType)({
+                    ...errorData.error,
+                    httpStatusCode: error.response.status,
+                    headers,
                 });
             }
-            throw (0, error_1.generateConductorErrorFromType)({
-                ...errorData.error,
-                httpStatusCode: error.response.status,
+            throw new error_1.ConductorInternalError({
+                message: "Invalid JSON received from the Conductor API.",
+                code: "INVALID_JSON_RESPONSE",
+                httpStatusCode: error.status ?? axios_1.HttpStatusCode.InternalServerError,
+                // @ts-expect-error -- `error.response.headers` is always an `AxiosHeaders` instance.
+                requestId: error.response.headers.get("request-id"),
+                headers,
             });
         }
         if (error.code === axios_1.AxiosError.ECONNABORTED) {
@@ -27,8 +32,8 @@ function addErrorHandlingInterceptors(httpClient) {
                 message += ` (${error.config.timeout}ms)`;
             }
             throw new error_1.ConductorConnectionError({
-                code: error.code,
                 message,
+                code: error.code,
                 httpStatusCode: error.status ?? axios_1.HttpStatusCode.RequestTimeout,
             });
         }
@@ -36,8 +41,8 @@ function addErrorHandlingInterceptors(httpClient) {
         // Conductor API is offline) or an error ocurred when setting up the
         // request (e.g., no network connection).
         throw new error_1.ConductorConnectionError({
-            code: error.code ?? "NETWORK_ERROR",
             message: "An error occurred with our connection to Conductor.",
+            code: error.code ?? "NETWORK_ERROR",
             httpStatusCode: error.status,
         });
     });

package/dist/src/utils/error.d.ts

@@ -1,23 +1,26 @@
 export declare const DEFAULT_END_USER_MESSAGE = "An internal server error occurred. Please try again later.";
 export interface ConductorErrorOptions {
+    readonly message: string;
+    readonly endUserMessage?: string;
     readonly type: string;
     readonly code: string;
     readonly httpStatusCode?: number | undefined;
-    readonly message: string;
-    readonly endUserMessage?: string;
     readonly integrationCode?: string | undefined;
+    readonly requestId?: string | undefined;
+    readonly headers?: Record<string, string>;
 }
 /**
  * The raw REST error response that Conductor's API returns.
  */
 export interface ConductorServerError {
     readonly error: {
+        readonly message: string;
+        readonly endUserMessage: string;
         readonly type: string;
         readonly code: string;
         readonly httpStatusCode: number;
-        readonly message: string;
-        readonly endUserMessage: string;
         readonly integrationCode?: string;
+        readonly requestId?: string;
     };
 }
 export declare function isWellFormedConductorServerError(error: unknown): error is ConductorServerError;
@@ -26,6 +29,21 @@ export declare function isWellFormedConductorServerError(error: unknown): error
  * Specifically for errors that Conductor's API returned.
  */
 export declare abstract class ConductorError extends Error {
+    /**
+     * The developer-friendly error message for your logs.
+     */
+    readonly message: string;
+    /**
+     * The end-user-friendly error message to display in your app's UI to your
+     * end-users.
+     *
+     * This value exists for *every* error. E.g., for a QBD connection error, it
+     * might recommend the end-user to check that their QuickBooks Desktop is open
+     * and that they're logged in. But if a Conductor API key is expired, e.g.,
+     * this message will just say "An internal server error occurred. Please try
+     * again later.".
+     */
+    readonly endUserMessage: string;
     /**
      * Categorizes the error.
      *
@@ -42,25 +60,9 @@ export declare abstract class ConductorError extends Error {
      */
     readonly code: string;
     /**
-     * The HTTP status code of the response that included the error. You probably
-     * won't need this.
+     * The HTTP status code of the response that included the error.
      */
     readonly httpStatusCode: number | undefined;
-    /**
-     * The developer-friendly error message for your logs.
-     */
-    readonly message: string;
-    /**
-     * The end-user-friendly error message to display in your app's UI to your
-     * end-users.
-     *
-     * This value exists for *every* error. E.g., for a QBD connection error, it
-     * might recommend the end-user to check that their QuickBooks Desktop is open
-     * and that they're logged in. But if a Conductor API key is expired, e.g.,
-     * this message will just say "An internal server error occurred. Please try
-     * again later.".
-     */
-    readonly endUserMessage: string;
     /**
      * The unique error code supplied by the third-party integration for errors
      * returned by the integration (i.e., `ConductorIntegrationError`) or
@@ -75,6 +77,17 @@ export declare abstract class ConductorError extends Error {
      * should not rely on this code to be the same across integrations.
      */
     readonly integrationCode: string | undefined;
+    /**
+     * The unique request identifier of the API request that caused the error.
+     *
+     * If you need to contact us about a specific request, providing the request
+     * identifier will ensure the fastest possible resolution.
+     */
+    readonly requestId: string | undefined;
+    /**
+     * The HTTP headers of the response that included the error.
+     */
+    readonly headers: Record<string, string> | undefined;
     /**
      * The internal representation of `type` for debugging.
      */

package/dist/src/utils/error.js

@@ -7,11 +7,11 @@ exports.DEFAULT_END_USER_MESSAGE = "An internal server error occurred. Please tr
 function isWellFormedConductorServerError(error) {
     return (error instanceof Object &&
         typeof error.error === "object" &&
+        typeof error.error.message === "string" &&
+        typeof error.error.endUserMessage === "string" &&
         typeof error.error.type === "string" &&
         typeof error.error.code === "string" &&
-        typeof error.error.httpStatusCode === "number" &&
-        typeof error.error.message === "string" &&
-        typeof error.error.endUserMessage === "string");
+        typeof error.error.httpStatusCode === "number");
 }
 exports.isWellFormedConductorServerError = isWellFormedConductorServerError;
 /**
@@ -19,6 +19,21 @@ exports.isWellFormedConductorServerError = isWellFormedConductorServerError;
  * Specifically for errors that Conductor's API returned.
  */
 class ConductorError extends Error {
+    /**
+     * The developer-friendly error message for your logs.
+     */
+    message;
+    /**
+     * The end-user-friendly error message to display in your app's UI to your
+     * end-users.
+     *
+     * This value exists for *every* error. E.g., for a QBD connection error, it
+     * might recommend the end-user to check that their QuickBooks Desktop is open
+     * and that they're logged in. But if a Conductor API key is expired, e.g.,
+     * this message will just say "An internal server error occurred. Please try
+     * again later.".
+     */
+    endUserMessage;
     /**
      * Categorizes the error.
      *
@@ -35,25 +50,9 @@ class ConductorError extends Error {
      */
     code;
     /**
-     * The HTTP status code of the response that included the error. You probably
-     * won't need this.
+     * The HTTP status code of the response that included the error.
      */
     httpStatusCode;
-    /**
-     * The developer-friendly error message for your logs.
-     */
-    message;
-    /**
-     * The end-user-friendly error message to display in your app's UI to your
-     * end-users.
-     *
-     * This value exists for *every* error. E.g., for a QBD connection error, it
-     * might recommend the end-user to check that their QuickBooks Desktop is open
-     * and that they're logged in. But if a Conductor API key is expired, e.g.,
-     * this message will just say "An internal server error occurred. Please try
-     * again later.".
-     */
-    endUserMessage;
     /**
      * The unique error code supplied by the third-party integration for errors
      * returned by the integration (i.e., `ConductorIntegrationError`) or
@@ -68,6 +67,17 @@ class ConductorError extends Error {
      * should not rely on this code to be the same across integrations.
      */
     integrationCode;
+    /**
+     * The unique request identifier of the API request that caused the error.
+     *
+     * If you need to contact us about a specific request, providing the request
+     * identifier will ensure the fastest possible resolution.
+     */
+    requestId;
+    /**
+     * The HTTP headers of the response that included the error.
+     */
+    headers;
     /**
      * The internal representation of `type` for debugging.
      */
@@ -86,12 +96,14 @@ class ConductorError extends Error {
         //    `ConductorError` always have the correct `type` even if they are
         //    instantiated with the wrong options.
         this.type = this.constructor.name;
-        this.rawType = options.type;
-        this.code = options.code;
-        this.httpStatusCode = options.httpStatusCode;
         this.message = options.message;
         this.endUserMessage = options.endUserMessage ?? exports.DEFAULT_END_USER_MESSAGE;
+        this.code = options.code;
+        this.httpStatusCode = options.httpStatusCode;
         this.integrationCode = options.integrationCode;
+        this.requestId = options.requestId;
+        this.headers = options.headers;
+        this.rawType = options.type;
     }
 }
 exports.ConductorError = ConductorError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "10.0.1",
+  "version": "10.1.0",
   "description": "Easily integrate the entire QuickBooks Desktop API using fully-typed async TypeScript",
   "license": "MIT",
   "type": "commonjs",
@@ -24,7 +24,7 @@
     "node": ">=16"
   },
   "dependencies": {
-    "axios": "^0.21.4 || ^1.4.0"
+    "axios": "^1.4.0"
   },
   "devDependencies": {
     "axios-mock-adapter": "^1.21.4",