conductor-node 7.4.4 → 7.4.6

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "7.4.4",
+    "version": "7.4.6",
     "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,7 @@
         "delete-compiled-tests": "rm -rf `find ./dist -type d -name __tests__` ./dist/src/utils/testing.*",
         "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": "yarn graphql-codegen --config ./src/graphql/codegenConfig.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"
     },
@@ -25,6 +25,7 @@
     },
     "dependencies": {
         "chalk": "^4",
+        "dotenv": "^16.0.3",
         "graphql": "^16.6.0",
         "graphql-request": "^5.0.0"
     },

package/dist/src/Client.js

@@ -115,9 +115,13 @@ class Client {
             if (error instanceof graphql_request_1.ClientError) {
                 const { response } = error;
                 if ([404, 502, 503].includes(response.status)) {
-                    throw new Error(`The server returned a ${response.status} error, which may indicate that the server is down. Please alert the Conductor team if this error persists.`);
+                    throw new Error(`The Conductor server returned a ${response.status} error, which may indicate that the server is down. Please alert the Conductor team if this error persists.`);
                 }
-                const errorMessage = response.errors?.[0]?.message ??
+                const nestedError = response.errors?.[0];
+                if (nestedError?.extensions["code"] === "GRAPHQL_VALIDATION_FAILED") {
+                    throw new Error(`The Conductor server is no longer compatible with your version of "${package_json_1.default.name}". Please run "yarn add ${package_json_1.default.name}@latest" to update.`);
+                }
+                const errorMessage = nestedError?.message ??
                     // 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).
@@ -138,7 +142,7 @@ class Client {
             .toString()
             .trim();
         if (currentVersion !== latestVersion) {
-            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.`));
+            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/graphql/__generated__/operationTypes.d.ts

@@ -1,5 +1,5 @@
-import { GraphQLClient } from "graphql-request";
-import * as Dom from "graphql-request/dist/types.dom";
+import type { GraphQLClient } from "graphql-request";
+import type * as Dom from "graphql-request/dist/types.dom";
 export type Maybe<T> = T | null;
 export type InputMaybe<T> = Maybe<T>;
 export type Exact<T extends {
@@ -23,64 +23,15 @@ export type Scalars = {
     DateTime: Date;
     JSONObject: object;
 };
-export type GraphqlConnectionStatusResult = {
-    error: Maybe<GraphqlUserError>;
-    isConnected: Scalars["Boolean"];
-};
 export type GraphqlCreateIntegrationConnectionInput = {
     endUserCompanyName: Scalars["String"];
     endUserEmail: Scalars["String"];
     integrationKey: Scalars["String"];
 };
-export type GraphqlCreateIntegrationConnectionResult = {
-    integrationConnection: GraphqlIntegrationConnection;
-    qbwcPassword: Scalars["String"];
-    qwcFileDownloadUrl: Scalars["String"];
-};
-export type GraphqlIntegration = {
-    id: Scalars["ID"];
-    key: Scalars["String"];
-    name: Scalars["String"];
-};
-export type GraphqlIntegrationConnection = {
-    connectionStatus: GraphqlConnectionStatusResult;
-    devUserId: Scalars["ID"];
-    endUserCompanyName: Scalars["String"];
-    endUserEmail: Scalars["String"];
-    id: Scalars["ID"];
-    integration: GraphqlIntegration;
-    integrationKey: Scalars["String"];
-    lastHeartbeatAt: Maybe<Scalars["DateTime"]>;
-    qbwcPassword: Scalars["String"];
-};
-export type GraphqlMutation = {
-    createIntegrationConnection: GraphqlCreateIntegrationConnectionResult;
-    sendIntegrationRequest: GraphqlSendIntegrationRequestResult;
-};
-export type GraphqlMutationCreateIntegrationConnectionArgs = {
-    input: GraphqlCreateIntegrationConnectionInput;
-};
-export type GraphqlMutationSendIntegrationRequestArgs = {
-    input: GraphqlSendIntegrationRequestInput;
-};
-export type GraphqlQuery = {
-    integrationConnection: GraphqlIntegrationConnection;
-    integrationConnections: Array<GraphqlIntegrationConnection>;
-};
-export type GraphqlQueryIntegrationConnectionArgs = {
-    id: Scalars["ID"];
-};
 export type GraphqlSendIntegrationRequestInput = {
     integrationConnectionId: Scalars["ID"];
     requestObject: Scalars["JSONObject"];
 };
-export type GraphqlSendIntegrationRequestResult = {
-    response: Scalars["JSONObject"];
-};
-export type GraphqlUserError = {
-    devMessage: Scalars["String"];
-    endUserMessage: Scalars["String"];
-};
 export type GraphqlIntegrationConnectionFragment = {
     id: string;
     integrationKey: string;
@@ -88,6 +39,11 @@ export type GraphqlIntegrationConnectionFragment = {
     endUserCompanyName: string;
     lastHeartbeatAt: Date | null;
 };
+export type GraphqlUserErrorFragment = {
+    code: string;
+    developerMessage: string;
+    endUserMessage: string;
+};
 export type GraphqlGetIntegrationConnectionQueryVariables = Exact<{
     integrationConnectionId: Scalars["ID"];
 }>;
@@ -120,7 +76,8 @@ export type GraphqlGetConnectionStatusQuery = {
         connectionStatus: {
             isConnected: boolean;
             error: {
-                devMessage: string;
+                code: string;
+                developerMessage: string;
                 endUserMessage: string;
             } | null;
         };
@@ -151,9 +108,10 @@ 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 UserErrorFragmentDoc = "\n    fragment UserError on UserError {\n  code\n  developerMessage\n  endUserMessage\n}\n    ";
 export declare const GetIntegrationConnectionDocument: string;
 export declare const GetIntegrationConnectionsDocument: string;
-export declare const GetConnectionStatusDocument = "\n    query getConnectionStatus($integrationConnectionId: ID!) {\n  integrationConnection(id: $integrationConnectionId) {\n    connectionStatus {\n      isConnected\n      error {\n        devMessage\n        endUserMessage\n      }\n    }\n  }\n}\n    ";
+export declare const GetConnectionStatusDocument: string;
 export declare const CreateIntegrationConnectionDocument: string;
 export declare const SendIntegrationRequestDocument = "\n    mutation sendIntegrationRequest($input: SendIntegrationRequestInput!) {\n  sendIntegrationRequest(input: $input) {\n    response\n  }\n}\n    ";
 export type SdkFunctionWrapper = <T>(action: (requestHeaders?: Record<string, string>) => Promise<T>, operationName: string, operationType?: string) => Promise<T>;

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.GetIntegrationConnectionsDocument = exports.GetIntegrationConnectionDocument = exports.IntegrationConnectionFragmentDoc = void 0;
+exports.getSdk = exports.SendIntegrationRequestDocument = exports.CreateIntegrationConnectionDocument = exports.GetConnectionStatusDocument = exports.GetIntegrationConnectionsDocument = exports.GetIntegrationConnectionDocument = exports.UserErrorFragmentDoc = exports.IntegrationConnectionFragmentDoc = void 0;
 exports.IntegrationConnectionFragmentDoc = `
     fragment IntegrationConnection on IntegrationConnection {
   id
@@ -10,6 +10,13 @@ exports.IntegrationConnectionFragmentDoc = `
   lastHeartbeatAt
 }
     `;
+exports.UserErrorFragmentDoc = `
+    fragment UserError on UserError {
+  code
+  developerMessage
+  endUserMessage
+}
+    `;
 exports.GetIntegrationConnectionDocument = `
     query getIntegrationConnection($integrationConnectionId: ID!) {
   integrationConnection(id: $integrationConnectionId) {
@@ -30,13 +37,12 @@ exports.GetConnectionStatusDocument = `
     connectionStatus {
       isConnected
       error {
-        devMessage
-        endUserMessage
+        ...UserError
       }
     }
   }
 }
-    `;
+    ${exports.UserErrorFragmentDoc}`;
 exports.CreateIntegrationConnectionDocument = `
     mutation createIntegrationConnection($input: CreateIntegrationConnectionInput!) {
   createIntegrationConnection(input: $input) {

package/dist/src/graphql/codegenConfig.js

@@ -13,15 +13,23 @@ const codegenConfig = {
                 "typescript-graphql-request",
                 {
                     add: {
-                        content: "/* eslint-disable eslint-comments/disable-enable-pair -- Auto-generated */\n" +
-                            "/* eslint-disable eslint-comments/no-unlimited-disable -- Auto-generated */\n" +
+                        content: [
+                            "/* eslint-disable eslint-comments/disable-enable-pair -- Auto-generated */",
+                            "/* eslint-disable eslint-comments/no-unlimited-disable -- Auto-generated */",
                             "/* eslint-disable -- Auto-generated */",
+                        ].join("\n"),
                     },
                 },
             ],
             config: {
                 // Avoid including `__typename` in objects we return to dev-users.
                 skipTypename: true,
+                // Use `import type {}` rather than `import {}`.
+                useTypeImports: true,
+                // Only emit types used in `operations.graphql`. This avoids confusion
+                // by creating types with more fields than the client actually returns
+                // (e.g. `IntegrationConnection` vs. `IntegrationConnectionFragment`)).
+                onlyOperationTypes: true,
                 avoidOptionals: true,
                 typesPrefix: "Graphql",
                 // Avoid adding `graphql-tag` as a client dependency.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "7.4.4",
+  "version": "7.4.6",
   "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,7 @@
     "delete-compiled-tests": "rm -rf `find ./dist -type d -name __tests__` ./dist/src/utils/testing.*",
     "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": "yarn graphql-codegen --config ./src/graphql/codegenConfig.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"
   },
@@ -25,6 +25,7 @@
   },
   "dependencies": {
     "chalk": "^4",
+    "dotenv": "^16.0.3",
     "graphql": "^16.6.0",
     "graphql-request": "^5.0.0"
   },