conductor-node 11.10.0 → 12.0.0-beta.1

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

@@ -1,184 +0,0 @@
-export declare const DEFAULT_USER_FACING_MESSAGE = "An internal server error occurred. Please try again later.";
-export interface ConductorErrorOptions {
-    readonly message: string;
-    readonly userFacingMessage?: string;
-    readonly type: string;
-    readonly code: string;
-    readonly httpStatusCode?: number | undefined;
-    readonly integrationCode?: string | undefined;
-    readonly requestId?: string | undefined;
-    readonly headers?: Record<string, string>;
-    readonly raw?: unknown;
-}
-/**
- * The raw REST error response that Conductor's API returns.
- */
-export interface ConductorServerError {
-    readonly error: {
-        readonly message: string;
-        readonly userFacingMessage: string;
-        readonly type: string;
-        readonly code: string;
-        readonly httpStatusCode: number;
-        readonly integrationCode?: string;
-        readonly requestId: string;
-    };
-}
-export declare function isWellFormedConductorServerError(error: unknown): error is ConductorServerError;
-/**
- * The base error from which all other more specific Conductor errors derive.
- * Specifically for errors that Conductor's API returned.
- */
-export declare abstract class ConductorError extends Error {
-    /**
-     * The developer error message for your logs.
-     */
-    readonly message: string;
-    /**
-     * The user-friendly error message, written specifically for displaying to
-     * your end-users in your app's UI.
-     *
-     * This value exists for *every* error. E.g., for a QBD connection error, it
-     * might recommend the end-user to confirm their QuickBooks Desktop is open
-     * and that they're logged in. But if a Conductor API key is expired, e.g.,
-     * this message will just say "An internal server error occurred. Please try
-     * again later.".
-     */
-    readonly userFacingMessage: string;
-    /**
-     * Categorizes the error.
-     *
-     * This value is the same as the subclass name. E.g.,
-     * `"ConductorIntegrationError"` or `"ConductorInvalidRequestError"`.
-     */
-    readonly type: string;
-    /**
-     * The unique error code from Conductor, which is useful for adding special
-     * handling for specific errors. E.g., `"RESOURCE_MISSING"`,
-     * `"API_KEY_INVALID"`, or `"QBD_REQUEST_ERROR"`.
-     *
-     * In contrast, `type` is more general and categorizes the error.
-     */
-    readonly code: string;
-    /**
-     * The HTTP status code of the response that included the error.
-     */
-    readonly httpStatusCode: number | undefined;
-    /**
-     * The unique error code supplied by the third-party integration for errors
-     * returned by the integration (i.e., `ConductorIntegrationError`) or
-     * integration connector (i.e., `ConductorIntegrationConnectorError`). This is
-     * useful for adding special handling for specific errors from the third-party
-     * integration or connector.
-     *
-     * The integration's corresponding error message for this code is in
-     * `error.message`.
-     *
-     * The third-party integrations' error codes are not standardized, so you
-     * should not rely on this code to be the same across integrations.
-     */
-    readonly integrationCode: string | undefined;
-    /**
-     * The unique request identifier of the API request that caused the error.
-     *
-     * If you need to contact us about a specific request, providing the request
-     * identifier will ensure the fastest possible resolution.
-     */
-    readonly requestId: string | undefined;
-    /**
-     * The HTTP headers of the response that included the error.
-     */
-    readonly headers: Record<string, string> | undefined;
-    /**
-     * The raw REST error response that Conductor's API returned.
-     */
-    protected readonly raw: unknown;
-    /**
-     * Conductor's internal representation of `type` for debugging.
-     */
-    protected readonly rawType: string;
-    constructor(options: ConductorErrorOptions);
-}
-type ConductorErrorOptionsWithoutType = Omit<ConductorErrorOptions, "type">;
-/**
- * Raised when the third-party integration encounters an error while processing
- * the end-user's request. This often results from an issue with the request or
- * data handling that requires your attention to resolve.
- *
- * E.g., a `ListID` you provided was not found in QuickBooks Desktop, or an
- * accounting value you supplied did not adhere to the integration's accounting
- * rules.
- *
- * Refer to `error.integrationCode` for the error code returned by the
- * integration, if available.
- */
-export declare class ConductorIntegrationError extends ConductorError {
-    static readonly rawType = "INTEGRATION_ERROR";
-    constructor(options: ConductorErrorOptionsWithoutType);
-}
-/**
- * Raised when a connection error occurs with the third-party integration on the
- * end-user's side. This typically indicates an issue with the end-user's
- * IntegrationConnection or configuration, which they must resolve. In other
- * words, you cannot take action to fix these errors.
- *
- * E.g., QuickBooks Web Connector (QBWC) failed to connect to QuickBooks Desktop
- * on the end-user's computer.
- *
- * Refer to `error.integrationCode` for the error code returned by the
- * integration connector, if available.
- *
- * ❗ We recommend _not_ triggering alerts for these errors because only the
- * end-user can fix them.
- */
-export declare class ConductorIntegrationConnectionError extends ConductorError {
-    static readonly rawType = "INTEGRATION_CONNECTION_ERROR";
-    constructor(options: ConductorErrorOptionsWithoutType);
-}
-/**
- * Raised when you make an API call with the wrong parameters, in the wrong
- * state, or in an invalid way.
- */
-export declare class ConductorInvalidRequestError extends ConductorError {
-    static readonly rawType = "INVALID_REQUEST_ERROR";
-    constructor(options: ConductorErrorOptionsWithoutType);
-}
-/**
- * Raised when Conductor cannot authenticate you with the credentials you
- * provided. E.g., an incorrect API key.
- */
-export declare class ConductorAuthenticationError extends ConductorError {
-    static readonly rawType = "AUTHENTICATION_ERROR";
-    constructor(options: ConductorErrorOptionsWithoutType);
-}
-/**
- * Raised when you attempt to access a resource that is not allowed.
- */
-export declare class ConductorPermissionError extends ConductorError {
-    static readonly rawType = "PERMISSION_ERROR";
-    constructor(options: ConductorErrorOptionsWithoutType);
-}
-/**
- * Raised when there was a network problem between the client (on your server)
- * and Conductor's servers. E.g., a downed network or a bad TLS certificate.
- */
-export declare class ConductorConnectionError extends ConductorError {
-    static readonly rawType = "CONNECTION_ERROR";
-    constructor(options: ConductorErrorOptionsWithoutType);
-}
-/**
- * Raised when something went wrong on Conductor's end. (These are rare.)
- */
-export declare class ConductorInternalError extends ConductorError {
-    static readonly rawType = "INTERNAL_ERROR";
-    constructor(options: ConductorErrorOptionsWithoutType);
-}
-/**
- * Raised as a fallback for any other error from Conductor that no other error
- * type captures.
- */
-export declare class ConductorUnknownError extends ConductorError {
-    constructor(options: ConductorErrorOptions);
-}
-export declare function generateConductorErrorFromType(options: ConductorErrorOptions): ConductorError;
-export {};

