@hubspot/local-dev-lib 0.5.0-experimental.0 → 0.5.0-experimental.1

package/config/index.d.ts

@@ -23,7 +23,7 @@ export declare function renameConfigAccount(currentName: string, newName: string
 export declare function removeAccountFromConfig(accountId: number): void;
 export declare function updateHttpTimeout(timeout: string | number): void;
 export declare function updateAllowUsageTracking(isAllowed: boolean): void;
-export declare function updateAllowAutoUpdates(enabled: boolean): void;
+export declare function updateAllowAutoUpdates(isEnabled: boolean): void;
 export declare function updateAutoOpenBrowser(isEnabled: boolean): void;
 export declare function updateDefaultCmsPublishMode(cmsPublishMode: CmsPublishMode): void;
 export declare function isConfigFlagEnabled(flag: ConfigFlag, defaultValue?: boolean): boolean;

package/config/index.js

@@ -12,6 +12,8 @@ const files_1 = require("../constants/files");
 const lang_1 = require("../utils/lang");
 const defaultAccountOverride_1 = require("./defaultAccountOverride");
 const environment_1 = require("../lib/environment");
+const HubSpotConfigError_1 = require("../models/HubSpotConfigError");
+const config_2 = require("../constants/config");
 function localConfigFileExists() {
     return Boolean((0, utils_1.getLocalConfigFilePath)());
 }
@@ -27,7 +29,7 @@ function getConfigDefaultFilePath() {
     }
     const localConfigFilePath = (0, utils_1.getLocalConfigFilePath)();
     if (!localConfigFilePath) {
-        throw new Error((0, lang_1.i18n)('config.getDefaultConfigFilePath.error'));
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.getDefaultConfigFilePath.error'), config_2.HUBSPOT_CONFIG_ERROR_TYPES.CONFIG_NOT_FOUND, config_1.HUBSPOT_CONFIG_OPERATIONS.READ);
     }
     return localConfigFilePath;
 }
@@ -37,14 +39,22 @@ function getConfigFilePath() {
 }
 exports.getConfigFilePath = getConfigFilePath;
 function getConfig() {
-    const { useEnvironmentConfig } = (0, utils_1.getConfigPathEnvironmentVariables)();
-    if (useEnvironmentConfig) {
-        return (0, utils_1.buildConfigFromEnvironment)();
+    let pathToRead;
+    try {
+        const { useEnvironmentConfig } = (0, utils_1.getConfigPathEnvironmentVariables)();
+        if (useEnvironmentConfig) {
+            return (0, utils_1.buildConfigFromEnvironment)();
+        }
+        pathToRead = getConfigFilePath();
+        logger_1.logger.debug((0, lang_1.i18n)('config.getConfig.reading', { path: pathToRead }));
+        const configFileSource = (0, utils_1.readConfigFile)(pathToRead);
+        return (0, utils_1.parseConfig)(configFileSource, pathToRead);
+    }
+    catch (err) {
+        throw new HubSpotConfigError_1.HubSpotConfigError(pathToRead
+            ? (0, lang_1.i18n)('config.getConfig.errorWithPath', { path: pathToRead })
+            : (0, lang_1.i18n)('config.getConfig.error'), config_2.HUBSPOT_CONFIG_ERROR_TYPES.CONFIG_NOT_FOUND, config_1.HUBSPOT_CONFIG_OPERATIONS.READ, { cause: err });
     }
-    const pathToRead = getConfigFilePath();
-    logger_1.logger.debug((0, lang_1.i18n)('config.getConfig', { path: pathToRead }));
-    const configFileSource = (0, utils_1.readConfigFile)(pathToRead);
-    return (0, utils_1.parseConfig)(configFileSource);
 }
 exports.getConfig = getConfig;
 function isConfigValid() {
@@ -103,7 +113,7 @@ function getConfigAccountById(accountId) {
     const { accounts } = getConfig();
     const account = (0, utils_1.getConfigAccountByIdentifier)(accounts, config_1.ACCOUNT_IDENTIFIERS.ACCOUNT_ID, accountId);
     if (!account) {
-        throw new Error((0, lang_1.i18n)('config.getConfigAccountById.error', { accountId }));
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.getConfigAccountById.error', { accountId }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.ACCOUNT_NOT_FOUND, config_1.HUBSPOT_CONFIG_OPERATIONS.READ);
     }
     return account;
 }
@@ -112,7 +122,7 @@ function getConfigAccountByName(accountName) {
     const { accounts } = getConfig();
     const account = (0, utils_1.getConfigAccountByIdentifier)(accounts, config_1.ACCOUNT_IDENTIFIERS.NAME, accountName);
     if (!account) {
-        throw new Error((0, lang_1.i18n)('config.getConfigAccountByName.error', { accountName }));
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.getConfigAccountByName.error', { accountName }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.ACCOUNT_NOT_FOUND, config_1.HUBSPOT_CONFIG_OPERATIONS.READ);
     }
     return account;
 }
@@ -130,13 +140,13 @@ function getConfigDefaultAccount() {
         defaultAccountToUse = defaultAccountOverrideAccountId || defaultAccount;
     }
     if (!defaultAccountToUse) {
-        throw new Error((0, lang_1.i18n)('config.getConfigDefaultAccount.fieldMissingError'));
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.getConfigDefaultAccount.fieldMissingError'), config_2.HUBSPOT_CONFIG_ERROR_TYPES.NO_DEFAULT_ACCOUNT, config_1.HUBSPOT_CONFIG_OPERATIONS.READ);
     }
     const account = (0, utils_1.getConfigAccountByInferredIdentifier)(accounts, defaultAccountToUse);
     if (!account) {
-        throw new Error((0, lang_1.i18n)('config.getConfigDefaultAccount.accountMissingError', {
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.getConfigDefaultAccount.accountMissingError', {
             defaultAccountToUse,
-        }));
+        }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.ACCOUNT_NOT_FOUND, config_1.HUBSPOT_CONFIG_OPERATIONS.READ);
     }
     return account;
 }
