conductor-node 11.0.2 → 11.0.4

package/dist/src/interceptors/errorHandling.js

@@ -12,6 +12,8 @@ function addErrorHandlingInterceptors(httpClient) {
             const errorData = error.response.data;
             if ((0, error_1.isWellFormedConductorServerError)(errorData)) {
                 throw (0, error_1.generateConductorErrorFromType)({
+                    // The request ID is already in the response body, so no need to
+                    // copy it from the headers.
                     ...errorData.error,
                     httpStatusCode: error.response.status,
                     headers,
@@ -21,9 +23,12 @@ function addErrorHandlingInterceptors(httpClient) {
                 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.
+                // @ts-expect-error -- `error.response.headers` always exists as an `AxiosHeaders` instance.
                 requestId: error.response.headers.get("request-id"),
                 headers,
+                // Include to understand why `isWellFormedConductorServerError()`
+                // failed.
+                raw: errorData,
             });
         }
         if (error.code === axios_1.AxiosError.ECONNABORTED) {
@@ -41,7 +46,7 @@ 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({
-            message: "An error occurred with our connection to Conductor.",
+            message: `An error occurred with our connection to Conductor: ${error.message}`,
             code: error.code ?? "NETWORK_ERROR",
             httpStatusCode: error.status,
         });

package/dist/src/interceptors/logging.js

@@ -24,7 +24,9 @@ function addLoggingInterceptors(httpClient, verbose) {
         // NOTE: We cannot include duration because we lack access to
         // `AxiosError.config` because we already wrapped the error.
         if (verbose) {
-            console.log("Conductor error:", stringifyForLogs(error));
+            // No prefix "Conductor error:" because the error already includes a
+            // prefix (e.g., `ConductorConnectionError`).
+            console.log(stringifyForLogs(error));
         }
         throw error;
     });

package/dist/src/resources/EndUsersResource.d.ts

@@ -25,6 +25,9 @@ export interface EndUser {
 }
 export type EndUserCreateInput = Pick<EndUser, "email" | "name" | "sourceId">;
 export interface EndUserPingOutput {
+    /**
+     * The time, in milliseconds, that it took to ping the connection.
+     */
     readonly duration: number;
 }
 export default class EndUsersResource extends BaseResource {

package/dist/src/utils/checkForUpdates.js

@@ -5,21 +5,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkForUpdates = void 0;
 const package_json_1 = __importDefault(require("../../package.json"));
-const node_child_process_1 = require("node:child_process");
+const node_child_process_1 = __importDefault(require("node:child_process"));
 function checkForUpdates() {
     // Exit early if npm is not installed.
     try {
-        (0, node_child_process_1.execSync)("which npm");
+        node_child_process_1.default.execSync("which npm");
     }
     catch {
         return;
     }
     const currentVersion = package_json_1.default.version;
-    const latestVersion = (0, node_child_process_1.execSync)(`npm view ${package_json_1.default.name} version --silent`)
+    const latestVersion = node_child_process_1.default
+        .execSync(`npm view ${package_json_1.default.name} version --silent`)
         .toString()
         .trim();
     if (currentVersion !== latestVersion) {
-        console.warn(`⚠️ A new release of Conductor is available: ${currentVersion} -> ${latestVersion}. To update, run: yarn upgrade ${package_json_1.default.name} --latest`);
+        const updateCommand = process.env["npm_execpath"]?.includes("yarn") === true
+            ? "yarn add"
+            : "npm install";
+        console.warn(`⚠️ Update available for Conductor: ${currentVersion} -> ${latestVersion}. To update, run: ${updateCommand} ${package_json_1.default.name}@latest`);
     }
 }
 exports.checkForUpdates = checkForUpdates;

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

@@ -8,6 +8,7 @@ export interface ConductorErrorOptions {
     readonly integrationCode?: string | undefined;
     readonly requestId?: string | undefined;
     readonly headers?: Record<string, string>;
+    readonly raw?: unknown;
 }
 /**
  * The raw REST error response that Conductor's API returns.
@@ -89,7 +90,11 @@ export declare abstract class ConductorError extends Error {
      */
     readonly headers: Record<string, string> | undefined;
     /**
-     * The internal representation of `type` for debugging.
+     * The raw REST error response that Conductor's API returned.
+     */
+    protected readonly raw: unknown;
+    /**
+     * Conductor's internal representation of `type` for debugging.
      */
     protected readonly rawType: string;
     constructor(options: ConductorErrorOptions);

package/dist/src/utils/error.js

@@ -80,7 +80,11 @@ class ConductorError extends Error {
      */
     headers;
     /**
-     * The internal representation of `type` for debugging.
+     * The raw REST error response that Conductor's API returned.
+     */
+    raw;
+    /**
+     * Conductor's internal representation of `type` for debugging.
      */
     rawType;
     constructor(options) {
@@ -105,6 +109,10 @@ class ConductorError extends Error {
         this.integrationCode = options.integrationCode;
         this.requestId = options.requestId;
         this.headers = options.headers;
+        // Only set `raw` if provided instead of always setting it to `options`
+        // because the latter is usually a near duplicate of `this`, which we don't
+        // want to log unless necessary.
+        this.raw = options.raw;
         this.rawType = options.type;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "11.0.2",
+  "version": "11.0.4",
   "description": "Easily integrate the entire QuickBooks Desktop API using fully-typed async TypeScript",
   "keywords": [
     "QuickBooks Desktop",
@@ -26,9 +26,7 @@
     "postpack": "rm -rf dist",
     "clean": "rm -rf dist package conductor-node-*.tgz tsconfig.tsbuildinfo",
     "diff": "yarn pack && npm diff --diff=conductor-node@latest --diff=conductor-node-v$(node -p \"require('./package.json').version\").tgz && yarn clean",
-    "prepublishOnly": "yarn test",
-    "test": "yarn --cwd=../../ test ./packages/client",
-    "jest": "yarn --cwd=../../ jest"
+    "prepublishOnly": "yarn jest"
   },
   "engines": {
     "node": ">=16"