@hubspot/local-dev-lib 0.2.3 → 0.2.4-experimental.0

package/config/config_DEPRECATED.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.isConfigFlagEnabled = exports.loadConfigFromEnvironment = exports.deleteConfigFile = exports.deleteEmptyConfigFile = exports.createEmptyConfigFile = exports.deleteAccount = exports.renameAccount = exports.updateAllowUsageTracking = exports.updateHttpTimeout = exports.updateDefaultMode = exports.updateDefaultAccount = exports.updateAccountConfig = exports.removeSandboxAccountFromConfig = exports.getAccountId = exports.getAccountConfig = exports.getEnv = exports.findConfig = exports.getAndLoadConfigIfNeeded = exports.isTrackingAllowed = exports.loadConfig = exports.writeConfig = exports.getOrderedConfig = exports.getOrderedAccount = exports.accountNameExistsInConfig = exports.validateConfig = exports.getConfigPath = exports.setConfigPath = exports.getConfigAccountId = exports.getConfigDefaultAccount = exports.getConfigAccounts = exports.setConfig = exports.getConfig = void 0;
+exports.isConfigFlagEnabled = exports.loadConfigFromEnvironment = exports.deleteConfigFile = exports.deleteEmptyConfigFile = exports.createEmptyConfigFile = exports.deleteAccount = exports.renameAccount = exports.updateAllowUsageTracking = exports.updateHttpTimeout = exports.updateDefaultCmsPublishMode = exports.updateDefaultAccount = exports.updateAccountConfig = exports.removeSandboxAccountFromConfig = exports.getAccountId = exports.getAccountConfig = exports.getAccountType = exports.getEnv = exports.findConfig = exports.getAndLoadConfigIfNeeded = exports.isTrackingAllowed = exports.loadConfig = exports.writeConfig = exports.getOrderedConfig = exports.getOrderedAccount = exports.accountNameExistsInConfig = exports.validateConfig = exports.getConfigPath = exports.setConfigPath = exports.getConfigAccountId = exports.getConfigDefaultAccount = exports.getConfigAccounts = exports.setConfig = exports.getConfig = 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"));
@@ -13,10 +13,10 @@ const environments_1 = require("../constants/environments");
 const auth_1 = require("../constants/auth");
 const files_1 = require("../constants/files");
 const environment_1 = require("../lib/environment");
-const logger_1 = require("../lib/logging/logger");
+const logger_1 = require("../lib/logger");
 const git_1 = require("../utils/git");
 const errors_DEPRECATED_1 = require("../errors/errors_DEPRECATED");
-const ALL_MODES = Object.values(files_1.MODE);
+const ALL_CMS_PUBLISH_MODES = Object.values(files_1.CMS_PUBLISH_MODE);
 let _config;
 let _configPath;
 let environmentVariableConfigLoaded = false;
@@ -78,6 +78,10 @@ function validateConfig() {
         logger_1.logger.error('config.portals[] is not defined');
         return false;
     }
+    if (accounts.length === 0) {
+        logger_1.logger.error('There are no accounts defined in the configuration file');
+        return false;
+    }
     const accountIdsHash = {};
     const accountNamesHash = {};
     return accounts.every(cfg => {
@@ -105,6 +109,14 @@ function validateConfig() {
             }
             accountNamesHash[cfg.name] = cfg;
         }
+        if (!cfg.accountType) {
+            updateAccountConfig({
+                ...cfg,
+                portalId: accountId,
+                accountType: getAccountType(undefined, cfg.sandboxAccountType),
+            });
+            writeConfig();
+        }
         accountIdsHash[accountId] = cfg;
         return true;
     });
