conductor-node 11.3.2 → 11.4.1

package/README.md

@@ -41,7 +41,7 @@ Conductor, the company, is building a data integration platform for vertical Saa
 
 ## Requirements
 
-1. A Conductor API key pair: one secret key, one publishable key. Please [complete this form](https://73a5v9t55ed.typeform.com/to/VRX7rfrN) to join the beta.
+1. A Conductor API key pair: one secret key, one publishable key. Please [complete this form](https://forms.gle/1LTGXy2Hcyzw6qWa6) to join the beta.
 2. Node.js v16 or later.
 
 ## Installation

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "11.3.2",
+    "version": "11.4.1",
     "description": "QuickBooks Desktop API for Node.js and TypeScript",
     "keywords": [
         "QuickBooks",
@@ -12,6 +12,7 @@
         "QB Desktop",
         "QB Enterprise",
         "QBD",
+        "QBDT",
         "QBE",
         "Intuit"
     ],

package/dist/src/Client.js

@@ -30,11 +30,11 @@ class Client {
         this.qbd = new QbdIntegration_1.default(this.httpClient);
     }
     createHttpClient(apiKey, verbose) {
-        // Use an environment variable for overriding the server URL for testing and
-        // development instead of checking `NODE_ENV` to allow `conductor-node`
-        // users to use the production API server when their `NODE_ENV` is set to
-        // "development".
-        const apiServerUrl = process.env["CONDUCTOR__MOCK_API_SERVER_URL"] ??
+        // We use an environment variable for overriding the server URL for testing
+        // and development instead of checking `NODE_ENV` to ensure `conductor-node`
+        // users use the production API server when their `NODE_ENV` is set to
+        // "development". Only Conductor team members can use the mock API server.
+        const apiServerUrl = process.env["CONDUCTOR_MOCK_API_SERVER_URL"] ??
             "https://api.conductor.is";
         const httpClient = axios_1.default.create({
             baseURL: `${apiServerUrl}/v1`,

package/dist/src/integrations/qbd/QbdIntegration.d.ts

@@ -423,7 +423,7 @@ export default class QbdIntegration extends BaseIntegration {
         add: (endUserId: string, params: QbdTypes.CheckAddRq["CheckAdd"]) => Promise<NonNullable<QbdTypes.CheckAddRs["CheckRet"]>>;
         /**
          * Modifies an existing Check. Notice that you cannot use this to modify
-         * BillPaymentChecks.
+         * `BillPaymentChecks`.
          *
          * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CheckMod
          */
@@ -993,7 +993,7 @@ export default class QbdIntegration extends BaseIntegration {
          * If you Add an invoice that has an inventory item on it, QB will
          * automatically calculate COGS and post it to the COGS account. (The
          * inventory item will need to be setup to post to the COGS account and must
-         * have a unit cost in it.) However, notice that such an InvoiceAdd has
+         * have a unit cost in it.) However, notice that such an `InvoiceAdd` has
          * sales prices, not cost, so the Add is not impacting the cost of the item.
          * The cost of the item is only affected by purchases (bills and item
          * receipts) sales and inventory adjustments.
@@ -1583,8 +1583,9 @@ export default class QbdIntegration extends BaseIntegration {
          * In a `TimeTracking` message, `ItemServiceRef` refers to the type of work.
          * If no `CustomerRef` is specified, then `ItemServiceRef` is not needed. If
          * `IsBillable` is set to true, then `TimeTrackingAdd` must include both
-         * `ItemServiceRef` and `CustomerRef`. See more:
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceAdd
+         * `ItemServiceRef` and `CustomerRef`.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceAdd
          */
         add: (endUserId: string, params: QbdTypes.ItemServiceAddRq["ItemServiceAdd"]) => Promise<NonNullable<QbdTypes.ItemServiceAddRs["ItemServiceRet"]>>;
         /**
@@ -1819,9 +1820,7 @@ export default class QbdIntegration extends BaseIntegration {
          *   QuickBooks Payroll Info window that provides detailed employee
          *   information employee.
          *
-         *
-         * See more:
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PayrollItemWageAdd
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PayrollItemWageAdd
          */
         add: (endUserId: string, params: QbdTypes.PayrollItemWageAddRq["PayrollItemWageAdd"]) => Promise<NonNullable<QbdTypes.PayrollItemWageAddRs["PayrollItemWageRet"]>>;
         /**
@@ -2457,14 +2456,23 @@ export default class QbdIntegration extends BaseIntegration {
      */
     timeTracking: {
         /**
-         * The time-tracking transactions that are returned in this query include
-         * time tracking information that was entered into QuickBooks manually or
-         * gathered using the QuickBooks “Timer” or “Stopwatch.” Note that the
-         * QuickBooks Timer application can run on its own without QuickBooks, but
-         * the QuickBooks SDK cannot access the Timer data directly. The Timer data
-         * must be imported into QuickBooks before it is accessible via the SDK.)
+         * This request adds a time tracking transaction to QuickBooks, mirroring
+         * the time-tracking feature available in the QuickBooks UI. The time
+         * tracking feature allows a QuickBooks user to base payroll or invoices on
+         * time worked. You can add time-tracking information to any vendor,
+         * employee, or person on the Other Names list in QuickBooks.
+         *
+         * If `IsBillable` is set to true, both `CustomerRef` and `ItemServiceRef`
+         * are required. There is no link between an invoice and the time entries.
+         * However, when you do the invoicing from QuickBooks, QuickBooks does mark
+         * the time entries as “billed.” If you don’t record the time entries as
+         * billed properly, then you get into a user workflow issue where every time
+         * the user creates an invoice for a customer, QB pops up a dialog asking if
+         * they want to bill the un-billed time (which you already billed from your
+         * app).
          *
-         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeTrackingQuery
+         * See more:
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeTrackingAdd
          */
         add: (endUserId: string, params: QbdTypes.TimeTrackingAddRq["TimeTrackingAdd"]) => Promise<NonNullable<QbdTypes.TimeTrackingAddRs["TimeTrackingRet"]>>;
         /**

package/dist/src/integrations/qbd/QbdIntegration.js

@@ -428,7 +428,7 @@ class QbdIntegration extends BaseIntegration_1.default {
         add: async (endUserId, params) => this.sendRequestWrapper(endUserId, { CheckAddRq: { CheckAdd: params } }, "CheckAddRs", "CheckRet"),
         /**
          * Modifies an existing Check. Notice that you cannot use this to modify
-         * BillPaymentChecks.
+         * `BillPaymentChecks`.
          *
          * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CheckMod
          */
@@ -998,7 +998,7 @@ class QbdIntegration extends BaseIntegration_1.default {
          * If you Add an invoice that has an inventory item on it, QB will
          * automatically calculate COGS and post it to the COGS account. (The
          * inventory item will need to be setup to post to the COGS account and must
-         * have a unit cost in it.) However, notice that such an InvoiceAdd has
+         * have a unit cost in it.) However, notice that such an `InvoiceAdd` has
          * sales prices, not cost, so the Add is not impacting the cost of the item.
          * The cost of the item is only affected by purchases (bills and item
          * receipts) sales and inventory adjustments.
@@ -1588,8 +1588,9 @@ class QbdIntegration extends BaseIntegration_1.default {
          * In a `TimeTracking` message, `ItemServiceRef` refers to the type of work.
          * If no `CustomerRef` is specified, then `ItemServiceRef` is not needed. If
          * `IsBillable` is set to true, then `TimeTrackingAdd` must include both
-         * `ItemServiceRef` and `CustomerRef`. See more:
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceAdd
+         * `ItemServiceRef` and `CustomerRef`.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceAdd
          */
         add: async (endUserId, params) => this.sendRequestWrapper(endUserId, { ItemServiceAddRq: { ItemServiceAdd: params } }, "ItemServiceAddRs", "ItemServiceRet"),
         /**
@@ -1824,9 +1825,7 @@ class QbdIntegration extends BaseIntegration_1.default {
          *   QuickBooks Payroll Info window that provides detailed employee
          *   information employee.
          *
-         *
-         * See more:
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PayrollItemWageAdd
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PayrollItemWageAdd
          */
         add: async (endUserId, params) => this.sendRequestWrapper(endUserId, { PayrollItemWageAddRq: { PayrollItemWageAdd: params } }, "PayrollItemWageAddRs", "PayrollItemWageRet"),
         /**
@@ -2462,14 +2461,23 @@ class QbdIntegration extends BaseIntegration_1.default {
      */
     timeTracking = {
         /**
-         * The time-tracking transactions that are returned in this query include
-         * time tracking information that was entered into QuickBooks manually or
-         * gathered using the QuickBooks “Timer” or “Stopwatch.” Note that the
-         * QuickBooks Timer application can run on its own without QuickBooks, but
-         * the QuickBooks SDK cannot access the Timer data directly. The Timer data
-         * must be imported into QuickBooks before it is accessible via the SDK.)
+         * This request adds a time tracking transaction to QuickBooks, mirroring
+         * the time-tracking feature available in the QuickBooks UI. The time
+         * tracking feature allows a QuickBooks user to base payroll or invoices on
+         * time worked. You can add time-tracking information to any vendor,
+         * employee, or person on the Other Names list in QuickBooks.
+         *
+         * If `IsBillable` is set to true, both `CustomerRef` and `ItemServiceRef`
+         * are required. There is no link between an invoice and the time entries.
+         * However, when you do the invoicing from QuickBooks, QuickBooks does mark
+         * the time entries as “billed.” If you don’t record the time entries as
+         * billed properly, then you get into a user workflow issue where every time
+         * the user creates an invoice for a customer, QB pops up a dialog asking if
+         * they want to bill the un-billed time (which you already billed from your
+         * app).
          *
-         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeTrackingQuery
+         * See more:
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeTrackingAdd
          */
         add: async (endUserId, params) => this.sendRequestWrapper(endUserId, { TimeTrackingAddRq: { TimeTrackingAdd: params } }, "TimeTrackingAddRs", "TimeTrackingRet"),
         /**

package/dist/src/utils/checkForUpdates.js

@@ -5,11 +5,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createFramedMessage = exports.checkForUpdates = void 0;
 const package_json_1 = __importDefault(require("../../package.json"));
+const env_1 = require("../utils/env");
 const node_child_process_1 = __importDefault(require("node:child_process"));
 function checkForUpdates() {
     if (process.env.NODE_ENV === "test") {
         return;
     }
+    // `CONDUCTOR_HIDE_UPDATE_MESSAGE` hides the update message that is logged
+    // when a newer version of `conductor-node` is available. It's a truthy value.
+    if ((0, env_1.isEnvironmentVariableTruthy)("CONDUCTOR_HIDE_UPDATE_MESSAGE")) {
+        return;
+    }
     // Exit early if npm is not installed.
     try {
         node_child_process_1.default.execSync("which npm");
@@ -27,26 +33,28 @@ function checkForUpdates() {
             ? "yarn add"
             : "npm install";
         console.warn(createFramedMessage([
-            "🟡 UPDATE AVAILABLE for Conductor!",
-            `Current Version: ${currentVersion}`,
-            `Latest Version: ${latestVersion}`,
-            `To update, run: ${updateCommand} ${package_json_1.default.name}@latest`,
+            `🟡 Update available for Conductor! ${currentVersion} → ${latestVersion}`,
+            "",
+            "Run the following to update:",
+            `  ${updateCommand} ${package_json_1.default.name}@latest`,
         ]));
     }
 }
 exports.checkForUpdates = checkForUpdates;
 function createFramedMessage(messageLines) {
     const maxLength = Math.max(...messageLines.map((line) => line.length), 0);
+    const paddingHorizontalLength = 2;
     return [
         // Top border of the box.
-        `┌${"─".repeat(maxLength + 2)}┐`,
+        `┌${"─".repeat(maxLength + paddingHorizontalLength * 2)}┐`,
         // Print each line of the message, padded to fit the box.
         ...messageLines.map((line) => {
-            const padding = " ".repeat(maxLength - line.length);
-            return `│ ${line}${padding} │`;
+            const paddingLine = " ".repeat(maxLength - line.length);
+            const paddingHorizontal = " ".repeat(paddingHorizontalLength);
+            return `│${paddingHorizontal}${line}${paddingLine}${paddingHorizontal}│`;
         }),
         // Bottom border of the box.
-        `└${"─".repeat(maxLength + 2)}┘`,
+        `└${"─".repeat(maxLength + paddingHorizontalLength * 2)}┘`,
     ].join("\n");
 }
 exports.createFramedMessage = createFramedMessage;

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

@@ -0,0 +1 @@
+export declare function isEnvironmentVariableTruthy(name: string): boolean;

package/dist/src/utils/env.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isEnvironmentVariableTruthy = void 0;
+const FALSY_VALUES = new Set([
+    undefined,
+    "",
+    "null",
+    "undefined",
+    "false",
+    "0",
+]);
+function isEnvironmentVariableTruthy(name) {
+    const value = process.env[name]?.toLowerCase();
+    return !FALSY_VALUES.has(value);
+}
+exports.isEnvironmentVariableTruthy = isEnvironmentVariableTruthy;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "11.3.2",
+  "version": "11.4.1",
   "description": "QuickBooks Desktop API for Node.js and TypeScript",
   "keywords": [
     "QuickBooks",
@@ -12,6 +12,7 @@
     "QB Desktop",
     "QB Enterprise",
     "QBD",
+    "QBDT",
     "QBE",
     "Intuit"
   ],