conductor-node 7.4.11 → 7.5.1

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.11",
+    "version": "7.5.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/Client.d.ts

@@ -9,8 +9,6 @@ export interface ClientOptions {
 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);
@@ -51,7 +49,6 @@ export default class Client {
     createIntegrationConnection(input: GraphqlCreateIntegrationConnectionInput & {
         integrationKey: "quickbooks-desktop";
     }): Promise<GraphqlCreateIntegrationConnectionMutation["createIntegrationConnection"]>;
+    /** Not intended for public use. */
     sendIntegrationRequest(input: GraphqlSendIntegrationRequestInput): Promise<GraphqlSendIntegrationRequestMutation["sendIntegrationRequest"]["response"]>;
-    private graphqlOperationWrapper;
-    private checkForUpdates;
 }

package/dist/src/Client.js

@@ -4,37 +4,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const package_json_1 = __importDefault(require("./../package.json"));
+const graphqlOperationWrapper_1 = require("./graphql/graphqlOperationWrapper");
 const operationTypes_1 = require("./graphql/__generated__/operationTypes");
 const QbdIntegration_1 = __importDefault(require("./integrations/qbd/QbdIntegration"));
+const checkForUpdates_1 = __importDefault(require("./utils/checkForUpdates"));
 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`, {
+        (0, checkForUpdates_1.default)();
+        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})`,
             },
         });
-        this.graphqlOperations = (0, operationTypes_1.getSdk)(this.graphqlClient);
-        Object.entries(this.graphqlOperations).forEach(([operationName, operation]) => {
-            // @ts-expect-error -- `operationName` is a key of `this.gqlOperations`.
-            this.graphqlOperations[operationName] = async (variables) => this.graphqlOperationWrapper(operationName, variables, 
-            // @ts-expect-error -- It is safe to call `operation` with `variables`.
-            operation);
-        });
+        this.graphqlOperations = (0, graphqlOperationWrapper_1.wrapGraphqlOperations)((0, operationTypes_1.getSdk)(this.graphqlClient), verbose);
         this.qbd = new QbdIntegration_1.default(this);
     }
     async getIntegrationConnection(integrationConnectionId) {
@@ -88,62 +77,12 @@ class Client {
             .createIntegrationConnection({ input })
             .then((result) => result.createIntegrationConnection);
     }
-    // TODO: Hide this method from the dev-user while still allowing the
-    // integration clients to access it.
+    // TODO: Find a way to make this private.
+    /** Not intended for public use. */
     async sendIntegrationRequest(input) {
         return this.graphqlOperations
             .sendIntegrationRequest({ input })
             .then((result) => result.sendIntegrationRequest.response);
     }
-    async graphqlOperationWrapper(operationName, variables, operation) {
-        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");
-        }
-        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 }));
-            }
-            return result;
-        }
-        catch (error) {
-            if (this.verbose) {
-                console.timeEnd("Request time");
-            }
-            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 error;
-        }
-    }
-    checkForUpdates() {
-        if (environment_1.currentEnvironment.isTest) {
-            return;
-        }
-        const currentVersion = package_json_1.default.version;
-        const latestVersion = (0, node_child_process_1.execSync)(`yarn info ${package_json_1.default.name} version`)
-            .toString()
-            .trim();
-        if (currentVersion !== latestVersion) {
-            console.warn(chalk_1.default.yellow(`⚠️ A new version of Conductor is available! You are using "${package_json_1.default.name}" version ${currentVersion} but the latest version is ${latestVersion}. Please run "yarn upgrade ${package_json_1.default.name} --latest" to update.`));
-        }
-    }
 }
 exports.default = Client;

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

@@ -0,0 +1,6 @@
+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 formatGraphqlError(error: Error): Error;

package/dist/src/graphql/graphqlOperationWrapper.js

