conductor-node 3.0.1 → 3.1.0

package/README.md

@@ -17,14 +17,14 @@ yarn add conductor-node
 
 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 user-id of a specific QuickBooks Desktop user.
+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";
 const conductor = new Conductor("sk_test_...");
 
-const mockQBDUserId = "1";
-const newAccount = await conductor.qbd.account.add(mockQBDUserId, {
+const mockQbdUserConnectionId = "1";
+const newAccount = await conductor.qbd.account.add(mockQbdUserConnectionId, {
   Name: "Test Account",
   AccountType: "Bank",
   OpenBalance: "100",

package/dist/src/BaseClient.d.ts

@@ -1,16 +1,5 @@
-import type { Environment } from "./environment";
-export interface BaseClientOptions {
-    verbose?: boolean;
-    environment?: Environment;
-}
-export interface RequestParams {
-    integrationUserConnectionId: string;
-    requestObj: object;
-}
+import type Client from "./Client";
 export default class BaseClient {
-    protected readonly apiKey: string;
-    protected readonly verbose: boolean;
-    protected readonly serverURL: string;
-    constructor(apiKey: string, { verbose, environment }: BaseClientOptions);
-    protected sendAPIRequest(apiPath: string, requestParams: RequestParams): Promise<object>;
+    protected readonly root: Client;
+    constructor(client: Client);
 }

package/dist/src/BaseClient.js

@@ -1,43 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const environment_1 = require("./environment");
-// 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 = "staging" }) {
-        this.apiKey = apiKey;
-        this.verbose = verbose;
-        this.serverURL = (0, environment_1.envToBaseServerURL)(environment);
-    }
-    async sendAPIRequest(apiPath, requestParams) {
-        const apiServerURL = `${this.serverURL}/${apiPath}`;
-        if (this.verbose) {
-            console.log(`Client sent request to ${apiServerURL} for ${apiPath} user ${requestParams.integrationUserConnectionId}:`, JSON.stringify(requestParams.requestObj, null, 2));
-        }
-        const response = await fetch(apiServerURL, {
-            body: JSON.stringify(requestParams),
-            headers: {
-                "Content-Type": "application/json",
-                Authorization: `Bearer ${this.apiKey}`,
-            },
-            method: "POST",
-        });
-        if (response.status >= 400) {
-            const errorMessage = (await response.text()) || response.statusText;
-            throw new Error(`Request to ${apiServerURL} failed with status ${response.status}: ${errorMessage}`);
-        }
-        const responseObj = (await response.json());
-        if (this.verbose) {
-            console.log(`Client received response for ${apiPath} user ${requestParams.integrationUserConnectionId}:`, JSON.stringify(responseObj, null, 2));
-        }
-        return responseObj;
+    root;
+    constructor(client) {
+        this.root = client;
     }
 }
 exports.default = BaseClient;

package/dist/src/Client.d.ts

@@ -1,7 +1,21 @@
-import type { BaseClientOptions } from "./BaseClient";
+import type { Environment } from "./environment";
 import ClientQbd from "./qbd/ClientQbd";
+export interface ClientOptions {
+    /** Log the each request and response. */
+    verbose?: boolean;
+    environment?: Environment;
+}
+export interface IntegrationRequestParams {
+    integrationUserConnectionId: string;
+    requestObject: object;
+}
 export default class Client {
     /** QuickBooks Desktop integration. */
     readonly qbd: ClientQbd;
-    constructor(apiKey: string, options?: BaseClientOptions);
+    private readonly serverURL;
+    private readonly gqlClient;
+    private readonly verbose;
+    constructor(apiKey: string, { verbose, environment }?: ClientOptions);
+    integrationUserConnections(): Promise<object[]>;
+    integrationRequest(integrationRequestParams: IntegrationRequestParams): Promise<object>;
 }

package/dist/src/Client.js

@@ -3,12 +3,60 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const environment_1 = require("./environment");
 const ClientQbd_1 = __importDefault(require("./qbd/ClientQbd"));
+const graphql_request_1 = require("graphql-request");
 class Client {
     /** QuickBooks Desktop integration. */
     qbd;
-    constructor(apiKey, options = {}) {
-        this.qbd = new ClientQbd_1.default(apiKey, options);
+    serverURL;
+    gqlClient;
+    verbose;
+    constructor(apiKey, { verbose = false, environment = "staging" } = {}) {
+        this.verbose = verbose;
+        this.serverURL = (0, environment_1.envToBaseServerURL)(environment);
+        this.gqlClient = new graphql_request_1.GraphQLClient(`${this.serverURL}/graphql`, {
+            headers: {
+                authorization: `Bearer ${apiKey}`,
+            },
+        });
+        this.qbd = new ClientQbd_1.default(this);
+    }
+    async integrationUserConnections() {
+        const data = await this.gqlClient.request(`#graphql
+        query {
+          integrationUserConnections {
+            id
+            integration {
+              id
+              name
+            }
+            username
+          }
+        }
+      `);
+        // @ts-expect-error - This will pass after we integrate GQL codegen.
+        return data.integrationUserConnections;
+    }
+    // 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, null, 2));
+            console.time("Request time");
+        }
+        const response = await this.gqlClient.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;
+        if (this.verbose) {
+            console.timeEnd("Request time");
+            console.log(`Client received response from ${this.serverURL}:`, JSON.stringify(responseBody, null, 2));
+        }
+        return responseBody;
     }
 }
 exports.default = Client;

package/dist/src/qbd/ClientQbd.d.ts

@@ -247,6 +247,6 @@ export default class ClientQbd extends BaseClient {
      * Available APIs:
      * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop
      */
-    sendRequest(integrationUserConnectionId: string, requestObj: object): Promise<object>;
+    sendRequest(integrationUserConnectionId: string, requestObject: object): Promise<object>;
     private sendRequestBase;
 }

package/dist/src/qbd/ClientQbd.js

@@ -251,10 +251,10 @@ class ClientQbd extends BaseClient_1.default {
      * Available APIs:
      * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop
      */
-    async sendRequest(integrationUserConnectionId, requestObj) {
-        return this.sendAPIRequest("qbd", {
+    async sendRequest(integrationUserConnectionId, requestObject) {
+        return this.root.integrationRequest({
             integrationUserConnectionId,
-            requestObj,
+            requestObject,
         });
     }
     async sendRequestBase(integrationUserConnectionId, params, responseKey, responseBodyKey) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "Conductor API wrapper",
   "author": "Danny Nemer <hi@DannyNemer.com>",
   "license": "MIT",
@@ -12,9 +12,14 @@
   ],
   "scripts": {
     "prepack": "yarn tsc && yarn tsc-alias",
-    "postpack": "rm -rf dist"
+    "postpack": "rm -rf dist",
+    "test-staging": "yarn ts-node ./test/sendMockRequest"
   },
   "devDependencies": {
     "tsc-alias": "^1.7.0"
+  },
+  "dependencies": {
+    "graphql": "^16.6.0",
+    "graphql-request": "^5.0.0"
   }
 }