conductor-node 8.2.0 → 8.2.3

package/README.md

@@ -2,6 +2,8 @@
 
 Execute _any_ read or write [QuickBooks Desktop API](https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop) through async TypeScript and receive a fully-typed response.
 
+<img src="https://user-images.githubusercontent.com/170023/213273732-83dd6881-0b36-4787-820b-bd55cdc8444f.jpg" alt="qbd" width="600"/>
+
 ## Requirements
 
 1. A Conductor API key from Danny.

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "8.2.0",
+    "version": "8.2.3",
     "description": "Easily integrate with the entire QuickBooks Desktop API with fully-typed async TypeScript",
     "author": "Danny Nemer <hi@DannyNemer.com>",
     "license": "MIT",

package/dist/src/error.d.ts

@@ -0,0 +1,18 @@
+export declare const DEFAULT_ERROR_CODE = "CONDUCTOR__INTERNAL_SERVER_ERROR";
+export declare const DEFAULT_END_USER_MESSAGE = "An internal server error occurred. Please try again later.";
+interface ConductorRawError {
+    readonly type: string;
+    readonly code: string;
+    readonly developerMessage: string;
+    readonly endUserMessage?: string;
+    readonly statusCode?: number;
+}
+export declare class ConductorError extends Error {
+    readonly type: string;
+    readonly code: string;
+    readonly developerMessage: string;
+    readonly endUserMessage: string;
+    readonly statusCode: number | undefined;
+    constructor(raw: ConductorRawError);
+}
+export {};

package/dist/src/error.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConductorError = exports.DEFAULT_END_USER_MESSAGE = exports.DEFAULT_ERROR_CODE = void 0;
+exports.DEFAULT_ERROR_CODE = "CONDUCTOR__INTERNAL_SERVER_ERROR";
+exports.DEFAULT_END_USER_MESSAGE = "An internal server error occurred. Please try again later.";
+class ConductorError extends Error {
+    type;
+    code;
+    developerMessage;
+    endUserMessage;
+    statusCode;
+    constructor(raw) {
+        super(raw.developerMessage);
+        this.name = "ConductorError";
+        this.type = raw.type;
+        this.code = raw.code;
+        this.developerMessage = raw.developerMessage;
+        this.endUserMessage = raw.endUserMessage ?? exports.DEFAULT_END_USER_MESSAGE;
+        this.statusCode = raw.statusCode;
+    }
+}
+exports.ConductorError = ConductorError;

package/dist/src/graphql/graphqlOperationWrapper.d.ts

@@ -1,6 +1,7 @@
+import { ConductorError } from "../error";
 import type { getSdk } from "../graphql/__generated__/operationTypes";
 export declare function wrapGraphqlOperations<T extends ReturnType<typeof getSdk>>(graphqlOperations: T, verbose: boolean): T;
 export declare function graphqlOperationWrapper<V extends {
     [key: string]: unknown;
 }, R>(operationName: string, variables: V | undefined, operation: (variables: V | undefined) => Promise<R>, verbose: boolean): Promise<R>;
-export declare function formatError(error: Error): Error;
+export declare function generateConductorError(error: Error): ConductorError;

package/dist/src/graphql/graphqlOperationWrapper.js

@@ -3,8 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatError = exports.graphqlOperationWrapper = exports.wrapGraphqlOperations = void 0;
+exports.generateConductorError = exports.graphqlOperationWrapper = exports.wrapGraphqlOperations = void 0;
 const package_json_1 = __importDefault(require("../../package.json"));
