conductor-node 3.8.5 → 4.0.1

package/README.md

@@ -1,6 +1,6 @@
-# Conductor Node.js Library
+# Conductor - QuickBooks Desktop Integration
 
-The Conductor Node.js library provides convenient access to the Conductor API from applications written in server-side JavaScript.
+Execute _any_ read or write [QuickBooks Desktop API](https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop) through async TypeScript and receive a fully-typed response.
 
 ## Requirements
 
@@ -15,16 +15,17 @@ yarn add conductor-node
 
 ## Usage
 
-Instantiate `Conductor` with your account's secret key, which is available from Danny.
-
-The `Conductor` instance can execute _any_ read or write [QuickBooks Desktop API](https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop) through TypeScript and receive a fully-typed response. Each request requires the integration-user-connection id of a specific QuickBooks Desktop user.
-
 ```ts
 import Conductor from "conductor-node";
+
+// Instantiate `Conductor` with your account's secret key.
 const conductor = new Conductor("sk_test_...");
 
-const mockQbdUserConnectionId = "1";
-const newAccount = await conductor.qbd.account.add(mockQbdUserConnectionId, {
+// Fetch all authorized integration-user-connections.
+const qbdConnections = await client.getIntegrationUserConnections();
+
+// Execute any QBD API against your QBD connection id.
+const newAccount = await conductor.qbd.account.add(qbdConnections[0].id, {
   Name: "Test Account",
   AccountType: "Bank",
   OpenBalance: "100",

package/dist/package.json

@@ -1,7 +1,7 @@
 {
     "name": "conductor-node",
-    "version": "3.8.5",
-    "description": "Conductor API wrapper",
+    "version": "4.0.1",
+    "description": "Easily integrate with the entire QuickBooks Desktop API with fully-type async TypeScript",
     "author": "Danny Nemer <hi@DannyNemer.com>",
     "license": "MIT",
     "type": "commonjs",
@@ -24,6 +24,7 @@
         "tsc-alias": "^1.7.0"
     },
     "dependencies": {
+        "chalk": "^4",
         "graphql": "^16.6.0",
         "graphql-request": "^5.0.0"
     }

package/dist/src/Client.d.ts

@@ -1,9 +1,9 @@
 import type { Environment } from "./environment";
 import QbdIntegration from "./integrations/qbd/QbdIntegration";
 export interface ClientOptions {
-    /** Log the each request and response. */
+    /** Log each request and response. */
     verbose?: boolean;
-    environment?: Environment;
+    serverEnvironment?: Environment;
 }
 export interface IntegrationRequestParams {
     integrationUserConnectionId: string;
@@ -15,8 +15,9 @@ export default class Client {
     private readonly serverURL;
     private readonly gqlClient;
     private readonly verbose;
-    constructor(apiKey: string, { verbose, environment }?: ClientOptions);
-    integrationUserConnections(): Promise<object[]>;
+    constructor(apiKey: string, { verbose, serverEnvironment }?: ClientOptions);
+    getIntegrationUserConnection(integrationUserConnectionId: string): Promise<object>;
+    getIntegrationUserConnections(): Promise<object[]>;
     integrationRequest(integrationRequestParams: IntegrationRequestParams): Promise<object>;
     private request;
     private checkForUpdates;

package/dist/src/Client.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const package_json_1 = __importDefault(require("./../package.json"));
 const environment_1 = require("./environment");
 const QbdIntegration_1 = __importDefault(require("./integrations/qbd/QbdIntegration"));
+const chalk_1 = __importDefault(require("chalk"));
 const graphql_request_1 = require("graphql-request");
 const node_child_process_1 = require("node:child_process");
 class Client {
@@ -14,10 +15,10 @@ class Client {
     serverURL;
     gqlClient;
     verbose;
-    constructor(apiKey, { verbose = false, environment = "staging" } = {}) {
+    constructor(apiKey, { verbose = false, serverEnvironment = "staging" } = {}) {
         this.checkForUpdates();
         this.verbose = verbose;
-        this.serverURL = (0, environment_1.envToBaseServerURL)(environment);
+        this.serverURL = (0, environment_1.envToBaseServerURL)(serverEnvironment);
         this.gqlClient = new graphql_request_1.GraphQLClient(`${this.serverURL}/graphql`, {
             headers: {
                 Authorization: `Bearer ${apiKey}`,
@@ -26,7 +27,24 @@ class Client {
         });
         this.qbd = new QbdIntegration_1.default(this);
     }
-    async integrationUserConnections() {
+    async getIntegrationUserConnection(integrationUserConnectionId) {
+        const data = await this.request(`#graphql
+        query GetIntegrationUserConnection($integrationUserConnectionId: ID!) {
+          integrationUserConnection(id: $integrationUserConnectionId) {
+            id
+            integration {
+              id
+              name
+            }
+            qbwcUsername
+            lastHeartbeatAt
+          }
+        }
+      `, { integrationUserConnectionId });
+        // @ts-expect-error - This will pass after we integrate GQL codegen.
+        return data.integrationUserConnection;
+    }
+    async getIntegrationUserConnections() {
         const data = await this.request(`#graphql
         query {
           integrationUserConnections {
@@ -35,7 +53,8 @@ class Client {
               id
               name
             }
-            username
+            qbwcUsername
+            lastHeartbeatAt
           }
         }
       `);
@@ -45,34 +64,35 @@ class Client {
     // TODO: Hide this method from the dev user while still allowing the
     // integration clients to access it.
     async integrationRequest(integrationRequestParams) {
-        if (this.verbose) {
-            console.log(`Client sent request to ${this.serverURL}:`, JSON.stringify(integrationRequestParams, undefined, 2));
-            console.time("Request time");
-        }
         const response = await this.request(`#graphql
         query IntegrationRequest($integrationRequestParams: IntegrationRequestParams!) {
           integrationRequest(integrationRequestParams: $integrationRequestParams)
         }
       `, { integrationRequestParams });
         // @ts-expect-error - This will pass after we integrate GQL codegen.
-        const responseBody = response.integrationRequest;
+        return response.integrationRequest;
+    }
+    async request(gqlQuery, variables) {
         if (this.verbose) {
-            console.timeEnd("Request time");
-            console.log(`Client received response from ${this.serverURL}:`, JSON.stringify(responseBody, undefined, 2));
+            console.log(`Client sent request to ${this.serverURL}:`, JSON.stringify(gqlQuery, undefined, 2));
+            console.time("Request time");
         }
-        return responseBody;
-    }
-    async request(document, variables) {
         try {
-            return await this.gqlClient.request(document, variables);
+            const response = await this.gqlClient.request(gqlQuery, variables);
+            if (this.verbose) {
+                console.timeEnd("Request time");
+                console.log(`Client received response from ${this.serverURL}:`, JSON.stringify(response, undefined, 2));
+            }
+            return response;
         }
         catch (error) {
             if (this.verbose) {
+                console.timeEnd("Request time");
                 console.log(JSON.stringify(error, undefined, 2));
             }
             if (error instanceof graphql_request_1.ClientError) {
                 const errorMessage = error.response.errors?.[0]?.message ??
-                    // Though property `ClientError.response.error` does *not* exist,
+                    // Though the property `ClientError.response.error` does *not* exist,
                     // we've seen it occur (e.g., attempting to access `development`
                     // environment when `ngrok` is not running locally).
                     error.response["error"];
@@ -84,12 +104,15 @@ class Client {
         }
     }
     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(`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 add ${package_json_1.default.name}@latest" to update.`);
