@hubspot/cli 7.4.8-experimental.0 → 7.5.0-experimental.0

package/bin/cli.js

@@ -1,21 +1,16 @@
 #!/usr/bin/env node
 "use strict";
 const yargs = require('yargs');
-const updateNotifier = require('update-notifier');
-const chalk = require('chalk');
 const { logger } = require('@hubspot/local-dev-lib/logger');
-const { addUserAgentHeader } = require('@hubspot/local-dev-lib/http');
-const { loadConfig, getAccountId, configFileExists, getConfigPath, validateConfig, } = require('@hubspot/local-dev-lib/config');
 const { logError } = require('../lib/errorHandlers/index');
 const { setLogLevel, getCommandName } = require('../lib/commonOpts');
-const { validateAccount } = require('../lib/validation');
 const { trackHelpUsage, trackConvertFieldsUsage, } = require('../lib/usageTracking');
-const { getIsInProject } = require('../lib/projects');
-const pkg = require('../package.json');
-const { i18n } = require('../lib/lang');
 const { EXIT_CODES } = require('../lib/enums/exitCodes');
-const { UI_COLORS, uiCommandReference, uiDeprecatedTag } = require('../lib/ui');
-const { checkAndWarnGitInclusion } = require('../lib/ui/git');
+const { loadConfigMiddleware, injectAccountIdMiddleware, validateAccountOptions, handleDeprecatedEnvVariables, } = require('../lib/middleware/configMiddleware');
+const { notifyAboutUpdates, } = require('../lib/middleware/notificationsMiddleware');
+const { checkAndWarnGitInclusionMiddleware, } = require('../lib/middleware/gitMiddleware');
+const { performChecks } = require('../lib/middleware/yargsChecksMiddleware');
+const { setRequestHeaders } = require('../lib/middleware/requestMiddleware');
 const removeCommand = require('../commands/remove');
 const initCommand = require('../commands/init');
 const logsCommand = require('../commands/logs');
@@ -44,33 +39,7 @@ const feedbackCommand = require('../commands/feedback');
 const doctorCommand = require('../commands/doctor');
 const completionCommand = require('../commands/completion');
 const appCommand = require('../commands/app');
-const notifier = updateNotifier({
-    pkg: { ...pkg, name: '@hubspot/cli' },
-    distTag: 'latest',
-    shouldNotifyInNpmScript: true,
-});
-const CMS_CLI_PACKAGE_NAME = '@hubspot/cms-cli';
-notifier.notify({
-    message: pkg.name === CMS_CLI_PACKAGE_NAME
-        ? i18n(`commands.generalErrors.updateNotify.cmsUpdateNotification`, {
-            packageName: CMS_CLI_PACKAGE_NAME,
-            updateCommand: uiCommandReference('{updateCommand}'),
-        })
-        : i18n(`commands.generalErrors.updateNotify.cliUpdateNotification`, {
-            updateCommand: uiCommandReference('{updateCommand}'),
-        }),
-    defer: false,
-    boxenOptions: {
-        borderColor: UI_COLORS.MARIGOLD_DARK,
-        margin: 1,
-        padding: 1,
-        textAlignment: 'center',
-        borderStyle: 'round',
-        title: pkg.name === CMS_CLI_PACKAGE_NAME
-            ? null
-            : chalk.bold(i18n(`commands.generalErrors.updateNotify.notifyTitle`)),
-    },
-});
+notifyAboutUpdates();
 const getTerminalWidth = () => {
     const width = yargs.terminalWidth();
     if (width >= 100)
@@ -92,152 +61,6 @@ const handleFailure = (msg, err, yargs) => {
         process.exit(EXIT_CODES.ERROR);
     }
 };
