conductor-node 7.5.1 → 8.0.1

package/README.md

@@ -42,9 +42,11 @@ Create a new integration-connection.
 const newQbdConnection = await conductor.createIntegrationConnection({
   // The identifier of the third-party platform to integrate.
   integrationKey: "quickbooks-desktop",
+  // Your end-user's unique ID in your product's database. Must be distinct
+  // from your other connections for the same integration.
+  endUserSourceId: "1234-abcd",
   // Your end-user's email address for identification only. No emails
-  // will be sent. Must be distinct from your other connections for the
-  // same `integrationKey`.
+  // will be sent.
   endUserEmail: "danny@constructionco.com",
   // Your end-user's company name that will be shown elsewhere in Conductor.
   endUserCompanyName: "Construction Corp",
@@ -58,7 +60,7 @@ The response includes the following:
   // ❗ Display 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/{UUID}'
+  qwcFileDownloadUrl: 'https://api.conductor.is/qwc/{UUID}'
   // ❗ Display 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
@@ -69,6 +71,7 @@ The response includes the following:
     // this end-user's integration in the future.
     id: '{UUID}',
     integrationKey: 'quickbooks-desktop',
+    endUserSourceId: "1234-abcd",
     endUserEmail: 'danny@constructionco.com',
     endUserCompanyName: 'Construction Corp',
     lastHeartbeatAt: null

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "7.5.1",
+    "version": "8.0.1",
     "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

@@ -25,12 +25,13 @@ 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 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".
-     * @returns result.endUserErrorMessage  If `isConnected=false`, this will be
-     * the corresponding error message for the end-user; e.g., "Please ensure your
-     * computer is on and QuickBooks Desktop is open".
+     * @returns result.error If `isConnected=false`, this will be an object with
+     * the following properties:
+     * @returns result.error.code The unique error code.
+     * @returns result.error.developerMessage The technical error message for the
+     * developer.
+     * @returns result.error.endUserMessage The user-friendly error message to
+     * display to the the end-user.
      */
     getConnectionStatus(integrationConnectionId: GraphqlGetConnectionStatusQueryVariables["integrationConnectionId"]): Promise<GraphqlGetConnectionStatusQuery["integrationConnection"]["connectionStatus"]>;
     /**
@@ -39,9 +40,11 @@ export default class Client {
      * @param input - The input object to create the integration connection.
      * @param input.integrationKey The identifier of the third-party platform to
      * integrate.
+     * @param input.endUserSourceId Your end-user's unique ID in your product's
+     * database. Must be distinct from your other connections for the same
+     * integration.
      * @param input.endUserEmail Your end-user's email address for identification
-     * only. No emails will be sent. Must be distinct from your other connections
-     * for the same integration.
+     * only. No emails will be sent.
      * @param input.endUserCompanyName Your end-user's company name that will be
      * shown elsewhere in Conductor.
      * @returns The newly created integration connection.

package/dist/src/Client.js

@@ -47,12 +47,13 @@ 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 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".
-     * @returns result.endUserErrorMessage  If `isConnected=false`, this will be
-     * the corresponding error message for the end-user; e.g., "Please ensure your
-     * computer is on and QuickBooks Desktop is open".
+     * @returns result.error If `isConnected=false`, this will be an object with
+     * the following properties:
+     * @returns result.error.code The unique error code.
+     * @returns result.error.developerMessage The technical error message for the
+     * developer.
+     * @returns result.error.endUserMessage The user-friendly error message to
+     * display to the the end-user.
      */
     async getConnectionStatus(integrationConnectionId) {
         return this.graphqlOperations
@@ -65,9 +66,11 @@ class Client {
      * @param input - The input object to create the integration connection.
      * @param input.integrationKey The identifier of the third-party platform to
      * integrate.
+     * @param input.endUserSourceId Your end-user's unique ID in your product's
+     * database. Must be distinct from your other connections for the same
+     * integration.
      * @param input.endUserEmail Your end-user's email address for identification
-     * only. No emails will be sent. Must be distinct from your other connections
-     * for the same integration.
+     * only. No emails will be sent.
      * @param input.endUserCompanyName Your end-user's company name that will be
      * shown elsewhere in Conductor.
      * @returns The newly created integration connection.

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

@@ -26,6 +26,7 @@ export type Scalars = {
 export type GraphqlCreateIntegrationConnectionInput = {
     endUserCompanyName: Scalars["String"];
     endUserEmail: Scalars["String"];
+    endUserSourceId: Scalars["String"];
     integrationKey: Scalars["String"];
 };
 export type GraphqlSendIntegrationRequestInput = {
@@ -35,6 +36,7 @@ export type GraphqlSendIntegrationRequestInput = {
 export type GraphqlIntegrationConnectionFragment = {
     id: string;
     integrationKey: string;
+    endUserSourceId: string;
     endUserEmail: string;
     endUserCompanyName: string;
     lastHeartbeatAt: Date | null;
@@ -51,6 +53,7 @@ export type GraphqlGetIntegrationConnectionQuery = {
     integrationConnection: {
         id: string;
         integrationKey: string;
+        endUserSourceId: string;
         endUserEmail: string;
         endUserCompanyName: string;
         lastHeartbeatAt: Date | null;
@@ -63,6 +66,7 @@ export type GraphqlGetIntegrationConnectionsQuery = {
     integrationConnections: Array<{
         id: string;
         integrationKey: string;
+        endUserSourceId: string;
         endUserEmail: string;
         endUserCompanyName: string;
         lastHeartbeatAt: Date | null;
@@ -93,6 +97,7 @@ export type GraphqlCreateIntegrationConnectionMutation = {
         integrationConnection: {
             id: string;
             integrationKey: string;
+            endUserSourceId: string;
             endUserEmail: string;
             endUserCompanyName: string;
             lastHeartbeatAt: Date | null;
@@ -107,7 +112,7 @@ export type GraphqlSendIntegrationRequestMutation = {
         response: object;
     };
 };
-export declare const IntegrationConnectionFragmentDoc = "\n    fragment IntegrationConnection on IntegrationConnection {\n  id\n  integrationKey\n  endUserEmail\n  endUserCompanyName\n  lastHeartbeatAt\n}\n    ";
+export declare const IntegrationConnectionFragmentDoc = "\n    fragment IntegrationConnection on IntegrationConnection {\n  id\n  integrationKey\n  endUserSourceId\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;

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

@@ -5,6 +5,7 @@ exports.IntegrationConnectionFragmentDoc = `
     fragment IntegrationConnection on IntegrationConnection {
   id
   integrationKey
+  endUserSourceId
   endUserEmail
   endUserCompanyName
   lastHeartbeatAt

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

@@ -4,5 +4,6 @@ export declare const currentEnvironment: {
     isTest: boolean;
     isDevelopment: boolean;
     isProduction: boolean;
+    isLocal: boolean;
 };
 export declare function getServerUrlForEnvironment(environment: Environment): string;

package/dist/src/utils/environment.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getServerUrlForEnvironment = exports.currentEnvironment = void 0;
-const currentEnvironmentName = process.env["NODE_ENV"] ?? "development";
+const currentEnvironmentName = (process.env["NODE_ENV"] ??
+    "development");
 exports.currentEnvironment = {
     name: currentEnvironmentName,
     isTest: currentEnvironmentName === "test",
     isDevelopment: currentEnvironmentName === "development",
     isProduction: currentEnvironmentName === "production",
+    isLocal: ["test", "development"].includes(currentEnvironmentName),
 };
 function getServerUrlForEnvironment(environment) {
     switch (environment) {
@@ -18,7 +20,7 @@ function getServerUrlForEnvironment(environment) {
             return "https://conductor.ngrok.io";
         }
         case "production": {
-            return "https://production.api.conductor.is";
+            return "https://api.conductor.is";
         }
         default: {
             throw new Error("Invalid environment");

package/package.json

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