conductor-node 8.4.0 → 8.4.1

package/README.md

@@ -164,9 +164,10 @@ The `ConductorError` and its subclasses have the following properties:
 {
   // The error type.
   type: string;
-  // The error code.
+  // The unique error code. This is useful for adding special handling for
+  // specific errors.
   code: string;
-  // The developer-friendly error message for your logs.
+  // The error message for your logs.
   message: string;
   // The end-user-friendly error message to display in your app.
   endUserMessage: string;

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "8.4.0",
+    "version": "8.4.1",
     "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 → errors.d.ts}

@@ -11,10 +11,26 @@ export interface ConductorErrorOptions {
  * Specifically for errors returned from Conductor's API.
  */
 export declare class ConductorError extends Error {
+    /**
+     * The error type.
+     */
     readonly type: string;
+    /**
+     * The raw error type for internal debugging.
+     */
     readonly rawType: string;
+    /**
+     * The unique error code. This is useful for adding special handling
+     * for specific errors.
+     */
     readonly code: string;
+    /**
+     * The end-user-friendly error message to display in your app.
+     */
     readonly endUserMessage: string;
+    /**
+     * The HTTP status code of the response that included the error.
+     */
     readonly statusCode: number | undefined;
     constructor(options: ConductorErrorOptions);
 }

package/dist/src/{error.js → errors.js}

@@ -8,10 +8,26 @@ exports.DEFAULT_END_USER_MESSAGE = "An internal server error occurred. Please tr
  * Specifically for errors returned from Conductor's API.
  */
 class ConductorError extends Error {
+    /**
+     * The error type.
+     */
     type;
+    /**
+     * The raw error type for internal debugging.
+     */
     rawType;
+    /**
+     * The unique error code. This is useful for adding special handling
+     * for specific errors.
+     */
     code;
+    /**
+     * The end-user-friendly error message to display in your app.
+     */
     endUserMessage;
+    /**
+     * The HTTP status code of the response that included the error.
+     */
     statusCode;
     constructor(options) {
         super(options.message);

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

@@ -1,4 +1,4 @@
-import type { ConductorError } from "../error";
+import type { ConductorError } from "../errors";
 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 {

package/dist/src/graphql/graphqlOperationWrapper.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.wrapError = exports.graphqlOperationWrapper = exports.wrapGraphqlOperations = void 0;
 const package_json_1 = __importDefault(require("../../package.json"));
-const error_1 = require("../error");
+const errors_1 = require("../errors");
 const graphql_request_1 = require("graphql-request");
 const node_util_1 = __importDefault(require("node:util"));
 function wrapGraphqlOperations(graphqlOperations, verbose) {
@@ -63,7 +63,7 @@ function wrapError(error) {
     if (error instanceof graphql_request_1.ClientError) {
         const { response } = error;
         if ([404, 502, 503].includes(response.status)) {
-            return (0, error_1.generateConductorError)({
+            return (0, errors_1.generateConductorError)({
                 type: "CONNECTION_ERROR",
                 code: "SERVER_UNAVAILABLE",
                 message: `The Conductor server returned a ${response.status} error, which may indicate that the server is unavailable. Please alert the Conductor team if this error persists.`,
@@ -74,14 +74,14 @@ function wrapError(error) {
         const errorExtensions = nestedError?.extensions;
         if (errorExtensions) {
             if (errorExtensions["code"] === "GRAPHQL_VALIDATION_FAILED") {
-                return (0, error_1.generateConductorError)({
+                return (0, errors_1.generateConductorError)({
                     type: "INVALID_REQUEST_ERROR",
                     code: "CLIENT_OUTDATED",
                     message: `Your version of "${package_json_1.default.name}" is not longer compatible with the Conductor server. Please run "yarn upgrade ${package_json_1.default.name} --latest" to update.`,
                     statusCode: response.status,
                 });
             }
-            return (0, error_1.generateConductorError)({
+            return (0, errors_1.generateConductorError)({
                 type: errorExtensions["type"],
                 code: errorExtensions["code"],
                 message: nestedError.message,
@@ -90,7 +90,7 @@ function wrapError(error) {
             });
         }
     }
-    return (0, error_1.generateConductorError)({
+    return (0, errors_1.generateConductorError)({
         type: "INTERNAL_ERROR",
         code: "INVALID_JSON_RESPONSE",
         message: "Invalid JSON received from the Conductor API.",

package/dist/src/index.d.ts

@@ -1,5 +1,5 @@
 import Client from "./Client";
 export default Client;
 export { type ClientOptions } from "./Client";
-export * from "./error";
+export * from "./errors";
 export * as QbdTypes from "./integrations/qbd/qbdTypes";

package/dist/src/index.js

@@ -34,5 +34,5 @@ exports.QbdTypes = void 0;
 const Client_1 = __importDefault(require("./Client"));
 // eslint-disable-next-line unicorn/prefer-export-from -- We need `Client` to be the default export, which is impossible to define with `export from`.
 exports.default = Client_1.default;
-__exportStar(require("./error"), exports);
+__exportStar(require("./errors"), exports);
 exports.QbdTypes = __importStar(require("./integrations/qbd/qbdTypes"));

package/package.json

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