-const performChecks = argv => {
-    // "hs config set default-account" has moved to "hs accounts use"
-    if (argv._[0] === 'config' &&
-        argv._[1] === 'set' &&
-        argv._[2] === 'default-account') {
-        logger.error(i18n(`commands.generalErrors.setDefaultAccountMoved`));
-        process.exit(EXIT_CODES.ERROR);
-    }
-    // Require "project" command when running upload/watch inside of a project
-    if (argv._.length === 1 && ['upload', 'watch'].includes(argv._[0])) {
-        if (getIsInProject(argv.src)) {
-            logger.error(i18n(`commands.generalErrors.srcIsProject`, {
-                src: argv.src || './',
-                command: argv._.join(' '),
-            }));
-            process.exit(EXIT_CODES.ERROR);
-        }
-        else {
-            return true;
-        }
-    }
-    else {
-        return true;
-    }
-};
-const setRequestHeaders = () => {
-    addUserAgentHeader('HubSpot CLI', pkg.version);
-};
-const isTargetedCommand = (options, commandMap) => {
-    const checkCommand = (options, commandMap) => {
-        const currentCommand = options._[0];
-        if (!commandMap[currentCommand]) {
-            return false;
-        }
-        if (commandMap[currentCommand].target) {
-            return true;
-        }
-        const subCommands = commandMap[currentCommand].subCommands || {};
-        if (options._.length > 1) {
-            return checkCommand({ _: options._.slice(1) }, subCommands);
-        }
-        return false;
-    };
-    return checkCommand(options, commandMap);
-};
-const SKIP_CONFIG_VALIDATION = {
-    init: { target: true },
-    auth: { target: true },
-};
-const handleDeprecatedEnvVariables = options => {
-    // HUBSPOT_PORTAL_ID is deprecated, but we'll still support it for now
-    // The HubSpot GH Deploy Action still uses HUBSPOT_PORTAL_ID
-    if (options.useEnv &&
-        process.env.HUBSPOT_PORTAL_ID &&
-        !process.env.HUBSPOT_ACCOUNT_ID) {
-        uiDeprecatedTag(i18n(`commands.generalErrors.handleDeprecatedEnvVariables.portalEnvVarDeprecated`, {
-            configPath: getConfigPath(),
-        }));
-        process.env.HUBSPOT_ACCOUNT_ID = process.env.HUBSPOT_PORTAL_ID;
-    }
-};
-/**
- * Auto-injects the derivedAccountId flag into all commands
- */
-const injectAccountIdMiddleware = async (options) => {
-    const { account } = options;
-    // Preserves the original --account flag for certain commands.
-    options.providedAccountId = account;
-    if (options.useEnv && process.env.HUBSPOT_ACCOUNT_ID) {
-        options.derivedAccountId = parseInt(process.env.HUBSPOT_ACCOUNT_ID, 10);
-    }
-    else {
-        options.derivedAccountId = getAccountId(account);
-    }
-};
-const loadConfigMiddleware = async (options) => {
-    // Skip this when no command is provided
-    if (!options._.length) {
-        return;
-    }
-    const maybeValidateConfig = () => {
-        if (!isTargetedCommand(options, SKIP_CONFIG_VALIDATION) &&
-            !validateConfig()) {
-            process.exit(EXIT_CODES.ERROR);
-        }
-    };
-    if (configFileExists(true) && options.config) {
-        logger.error(i18n(`commands.generalErrors.loadConfigMiddleware.configFileExists`, {
-            configPath: getConfigPath(),
-        }));
-        process.exit(EXIT_CODES.ERROR);
-    }
-    else if (!isTargetedCommand(options, { init: { target: true } })) {
-        const { config: configPath } = options;
-        const config = loadConfig(configPath, options);
-        // We don't run validateConfig() for auth because users should be able to run it when
-        // no accounts are configured, but we still want to exit if the config file is not found
-        if (isTargetedCommand(options, { auth: { target: true } }) && !config) {
-            process.exit(EXIT_CODES.ERROR);
-        }
-    }
-    maybeValidateConfig();
-};
-const checkAndWarnGitInclusionMiddleware = options => {
-    // Skip this when no command is provided
-    if (!options._.length) {
-        return;
-    }
-    checkAndWarnGitInclusion(getConfigPath());
-};
-const accountsSubCommands = {
-    target: false,
-    subCommands: {
-        clean: { target: true },
-        list: { target: true },
-        ls: { target: true },
-        remove: { target: true },
-    },
-};
-const sandboxesSubCommands = {
-    target: false,
-    subCommands: {
-        delete: { target: true },
-    },
-};
-const SKIP_ACCOUNT_VALIDATION = {
-    init: { target: true },
-    auth: { target: true },
-    account: accountsSubCommands,
-    accounts: accountsSubCommands,
-    sandbox: sandboxesSubCommands,
-    sandboxes: sandboxesSubCommands,
-};
-const validateAccountOptions = async (options) => {
-    // Skip this when no command is provided
-    if (!options._.length) {
-        return;
-    }
-    let validAccount = true;
-    if (!isTargetedCommand(options, SKIP_ACCOUNT_VALIDATION)) {
-        validAccount = await validateAccount(options);
-    }
-    if (!validAccount) {
-        process.exit(EXIT_CODES.ERROR);
-    }
-};
 const argv = yargs
     .usage('The command line interface to interact with HubSpot.')
     // loadConfigMiddleware loads the new hidden config for all commands

