conductor-node 4.1.10 → 6.1.0

package/README.md

@@ -31,3 +31,53 @@ const newAccount = await conductor.qbd.account.add(qbdConnections[0].id, {
   OpenBalance: "100",
 });
 ```
+
+## `Conductor` APIs
+
+### `getIntegrationConnections()`
+
+Fetch all authorized integration-connections.
+
+```ts
+const qbdConnections = await conductor.getIntegrationConnections();
+```
+
+### `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.
+
+```ts
+const newAccount = await conductor.qbd.account.add(qbdConnections[0].id, {
+  Name: "Test Account",
+  AccountType: "Bank",
+  OpenBalance: "100",
+});
+```
+
+### `getIntegrationConnectionById(id: string)`
+
+Fetch a single integration connection by id.
+
+```ts
+const connection = await conductor.getIntegrationConnectionById(
+  qbdConnections[0].id
+);
+```
+
+### `isIntegrationConnectionActive(id: string, secondsSinceLastHeartbeat: number = 10)`
+
+Check if an integration connection is active within the last `secondsSinceLastHeartbeat` seconds (defaults to 10 seconds).
+
+```ts
+const isActive = await conductor.isIntegrationConnectionActive(
+  qbdConnections[0].id
+);
+```
+
+### `logConnectionStatuses()`
+
+Log the time since Conductor has heard from each authorized integration connection.
+
+```ts
+conductor.logConnectionStatuses(); // Outputs to logs
+```

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "4.1.10",
+    "version": "6.1.0",
     "description": "Easily integrate with the entire QuickBooks Desktop API with fully-typed async TypeScript",
     "author": "Danny Nemer <hi@DannyNemer.com>",
     "license": "MIT",

package/dist/src/Client.d.ts

@@ -9,6 +9,20 @@ interface IntegrationRequestParams {
     integrationConnectionId: string;
     requestObject: object;
 }
+interface GetIntegrationConnectionByIdResult {
+    integrationConnection: {
+        id: string;
+        integration: {
+            id: string;
+            name: string;
+        };
+        qbwcUsername: string;
+        lastHeartbeatAt: string | null;
+    };
+}
+interface GetIntegrationConnectionsResult {
+    integrationConnections: GetIntegrationConnectionByIdResult["integrationConnection"][];
+}
 export default class Client {
     /** QuickBooks Desktop integration. */
     readonly qbd: QbdIntegration;
@@ -16,8 +30,9 @@ export default class Client {
     private readonly gqlClient;
     private readonly verbose;
     constructor(apiKey: string, { verbose, serverEnvironment }?: ClientOptions);
-    getIntegrationConnection(integrationConnectionId: string): Promise<object>;
-    getIntegrationConnections(): Promise<object[]>;
+    getIntegrationConnectionById(integrationConnectionId: string): Promise<GetIntegrationConnectionByIdResult["integrationConnection"]>;
+    getIntegrationConnections(): Promise<GetIntegrationConnectionsResult["integrationConnections"]>;
+    isIntegrationConnectionActive(integrationConnectionId: string, secondsSinceLastHeartbeat?: number): Promise<boolean>;
     logConnectionStatuses(): Promise<void>;
     integrationRequest(integrationRequestParams: IntegrationRequestParams): Promise<object>;
     private request;

package/dist/src/Client.js

@@ -27,9 +27,9 @@ class Client {
         });
         this.qbd = new QbdIntegration_1.default(this);
     }
-    async getIntegrationConnection(integrationConnectionId) {
-        const data = await this.request(`#graphql
-        query GetIntegrationConnection($integrationConnectionId: ID!) {
+    async getIntegrationConnectionById(integrationConnectionId) {
+        const data = (await this.request(`#graphql
+        query GetIntegrationConnectionById($integrationConnectionId: ID!) {
           integrationConnection(id: $integrationConnectionId) {
             id
             integration {
@@ -40,12 +40,11 @@ class Client {
             lastHeartbeatAt
           }
         }
-      `, { integrationConnectionId });
-        // @ts-expect-error - This will pass after we integrate GQL codegen.
+      `, { integrationConnectionId }));
         return data.integrationConnection;
     }
     async getIntegrationConnections() {
-        const data = await this.request(`#graphql
+        const data = (await this.request(`#graphql
         query {
           integrationConnections {
             id
@@ -57,10 +56,19 @@ class Client {
             lastHeartbeatAt
           }
         }
-      `);
-        // @ts-expect-error - This will pass after we integrate GQL codegen.
+      `));
         return data.integrationConnections;
     }
+    async isIntegrationConnectionActive(integrationConnectionId, secondsSinceLastHeartbeat = 10) {
+        const integrationConnection = await this.getIntegrationConnectionById(integrationConnectionId);
+        if (integrationConnection.lastHeartbeatAt === null) {
+            return false;
+        }
+        const lastHeartbeatAt = new Date(integrationConnection.lastHeartbeatAt);
+        const now = new Date();
+        const secondsSinceLastHeartbeatActual = (now.getTime() - lastHeartbeatAt.getTime()) / 1000;
+        return secondsSinceLastHeartbeatActual <= secondsSinceLastHeartbeat;
+    }
     async logConnectionStatuses() {
         const integrationConnections = (await this.getIntegrationConnections());
         console.log("Time since Conductor last heard from each integration connection:");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "4.1.10",
+  "version": "6.1.0",
   "description": "Easily integrate with the entire QuickBooks Desktop API with fully-typed async TypeScript",
   "author": "Danny Nemer <hi@DannyNemer.com>",
   "license": "MIT",