conductor-node 11.10.1 → 12.0.0-beta.10

package/dist/src/integrations/qbd/qbdTypes.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/interceptors/errorHandling.d.ts

@@ -1,2 +0,0 @@
-import type { AxiosInstance } from "axios";
-export declare function addErrorHandlingInterceptors(httpClient: AxiosInstance): void;

package/dist/src/interceptors/errorHandling.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addErrorHandlingInterceptors = addErrorHandlingInterceptors;
-const error_1 = require("../utils/error");
-const axios_1 = require("axios");
-function addErrorHandlingInterceptors(httpClient) {
-    httpClient.interceptors.response.use((response) => response, (error) => {
-        // The request was made and the server responded with a status code that
-        // falls out of the range of 2xx.
-        if (error.response) {
-            const headers = { ...error.response.headers };
-            const errorData = error.response.data;
-            if ((0, error_1.isWellFormedConductorServerError)(errorData)) {
-                throw (0, error_1.generateConductorErrorFromType)({
-                    // The request ID is already in the response body, so no need to
-                    // copy it from the headers.
-                    ...errorData.error,
-                    httpStatusCode: error.response.status,
-                    headers,
-                });
-            }
-            throw new error_1.ConductorInternalError({
-                message: "Invalid JSON received from the Conductor API.",
-                code: "INVALID_JSON_RESPONSE",
-                httpStatusCode: error.status ?? axios_1.HttpStatusCode.InternalServerError,
-                // @ts-expect-error -- `error.response.headers` always exists as an `AxiosHeaders` instance.
-                requestId: error.response.headers.get("Conductor-Request-Id"),
-                headers,
-                // Help debug if `isWellFormedConductorServerError()` fails.
-                raw: errorData,
-            });
-        }
-        if (error.code === axios_1.AxiosError.ECONNABORTED) {
-            let message = "Request aborted due to timeout being reached";
-            if (error.config?.timeout !== undefined) {
-                message += ` (${error.config.timeout}ms)`;
-            }
-            throw new error_1.ConductorConnectionError({
-                message,
-                code: error.code,
-                httpStatusCode: error.status ?? axios_1.HttpStatusCode.RequestTimeout,
-            });
-        }
-        // Either the request was made but no response was received (e.g.,
-        // Conductor API is offline) or an error ocurred when setting up the
-        // request (e.g., no network connection).
-        throw new error_1.ConductorConnectionError({
-            message: `An error occurred with our connection to Conductor: ${error.message === "" ? error.code : error.message}`,
-            code: error.code ?? "NETWORK_ERROR",
-            httpStatusCode: error.status,
-        });
-    });
-}

package/dist/src/interceptors/logging.d.ts

@@ -1,18 +0,0 @@
-import type { AxiosInstance, AxiosRequestConfig } from "axios";
-export interface RequestConfigWithStartTime extends AxiosRequestConfig {
-    startTime: number;
-}
-export declare function addLoggingInterceptors(httpClient: AxiosInstance, verbose: boolean): void;
-interface RequestLogObject {
-    method?: string;
-    url?: string;
-    headers?: {
-        "Content-Type"?: string;
-        Authorization?: string;
-    };
-    body?: Record<string, unknown>;
-}
-export declare function createRequestLogObject(config: AxiosRequestConfig): RequestLogObject;
-export declare function getDurationStringFromConfig(config: RequestConfigWithStartTime): string;
-export declare function stringifyForLogs(object: unknown): string;
-export {};

package/dist/src/interceptors/logging.js