package/dist/src/utils/error.js

@@ -1,254 +0,0 @@
-"use strict";
-/* eslint-disable max-classes-per-file -- Use one module for all error classes. */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConductorUnknownError = exports.ConductorInternalError = exports.ConductorConnectionError = exports.ConductorPermissionError = exports.ConductorAuthenticationError = exports.ConductorInvalidRequestError = exports.ConductorIntegrationConnectionError = exports.ConductorIntegrationError = exports.ConductorError = exports.DEFAULT_USER_FACING_MESSAGE = void 0;
-exports.isWellFormedConductorServerError = isWellFormedConductorServerError;
-exports.generateConductorErrorFromType = generateConductorErrorFromType;
-// Matches server-side value.
-exports.DEFAULT_USER_FACING_MESSAGE = "An internal server error occurred. Please try again later.";
-function isWellFormedConductorServerError(error) {
-    return (error instanceof Object &&
-        typeof error.error === "object" &&
-        typeof error.error.message === "string" &&
-        typeof error.error.userFacingMessage ===
-            "string" &&
-        typeof error.error.type === "string" &&
-        typeof error.error.code === "string" &&
-        typeof error.error.httpStatusCode === "number");
-}
-/**
- * The base error from which all other more specific Conductor errors derive.
- * Specifically for errors that Conductor's API returned.
- */
-class ConductorError extends Error {
-    /**
-     * The developer error message for your logs.
-     */
-    message;
-    /**
-     * The user-friendly error message, written specifically for displaying to
-     * your end-users in your app's UI.
-     *
-     * This value exists for *every* error. E.g., for a QBD connection error, it
-     * might recommend the end-user to confirm their QuickBooks Desktop is open
-     * and that they're logged in. But if a Conductor API key is expired, e.g.,
-     * this message will just say "An internal server error occurred. Please try
-     * again later.".
-     */
-    userFacingMessage;
-    /**
-     * Categorizes the error.
-     *
-     * This value is the same as the subclass name. E.g.,
-     * `"ConductorIntegrationError"` or `"ConductorInvalidRequestError"`.
-     */
-    type;
-    /**
-     * The unique error code from Conductor, which is useful for adding special
-     * handling for specific errors. E.g., `"RESOURCE_MISSING"`,
-     * `"API_KEY_INVALID"`, or `"QBD_REQUEST_ERROR"`.
-     *
-     * In contrast, `type` is more general and categorizes the error.
-     */
-    code;
-    /**
-     * The HTTP status code of the response that included the error.
-     */
-    httpStatusCode;
-    /**
-     * The unique error code supplied by the third-party integration for errors
-     * returned by the integration (i.e., `ConductorIntegrationError`) or
-     * integration connector (i.e., `ConductorIntegrationConnectorError`). This is
-     * useful for adding special handling for specific errors from the third-party
-     * integration or connector.
-     *
-     * The integration's corresponding error message for this code is in
-     * `error.message`.
-     *
-     * The third-party integrations' error codes are not standardized, so you
-     * should not rely on this code to be the same across integrations.
-     */
-    integrationCode;
-    /**
-     * The unique request identifier of the API request that caused the error.
-     *
-     * If you need to contact us about a specific request, providing the request
-     * identifier will ensure the fastest possible resolution.
-     */
-    requestId;
-    /**
-     * The HTTP headers of the response that included the error.
-     */
-    headers;
-    /**
-     * The raw REST error response that Conductor's API returned.
-     */
-    raw;
-    /**
-     * Conductor's internal representation of `type` for debugging.
-     */
-    rawType;
-    constructor(options) {
-        // Do not pass `options.message` to the superclass `Error` constructor to
-        // avoid this bug: https://twitter.com/DannyNemer/status/1639513810141687810
-        super();
-        // Set `name` to the constructor name so that the error appears in logs as
-        // `[ConductorError: foo]` instead of `[Error: foo]`.
-        this.name = this.constructor.name;
-        // 1. Set `type`, even though it's redundant with `name`, because `name`
-        //    does not appear when doing `console.log(error)` unlike all other
-        //    properties we set.
-        // 2. Set `type` to the constructor name to ensure that subclasses of
-        //    `ConductorError` always have the correct `type` even if they are
-        //    instantiated with the wrong options.
-        this.type = this.constructor.name;
-        this.message = options.message;
-        this.userFacingMessage =
-            options.userFacingMessage ?? exports.DEFAULT_USER_FACING_MESSAGE;
-        this.code = options.code;
-        this.httpStatusCode = options.httpStatusCode;
-        this.integrationCode = options.integrationCode;
-        this.requestId = options.requestId;
-        this.headers = options.headers;
-        // Only set `raw` if provided instead of always setting it to `options`
-        // because the latter is usually a near duplicate of `this`, which we don't
-        // want to log unless necessary.
-        this.raw = options.raw;
-        this.rawType = options.type;
-    }
-}
-exports.ConductorError = ConductorError;
-/**
- * Raised when the third-party integration encounters an error while processing
- * the end-user's request. This often results from an issue with the request or
- * data handling that requires your attention to resolve.
- *
- * E.g., a `ListID` you provided was not found in QuickBooks Desktop, or an
- * accounting value you supplied did not adhere to the integration's accounting
- * rules.
- *
- * Refer to `error.integrationCode` for the error code returned by the
- * integration, if available.
- */
-class ConductorIntegrationError extends ConductorError {
-    static rawType = "INTEGRATION_ERROR";
-    constructor(options) {
-        super({ ...options, type: ConductorIntegrationError.rawType });
-    }
-}
-exports.ConductorIntegrationError = ConductorIntegrationError;
-/**
- * Raised when a connection error occurs with the third-party integration on the
- * end-user's side. This typically indicates an issue with the end-user's
- * IntegrationConnection or configuration, which they must resolve. In other
- * words, you cannot take action to fix these errors.
- *
- * E.g., QuickBooks Web Connector (QBWC) failed to connect to QuickBooks Desktop
- * on the end-user's computer.
- *
- * Refer to `error.integrationCode` for the error code returned by the
- * integration connector, if available.
- *
- * ❗ We recommend _not_ triggering alerts for these errors because only the
- * end-user can fix them.
- */
-class ConductorIntegrationConnectionError extends ConductorError {
-    static rawType = "INTEGRATION_CONNECTION_ERROR";
-    constructor(options) {
-        super({ ...options, type: ConductorIntegrationConnectionError.rawType });
-    }
-}
-exports.ConductorIntegrationConnectionError = ConductorIntegrationConnectionError;
-/**
- * Raised when you make an API call with the wrong parameters, in the wrong
- * state, or in an invalid way.
- */
-class ConductorInvalidRequestError extends ConductorError {
-    static rawType = "INVALID_REQUEST_ERROR";
-    constructor(options) {
-        super({ ...options, type: ConductorInvalidRequestError.rawType });
-    }
-}
-exports.ConductorInvalidRequestError = ConductorInvalidRequestError;
-/**
- * Raised when Conductor cannot authenticate you with the credentials you
- * provided. E.g., an incorrect API key.
- */
-class ConductorAuthenticationError extends ConductorError {
-    static rawType = "AUTHENTICATION_ERROR";
-    constructor(options) {
-        super({ ...options, type: ConductorAuthenticationError.rawType });
-    }
-}
-exports.ConductorAuthenticationError = ConductorAuthenticationError;
-/**
- * Raised when you attempt to access a resource that is not allowed.
- */
-class ConductorPermissionError extends ConductorError {
-    static rawType = "PERMISSION_ERROR";
-    constructor(options) {
-        super({ ...options, type: ConductorPermissionError.rawType });
-    }
-}
-exports.ConductorPermissionError = ConductorPermissionError;
-/**
- * Raised when there was a network problem between the client (on your server)
- * and Conductor's servers. E.g., a downed network or a bad TLS certificate.
- */
-class ConductorConnectionError extends ConductorError {
-    static rawType = "CONNECTION_ERROR";
-    constructor(options) {
-        super({ ...options, type: ConductorConnectionError.rawType });
-    }
-}
-exports.ConductorConnectionError = ConductorConnectionError;
-/**
- * Raised when something went wrong on Conductor's end. (These are rare.)
- */
-class ConductorInternalError extends ConductorError {
-    static rawType = "INTERNAL_ERROR";
-    constructor(options) {
-        super({ ...options, type: ConductorInternalError.rawType });
-    }
-}
-exports.ConductorInternalError = ConductorInternalError;
-/**
- * Raised as a fallback for any other error from Conductor that no other error
- * type captures.
- */
-class ConductorUnknownError extends ConductorError {
-    // Override the `protected` constructor in the base class even though we are
-    // not overriding `rawType`.
-    constructor(options) {
-        super(options);
-    }
-}
-exports.ConductorUnknownError = ConductorUnknownError;
-function generateConductorErrorFromType(options) {
-    switch (options.type) {
-        case ConductorIntegrationError.rawType: {
-            return new ConductorIntegrationError(options);
-        }
-        case ConductorIntegrationConnectionError.rawType: {
-            return new ConductorIntegrationConnectionError(options);
-        }
-        case ConductorInvalidRequestError.rawType: {
-            return new ConductorInvalidRequestError(options);
-        }
-        case ConductorAuthenticationError.rawType: {
-            return new ConductorAuthenticationError(options);
-        }
-        case ConductorPermissionError.rawType: {
-            return new ConductorPermissionError(options);
-        }
-        case ConductorConnectionError.rawType: {
-            return new ConductorConnectionError(options);
-        }
-        case ConductorInternalError.rawType: {
-            return new ConductorInternalError(options);
-        }
-        default: {
-            return new ConductorUnknownError(options);
-        }
-    }
-}