package/commands/account/info.js

@@ -20,7 +20,9 @@ async function handler(args) {
         const response = await (0, personalAccessKey_1.getAccessToken)(personalAccessKey, env, derivedAccountId);
         scopeGroups = response.scopeGroups.map(s => [s]);
         logger_1.logger.log((0, lang_1.i18n)(`commands.account.subcommands.info.name`, { name: name }));
-        logger_1.logger.log((0, lang_1.i18n)(`commands.account.subcommands.info.accountId`, { accountId: derivedAccountId }));
+        logger_1.logger.log((0, lang_1.i18n)(`commands.account.subcommands.info.accountId`, {
+            accountId: derivedAccountId,
+        }));
         logger_1.logger.log((0, lang_1.i18n)(`commands.account.subcommands.info.scopeGroups`));
         logger_1.logger.log((0, table_1.getTableContents)(scopeGroups, { border: { bodyLeft: '  ' } }));
     }
@@ -34,9 +36,18 @@ function accountInfoBuilder(yargs) {
         type: 'string',
     });
     yargs.example([
-        ['$0 accounts info', (0, lang_1.i18n)(`commands.account.subcommands.info.examples.default`)],
-        ['$0 accounts info MyAccount', (0, lang_1.i18n)(`commands.account.subcommands.info.examples.nameBased`)],
-        ['$0 accounts info 1234567', (0, lang_1.i18n)(`commands.account.subcommands.info.examples.idBased`)],
+        [
+            '$0 accounts info',
+            (0, lang_1.i18n)(`commands.account.subcommands.info.examples.default`),
+        ],
+        [
+            '$0 accounts info MyAccount',
+            (0, lang_1.i18n)(`commands.account.subcommands.info.examples.nameBased`),
+        ],
+        [
+            '$0 accounts info 1234567',
+            (0, lang_1.i18n)(`commands.account.subcommands.info.examples.idBased`),
+        ],
     ]);
     return yargs;
 }

package/commands/account/list.js

@@ -80,7 +80,9 @@ async function handler(args) {
         (0, lang_1.i18n)('commands.account.subcommands.list.labels.accountId'),
         (0, lang_1.i18n)('commands.account.subcommands.list.labels.authType'),
     ]));
-    logger_1.logger.log((0, lang_1.i18n)('commands.account.subcommands.list.configPath', { configPath: configPath }));
+    logger_1.logger.log((0, lang_1.i18n)('commands.account.subcommands.list.configPath', {
+        configPath: configPath,
+    }));
     logger_1.logger.log((0, lang_1.i18n)('commands.account.subcommands.list.defaultAccount', {
         account: (0, config_1.getConfigDefaultAccount)(),
     }));

package/commands/account/remove.js

@@ -45,8 +45,14 @@ function builder(yargs) {
         type: 'string',
     });
     yargs.example([
-        ['$0 accounts remove', (0, lang_1.i18n)(`commands.account.subcommands.remove.examples.default`)],
-        ['$0 accounts remove MyAccount', (0, lang_1.i18n)(`commands.account.subcommands.remove.examples.byName`)],
+        [
+            '$0 accounts remove',
+            (0, lang_1.i18n)(`commands.account.subcommands.remove.examples.default`),
+        ],
+        [
+            '$0 accounts remove MyAccount',
+            (0, lang_1.i18n)(`commands.account.subcommands.remove.examples.byName`),
+        ],
     ]);
     return yargs;
 }

package/commands/account/use.js

