conductor-node 0.0.14 → 0.0.17

package/README.md

@@ -23,7 +23,7 @@ To send a request to a specific QuickBooks Desktop user, you must also supply th
 
 ```ts
 import Conductor from "conductor-node";
-const conductor = new Conductor("sk_test_...");
+const conductor = new Conductor({ apiKey: "sk_test_..." });
 
 conductor.qbd
   .accountAdd("mock_qbwc_username", {

package/dist/src/BaseClient.d.ts

@@ -0,0 +1,11 @@
+export interface BaseClientOptions {
+    apiKey: string;
+    verbose?: boolean;
+    environment?: "development" | "staging";
+}
+export default class BaseClient {
+    protected readonly apiKey: string;
+    protected readonly verbose: boolean;
+    protected readonly serverURL: string;
+    constructor({ apiKey, verbose, environment, }: BaseClientOptions);
+}

package/dist/src/BaseClient.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Store properties via superclass `BaseClient` instead of on `Client` passed to
+// the integration clients (e.g., `ClientQBD`) to hide these properties from the
+// dev user while still allowing the integration clients to access them.
+//
+// Downside: These values are stored in each subclass instead of sharing a
+// single store (e.g., `Client`).
+class BaseClient {
+    apiKey;
+    verbose;
+    serverURL;
+    constructor({ apiKey, verbose = false, environment = "development", }) {
+        this.apiKey = apiKey;
+        this.verbose = verbose;
+        if (environment === "development") {
+            this.serverURL = "https://conductor.ngrok.io";
+        }
+        else {
+            throw new Error(`Unsupported environment: ${environment}`);
+        }
+    }
+}
+exports.default = BaseClient;

package/dist/{Client.d.ts → src/Client.d.ts}

@@ -1,6 +1,7 @@
+import type { BaseClientOptions } from "./BaseClient";
 import ClientQBD from "./qb/ClientQBD";
 export default class Client {
     /** QuickBooks Desktop integration. */
     readonly qbd: ClientQBD;
-    constructor(apiKey: string, verbose?: boolean, environment?: string);
+    constructor(options: BaseClientOptions);
 }

package/dist/{Client.js → src/Client.js}

@@ -7,11 +7,8 @@ const ClientQBD_1 = __importDefault(require("./qb/ClientQBD"));
 class Client {
     /** QuickBooks Desktop integration. */
     qbd;
-    constructor(apiKey, verbose = false, environment = "development") {
-        // Do not assign the passed parameters to the root `Client` to avoid
-        // exposing them as properties to the user and mixing them with the
-        // integrations, like `qbd`.
-        this.qbd = new ClientQBD_1.default(apiKey, verbose, environment);
+    constructor(options) {
+        this.qbd = new ClientQBD_1.default(options);
     }
 }
 exports.default = Client;

package/dist/{qb → src/qb}/ClientQBD.d.ts

@@ -1,18 +1,18 @@
+import BaseClient from "../BaseClient";
 import type { AccountAdd, AccountQueryRq, AccountRet } from "../qb/qbXMLTypes/Account";
 import type { CustomerQueryRq, CustomerRet } from "../qb/qbXMLTypes/Customer";
 import type { EmployeeAdd, EmployeeMod, EmployeeQueryRq, EmployeeRet } from "../qb/qbXMLTypes/Employee";
 import type { VendorQueryRq, VendorRet } from "../qb/qbXMLTypes/Vendor";
-export default class ClientQBD {
-    private readonly apiKey;
-    private readonly verbose;
-    private readonly serverURL;
-    constructor(apiKey: string, verbose: boolean, environment: string);
+export interface QBXMLObj {
+    [apiName: string]: object;
+}
+export default class ClientQBD extends BaseClient {
     /**
      * Send any QBXML request to QuickBooks Desktop.
      *
      * Available APIs: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop
      */
-    sendRequest(qbwcUsername: string, requestObj: object): Promise<object>;
+    sendRequest(qbwcUsername: string, requestObj: QBXMLObj): Promise<QBXMLObj>;
     /**
      * Perform the same activities as a user does in the QB New Account form,
      * which can be accessed in QB by selecting "Lists" → "Chart of Accounts" →

package/dist/{qb → src/qb}/ClientQBD.js

@@ -1,19 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-class ClientQBD {
-    apiKey;
-    verbose;
-    serverURL;
-    constructor(apiKey, verbose, environment) {
-        this.apiKey = apiKey;
-        this.verbose = verbose;
-        if (environment === "development") {
-            this.serverURL = "https://conductor.ngrok.io";
-        }
-        else {
-            throw new Error(`Unsupported environment: ${environment}`);
-        }
-    }
+const BaseClient_1 = __importDefault(require("../BaseClient"));
+class ClientQBD extends BaseClient_1.default {
     /**
      * Send any QBXML request to QuickBooks Desktop.
      *

package/dist/{qb → src/qb}/qbXMLTypes/Employee.d.ts

@@ -282,19 +282,20 @@ interface EmployeeAddress {
      */
     City?: string;
     /**
-     * When it appears in the EmployeeAddress aggregate, the State element acts
+     * When it appears in the `EmployeeAddress` aggregate, the State element acts
      * like an `ENUMTYPE` with the following possible values: None, AA (military),
      * AE (military), AK, AL, AP (military), AR, AZ, CA, CO, CT, DC, DE, FL, GA,
      * HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE,
      * NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, RI, SC, SD, TN, TX, UT, VA, VT, WA,
      * WI, WV, and WY.
      */
-    State?: string;
+    State?: State;
     /**
      * The postal code in an address.
      */
     PostalCode?: string;
 }
+declare type State = "AA" | "AE" | "AK" | "AL" | "AP" | "AR" | "AZ" | "CA" | "CO" | "CT" | "DC" | "DE" | "FL" | "GA" | "HI" | "IA" | "ID" | "IL" | "IN" | "KS" | "KY" | "LA" | "MA" | "MD" | "ME" | "MI" | "MN" | "MO" | "MS" | "MT" | "NC" | "ND" | "NE" | "NH" | "NJ" | "NM" | "None" | "NV" | "NY" | "OH" | "OK" | "OR" | "PA" | "PR" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VA" | "VT" | "WA" | "WI" | "WV" | "WY";
 interface EmergencyContacts {
     PrimaryContact?: {
         ContactName: string;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "conductor-node",
-  "version": "0.0.14",
+  "version": "0.0.17",
   "description": "Conductor API wrapper",
   "author": "Danny Nemer <hi@DannyNemer.com>",
   "license": "MIT",
-  "main": "dist/Client.js",
-  "types": "dist/Client.d.ts",
+  "main": "dist/src/Client.js",
+  "types": "dist/src/Client.d.ts",
   "files": [
-    "dist/**/*.[jt]s"
+    "dist/src/**/*.[jt]s"
   ],
   "scripts": {
     "prepack": "yarn tsc && yarn tsc-alias",