@@ -174,14 +184,14 @@ function getConfigAccountEnvironment(identifier) {
 exports.getConfigAccountEnvironment = getConfigAccountEnvironment;
 function addConfigAccount(accountToAdd) {
     if (!(0, utils_1.isConfigAccountValid)(accountToAdd)) {
-        throw new Error((0, lang_1.i18n)('config.addConfigAccount.invalidAccount'));
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.addConfigAccount.invalidAccount'), config_2.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_ACCOUNT, config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE);
     }
     const config = getConfig();
     const accountInConfig = (0, utils_1.getConfigAccountByIdentifier)(config.accounts, config_1.ACCOUNT_IDENTIFIERS.ACCOUNT_ID, accountToAdd.accountId);
     if (accountInConfig) {
-        throw new Error((0, lang_1.i18n)('config.addConfigAccount.duplicateAccount', {
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.addConfigAccount.duplicateAccount', {
             accountId: accountToAdd.accountId,
-        }));
+        }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_ACCOUNT, config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE);
     }
     config.accounts.push(accountToAdd);
     (0, utils_1.writeConfigFile)(config, getConfigFilePath());
@@ -189,14 +199,16 @@ function addConfigAccount(accountToAdd) {
 exports.addConfigAccount = addConfigAccount;
 function updateConfigAccount(updatedAccount) {
     if (!(0, utils_1.isConfigAccountValid)(updatedAccount)) {
-        throw new Error((0, lang_1.i18n)('config.updateConfigAccount.invalidAccount'));
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.updateConfigAccount.invalidAccount', {
+            name: updatedAccount.name,
+        }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_ACCOUNT, config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE);
     }
     const config = getConfig();
     const accountIndex = (0, utils_1.getConfigAccountIndexById)(config.accounts, updatedAccount.accountId);
     if (accountIndex < 0) {
-        throw new Error((0, lang_1.i18n)('config.updateConfigAccount.accountNotFound', {
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.updateConfigAccount.accountNotFound', {
             accountId: updatedAccount.accountId,
-        }));
+        }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.ACCOUNT_NOT_FOUND, config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE);
     }
     config.accounts[accountIndex] = updatedAccount;
     (0, utils_1.writeConfigFile)(config, getConfigFilePath());