@@ -34,9 +34,18 @@ function builder(yargs) {
         type: 'string',
     });
     yargs.example([
-        ['$0 accounts use', (0, lang_1.i18n)('commands.account.subcommands.use.examples.default')],
-        ['$0 accounts use MyAccount', (0, lang_1.i18n)('commands.account.subcommands.use.examples.nameBased')],
-        ['$0 accounts use 1234567', (0, lang_1.i18n)('commands.account.subcommands.use.examples.idBased')],
+        [
+            '$0 accounts use',
+            (0, lang_1.i18n)('commands.account.subcommands.use.examples.default'),
+        ],
+        [
+            '$0 accounts use MyAccount',
+            (0, lang_1.i18n)('commands.account.subcommands.use.examples.nameBased'),
+        ],
+        [
+            '$0 accounts use 1234567',
+            (0, lang_1.i18n)('commands.account.subcommands.use.examples.idBased'),
+        ],
     ]);
     return yargs;
 }

package/commands/cms/lighthouseScore.js

@@ -67,7 +67,9 @@ exports.handler = async (options) => {
             isValidTheme = false;
         }
         if (!isValidTheme) {
-            logger.error(i18n(`commands.cms.subcommands.lighthouseScore.errors.themeNotFound`, { theme: themeToCheck }));
+            logger.error(i18n(`commands.cms.subcommands.lighthouseScore.errors.themeNotFound`, {
+                theme: themeToCheck,
+            }));
             process.exit(EXIT_CODES.ERROR);
         }
     }
@@ -206,7 +208,9 @@ exports.handler = async (options) => {
             });
         }
         logger.log();