+            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 add ${package_json_1.default.name}@latest" to update.`));
         }
     }
 }

package/dist/src/environment.d.ts

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

package/dist/src/environment.js

@@ -1,15 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.envToBaseServerURL = void 0;
-const STAGING_BASE_URL = "https://staging.api.conductor.is";
-const DEVELOPMENT_BASE_URL = "https://conductor.ngrok.io";
+exports.currentEnvironment = exports.envToBaseServerURL = void 0;
 function envToBaseServerURL(environment) {
     switch (environment) {
+        case "development": {
+            return "https://conductor.ngrok.io";
+        }
         case "staging": {
-            return STAGING_BASE_URL;
+            return "https://staging.api.conductor.is";
         }
-        case "development": {
-            return DEVELOPMENT_BASE_URL;
+        case "production": {
+            return "https://production.api.conductor.is";
         }
         default: {
             throw new Error("Invalid environment");
@@ -17,3 +18,11 @@ function envToBaseServerURL(environment) {
     }
 }
 exports.envToBaseServerURL = envToBaseServerURL;
+const currentEnvironmentName = process.env["NODE_ENV"] ?? "development";
+exports.currentEnvironment = {
+    name: currentEnvironmentName,
+    isTest: currentEnvironmentName === "test",
+    isDevelopment: currentEnvironmentName === "development",
+    isStaging: currentEnvironmentName === "staging",
+    isProduction: currentEnvironmentName === "production",
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "conductor-node",
-  "version": "3.8.5",
-  "description": "Conductor API wrapper",
+  "version": "4.0.1",
+  "description": "Easily integrate with the entire QuickBooks Desktop API with fully-type async TypeScript",
   "author": "Danny Nemer <hi@DannyNemer.com>",
   "license": "MIT",
   "type": "commonjs",
@@ -24,6 +24,7 @@
     "tsc-alias": "^1.7.0"
   },
   "dependencies": {
+    "chalk": "^4",
     "graphql": "^16.6.0",
     "graphql-request": "^5.0.0"
   }