@@ -1,70 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addLoggingInterceptors = addLoggingInterceptors;
-exports.createRequestLogObject = createRequestLogObject;
-exports.getDurationStringFromConfig = getDurationStringFromConfig;
-exports.stringifyForLogs = stringifyForLogs;
-function addLoggingInterceptors(httpClient, verbose) {
-    httpClient.interceptors.request.use((config) => {
-        if (verbose) {
-            config.startTime = Date.now();
-            console.log("Conductor request:", stringifyForLogs(createRequestLogObject(config)));
-        }
-        return config;
-    });
-    httpClient.interceptors.response.use((response) => {
-        if (verbose) {
-            console.log("Conductor response:", stringifyForLogs(createResponseLogObject(response)));
-        }
-        return response;
-    }, (error) => {
-        // Log after the other interceptor wraps the response error in a
-        // `ConductorError`.
-        // NOTE: We cannot include duration because we lack access to
-        // `AxiosError#config` because we already wrapped the error.
-        if (verbose) {
-            // No prefix "Conductor error:" because the error already includes a
-            // prefix (e.g., `ConductorConnectionError`).
-            console.log(stringifyForLogs(error));
-        }
-        throw error;
-    });
-}
-function createRequestLogObject(config) {
-    const requestInfo = {};
-    if (config.method !== undefined) {
-        requestInfo.method = config.method.toUpperCase();
-    }
-    if (config.baseURL !== undefined || config.url !== undefined) {
-        requestInfo.url = (config.baseURL ?? "") + (config.url ?? "");
-    }
-    if (config.data !== undefined) {
-        requestInfo.body = config.data;
-    }
-    if (config.headers !== undefined) {
-        requestInfo.headers = {};
-        if (config.headers["Content-Type"] !== undefined) {
-            requestInfo.headers["Content-Type"] = config.headers["Content-Type"];
-        }
-        if (config.headers.Authorization !== undefined) {
-            requestInfo.headers.Authorization = "BEARER sk_live_************";
-        }
-    }
-    return requestInfo;
-}
-function createResponseLogObject(response) {
-    return {
-        duration: getDurationStringFromConfig(response.config),
-        status: response.status,
-        data: response.data,
-        request: createRequestLogObject(response.config),
-    };
-}
-function getDurationStringFromConfig(config) {
-    const duration = Date.now() - config.startTime;
-    return `${Math.round(duration / 10) / 100}s`;
-}
-function stringifyForLogs(object) {
-    // Output raw JSON for easy copy-pasting for REST API development.
-    return JSON.stringify(object, undefined, 2);
-}

package/dist/src/resources/AuthSessionsResource.d.ts

@@ -1,77 +0,0 @@
-import BaseResource from "../resources/BaseResource";
-export interface AuthSession {
-    /**
-     * The unique identifier for the object.
-     */
-    readonly id: string;
-    /**
-     * The object's type. This will always be "auth_session".
-     */
-    readonly objectType: "auth_session";
-    /**
-     * The date and time when this object was created.
-     */
-    readonly createdAt: string;
-    /**
-     * The ID of the EndUser for whom to create an IntegrationConnection.
-     */
-    readonly endUserId: string;
-    /**
-     * The secret used in `authFlowUrl` to securely access the authentication
-     * flow.
-     */
-    readonly clientSecret: string;
-    /**
-     * The URL of the authentication flow that you will pass to your client for
-     * your end-user to set up their IntegrationConnection.
-     */
-    readonly authFlowUrl: string;
-    /**
-     * The time at which the AuthSession expires. By default, this value is 30
-     * minutes from creation. You can extend this time by setting `linkExpiryMins`
-     * when creating the AuthSession.
-     */
-    readonly expiresAt: string;
-    /**
-     * The URL to which Conductor will redirect the user to return to your app
-     * after they complete the authentication flow. If `undefined`, their browser
-     * tab will close instead.
-     */
-    readonly redirectUrl: string | undefined;
-}
-export interface AuthSessionCreateInput {
-    /**
-     * Your Conductor publishable key, which we use to create the session's
-     * `authFlowUrl`.
-     */
-    readonly publishableKey: string;
-    /**
-     * The ID of the EndUser for whom to create the IntegrationConnection.
-     */
-    readonly endUserId: string;
-    /**
-     * The number of minutes after which the AuthSession will expire. Must be at
-     * least 15 minutes and no more than 7 days. If not provided, defaults to 30
-     * minutes.
-     */
-    readonly linkExpiryMins?: number;
-    /**
-     * The URL to which Conductor will redirect the end-user to return to your app
-     * after they complete the authentication flow. If not provided, their browser
-     * tab will close instead.
-     */
-    readonly redirectUrl?: string;
-}
-export default class AuthSessionsResource extends BaseResource {
-    protected readonly ROUTE = "/auth-sessions";
-    /**
-     * Creates an AuthSession. Pass the returned session’s `authFlowUrl` to the
-     * client for your end-user to launch the IntegrationConnection authentication
-     * flow.
-     */
-    create(input: AuthSessionCreateInput): Promise<AuthSession>;
-    /**
-     * Retrieves the specified AuthSession.
-     */
-    retrieve(id: AuthSession["id"]): Promise<AuthSession>;
-}