@@ -0,0 +1,86 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatGraphqlError = exports.graphqlOperationWrapper = exports.wrapGraphqlOperations = void 0;
+const package_json_1 = __importDefault(require("../../package.json"));
+const graphql_request_1 = require("graphql-request");
+const node_util_1 = __importDefault(require("node:util"));
+function wrapGraphqlOperations(graphqlOperations, verbose) {
+    return Object.fromEntries(Object.entries(graphqlOperations).map(([operationName, operation]) => [
+        operationName,
+        async (variables) => graphqlOperationWrapper(operationName, 
+        // @ts-expect-error -- It is safe to call `operation` with `variables`.
+        variables, operation, verbose),
+    ]));
+}
+exports.wrapGraphqlOperations = wrapGraphqlOperations;
+async function graphqlOperationWrapper(operationName, variables, operation, verbose) {
+    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 (verbose) {
+        console.log(`Conductor request sent: ${node_util_1.default.inspect(graphqlInfo, {
+            depth: undefined,
+        })}`);
+    }
+    const startTime = Date.now();
+    try {
+        const result = await operation(variables);
+        if (verbose) {
+            const responseInfo = {
+                duration: getDurationString(startTime),
+                ...graphqlInfo,
+            };
+            const responseString = node_util_1.default.inspect(responseInfo, { depth: undefined });
+            console.log(`Conductor response: ${responseString}`);
+        }
+        return result;
+    }
+    catch (error) {
+        const formattedError = formatGraphqlError(error);
+        if (verbose) {
+            const errorInfo = {
+                duration: getDurationString(startTime),
+                error: String(formattedError),
+                ...graphqlInfo,
+            };
+            const errorString = node_util_1.default.inspect(errorInfo, { depth: undefined });
+            console.log(`Conductor error: ${errorString}`);
+        }
+        throw formattedError;
+    }
+}
+exports.graphqlOperationWrapper = graphqlOperationWrapper;
+function formatGraphqlError(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);
+        }
+    }
+    return error;
+}
+exports.formatGraphqlError = formatGraphqlError;
+function getDurationString(startTime) {
+    const duration = Date.now() - startTime;
+    return `${Math.round(duration / 10) / 100}s`;
+}

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/utils/checkForUpdates.d.ts

@@ -0,0 +1 @@
+export default function checkForUpdates(): void;

package/dist/src/utils/checkForUpdates.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const package_json_1 = __importDefault(require("../../package.json"));
+const environment_1 = require("../utils/environment");
+const chalk_1 = __importDefault(require("chalk"));
+const node_child_process_1 = require("node:child_process");
+function checkForUpdates() {
+    if (environment_1.currentEnvironment.isTest) {
+        return;
+    }
+    const currentVersion = package_json_1.default.version;
+    const latestVersion = (0, node_child_process_1.execSync)(`yarn info ${package_json_1.default.name} version`)
+        .toString()
+        .trim();
+    if (currentVersion !== latestVersion) {
+        console.warn(chalk_1.default.yellow(`⚠️ A new version of Conductor is available! You are using "${package_json_1.default.name}" version ${currentVersion} but the latest version is ${latestVersion}. Please run "yarn upgrade ${package_json_1.default.name} --latest" to update.`));
+    }
+}
+exports.default = checkForUpdates;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "7.4.11",
+  "version": "7.5.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/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"));

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

@@ -1,2 +0,0 @@
-export declare const CONDUCTOR_TEST_API_KEY = "063d95bc-a6f7-4b4b-841d-8007648a3112";
-export declare const CONDUCTOR_TEST_QBD_CONNECTION_ID = "49ee2e46-ec5a-40a0-8c37-43913994b2a9";

package/dist/src/utils/testConstants.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CONDUCTOR_TEST_QBD_CONNECTION_ID = exports.CONDUCTOR_TEST_API_KEY = void 0;
-exports.CONDUCTOR_TEST_API_KEY = "063d95bc-a6f7-4b4b-841d-8007648a3112";
-exports.CONDUCTOR_TEST_QBD_CONNECTION_ID = "49ee2e46-ec5a-40a0-8c37-43913994b2a9";