@hubspot/local-dev-lib 2.3.0 → 3.0.0-beta.0

package/config/CLIConfiguration.d.ts

@@ -1,6 +1,7 @@
 import { CLIConfig_NEW, Environment } from '../types/Config';
 import { CLIAccount_NEW, FlatAccountFields_NEW, AccountType } from '../types/Accounts';
 import { CLIOptions } from '../types/CLIOptions';
+import { CmsPublishMode } from '../types/Files';
 declare class _CLIConfiguration {
     options: CLIOptions;
     useEnvConfig: boolean;
@@ -47,7 +48,7 @@ declare class _CLIConfiguration {
     /**
      * @throws {Error}
      */
-    updateDefaultMode(defaultMode: string): CLIConfig_NEW | null;
+    updateDefaultCmsPublishMode(defaultCmsPublishMode: CmsPublishMode): CLIConfig_NEW | null;
     /**
      * @throws {Error}
      */
@@ -57,6 +58,7 @@ declare class _CLIConfiguration {
      */
     updateAllowUsageTracking(isEnabled: boolean): CLIConfig_NEW | null;
     isTrackingAllowed(): boolean;
+    handleLegacyCmsPublishMode(config: CLIConfig_NEW | null): CLIConfig_NEW | null;
 }
 export declare const CLIConfiguration: _CLIConfiguration;
 export {};

package/config/CLIConfiguration.js

@@ -43,7 +43,7 @@ class _CLIConfiguration {
                     accountId: configFromEnv.accounts[0].accountId,
                 }));
                 this.useEnvConfig = true;
-                this.config = configFromEnv;
+                this.config = this.handleLegacyCmsPublishMode(configFromEnv);
             }
         }
         else {
@@ -54,7 +54,7 @@ class _CLIConfiguration {
                 this.config = { accounts: [] };
             }
             this.useEnvConfig = false;
-            this.config = configFromFile;
+            this.config = this.handleLegacyCmsPublishMode(configFromFile);
         }
         return this.config;
     }
