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

package/config/index.d.ts

@@ -1,22 +1,24 @@
 import { HubSpotConfigAccount } from '../types/Accounts';
-import { HubSpotConfig, ConfigFlag } from '../types/Config';
+import { HubSpotConfig, ConfigFlag, HubSpotConfigValidationResult } from '../types/Config';
 import { CmsPublishMode } from '../types/Files';
 import { Environment } from '../types/Config';
+export declare function getGlobalConfigFilePath(): string;
+export declare function getLocalConfigFilePathIfExists(): string | null;
 export declare function localConfigFileExists(): boolean;
 export declare function globalConfigFileExists(): boolean;
 export declare function configFileExists(): boolean;
 export declare function getConfigFilePath(): string;
 export declare function getConfig(): HubSpotConfig;
-export declare function isConfigValid(): boolean;
+export declare function validateConfig(): HubSpotConfigValidationResult;
 export declare function createEmptyConfigFile(useGlobalConfig?: boolean): void;
-export declare function deleteConfigFile(): void;
+export declare function deleteConfigFileIfEmpty(): void;
 export declare function getConfigAccountById(accountId: number): HubSpotConfigAccount;
 export declare function getConfigAccountByName(accountName: string): HubSpotConfigAccount;
 export declare function getConfigAccountIfExists(identifier: number | string): HubSpotConfigAccount | undefined;
 export declare function getConfigDefaultAccount(): HubSpotConfigAccount;
 export declare function getConfigDefaultAccountIfExists(): HubSpotConfigAccount | undefined;
 export declare function getAllConfigAccounts(): HubSpotConfigAccount[];
-export declare function getConfigAccountEnvironment(identifier?: number | string): Environment;
+export declare function getConfigAccountEnvironment(identifier: number | string): Environment;
 export declare function addConfigAccount(accountToAdd: HubSpotConfigAccount): void;
 export declare function updateConfigAccount(updatedAccount: HubSpotConfigAccount): void;
 export declare function setConfigAccountAsDefault(identifier: number | string): void;

package/config/index.js

@@ -3,8 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeLocalStateFlag = exports.addLocalStateFlag = exports.hasLocalStateFlag = exports.isConfigFlagEnabled = exports.updateDefaultCmsPublishMode = exports.updateAutoOpenBrowser = exports.updateAllowAutoUpdates = exports.updateAllowUsageTracking = exports.updateHttpTimeout = exports.removeAccountFromConfig = exports.renameConfigAccount = exports.setConfigAccountAsDefault = exports.updateConfigAccount = exports.addConfigAccount = exports.getConfigAccountEnvironment = exports.getAllConfigAccounts = exports.getConfigDefaultAccountIfExists = exports.getConfigDefaultAccount = exports.getConfigAccountIfExists = exports.getConfigAccountByName = exports.getConfigAccountById = exports.deleteConfigFile = exports.createEmptyConfigFile = exports.isConfigValid = exports.getConfig = exports.getConfigFilePath = exports.configFileExists = exports.globalConfigFileExists = exports.localConfigFileExists = void 0;
+exports.removeLocalStateFlag = exports.addLocalStateFlag = exports.hasLocalStateFlag = exports.isConfigFlagEnabled = exports.updateDefaultCmsPublishMode = exports.updateAutoOpenBrowser = exports.updateAllowAutoUpdates = exports.updateAllowUsageTracking = exports.updateHttpTimeout = exports.removeAccountFromConfig = exports.renameConfigAccount = exports.setConfigAccountAsDefault = exports.updateConfigAccount = exports.addConfigAccount = exports.getConfigAccountEnvironment = exports.getAllConfigAccounts = exports.getConfigDefaultAccountIfExists = exports.getConfigDefaultAccount = exports.getConfigAccountIfExists = exports.getConfigAccountByName = exports.getConfigAccountById = exports.deleteConfigFileIfEmpty = exports.createEmptyConfigFile = exports.validateConfig = exports.getConfig = exports.getConfigFilePath = exports.configFileExists = exports.globalConfigFileExists = exports.localConfigFileExists = exports.getLocalConfigFilePathIfExists = exports.getGlobalConfigFilePath = void 0;
 const fs_extra_1 = __importDefault(require("fs-extra"));
+const findup_sync_1 = __importDefault(require("findup-sync"));
 const config_1 = require("../constants/config");
 const logger_1 = require("../lib/logger");
 const utils_1 = require("./utils");
@@ -14,17 +15,31 @@ const defaultAccountOverride_1 = require("./defaultAccountOverride");
 const environment_1 = require("../lib/environment");
 const HubSpotConfigError_1 = require("../models/HubSpotConfigError");
 const config_2 = require("../constants/config");
