@hubspot/cli 7.3.0-experimental.2 → 7.4.0-beta.0

package/api/migrate.d.ts

@@ -0,0 +1,61 @@
+import { HubSpotPromise } from '@hubspot/local-dev-lib/types/Http';
+import { UNMIGRATABLE_REASONS } from '@hubspot/local-dev-lib/constants/projects';
+import { MIGRATION_STATUS } from '@hubspot/local-dev-lib/types/Migration';
+interface BaseMigrationApp {
+    appId: number;
+    appName: string;
+    isMigratable: boolean;
+    migrationComponents: ListAppsMigrationComponent[];
+    projectName?: string;
+}
+export interface MigratableApp extends BaseMigrationApp {
+    isMigratable: true;
+}
+export interface UnmigratableApp extends BaseMigrationApp {
+    isMigratable: false;
+    unmigratableReason: keyof typeof UNMIGRATABLE_REASONS;
+}
+export type MigrationApp = MigratableApp | UnmigratableApp;
+export interface ListAppsResponse {
+    migratableApps: MigratableApp[];
+    unmigratableApps: UnmigratableApp[];
+}
+export interface InitializeMigrationResponse {
+    migrationId: number;
+}
+export interface ListAppsMigrationComponent {
+    id: string;
+    componentType: string;
+    isSupported: boolean;
+}
+export type ContinueMigrationResponse = {
+    migrationId: number;
+};
+export interface MigrationBaseStatus {
+    id: number;
+}
+export interface MigrationInProgress extends MigrationBaseStatus {
+    status: typeof MIGRATION_STATUS.IN_PROGRESS;
+}
+export interface MigrationInputRequired extends MigrationBaseStatus {
+    status: typeof MIGRATION_STATUS.INPUT_REQUIRED;
+    componentsRequiringUids: Record<string, {
+        componentType: string;
+        componentHint: string;
+    }>;
+}
+export interface MigrationSuccess extends MigrationBaseStatus {
+    status: typeof MIGRATION_STATUS.SUCCESS;
+    buildId: number;
+}
+export interface MigrationFailed extends MigrationBaseStatus {
+    status: typeof MIGRATION_STATUS.FAILURE;
+    projectErrorsDetail?: string;
+    componentErrorDetails: Record<string, string>;
+}
+export type MigrationStatus = MigrationInProgress | MigrationInputRequired | MigrationSuccess | MigrationFailed;
+export declare function listAppsForMigration(accountId: number): HubSpotPromise<ListAppsResponse>;
+export declare function initializeMigration(accountId: number, applicationId: number, platformVersion: string): HubSpotPromise<InitializeMigrationResponse>;
+export declare function continueMigration(portalId: number, migrationId: number, componentUids: Record<string, string>, projectName: string): HubSpotPromise<ContinueMigrationResponse>;
+export declare function checkMigrationStatusV2(accountId: number, id: number): HubSpotPromise<MigrationStatus>;
+export {};

package/api/migrate.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listAppsForMigration = listAppsForMigration;
+exports.initializeMigration = initializeMigration;
+exports.continueMigration = continueMigration;
+exports.checkMigrationStatusV2 = checkMigrationStatusV2;
+const projects_1 = require("@hubspot/local-dev-lib/constants/projects");
+const http_1 = require("@hubspot/local-dev-lib/http");
+const MIGRATIONS_API_PATH_V2 = 'dfs/migrations/v2';
+async function listAppsForMigration(accountId) {
+    return http_1.http.get(accountId, {
+        url: `${MIGRATIONS_API_PATH_V2}/list-apps`,
+    });
+}
+function mapPlatformVersionToEnum(platformVersion) {
+    if (platformVersion === projects_1.PLATFORM_VERSIONS.unstable) {
+        return projects_1.PLATFORM_VERSIONS.unstable.toUpperCase();
+    }
+    return `V${platformVersion.replace('.', '_')}`;
+}
+async function initializeMigration(accountId, applicationId, platformVersion) {
+    return http_1.http.post(accountId, {
+        url: `${MIGRATIONS_API_PATH_V2}/migrations`,
+        data: {
+            applicationId,
+            platformVersion: mapPlatformVersionToEnum(platformVersion),
+        },
+    });
+}
+async function continueMigration(portalId, migrationId, componentUids, projectName) {
+    return http_1.http.post(portalId, {
+        url: `${MIGRATIONS_API_PATH_V2}/migrations/continue`,
+        data: {
+            migrationId,
+            projectName,
+            componentUids,
+        },
+    });
+}
+function checkMigrationStatusV2(accountId, id) {
+    return http_1.http.get(accountId, {
+        url: `${MIGRATIONS_API_PATH_V2}/migrations/${id}/status`,
+    });
+}