package/dist/src/resources/AuthSessionsResource.js

@@ -1,26 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const BaseResource_1 = __importDefault(require("../resources/BaseResource"));
-class AuthSessionsResource extends BaseResource_1.default {
-    ROUTE = "/auth-sessions";
-    /**
-     * Creates an AuthSession. Pass the returned session’s `authFlowUrl` to the
-     * client for your end-user to launch the IntegrationConnection authentication
-     * flow.
-     */
-    async create(input) {
-        const { data } = await this.httpClient.post(this.ROUTE, input);
-        return data;
-    }
-    /**
-     * Retrieves the specified AuthSession.
-     */
-    async retrieve(id) {
-        const { data } = await this.httpClient.get(`${this.ROUTE}/${id}`);
-        return data;
-    }
-}
-exports.default = AuthSessionsResource;

package/dist/src/resources/BaseResource.d.ts

@@ -1,6 +0,0 @@
-import type { AxiosInstance } from "axios";
-export default abstract class BaseResource {
-    protected readonly httpClient: AxiosInstance;
-    protected abstract readonly ROUTE: string;
-    constructor(httpClient: AxiosInstance);
-}

package/dist/src/resources/BaseResource.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class BaseResource {
-    httpClient;
-    constructor(httpClient) {
-        this.httpClient = httpClient;
-    }
-}
-exports.default = BaseResource;

package/dist/src/resources/EndUsersResource.d.ts

@@ -1,84 +0,0 @@
-import BaseResource from "../resources/BaseResource";
-import type { ApiListResponse, IntegrationConnection, IntegrationSlug } from "../resources/types";
-export interface EndUser {
-    /**
-     * The unique identifier for this EndUser. You must save this value to your
-     * database because it is how you identify the target of your requests in the
-     * future.
-     */
-    readonly id: string;
-    /**
-     * The object's type. This will always be "end_user".
-     */
-    readonly objectType: "end_user";
-    /**
-     * The time at which the object was created.
-     */
-    readonly createdAt: string;
-    /**
-     * The EndUser's company name that will be shown elsewhere in Conductor.
-     */
-    readonly companyName: string;
-    /**
-     * The EndUser's unique identifier from your system. Maps users between your
-     * database and Conductor. Must be unique for each user. If you have only one
-     * user, you may use any string value.
-     */
-    readonly sourceId: string;
-    /**
-     * The EndUser's email address for identification purposes. Setting this field
-     * will not cause any emails to be sent.
-     */
-    readonly email: string;
-    /**
-     * The EndUser's IntegrationConnections.
-     */
-    readonly integrationConnections: IntegrationConnection[];
-}
-export type EndUserCreateInput = Pick<EndUser, "companyName" | "email" | "sourceId">;
-export interface EndUserDeleteOutput {
-    readonly id: EndUser["id"];
-    readonly objectType: EndUser["objectType"];
-    readonly deleted: boolean;
-}
-export interface EndUserPingOutput {
-    /**
-     * The time, in milliseconds, that it took to ping the connection.
-     */
-    readonly duration: number;
-}
-export default class EndUsersResource extends BaseResource {
-    protected readonly ROUTE = "/end-users";
-    /**
-     * Returns a list of your EndUsers.
-     */
-    list(): Promise<ApiListResponse<EndUser>>;
-    /**
-     * Creates a new EndUser.
-     */
-    create(input: EndUserCreateInput): Promise<EndUser>;
-    /**
-     * Retrieves the specified EndUser.
-     */
-    retrieve(id: EndUser["id"]): Promise<EndUser>;
-    /**
-     * Deletes the specified EndUser and all of its connections.
-     */
-    delete(id: EndUser["id"]): Promise<EndUserDeleteOutput>;
-    /**
-     * Checks whether the specified IntegrationConnection can connect and process
-     * requests end-to-end.
-     *
-     * If the connection fails, the error we encountered will be thrown as a
-     * `ConductorError` (like any request). This information is useful for showing
-     * a "connection status" indicator in your app. If an error occurs, we
-     * strongly recommend displaying the property `error.userFacingMessage` to
-     * your end-user in your app's UI.
-     *
-     * @param id The ID of the end-user to ping.
-     * @param integrationSlug The integration identifier for the end-user's
-     * connection you want to ping (e.g. "quickbooks_desktop").
-     * @returns The ping result with the duration in milliseconds.
-     */
-    ping(id: EndUser["id"], integrationSlug: IntegrationSlug): Promise<EndUserPingOutput>;
-}