@@ -131,10 +143,10 @@ function getOrderedAccount(unorderedAccount) {
 }
 exports.getOrderedAccount = getOrderedAccount;
 function getOrderedConfig(unorderedConfig) {
-    const { defaultPortal, defaultMode, httpTimeout, allowUsageTracking, portals, ...rest } = unorderedConfig;
+    const { defaultPortal, defaultCmsPublishMode, httpTimeout, allowUsageTracking, portals, ...rest } = unorderedConfig;
     return {
         ...(defaultPortal && { defaultPortal }),
-        defaultMode,
+        defaultCmsPublishMode,
         httpTimeout,
         allowUsageTracking,
         ...rest,
@@ -167,7 +179,7 @@ function writeConfig(options = {}) {
     catch (err) {
         (0, errors_DEPRECATED_1.logFileSystemErrorInstance)(err, {
             filepath: configPath || '',
-            write: true,
+            operation: 'write',
         });
     }
 }
@@ -185,7 +197,10 @@ function readConfigFile() {
     catch (err) {
         error = err;
         logger_1.logger.error('Config file could not be read "%s"', _configPath);
-        (0, errors_DEPRECATED_1.logFileSystemErrorInstance)(error, { filepath: _configPath, read: true });
+        (0, errors_DEPRECATED_1.logFileSystemErrorInstance)(error, {
+            filepath: _configPath,
+            operation: 'read',
+        });
     }
     return { source: source && source.toString(), error };
 }
@@ -223,7 +238,7 @@ function loadConfigFromFile(path, options = {}) {
     const { parsed, error: parseError } = parseConfig(source);
     if (parseError)
         return;
-    setConfig(parsed);
+    setConfig(handleLegacyCmsPublishMode(parsed));
     if (!(0, exports.getConfig)()) {
         logger_1.logger.debug('The config file was empty config');
         logger_1.logger.debug('Initializing an empty config');
@@ -287,6 +302,22 @@ function getEnv(nameOrId) {
     return env;
 }
 exports.getEnv = getEnv;
+// Deprecating sandboxAccountType in favor of accountType
+function getAccountType(accountType, sandboxAccountType) {
+    if (accountType) {
+        return accountType;
+    }
+    if (typeof sandboxAccountType === 'string') {
+        if (sandboxAccountType.toUpperCase() === 'DEVELOPER') {
+            return config_1.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX;
+        }
+        if (sandboxAccountType.toUpperCase() === 'STANDARD') {
+            return config_1.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX;
+        }
+    }
+    return config_1.HUBSPOT_ACCOUNT_TYPES.STANDARD;
+}
+exports.getAccountType = getAccountType;
 function getAccountConfig(accountId) {
     return getConfigAccounts(getAndLoadConfigIfNeeded())?.find(account => account.portalId === accountId);
 }
@@ -343,7 +374,10 @@ function removeSandboxAccountFromConfig(nameOrId) {
         throw new Error(`Unable to find account for ${nameOrId}.`);
     }
     const accountConfig = getAccountConfig(accountId);
-    if (accountConfig?.sandboxAccountType === null)
+    const accountType = getAccountType(accountConfig?.accountType, accountConfig?.sandboxAccountType);
+    const isSandboxAccount = accountType === config_1.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX ||
+        accountType === config_1.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX;
+    if (!isSandboxAccount)
         return promptDefaultAccount;
     if (config.defaultPortal === accountConfig?.name) {
         promptDefaultAccount = true;
@@ -362,13 +396,13 @@ exports.removeSandboxAccountFromConfig = removeSandboxAccountFromConfig;
  * @throws {Error}
  */
 function updateAccountConfig(configOptions) {
-    const { portalId, authType, environment, clientId, clientSecret, scopes, tokenInfo, defaultMode, name, apiKey, personalAccessKey, sandboxAccountType, parentAccountId, } = configOptions;
+    const { accountType, apiKey, authType, clientId, clientSecret, defaultCmsPublishMode, environment, name, parentAccountId, personalAccessKey, portalId, sandboxAccountType, scopes, tokenInfo, } = configOptions;
     if (!portalId) {
         throw new Error('A portalId is required to update the config');
     }
     const config = getAndLoadConfigIfNeeded();
     const accountConfig = getAccountConfig(portalId);
-    let auth = undefined;
+    let auth = accountConfig && accountConfig.auth;
     if (clientId || clientSecret || scopes || tokenInfo) {
         auth = {
             ...(accountConfig ? accountConfig.auth : {}),
@@ -381,7 +415,7 @@ function updateAccountConfig(configOptions) {
     const env = (0, environment_1.getValidEnv)(environment ||
         (configOptions && configOptions.env) ||
         (accountConfig && accountConfig.env));
-    const mode = defaultMode && defaultMode.toLowerCase();
+    const cmsPublishMode = defaultCmsPublishMode?.toLowerCase();
     const nextAccountConfig = {
         ...accountConfig,
         name: name || (accountConfig && accountConfig.name),
@@ -389,8 +423,11 @@ function updateAccountConfig(configOptions) {
         ...(portalId && { portalId }),
         authType,
         auth,
+        accountType: getAccountType(accountType, sandboxAccountType),
         apiKey,
-        defaultMode: mode && Object.hasOwn(files_1.MODE, mode) ? mode : undefined,
+        defaultCmsPublishMode: cmsPublishMode && Object.hasOwn(files_1.CMS_PUBLISH_MODE, cmsPublishMode)
+            ? cmsPublishMode
+            : undefined,
         personalAccessKey,
         sandboxAccountType,
         parentAccountId,
@@ -430,16 +467,17 @@ exports.updateDefaultAccount = updateDefaultAccount;
 /**
  * @throws {Error}
  */
-function updateDefaultMode(defaultMode) {
-    if (!defaultMode || !ALL_MODES.find(m => m === defaultMode)) {
-        throw new Error(`The mode ${defaultMode} is invalid. Valid values are ${commaSeparatedValues(ALL_MODES)}.`);
+function updateDefaultCmsPublishMode(defaultCmsPublishMode) {
+    if (!defaultCmsPublishMode ||
+        !ALL_CMS_PUBLISH_MODES.find(m => m === defaultCmsPublishMode)) {
+        throw new Error(`The mode ${defaultCmsPublishMode} is invalid. Valid values are ${commaSeparatedValues(ALL_CMS_PUBLISH_MODES)}.`);
     }
     const config = getAndLoadConfigIfNeeded();
-    config.defaultMode = defaultMode;
+    config.defaultCmsPublishMode = defaultCmsPublishMode;
     setDefaultConfigPathIfUnset();
     writeConfig();
 }
-exports.updateDefaultMode = updateDefaultMode;
+exports.updateDefaultCmsPublishMode = updateDefaultCmsPublishMode;
 /**
  * @throws {Error}
  */
@@ -550,12 +588,16 @@ function getConfigVariablesFromEnv() {
         clientId: env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_CLIENT_ID],
         clientSecret: env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_CLIENT_SECRET],
         personalAccessKey: env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_PERSONAL_ACCESS_KEY],
-        portalId: parseInt(env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_PORTAL_ID] || '', 10),
+        portalId: parseInt(env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_ACCOUNT_ID] || '', 10) ||
+            parseInt(env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_PORTAL_ID] || '', 10),
         refreshToken: env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_REFRESH_TOKEN],
+        httpTimeout: env[environments_1.ENVIRONMENT_VARIABLES.HTTP_TIMEOUT]
+            ? parseInt(env[environments_1.ENVIRONMENT_VARIABLES.HTTP_TIMEOUT])
+            : undefined,
         env: (0, environment_1.getValidEnv)(env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_ENVIRONMENT]),
     };
 }
-function generatePersonalAccessKeyConfig(portalId, personalAccessKey, env) {
+function generatePersonalAccessKeyConfig(portalId, personalAccessKey, env, httpTimeout) {
     return {
         portals: [
             {
@@ -565,9 +607,10 @@ function generatePersonalAccessKeyConfig(portalId, personalAccessKey, env) {
                 env,
             },
         ],
+        httpTimeout,
     };
 }
-function generateOauthConfig(portalId, clientId, clientSecret, refreshToken, scopes, env) {
+function generateOauthConfig(portalId, clientId, clientSecret, refreshToken, scopes, env, httpTimeout) {
     return {
         portals: [
             {
@@ -584,6 +627,7 @@ function generateOauthConfig(portalId, clientId, clientSecret, refreshToken, sco
                 env,
             },
         ],
+        httpTimeout,
     };
 }
 function generateApiKeyConfig(portalId, apiKey, env) {
@@ -599,17 +643,20 @@ function generateApiKeyConfig(portalId, apiKey, env) {
     };
 }
 function loadConfigFromEnvironment({ useEnv = false, } = {}) {
-    const { apiKey, clientId, clientSecret, personalAccessKey, portalId, refreshToken, env, } = getConfigVariablesFromEnv();
+    const { apiKey, clientId, clientSecret, personalAccessKey, portalId, refreshToken, env, httpTimeout, } = getConfigVariablesFromEnv();
     const unableToLoadEnvConfigError = 'Unable to load config from environment variables.';
     if (!portalId) {
         useEnv && logger_1.logger.error(unableToLoadEnvConfigError);
         return;
     }
+    if (httpTimeout && httpTimeout < config_1.MIN_HTTP_TIMEOUT) {
+        throw new Error(`The HTTP timeout value ${httpTimeout} is invalid. The value must be a number greater than ${config_1.MIN_HTTP_TIMEOUT}.`);
+    }
     if (personalAccessKey) {
-        return generatePersonalAccessKeyConfig(portalId, personalAccessKey, env);
+        return generatePersonalAccessKeyConfig(portalId, personalAccessKey, env, httpTimeout);
     }
     else if (clientId && clientSecret && refreshToken) {
-        return generateOauthConfig(portalId, clientId, clientSecret, refreshToken, auth_1.OAUTH_SCOPES.map(scope => scope.value), env);
+        return generateOauthConfig(portalId, clientId, clientSecret, refreshToken, auth_1.OAUTH_SCOPES.map(scope => scope.value), env, httpTimeout);
     }
     else if (apiKey) {
         return generateApiKeyConfig(portalId, apiKey, env);
@@ -627,7 +674,7 @@ function loadEnvironmentVariableConfig(options) {
     }
     const { portalId } = getConfigVariablesFromEnv();
     logger_1.logger.debug(`Loaded config from environment variables for account ${portalId}`);
-    return setConfig(envConfig);
+    return setConfig(handleLegacyCmsPublishMode(envConfig));
 }
 function isConfigFlagEnabled(flag) {
     if (!configFileExists() || configFileIsBlank()) {
@@ -637,3 +684,10 @@ function isConfigFlagEnabled(flag) {
     return Boolean(config[flag] || false);
 }
 exports.isConfigFlagEnabled = isConfigFlagEnabled;
+function handleLegacyCmsPublishMode(config) {
+    if (config?.defaultMode) {
+        config.defaultCmsPublishMode = config.defaultMode;
+        delete config.defaultMode;
+    }
+    return config;
+}

package/config/environment.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadConfigFromEnvironment = void 0;
-const logger_1 = require("../utils/logger");
+const logger_1 = require("../lib/logger");
 const environments_1 = require("../constants/environments");
 const auth_1 = require("../constants/auth");
 const configUtils_1 = require("./configUtils");
 const environment_1 = require("../lib/environment");
+const lang_1 = require("../utils/lang");
 const i18nKey = 'config.environment';
 function getConfigVariablesFromEnv() {
     const env = process.env;
@@ -22,11 +23,11 @@ function getConfigVariablesFromEnv() {
 function loadConfigFromEnvironment() {
     const { apiKey, clientId, clientSecret, personalAccessKey, accountId, refreshToken, env, } = getConfigVariablesFromEnv();
     if (!accountId) {
-        (0, logger_1.debug)(`${i18nKey}.loadConfig.missingAccountId`);
+        logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.loadConfig.missingAccountId`));
         return null;
     }
     if (!env) {
-        (0, logger_1.debug)(`${i18nKey}.loadConfig.missingEnv`);
+        logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.loadConfig.missingEnv`));
         return null;
     }
     if (personalAccessKey) {
@@ -53,7 +54,7 @@ function loadConfigFromEnvironment() {
             env,
         });
     }
-    (0, logger_1.debug)(`${i18nKey}.loadConfig.unknownAuthType`);
+    logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.loadConfig.unknownAuthType`));
     return null;
 }
 exports.loadConfigFromEnvironment = loadConfigFromEnvironment;

package/config/getAccountIdentifier.d.ts

@@ -0,0 +1,2 @@
+import { GenericAccount } from '../types/Accounts';
+export declare function getAccountIdentifier(account?: GenericAccount | null): number | undefined;

package/config/getAccountIdentifier.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAccountIdentifier = void 0;
+function getAccountIdentifier(account) {
+    if (!account) {
+        return undefined;
+    }
+    else if (Object.hasOwn(account, 'portalId')) {
+        return account.portalId;
+    }
+    else if (Object.hasOwn(account, 'accountId')) {
+        return account.accountId;
+    }
+}
+exports.getAccountIdentifier = getAccountIdentifier;

package/config/index.d.ts

@@ -1,18 +1,20 @@
 import * as config_DEPRECATED from './config_DEPRECATED';
-import { CLIConfig } from '../types/Config';
+import { CLIConfig_NEW, CLIConfig } from '../types/Config';
 import { CLIOptions, WriteConfigOptions } from '../types/CLIOptions';
-import { CLIAccount, FlatAccountFields } from '../types/Accounts';
+import { AccountType, CLIAccount, CLIAccount_NEW, CLIAccount_DEPRECATED, FlatAccountFields } from '../types/Accounts';
+import { CmsPublishMode } from '../types/Files';
 export declare function loadConfig(path: string, options?: CLIOptions): CLIConfig | null;
 export declare function getAndLoadConfigIfNeeded(options?: CLIOptions): Partial<CLIConfig> | null;
 export declare function validateConfig(): boolean;
 export declare function loadConfigFromEnvironment(): boolean;
 export declare function createEmptyConfigFile(options?: {
     path?: string;
-}, useRootConfig?: boolean): void;
+}, useHiddenConfig?: boolean): void;
 export declare function deleteEmptyConfigFile(): void;
 export declare function getConfig(): CLIConfig | null;
 export declare function writeConfig(options?: WriteConfigOptions): void;
-export declare function getConfigPath(path?: string): string | null;
+export declare function getConfigPath(path?: string, useHiddenConfig?: boolean): string | null;
+export declare function configFileExists(useHiddenConfig?: boolean): boolean;
 export declare function getAccountConfig(accountId?: number): CLIAccount | null;
 export declare function accountNameExistsInConfig(name: string): boolean;
 export declare function updateAccountConfig(configOptions: Partial<FlatAccountFields>): FlatAccountFields | null;
@@ -20,19 +22,22 @@ export declare function updateDefaultAccount(nameOrId: string | number): void;
 export declare function renameAccount(currentName: string, newName: string): Promise<void>;
 export declare function getAccountId(nameOrId?: string | number): number | null;
 export declare function removeSandboxAccountFromConfig(nameOrId: string | number): boolean;
-export declare function deleteAccount(accountName: string): Promise<void>;
+export declare function deleteAccount(accountName: string): Promise<void | boolean>;
 export declare function updateHttpTimeout(timeout: string): void;
 export declare function updateAllowUsageTracking(isEnabled: boolean): void;
 export declare function deleteConfigFile(): void;
 export declare function isConfigFlagEnabled(flag: keyof CLIConfig): boolean;
 export declare function isTrackingAllowed(): boolean;
 export declare function getEnv(nameOrId?: string | number): import("../types/Config").Environment;
-export declare const getConfigAccounts: typeof config_DEPRECATED.getConfigAccounts;
-export declare const getConfigDefaultAccount: typeof config_DEPRECATED.getConfigDefaultAccount;
+export declare function getAccountType(accountType?: AccountType, sandboxAccountType?: string | null): AccountType;
+export declare function getConfigDefaultAccount(): 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;
+export declare function getDefaultAccountOverrideFilePath(): string | null | undefined;
 export declare const getConfigAccountId: typeof config_DEPRECATED.getConfigAccountId;
 export declare const getOrderedAccount: typeof config_DEPRECATED.getOrderedAccount;
 export declare const getOrderedConfig: typeof config_DEPRECATED.getOrderedConfig;
 export declare const setConfig: typeof config_DEPRECATED.setConfig;
 export declare const setConfigPath: typeof config_DEPRECATED.setConfigPath;
 export declare const findConfig: typeof config_DEPRECATED.findConfig;
-export declare const updateDefaultMode: typeof config_DEPRECATED.updateDefaultMode;