package/bin/cli.js

@@ -1,23 +1,17 @@
 #!/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 SpinniesManager = require('../lib/ui/SpinniesManager');
-const { isGloballyInstalled, executeInstall } = require('../lib/npm');
+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 { checkFireAlarms } = require('../lib/middleware/fireAlarmMiddleware');
 const removeCommand = require('../commands/remove');
 const initCommand = require('../commands/init');
 const logsCommand = require('../commands/logs');
@@ -45,36 +39,8 @@ const cmsCommand = require('../commands/cms');
 const feedbackCommand = require('../commands/feedback');
 const doctorCommand = require('../commands/doctor');
 const completionCommand = require('../commands/completion');
-const notifier = updateNotifier({
-    pkg: { ...pkg, name: '@hubspot/cli' },
-    distTag: 'latest',
-    shouldNotifyInNpmScript: true,
-});
-const i18nKey = 'commands.generalErrors';
-const CMS_CLI_PACKAGE_NAME = '@hubspot/cms-cli';
-const showUpdateNotification = () => {
-    notifier.notify({
-        message: pkg.name === CMS_CLI_PACKAGE_NAME
-            ? i18n(`${i18nKey}.updateNotify.cmsUpdateNotification`, {
-                packageName: CMS_CLI_PACKAGE_NAME,
-                updateCommand: uiCommandReference('{updateCommand}'),
-            })
-            : i18n(`${i18nKey}.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(`${i18nKey}.updateNotify.notifyTitle`)),
-        },
-    });
-};
+const appCommand = require('../commands/app');
+notifyAboutUpdates();
 const getTerminalWidth = () => {
     const width = yargs.terminalWidth();
     if (width >= 100)
@@ -96,216 +62,18 @@ 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(`${i18nKey}.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(`${i18nKey}.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 updateCLIVersion = async () => {
-    logger.debug('Checking for CLI updates', notifier);
-    if (!process.env.SKIP_HUBSPOT_CLI_AUTO_UPDATES &&
-        notifier &&
-        notifier.update) {
-        let updateInfo;
-        try {
-            updateInfo = await notifier.fetchInfo();
-        }
-        catch (e) {
-            logger.debug('Error fetching update info', e);
-            return;
-        }
-        // Update if the current version is not the latest version.
-        // Don't auto-update if the current version is a pre-release
-        // or if this would be a major version update
-        if (!updateInfo.current.includes('-') &&
-            !['major', 'latest'].includes(updateInfo.type)) {
-            SpinniesManager.init({
-                succeedColor: 'white',
-            });
-            SpinniesManager.add('cliAutoUpdate', {
-                text: `New HubSpot CLI version available. Updating to version ${updateInfo.latest}`,
-            });
-            let showManualInstallHelp = false;
-            try {
-                if (await isGloballyInstalled()) {
-                    await executeInstall(['@hubspot/cli@latest'], '-g');
-                    SpinniesManager.succeed('cliAutoUpdate', {
-                        text: `Successfully updated HubSpot CLI to version ${updateInfo.latest}`,
-                    });
-                }
-                else {
-                    SpinniesManager.fail('cliAutoUpdate', {
-                        text: `Cannot auto-update the HubSpot CLI if it is not globall installed with NPM`,
-                    });
-                    showManualInstallHelp = true;
-                }
-            }
-            catch (e) {
-                logger.debug('Error updating CLI', e);
-                SpinniesManager.fail('cliAutoUpdate', {
-                    text: `Failed to update HubSpot CLI to version ${updateInfo.latest}`,
-                });
-                showManualInstallHelp = true;
-            }
-            if (showManualInstallHelp) {
-                showUpdateNotification();
-            }
-        }
-    }
-};
-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(`${i18nKey}.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(`${i18nKey}.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
     .middleware([
     setLogLevel,
-    updateCLIVersion,
     setRequestHeaders,
     handleDeprecatedEnvVariables,
     loadConfigMiddleware,
     injectAccountIdMiddleware,
     checkAndWarnGitInclusionMiddleware,
     validateAccountOptions,
+    checkFireAlarms,
 ])
     .exitProcess(false)
     .fail(handleFailure)
@@ -352,6 +120,7 @@ const argv = yargs
     .command(feedbackCommand)
     .command(doctorCommand)
     .command(completionCommand)
+    .command(appCommand)
     .help()
     .alias('h', 'help')
     .recommendCommands()

package/commands/account/auth.d.ts

@@ -0,0 +1,10 @@
+import { Argv, ArgumentsCamelCase } from 'yargs';
+import { CommonArgs, ConfigArgs } from '../../types/Yargs';
+export declare const describe: string;
+export declare const command = "auth";
+type AccountAuthArgs = CommonArgs & ConfigArgs & {
+    disableTracking?: boolean;
+};
+export declare function handler(args: ArgumentsCamelCase<AccountAuthArgs>): Promise<void>;
+export declare function builder(yargs: Argv): Argv<AccountAuthArgs>;
+export {};

package/commands/account/auth.js

@@ -0,0 +1,168 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = exports.describe = void 0;
+exports.handler = handler;
+exports.builder = builder;
+const config_1 = require("@hubspot/local-dev-lib/config");
+const migrate_1 = require("@hubspot/local-dev-lib/config/migrate");
+const getAccountIdentifier_1 = require("@hubspot/local-dev-lib/config/getAccountIdentifier");
+const logger_1 = require("@hubspot/local-dev-lib/logger");
+const personalAccessKey_1 = require("@hubspot/local-dev-lib/personalAccessKey");
+const environments_1 = require("@hubspot/local-dev-lib/constants/environments");
+const text_1 = require("@hubspot/local-dev-lib/text");
+const auth_1 = require("@hubspot/local-dev-lib/constants/auth");
+const commonOpts_1 = require("../../lib/commonOpts");
+const configMigrate_1 = require("../../lib/configMigrate");
+const process_1 = require("../../lib/process");
+const index_1 = require("../../lib/errorHandlers/index");
+const lang_1 = require("../../lib/lang");
+const usageTracking_1 = require("../../lib/usageTracking");
+const personalAccessKeyPrompt_1 = require("../../lib/prompts/personalAccessKeyPrompt");
+const accountNamePrompt_1 = require("../../lib/prompts/accountNamePrompt");
+const setAsDefaultAccountPrompt_1 = require("../../lib/prompts/setAsDefaultAccountPrompt");
+const index_2 = require("../../lib/errorHandlers/index");
+const usageTracking_2 = require("../../lib/usageTracking");
+const exitCodes_1 = require("../../lib/enums/exitCodes");
+const ui_1 = require("../../lib/ui");
+const TRACKING_STATUS = {
+    STARTED: 'started',
+    ERROR: 'error',
+    COMPLETE: 'complete',
+};
+async function updateConfig(env, doesConfigExist, disableTracking, authType, account) {
+    try {
+        const { personalAccessKey } = await (0, personalAccessKeyPrompt_1.personalAccessKeyPrompt)({
+            env,
+            account,
+        });
+        const token = await (0, personalAccessKey_1.getAccessToken)(personalAccessKey, env);
+        const defaultName = token.hubName ? (0, text_1.toKebabCase)(token.hubName) : undefined;
+        const name = doesConfigExist
+            ? undefined
+            : (await (0, accountNamePrompt_1.cliAccountNamePrompt)(defaultName)).name;
+        const updatedConfig = await (0, personalAccessKey_1.updateConfigWithAccessToken)(token, personalAccessKey, env, name, !doesConfigExist);
+        if (!updatedConfig)
+            return null;
+        if (doesConfigExist && !updatedConfig.name) {
+            updatedConfig.name = (await (0, accountNamePrompt_1.cliAccountNamePrompt)(defaultName)).name;
+            (0, config_1.updateAccountConfig)({
+                ...updatedConfig,
+            });
+            (0, config_1.writeConfig)();
+        }
+        return updatedConfig;
+    }
+    catch (e) {
+        if (!disableTracking) {
+            await (0, usageTracking_1.trackAuthAction)('account-auth', authType, TRACKING_STATUS.ERROR);
+        }
+        (0, index_1.debugError)(e);
+        return null;
+    }
+}
+exports.describe = (0, lang_1.i18n)('commands.account.subcommands.auth.describe');
+exports.command = 'auth';
+async function handler(args) {
+    const { providedAccountId, disableTracking } = args;
+    const authType = auth_1.PERSONAL_ACCESS_KEY_AUTH_METHOD.value;
+    const deprecatedConfigExists = (0, migrate_1.configFileExists)(false);
+    const globalConfigExists = (0, migrate_1.configFileExists)(true);
+    if (deprecatedConfigExists) {
+        if (globalConfigExists) {
+            try {
+                await (0, configMigrate_1.handleMerge)(providedAccountId);
+            }
+            catch (error) {
+                (0, index_2.logError)(error);
+                (0, usageTracking_2.trackCommandMetadataUsage)('account-auth', {
+                    command: 'hs account auth',
+                    type: 'Merge configs',
+                    successful: false,
+                }, providedAccountId);
+                process.exit(exitCodes_1.EXIT_CODES.ERROR);
+            }
+        }
+        else {
+            try {
+                await (0, configMigrate_1.handleMigration)(providedAccountId);
+            }
+            catch (error) {
+                (0, index_2.logError)(error);
+                (0, usageTracking_2.trackCommandMetadataUsage)('account-auth', {
+                    command: 'hs account auth',
+                    type: 'Migrate a single config',
+                    successful: false,
+                }, providedAccountId);
+                process.exit(exitCodes_1.EXIT_CODES.ERROR);
+            }
+        }
+    }
+    if (!disableTracking) {
+        (0, usageTracking_1.trackCommandUsage)('account-auth', {}, providedAccountId);
+        await (0, usageTracking_1.trackAuthAction)('account-auth', authType, TRACKING_STATUS.STARTED);
+    }
+    const env = args.qa ? environments_1.ENVIRONMENTS.QA : environments_1.ENVIRONMENTS.PROD;
+    const configAlreadyExists = (0, migrate_1.configFileExists)(true);
+    if (!configAlreadyExists) {
+        (0, config_1.createEmptyConfigFile)({}, true);
+    }
+    (0, config_1.loadConfig)('');
+    (0, process_1.handleExit)(config_1.deleteEmptyConfigFile);
+    const updatedConfig = await updateConfig(env, configAlreadyExists, disableTracking, authType, providedAccountId);
+    if (!updatedConfig) {
+        logger_1.logger.error((0, lang_1.i18n)('commands.account.subcommands.auth.errors.failedToUpdateConfig'));
+        process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
+    const { name } = updatedConfig;
+    const accountId = (0, getAccountIdentifier_1.getAccountIdentifier)(updatedConfig);
+    // If the config file was just created, we don't need to prompt the user to set as default
+    if (!configAlreadyExists) {
+        logger_1.logger.log('');
+        logger_1.logger.success((0, lang_1.i18n)('commands.account.subcommands.auth.success.configFileCreated', {
+            configPath: (0, config_1.getConfigPath)('', true),
+        }));
+        logger_1.logger.success((0, lang_1.i18n)('commands.account.subcommands.auth.success.configFileUpdated', {
+            account: name || accountId || '',
+        }));
+    }
+    else {
+        const setAsDefault = await (0, setAsDefaultAccountPrompt_1.setAsDefaultAccountPrompt)(name);
+        logger_1.logger.log('');
+        if (setAsDefault) {
+            logger_1.logger.success((0, lang_1.i18n)(`lib.prompts.setAsDefaultAccountPrompt.setAsDefaultAccount`, {
+                accountName: name,
+            }));
+        }
+        else {
+            logger_1.logger.info((0, lang_1.i18n)(`lib.prompts.setAsDefaultAccountPrompt.keepingCurrentDefault`, {
+                accountName: (0, config_1.getConfigDefaultAccount)(),
+            }));
+        }
+    }
+    (0, ui_1.uiFeatureHighlight)([
+        'helpCommand',
+        'accountAuthCommand',
+        'accountsListCommand',
+    ]);
+    if (!disableTracking) {
+        await (0, usageTracking_1.trackAuthAction)('account-auth', authType, TRACKING_STATUS.COMPLETE, accountId);
+    }
+    process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
+}
+function builder(yargs) {
+    yargs.options({
+        account: {
+            describe: (0, lang_1.i18n)('commands.account.subcommands.auth.options.account.describe'),
+            type: 'string',
+            alias: 'a',
+        },
+        'disable-tracking': {
+            type: 'boolean',
+            hidden: true,
+            default: false,
+        },
+    });
+    (0, commonOpts_1.addTestingOptions)(yargs);
+    (0, commonOpts_1.addGlobalOptions)(yargs);
+    return yargs;
+}