-        logger.info(i18n(`commands.cms.subcommands.lighthouseScore.info.targetDeviceNote`, { target }));
+        logger.info(i18n(`commands.cms.subcommands.lighthouseScore.info.targetDeviceNote`, {
+            target,
+        }));
     }
     else {
         logger.log(`Theme: ${themeToCheck}`);

package/commands/config/set.js

@@ -73,6 +73,11 @@ exports.builder = yargs => {
         .conflicts('defaultCmsPublishMode', 'allowUsageTracking')
         .conflicts('defaultCmsPublishMode', 'httpTimeout')
         .conflicts('allowUsageTracking', 'httpTimeout')
-        .example([['$0 config set', i18n(`commands.config.subcommands.set.examples.default`)]]);
+        .example([
+        [
+            '$0 config set',
+            i18n(`commands.config.subcommands.set.examples.default`),
+        ],
+    ]);
     return yargs;
 };

package/commands/create/api-sample.js

@@ -24,7 +24,9 @@ module.exports = {
     execute: async ({ dest, name, assetType, options }) => {
         const filePath = path.join(dest, name);
         if (fs.existsSync(filePath)) {
-            const overwrite = await confirmPrompt(i18n(`commands.create.subcommands.apiSample.folderOverwritePrompt`, { folderName: filePath }), { defaultAnswer: false });
+            const overwrite = await confirmPrompt(i18n(`commands.create.subcommands.apiSample.folderOverwritePrompt`, {
+                folderName: filePath,
+            }), { defaultAnswer: false });
             if (overwrite) {
                 fs.rmdirSync(filePath, { recursive: true });
             }

package/commands/customObject/schema/delete.js

@@ -50,7 +50,10 @@ function builder(yargs) {
     (0, commonOpts_1.addUseEnvironmentOptions)(yargs);
     yargs
         .example([
-        ['$0 schema delete schemaName', (0, lang_1.i18n)(`commands.customObject.subcommands.schema.subcommands.delete.examples.default`)],
+        [
+            '$0 schema delete schemaName',
+            (0, lang_1.i18n)(`commands.customObject.subcommands.schema.subcommands.delete.examples.default`),
+        ],
     ])
         .positional('name', {
         describe: (0, lang_1.i18n)(`commands.customObject.subcommands.schema.subcommands.delete.positionals.name.describe`),

package/commands/customObject/schema/fetch-all.js

@@ -17,7 +17,8 @@ async function handler(args) {
     const { derivedAccountId, dest: providedDest } = args;
     (0, usageTracking_1.trackCommandUsage)('custom-object-schema-fetch-all', {}, derivedAccountId);
     try {
-        const dest = providedDest || (await (0, promptUtils_1.inputPrompt)((0, lang_1.i18n)(`commands.customObject.subcommands.schema.subcommands.fetchAll.inputDest`)));
+        const dest = providedDest ||
+            (await (0, promptUtils_1.inputPrompt)((0, lang_1.i18n)(`commands.customObject.subcommands.schema.subcommands.fetchAll.inputDest`)));
         const schemas = await (0, customObjects_1.downloadSchemas)(derivedAccountId, dest);
         (0, schema_1.logSchemas)(schemas);
         logger_1.logger.success((0, lang_1.i18n)(`commands.customObject.subcommands.schema.subcommands.fetchAll.success.fetch`, {

package/commands/customObject/schema/fetch.js

@@ -25,7 +25,8 @@ async function handler(args) {
                 (await (0, promptUtils_1.listPrompt)((0, lang_1.i18n)(`commands.customObject.subcommands.schema.subcommands.fetch.selectSchema`), {
                     choices: schemaNames,
                 }));
-        const dest = providedDest || (await (0, promptUtils_1.inputPrompt)((0, lang_1.i18n)(`commands.customObject.subcommands.schema.subcommands.fetch.inputDest`)));
+        const dest = providedDest ||
+            (await (0, promptUtils_1.inputPrompt)((0, lang_1.i18n)(`commands.customObject.subcommands.schema.subcommands.fetch.inputDest`)));
         await (0, customObjects_2.downloadSchema)(derivedAccountId, name, dest);
         logger_1.logger.success((0, lang_1.i18n)(`commands.customObject.subcommands.schema.subcommands.fetch.success.savedToPath`, {
             path: (0, customObjects_2.getResolvedPath)(dest, name),

package/commands/project/upload.js

@@ -31,7 +31,8 @@ exports.handler = async (options) => {
         uploadCommand: true,
     });
     try {
-        const { result, uploadError } = await handleProjectUpload(derivedAccountId, projectConfig, projectDir, pollProjectBuildAndDeploy, message, useV3Api(projectConfig?.platformVersion), skipValidation);
+        console.log('options.env', options.env);
+        const { result, uploadError } = await handleProjectUpload(derivedAccountId, projectConfig, projectDir, pollProjectBuildAndDeploy, message, useV3Api(projectConfig?.platformVersion), skipValidation, options.env);
         if (uploadError) {
             if (isSpecifiedError(uploadError, {
                 subCategory: PROJECT_ERROR_TYPES.PROJECT_LOCKED,
@@ -86,6 +87,11 @@ exports.builder = yargs => {
             hidden: true,
             default: false,
         },
+        env: {
+            type: 'string',
+            describe: i18n(`${i18nKey}.options.env.describe`),
+            hidden: true,
+        },
     });
     yargs.example([['$0 project upload', i18n(`${i18nKey}.examples.default`)]]);
     addConfigOptions(yargs);

package/lang/en.js

@@ -11,8 +11,6 @@ export const commands = {
     },
     srcIsProject: (src, command) =>
       `"${src}" is in a project folder. Did you mean "hs project ${command}"?`,
-    setDefaultAccountMoved:
-      'This command has moved. Try `hs accounts use` instead',
     handleDeprecatedEnvVariables: {
       portalEnvVarDeprecated:
         'The HUBSPOT_PORTAL_ID environment variable is deprecated. Please use HUBSPOT_ACCOUNT_ID instead.',

package/lang/en.lyaml

@@ -6,7 +6,6 @@ en:
         cmsUpdateNotification: "{{#bold}}The CMS CLI is now the HubSpot CLI{{/bold}}\n\nTo upgrade, uninstall {{#bold}}{{ packageName }}{{/bold}}\nand then run {{ updateCommand }}"
         cliUpdateNotification: "HubSpot CLI version {{#cyan}}{{#bold}}{currentVersion}{{/bold}}{{/cyan}} is outdated.\nRun {{ updateCommand }} to upgrade to version {{#cyan}}{{#bold}}{latestVersion}{{/bold}}{{/cyan}}"
       srcIsProject: "\"{{ src }}\" is in a project folder. Did you mean \"hs project {{command}}\"?"
-      setDefaultAccountMoved: "This command has moved. Try `hs accounts use` instead"
       handleDeprecatedEnvVariables:
         portalEnvVarDeprecated: "The HUBSPOT_PORTAL_ID environment variable is deprecated. Please use HUBSPOT_ACCOUNT_ID instead."
       loadConfigMiddleware:

package/lib/app/migrate.js

@@ -39,24 +39,28 @@ function getUnmigratableReason(reasonCode) {
 }
 async function handleMigrationSetup(derivedAccountId, options) {
     const { name, dest, appId } = options;
-    const { data } = await (0, migrate_1.listAppsForMigration)(derivedAccountId);
-    const { migratableApps, unmigratableApps } = data;
-    const allApps = [...migratableApps, ...unmigratableApps].filter(app => !app.projectName);
-    if (migratableApps.length === 0) {
-        const reasons = unmigratableApps.map(app => `${chalk_1.default.bold(app.appName)}: ${getUnmigratableReason(app.unmigratableReason)}`);
+    const { data: { migratableApps, unmigratableApps }, } = await (0, migrate_1.listAppsForMigration)(derivedAccountId);
+    const migratableAppsWithoutProject = migratableApps.filter((app) => !app.projectName);
+    const unmigratableAppsWithoutProject = unmigratableApps.filter((app) => !app.projectName);
+    const allAppsWithoutProject = [
+        ...migratableAppsWithoutProject,
+        ...unmigratableAppsWithoutProject,
+    ];
+    if (allAppsWithoutProject.length === 0) {
+        const reasons = unmigratableAppsWithoutProject.map(app => `${chalk_1.default.bold(app.appName)}: ${getUnmigratableReason(app.unmigratableReason)}`);
         throw new Error(`${(0, lang_1.i18n)(`commands.project.subcommands.migrateApp.errors.noAppsEligible`, {
-            accountId: derivedAccountId,
-        })} \n  - ${reasons.join('\n  - ')}`);
+            accountId: (0, ui_1.uiAccountDescription)(derivedAccountId),
+        })}${reasons.length ? `\n  - ${reasons.join('\n  - ')}` : ''}`);
     }
     if (appId &&
-        !allApps.some(app => {
+        !allAppsWithoutProject.some(app => {
             return app.appId === appId;
         })) {
         throw new Error((0, lang_1.i18n)('commands.project.subcommands.migrateApp.prompt.chooseApp', {
             appId,
         }));
     }
-    const appChoices = allApps.map(app => ({
+    const appChoices = allAppsWithoutProject.map(app => ({
         name: app.isMigratable
             ? app.appName
             : `[${chalk_1.default.yellow('DISABLED')}] ${app.appName} `,
@@ -72,7 +76,7 @@ async function handleMigrationSetup(derivedAccountId, options) {
         });
         appIdToMigrate = selectedAppId;
     }
-    const selectedApp = allApps.find(app => app.appId === appIdToMigrate);
+    const selectedApp = allAppsWithoutProject.find(app => app.appId === appIdToMigrate);
     const migratableComponents = [];
     const unmigratableComponents = [];
     selectedApp?.migrationComponents.forEach(component => {
@@ -133,8 +137,8 @@ async function beginMigration(derivedAccountId, appId, platformVersion) {
             const { componentHint, componentType } = component;
             uidMap[componentId] = await (0, promptUtils_1.inputPrompt)((0, lang_1.i18n)('commands.project.subcommands.migrateApp.prompt.uidForComponent', {
                 componentName: componentHint
-                    ? `${componentHint} [${componentType}]`
-                    : componentType,
+                    ? `${componentHint} [${(0, transform_1.mapToUserFacingType)(componentType)}]`
+                    : (0, transform_1.mapToUserFacingType)(componentType),
             }), {
                 validate: (uid) => {
                     const result = (0, project_parsing_lib_1.validateUid)(uid);
@@ -199,7 +203,7 @@ async function downloadProjectFiles(derivedAccountId, projectName, buildId, proj
             : (0, path_2.getCwd)();
         await (0, archive_1.extractZipArchive)(zippedProject, (0, path_2.sanitizeFileName)(projectName), absoluteDestPath, {
             includesRootDir: true,
-            hideLogs: false,
+            hideLogs: true,
         });
         SpinniesManager_1.default.succeed('fetchingMigratedProject', {
             text: (0, lang_1.i18n)(`commands.project.subcommands.migrateApp.spinners.downloadingProjectContentsComplete`),

package/lib/middleware/__test__/configMiddleware.test.d.ts

@@ -0,0 +1 @@
+export {};