package/dist/src/resources/EndUsersResource.js

@@ -1,57 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const BaseResource_1 = __importDefault(require("../resources/BaseResource"));
-class EndUsersResource extends BaseResource_1.default {
-    ROUTE = "/end-users";
-    /**
-     * Returns a list of your EndUsers.
-     */
-    async list() {
-        const { data } = await this.httpClient.get(this.ROUTE);
-        return data;
-    }
-    /**
-     * Creates a new EndUser.
-     */
-    async create(input) {
-        const { data } = await this.httpClient.post(this.ROUTE, input);
-        return data;
-    }
-    /**
-     * Retrieves the specified EndUser.
-     */
-    async retrieve(id) {
-        const { data } = await this.httpClient.get(`${this.ROUTE}/${id}`);
-        return data;
-    }
-    /**
-     * Deletes the specified EndUser and all of its connections.
-     */
-    async delete(id) {
-        const { data } = await this.httpClient.delete(`${this.ROUTE}/${id}`);
-        return data;
-    }
-    /**
-     * Checks whether the specified IntegrationConnection can connect and process
-     * requests end-to-end.
-     *
-     * If the connection fails, the error we encountered will be thrown as a
-     * `ConductorError` (like any request). This information is useful for showing
-     * a "connection status" indicator in your app. If an error occurs, we
-     * strongly recommend displaying the property `error.userFacingMessage` to
-     * your end-user in your app's UI.
-     *
-     * @param id The ID of the end-user to ping.
-     * @param integrationSlug The integration identifier for the end-user's
-     * connection you want to ping (e.g. "quickbooks_desktop").
-     * @returns The ping result with the duration in milliseconds.
-     */
-    async ping(id, integrationSlug) {
-        const { data } = await this.httpClient.get(`${this.ROUTE}/${id}/ping/${integrationSlug}`);
-        return data;
-    }
-}
-exports.default = EndUsersResource;

package/dist/src/resources/types.d.ts

@@ -1,40 +0,0 @@
-export type IntegrationSlug = "quickbooks_desktop";
-export interface IntegrationConnection {
-    /**
-     * The unique identifier for the object.
-     */
-    readonly id: string;
-    /**
-     * The object's type. This will always be "integration_connection".
-     */
-    readonly objectType: "integration_connection";
-    /**
-     * The time at which the object was created.
-     */
-    readonly createdAt: string;
-    /**
-     * The ID of the EndUser who owns this IntegrationConnection.
-     */
-    readonly endUserId: string;
-    /**
-     * The identifier of the third-party platform to integrate (e.g.,
-     * "quickbooks_desktop").
-     */
-    readonly integrationSlug: IntegrationSlug;
-    /**
-     * The date and time of your last API request to this IntegrationConnection.
-     */
-    readonly lastRequestAt: string | null;
-    /**
-     * The date and time of your last *successful* API request to this
-     * IntegrationConnection. This represents an end-to-end request that the
-     * integration fully processed and returned without any connection or business
-     * logic errors.
-     */
-    readonly lastSuccessfulRequestAt: string | null;
-}
-export interface ApiListResponse<T> {
-    readonly url: string;
-    readonly objectType: "list";
-    readonly data: T[];
-}

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

