@hubspot/local-dev-lib 1.13.1 → 2.0.1

package/errors/apiErrors.js

@@ -1,176 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.throwApiUploadError = exports.throwApiError = exports.getAxiosErrorWithContext = exports.parseValidationErrors = exports.isSpecifiedHubSpotAuthError = exports.isApiUploadValidationError = exports.isTimeoutError = exports.isGatingError = exports.isMissingScopeError = exports.isSpecifiedError = void 0;
-const axios_1 = require("axios");
-const api_1 = require("../constants/api");
-const lang_1 = require("../utils/lang");
-const standardErrors_1 = require("./standardErrors");
-const HubSpotAuthError_1 = require("../models/HubSpotAuthError");
-const i18nKey = 'errors.apiErrors';
-function isSpecifiedError(err, { statusCode, category, subCategory, errorType, code, }) {
-    if (!(err instanceof Error)) {
-        return false;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const error = (err && err.cause) || err;
-    const statusCodeErr = !statusCode || error.response?.status === statusCode;
-    const categoryErr = !category || error.response?.data?.category === category;
-    const subCategoryErr = !subCategory || error.response?.data?.subCategory === subCategory;
-    const errorTypeErr = !errorType || error.response?.data?.errorType === errorType;
-    const codeError = !code || error.code === code;
-    return (error.isAxiosError &&
-        statusCodeErr &&
-        categoryErr &&
-        subCategoryErr &&
-        errorTypeErr &&
-        codeError);
-}
-exports.isSpecifiedError = isSpecifiedError;
-function isMissingScopeError(err) {
-    return isSpecifiedError(err, { statusCode: 403, category: 'MISSING_SCOPES' });
-}
-exports.isMissingScopeError = isMissingScopeError;
-function isGatingError(err) {
-    return isSpecifiedError(err, { statusCode: 403, category: 'GATED' });
-}
-exports.isGatingError = isGatingError;
-function isTimeoutError(err) {
-    return isSpecifiedError(err, { code: 'ETIMEDOUT' });
-}
-exports.isTimeoutError = isTimeoutError;
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function isApiUploadValidationError(err) {
-    return ((0, axios_1.isAxiosError)(err) &&
-        (err.status === 400 || err.response?.status === 400) &&
-        !!err.response &&
-        !!(err.response?.data?.message || !!err.response?.data?.errors));
-}
-exports.isApiUploadValidationError = isApiUploadValidationError;
-function isSpecifiedHubSpotAuthError(err, { status, category, subCategory }) {
-    if (!err || !(err instanceof HubSpotAuthError_1.HubSpotAuthError)) {
-        return false;
-    }
-    const statusCodeErr = !status || err.status === status;
-    const categoryErr = !category || err.category === category;
-    const subCategoryErr = !subCategory || err.subCategory === subCategory;
-    return Boolean(statusCodeErr && categoryErr && subCategoryErr);
-}
-exports.isSpecifiedHubSpotAuthError = isSpecifiedHubSpotAuthError;
-function parseValidationErrors(responseData = { errors: [], message: '' }) {
-    const errorMessages = [];
-    const { errors, message } = responseData;
-    if (message) {
-        errorMessages.push(message);
-    }
-    if (errors) {
-        const specificErrors = errors.map(error => {
-            let errorMessage = error.message;
-            if (error.errorTokens && error.errorTokens.line) {
-                errorMessage = `line ${error.errorTokens.line}: ${errorMessage}`;
-            }
-            return errorMessage;
-        });
-        errorMessages.push(...specificErrors);
-    }
-    return errorMessages;
-}
-exports.parseValidationErrors = parseValidationErrors;
-/**
- * @throws
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function throwValidationError(error) {
-    const validationErrorMessages = parseValidationErrors(error?.response?.data);
-    if (validationErrorMessages.length) {
-        return new Error(validationErrorMessages.join(' '), { cause: error });
-    }
-}
-function getAxiosErrorWithContext(
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-error, context = {}) {
-    const status = error.response?.status;
-    const method = error.config?.method;
-    let messageDetail;
-    if (context.accountId) {
-        const action = (method && api_1.HTTP_METHOD_VERBS[method]) || api_1.HTTP_METHOD_VERBS.get;
-        const preposition = (method && api_1.HTTP_METHOD_PREPOSITIONS[method]) ||
-            api_1.HTTP_METHOD_PREPOSITIONS.get;
-        const requestName = context.request
-            ? `${action} ${preposition} '${context.request}'`
-            : action;
-        messageDetail = (0, lang_1.i18n)(`${i18nKey}.messageDetail`, {
-            accountId: context.accountId,
-            requestName,
-        });
-    }
-    else {
-        messageDetail = (0, lang_1.i18n)(`${i18nKey}.genericMessageDetail`);
-    }
-    const errorMessage = [];
-    if ((method === 'put' || method === 'post') && context.payload) {
-        errorMessage.push((0, lang_1.i18n)(`${i18nKey}.unableToUpload`, { payload: context.payload }));
-    }
-    switch (status) {
-        case 400:
-            errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.400`, { messageDetail }));
-            break;
-        case 401:
-            errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.401`, { messageDetail }));
-            break;
-        case 403:
-            errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.403`, { messageDetail }));
-            break;
-        case 404:
-            errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.404`, { messageDetail }));
-            break;
-        case 429:
-            errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.429`, { messageDetail }));
-            break;
-        case 503:
-            errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.503`, { messageDetail }));
-            break;
-        default:
-            if (status && status >= 500 && status < 600) {
-                errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.500Generic`, { messageDetail }));
-            }
-            else if (status && status >= 400 && status < 500) {
-                errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.400Generic`, { messageDetail }));
-            }
-            else {
-                errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.generic`, { messageDetail }));
-            }
-            break;
-    }
-    if (error?.response?.data) {
-        const { message, errors } = error.response.data;
-        if (message) {
-            errorMessage.push(message);
-        }
-        if (errors) {
-            errors.forEach((err) => {
-                if (err.message) {
-                    errorMessage.push('\n- ' + err.message);
-                }
-            });
-        }
-    }
-    return new Error(errorMessage.join(' '), { cause: error });
-}
-exports.getAxiosErrorWithContext = getAxiosErrorWithContext;
-/**
- * @throws
- */
-function throwApiError(error, context = {}) {
-    if ((0, axios_1.isAxiosError)(error)) {
-        throw getAxiosErrorWithContext(error, context);
-    }
-    (0, standardErrors_1.throwError)(error);
-}
-exports.throwApiError = throwApiError;
-function throwApiUploadError(error, context = {}) {
-    if (isApiUploadValidationError(error)) {
-        throwValidationError(error);
-    }
-    throwApiError(error, context);
-}
-exports.throwApiUploadError = throwApiUploadError;

package/errors/fileSystemErrors.d.ts

@@ -1,6 +0,0 @@
-import { FileSystemErrorContext } from '../types/Error';
-export declare function getFileSystemError(error: unknown, context: FileSystemErrorContext): Error;
-/**
- * @throws
- */
-export declare function throwFileSystemError(error: unknown, context: FileSystemErrorContext): void;

package/errors/fileSystemErrors.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.throwFileSystemError = exports.getFileSystemError = void 0;
-const lang_1 = require("../utils/lang");
-const standardErrors_1 = require("./standardErrors");
-const i18nKey = 'errors.fileSystemErrors';
-function getFileSystemError(error, context) {
-    let fileAction = '';
-    if (context.read) {
-        fileAction = (0, lang_1.i18n)(`${i18nKey}.readAction`);
-    }
-    else if (context.write) {
-        fileAction = (0, lang_1.i18n)(`${i18nKey}.writeAction`);
-    }
-    else {
-        fileAction = (0, lang_1.i18n)(`${i18nKey}.otherAction`);
-    }
-    const filepath = context.filepath
-        ? `"${context.filepath}"`
-        : (0, lang_1.i18n)(`${i18nKey}.unknownFilepath`);
-    const message = [(0, lang_1.i18n)(`${i18nKey}.baseMessage`, { fileAction, filepath })];
-    // Many `fs` errors will be `SystemError`s
-    if ((0, standardErrors_1.isSystemError)(error)) {
-        message.push((0, lang_1.i18n)(`${i18nKey}.baseMessage`, { errorMessage: error.message }));
-    }
-    return new Error(message.join(' '), { cause: error });
-}
-exports.getFileSystemError = getFileSystemError;
-/**
- * @throws
- */
-function throwFileSystemError(error, context) {
-    throw getFileSystemError(error, context);
-}
-exports.throwFileSystemError = throwFileSystemError;

package/errors/standardErrors.d.ts

@@ -1,20 +0,0 @@
-import { BaseError } from '../types/Error';
-import { LangKey } from '../types/Lang';
-export declare function isSystemError(err: unknown): err is BaseError;
-export declare function isFatalError(err: unknown): err is BaseError;
-/**
- * @throws
- */
-export declare function throwErrorWithMessage(identifier: LangKey, interpolation?: {
-    [key: string]: string | number;
-}, cause?: unknown): never;
-/**
- * @throws
- */
-export declare function throwAuthErrorWithMessage(identifier: LangKey, interpolation?: {
-    [key: string]: string | number;
-}, cause?: unknown): never;
-/**
- * @throws
- */
-export declare function throwError(error: unknown): never;

package/errors/standardErrors.js

@@ -1,62 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.throwError = exports.throwAuthErrorWithMessage = exports.throwErrorWithMessage = exports.isFatalError = exports.isSystemError = void 0;
-const HubSpotAuthError_1 = require("../models/HubSpotAuthError");
-const lang_1 = require("../utils/lang");
-function isSystemError(err) {
-    return (err instanceof Error &&
-        'errno' in err &&
-        err.errno != null &&
-        'code' in err &&
-        err.code != null &&
-        'syscall' in err &&
-        err.syscall != null);
-}
-exports.isSystemError = isSystemError;
-function isFatalError(err) {
-    return err instanceof HubSpotAuthError_1.HubSpotAuthError;
-}
-exports.isFatalError = isFatalError;
-function genericThrowErrorWithMessage(ErrorType, identifier, interpolation, cause) {
-    const message = (0, lang_1.i18n)(identifier, interpolation);
-    if (cause) {
-        throw new ErrorType(message, { cause });
-    }
-    throw new ErrorType(message);
-}
-/**
- * @throws
- */
-function throwErrorWithMessage(identifier, interpolation, cause) {
-    genericThrowErrorWithMessage(Error, identifier, interpolation, cause);
-}
-exports.throwErrorWithMessage = throwErrorWithMessage;
-/**
- * @throws
- */
-function throwAuthErrorWithMessage(identifier, interpolation, cause) {
-    genericThrowErrorWithMessage(
-    // @ts-expect-error HubSpotAuthError is not callable
-    HubSpotAuthError_1.HubSpotAuthError, identifier, interpolation, cause);
-}
-exports.throwAuthErrorWithMessage = throwAuthErrorWithMessage;
-/**
- * @throws
- */
-function throwError(error) {
-    if (!(error instanceof Error)) {
-        throw new Error('', { cause: error });
-    }
-    // Error or Error subclass
-    const message = error.name && error.name !== 'Error'
-        ? [(0, lang_1.i18n)('errors.generic', { name: error.name })]
-        : [];
-    if (error.message) {
-        message.push(error.message);
-    }
-    if ('reason' in error && error.reason) {
-        message.push(error.reason);
-    }
-    throw new Error(message.join(' '), { cause: error });
-}
-exports.throwError = throwError;

package/lib/developerTestAccounts.d.ts

@@ -1,4 +0,0 @@
-import { DeveloperTestAccount, FetchDeveloperTestAccountsResponse } from '../types/developerTestAccounts';
-export declare function createDeveloperTestAccount(accountId: number, accountName: string): Promise<DeveloperTestAccount>;
-export declare function deleteDeveloperTestAccount(accountId: number, testAccountId: number): Promise<void>;
-export declare function fetchDeveloperTestAccounts(accountId: number): Promise<FetchDeveloperTestAccountsResponse>;

package/lib/developerTestAccounts.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchDeveloperTestAccounts = exports.deleteDeveloperTestAccount = exports.createDeveloperTestAccount = void 0;
-const developerTestAccounts_1 = require("../api/developerTestAccounts");
-const apiErrors_1 = require("../errors/apiErrors");
-async function createDeveloperTestAccount(accountId, accountName) {
-    try {
-        const resp = await (0, developerTestAccounts_1.createDeveloperTestAccount)(accountId, accountName);
-        return resp;
-    }
-    catch (err) {
-        (0, apiErrors_1.throwApiError)(err);
-    }
-}
-exports.createDeveloperTestAccount = createDeveloperTestAccount;
-async function deleteDeveloperTestAccount(accountId, testAccountId) {
-    try {
-        const resp = await (0, developerTestAccounts_1.deleteDeveloperTestAccount)(accountId, testAccountId);
-        return resp;
-    }
-    catch (err) {
-        (0, apiErrors_1.throwApiError)(err);
-    }
-}
-exports.deleteDeveloperTestAccount = deleteDeveloperTestAccount;
-async function fetchDeveloperTestAccounts(accountId) {
-    try {
-        const resp = await (0, developerTestAccounts_1.fetchDeveloperTestAccounts)(accountId);
-        return resp;
-    }
-    catch (err) {
-        (0, apiErrors_1.throwApiError)(err);
-    }
-}
-exports.fetchDeveloperTestAccounts = fetchDeveloperTestAccounts;

package/lib/sandboxes.d.ts

@@ -1,14 +0,0 @@
-import { InitiateSyncResponse, Sandbox, SandboxType, SyncTaskStatusType, TaskRequestData, Usage } from '../types/Sandbox';
-export declare function createSandbox(accountId: number, name: string, type: 1 | 2): Promise<{
-    name: string;
-    sandbox: Sandbox;
-    personalAccessKey: string;
-}>;
-export declare function deleteSandbox(parentAccountId: number, sandboxAccountId: number): Promise<{
-    parentAccountId: number;
-    sandboxAccountId: number;
-}>;
-export declare function getSandboxUsageLimits(parentAccountId: number): Promise<Usage | void>;
-export declare function initiateSync(fromHubId: number, toHubId: number, tasks: Array<TaskRequestData>, sandboxHubId: number): Promise<InitiateSyncResponse>;
-export declare function fetchTaskStatus(accountId: number, taskId: number): Promise<SyncTaskStatusType>;
-export declare function fetchTypes(accountId: number, toHubId: number): Promise<Array<SandboxType> | void>;

package/lib/sandboxes.js

@@ -1,70 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchTypes = exports.fetchTaskStatus = exports.initiateSync = exports.getSandboxUsageLimits = exports.deleteSandbox = exports.createSandbox = void 0;
-const sandboxHubs_1 = require("../api/sandboxHubs");
-const sandboxSync_1 = require("../api/sandboxSync");
-const apiErrors_1 = require("../errors/apiErrors");
-async function createSandbox(accountId, name, type) {
-    try {
-        const resp = await (0, sandboxHubs_1.createSandbox)(accountId, name, type);
-        return {
-            name,
-            ...resp,
-        };
-    }
-    catch (err) {
-        (0, apiErrors_1.throwApiError)(err);
-    }
-}
-exports.createSandbox = createSandbox;
-async function deleteSandbox(parentAccountId, sandboxAccountId) {
-    try {
-        await (0, sandboxHubs_1.deleteSandbox)(parentAccountId, sandboxAccountId);
-    }
-    catch (err) {
-        (0, apiErrors_1.throwApiError)(err);
-    }
-    return {
-        parentAccountId,
-        sandboxAccountId,
-    };
-}
-exports.deleteSandbox = deleteSandbox;
-async function getSandboxUsageLimits(parentAccountId) {
-    try {
-        const resp = await (0, sandboxHubs_1.getSandboxUsageLimits)(parentAccountId);
-        return resp && resp.usage;
-    }
-    catch (err) {
-        (0, apiErrors_1.throwApiError)(err);
-    }
-}
-exports.getSandboxUsageLimits = getSandboxUsageLimits;
-async function initiateSync(fromHubId, toHubId, tasks, sandboxHubId) {
-    try {
-        return await (0, sandboxSync_1.initiateSync)(fromHubId, toHubId, tasks, sandboxHubId);
-    }
-    catch (err) {
-        (0, apiErrors_1.throwApiError)(err);
-    }
-}
-exports.initiateSync = initiateSync;
-async function fetchTaskStatus(accountId, taskId) {
-    try {
-        return await (0, sandboxSync_1.fetchTaskStatus)(accountId, taskId);
-    }
-    catch (err) {
-        (0, apiErrors_1.throwApiError)(err);
-    }
-}
-exports.fetchTaskStatus = fetchTaskStatus;
-async function fetchTypes(accountId, toHubId) {
-    try {
-        const resp = await (0, sandboxSync_1.fetchTypes)(accountId, toHubId);
-        return resp && resp.results;
-    }
-    catch (err) {
-        (0, apiErrors_1.throwApiError)(err);
-    }
-}
-exports.fetchTypes = fetchTypes;

package/models/HubSpotAuthError.d.ts

@@ -1,12 +0,0 @@
-import { AxiosError } from 'axios';
-export declare class HubSpotAuthError extends Error {
-    status?: number;
-    category?: string;
-    subCategory?: string;
-    constructor(message: string, { cause, }: {
-        cause?: Partial<AxiosError<{
-            category?: string;
-            subCategory?: string;
-        }>>;
-    });
-}

package/models/HubSpotAuthError.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HubSpotAuthError = void 0;
-class HubSpotAuthError extends Error {
-    status;
-    category;
-    subCategory;
-    constructor(message, { cause = {}, }) {
-        super(message);
-        this.name = 'HubSpotAuthError';
-        this.status = cause.response?.status;
-        this.category = cause?.response?.data?.category || undefined;
-        this.subCategory =
-            (cause.response &&
-                cause.response.data &&
-                cause.response.data.subCategory) ||
-                undefined;
-    }
-}
-exports.HubSpotAuthError = HubSpotAuthError;