conductor-node 7.0.1 → 7.1.0

package/README.md

@@ -36,10 +36,40 @@ const newAccount = await conductor.qbd.account.add(qbdConnections[0].id, {
 
 ### `createIntegrationConnection(input: CreateIntegrationConnectionInput)`
 
-**🚧 Coming soon!**
-
 Create a new integration-connection.
 
+```ts
+const newQbdConnection = await conductor.createIntegrationConnection({
+  integrationKey: "quickbooks-desktop",
+  endUserEmail: "danny@constructionco.com",
+  endUserName: "Construction Corp.",
+});
+```
+
+The response includes the following:
+
+```ts
+{
+  // ❗ Show this URL to your end-user: The URL for the QWC config file
+  // that your end-user must download and open on their computer to connect
+  //  their QBD instance to Conductor.
+  qwcFileDownloadUrl: 'https://production.api.conductor.is/qwc/c1598ccf-0f84-4ac0-8703-f1b7260d59bf'
+  // ❗ Show this password/access-code to your end-user: The unique password
+  // that your end-user must enter into QuickBooks Web Connector after
+  // loading the config file. This value will never be shown again.
+  qbwcPassword: 'D+HaxP3p@@',
+  integrationConnection: {
+    // ❗ The `id` to save to you database to execute issue requests to
+    // this end-user's integration in the future.
+    id: 'c1598ccf-0f84-4ac0-8703-f1b7260d59bf',
+    integrationKey: 'quickbooks-desktop',
+    endUserEmail: 'danny@constructionco.com',
+    endUserName: 'Construction Corp.',
+    lastHeartbeatAt: null
+  }
+}
+```
+
 ### `qbd.*`
 
 Execute any QuickBooks Desktop (QBD) API against a specific integration-connection id. See the official [QuickBooks Desktop API Reference](https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop) for a full list of available APIs.

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "7.0.1",
+    "version": "7.1.0",
     "description": "Easily integrate with the entire QuickBooks Desktop API with fully-typed async TypeScript",
     "author": "Danny Nemer <hi@DannyNemer.com>",
     "license": "MIT",
@@ -16,7 +16,8 @@
         "delete-compiled-tests": "rm -rf `find ./dist -type d -name __tests__`",
         "postpack": "rm -rf dist",
         "clean": "rm -rf dist package conductor-node-*.tgz tsconfig.tsbuildinfo",
-        "gen:graphql-types": "yarn graphql-codegen --config ./src/graphql/codegenConfig.ts"
+        "gen:graphql-types": "yarn graphql-codegen --config ./src/graphql/codegenConfig.ts",
+        "test-connections": "yarn ts-node ./bin/testConnections.ts"
     },
     "engines": {
         "node": ">=16"

package/dist/src/Client.d.ts

@@ -28,7 +28,9 @@ export default class Client {
      * @param input.endUserName Your end-user's name.
      * @returns The newly created integration connection.
      */
-    createIntegrationConnection(input: GraphqlCreateIntegrationConnectionInput): Promise<GraphqlCreateIntegrationConnectionMutation["createIntegrationConnection"]>;
+    createIntegrationConnection(input: GraphqlCreateIntegrationConnectionInput & {
+        integrationKey: "quickbooks-desktop";
+    }): Promise<GraphqlCreateIntegrationConnectionMutation["createIntegrationConnection"]>;
     isIntegrationConnectionActive(integrationConnectionId: GraphqlIsIntegrationConnectionActiveQueryVariables["integrationConnectionId"], secondsSinceLastActive?: GraphqlIsIntegrationConnectionActiveQueryVariables["secondsSinceLastActive"]): Promise<GraphqlIsIntegrationConnectionActiveQuery["integrationConnection"]["isActive"]>;
     integrationRequest(input: GraphqlIntegrationRequestInput): Promise<GraphqlIntegrationRequestQuery["integrationRequest"]>;
     graphqlOperationWrapper<V, R>(operationName: string, variables: V, operation: (variables: V) => Promise<R>): Promise<R>;

package/dist/src/Client.js

@@ -10,6 +10,7 @@ const QbdIntegration_1 = __importDefault(require("./integrations/qbd/QbdIntegrat
 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;
@@ -80,14 +81,14 @@ class Client {
     }
     async graphqlOperationWrapper(operationName, variables, operation) {
         if (this.verbose) {
-            console.log(`Client sent request to ${this.serverURL}:`, operationName, JSON.stringify(variables, undefined, 2));
+            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}:`, JSON.stringify(result, undefined, 2));
+                console.log(`Client received response from ${this.serverURL}:`, node_util_1.default.inspect(result, { depth: undefined, colors: true }));
             }
             return result;
         }

package/dist/src/environment.d.ts

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

package/dist/src/environment.js

@@ -1,8 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.currentEnvironment = exports.getServerUrlForEnvironment = void 0;
+exports.getServerUrlForEnvironment = exports.currentEnvironment = void 0;
+const currentEnvironmentName = process.env["NODE_ENV"] ?? "development";
+exports.currentEnvironment = {
+    name: currentEnvironmentName,
+    isTest: currentEnvironmentName === "test",
+    isDevelopment: currentEnvironmentName === "development",
+    isStaging: currentEnvironmentName === "staging",
+    isProduction: currentEnvironmentName === "production",
+};
 function getServerUrlForEnvironment(environment) {
     switch (environment) {
+        case "test": {
+            // DOES NOT EXIST.
+            return "https://test.api.conductor.is";
+        }
         case "development": {
             return "https://conductor.ngrok.io";
         }
@@ -13,16 +25,8 @@ function getServerUrlForEnvironment(environment) {
             return "https://production.api.conductor.is";
         }
         default: {
-            throw new Error("Invalid environment");
+            throw new Error(`Invalid environment`);
         }
     }
 }
 exports.getServerUrlForEnvironment = getServerUrlForEnvironment;
-const currentEnvironmentName = process.env["NODE_ENV"] ?? "development";
-exports.currentEnvironment = {
-    name: currentEnvironmentName,
-    isTest: currentEnvironmentName === "test",
-    isDevelopment: currentEnvironmentName === "development",
-    isStaging: currentEnvironmentName === "staging",
-    isProduction: currentEnvironmentName === "production",
-};

package/dist/src/graphql/__generated__/operationTypes.d.ts

@@ -31,6 +31,7 @@ export declare type GraphqlCreateIntegrationConnectionInput = {
 export declare type GraphqlCreateIntegrationConnectionResult = {
     integrationConnection: GraphqlIntegrationConnection;
     qbwcPassword: Scalars["String"];
+    qwcFileDownloadUrl: Scalars["String"];
 };
 export declare type GraphqlIntegration = {
     id: Scalars["ID"];
@@ -109,6 +110,7 @@ export declare type GraphqlCreateIntegrationConnectionMutationVariables = Exact<
 export declare type GraphqlCreateIntegrationConnectionMutation = {
     createIntegrationConnection: {
         qbwcPassword: string;
+        qwcFileDownloadUrl: string;
         integrationConnection: {
             id: string;
             integrationKey: string;

package/dist/src/graphql/__generated__/operationTypes.js

@@ -31,6 +31,7 @@ exports.CreateIntegrationConnectionDocument = `
       ...IntegrationConnection
     }
     qbwcPassword
+    qwcFileDownloadUrl
   }
 }
     ${exports.IntegrationConnectionFragmentDoc}`;

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

@@ -0,0 +1,2 @@
+export declare const MITER_API_KEY = "sk_test_miter";
+export declare const TEST_QBD_CONNECTION_ID = "a826e788-deaa-4e2a-bb6a-2165f841b159";

package/dist/src/utils/testing.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TEST_QBD_CONNECTION_ID = exports.MITER_API_KEY = void 0;
+exports.MITER_API_KEY = "sk_test_miter";
+exports.TEST_QBD_CONNECTION_ID = "a826e788-deaa-4e2a-bb6a-2165f841b159";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "7.0.1",
+  "version": "7.1.0",
   "description": "Easily integrate with the entire QuickBooks Desktop API with fully-typed async TypeScript",
   "author": "Danny Nemer <hi@DannyNemer.com>",
   "license": "MIT",
@@ -16,7 +16,8 @@
     "delete-compiled-tests": "rm -rf `find ./dist -type d -name __tests__`",
     "postpack": "rm -rf dist",
     "clean": "rm -rf dist package conductor-node-*.tgz tsconfig.tsbuildinfo",
-    "gen:graphql-types": "yarn graphql-codegen --config ./src/graphql/codegenConfig.ts"
+    "gen:graphql-types": "yarn graphql-codegen --config ./src/graphql/codegenConfig.ts",
+    "test-connections": "yarn ts-node ./bin/testConnections.ts"
   },
   "engines": {
     "node": ">=16"

package/dist/src/testUtils.d.ts

@@ -1,2 +0,0 @@
-export declare const TEST_CLIENT_API_KEY = "sk_test_miter";
-export declare const TEST_QBD_CONNECTION_ID = "test_qbd_connection_id";

package/dist/src/testUtils.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TEST_QBD_CONNECTION_ID = exports.TEST_CLIENT_API_KEY = void 0;
-exports.TEST_CLIENT_API_KEY = "sk_test_miter";
-exports.TEST_QBD_CONNECTION_ID = "test_qbd_connection_id";