@@ -206,9 +218,9 @@ function setConfigAccountAsDefault(identifier) {
     const config = getConfig();
     const account = (0, utils_1.getConfigAccountByInferredIdentifier)(config.accounts, identifier);
     if (!account) {
-        throw new Error((0, lang_1.i18n)('config.setConfigAccountAsDefault.accountNotFound', {
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.setConfigAccountAsDefault.accountNotFound', {
             accountId: identifier,
-        }));
+        }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.ACCOUNT_NOT_FOUND, config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE);
     }
     config.defaultAccount = account.accountId;
     (0, utils_1.writeConfigFile)(config, getConfigFilePath());
@@ -218,15 +230,16 @@ function renameConfigAccount(currentName, newName) {
     const config = getConfig();
     const account = (0, utils_1.getConfigAccountByIdentifier)(config.accounts, config_1.ACCOUNT_IDENTIFIERS.NAME, currentName);
     if (!account) {
-        throw new Error((0, lang_1.i18n)('config.renameConfigAccount.accountNotFound', {
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.renameConfigAccount.accountNotFound', {
             currentName,
-        }));
+        }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.ACCOUNT_NOT_FOUND, config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE);
     }
     const duplicateAccount = (0, utils_1.getConfigAccountByIdentifier)(config.accounts, config_1.ACCOUNT_IDENTIFIERS.NAME, newName);
     if (duplicateAccount) {
-        throw new Error((0, lang_1.i18n)('config.renameConfigAccount.duplicateAccount', {
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.renameConfigAccount.duplicateAccount', {
+            currentName,
             newName,
-        }));
+        }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_ACCOUNT, config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE);
     }
     account.name = newName;
     (0, utils_1.writeConfigFile)(config, getConfigFilePath());
@@ -236,9 +249,9 @@ function removeAccountFromConfig(accountId) {
     const config = getConfig();
     const index = (0, utils_1.getConfigAccountIndexById)(config.accounts, accountId);
     if (index < 0) {
-        throw new Error((0, lang_1.i18n)('config.removeAccountFromConfig.accountNotFound', {
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.removeAccountFromConfig.accountNotFound', {
             accountId,
-        }));
+        }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.ACCOUNT_NOT_FOUND, config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE);
     }
     config.accounts.splice(index, 1);
     if (config.defaultAccount === accountId) {
@@ -250,9 +263,10 @@ exports.removeAccountFromConfig = removeAccountFromConfig;
 function updateHttpTimeout(timeout) {
     const parsedTimeout = typeof timeout === 'string' ? parseInt(timeout) : timeout;
     if (isNaN(parsedTimeout) || parsedTimeout < config_1.MIN_HTTP_TIMEOUT) {
-        throw new Error((0, lang_1.i18n)('config.updateHttpTimeout.invalidTimeout', {
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.updateHttpTimeout.invalidTimeout', {
             minTimeout: config_1.MIN_HTTP_TIMEOUT,
-        }));
+            timeout: parsedTimeout,
+        }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_FIELD, config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE);
     }
     const config = getConfig();
     config.httpTimeout = parsedTimeout;
@@ -260,22 +274,32 @@ function updateHttpTimeout(timeout) {
 }
 exports.updateHttpTimeout = updateHttpTimeout;
 function updateAllowUsageTracking(isAllowed) {
+    if (typeof isAllowed !== 'boolean') {
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.updateAllowUsageTracking.invalidInput', {
+            isAllowed: `${isAllowed}`,
+        }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_FIELD, config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE);
+    }
     const config = getConfig();
     config.allowUsageTracking = isAllowed;
     (0, utils_1.writeConfigFile)(config, getConfigFilePath());
 }
 exports.updateAllowUsageTracking = updateAllowUsageTracking;
-function updateAllowAutoUpdates(enabled) {
+function updateAllowAutoUpdates(isEnabled) {
+    if (typeof isEnabled !== 'boolean') {
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.updateAllowAutoUpdates.invalidInput', {
+            isEnabled: `${isEnabled}`,
+        }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_FIELD, config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE);
+    }
     const config = getConfig();
-    config.allowAutoUpdates = enabled;
+    config.allowAutoUpdates = isEnabled;
     (0, utils_1.writeConfigFile)(config, getConfigFilePath());
 }
 exports.updateAllowAutoUpdates = updateAllowAutoUpdates;
 function updateAutoOpenBrowser(isEnabled) {
     if (typeof isEnabled !== 'boolean') {
-        throw new Error((0, lang_1.i18n)('config.updateAutoOpenBrowser.invalidInput', {
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.updateAutoOpenBrowser.invalidInput', {
             isEnabled: `${isEnabled}`,
-        }));
+        }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_FIELD, config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE);
     }
     const config = getConfig();
     config.autoOpenBrowser = isEnabled;