@@ -1,2 +0,0 @@
-export declare function checkForUpdates(): void;
-export declare function createFramedMessage(messageLines: string[]): string;

package/dist/src/utils/checkForUpdates.js

@@ -1,65 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkForUpdates = checkForUpdates;
-exports.createFramedMessage = createFramedMessage;
-const package_json_1 = __importDefault(require("../../package.json"));
-const env_1 = require("../utils/env");
-const axios_1 = __importDefault(require("axios"));
-function checkForUpdates() {
-    // eslint-disable-next-line @typescript-eslint/dot-notation -- ESLint is incorrectly following the global type modification that `next` makes in other packages of this monorepo where it is a dependency. TypeScript correctly limits the scope of this `next` type modification to only the packages where `next` is a dependency. ESLint does not; hence, we disable this rule here.
-    if (process.env["NODE_ENV"] === "test") {
-        return;
-    }
-    // `CONDUCTOR_HIDE_UPDATE_MESSAGE` hides the update message that is logged
-    // when a newer version of `conductor-node` is available. It's a truthy value.
-    if ((0, env_1.isEnvironmentVariableTruthy)("CONDUCTOR_HIDE_UPDATE_MESSAGE")) {
-        return;
-    }
-    const currentVersion = package_json_1.default.version;
-    const packageName = encodeURIComponent(package_json_1.default.name);
-    axios_1.default
-        .get(`https://registry.npmjs.org/-/package/${packageName}/dist-tags`)
-        .then((response) => {
-        const latestVersion = response.data.latest;
-        if (currentVersion !== latestVersion) {
-            console.warn(createFramedMessage([
-                "🚨 MAJOR UPDATE AVAILABLE! 🚨",
-                `${currentVersion} ➡️ ${latestVersion}`,
-                "",
-                "✨ This is an entirely new SDK with amazing improvements:",
-                "• 📄 Automatic pagination",
-                "• 🔄 Automatic retry",
-                "• 🎯 Significantly improved naming",
-                "• 🏗️ Simplified structure",
-                "",
-                "⚠️ While your current version will continue to work,",
-                "it will not receive any more updates.",
-                "",
-                "🔥 UPGRADE GUIDE 🔥",
-                "→ https://docs.conductor.is/qbd-api/upgrade-node ←",
-            ]));
-        }
-    })
-        .catch((error) => {
-        console.debug("Failed to check for updates:", error);
-    });
-}
-function createFramedMessage(messageLines) {
-    const maxLength = Math.max(...messageLines.map((line) => line.length), 0);
-    const paddingHorizontalLength = 2;
-    return [
-        // Top border of the box.
-        `┌${"─".repeat(maxLength + paddingHorizontalLength * 2)}┐`,
-        // Print each line of the message, padded to fit the box.
-        ...messageLines.map((line) => {
-            const paddingLine = " ".repeat(maxLength - line.length);
-            const paddingHorizontal = " ".repeat(paddingHorizontalLength);
-            return `│${paddingHorizontal}${line}${paddingLine}${paddingHorizontal}│`;
-        }),
-        // Bottom border of the box.
-        `└${"─".repeat(maxLength + paddingHorizontalLength * 2)}┘`,
-    ].join("\n");
-}

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

@@ -1 +0,0 @@
-export declare function isEnvironmentVariableTruthy(name: string): boolean;

package/dist/src/utils/env.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isEnvironmentVariableTruthy = isEnvironmentVariableTruthy;
-const FALSY_VALUES = new Set([
-    undefined,
-    "",
-    "null",
-    "undefined",
-    "false",
-    "0",
-]);
-function isEnvironmentVariableTruthy(name) {
-    const value = process.env[name]?.toLowerCase();
-    return !FALSY_VALUES.has(value);
-}