+const error_1 = require("../error");
 const graphql_request_1 = require("graphql-request");
 const node_util_1 = __importDefault(require("node:util"));
 function wrapGraphqlOperations(graphqlOperations, verbose) {
@@ -17,7 +18,7 @@ function wrapGraphqlOperations(graphqlOperations, verbose) {
 }
 exports.wrapGraphqlOperations = wrapGraphqlOperations;
 async function graphqlOperationWrapper(operationName, variables, operation, verbose) {
-    const graphqlInfo = {
+    const graphqlLog = {
         operationName,
         input: variables
             ? Object.keys(variables).length === 1 && "input" in variables
@@ -26,7 +27,7 @@ async function graphqlOperationWrapper(operationName, variables, operation, verb
             : {},
     };
     if (verbose) {
-        console.log(`Conductor request start: ${node_util_1.default.inspect(graphqlInfo, {
+        console.log(`Conductor request start: ${node_util_1.default.inspect(graphqlLog, {
             depth: undefined,
         })}`);
     }
@@ -34,52 +35,72 @@ async function graphqlOperationWrapper(operationName, variables, operation, verb
     try {
         const result = await operation(variables);
         if (verbose) {
-            const responseInfo = {
+            const responseLog = {
                 duration: getDurationString(startTime),
-                ...graphqlInfo,
+                ...graphqlLog,
             };
-            const responseString = node_util_1.default.inspect(responseInfo, { depth: undefined });
+            const responseString = node_util_1.default.inspect(responseLog, { depth: undefined });
             console.log(`Conductor request complete: ${responseString}`);
         }
         return result;
     }
     catch (error) {
-        const formattedError = formatError(error);
+        const conductorError = generateConductorError(error);
         if (verbose) {
-            const errorInfo = {
+            const errorLog = {
                 duration: getDurationString(startTime),
-                error: String(formattedError),
-                ...graphqlInfo,
+                error: String(conductorError),
+                ...graphqlLog,
             };
-            const errorString = node_util_1.default.inspect(errorInfo, { depth: undefined });
+            const errorString = node_util_1.default.inspect(errorLog, { depth: undefined });
             console.log(`Conductor error: ${errorString}`);
         }
-        throw formattedError;
+        throw conductorError;
     }
 }
 exports.graphqlOperationWrapper = graphqlOperationWrapper;
-function formatError(error) {
+function generateConductorError(error) {
     if (error instanceof graphql_request_1.ClientError) {
         const { response } = error;
         if ([404, 502, 503].includes(response.status)) {
-            return new Error(`The Conductor server returned a ${response.status} error, which may indicate that the server is down. Please alert the Conductor team if this error persists.`);
+            return new error_1.ConductorError({
+                type: "connection_error",
+                code: error_1.DEFAULT_ERROR_CODE,
+                developerMessage: `The Conductor server returned a ${response.status} error, which may indicate that the server is down. Please alert the Conductor team if this error persists.`,
+                statusCode: response.status,
+            });
         }
         const nestedError = response.errors?.[0];
         if (nestedError?.extensions["code"] === "GRAPHQL_VALIDATION_FAILED") {
-            return new Error(`The Conductor server is no longer compatible with your version of "${package_json_1.default.name}". Please run "yarn upgrade ${package_json_1.default.name}@latest --latest" to update.`);
+            return new error_1.ConductorError({
+                type: "temp",
+                code: error_1.DEFAULT_ERROR_CODE,
+                developerMessage: `The Conductor server is no longer compatible with your version of "${package_json_1.default.name}". Please run "yarn upgrade ${package_json_1.default.name}@latest --latest" to update.`,
+                statusCode: response.status,
+            });
         }
+        // TODO: Integrate with new error attributes.
         const errorMessage = nestedError?.message ??
             // Though `ClientError.response.error` is *not* defined in the type
             // definition, we've seen it occur (e.g., attempting to access the
             // `development` environment when `ngrok` is not running locally).
             response["error"];
         if (errorMessage !== undefined) {
-            return new Error(errorMessage);
+            return new error_1.ConductorError({
+                type: "temp",
+                code: error_1.DEFAULT_ERROR_CODE,
+                developerMessage: errorMessage,
+                statusCode: response.status,
+            });
         }
     }
-    return error;
+    return new error_1.ConductorError({
+        type: "temp",
+        code: error_1.DEFAULT_ERROR_CODE,
+        developerMessage: "Invalid JSON received from the Conductor API.",
+    });
 }
-exports.formatError = formatError;
+exports.generateConductorError = generateConductorError;
 function getDurationString(startTime) {
     const duration = Date.now() - startTime;
     return `${Math.round(duration / 10) / 100}s`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "8.2.0",
+  "version": "8.2.3",
   "description": "Easily integrate with the entire QuickBooks Desktop API with fully-typed async TypeScript",
   "author": "Danny Nemer <hi@DannyNemer.com>",
   "license": "MIT",