@@ -285,7 +309,9 @@ exports.updateAutoOpenBrowser = updateAutoOpenBrowser;
 function updateDefaultCmsPublishMode(cmsPublishMode) {
     if (!cmsPublishMode ||
         !Object.values(files_1.CMS_PUBLISH_MODE).includes(cmsPublishMode)) {
-        throw new Error((0, lang_1.i18n)('config.updateDefaultCmsPublishMode.invalidCmsPublishMode'));
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.updateDefaultCmsPublishMode.invalidCmsPublishMode', {
+            cmsPublishMode,
+        }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_FIELD, config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE);
     }
     const config = getConfig();
     config.defaultCmsPublishMode = cmsPublishMode;

package/config/migrate.js

@@ -10,7 +10,7 @@ const config_1 = require("../constants/config");
 const utils_1 = require("./utils");
 function getConfigAtPath(path) {
     const configFileSource = (0, utils_1.readConfigFile)(path);
-    return (0, utils_1.parseConfig)(configFileSource);
+    return (0, utils_1.parseConfig)(configFileSource, path);
 }
 exports.getConfigAtPath = getConfigAtPath;
 function migrateConfigAtPath(path) {

package/config/utils.d.ts

@@ -62,7 +62,7 @@ export declare function formatConfigForWrite(config: HubSpotConfig): {
 };
 export declare function writeConfigFile(config: HubSpotConfig, configPath: string): void;
 export declare function normalizeParsedConfig(parsedConfig: HubSpotConfig & DeprecatedHubSpotConfigFields): HubSpotConfig;
-export declare function parseConfig(configSource: string): HubSpotConfig;
+export declare function parseConfig(configSource: string, configPath: string): HubSpotConfig;
 export declare function buildConfigFromEnvironment(): HubSpotConfig;
 export declare function getAccountIdentifierAndType(accountIdentifier: string | number): {
     identifier: string | number;

package/config/utils.js

@@ -15,6 +15,7 @@ const environment_1 = require("../lib/environment");
 const path_1 = require("../lib/path");
 const files_1 = require("../constants/files");
 const lang_1 = require("../utils/lang");
+const HubSpotConfigError_1 = require("../models/HubSpotConfigError");
 function getGlobalConfigFilePath() {
     return config_1.GLOBAL_CONFIG_PATH;
 }
@@ -35,7 +36,7 @@ function getConfigPathEnvironmentVariables() {
     const useEnvironmentConfig = process.env[config_1.ENVIRONMENT_VARIABLES.USE_ENVIRONMENT_HUBSPOT_CONFIG] ===
         'true';
     if (configFilePathFromEnvironment && useEnvironmentConfig) {
-        throw new Error((0, lang_1.i18n)('config.utils.getConfigPathEnvironmentVariables.invalidEnvironmentVariables'));
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.utils.getConfigPathEnvironmentVariables.invalidEnvironmentVariables'), config_1.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_ENVIRONMENT_VARIABLES, config_1.HUBSPOT_CONFIG_OPERATIONS.READ);
     }
     return {
         configFilePathFromEnvironment,
@@ -163,13 +164,13 @@ function normalizeParsedConfig(parsedConfig) {
     return parsedConfig;
 }
 exports.normalizeParsedConfig = normalizeParsedConfig;
-function parseConfig(configSource) {
+function parseConfig(configSource, configPath) {
     let parsedYaml;
     try {
         parsedYaml = js_yaml_1.default.load(configSource);
     }
     catch (err) {
-        throw new Error((0, lang_1.i18n)('config.utils.parseConfig.error'), { cause: err });
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.utils.parseConfig.error', { configPath: configPath }), config_1.HUBSPOT_CONFIG_ERROR_TYPES.YAML_PARSING, config_1.HUBSPOT_CONFIG_OPERATIONS.READ, { cause: err });
     }
     return normalizeParsedConfig(parsedYaml);
 }
@@ -188,7 +189,7 @@ function buildConfigFromEnvironment() {
     const allowUsageTrackingVar = process.env[config_1.ENVIRONMENT_VARIABLES.ALLOW_USAGE_TRACKING];
     const defaultCmsPublishModeVar = process.env[config_1.ENVIRONMENT_VARIABLES.DEFAULT_CMS_PUBLISH_MODE];
     if (!accountIdVar) {
-        throw new Error((0, lang_1.i18n)('config.utils.buildConfigFromEnvironment.missingAccountId'));
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.utils.buildConfigFromEnvironment.missingAccountId'), config_1.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_ENVIRONMENT_VARIABLES, config_1.HUBSPOT_CONFIG_OPERATIONS.READ);
     }
     const accountId = parseInt(accountIdVar);
     const httpTimeout = httpTimeoutVar ? parseInt(httpTimeoutVar) : undefined;
@@ -242,7 +243,7 @@ function buildConfigFromEnvironment() {
         };
     }
     else {
-        throw new Error((0, lang_1.i18n)('config.utils.buildConfigFromEnvironment.invalidAuthType'));
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.utils.buildConfigFromEnvironment.invalidAuthType'), config_1.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_ENVIRONMENT_VARIABLES, config_1.HUBSPOT_CONFIG_OPERATIONS.READ);
     }
     return {
         accounts: [account],

package/constants/config.d.ts

@@ -56,3 +56,16 @@ export declare const ACCOUNT_IDENTIFIERS: {
     readonly ACCOUNT_ID: "accountId";
     readonly NAME: "name";
 };
+export declare const HUBSPOT_CONFIG_ERROR_TYPES: {
+    readonly CONFIG_NOT_FOUND: "CONFIG_NOT_FOUND";
+    readonly ACCOUNT_NOT_FOUND: "ACCOUNT_NOT_FOUND";
+    readonly NO_DEFAULT_ACCOUNT: "NO_DEFAULT_ACCOUNT";
+    readonly INVALID_ENVIRONMENT_VARIABLES: "ENVIRONMENT_VARIABLES";
+    readonly YAML_PARSING: "YAML_PARSING";
+    readonly INVALID_ACCOUNT: "INVALID_ACCOUNT";
+    readonly INVALID_FIELD: "INVALID_FIELD";
+};
+export declare const HUBSPOT_CONFIG_OPERATIONS: {
+    readonly READ: "READ";
+    readonly WRITE: "WRITE";
+};

package/constants/config.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ACCOUNT_IDENTIFIERS = exports.ENVIRONMENT_VARIABLES = exports.CONFIG_FLAGS = exports.HUBSPOT_ACCOUNT_TYPE_STRINGS = exports.HUBSPOT_ACCOUNT_TYPES = exports.MIN_HTTP_TIMEOUT = exports.DEFAULT_PORTAL = exports.DEFAULT_ACCOUNT = exports.ALLOW_AUTO_UPDATES = exports.AUTO_OPEN_BROWSER = exports.ALLOW_USAGE_TRACKING = exports.HTTP_USE_LOCALHOST = exports.ENV = exports.HTTP_TIMEOUT = exports.DEFAULT_CMS_PUBLISH_MODE = exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND = exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID = exports.DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME = exports.STATE_FILE_PATH = exports.GLOBAL_CONFIG_PATH = exports.HUBSPOT_STATE_FILE = exports.HUBSPOT_CONFIGURATION_FILE = exports.HUBSPOT_CONFIGURATION_FOLDER = exports.ARCHIVED_HUBSPOT_CONFIG_YAML_FILE_NAME = exports.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = void 0;
+exports.HUBSPOT_CONFIG_OPERATIONS = exports.HUBSPOT_CONFIG_ERROR_TYPES = exports.ACCOUNT_IDENTIFIERS = exports.ENVIRONMENT_VARIABLES = exports.CONFIG_FLAGS = exports.HUBSPOT_ACCOUNT_TYPE_STRINGS = exports.HUBSPOT_ACCOUNT_TYPES = exports.MIN_HTTP_TIMEOUT = exports.DEFAULT_PORTAL = exports.DEFAULT_ACCOUNT = exports.ALLOW_AUTO_UPDATES = exports.AUTO_OPEN_BROWSER = exports.ALLOW_USAGE_TRACKING = exports.HTTP_USE_LOCALHOST = exports.ENV = exports.HTTP_TIMEOUT = exports.DEFAULT_CMS_PUBLISH_MODE = exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND = exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID = exports.DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME = exports.STATE_FILE_PATH = exports.GLOBAL_CONFIG_PATH = exports.HUBSPOT_STATE_FILE = exports.HUBSPOT_CONFIGURATION_FILE = exports.HUBSPOT_CONFIGURATION_FOLDER = exports.ARCHIVED_HUBSPOT_CONFIG_YAML_FILE_NAME = exports.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = void 0;
 const lang_1 = require("../utils/lang");
 const path_1 = __importDefault(require("path"));
 const os_1 = __importDefault(require("os"));
@@ -65,3 +65,16 @@ exports.ACCOUNT_IDENTIFIERS = {
     ACCOUNT_ID: 'accountId',
     NAME: 'name',
 };
+exports.HUBSPOT_CONFIG_ERROR_TYPES = {
+    CONFIG_NOT_FOUND: 'CONFIG_NOT_FOUND',
+    ACCOUNT_NOT_FOUND: 'ACCOUNT_NOT_FOUND',
+    NO_DEFAULT_ACCOUNT: 'NO_DEFAULT_ACCOUNT',
+    INVALID_ENVIRONMENT_VARIABLES: 'ENVIRONMENT_VARIABLES',
+    YAML_PARSING: 'YAML_PARSING',
+    INVALID_ACCOUNT: 'INVALID_ACCOUNT',
+    INVALID_FIELD: 'INVALID_FIELD',
+};
+exports.HUBSPOT_CONFIG_OPERATIONS = {
+    READ: 'READ',
+    WRITE: 'WRITE',
+};

package/errors/index.d.ts

@@ -1,6 +1,7 @@
 import { HubSpotHttpError } from '../models/HubSpotHttpError';
 import { BaseError } from '../types/Error';
 import { FileSystemError } from '../models/FileSystemError';
+import { HubSpotConfigError } from '../models/HubSpotConfigError';
 export declare function isSpecifiedError(err: unknown, { statusCode, category, subCategory, errorType, code, }: {
     statusCode?: number;
     category?: string;
@@ -17,3 +18,4 @@ export declare function isHubSpotHttpError(error?: unknown): error is HubSpotHtt
 export declare function isGithubRateLimitError(err: unknown): boolean;
 export declare function isSystemError(err: unknown): err is BaseError;
 export declare function isFileSystemError(err: unknown): err is FileSystemError;
+export declare function isHubSpotConfigError(err: unknown): err is HubSpotConfigError;

package/errors/index.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFileSystemError = exports.isSystemError = exports.isGithubRateLimitError = exports.isHubSpotHttpError = exports.isValidationError = exports.isAuthError = exports.isTimeoutError = exports.isGatingError = exports.isMissingScopeError = exports.isSpecifiedError = void 0;
+exports.isHubSpotConfigError = exports.isFileSystemError = exports.isSystemError = exports.isGithubRateLimitError = exports.isHubSpotHttpError = exports.isValidationError = exports.isAuthError = exports.isTimeoutError = exports.isGatingError = exports.isMissingScopeError = exports.isSpecifiedError = void 0;
 const HubSpotHttpError_1 = require("../models/HubSpotHttpError");
 const FileSystemError_1 = require("../models/FileSystemError");
+const HubSpotConfigError_1 = require("../models/HubSpotConfigError");
 function isSpecifiedError(err, { statusCode, category, subCategory, errorType, code, }) {
     if (!isHubSpotHttpError(err)) {
         return false;
@@ -70,3 +71,7 @@ function isFileSystemError(err) {
     return err instanceof FileSystemError_1.FileSystemError;
 }
 exports.isFileSystemError = isFileSystemError;
+function isHubSpotConfigError(err) {
+    return err instanceof HubSpotConfigError_1.HubSpotConfigError;
+}
+exports.isHubSpotConfigError = isHubSpotConfigError;

package/lang/en.json

@@ -244,9 +244,13 @@
   },
   "config": {
     "getDefaultConfigFilePath": {
-      "error": "Error getting config file path: no config file found"
+      "error": "Attempted to get config file path, but no config file was found."
+    },
+    "getConfig": {
+      "reading": "Reading config from {{ path }}",
+      "error": "No config file found.",
+      "errorWithPath": "No config file found at {{ path }}."
     },
-    "getConfig": "Reading config from {{ path }}",
     "isConfigValid": {
       "missingAccounts": "Invalid config: no accounts found",
       "duplicateAccountIds": "Invalid config: multiple accounts with accountId: {{ accountId }}",
@@ -254,35 +258,35 @@
       "invalidAccountName": "Invalid config: account name {{ accountName }} contains spaces"
     },
     "getConfigAccountById": {
-      "error": "Error getting config account: no account with id {{ accountId }} exists in config"
+      "error": "No account with id {{ accountId }} exists in config"
     },
     "getConfigAccountByName": {
-      "error": "Error getting config account: no account with name {{ accountName }} exists in config"
+      "error": "No account with name {{ accountName }} exists in config"
     },
     "getConfigDefaultAccount": {
-      "fieldMissingError": "Error getting config default account: no default account field found in config",
-      "accountMissingError": "Error getting config default account: default account is set to {{ defaultAccount }} but no account with that id exists in config"
+      "fieldMissingError": "Attempted to get default account, but no default account was found in config",
+      "accountMissingError": "Default account is set to {{ defaultAccount }}, but no account with that id exists in config"
     },
     "addConfigAccount": {
-      "invalidAccount": "Error adding config account: account is invalid",
-      "duplicateAccount": "Error adding config account: account with id {{ accountId }} already exists in config"
+      "invalidAccount": "Attempting to add account, but account is invalid",
+      "duplicateAccount": "Attempting to add account, but account with id {{ accountId }} already exists in config"
     },
     "updateConfigAccount": {
-      "invalidAccount": "Error updating config account: account is invalid",
-      "accountNotFound": "Error updating config account: account with id {{ accountId }} not found in config"
+      "invalidAccount": "Attempting to update account {{ name }}, but account is invalid",
+      "accountNotFound": "Attempting to update account with id {{ id }}, but that account was not found in config"
     },
     "setConfigAccountAsDefault": {
-      "accountNotFound": "Error setting config default account: account with id {{ accountId }} not found in config"
+      "accountNotFound": "Attempted to set account with id {{ accountId }} as default, but that account was not found in config"
     },
     "renameConfigAccount": {
-      "accountNotFound": "Error renaming config account: account with name {{ currentName }} not found in config",
-      "duplicateAccount": "Error renaming config account: account with name {{ newName}} already exists in config"
+      "accountNotFound": "Attempted to rename account with name {{ currentName }}, but that account was not found in config",
+      "duplicateAccount": "Attempted to rename account {{ currentName }} to {{ newName }}, but an account with that name already exists in config"
     },
     "removeAccountFromConfig": {
-      "accountNotFound": "Error removing config account: account with id {{ accountId }} not found in config"
+      "accountNotFound": "Attempted to remove account with id {{ accountId }}, but that account was not found in config"
     },
     "updateHttpTimeout": {
-      "invalidTimeout": "Error updating config http timeout: timeout must be greater than {{ minTimeout }}"
+      "invalidTimeout": "HTTP timeout must be greater than {{ minTimeout }}. Received {{ timeout }}"
     },
     "updateDefaultCmsPublishMode": {
       "invalidCmsPublishMode": "Error updating config default CMS publish mode: CMS publish can only be set to 'draft' or 'publish'"
@@ -297,14 +301,14 @@
         "missingPersonalAccessKey": "Invalid config: account {{ accountId }} has authType of personalAccessKey but is missing the personalAccessKey field"
       },
       "getConfigPathEnvironmentVariables": {
-        "invalidEnvironmentVariables": "Error loading config: USE_ENVIRONMENT_HUBSPOT_CONFIG and HUBSPOT_CONFIG_PATH cannot both be set simultaneously"
+        "invalidEnvironmentVariables": "USE_ENVIRONMENT_HUBSPOT_CONFIG and HUBSPOT_CONFIG_PATH cannot both be set simultaneously"
       },
       "parseConfig": {
-        "error": "An error occurred parsing the config file."
+        "error": "File could not be parsed. Confirm that your config file {{ configPath }} is valid YAML."
       },
       "buildConfigFromEnvironment": {
-        "missingAccountId": "Error loading config from environment: HUBSPOT_ACCOUNT_ID not set",
-        "invalidAuthType": "Error loading config from environment: auth is invalid. Use HUBSPOT_CLIENT_ID, HUBSPOT_CLIENT_SECRET, and HUBSPOT_REFRESH_TOKEN to authenticate with Oauth2, PERSONAL_ACCESS_KEY to authenticate with Personal Access Key, or API_KEY to authenticate with API Key."
+        "missingAccountId": "HUBSPOT_ACCOUNT_ID is required, but not currently set",
+        "invalidAuthType": "Auth type is invalid. Use HUBSPOT_CLIENT_ID, HUBSPOT_CLIENT_SECRET, and HUBSPOT_REFRESH_TOKEN to authenticate with Oauth2, PERSONAL_ACCESS_KEY to authenticate with Personal Access Key, or API_KEY to authenticate with API Key."
       }
     },
     "defaultAccountOverride": {
@@ -313,6 +317,12 @@
         "readFileError": "Error reading account override file."
       }
     },
+    "updateAllowUsageTracking": {
+      "invalidInput": "Unable to update allowUsageTracking. The value {{ isAllowed }} is invalid. The value must be a boolean."
+    },
+    "updateAllowAutoUpdates": {
+      "invalidInput": "Unable to update allowAutoUpdates. The value {{ isEnabled }} is invalid. The value must be a boolean."
+    },
     "updateAutoOpenBrowser": {
       "invalidInput": "Unable to update autoOpenBrowser. The value {{ isEnabled }} is invalid. The value must be a boolean."
     },
@@ -367,6 +377,9 @@
         "missingRefreshToken": "The account {{ accountId }} has not been authenticated with Oauth2",
         "auth": "Error while retrieving new token: {{ token }}"
       }
+    },
+    "HubSpotConfigError": {
+      "baseMessage": "An error occurred while {{ operation }} your HubSpot config {{ configType }}: {{ message }}"
     }
   },
   "utils": {

package/models/HubSpotConfigError.d.ts

@@ -0,0 +1,6 @@
+import { HubSpotConfigErrorType, HubSpotConfigOperation } from '../types/Config';
+export declare class HubSpotConfigError extends Error {
+    type: HubSpotConfigErrorType;
+    operation: HubSpotConfigOperation;
+    constructor(message: string, type: HubSpotConfigErrorType, operation: HubSpotConfigOperation, options?: ErrorOptions);
+}

package/models/HubSpotConfigError.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HubSpotConfigError = void 0;
+const config_1 = require("../constants/config");
+const lang_1 = require("../utils/lang");
+const NAME = 'HubSpotConfigError';
+function isEnvironmentError(type) {
+    return type === config_1.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_ENVIRONMENT_VARIABLES;
+}
+class HubSpotConfigError extends Error {
+    type;
+    operation;
+    constructor(message, type, operation, options) {
+        const configType = isEnvironmentError(type)
+            ? 'environment variables'
+            : 'file';
+        const operationText = operation === config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE ? 'writing to' : 'reading';
+        const withBaseMessage = (0, lang_1.i18n)('models.HubSpotConfigError.baseMessage', {
+            configType,
+            message,
+            operation: operationText,
+        });
+        super(withBaseMessage, options);
+        this.name = NAME;
+        this.type = type;
+        this.operation = operation;
+    }
+}
+exports.HubSpotConfigError = HubSpotConfigError;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "0.5.0-experimental.0",
+    "version": "0.5.0-experimental.1",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "repository": {
         "type": "git",

package/types/Config.d.ts

@@ -1,4 +1,4 @@
-import { CONFIG_FLAGS } from '../constants/config';
+import { CONFIG_FLAGS, HUBSPOT_CONFIG_ERROR_TYPES, HUBSPOT_CONFIG_OPERATIONS } from '../constants/config';
 import { ENVIRONMENTS } from '../constants/environments';
 import { DeprecatedHubSpotConfigAccountFields, HubSpotConfigAccount } from './Accounts';
 import { CmsPublishMode } from './Files';
@@ -32,3 +32,5 @@ export type ConfigFlag = ValueOf<typeof CONFIG_FLAGS>;
 export type CLIState = {
     mcpTotalToolCalls: number;
 };
+export type HubSpotConfigErrorType = ValueOf<typeof HUBSPOT_CONFIG_ERROR_TYPES>;
+export type HubSpotConfigOperation = ValueOf<typeof HUBSPOT_CONFIG_OPERATIONS>;