@hubspot/local-dev-lib 3.3.2 → 3.4.0-beta.0

package/config/configFile.js

@@ -5,8 +5,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.writeConfigToFile = exports.loadConfigFromFile = exports.parseConfig = exports.readConfigFile = exports.deleteConfigFile = exports.configFileIsBlank = exports.configFileExists = exports.getConfigFilePath = void 0;
 const fs_extra_1 = __importDefault(require("fs-extra"));
-const path_1 = __importDefault(require("path"));
-const os_1 = __importDefault(require("os"));
 const js_yaml_1 = __importDefault(require("js-yaml"));
 const logger_1 = require("../lib/logger");
 const config_1 = require("../constants/config");
@@ -15,7 +13,7 @@ const lang_1 = require("../utils/lang");
 const FileSystemError_1 = require("../models/FileSystemError");
 const i18nKey = 'config.configFile';
 function getConfigFilePath() {
-    return path_1.default.join(os_1.default.homedir(), config_1.HUBSPOT_CONFIGURATION_FOLDER, config_1.HUBSPOT_CONFIGURATION_FILE);
+    return config_1.GLOBAL_CONFIG_PATH;
 }
 exports.getConfigFilePath = getConfigFilePath;
 function configFileExists() {

package/config/index.d.ts

@@ -31,6 +31,7 @@ export declare function isTrackingAllowed(): boolean;
 export declare function getEnv(nameOrId?: string | number): import("../types/Config").Environment;
 export declare function getAccountType(accountType?: AccountType, sandboxAccountType?: string | null): AccountType;
 export declare function getConfigDefaultAccount(): string | number | null | undefined;
+export declare function getDisplayDefaultAccount(): string | number | null | undefined;
 export declare function getConfigAccounts(): Array<CLIAccount_NEW> | Array<CLIAccount_DEPRECATED> | null | undefined;
 export declare function updateDefaultCmsPublishMode(cmsPublishMode: CmsPublishMode): void | CLIConfig_NEW | null;
 export declare function getCWDAccountOverride(): string | number | null | undefined;

package/config/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findConfig = exports.setConfigPath = exports.setConfig = exports.getOrderedConfig = exports.getOrderedAccount = exports.getConfigAccountId = exports.getDefaultAccountOverrideFilePath = exports.getCWDAccountOverride = exports.updateDefaultCmsPublishMode = exports.getConfigAccounts = exports.getConfigDefaultAccount = exports.getAccountType = exports.getEnv = exports.isTrackingAllowed = exports.isConfigFlagEnabled = exports.deleteConfigFile = exports.updateAllowUsageTracking = exports.updateHttpTimeout = exports.deleteAccount = exports.removeSandboxAccountFromConfig = exports.getAccountId = exports.renameAccount = exports.updateDefaultAccount = exports.updateAccountConfig = exports.accountNameExistsInConfig = exports.getAccountConfig = exports.configFileExists = exports.getConfigPath = exports.writeConfig = exports.getConfig = exports.deleteEmptyConfigFile = exports.createEmptyConfigFile = exports.loadConfigFromEnvironment = exports.validateConfig = exports.getAndLoadConfigIfNeeded = exports.loadConfig = void 0;
+exports.findConfig = exports.setConfigPath = exports.setConfig = exports.getOrderedConfig = exports.getOrderedAccount = exports.getConfigAccountId = exports.getDefaultAccountOverrideFilePath = exports.getCWDAccountOverride = exports.updateDefaultCmsPublishMode = exports.getConfigAccounts = exports.getDisplayDefaultAccount = exports.getConfigDefaultAccount = exports.getAccountType = exports.getEnv = exports.isTrackingAllowed = exports.isConfigFlagEnabled = exports.deleteConfigFile = exports.updateAllowUsageTracking = exports.updateHttpTimeout = exports.deleteAccount = exports.removeSandboxAccountFromConfig = exports.getAccountId = exports.renameAccount = exports.updateDefaultAccount = exports.updateAccountConfig = exports.accountNameExistsInConfig = exports.getAccountConfig = exports.configFileExists = exports.getConfigPath = exports.writeConfig = exports.getConfig = exports.deleteEmptyConfigFile = exports.createEmptyConfigFile = exports.loadConfigFromEnvironment = exports.validateConfig = exports.getAndLoadConfigIfNeeded = exports.loadConfig = void 0;
 const config_DEPRECATED = __importStar(require("./config_DEPRECATED"));
 const CLIConfiguration_1 = require("./CLIConfiguration");
 const configFile_1 = require("./configFile");
@@ -237,6 +237,13 @@ function getConfigDefaultAccount() {
     return config_DEPRECATED.getConfigDefaultAccount();
 }
 exports.getConfigDefaultAccount = getConfigDefaultAccount;
+function getDisplayDefaultAccount() {
+    if (CLIConfiguration_1.CLIConfiguration.isActive()) {
+        return CLIConfiguration_1.CLIConfiguration.config?.defaultAccount;
+    }
+    return config_DEPRECATED.getConfigDefaultAccount();
+}
+exports.getDisplayDefaultAccount = getDisplayDefaultAccount;
 function getConfigAccounts() {
     if (CLIConfiguration_1.CLIConfiguration.isActive()) {
         return CLIConfiguration_1.CLIConfiguration.getConfigAccounts();

package/config/migrate.d.ts

@@ -0,0 +1,22 @@
+import { CLIConfig_DEPRECATED, CLIConfig_NEW, Environment } from '../types/Config';
+import { CmsPublishMode } from '../types/Files';
+export declare function getDeprecatedConfig(configPath?: string): CLIConfig_DEPRECATED | null;
+export declare function getGlobalConfig(): CLIConfig_NEW | null;
+export declare function configFileExists(useHiddenConfig?: boolean, configPath?: string): boolean;
+export declare function getConfigPath(configPath?: string, useHiddenConfig?: boolean): string | null;
+export declare function migrateConfig(deprecatedConfig: CLIConfig_DEPRECATED | null): void;
+type ConflictValue = boolean | string | number | CmsPublishMode | Environment;
+export type ConflictProperty = {
+    property: keyof CLIConfig_NEW;
+    oldValue: ConflictValue;
+    newValue: ConflictValue;
+};
+export declare function mergeConfigProperties(globalConfig: CLIConfig_NEW, deprecatedConfig: CLIConfig_DEPRECATED, force?: boolean): {
+    initialConfig: CLIConfig_NEW;
+    conflicts: Array<ConflictProperty>;
+};
+export declare function mergeExistingConfigs(globalConfig: CLIConfig_NEW, deprecatedConfig: CLIConfig_DEPRECATED): {
+    finalConfig: CLIConfig_NEW;
+    skippedAccountIds: Array<string | number>;
+};
+export {};

package/config/migrate.js

@@ -0,0 +1,166 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeExistingConfigs = exports.mergeConfigProperties = exports.migrateConfig = exports.getConfigPath = exports.configFileExists = exports.getGlobalConfig = exports.getDeprecatedConfig = void 0;
+const fs_1 = __importDefault(require("fs"));
+const config_DEPRECATED = __importStar(require("./config_DEPRECATED"));
+const CLIConfiguration_1 = require("./CLIConfiguration");
+const index_1 = require("./index");
+const configFile_1 = require("./configFile");
+const config_1 = require("../constants/config");
+const lang_1 = require("../utils/lang");
+const i18nKey = 'config.migrate';
+function getDeprecatedConfig(configPath) {
+    return config_DEPRECATED.loadConfig(configPath);
+}
+exports.getDeprecatedConfig = getDeprecatedConfig;
+function getGlobalConfig() {
+    if (CLIConfiguration_1.CLIConfiguration.isActive()) {
+        return CLIConfiguration_1.CLIConfiguration.config;
+    }
+    return null;
+}
+exports.getGlobalConfig = getGlobalConfig;
+function configFileExists(useHiddenConfig = false, configPath) {
+    return useHiddenConfig
+        ? (0, configFile_1.configFileExists)()
+        : Boolean(configPath && fs_1.default.existsSync(configPath)) ||
+            Boolean(config_DEPRECATED.loadConfig(configPath));
+}
+exports.configFileExists = configFileExists;
+function getConfigPath(configPath, useHiddenConfig = false) {
+    if (useHiddenConfig) {
+        return (0, configFile_1.getConfigFilePath)();
+    }
+    return config_DEPRECATED.getConfigPath(configPath);
+}
+exports.getConfigPath = getConfigPath;
+function writeGlobalConfigFile(updatedConfig, isMigrating = false) {
+    const updatedConfigJson = JSON.stringify(updatedConfig);
+    if (isMigrating) {
+        (0, index_1.createEmptyConfigFile)({}, true);
+    }
+    (0, index_1.loadConfig)('');
+    try {
+        (0, index_1.writeConfig)({ source: updatedConfigJson });
+        config_DEPRECATED.deleteConfigFile();
+    }
+    catch (error) {
+        (0, index_1.deleteEmptyConfigFile)();
+        throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.writeConfig`, { configPath: config_1.GLOBAL_CONFIG_PATH }), { cause: error });
+    }
+}
+function migrateConfig(deprecatedConfig) {
+    if (!deprecatedConfig) {
+        throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.noDeprecatedConfig`));
+    }
+    const { defaultPortal, portals, ...rest } = deprecatedConfig;
+    const updatedConfig = {
+        ...rest,
+        defaultAccount: defaultPortal,
+        accounts: portals
+            .filter(({ portalId }) => portalId !== undefined)
+            .map(({ portalId, ...rest }) => ({
+            ...rest,
+            accountId: portalId,
+        })),
+    };
+    writeGlobalConfigFile(updatedConfig, true);
+}
+exports.migrateConfig = migrateConfig;
+function mergeConfigProperties(globalConfig, deprecatedConfig, force) {
+    const propertiesToCheck = [
+        config_1.DEFAULT_CMS_PUBLISH_MODE,
+        config_1.HTTP_TIMEOUT,
+        config_1.ENV,
+        config_1.HTTP_USE_LOCALHOST,
+        config_1.ALLOW_USAGE_TRACKING,
+    ];
+    const conflicts = [];
+    propertiesToCheck.forEach(prop => {
+        if (prop in globalConfig && prop in deprecatedConfig) {
+            if (force || globalConfig[prop] === deprecatedConfig[prop]) {
+                // @ts-expect-error Cannot reconcile CLIConfig_NEW and CLIConfig_DEPRECATED types
+                globalConfig[prop] = deprecatedConfig[prop];
+            }
+            else {
+                conflicts.push({
+                    property: prop,
+                    oldValue: deprecatedConfig[prop],
+                    newValue: globalConfig[prop],
+                });
+            }
+        }
+    });
+    if (config_1.DEFAULT_ACCOUNT in globalConfig &&
+        config_1.DEFAULT_PORTAL in deprecatedConfig &&
+        globalConfig.defaultAccount !== deprecatedConfig.defaultPortal) {
+        conflicts.push({
+            property: config_1.DEFAULT_ACCOUNT,
+            oldValue: deprecatedConfig.defaultPortal,
+            newValue: globalConfig.defaultAccount,
+        });
+    }
+    else if (config_1.DEFAULT_PORTAL in deprecatedConfig) {
+        globalConfig.defaultAccount = deprecatedConfig.defaultPortal;
+    }
+    return { initialConfig: globalConfig, conflicts };
+}
+exports.mergeConfigProperties = mergeConfigProperties;
+function mergeAccounts(globalConfig, deprecatedConfig) {
+    let existingAccountIds = [];
+    const skippedAccountIds = [];
+    if (globalConfig.accounts && deprecatedConfig.portals) {
+        existingAccountIds = globalConfig.accounts.map(account => account.accountId);
+        const newAccounts = deprecatedConfig.portals
+            .filter(portal => {
+            const isExisting = existingAccountIds.includes(portal.portalId);
+            if (isExisting) {
+                skippedAccountIds.push(portal.portalId);
+            }
+            return !isExisting;
+        })
+            .map(({ portalId, ...rest }) => ({
+            ...rest,
+            accountId: portalId,
+        }));
+        if (newAccounts.length > 0) {
+            globalConfig.accounts.push(...newAccounts);
+        }
+    }
+    return {
+        finalConfig: globalConfig,
+        skippedAccountIds,
+    };
+}
+function mergeExistingConfigs(globalConfig, deprecatedConfig) {
+    const { finalConfig, skippedAccountIds } = mergeAccounts(globalConfig, deprecatedConfig);
+    writeGlobalConfigFile(finalConfig);
+    return { finalConfig, skippedAccountIds };
+}
+exports.mergeExistingConfigs = mergeExistingConfigs;

package/constants/config.d.ts

@@ -1,9 +1,17 @@
 export declare const DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = "hubspot.config.yml";
 export declare const HUBSPOT_CONFIGURATION_FOLDER = ".hscli";
 export declare const HUBSPOT_CONFIGURATION_FILE = "config.yml";
+export declare const GLOBAL_CONFIG_PATH: string;
 export declare const DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME = ".hsaccount";
 export declare const DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID = "DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID";
 export declare const DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND = "DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND";
+export declare const DEFAULT_CMS_PUBLISH_MODE = "defaultCmsPublishMode";
+export declare const HTTP_TIMEOUT = "httpTimeout";
+export declare const ENV = "env";
+export declare const HTTP_USE_LOCALHOST = "httpUseLocalhost";
+export declare const ALLOW_USAGE_TRACKING = "allowUsageTracking";
+export declare const DEFAULT_ACCOUNT = "defaultAccount";
+export declare const DEFAULT_PORTAL = "defaultPortal";
 export declare const MIN_HTTP_TIMEOUT = 3000;
 export declare const HUBSPOT_ACCOUNT_TYPES: {
     readonly DEVELOPMENT_SANDBOX: "DEVELOPMENT_SANDBOX";

package/constants/config.js

@@ -1,13 +1,26 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HUBSPOT_ACCOUNT_TYPE_STRINGS = exports.HUBSPOT_ACCOUNT_TYPES = exports.MIN_HTTP_TIMEOUT = exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND = exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID = exports.DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME = exports.HUBSPOT_CONFIGURATION_FILE = exports.HUBSPOT_CONFIGURATION_FOLDER = exports.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = void 0;
+exports.HUBSPOT_ACCOUNT_TYPE_STRINGS = exports.HUBSPOT_ACCOUNT_TYPES = exports.MIN_HTTP_TIMEOUT = exports.DEFAULT_PORTAL = exports.DEFAULT_ACCOUNT = 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.GLOBAL_CONFIG_PATH = exports.HUBSPOT_CONFIGURATION_FILE = exports.HUBSPOT_CONFIGURATION_FOLDER = 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"));
 exports.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = 'hubspot.config.yml';
 exports.HUBSPOT_CONFIGURATION_FOLDER = '.hscli';
 exports.HUBSPOT_CONFIGURATION_FILE = 'config.yml';
+exports.GLOBAL_CONFIG_PATH = path_1.default.join(os_1.default.homedir(), exports.HUBSPOT_CONFIGURATION_FOLDER, exports.HUBSPOT_CONFIGURATION_FILE);
 exports.DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME = '.hsaccount';
 exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID = 'DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID';
 exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND = 'DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND';
+exports.DEFAULT_CMS_PUBLISH_MODE = 'defaultCmsPublishMode';
+exports.HTTP_TIMEOUT = 'httpTimeout';
+exports.ENV = 'env';
+exports.HTTP_USE_LOCALHOST = 'httpUseLocalhost';
+exports.ALLOW_USAGE_TRACKING = 'allowUsageTracking';
+exports.DEFAULT_ACCOUNT = 'defaultAccount';
+exports.DEFAULT_PORTAL = 'defaultPortal';
 exports.MIN_HTTP_TIMEOUT = 3000;
 exports.HUBSPOT_ACCOUNT_TYPES = {
     DEVELOPMENT_SANDBOX: 'DEVELOPMENT_SANDBOX',

package/lang/en.json

@@ -311,6 +311,12 @@
         "missingEnv": "Unable to load config from environment variables: Missing env",
         "unknownAuthType": "Unable to load config from environment variables: Unknown auth type"
       }
+    },
+    "migrate": {
+      "errors": {
+        "writeConfig": "Unable to write global configuration file at {{ configPath }}.",
+        "noDeprecatedConfig": "No deprecated configuration file found. Skipping migration to global config."
+      }
     }
   },
   "models": {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "3.3.2",
+    "version": "3.4.0-beta.0",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "repository": {
         "type": "git",
@@ -50,6 +50,7 @@
         "./http": "./http/index.js",
         "./http/*": "./http/*.js",
         "./config/getAccountIdentifier": "./config/getAccountIdentifier.js",
+        "./config/migrate": "./config/migrate.js",
         "./config": "./config/index.js",
         "./constants/*": "./constants/*.js",
         "./models/*": "./models/*.js",
@@ -57,13 +58,13 @@
     },
     "dependencies": {
         "address": "2.0.2",
-        "axios": "1.7.2",
+        "axios": "1.8.3",
         "chalk": "2.4.2",
         "chokidar": "3.6.0",
         "content-disposition": "0.5.4",
         "cors": "2.8.5",
         "debounce": "1.2.1",
-        "express": "4.19.2",
+        "express": "4.21.2",
         "extract-zip": "2.0.1",
         "findup-sync": "5.0.0",
         "fs-extra": "11.2.0",