conductor-node 7.3.5 → 7.4.0

package/README.md

@@ -106,10 +106,25 @@ const qbdConnection = await conductor.getIntegrationConnectionById(
 );
 ```
 
-### `isIntegrationConnectionActive(id: string, secondsSinceLastActive: number = 60)`
+### `getConnectionStatus(id: string)`
 
-Check if an integration-connection is active within the last `secondsSinceLastActive` seconds (defaults to 60 seconds).
+Check whether we can successfully connect to the end-user's QBD instance.
+
+Unlike `lastHeartbeatAt`, which only checks if QBWC is running (i.e., is the user's computer on), this check fails if the user's computer is on but QBD is not running, the wrong company file is open, or there is a modal dialog open in QBD.
+
+```ts
+const connectionStatus = await conductor.getConnectionStatus(qbdConnectionId);
+```
+
+The response includes the following:
 
 ```ts
-const isActive = await conductor.isIntegrationConnectionActive(qbdConnectionId);
+{
+  // Whether we can connect to the end-user's QBD.
+  isConnected: false
+  // If `isConnected=false`, the corresponding error message for the developer.
+  devErrorMessage: "The end-user's computer is likely off",
+  // If `isConnected=false`, the corresponding error message for the end-user.
+  endUserErrorMessage: "Please ensure your computer is on and QuickBooks Desktop is open",
+}
 ```

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "7.3.5",
+    "version": "7.4.0",
     "description": "Easily integrate with the entire QuickBooks Desktop API with fully-typed async TypeScript",
     "author": "Danny Nemer <hi@DannyNemer.com>",
     "license": "MIT",
@@ -17,7 +17,8 @@
         "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",
-        "status": "yarn ts-node ./bin/logConnectionStatuses.ts"
+        "status": "yarn ts-node ./bin/logConnectionStatuses.ts",
+        "diff": "yarn pack && npm diff --diff=conductor-node@latest --diff=conductor-node-v$(node -p \"require('./package.json').version\").tgz && yarn clean"
     },
     "engines": {
         "node": ">=16"

package/dist/src/Client.d.ts

@@ -1,5 +1,5 @@
 import type { Environment } from "./environment";
-import type { GraphqlCreateIntegrationConnectionMutation, GraphqlGetConnectionStatusQuery, GraphqlGetConnectionStatusQueryVariables, GraphqlGetIntegrationConnectionQuery, GraphqlGetIntegrationConnectionQueryVariables, GraphqlGetIntegrationConnectionsQuery, GraphqlIsIntegrationConnectionActiveQuery, GraphqlIsIntegrationConnectionActiveQueryVariables, GraphqlSendIntegrationRequestInput, GraphqlSendIntegrationRequestMutation } from "./graphql/__generated__/operationTypes";
+import type { GraphqlCreateIntegrationConnectionMutation, GraphqlGetConnectionStatusQuery, GraphqlGetConnectionStatusQueryVariables, GraphqlGetIntegrationConnectionQuery, GraphqlGetIntegrationConnectionQueryVariables, GraphqlGetIntegrationConnectionsQuery, GraphqlSendIntegrationRequestInput, GraphqlSendIntegrationRequestMutation } from "./graphql/__generated__/operationTypes";
 import QbdIntegration from "./integrations/qbd/QbdIntegration";
 export interface ClientOptions {
     /** Log each request and response. */
@@ -16,7 +16,6 @@ export default class Client {
     constructor(apiKey: string, { verbose, serverEnvironment }?: ClientOptions);
     getIntegrationConnection(integrationConnectionId: GraphqlGetIntegrationConnectionQueryVariables["integrationConnectionId"]): Promise<GraphqlGetIntegrationConnectionQuery["integrationConnection"]>;
     getIntegrationConnections(): Promise<GraphqlGetIntegrationConnectionsQuery["integrationConnections"]>;
-    isIntegrationConnectionActive(integrationConnectionId: GraphqlIsIntegrationConnectionActiveQueryVariables["integrationConnectionId"], secondsSinceLastActive?: GraphqlIsIntegrationConnectionActiveQueryVariables["secondsSinceLastActive"]): Promise<GraphqlIsIntegrationConnectionActiveQuery["integrationConnection"]["isActive"]>;
     /**
      * Check whether we can successfully connect to the end-user's QBD instance.
      *
@@ -27,7 +26,7 @@ export default class Client {
      *
      * @param integrationConnectionId The ID of the integration connection.
      * @returns result Object with the following properties:
-     * @returns result.isConnected Whether we can connect to QBD.
+     * @returns result.isConnected Whether we can connect to the end-user's QBD.
      * @returns result.devErrorMessage If `isConnected=false`, this will be the
      * corresponding error message for the developer; e.g., "The end-user's
      * computer is likely off".

package/dist/src/Client.js

@@ -47,14 +47,6 @@ class Client {
             .getIntegrationConnections()
             .then((result) => result.integrationConnections);
     }
-    async isIntegrationConnectionActive(integrationConnectionId, secondsSinceLastActive = 60) {
-        return this.graphqlOperations
-            .isIntegrationConnectionActive({
-            integrationConnectionId,
-            secondsSinceLastActive,
-        })
-            .then((result) => result.integrationConnection.isActive);
-    }
     /**
      * Check whether we can successfully connect to the end-user's QBD instance.
      *
@@ -65,7 +57,7 @@ class Client {
      *
      * @param integrationConnectionId The ID of the integration connection.
      * @returns result Object with the following properties:
-     * @returns result.isConnected Whether we can connect to QBD.
+     * @returns result.isConnected Whether we can connect to the end-user's QBD.
      * @returns result.devErrorMessage If `isConnected=false`, this will be the
      * corresponding error message for the developer; e.g., "The end-user's
      * computer is likely off".

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

@@ -55,13 +55,9 @@ export type GraphqlIntegrationConnection = {
     id: Scalars["ID"];
     integration: GraphqlIntegration;
     integrationKey: Scalars["String"];
-    isActive: Scalars["Boolean"];
     lastHeartbeatAt: Maybe<Scalars["DateTime"]>;
     qbwcPassword: Scalars["String"];
 };
-export type GraphqlIntegrationConnectionIsActiveArgs = {
-    secondsSinceLastActive: Scalars["Int"];
-};
 export type GraphqlMutation = {
     createIntegrationConnection: GraphqlCreateIntegrationConnectionResult;
     sendIntegrationRequest: GraphqlSendIntegrationRequestResult;
@@ -117,15 +113,6 @@ export type GraphqlGetIntegrationConnectionsQuery = {
         lastHeartbeatAt: Date | null;
     }>;
 };
-export type GraphqlIsIntegrationConnectionActiveQueryVariables = Exact<{
-    integrationConnectionId: Scalars["ID"];
-    secondsSinceLastActive: Scalars["Int"];
-}>;
-export type GraphqlIsIntegrationConnectionActiveQuery = {
-    integrationConnection: {
-        isActive: boolean;
-    };
-};
 export type GraphqlGetConnectionStatusQueryVariables = Exact<{
     integrationConnectionId: Scalars["ID"];
 }>;
@@ -165,7 +152,6 @@ export type GraphqlSendIntegrationRequestMutation = {
 export declare const IntegrationConnectionFragmentDoc = "\n    fragment IntegrationConnection on IntegrationConnection {\n  id\n  integrationKey\n  endUserEmail\n  endUserCompanyName\n  lastHeartbeatAt\n}\n    ";
 export declare const GetIntegrationConnectionDocument: string;
 export declare const GetIntegrationConnectionsDocument: string;
-export declare const IsIntegrationConnectionActiveDocument = "\n    query isIntegrationConnectionActive($integrationConnectionId: ID!, $secondsSinceLastActive: Int!) {\n  integrationConnection(id: $integrationConnectionId) {\n    isActive(secondsSinceLastActive: $secondsSinceLastActive)\n  }\n}\n    ";
 export declare const GetConnectionStatusDocument = "\n    query getConnectionStatus($integrationConnectionId: ID!) {\n  integrationConnection(id: $integrationConnectionId) {\n    connectionStatus {\n      isConnected\n      devErrorMessage\n      endUserErrorMessage\n    }\n  }\n}\n    ";
 export declare const CreateIntegrationConnectionDocument: string;
 export declare const SendIntegrationRequestDocument = "\n    mutation sendIntegrationRequest($input: SendIntegrationRequestInput!) {\n  sendIntegrationRequest(input: $input) {\n    response\n  }\n}\n    ";
@@ -173,7 +159,6 @@ export type SdkFunctionWrapper = <T>(action: (requestHeaders?: Record<string, st
 export declare function getSdk(client: GraphQLClient, withWrapper?: SdkFunctionWrapper): {
     getIntegrationConnection(variables: GraphqlGetIntegrationConnectionQueryVariables, requestHeaders?: (Record<string, string> | Dom.Headers | string[][]) | undefined): Promise<GraphqlGetIntegrationConnectionQuery>;
     getIntegrationConnections(variables?: GraphqlGetIntegrationConnectionsQueryVariables, requestHeaders?: (Record<string, string> | Dom.Headers | string[][]) | undefined): Promise<GraphqlGetIntegrationConnectionsQuery>;
-    isIntegrationConnectionActive(variables: GraphqlIsIntegrationConnectionActiveQueryVariables, requestHeaders?: (Record<string, string> | Dom.Headers | string[][]) | undefined): Promise<GraphqlIsIntegrationConnectionActiveQuery>;
     getConnectionStatus(variables: GraphqlGetConnectionStatusQueryVariables, requestHeaders?: (Record<string, string> | Dom.Headers | string[][]) | undefined): Promise<GraphqlGetConnectionStatusQuery>;
     createIntegrationConnection(variables: GraphqlCreateIntegrationConnectionMutationVariables, requestHeaders?: (Record<string, string> | Dom.Headers | string[][]) | undefined): Promise<GraphqlCreateIntegrationConnectionMutation>;
     sendIntegrationRequest(variables: GraphqlSendIntegrationRequestMutationVariables, requestHeaders?: (Record<string, string> | Dom.Headers | string[][]) | undefined): Promise<GraphqlSendIntegrationRequestMutation>;

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSdk = exports.SendIntegrationRequestDocument = exports.CreateIntegrationConnectionDocument = exports.GetConnectionStatusDocument = exports.IsIntegrationConnectionActiveDocument = exports.GetIntegrationConnectionsDocument = exports.GetIntegrationConnectionDocument = exports.IntegrationConnectionFragmentDoc = void 0;
+exports.getSdk = exports.SendIntegrationRequestDocument = exports.CreateIntegrationConnectionDocument = exports.GetConnectionStatusDocument = exports.GetIntegrationConnectionsDocument = exports.GetIntegrationConnectionDocument = exports.IntegrationConnectionFragmentDoc = void 0;
 exports.IntegrationConnectionFragmentDoc = `
     fragment IntegrationConnection on IntegrationConnection {
   id
@@ -24,13 +24,6 @@ exports.GetIntegrationConnectionsDocument = `
   }
 }
     ${exports.IntegrationConnectionFragmentDoc}`;
-exports.IsIntegrationConnectionActiveDocument = `
-    query isIntegrationConnectionActive($integrationConnectionId: ID!, $secondsSinceLastActive: Int!) {
-  integrationConnection(id: $integrationConnectionId) {
-    isActive(secondsSinceLastActive: $secondsSinceLastActive)
-  }
-}
-    `;
 exports.GetConnectionStatusDocument = `
     query getConnectionStatus($integrationConnectionId: ID!) {
   integrationConnection(id: $integrationConnectionId) {
@@ -69,9 +62,6 @@ function getSdk(client, withWrapper = defaultWrapper) {
         getIntegrationConnections(variables, requestHeaders) {
             return withWrapper((wrappedRequestHeaders) => client.request(exports.GetIntegrationConnectionsDocument, variables, { ...requestHeaders, ...wrappedRequestHeaders }), "getIntegrationConnections", "query");
         },
-        isIntegrationConnectionActive(variables, requestHeaders) {
-            return withWrapper((wrappedRequestHeaders) => client.request(exports.IsIntegrationConnectionActiveDocument, variables, { ...requestHeaders, ...wrappedRequestHeaders }), "isIntegrationConnectionActive", "query");
-        },
         getConnectionStatus(variables, requestHeaders) {
             return withWrapper((wrappedRequestHeaders) => client.request(exports.GetConnectionStatusDocument, variables, { ...requestHeaders, ...wrappedRequestHeaders }), "getConnectionStatus", "query");
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "7.3.5",
+  "version": "7.4.0",
   "description": "Easily integrate with the entire QuickBooks Desktop API with fully-typed async TypeScript",
   "author": "Danny Nemer <hi@DannyNemer.com>",
   "license": "MIT",
@@ -17,7 +17,8 @@
     "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",
-    "status": "yarn ts-node ./bin/logConnectionStatuses.ts"
+    "status": "yarn ts-node ./bin/logConnectionStatuses.ts",
+    "diff": "yarn pack && npm diff --diff=conductor-node@latest --diff=conductor-node-v$(node -p \"require('./package.json').version\").tgz && yarn clean"
   },
   "engines": {
     "node": ">=16"