@@ -258,7 +258,7 @@ class _CLIConfiguration {
      * @throws {Error}
      */
     addOrUpdateAccount(updatedAccountFields, writeUpdate = true) {
-        const { accountId, accountType, apiKey, authType, clientId, clientSecret, defaultMode, env, name, parentAccountId, personalAccessKey, sandboxAccountType, scopes, tokenInfo, } = updatedAccountFields;
+        const { accountId, accountType, apiKey, authType, clientId, clientSecret, defaultCmsPublishMode, env, name, parentAccountId, personalAccessKey, sandboxAccountType, scopes, tokenInfo, } = updatedAccountFields;
         if (!accountId) {
             throw new Error((0, lang_1.i18n)(`${i18nKey}.updateAccount.errors.accountIdRequired`));
         }
@@ -292,7 +292,8 @@ class _CLIConfiguration {
             }
         }
         const updatedEnv = (0, environment_2.getValidEnv)(env || (currentAccountConfig && currentAccountConfig.env));
-        const updatedDefaultMode = defaultMode && defaultMode.toLowerCase();
+        const updatedDefaultCmsPublishMode = defaultCmsPublishMode &&
+            defaultCmsPublishMode.toLowerCase();
         const updatedAccountType = accountType || (currentAccountConfig && currentAccountConfig.accountType);
         safelyApplyUpdates('name', name);
         safelyApplyUpdates('env', updatedEnv);
@@ -302,9 +303,9 @@ class _CLIConfiguration {
         if (nextAccountConfig.authType === auth_1.API_KEY_AUTH_METHOD.value) {
             safelyApplyUpdates('apiKey', apiKey);
         }
-        if (typeof updatedDefaultMode !== 'undefined') {
+        if (typeof updatedDefaultCmsPublishMode !== 'undefined') {
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            safelyApplyUpdates('defaultMode', files_1.MODE[updatedDefaultMode]);
+            safelyApplyUpdates('defaultCmsPublishMode', files_1.CMS_PUBLISH_MODE[updatedDefaultCmsPublishMode]);
         }
         safelyApplyUpdates('personalAccessKey', personalAccessKey);
         // Deprecating sandboxAccountType in favor of the more generic accountType
@@ -411,18 +412,19 @@ class _CLIConfiguration {
     /**
      * @throws {Error}
      */
-    updateDefaultMode(defaultMode) {
+    updateDefaultCmsPublishMode(defaultCmsPublishMode) {
         if (!this.config) {
             throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.noConfigLoaded`));
         }
-        const ALL_MODES = Object.values(files_1.MODE);
-        if (!defaultMode || !ALL_MODES.find(m => m === defaultMode)) {
-            throw new Error((0, lang_1.i18n)(`${i18nKey}.updateDefaultMode.errors.invalidMode`, {
-                defaultMode,
-                validModes: (0, text_1.commaSeparatedValues)(ALL_MODES),
+        const ALL_CMS_PUBLISH_MODES = Object.values(files_1.CMS_PUBLISH_MODE);
+        if (!defaultCmsPublishMode ||
+            !ALL_CMS_PUBLISH_MODES.find(m => m === defaultCmsPublishMode)) {
+            throw new Error((0, lang_1.i18n)(`${i18nKey}.updateDefaultCmsPublishMode.errors.invalidCmsPublishMode`, {
+                defaultCmsPublishMode,
+                validCmsPublishModes: (0, text_1.commaSeparatedValues)(ALL_CMS_PUBLISH_MODES),
             }));
         }
-        this.config.defaultMode = defaultMode;
+        this.config.defaultCmsPublishMode = defaultCmsPublishMode;
         return this.write();
     }
     /**
@@ -463,5 +465,12 @@ class _CLIConfiguration {
         }
         return this.config.allowUsageTracking !== false;
     }
+    handleLegacyCmsPublishMode(config) {
+        if (config?.defaultMode) {
+            config.defaultCmsPublishMode = config.defaultMode;
+            delete config.defaultMode;
+        }
+        return config;
+    }
 }
 exports.CLIConfiguration = new _CLIConfiguration();

package/config/configUtils.js

@@ -17,10 +17,10 @@ function getOrderedAccount(unorderedAccount) {
 }
 exports.getOrderedAccount = getOrderedAccount;
 function getOrderedConfig(unorderedConfig) {
-    const { defaultAccount, defaultMode, httpTimeout, allowUsageTracking, accounts, ...rest } = unorderedConfig;
+    const { defaultAccount, defaultCmsPublishMode, httpTimeout, allowUsageTracking, accounts, ...rest } = unorderedConfig;
     return {
         ...(defaultAccount && { defaultAccount }),
-        defaultMode,
+        defaultCmsPublishMode,
         httpTimeout,
         allowUsageTracking,
         ...rest,

package/config/config_DEPRECATED.d.ts

@@ -1,6 +1,6 @@
 import { CLIConfig_DEPRECATED, Environment } from '../types/Config';
 import { AccountType, CLIAccount_DEPRECATED, FlatAccountFields_DEPRECATED, UpdateAccountConfigOptions } from '../types/Accounts';
-import { Mode } from '../types/Files';
+import { CmsPublishMode } from '../types/Files';
 import { CLIOptions, WriteConfigOptions } from '../types/CLIOptions';
 export declare const getConfig: () => CLIConfig_DEPRECATED | null;
 export declare function setConfig(updatedConfig?: CLIConfig_DEPRECATED): CLIConfig_DEPRECATED | null;
@@ -14,9 +14,10 @@ export declare function accountNameExistsInConfig(name: string): boolean;
 export declare function getOrderedAccount(unorderedAccount: CLIAccount_DEPRECATED): CLIAccount_DEPRECATED;
 export declare function getOrderedConfig(unorderedConfig: CLIConfig_DEPRECATED): {
     portals: CLIAccount_DEPRECATED[];
+    defaultMode?: CmsPublishMode | undefined;
     env?: Environment | undefined;
     httpUseLocalhost?: boolean | undefined;
-    defaultMode: string | undefined;
+    defaultCmsPublishMode: CmsPublishMode | undefined;
     httpTimeout: number | undefined;
     allowUsageTracking: boolean | undefined;
     defaultPortal?: string | number | undefined;
@@ -45,7 +46,7 @@ export declare function updateDefaultAccount(defaultAccount: string | number): v
 /**
  * @throws {Error}
  */
-export declare function updateDefaultMode(defaultMode: Mode): void;
+export declare function updateDefaultCmsPublishMode(defaultCmsPublishMode: CmsPublishMode): void;
 /**
  * @throws {Error}
  */

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.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;
+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"));
@@ -16,7 +16,7 @@ const environment_1 = require("../lib/environment");
 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;
@@ -139,10 +139,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,
@@ -234,7 +234,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');
@@ -392,7 +392,7 @@ exports.removeSandboxAccountFromConfig = removeSandboxAccountFromConfig;
  * @throws {Error}
  */
 function updateAccountConfig(configOptions) {
-    const { accountType, apiKey, authType, clientId, clientSecret, defaultMode, environment, name, parentAccountId, personalAccessKey, portalId, sandboxAccountType, scopes, tokenInfo, } = 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');
     }
@@ -411,7 +411,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),
@@ -421,7 +421,9 @@ function updateAccountConfig(configOptions) {
         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,
@@ -461,16 +463,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}
  */
@@ -666,7 +669,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()) {
@@ -676,3 +679,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/index.d.ts

@@ -2,7 +2,7 @@ import * as config_DEPRECATED from './config_DEPRECATED';
 import { CLIConfig_NEW, CLIConfig } from '../types/Config';
 import { CLIOptions, WriteConfigOptions } from '../types/CLIOptions';
 import { AccountType, CLIAccount, CLIAccount_NEW, CLIAccount_DEPRECATED, FlatAccountFields } from '../types/Accounts';
-import { Mode } from '../types/Files';
+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;
@@ -32,7 +32,7 @@ export declare function getEnv(nameOrId?: string | number): import("../types/Con
 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 updateDefaultMode(mode: Mode): void | CLIConfig_NEW | null;
+export declare function updateDefaultCmsPublishMode(cmsPublishMode: CmsPublishMode): void | CLIConfig_NEW | null;
 export declare const getConfigAccountId: typeof config_DEPRECATED.getConfigAccountId;
 export declare const getOrderedAccount: typeof config_DEPRECATED.getOrderedAccount;
 export declare const getOrderedConfig: typeof config_DEPRECATED.getOrderedConfig;

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.updateDefaultMode = 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.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;
 const config_DEPRECATED = __importStar(require("./config_DEPRECATED"));
 const CLIConfiguration_1 = require("./CLIConfiguration");
 const configFile_1 = require("./configFile");
@@ -244,13 +244,13 @@ function getConfigAccounts() {
     return config_DEPRECATED.getConfigAccounts();
 }
 exports.getConfigAccounts = getConfigAccounts;
-function updateDefaultMode(mode) {
+function updateDefaultCmsPublishMode(cmsPublishMode) {
     if (CLIConfiguration_1.CLIConfiguration.isActive()) {
-        return CLIConfiguration_1.CLIConfiguration.updateDefaultMode(mode);
+        return CLIConfiguration_1.CLIConfiguration.updateDefaultCmsPublishMode(cmsPublishMode);
     }
-    return config_DEPRECATED.updateDefaultMode(mode);
+    return config_DEPRECATED.updateDefaultCmsPublishMode(cmsPublishMode);
 }
-exports.updateDefaultMode = updateDefaultMode;
+exports.updateDefaultCmsPublishMode = updateDefaultCmsPublishMode;
 // These functions are not supported with the new config setup
 exports.getConfigAccountId = config_DEPRECATED.getConfigAccountId;
 exports.getOrderedAccount = config_DEPRECATED.getOrderedAccount;

package/constants/files.d.ts

@@ -3,11 +3,11 @@ export declare const STAT_TYPES: {
     readonly SYMBOLIC_LINK: "symlink";
     readonly DIRECTORY: "dir";
 };
-export declare const MODE: {
+export declare const CMS_PUBLISH_MODE: {
     readonly draft: "draft";
     readonly publish: "publish";
 };
-export declare const DEFAULT_MODE: "publish";
+export declare const DEFAULT_CMS_PUBLISH_MODE: "publish";
 export declare const FILE_UPLOAD_RESULT_TYPES: {
     readonly SUCCESS: "SUCCESS";
     readonly FAILURE: "FAILURE";

package/constants/files.js

@@ -1,16 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FILE_TYPES = exports.FILE_UPLOAD_RESULT_TYPES = exports.DEFAULT_MODE = exports.MODE = exports.STAT_TYPES = void 0;
+exports.FILE_TYPES = exports.FILE_UPLOAD_RESULT_TYPES = exports.DEFAULT_CMS_PUBLISH_MODE = exports.CMS_PUBLISH_MODE = exports.STAT_TYPES = void 0;
 exports.STAT_TYPES = {
     FILE: 'file',
     SYMBOLIC_LINK: 'symlink',
     DIRECTORY: 'dir',
 };
-exports.MODE = {
+exports.CMS_PUBLISH_MODE = {
     draft: 'draft',
     publish: 'publish',
 };
-exports.DEFAULT_MODE = exports.MODE.publish;
+exports.DEFAULT_CMS_PUBLISH_MODE = exports.CMS_PUBLISH_MODE.publish;
 exports.FILE_UPLOAD_RESULT_TYPES = {
     SUCCESS: 'SUCCESS',
     FAILURE: 'FAILURE',

package/lang/en.json

@@ -274,9 +274,9 @@
           "invalidId": "Unable to find account for {{ nameOrId }}."
         }
       },
-      "updateDefaultMode": {
+      "updateDefaultCmsPublishMode": {
         "errors": {
-          "invalidMode": "The mode {{ defaultMode }} is invalid. Valid values are {{ validModes }}."
+          "invalidCmsPublishMode": "The CMS publish mode {{ defaultCmsPublishMode }} is invalid. Valid values are {{ validCmsPublishModes }}."
         }
       },
       "updateHttpTimeout": {

package/lib/cms/uploadFolder.d.ts

@@ -1,7 +1,7 @@
 import { FieldsJs } from './handleFieldsJS';
 import { FileMapperInputOptions } from '../../types/Files';
 import { UploadFolderResults, CommandOptions, FilePathsByType } from '../../types/Files';
-import { Mode } from '../../types/Files';
+import { CmsPublishMode } from '../../types/Files';
 export declare function getFilesByType(filePaths: Array<string>, projectDir: string, rootWriteDir: string | null, commandOptions: CommandOptions): Promise<[FilePathsByType, Array<FieldsJs>]>;
-export declare function uploadFolder(accountId: number, src: string, dest: string, fileMapperOptions: FileMapperInputOptions, commandOptions?: CommandOptions, filePaths?: Array<string>, mode?: Mode | null): Promise<Array<UploadFolderResults>>;
+export declare function uploadFolder(accountId: number, src: string, dest: string, fileMapperOptions: FileMapperInputOptions, commandOptions?: CommandOptions, filePaths?: Array<string>, cmsPublishMode?: CmsPublishMode | null): Promise<Array<UploadFolderResults>>;
 export declare function hasUploadErrors(results: Array<UploadFolderResults>): boolean;

package/lib/cms/uploadFolder.js

@@ -106,7 +106,7 @@ const defaultUploadFinalErrorCallback = (accountId, file, destPath, error) => {
         payload: file,
     });
 };
-async function uploadFolder(accountId, src, dest, fileMapperOptions, commandOptions = {}, filePaths = [], mode = null) {
+async function uploadFolder(accountId, src, dest, fileMapperOptions, commandOptions = {}, filePaths = [], cmsPublishMode = null) {
     const { saveOutput, convertFields, onAttemptCallback, onSuccessCallback, onFirstErrorCallback, onRetryCallback, onFinalErrorCallback, } = commandOptions;
     const _onAttemptCallback = onAttemptCallback || defaultUploadAttemptCallback;
     const _onSuccessCallback = onSuccessCallback || defaultUploadSuccessCallback;
@@ -117,7 +117,7 @@ async function uploadFolder(accountId, src, dest, fileMapperOptions, commandOpti
         ? (0, handleFieldsJS_1.createTmpDirSync)('hubspot-temp-fieldsjs-output-')
         : null;
     const regex = new RegExp(`^${(0, escapeRegExp_1.escapeRegExp)(src)}`);
-    const apiOptions = (0, fileMapper_1.getFileMapperQueryValues)(mode, fileMapperOptions);
+    const apiOptions = (0, fileMapper_1.getFileMapperQueryValues)(cmsPublishMode, fileMapperOptions);
     const failures = [];
     let fieldsJsPaths = [];
     let tmpDirRegex;

package/lib/cms/watch.d.ts

@@ -1,4 +1,4 @@
 import chokidar from 'chokidar';
 import { WatchOptions, WatchErrorHandler } from '../../types/Files';
 import { UploadFolderResults } from '../../types/Files';
-export declare function watch(accountId: number, src: string, dest: string, { mode, remove, disableInitial, notify, commandOptions, filePaths, }: WatchOptions, postInitialUploadCallback?: ((result: Array<UploadFolderResults>) => void) | null, onUploadFolderError?: WatchErrorHandler, onQueueAddError?: WatchErrorHandler, onUploadFileError?: (file: string, dest: string, accountId: number) => WatchErrorHandler): chokidar.FSWatcher;
+export declare function watch(accountId: number, src: string, dest: string, { cmsPublishMode, remove, disableInitial, notify, commandOptions, filePaths, }: WatchOptions, postInitialUploadCallback?: ((result: Array<UploadFolderResults>) => void) | null, onUploadFolderError?: WatchErrorHandler, onQueueAddError?: WatchErrorHandler, onUploadFileError?: (file: string, dest: string, accountId: number) => WatchErrorHandler): chokidar.FSWatcher;

package/lib/cms/watch.js

@@ -50,7 +50,7 @@ const defaultOnUploadFileError = (file, dest, accountId) => (error) => {
         payload: file,
     });
 };
-async function uploadFile(accountId, file, dest, options, mode = null, onUploadFileError = defaultOnUploadFileError) {
+async function uploadFile(accountId, file, dest, options, cmsPublishMode = null, onUploadFileError = defaultOnUploadFileError) {
     const src = options.src;
     const absoluteSrcPath = path_1.default.resolve((0, path_2.getCwd)(), file);
     const themeJsonPath = (0, themes_1.getThemeJSONPath)(absoluteSrcPath);
@@ -76,7 +76,7 @@ async function uploadFile(accountId, file, dest, options, mode = null, onUploadF
     }
     const fileToUpload = convertFields && fieldsJs?.outputPath ? fieldsJs.outputPath : file;
     logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadAttempt`, { file, dest }));
-    const apiOptions = (0, fileMapper_1.getFileMapperQueryValues)(mode, options);
+    const apiOptions = (0, fileMapper_1.getFileMapperQueryValues)(cmsPublishMode, options);
     queue.add(() => {
         return (0, fileMapper_2.upload)(accountId, fileToUpload, dest, apiOptions)
             .then(() => {
@@ -116,7 +116,7 @@ async function deleteRemoteFile(accountId, filePath, remoteFilePath) {
         });
     });
 }
-function watch(accountId, src, dest, { mode, remove, disableInitial, notify, commandOptions, filePaths, }, postInitialUploadCallback = null, onUploadFolderError, onQueueAddError, onUploadFileError) {
+function watch(accountId, src, dest, { cmsPublishMode, remove, disableInitial, notify, commandOptions, filePaths, }, postInitialUploadCallback = null, onUploadFolderError, onQueueAddError, onUploadFileError) {
     const regex = new RegExp(`^${(0, escapeRegExp_1.escapeRegExp)(src)}`);
     if (notify) {
         (0, ignoreRules_1.ignoreFile)(notify);
@@ -131,7 +131,7 @@ function watch(accountId, src, dest, { mode, remove, disableInitial, notify, com
     }
     if (!disableInitial) {
         // Use uploadFolder so that failures of initial upload are retried
-        const uploadFolderPromise = (0, uploadFolder_1.uploadFolder)(accountId, src, dest, {}, commandOptions, filePaths, mode || null).then(result => {
+        const uploadFolderPromise = (0, uploadFolder_1.uploadFolder)(accountId, src, dest, {}, commandOptions, filePaths, cmsPublishMode || null).then(result => {
             logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.folderUploadSuccess`, {
                 src,
                 dest,
@@ -153,7 +153,7 @@ function watch(accountId, src, dest, { mode, remove, disableInitial, notify, com
         const uploadPromise = uploadFile(accountId, filePath, destPath, {
             src,
             commandOptions,
-        }, mode, onUploadFileError);
+        }, cmsPublishMode, onUploadFileError);
         (0, notify_1.triggerNotify)(notify, 'Added', filePath, uploadPromise);
     });
     if (remove) {
@@ -193,7 +193,7 @@ function watch(accountId, src, dest, { mode, remove, disableInitial, notify, com
         const uploadPromise = uploadFile(accountId, filePath, destPath, {
             src,
             commandOptions,
-        }, mode, onUploadFileError);
+        }, cmsPublishMode, onUploadFileError);
         (0, notify_1.triggerNotify)(notify, 'Changed', filePath, uploadPromise);
     });
     return watcher;

package/lib/fileMapper.d.ts

@@ -1,13 +1,13 @@
-import { FileMapperNode, Mode, FileMapperOptions, FileMapperInputOptions, PathTypeData, RecursiveFileMapperCallback } from '../types/Files';
+import { FileMapperNode, CmsPublishMode, FileMapperOptions, FileMapperInputOptions, PathTypeData, RecursiveFileMapperCallback } from '../types/Files';
 export declare function isPathToFile(filepath: string): boolean;
 export declare function isPathToModule(filepath: string): boolean;
 export declare function isPathToRoot(filepath: string): boolean;
 export declare function isPathToHubspot(filepath: string): boolean;
-export declare function getFileMapperQueryValues(mode?: Mode | null, { staging, assetVersion }?: FileMapperInputOptions): FileMapperOptions;
+export declare function getFileMapperQueryValues(cmsPublishMode?: CmsPublishMode | null, { staging, assetVersion }?: FileMapperInputOptions): FileMapperOptions;
 export declare function getTypeDataFromPath(src: string): PathTypeData;
 export declare function recurseFolder(node: FileMapperNode, callback: RecursiveFileMapperCallback, filepath?: string, depth?: number): boolean;
 export declare function writeUtimes(accountId: number, filepath: string, node: FileMapperNode): Promise<void>;
-export declare function fetchFolderFromApi(accountId: number, src: string, mode?: Mode, options?: FileMapperInputOptions): Promise<FileMapperNode>;
+export declare function fetchFolderFromApi(accountId: number, src: string, cmsPublishMode?: CmsPublishMode, options?: FileMapperInputOptions): Promise<FileMapperNode>;
 /**
  * Fetch a file/folder and write to local file system.
  *
@@ -15,4 +15,4 @@ export declare function fetchFolderFromApi(accountId: number, src: string, mode?
  * @param {FileMapperInputArguments} input
  * @returns {Promise}
  */
-export declare function downloadFileOrFolder(accountId: number, src: string, dest: string, mode?: Mode, options?: FileMapperInputOptions): Promise<void>;
+export declare function downloadFileOrFolder(accountId: number, src: string, dest: string, cmsPublishMode?: CmsPublishMode, options?: FileMapperInputOptions): Promise<void>;

package/lib/fileMapper.js

@@ -43,14 +43,14 @@ function isPathToHubspot(filepath) {
     return /^(\/|\\)?@hubspot/i.test(filepath.trim());
 }
 exports.isPathToHubspot = isPathToHubspot;
-function useApiBuffer(mode) {
-    return mode === files_1.MODE.draft;
+function useApiBuffer(cmsPublishMode) {
+    return cmsPublishMode === files_1.CMS_PUBLISH_MODE.draft;
 }
-// Determines API param based on mode an options
-function getFileMapperQueryValues(mode, { staging, assetVersion } = {}) {
+// Determines API param based on publish mode and options
+function getFileMapperQueryValues(cmsPublishMode, { staging, assetVersion } = {}) {
     return {
         params: {
-            buffer: useApiBuffer(mode),
+            buffer: useApiBuffer(cmsPublishMode),
             environmentId: staging ? 2 : 1,
             version: assetVersion,
         },
@@ -141,7 +141,7 @@ async function skipExisting(filepath, overwrite = false) {
     }
     return false;
 }
-async function fetchAndWriteFileStream(accountId, srcPath, filepath, mode, options = {}) {
+async function fetchAndWriteFileStream(accountId, srcPath, filepath, cmsPublishMode, options = {}) {
     if (typeof srcPath !== 'string' || !srcPath.trim()) {
         return;
     }
@@ -152,12 +152,12 @@ async function fetchAndWriteFileStream(accountId, srcPath, filepath, mode, optio
     if (!(0, path_2.isAllowedExtension)(srcPath, Array.from(extensions_1.JSR_ALLOWED_EXTENSIONS))) {
         throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.invalidFileType`, { srcPath }));
     }
-    const node = await (0, fileMapper_1.fetchFileStream)(accountId, srcPath, filepath, getFileMapperQueryValues(mode, options));
+    const node = await (0, fileMapper_1.fetchFileStream)(accountId, srcPath, filepath, getFileMapperQueryValues(cmsPublishMode, options));
     await writeUtimes(accountId, filepath, node);
 }
 // Writes an individual file or folder (not recursive).  If file source is missing, the
 //file is fetched.
-async function writeFileMapperNode(accountId, filepath, node, mode, options = {}) {
+async function writeFileMapperNode(accountId, filepath, node, cmsPublishMode, options = {}) {
     const localFilepath = (0, path_2.convertToLocalFileSystemPath)(path_1.default.resolve(filepath));
     if (await skipExisting(localFilepath, options.overwrite)) {
         logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.skippedExisting`, {
@@ -167,7 +167,7 @@ async function writeFileMapperNode(accountId, filepath, node, mode, options = {}
     }
     if (!node.folder) {
         try {
-            await fetchAndWriteFileStream(accountId, node.path, localFilepath, mode, options);
+            await fetchAndWriteFileStream(accountId, node.path, localFilepath, cmsPublishMode, options);
             return true;
         }
         catch (err) {
@@ -189,7 +189,7 @@ async function writeFileMapperNode(accountId, filepath, node, mode, options = {}
     }
     return true;
 }
-async function downloadFile(accountId, src, destPath, mode, options = {}) {
+async function downloadFile(accountId, src, destPath, cmsPublishMode, options = {}) {
     const { isFile, isHubspot } = getTypeDataFromPath(src);
     if (!isFile) {
         throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.invalidRequest`, { src }));
@@ -214,7 +214,7 @@ async function downloadFile(accountId, src, destPath, mode, options = {}) {
                 : path_1.default.resolve(cwd, dest, name);
         }
         const localFsPath = (0, path_2.convertToLocalFileSystemPath)(filepath);
-        await fetchAndWriteFileStream(accountId, src, localFsPath, mode, options);
+        await fetchAndWriteFileStream(accountId, src, localFsPath, cmsPublishMode, options);
         await queue.onIdle();
         logger_1.logger.success((0, lang_1.i18n)(`${i18nKey}.completedFetch`, {
             src,
@@ -232,7 +232,7 @@ async function downloadFile(accountId, src, destPath, mode, options = {}) {
         }
     }
 }
-async function fetchFolderFromApi(accountId, src, mode, options = {}) {
+async function fetchFolderFromApi(accountId, src, cmsPublishMode, options = {}) {
     const { isRoot, isFolder, isHubspot } = getTypeDataFromPath(src);
     if (!isFolder) {
         throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.invalidFetchFolderRequest`, {
@@ -240,7 +240,7 @@ async function fetchFolderFromApi(accountId, src, mode, options = {}) {
         }));
     }
     const srcPath = isRoot ? '@root' : src;
-    const queryValues = getFileMapperQueryValues(mode, options);
+    const queryValues = getFileMapperQueryValues(cmsPublishMode, options);
     const { data: node } = isHubspot
         ? await (0, fileMapper_1.downloadDefault)(accountId, srcPath, queryValues)
         : await (0, fileMapper_1.download)(accountId, srcPath, queryValues);
@@ -248,9 +248,9 @@ async function fetchFolderFromApi(accountId, src, mode, options = {}) {
     return node;
 }
 exports.fetchFolderFromApi = fetchFolderFromApi;
-async function downloadFolder(accountId, src, destPath, mode, options = {}) {
+async function downloadFolder(accountId, src, destPath, cmsPublishMode, options = {}) {
     try {
-        const node = await fetchFolderFromApi(accountId, src, mode, options);
+        const node = await fetchFolderFromApi(accountId, src, cmsPublishMode, options);
         if (!node) {
             return;
         }
@@ -261,7 +261,7 @@ async function downloadFolder(accountId, src, destPath, mode, options = {}) {
         let success = true;
         recurseFolder(node, (childNode, filepath) => {
             queue.add(async () => {
-                const succeeded = await writeFileMapperNode(accountId, filepath || '', childNode, mode, options);
+                const succeeded = await writeFileMapperNode(accountId, filepath || '', childNode, cmsPublishMode, options);
                 if (succeeded === false) {
                     success = false;
                     logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.errors.failedToFetchFile`, {
@@ -302,16 +302,16 @@ async function downloadFolder(accountId, src, destPath, mode, options = {}) {
  * @param {FileMapperInputArguments} input
  * @returns {Promise}
  */
-async function downloadFileOrFolder(accountId, src, dest, mode, options = {}) {
+async function downloadFileOrFolder(accountId, src, dest, cmsPublishMode, options = {}) {
     if (!src) {
         return;
     }
     const { isFile } = getTypeDataFromPath(src);
     if (isFile) {
-        await downloadFile(accountId, src, dest, mode, options);
+        await downloadFile(accountId, src, dest, cmsPublishMode, options);
     }
     else {
-        await downloadFolder(accountId, src, dest, mode, options);
+        await downloadFolder(accountId, src, dest, cmsPublishMode, options);
     }
 }
 exports.downloadFileOrFolder = downloadFileOrFolder;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "2.3.0",
+    "version": "3.0.0-beta.0",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "main": "lib/index.js",
     "repository": {
@@ -38,6 +38,7 @@
         "eslint-plugin-import": "^2.29.1",
         "husky": "^8.0.0",
         "jest": "^29.5.0",
+        "open": "^8.4.2",
         "ts-jest": "^29.0.5",
         "ts-node": "^10.9.2",
         "typescript": "^4.9.5",

package/types/Accounts.d.ts

@@ -1,5 +1,5 @@
 import { HUBSPOT_ACCOUNT_TYPES } from '../constants/config';
-import { Mode } from './Files';
+import { CmsPublishMode } from './Files';
 import { Environment } from './Config';
 import { ValueOf } from './Utils';
 export type AuthType = 'personalaccesskey' | 'apikey' | 'oauth2';
@@ -7,7 +7,7 @@ export interface CLIAccount_NEW {
     name?: string;
     accountId: number;
     accountType?: AccountType;
-    defaultMode?: Mode;
+    defaultCmsPublishMode?: CmsPublishMode;
     env: Environment;
     authType?: AuthType;
     auth?: {
@@ -21,7 +21,7 @@ export interface CLIAccount_NEW {
 export interface CLIAccount_DEPRECATED {
     name?: string;
     portalId?: number;
-    defaultMode?: Mode;
+    defaultCmsPublishMode?: CmsPublishMode;
     env: Environment;
     accountType?: AccountType;
     authType?: AuthType;

package/types/Config.d.ts

@@ -1,11 +1,13 @@
 import { ENVIRONMENTS } from '../constants/environments';
 import { CLIAccount_NEW, CLIAccount_DEPRECATED } from './Accounts';
+import { CmsPublishMode } from './Files';
 import { ValueOf } from './Utils';
 export interface CLIConfig_NEW {
     accounts: Array<CLIAccount_NEW>;
     allowUsageTracking?: boolean;
     defaultAccount?: string | number;
-    defaultMode?: string;
+    defaultMode?: CmsPublishMode;
+    defaultCmsPublishMode?: CmsPublishMode;
     httpTimeout?: number;
     env?: Environment;
     httpUseLocalhost?: boolean;
@@ -14,7 +16,8 @@ export interface CLIConfig_DEPRECATED {
     portals: Array<CLIAccount_DEPRECATED>;
     allowUsageTracking?: boolean;
     defaultPortal?: string | number;
-    defaultMode?: string;
+    defaultMode?: CmsPublishMode;
+    defaultCmsPublishMode?: CmsPublishMode;
     httpTimeout?: number;
     env?: Environment;
     httpUseLocalhost?: boolean;

package/types/Files.d.ts

@@ -1,6 +1,6 @@
 import { ValueOf } from '../types/Utils';
 import { STAT_TYPES, FILE_TYPES, FILE_UPLOAD_RESULT_TYPES } from '../constants/files';
-import { MODE } from '../constants/files';
+import { CMS_PUBLISH_MODE } from '../constants/files';
 import { HttpOptions } from './Http';
 import { AxiosError } from 'axios';
 export type StatType = ValueOf<typeof STAT_TYPES>;
@@ -18,7 +18,7 @@ export type FileMapperNode = {
     folder: boolean;
     children: Array<FileMapperNode>;
 };
-export type Mode = ValueOf<typeof MODE>;
+export type CmsPublishMode = ValueOf<typeof CMS_PUBLISH_MODE>;
 export type FileMapperOptions = Omit<HttpOptions, 'url'>;
 export type FileMapperInputOptions = {
     staging?: boolean;
@@ -66,7 +66,7 @@ export type UploadFileOptions = FileMapperInputOptions & {
     fieldOptions?: string;
 };
 export type WatchOptions = {
-    mode?: Mode;
+    cmsPublishMode?: CmsPublishMode;
     remove?: boolean;
     disableInitial?: boolean;
     notify?: string;