+const isDeepEqual_1 = require("../lib/isDeepEqual");
+const path_1 = require("../lib/path");
+const EMPTY_CONFIG = { accounts: [] };
+function getGlobalConfigFilePath() {
+    return config_1.GLOBAL_CONFIG_PATH;
+}
+exports.getGlobalConfigFilePath = getGlobalConfigFilePath;
+function getLocalConfigFilePathIfExists() {
+    return (0, findup_sync_1.default)([
+        config_1.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME,
+        config_1.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME.replace('.yml', '.yaml'),
+    ], { cwd: (0, path_1.getCwd)() });
+}
+exports.getLocalConfigFilePathIfExists = getLocalConfigFilePathIfExists;
 function localConfigFileExists() {
-    return Boolean((0, utils_1.getLocalConfigFilePath)());
+    return Boolean(getLocalConfigFilePathIfExists());
 }
 exports.localConfigFileExists = localConfigFileExists;
 function globalConfigFileExists() {
-    return fs_extra_1.default.existsSync((0, utils_1.getGlobalConfigFilePath)());
+    return (0, utils_1.doesConfigFileExistAtPath)(getGlobalConfigFilePath());
 }
 exports.globalConfigFileExists = globalConfigFileExists;
 function configFileExists() {
     try {
-        return fs_extra_1.default.existsSync(getConfigFilePath());
+        return (0, utils_1.doesConfigFileExistAtPath)(getConfigFilePath());
     }
     catch (error) {
         return false;
@@ -32,11 +47,11 @@ function configFileExists() {
 }
 exports.configFileExists = configFileExists;
 function getConfigDefaultFilePath() {
-    const globalConfigFilePath = (0, utils_1.getGlobalConfigFilePath)();
-    if (fs_extra_1.default.existsSync(globalConfigFilePath)) {
+    const globalConfigFilePath = getGlobalConfigFilePath();
+    if ((0, utils_1.doesConfigFileExistAtPath)(globalConfigFilePath)) {
         return globalConfigFilePath;
     }
-    const localConfigFilePath = (0, utils_1.getLocalConfigFilePath)();
+    const localConfigFilePath = getLocalConfigFilePathIfExists();
     if (!localConfigFilePath) {
         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);
     }
@@ -66,58 +81,70 @@ function getConfig() {
     }
 }
 exports.getConfig = getConfig;
-function isConfigValid() {
+function validateConfig() {
     const config = getConfig();
     if (config.accounts.length === 0) {
-        logger_1.logger.debug((0, lang_1.i18n)('config.isConfigValid.missingAccounts'));
-        return false;
+        return {
+            isValid: false,
+            errors: [(0, lang_1.i18n)('config.validateConfig.missingAccounts')],
+        };
     }
     const accountIdsMap = {};
     const accountNamesMap = {};
-    return config.accounts.every(account => {
-        if (!(0, utils_1.isConfigAccountValid)(account)) {
-            return false;
+    const validationErrors = [];
+    config.accounts.forEach(account => {
+        const accountValidationResult = (0, utils_1.validateConfigAccount)(account);
+        if (!accountValidationResult.isValid) {
+            validationErrors.push(...accountValidationResult.errors);
         }
         if (accountIdsMap[account.accountId]) {
-            logger_1.logger.debug((0, lang_1.i18n)('config.isConfigValid.duplicateAccountIds', {
+            validationErrors.push((0, lang_1.i18n)('config.validateConfig.duplicateAccountIds', {
                 accountId: account.accountId,
             }));
-            return false;
         }
         if (account.name) {
             if (accountNamesMap[account.name.toLowerCase()]) {
-                logger_1.logger.debug((0, lang_1.i18n)('config.isConfigValid.duplicateAccountNames', {
+                validationErrors.push((0, lang_1.i18n)('config.validateConfig.duplicateAccountNames', {
                     accountName: account.name,
                 }));
-                return false;
             }
             if (/\s+/.test(account.name)) {
-                logger_1.logger.debug((0, lang_1.i18n)('config.isConfigValid.invalidAccountName', {
+                validationErrors.push((0, lang_1.i18n)('config.validateConfig.invalidAccountName', {
                     accountName: account.name,
                 }));
-                return false;
             }
             accountNamesMap[account.name] = true;
         }
         accountIdsMap[account.accountId] = true;
-        return true;
     });
+    return { isValid: validationErrors.length === 0, errors: validationErrors };
 }
-exports.isConfigValid = isConfigValid;
+exports.validateConfig = validateConfig;
 function createEmptyConfigFile(useGlobalConfig = false) {
     const { configFilePathFromEnvironment } = (0, utils_1.getConfigPathEnvironmentVariables)();
     const defaultPath = useGlobalConfig
-        ? (0, utils_1.getGlobalConfigFilePath)()
+        ? getGlobalConfigFilePath()
         : (0, utils_1.getLocalConfigDefaultFilePath)();
     const pathToWrite = configFilePathFromEnvironment || defaultPath;
-    (0, utils_1.writeConfigFile)({ accounts: [] }, pathToWrite);
+    (0, utils_1.writeConfigFile)(EMPTY_CONFIG, pathToWrite);
 }
 exports.createEmptyConfigFile = createEmptyConfigFile;
-function deleteConfigFile() {
+function deleteConfigFileIfEmpty() {
     const pathToDelete = getConfigFilePath();
-    fs_extra_1.default.unlinkSync(pathToDelete);
+    try {
+        const config = getConfig();
+        if ((0, isDeepEqual_1.isDeepEqual)(config, EMPTY_CONFIG)) {
+            fs_extra_1.default.unlinkSync(pathToDelete);
+        }
+    }
+    catch (error) {
+        const { message, type } = (0, utils_1.handleConfigFileSystemError)(error, pathToDelete);
+        throw new HubSpotConfigError_1.HubSpotConfigError(message, type, config_1.HUBSPOT_CONFIG_OPERATIONS.DELETE, {
+            cause: error,
+        });
+    }
 }
-exports.deleteConfigFile = deleteConfigFile;
+exports.deleteConfigFileIfEmpty = deleteConfigFileIfEmpty;
 function getConfigAccountById(accountId) {
     const { accounts } = getConfig();
     const account = (0, utils_1.getConfigAccountByIdentifier)(accounts, config_1.ACCOUNT_IDENTIFIERS.ACCOUNT_ID, accountId);
@@ -145,7 +172,7 @@ function getConfigDefaultAccount() {
     const { accounts, defaultAccount } = getConfig();
     let defaultAccountToUse = defaultAccount;
     const currentConfigPath = getConfigFilePath();
-    const globalConfigPath = (0, utils_1.getGlobalConfigFilePath)();
+    const globalConfigPath = getGlobalConfigFilePath();
     if (currentConfigPath === globalConfigPath && globalConfigFileExists()) {
         const defaultAccountOverrideAccountId = (0, defaultAccountOverride_1.getDefaultAccountOverrideAccountId)();
         defaultAccountToUse = defaultAccountOverrideAccountId || defaultAccount;
@@ -167,7 +194,7 @@ function getConfigDefaultAccountIfExists() {
     let defaultAccountToUse = defaultAccount;
     // Only check for default account override if we're using the global config
     const currentConfigPath = getConfigFilePath();
-    const globalConfigPath = (0, utils_1.getGlobalConfigFilePath)();
+    const globalConfigPath = getGlobalConfigFilePath();
     if (currentConfigPath === globalConfigPath && globalConfigFileExists()) {
         const defaultAccountOverrideAccountId = (0, defaultAccountOverride_1.getDefaultAccountOverrideAccountId)();
         defaultAccountToUse = defaultAccountOverrideAccountId || defaultAccount;
@@ -185,19 +212,18 @@ function getAllConfigAccounts() {
 }
 exports.getAllConfigAccounts = getAllConfigAccounts;
 function getConfigAccountEnvironment(identifier) {
-    if (identifier) {
-        const config = getConfig();
-        const account = (0, utils_1.getConfigAccountByInferredIdentifier)(config.accounts, identifier);
-        if (account) {
-            return (0, environment_1.getValidEnv)(account.env);
-        }
+    const config = getConfig();
+    const account = (0, utils_1.getConfigAccountByInferredIdentifier)(config.accounts, identifier);
+    if (!account) {
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.getConfigAccountEnvironment.accountNotFound', {
+            identifier,
+        }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.ACCOUNT_NOT_FOUND, config_1.HUBSPOT_CONFIG_OPERATIONS.READ);
     }
-    const defaultAccount = getConfigDefaultAccount();
-    return (0, environment_1.getValidEnv)(defaultAccount.env);
+    return (0, environment_1.getValidEnv)(account.env);
 }
 exports.getConfigAccountEnvironment = getConfigAccountEnvironment;
 function addConfigAccount(accountToAdd) {
-    if (!(0, utils_1.isConfigAccountValid)(accountToAdd)) {
+    if (!(0, utils_1.validateConfigAccount)(accountToAdd)) {
         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();
@@ -212,7 +238,7 @@ function addConfigAccount(accountToAdd) {
 }
 exports.addConfigAccount = addConfigAccount;
 function updateConfigAccount(updatedAccount) {
-    if (!(0, utils_1.isConfigAccountValid)(updatedAccount)) {
+    if (!(0, utils_1.validateConfigAccount)(updatedAccount)) {
         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);
@@ -233,7 +259,7 @@ function setConfigAccountAsDefault(identifier) {
     const account = (0, utils_1.getConfigAccountByInferredIdentifier)(config.accounts, identifier);
     if (!account) {
         throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.setConfigAccountAsDefault.accountNotFound', {
-            accountId: identifier,
+            identifier,
         }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.ACCOUNT_NOT_FOUND, config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE);
     }
     config.defaultAccount = account.accountId;

package/config/migrate.d.ts

@@ -15,3 +15,4 @@ export declare function mergeConfigAccounts(toConfig: HubSpotConfig, fromConfig:
     configWithMergedAccounts: HubSpotConfig;
     skippedAccountIds: Array<string | number>;
 };
+export declare function archiveConfigAtPath(configPath: string): void;

package/config/migrate.js

@@ -3,11 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeConfigAccounts = exports.mergeConfigProperties = exports.migrateConfigAtPath = exports.getConfigAtPath = void 0;
+exports.archiveConfigAtPath = exports.mergeConfigAccounts = exports.mergeConfigProperties = exports.migrateConfigAtPath = exports.getConfigAtPath = void 0;
 const fs_1 = __importDefault(require("fs"));
 const index_1 = require("./index");
 const config_1 = require("../constants/config");
 const utils_1 = require("./utils");
+const path_1 = __importDefault(require("path"));
 function getConfigAtPath(path) {
     const configFileSource = (0, utils_1.readConfigFile)(path);
     return (0, utils_1.parseConfig)(configFileSource, path);
@@ -16,8 +17,7 @@ exports.getConfigAtPath = getConfigAtPath;
 function migrateConfigAtPath(path) {
     (0, index_1.createEmptyConfigFile)(true);
     const configToMigrate = getConfigAtPath(path);
-    (0, utils_1.writeConfigFile)(configToMigrate, (0, utils_1.getGlobalConfigFilePath)());
-    fs_1.default.unlinkSync(path);
+    (0, utils_1.writeConfigFile)(configToMigrate, (0, index_1.getGlobalConfigFilePath)());
 }
 exports.migrateConfigAtPath = migrateConfigAtPath;
 function mergeConfigProperties(toConfig, fromConfig, force) {
@@ -64,7 +64,9 @@ function mergeConfigProperties(toConfig, fromConfig, force) {
             config_1.DEFAULT_ACCOUNT,
         ];
         propertiesToCheck.forEach(prop => {
-            if (toConfig[prop] !== undefined && toConfig[prop] !== fromConfig[prop]) {
+            if (toConfig[prop] !== undefined &&
+                fromConfig[prop] !== undefined &&
+                toConfig[prop] !== fromConfig[prop]) {
                 conflicts.push({
                     property: prop,
                     oldValue: fromConfig[prop],
@@ -98,7 +100,13 @@ function buildConfigWithMergedAccounts(toConfig, fromConfig) {
 }
 function mergeConfigAccounts(toConfig, fromConfig) {
     const { configWithMergedAccounts, skippedAccountIds } = buildConfigWithMergedAccounts(toConfig, fromConfig);
-    (0, utils_1.writeConfigFile)(configWithMergedAccounts, (0, utils_1.getGlobalConfigFilePath)());
+    (0, utils_1.writeConfigFile)(configWithMergedAccounts, (0, index_1.getGlobalConfigFilePath)());
     return { configWithMergedAccounts, skippedAccountIds };
 }
 exports.mergeConfigAccounts = mergeConfigAccounts;
+function archiveConfigAtPath(configPath) {
+    const dir = path_1.default.dirname(configPath);
+    const archivedConfigPath = path_1.default.join(dir, config_1.ARCHIVED_HUBSPOT_CONFIG_YAML_FILE_NAME);
+    fs_1.default.renameSync(configPath, archivedConfigPath);
+}
+exports.archiveConfigAtPath = archiveConfigAtPath;

package/config/utils.d.ts

@@ -1,67 +1,19 @@
 import { ACCOUNT_IDENTIFIERS } from '../constants/config';
-import { HubSpotConfig, DeprecatedHubSpotConfigFields } from '../types/Config';
-import { HubSpotConfigAccount, AccountType, TokenInfo } from '../types/Accounts';
+import { HubSpotConfig, DeprecatedHubSpotConfigFields, HubSpotConfigErrorType, HubSpotConfigValidationResult } from '../types/Config';
+import { HubSpotConfigAccount } from '../types/Accounts';
 import { ValueOf } from '../types/Utils';
-export declare function getGlobalConfigFilePath(): string;
-export declare function getLocalConfigFilePath(): string | null;
 export declare function getLocalConfigDefaultFilePath(): string;
 export declare function getConfigPathEnvironmentVariables(): {
     useEnvironmentConfig: boolean;
     configFilePathFromEnvironment: string | undefined;
 };
+export declare function doesConfigFileExistAtPath(path: string): boolean;
 export declare function readConfigFile(configPath: string): string;
 export declare function removeUndefinedFieldsFromConfigAccount<T extends HubSpotConfigAccount | Partial<HubSpotConfigAccount> = HubSpotConfigAccount>(account: T): T;
-export declare function formatConfigForWrite(config: HubSpotConfig): {
-    accounts: ({
-        personalAccessKey: string;
-        auth: {
-            tokenInfo: TokenInfo;
-        };
-        accountType?: AccountType | undefined;
-        defaultCmsPublishMode?: import("../types/Files").CmsPublishMode | undefined;
-        parentAccountId?: number | undefined;
-        name: string;
-        accountId: number;
-        env: import("../types/Config").Environment;
-        authType: "apikey" | "oauth2" | "personalaccesskey";
-    } | {
-        auth: {
-            clientId: string;
-            clientSecret: string;
-            scopes: string[];
-            tokenInfo: TokenInfo;
-        };
-        accountType?: AccountType | undefined;
-        defaultCmsPublishMode?: import("../types/Files").CmsPublishMode | undefined;
-        parentAccountId?: number | undefined;
-        name: string;
-        accountId: number;
-        env: import("../types/Config").Environment;
-        authType: "apikey" | "oauth2" | "personalaccesskey";
-    } | {
-        apiKey: string;
-        accountType?: AccountType | undefined;
-        defaultCmsPublishMode?: import("../types/Files").CmsPublishMode | undefined;
-        parentAccountId?: number | undefined;
-        name: string;
-        accountId: number;
-        env: import("../types/Config").Environment;
-        authType: "apikey" | "oauth2" | "personalaccesskey";
-    })[];
-    allowAutoUpdates?: boolean | undefined;
-    defaultMode?: import("../types/Files").CmsPublishMode | undefined;
-    env?: import("../types/Config").Environment | undefined;
-    httpUseLocalhost?: boolean | undefined;
-    autoOpenBrowser?: boolean | undefined;
-    useCustomObjectHubfile?: boolean | undefined;
-    flags?: string[] | undefined;
-    defaultCmsPublishMode: import("../types/Files").CmsPublishMode | undefined;
-    httpTimeout: number | undefined;
-    allowUsageTracking: boolean | undefined;
-    defaultAccount?: number | undefined;
-};
+export declare function formatConfigForWrite(config: HubSpotConfig): HubSpotConfig;
 export declare function writeConfigFile(config: HubSpotConfig, configPath: string): void;
 export declare function normalizeParsedConfig(parsedConfig: HubSpotConfig & DeprecatedHubSpotConfigFields): HubSpotConfig;
+export declare function convertToDeprecatedConfig(config: HubSpotConfig): Partial<HubSpotConfig> & Partial<DeprecatedHubSpotConfigFields>;
 export declare function parseConfig(configSource: string, configPath: string): HubSpotConfig;
 export declare function buildConfigFromEnvironment(): HubSpotConfig;
 export declare function getAccountIdentifierAndType(accountIdentifier: string | number): {
@@ -71,4 +23,8 @@ export declare function getAccountIdentifierAndType(accountIdentifier: string |
 export declare function getConfigAccountByIdentifier(accounts: Array<HubSpotConfigAccount>, identifierFieldName: ValueOf<typeof ACCOUNT_IDENTIFIERS>, identifier: string | number): HubSpotConfigAccount | undefined;
 export declare function getConfigAccountByInferredIdentifier(accounts: Array<HubSpotConfigAccount>, accountIdentifier: string | number): HubSpotConfigAccount | undefined;
 export declare function getConfigAccountIndexById(accounts: Array<HubSpotConfigAccount>, id: number): number;
-export declare function isConfigAccountValid(account: Partial<HubSpotConfigAccount>): boolean;
+export declare function validateConfigAccount(account: Partial<HubSpotConfigAccount>): HubSpotConfigValidationResult;
+export declare function handleConfigFileSystemError(error: unknown, path: string): {
+    message?: string;
+    type: HubSpotConfigErrorType;
+};

package/config/utils.js

@@ -3,30 +3,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isConfigAccountValid = exports.getConfigAccountIndexById = exports.getConfigAccountByInferredIdentifier = exports.getConfigAccountByIdentifier = exports.getAccountIdentifierAndType = exports.buildConfigFromEnvironment = exports.parseConfig = exports.normalizeParsedConfig = exports.writeConfigFile = exports.formatConfigForWrite = exports.removeUndefinedFieldsFromConfigAccount = exports.readConfigFile = exports.getConfigPathEnvironmentVariables = exports.getLocalConfigDefaultFilePath = exports.getLocalConfigFilePath = exports.getGlobalConfigFilePath = void 0;
+exports.handleConfigFileSystemError = exports.validateConfigAccount = exports.getConfigAccountIndexById = exports.getConfigAccountByInferredIdentifier = exports.getConfigAccountByIdentifier = exports.getAccountIdentifierAndType = exports.buildConfigFromEnvironment = exports.parseConfig = exports.convertToDeprecatedConfig = exports.normalizeParsedConfig = exports.writeConfigFile = exports.formatConfigForWrite = exports.removeUndefinedFieldsFromConfigAccount = exports.readConfigFile = exports.doesConfigFileExistAtPath = exports.getConfigPathEnvironmentVariables = exports.getLocalConfigDefaultFilePath = void 0;
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const js_yaml_1 = __importDefault(require("js-yaml"));
-const findup_sync_1 = __importDefault(require("findup-sync"));
 const config_1 = require("../constants/config");
 const auth_1 = require("../constants/auth");
 const FileSystemError_1 = require("../models/FileSystemError");
-const logger_1 = require("../lib/logger");
 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;
-}
-exports.getGlobalConfigFilePath = getGlobalConfigFilePath;
-function getLocalConfigFilePath() {
-    return (0, findup_sync_1.default)([
-        config_1.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME,
-        config_1.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME.replace('.yml', '.yaml'),
-    ], { cwd: (0, path_1.getCwd)() });
-}
-exports.getLocalConfigFilePath = getLocalConfigFilePath;
 function getLocalConfigDefaultFilePath() {
     return `${(0, path_1.getCwd)()}/${config_1.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME}`;
 }
@@ -44,18 +31,24 @@ function getConfigPathEnvironmentVariables() {
     };
 }
 exports.getConfigPathEnvironmentVariables = getConfigPathEnvironmentVariables;
+function doesConfigFileExistAtPath(path) {
+    try {
+        return fs_extra_1.default.existsSync(path);
+    }
+    catch (error) {
+        const { message, type } = handleConfigFileSystemError(error, path);
+        throw new HubSpotConfigError_1.HubSpotConfigError(message, type, config_1.HUBSPOT_CONFIG_OPERATIONS.READ, { cause: error });
+    }
+}
+exports.doesConfigFileExistAtPath = doesConfigFileExistAtPath;
 function readConfigFile(configPath) {
-    let source = '';
     try {
-        source = fs_extra_1.default.readFileSync(configPath).toString();
+        return fs_extra_1.default.readFileSync(configPath).toString();
     }
     catch (err) {
-        throw new FileSystemError_1.FileSystemError({ cause: err }, {
-            filepath: configPath,
-            operation: 'read',
-        });
+        const { message, type } = handleConfigFileSystemError(err, configPath);
+        throw new HubSpotConfigError_1.HubSpotConfigError(message, type, config_1.HUBSPOT_CONFIG_OPERATIONS.READ, { cause: err });
     }
-    return source;
 }
 exports.readConfigFile = readConfigFile;
 function removeUndefinedFieldsFromConfigAccount(account) {
@@ -98,20 +91,26 @@ function formatConfigForWrite(config) {
         ...rest,
         accounts: accounts.map(account => {
             const { name, accountId, env, authType, ...rest } = account;
-            return {
+            const orderedAccount = {
                 name,
                 accountId,
                 env,
                 authType,
                 ...rest,
+                // using ...rest messes with the typing
             };
+            return removeUndefinedFieldsFromConfigAccount(orderedAccount);
         }),
     };
-    return removeUndefinedFieldsFromConfigAccount(orderedConfig);
+    return orderedConfig;
 }
 exports.formatConfigForWrite = formatConfigForWrite;
 function writeConfigFile(config, configPath) {
-    const source = js_yaml_1.default.dump(JSON.parse(JSON.stringify(formatConfigForWrite(config), null, 2)));
+    const formattedConfig = formatConfigForWrite(config);
+    const configToWrite = configPath == config_1.GLOBAL_CONFIG_PATH
+        ? formattedConfig
+        : convertToDeprecatedConfig(formattedConfig);
+    const source = js_yaml_1.default.dump(configToWrite);
     try {
         fs_extra_1.default.ensureFileSync(configPath);
         fs_extra_1.default.writeFileSync(configPath, source);
@@ -136,6 +135,9 @@ function getAccountType(sandboxAccountType) {
     return config_1.HUBSPOT_ACCOUNT_TYPES.STANDARD;
 }
 function normalizeParsedConfig(parsedConfig) {
+    if (!parsedConfig.portals && !parsedConfig.accounts) {
+        parsedConfig.accounts = [];
+    }
     if (parsedConfig.portals) {
         parsedConfig.accounts = parsedConfig.portals.map(account => {
             if (account.portalId) {
@@ -164,6 +166,30 @@ function normalizeParsedConfig(parsedConfig) {
     return parsedConfig;
 }
 exports.normalizeParsedConfig = normalizeParsedConfig;
+function convertToDeprecatedConfig(config) {
+    const deprecatedConfig = structuredClone(config);
+    if (config.defaultAccount) {
+        const defaultAccount = getConfigAccountByIdentifier(config.accounts, config_1.ACCOUNT_IDENTIFIERS.ACCOUNT_ID, config.defaultAccount);
+        if (defaultAccount) {
+            deprecatedConfig.defaultPortal = defaultAccount.name;
+            delete deprecatedConfig.defaultAccount;
+        }
+    }
+    const portals = config.accounts.map(account => {
+        if (account.accountId) {
+            const deprecatedAccount = structuredClone(account);
+            deprecatedAccount.portalId = account.accountId;
+            // @ts-expect-error deleting accountId is intential since using deprecated config format
+            delete deprecatedAccount.accountId;
+            return deprecatedAccount;
+        }
+        return account;
+    });
+    deprecatedConfig.portals = portals;
+    delete deprecatedConfig.accounts;
+    return deprecatedConfig;
+}
+exports.convertToDeprecatedConfig = convertToDeprecatedConfig;
 function parseConfig(configSource, configPath) {
     let parsedYaml;
     try {
@@ -274,54 +300,74 @@ function getConfigAccountByIdentifier(accounts, identifierFieldName, identifier)
 exports.getConfigAccountByIdentifier = getConfigAccountByIdentifier;
 function getConfigAccountByInferredIdentifier(accounts, accountIdentifier) {
     const { identifier, identifierType } = getAccountIdentifierAndType(accountIdentifier);
-    return accounts.find(account => account[identifierType] === identifier);
+    const account = getConfigAccountByIdentifier(accounts, identifierType, identifier);
+    if (account) {
+        return account;
+    }
+    // Fallback to handle accounts with numbers as names
+    return getConfigAccountByIdentifier(accounts, config_1.ACCOUNT_IDENTIFIERS.NAME, String(accountIdentifier));
 }
 exports.getConfigAccountByInferredIdentifier = getConfigAccountByInferredIdentifier;
 function getConfigAccountIndexById(accounts, id) {
     return accounts.findIndex(account => account.accountId === id);
 }
 exports.getConfigAccountIndexById = getConfigAccountIndexById;
-function isConfigAccountValid(account) {
+function validateConfigAccount(account) {
+    const validationErrors = [];
     if (!account || typeof account !== 'object') {
-        logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingAccount'));
-        return false;
+        validationErrors.push((0, lang_1.i18n)('config.utils.validateConfigAccount.missingAccount'));
+        return { isValid: false, errors: validationErrors };
     }
     if (!account.accountId) {
-        logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingAccountId'));
-        return false;
+        validationErrors.push((0, lang_1.i18n)('config.utils.validateConfigAccount.missingAccountId'));
+        return { isValid: false, errors: validationErrors };
     }
     if (!account.authType) {
-        logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingAuthType', {
+        validationErrors.push((0, lang_1.i18n)('config.utils.validateConfigAccount.missingAuthType', {
             accountId: account.accountId,
         }));
-        return false;
+        return { isValid: false, errors: validationErrors };
     }
-    let valid = false;
     if (account.authType === auth_1.PERSONAL_ACCESS_KEY_AUTH_METHOD.value) {
-        valid =
-            'personalAccessKey' in account && Boolean(account.personalAccessKey);
-        if (!valid) {
-            logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingPersonalAccessKey', {
+        const isValidPersonalAccessKeyAccount = 'personalAccessKey' in account && Boolean(account.personalAccessKey);
+        if (!isValidPersonalAccessKeyAccount) {
+            validationErrors.push((0, lang_1.i18n)('config.utils.validateConfigAccount.missingPersonalAccessKey', {
                 accountId: account.accountId,
             }));
         }
     }
     if (account.authType === auth_1.OAUTH_AUTH_METHOD.value) {
-        valid = 'auth' in account && Boolean(account.auth);
-        if (!valid) {
-            logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingAuth', {
+        const isValidOAuthAccount = 'auth' in account && Boolean(account.auth);
+        if (!isValidOAuthAccount) {
+            validationErrors.push((0, lang_1.i18n)('config.utils.validateConfigAccount.missingAuth', {
                 accountId: account.accountId,
             }));
         }
     }
     if (account.authType === auth_1.API_KEY_AUTH_METHOD.value) {
-        valid = 'apiKey' in account && Boolean(account.apiKey);
-        if (!valid) {
-            logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingApiKey', {
+        const isValidAPIKeyAccount = 'apiKey' in account && Boolean(account.apiKey);
+        if (!isValidAPIKeyAccount) {
+            validationErrors.push((0, lang_1.i18n)('config.utils.validateConfigAccount.missingApiKey', {
                 accountId: account.accountId,
             }));
         }
     }
-    return valid;
+    return { isValid: validationErrors.length === 0, errors: validationErrors };
+}
+exports.validateConfigAccount = validateConfigAccount;
+function handleConfigFileSystemError(error, path) {
+    let message;
+    let type = config_1.HUBSPOT_CONFIG_ERROR_TYPES.UNKNOWN;
+    if (error instanceof Error && 'code' in error) {
+        if (error.code === 'ENOENT') {
+            message = (0, lang_1.i18n)('config.utils.handleConfigFileSystemError.configNotFoundError', { path });
+            type = config_1.HUBSPOT_CONFIG_ERROR_TYPES.CONFIG_NOT_FOUND;
+        }
+        else if (error.code === 'EACCES') {
+            message = (0, lang_1.i18n)('config.utils.handleConfigFileSystemError.insufficientPermissionsError', { path });
+            type = config_1.HUBSPOT_CONFIG_ERROR_TYPES.INSUFFICIENT_PERMISSIONS;
+        }
+    }
+    return { message, type };
 }
-exports.isConfigAccountValid = isConfigAccountValid;
+exports.handleConfigFileSystemError = handleConfigFileSystemError;

package/constants/config.d.ts

@@ -59,14 +59,17 @@ export declare const ACCOUNT_IDENTIFIERS: {
 };
 export declare const HUBSPOT_CONFIG_ERROR_TYPES: {
     readonly CONFIG_NOT_FOUND: "CONFIG_NOT_FOUND";
+    readonly INSUFFICIENT_PERMISSIONS: "INSUFFICIENT_PERMISSIONS";
     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";
+    readonly UNKNOWN: "UNKNOWN";
 };
 export declare const HUBSPOT_CONFIG_OPERATIONS: {
     readonly READ: "READ";
     readonly WRITE: "WRITE";
+    readonly DELETE: "DELETE";
 };

package/constants/config.js

@@ -68,14 +68,17 @@ exports.ACCOUNT_IDENTIFIERS = {
 };
 exports.HUBSPOT_CONFIG_ERROR_TYPES = {
     CONFIG_NOT_FOUND: 'CONFIG_NOT_FOUND',
+    INSUFFICIENT_PERMISSIONS: 'INSUFFICIENT_PERMISSIONS',
     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',
+    UNKNOWN: 'UNKNOWN',
 };
 exports.HUBSPOT_CONFIG_OPERATIONS = {
     READ: 'READ',
     WRITE: 'WRITE',
+    DELETE: 'DELETE',
 };

package/lang/en.json

@@ -251,11 +251,11 @@
       "error": "No config file found.",
       "errorWithPath": "No config file found at {{ path }}."
     },
-    "isConfigValid": {
-      "missingAccounts": "Invalid config: no accounts found",
-      "duplicateAccountIds": "Invalid config: multiple accounts with accountId: {{ accountId }}",
-      "duplicateAccountNames": "Invalid config: multiple accounts with name: {{ accountName }}",
-      "invalidAccountName": "Invalid config: account name {{ accountName }} contains spaces"
+    "validateConfig": {
+      "missingAccounts": "No accounts found",
+      "duplicateAccountIds": "Multiple accounts with accountId: {{ accountId }}",
+      "duplicateAccountNames": "Multiple accounts with name: {{ accountName }}",
+      "invalidAccountName": "Account name {{ accountName }} contains spaces"
     },
     "getConfigAccountById": {
       "error": "No account with id {{ accountId }} exists in config"
@@ -276,7 +276,7 @@
       "accountNotFound": "Attempting to update account with id {{ id }}, but that account was not found in config"
     },
     "setConfigAccountAsDefault": {
-      "accountNotFound": "Attempted to set account with id {{ accountId }} as default, but that account was not found in config"
+      "accountNotFound": "Attempted to set account with identifier {{ identifier }} as default, but that account was not found in config"
     },
     "renameConfigAccount": {
       "accountNotFound": "Attempted to rename account with name {{ currentName }}, but that account was not found in config",
@@ -291,14 +291,21 @@
     "updateDefaultCmsPublishMode": {
       "invalidCmsPublishMode": "Error updating config default CMS publish mode: CMS publish can only be set to 'draft' or 'publish'"
     },
+    "getConfigAccountEnvironment": {
+      "accountNotFound": "Attempted to get environment for account with identifier {{ identifier }}, but that account was not found in config"
+    },
     "utils": {
-      "isConfigAccountValid": {
-        "missingAccount": "Invalid config: at least one account in config is missing data",
-        "missingAuthType": "Invalid config: account {{ accountId }} has no authType",
-        "missingAccountId": "Invalid config: at least one account in config is missing accountId",
-        "missingApiKey": "Invalid config: account {{ accountId }} has authType of apikey but is missing the apiKey field",
-        "missingAuth": "Invalid config: account {{ accountId }} has authtype of oauth2 but is missing auth data",
-        "missingPersonalAccessKey": "Invalid config: account {{ accountId }} has authType of personalAccessKey but is missing the personalAccessKey field"
+      "handleConfigFileSystemError": {
+        "configNotFoundError": "No config file found at {{ path }}.",
+        "insufficientPermissionsError": "Insufficient permissions to access config file at {{ path }}"
+      },
+      "validateConfigAccount": {
+        "missingAccount": "At least one account in config is missing data",
+        "missingAuthType": "Account {{ accountId }} has no authType",
+        "missingAccountId": "At least one account in config is missing accountId",
+        "missingApiKey": "Account {{ accountId }} has authType of apikey but is missing the apiKey field",
+        "missingAuth": "Account {{ accountId }} has authtype of oauth2 but is missing auth data",
+        "missingPersonalAccessKey": "Account {{ accountId }} has authType of personalAccessKey but is missing the personalAccessKey field"
       },
       "getConfigPathEnvironmentVariables": {
         "invalidEnvironmentVariables": "USE_ENVIRONMENT_HUBSPOT_CONFIG and HUBSPOT_CONFIG_PATH cannot both be set simultaneously"
@@ -382,7 +389,7 @@
       }
     },
     "HubSpotConfigError": {
-      "baseMessage": "An error occurred while {{ operation }} your HubSpot config {{ configType }}: {{ message }}"
+      "baseMessage": "An error occurred while {{ operation }} your HubSpot config {{ configType }}{{ message }}"
     }
   },
   "utils": {

package/lib/personalAccessKey.js

@@ -121,9 +121,7 @@ async function authorizedScopesForPortalAndUser(accountId) {
 exports.authorizedScopesForPortalAndUser = authorizedScopesForPortalAndUser;
 async function updateConfigWithAccessToken(token, personalAccessKey, env, name, makeDefault = false) {
     const { portalId, accessToken, expiresAt, accountType } = token;
-    const account = name
-        ? (0, config_1.getConfigAccountIfExists)(name)
-        : (0, config_1.getConfigDefaultAccountIfExists)();
+    const account = (0, config_1.getConfigAccountIfExists)(portalId);
     const accountEnv = env || account?.env || environments_1.ENVIRONMENTS.PROD;
     let parentAccountId;
     try {
@@ -161,12 +159,12 @@ async function updateConfigWithAccessToken(token, personalAccessKey, env, name,
         accountId: portalId,
         accountType,
         personalAccessKey,
-        name: name || account?.name || token.hubName,
+        name: name || account?.name,
         authType: auth_1.PERSONAL_ACCESS_KEY_AUTH_METHOD.value,
         auth: { tokenInfo: { accessToken, expiresAt } },
         parentAccountId,
         env: accountEnv,
-    };
+    }; // Account may temporarily not have a name before prompted to add one in the CLI
     // Add new account if it doesn't exist, otherwise update existing account
     if (account) {
         (0, config_1.updateConfigAccount)(updatedAccount);

package/models/HubSpotConfigError.d.ts

@@ -2,5 +2,5 @@ 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);
+    constructor(message: string | undefined, type: HubSpotConfigErrorType, operation: HubSpotConfigOperation, options?: ErrorOptions);
 }

package/models/HubSpotConfigError.js

@@ -4,6 +4,11 @@ exports.HubSpotConfigError = void 0;
 const config_1 = require("../constants/config");
 const lang_1 = require("../utils/lang");
 const NAME = 'HubSpotConfigError';
+const OPERATION_TEXT = {
+    [config_1.HUBSPOT_CONFIG_OPERATIONS.READ]: 'reading',
+    [config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE]: 'writing to',
+    [config_1.HUBSPOT_CONFIG_OPERATIONS.DELETE]: 'deleting',
+};
 function isEnvironmentError(type) {
     return type === config_1.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_ENVIRONMENT_VARIABLES;
 }
@@ -14,10 +19,10 @@ class HubSpotConfigError extends Error {
         const configType = isEnvironmentError(type)
             ? 'environment variables'
             : 'file';
-        const operationText = operation === config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE ? 'writing to' : 'reading';
+        const operationText = OPERATION_TEXT[operation];
         const withBaseMessage = (0, lang_1.i18n)('models.HubSpotConfigError.baseMessage', {
             configType,
-            message,
+            message: message ? `: ${message}` : '',
             operation: operationText,
         });
         super(withBaseMessage, options);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "0.5.0-experimental.8",
+    "version": "0.6.0-experimental.0",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "repository": {
         "type": "git",
@@ -11,11 +11,11 @@
         "access": "public"
     },
     "scripts": {
-        "build": "ts-node ./scripts/build.ts",
+        "build": "tsx ./scripts/build.ts",
         "lint": "eslint --max-warnings=0 . && prettier . --check",
         "local-dev": "yarn build && cd dist && yarn link && cd .. && tsc --watch --rootDir . --outdir dist",
         "prettier:write": "prettier . --write",
-        "release": "ts-node ./scripts/release.ts release",
+        "release": "tsx ./scripts/release.ts release",
         "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ./node_modules/.bin/jest"
     },
     "license": "Apache-2.0",
@@ -39,7 +39,7 @@
         "jest": "^29.5.0",
         "open": "^8.4.2",
         "ts-jest": "^29.0.5",
-        "ts-node": "^10.9.2",
+        "tsx": "^4.20.6",
         "typescript": "^4.9.5",
         "yargs": "^17.7.2"
     },

package/types/Config.d.ts

@@ -34,3 +34,7 @@ export type HubSpotState = {
 };
 export type HubSpotConfigErrorType = ValueOf<typeof HUBSPOT_CONFIG_ERROR_TYPES>;
 export type HubSpotConfigOperation = ValueOf<typeof HUBSPOT_CONFIG_OPERATIONS>;
+export type HubSpotConfigValidationResult = {
+    isValid: boolean;
+    errors: Array<string>;
+};