conductor-node 7.4.10 → 7.5.0

package/README.md

@@ -130,3 +130,19 @@ The response includes the following:
   }
 }
 ```
+
+## TypeScript
+
+Access the full QuickBooks Desktop API through TypeScript. The `qbd.*` APIs are fully-typed with inline documentation and will autocomplete in your editor.
+
+To manually access the QBD types, import them from `conductor-node` like so:
+
+```ts
+import { QbdTypes } from "conductor-node";
+
+const accountAddInput: QbdTypes.AccountAdd = {
+  Name: "Test Account",
+  AccountType: "Bank",
+  OpenBalance: "100",
+};
+```

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "7.4.10",
+    "version": "7.5.0",
     "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/Client.d.ts

@@ -1,6 +1,6 @@
-import type { Environment } from "./environment";
 import type { GraphqlCreateIntegrationConnectionInput, GraphqlCreateIntegrationConnectionMutation, GraphqlGetConnectionStatusQuery, GraphqlGetConnectionStatusQueryVariables, GraphqlGetIntegrationConnectionQuery, GraphqlGetIntegrationConnectionQueryVariables, GraphqlGetIntegrationConnectionsQuery, GraphqlSendIntegrationRequestInput, GraphqlSendIntegrationRequestMutation } from "./graphql/__generated__/operationTypes";
 import QbdIntegration from "./integrations/qbd/QbdIntegration";
+import type { Environment } from "./utils/environment";
 export interface ClientOptions {
     /** Log each request and response. */
     readonly verbose?: boolean;
@@ -10,7 +10,6 @@ export default class Client {
     /** QuickBooks Desktop integration. */
     readonly qbd: QbdIntegration;
     private readonly verbose;
-    private readonly serverURL;
     private readonly graphqlClient;
     private readonly graphqlOperations;
     constructor(apiKey: string, { verbose, serverEnvironment }?: ClientOptions);
@@ -53,5 +52,6 @@ export default class Client {
     }): Promise<GraphqlCreateIntegrationConnectionMutation["createIntegrationConnection"]>;
     sendIntegrationRequest(input: GraphqlSendIntegrationRequestInput): Promise<GraphqlSendIntegrationRequestMutation["sendIntegrationRequest"]["response"]>;
     private graphqlOperationWrapper;
+    private reformatError;
     private checkForUpdates;
 }

package/dist/src/Client.js

@@ -4,25 +4,22 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const package_json_1 = __importDefault(require("./../package.json"));
-const environment_1 = require("./environment");
 const operationTypes_1 = require("./graphql/__generated__/operationTypes");
 const QbdIntegration_1 = __importDefault(require("./integrations/qbd/QbdIntegration"));
+const environment_1 = require("./utils/environment");
 const chalk_1 = __importDefault(require("chalk"));
 const graphql_request_1 = require("graphql-request");
 const node_child_process_1 = require("node:child_process");
-const node_util_1 = __importDefault(require("node:util"));
 class Client {
     /** QuickBooks Desktop integration. */
     qbd;
     verbose;
-    serverURL;
     graphqlClient;
     graphqlOperations;
     constructor(apiKey, { verbose = false, serverEnvironment = "production" } = {}) {
         this.checkForUpdates();
         this.verbose = verbose;
-        this.serverURL = (0, environment_1.getServerUrlForEnvironment)(serverEnvironment);
-        this.graphqlClient = new graphql_request_1.GraphQLClient(`${this.serverURL}/graphql`, {
+        this.graphqlClient = new graphql_request_1.GraphQLClient(`${(0, environment_1.getServerUrlForEnvironment)(serverEnvironment)}/graphql`, {
             headers: {
                 Authorization: `Bearer ${apiKey}`,
                 "User-Agent": `${package_json_1.default.name}/${package_json_1.default.version} (Node.js ${process.version}; ${process.platform} ${process.arch})`,
@@ -96,42 +93,64 @@ class Client {
             .then((result) => result.sendIntegrationRequest.response);
     }
     async graphqlOperationWrapper(operationName, variables, operation) {
+        const graphqlInfo = {
+            operationName,
+            input: variables
+                ? Object.keys(variables).length === 1 && "input" in variables
+                    ? variables["input"] // Flatten the input if it only has one key called "input".
+                    : variables
+                : {},
+        };
         if (this.verbose) {
-            console.log(`Client sent request to ${this.serverURL}:`, operationName, node_util_1.default.inspect(variables, { depth: undefined, colors: true }));
-            console.time("Request time");
+            console.log(`Conductor request start: ${JSON.stringify(graphqlInfo, undefined, 2)}`);
         }
+        const startTime = Date.now();
         try {
             const result = await operation(variables);
             if (this.verbose) {
-                console.timeEnd("Request time");
-                console.log(`Client received response from ${this.serverURL}:`, node_util_1.default.inspect(result, { depth: undefined, colors: true }));
+                const responseInfo = {
+                    duration: `${(Date.now() - startTime) / 1000}s`,
+                    ...graphqlInfo,
+                };
+                const responseString = JSON.stringify(responseInfo, undefined, 2);
+                console.log(`Conductor response: ${responseString}`);
             }
             return result;
         }
         catch (error) {
+            const formattedError = this.reformatError(error);
             if (this.verbose) {
-                console.timeEnd("Request time");
+                const errorInfo = {
+                    duration: `${(Date.now() - startTime) / 1000}s`,
+                    error: String(formattedError),
+                    ...graphqlInfo,
+                };
+                const errorString = JSON.stringify(errorInfo, undefined, 2);
+                console.log(`Conductor error: ${errorString}`);
             }
-            if (error instanceof graphql_request_1.ClientError) {
-                const { response } = error;
-                if ([404, 502, 503].includes(response.status)) {
-                    throw 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.`);
-                }
-                const nestedError = response.errors?.[0];
-                if (nestedError?.extensions["code"] === "GRAPHQL_VALIDATION_FAILED") {
-                    throw 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.`);
-                }
-                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) {
-                    throw new Error(errorMessage);
-                }
+            throw formattedError;
+        }
+    }
+    reformatError(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.`);
+            }
+            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.`);
+            }
+            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);
             }
-            throw error;
         }
+        return error;
     }
     checkForUpdates() {
         if (environment_1.currentEnvironment.isTest) {

package/dist/src/index.d.ts

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

package/dist/src/index.js

@@ -26,9 +26,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Types = void 0;
+exports.QbdTypes = void 0;
 // eslint-disable-next-line consistent-default-export-name/default-export-match-filename -- This file defines the exports for the `conductor-node` package, as defined by `main` in `package.json`. Hence, no other internal code imports this module and we can ignore the error that that the file's name must match the default export (`Client`).
 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;
-exports.Types = __importStar(require("./integrations/types"));
+exports.QbdTypes = __importStar(require("./integrations/qbd/qbdTypes"));

package/dist/src/{environment.d.ts → utils/environment.d.ts}

@@ -1,9 +1,8 @@
-export type Environment = "development" | "production" | "staging" | "test";
+export type Environment = "development" | "production" | "test";
 export declare const currentEnvironment: {
     name: Environment;
     isTest: boolean;
     isDevelopment: boolean;
-    isStaging: boolean;
     isProduction: boolean;
 };
 export declare function getServerUrlForEnvironment(environment: Environment): string;

package/dist/src/{environment.js → utils/environment.js}

@@ -6,7 +6,6 @@ exports.currentEnvironment = {
     name: currentEnvironmentName,
     isTest: currentEnvironmentName === "test",
     isDevelopment: currentEnvironmentName === "development",
-    isStaging: currentEnvironmentName === "staging",
     isProduction: currentEnvironmentName === "production",
 };
 function getServerUrlForEnvironment(environment) {
@@ -18,9 +17,6 @@ function getServerUrlForEnvironment(environment) {
         case "development": {
             return "https://conductor.ngrok.io";
         }
-        case "staging": {
-            return "https://staging.api.conductor.is";
-        }
         case "production": {
             return "https://production.api.conductor.is";
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "7.4.10",
+  "version": "7.5.0",
   "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/integrations/types.d.ts

@@ -1 +0,0 @@
-export * as qbd from "../integrations/qbd/qbdTypes";

package/dist/src/integrations/types.js

@@ -1,27 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.qbd = void 0;
-exports.qbd = __importStar(require("../integrations/qbd/qbdTypes"));