conductor-node 8.5.0 → 8.5.2

package/README.md

@@ -54,13 +54,13 @@ 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.
+  // 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.
   endUserEmail: "danny@constructionco.com",
-  // Your end-user's company name that will be shown elsewhere in Conductor.
+  // Your end-user's company name shown elsewhere in Conductor.
   endUserCompanyName: "Construction Corp",
 });
 ```
@@ -167,7 +167,7 @@ The `ConductorError` and its subclasses have the following properties:
   // The unique error code. This is useful for adding special handling
   // for specific errors.
   code: string;
-  // The error message for your logs.
+  // The developer error message for your logs.
   message: string;
   // The end-user-friendly error message to display in your app.
   endUserMessage: string;
@@ -184,34 +184,17 @@ The `ConductorError` and its subclasses have the following properties:
 
 The error object you receive will have one of the following error types:
 
-| Type                           | Description                                                                                      |
-| ------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `ConductorIntegrationError`    | An error occurred on the third-party integration's end while processing your end-user's request. |
-| `ConductorInvalidRequestError` | You made an API call with the wrong parameters, in the wrong state, or in an invalid way.        |
-| `ConductorAuthenticationError` | Conductor cannot authenticate you with the credentials you provided. E.g., an incorrect API key. |
-| `ConductorConnectionError`     | There was a network problem between the client (on your server) and Conductor's servers.         |
-| `ConductorInternalError`       | Something went wrong on Conductor's end. (These are rare.)                                       |
+| Type                           | Description                                                                                                                                                              |
+| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `ConductorIntegrationError`    | An error occurred on the third-party integration's end while processing your end-user's request. E.g., cannot connect to QuickBooks Desktop on your end-user's computer. |
+| `ConductorInvalidRequestError` | You made an API call with the wrong parameters, in the wrong state, or in an invalid way.                                                                                |
+| `ConductorAuthenticationError` | Conductor cannot authenticate you with the credentials you provided. E.g., an incorrect API key.                                                                         |
+| `ConductorConnectionError`     | There was a network problem between the client (on your server) and Conductor's servers.                                                                                 |
+| `ConductorInternalError`       | Something went wrong on Conductor's end. (These are rare.)                                                                                                               |
 
 ### Example
 
-Using `async`/`await`:
-
-```ts
-try {
-  const newAccount = await conductor.qbd.account.add(qbdConnectionId, {
-    Name: "Test Account",
-    AccountType: "Bank",
-    OpenBalance: "100",
-  });
-} catch (error) {
-  if (error instanceof ConductorError) {
-    // Update your app's UI to display `error.endUserMessage`.
-  }
-  // ...
-}
-```
-
-Or in the form of a rejected promise:
+In the form of a rejected promise:
 
 ```ts
 conductor.qbd.account
@@ -225,8 +208,36 @@ conductor.qbd.account
   })
   .catch((error) => {
     if (error instanceof ConductorError) {
-      // Update your app's UI to display `error.endUserMessage`.
+      // ❗ TODO: Update your app's UI to display `error.endUserMessage`.
+
+      // RECOMMENDED: Send a *warning* to Sentry for integration-errors,
+      // which are your end-user's fault (e.g., cannot connect to QBD on
+      // your end-user's computer) or an *error* for other errors (e.g.,
+      // invalid API key).
+      Sentry.captureException(error, {
+        level: error instanceof ConductorIntegrationError ? "warning" : "error",
+      });
+    } else {
+      // ...
     }
-    // ...
   });
 ```
+
+Or using `async`/`await`:
+
+```ts
+try {
+  const newAccount = await conductor.qbd.account.add(qbdConnectionId, {
+    Name: "Test Account",
+    AccountType: "Bank",
+    OpenBalance: "100",
+  });
+} catch (error) {
+  if (error instanceof ConductorError) {
+    // ❗ TODO: Update your app's UI to display `error.endUserMessage`.
+    // ...
+  } else {
+    // ...
+  }
+}
+```

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "8.5.0",
+    "version": "8.5.2",
     "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/errors.d.ts

@@ -52,8 +52,8 @@ export declare class ConductorError extends Error {
 type ConductorErrorOptionsWithoutRawType = Omit<ConductorErrorOptions, "rawType">;
 /**
  * Raised when an error occurs on the third-party integration's end while
- * processing your end-user's request. E.g., QBWC failed to connect to
- * QuickBooks Desktop on the end-user's computer.
+ * processing your end-user's request. E.g., cannot connect to QuickBooks
+ * Desktop on the end-user's computer.
  */
 export declare class ConductorIntegrationError extends ConductorError {
     static readonly rawType: string;

package/dist/src/errors.js

@@ -66,8 +66,8 @@ class ConductorError extends Error {
 exports.ConductorError = ConductorError;
 /**
  * Raised when an error occurs on the third-party integration's end while
- * processing your end-user's request. E.g., QBWC failed to connect to
- * QuickBooks Desktop on the end-user's computer.
+ * processing your end-user's request. E.g., cannot connect to QuickBooks
+ * Desktop on the end-user's computer.
  */
 class ConductorIntegrationError extends ConductorError {
     static rawType = "INTEGRATION_ERROR";

package/package.json

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