@hubspot/cli 7.3.0 → 7.4.0-experimental.0

package/commands/project/migrateApp.js

@@ -1,188 +1,61 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// @ts-nocheck
-const path = require('path');
-const { addAccountOptions, addConfigOptions, addUseEnvironmentOptions, } = require('../../lib/commonOpts');
-const { trackCommandUsage, trackCommandMetadataUsage, } = require('../../lib/usageTracking');
-const { createProjectPrompt, } = require('../../lib/prompts/createProjectPrompt');
-const { i18n } = require('../../lib/lang');
-const { selectPublicAppPrompt, } = require('../../lib/prompts/selectPublicAppPrompt');
-const { poll } = require('../../lib/polling');
-const { uiBetaTag, uiLine, uiLink, uiCommandReference, uiAccountDescription, } = require('../../lib/ui');
-const SpinniesManager = require('../../lib/ui/SpinniesManager');
-const { logError, ApiErrorContext } = require('../../lib/errorHandlers/index');
-const { EXIT_CODES } = require('../../lib/enums/exitCodes');
-const { promptUser } = require('../../lib/prompts/promptUtils');
-const { isAppDeveloperAccount } = require('../../lib/accountTypes');
-const { ensureProjectExists } = require('../../lib/projects');
-const { handleKeypress } = require('../../lib/process');
-const { migrateApp, checkMigrationStatus, } = require('@hubspot/local-dev-lib/api/projects');
-const { getCwd, sanitizeFileName } = require('@hubspot/local-dev-lib/path');
-const { logger } = require('@hubspot/local-dev-lib/logger');
-const { getAccountConfig } = require('@hubspot/local-dev-lib/config');
-const { downloadProject } = require('@hubspot/local-dev-lib/api/projects');
-const { extractZipArchive } = require('@hubspot/local-dev-lib/archive');
-const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
-const { fetchPublicAppMetadata, } = require('@hubspot/local-dev-lib/api/appsDev');
-const i18nKey = 'commands.project.subcommands.migrateApp';
+exports.deprecated = exports.describe = exports.command = void 0;
+exports.handler = handler;
+exports.builder = builder;
+const lang_1 = require("../../lib/lang");
+const ui_1 = require("../../lib/ui");
+const migrate_1 = require("../app/migrate");
+const logger_1 = require("@hubspot/local-dev-lib/logger");
+const commonOpts_1 = require("../../lib/commonOpts");
 exports.command = 'migrate-app';
-exports.describe = uiBetaTag(i18n(`${i18nKey}.describe`), false);
-exports.handler = async (options) => {
-    const { derivedAccountId } = options;
-    const accountConfig = getAccountConfig(derivedAccountId);
-    const accountName = uiAccountDescription(derivedAccountId);
-    trackCommandUsage('migrate-app', {}, derivedAccountId);
-    logger.log('');
-    logger.log(uiBetaTag(i18n(`${i18nKey}.header.text`), false));
-    logger.log(uiLink(i18n(`${i18nKey}.header.link`), 'https://developers.hubspot.com/docs/platform/migrate-a-public-app-to-projects'));
-    logger.log('');
-    if (!isAppDeveloperAccount(accountConfig)) {
-        uiLine();
-        logger.error(i18n(`${i18nKey}.errors.invalidAccountTypeTitle`));
-        logger.log(i18n(`${i18nKey}.errors.invalidAccountTypeDescription`, {
-            useCommand: uiCommandReference('hs accounts use'),
-            authCommand: uiCommandReference('hs auth'),
-        }));
-        uiLine();
-        process.exit(EXIT_CODES.SUCCESS);
-    }
-    const { appId } = 'appId' in options
-        ? options
-        : await selectPublicAppPrompt({
-            accountId: derivedAccountId,
-            accountName,
-            isMigratingApp: true,
-        });
-    try {
-        const { data: selectedApp } = await fetchPublicAppMetadata(appId, derivedAccountId);
-        // preventProjectMigrations returns true if we have not added app to allowlist config.
-        // listingInfo will only exist for marketplace apps
-        const preventProjectMigrations = selectedApp.preventProjectMigrations;
-        const listingInfo = selectedApp.listingInfo;
-        if (preventProjectMigrations && listingInfo) {
-            logger.error(i18n(`${i18nKey}.errors.invalidApp`, { appId }));
-            process.exit(EXIT_CODES.ERROR);
-        }
-    }
-    catch (error) {
-        logError(error, new ApiErrorContext({ accountId: derivedAccountId }));
-        process.exit(EXIT_CODES.ERROR);
-    }
-    let projectName;
-    let projectDest;
-    try {
-        const createProjectPromptResponse = await createProjectPrompt(options);
-        projectName = createProjectPromptResponse.name;
-        projectDest = createProjectPromptResponse.dest;
-        const { projectExists } = await ensureProjectExists(derivedAccountId, projectName, {
-            allowCreate: false,
-            noLogs: true,
-        });
-        if (projectExists) {
-            logger.error(i18n(`${i18nKey}.errors.projectAlreadyExists`, {
-                projectName,
-            }));
-            process.exit(EXIT_CODES.ERROR);
-        }
-    }
-    catch (error) {
-        logError(error, new ApiErrorContext({ accountId: derivedAccountId }));
-        process.exit(EXIT_CODES.ERROR);
-    }
-    await trackCommandMetadataUsage('migrate-app', { status: 'STARTED' }, derivedAccountId);
-    logger.log('');
-    uiLine();
-    logger.warn(i18n(`${i18nKey}.warning.title`));
-    logger.log('');
-    logger.log(i18n(`${i18nKey}.warning.projectConversion`));
-    logger.log(i18n(`${i18nKey}.warning.appConfig`));
-    logger.log('');
-    logger.log(i18n(`${i18nKey}.warning.buildAndDeploy`));
-    logger.log('');
-    logger.log(i18n(`${i18nKey}.warning.existingApps`));
-    logger.log('');
-    logger.log(i18n(`${i18nKey}.warning.copyApp`));
-    uiLine();
-    const { shouldCreateApp } = await promptUser({
-        name: 'shouldCreateApp',
-        type: 'confirm',
-        message: i18n(`${i18nKey}.createAppPrompt`),
-    });
-    process.stdin.resume();
-    if (!shouldCreateApp) {
-        process.exit(EXIT_CODES.SUCCESS);
-    }
-    try {
-        SpinniesManager.init();
-        SpinniesManager.add('migrateApp', {
-            text: i18n(`${i18nKey}.migrationStatus.inProgress`),
-        });
-        handleKeypress(async (key) => {
-            if ((key.ctrl && key.name === 'c') || key.name === 'q') {
-                SpinniesManager.remove('migrateApp');
-                logger.log(i18n(`${i18nKey}.migrationInterrupted`));
-                process.exit(EXIT_CODES.SUCCESS);
-            }
-        });
-        const { data: migrateResponse } = await migrateApp(derivedAccountId, appId, projectName);
-        const { id } = migrateResponse;
-        const pollResponse = await poll(() => checkMigrationStatus(derivedAccountId, id));
-        const { status, project } = pollResponse;
-        if (status === 'SUCCESS') {
-            const absoluteDestPath = path.resolve(getCwd(), projectDest);
-            const { env } = accountConfig;
-            const baseUrl = getHubSpotWebsiteOrigin(env);
-            const { data: zippedProject } = await downloadProject(derivedAccountId, projectName, 1);
-            await extractZipArchive(zippedProject, sanitizeFileName(projectName), path.resolve(absoluteDestPath), { includesRootDir: true, hideLogs: true });
-            SpinniesManager.succeed('migrateApp', {
-                text: i18n(`${i18nKey}.migrationStatus.done`),
-                succeedColor: 'white',
-            });
-            logger.log('');
-            uiLine();
-            logger.success(i18n(`${i18nKey}.migrationStatus.success`));
-            logger.log('');
-            logger.log(uiLink(i18n(`${i18nKey}.projectDetailsLink`), `${baseUrl}/developer-projects/${derivedAccountId}/project/${encodeURIComponent(project.name)}`));
-            process.exit(EXIT_CODES.SUCCESS);
-        }
-    }
-    catch (error) {
-        await trackCommandMetadataUsage('migrate-app', { status: 'FAILURE' }, derivedAccountId);
-        SpinniesManager.fail('migrateApp', {
-            text: i18n(`${i18nKey}.migrationStatus.failure`),
-            failColor: 'white',
-        });
-        if (error.errors) {
-            error.errors.forEach(logError);
-        }
-        else {
-            logError(error, new ApiErrorContext({ accountId: derivedAccountId }));
-        }
-        process.exit(EXIT_CODES.ERROR);
-    }
-    await trackCommandMetadataUsage('migrate-app', { status: 'SUCCESS' }, derivedAccountId);
-    process.exit(EXIT_CODES.SUCCESS);
-};
-exports.builder = yargs => {
+// TODO: Leave this as deprecated and remove in the next major release
+exports.describe = (0, ui_1.uiDeprecatedTag)((0, lang_1.i18n)(`commands.project.subcommands.migrateApp.describe`), false);
+exports.deprecated = true;
+async function handler(yargs) {
+    logger_1.logger.warn((0, lang_1.i18n)(`commands.project.subcommands.migrateApp.deprecationWarning`, {
+        oldCommand: (0, ui_1.uiCommandReference)('hs project migrate-app'),
+        newCommand: (0, ui_1.uiCommandReference)('hs app migrate'),
+    }));
+    await (0, migrate_1.handler)(yargs);
+}
+function builder(yargs) {
+    (0, commonOpts_1.addConfigOptions)(yargs);
+    (0, commonOpts_1.addAccountOptions)(yargs);
+    (0, commonOpts_1.addUseEnvironmentOptions)(yargs);
     yargs.options({
         name: {
-            describe: i18n(`${i18nKey}.options.name.describe`),
+            describe: (0, lang_1.i18n)(`commands.project.subcommands.migrateApp.options.name.describe`),
             type: 'string',
         },
         dest: {
-            describe: i18n(`${i18nKey}.options.dest.describe`),
+            describe: (0, lang_1.i18n)(`commands.project.subcommands.migrateApp.options.dest.describe`),
             type: 'string',
         },
         'app-id': {
-            describe: i18n(`${i18nKey}.options.appId.describe`),
+            describe: (0, lang_1.i18n)(`commands.project.subcommands.migrateApp.options.appId.describe`),
             type: 'number',
         },
+        'platform-version': {
+            type: 'string',
+            choices: migrate_1.validMigrationTargets,
+            hidden: true,
+            default: '2023.2',
+        },
     });
     yargs.example([
-        ['$0 project migrate-app', i18n(`${i18nKey}.examples.default`)],
+        [
+            `$0 project migrate-app`,
+            (0, lang_1.i18n)(`commands.project.subcommands.migrateApp.examples.default`),
+        ],
     ]);
-    addConfigOptions(yargs);
-    addAccountOptions(yargs);
-    addUseEnvironmentOptions(yargs);
     return yargs;
+}
+const migrateAppCommand = {
+    command: exports.command,
+    describe: exports.describe,
+    deprecated: exports.deprecated,
+    handler,
+    builder,
 };
+exports.default = migrateAppCommand;

package/lang/en.js

@@ -2841,7 +2841,7 @@ export const lib = {
     disabledUrlText: 'See all HubSpot CLI commands here.',
     featureHighlight: {
       defaultTitle: "What's next?",
-      featureKeys: {
+      commandKeys: {
         accountOption: {
           command: '--account',
           message: command =>
@@ -2895,11 +2895,6 @@ export const lib = {
           message: command =>
             `Run ${command} to set up your test environment and start local development`,
         },
-        projectInstallDepsCommand: {
-          command: 'hs project install-deps',
-          message: command =>
-            `Run ${command} to install dependencies for your project components`,
-        },
         sampleProjects: {
           linkText: "HubSpot's sample projects",
           url: 'https://developers.hubspot.com/docs/platform/sample-projects?utm_source=cli&utm_content=project_create_whats_next',

package/lang/en.lyaml

@@ -570,6 +570,7 @@ en:
           header:
             text: "Migrate an app to the projects framework"
             link: "Learn more about migrating apps to the projects framework"
+          deprecationWarning: "The {{ oldCommand }} command is deprecated and will be removed. Use {{ newCommand }} going forward."
           migrationStatus:
             inProgress: "Converting app configuration to {{#bold}}public-app.json{{/bold}} component definition ..."
             success: "{{#bold}}Your app was converted and build #1 is deployed{{/bold}}"
@@ -585,11 +586,41 @@ en:
           migrationInterrupted: "\nThe command is terminated, but app migration is still in progress. Please check your account to ensure that the project and associated app have been created successfully."
           createAppPrompt: "Proceed with migrating this app to a project component (this process can't be aborted)?"
           projectDetailsLink: "View project details in your developer account"
+          componentsToBeMigrated: "The following component types will be migrated: {{ components }}"
+          componentsThatWillNotBeMigrated: "[NOTE] These component types are not yet supported for migration but will be available later: {{ components }}"
           errors:
+            noApps: "No apps found in account {{ accountId }}"
+            noAppsEligible: "No apps in account {{ accountId }} are currently migratable"
+            noAccountConfig: "There is no account associated with {{ accountId }} in the config file. Please choose another account and try again, or authenticate {{ accountId }} using {{ authCommand }}."
             invalidAccountTypeTitle: "{{#bold}}Developer account not targeted{{/bold}}"
             invalidAccountTypeDescription: "Only public apps created in a developer account can be converted to a project component. Select a connected developer account with {{useCommand}} or {{authCommand}} and try again."
             projectAlreadyExists: "A project with name {{ projectName }} already exists. Please choose another name."
             invalidApp: "Could not migrate appId {{ appId }}. This app cannot be migrated at this time. Please choose another public app."
+            appWithAppIdNotFound: "Could not find an app with the id {{ appId }} "
+          prompt:
+            chooseApp: 'Which app would you like to migrate?'
+            inputName: '[--name] What would you like to name the project?'
+            inputDest: '[--dest] Where would you like to save the project?'
+            uidForComponent: 'What UID would you like to use for {{ componentName }}?'
+            proceed: 'Would you like to proceed?'
+          spinners:
+            beginningMigration: "Beginning migration"
+            migrationStarted: "Migration started"
+            unableToStartMigration: "Unable to begin migration"
+            finishingMigration: "Wrapping up migration"
+            migrationComplete: "Migration completed"
+            migrationFailed: "Migration failed"
+            downloadingProjectContents: "Downloading migrated project files"
+            downloadingProjectContentsComplete: "Migrated project files downloaded"
+            downloadingProjectContentsFailed: "Unable to download migrated project files"
+            copyingProjectFiles: "Copying migrated project files"
+            copyingProjectFilesComplete: "Migrated project files copied"
+            copyingProjectFilesFailed: "Unable to copy migrated project files"
+          unmigratableReasons:
+            upToDate: 'App is already up to date'
+            isPrivateApp: 'Private apps are not currently migratable'
+            listedInMarketplace: 'Listed apps are not currently migratable'
+            generic: "Unable to migrate app: {{ reasonCode }}"
         cloneApp:
           describe: "Clone a public app using the projects framework."
           examples:
@@ -608,6 +639,7 @@ en:
             invalidAccountTypeTitle: "{{#bold}}Developer account not targeted{{/bold}}"
             invalidAccountTypeDescription: "Only public apps created in a developer account can be converted to a project component. Select a connected developer account with {{useCommand}} or {{authCommand}} and try again."
             couldNotWriteConfigPath: "Failed to write project config at {{ configPath }}"
+            noAccountConfig: "There is no account associated with {{ accountId }} in the config file. Please choose another account and try again, or authenticate {{ accountId }} using {{ authCommand }}."
         add:
           describe: "Create a new component within a project."
           options:
@@ -1077,7 +1109,6 @@ en:
         missingComponents: "Couldn't find the following components in the deployed build for this project: {{#bold}}'{{ missingComponents }}'{{/bold}}. This may cause issues in local development."
         defaultWarning: "{{#bold}}Changing project configuration requires a new project build.{{/bold}}"
         defaultPublicAppWarning: "{{#bold}}Changing project configuration requires a new project build.{{/bold}}\n\nThis will affect your public app's {{#bold}}{{ installCount }} existing {{ installText }}{{/bold}}. If your app has users in production, we strongly recommend creating a copy of this app to test your changes before proceding."
-        defaultMarketplaceAppWarning: "{{#bold}}Changing project configuration requires creating a new project build.{{/bold}}\n\nYour marketplace app is currently installed in {{#bold}}{{ installCount }} {{ accountText }}{{/bold}}. Any uploaded changes will impact your app's users. We strongly recommend creating a copy of this app to test your changes before proceding."
         header: "{{ warning }} To reflect these changes and continue testing:"
         stopDev: "  * Stop {{ command }}"
         runUpload: "  * Run {{ command }}"
@@ -1213,9 +1244,6 @@ en:
           projectDevCommand:
             command: "hs project dev"
             message: "Run {{ command }} to set up your test environment and start local development"
-          projectInstallDepsCommand:
-            command: "hs project install-deps"
-            message: "Run {{ command }} to install dependencies for your project components"
           projectCommandTip:
             message: "Tip: All project commands must be run from within a project directory"
           sampleProjects:

package/lib/DevServerManagerV2.d.ts

@@ -12,10 +12,11 @@ declare class DevServerManagerV2 {
     private devServers;
     constructor();
     iterateDevServers(callback: (serverInterface: DevServerInterface) => Promise<void>): Promise<void>;
-    setup({ projectNodes, accountId, setActiveApp, }: {
+    setup({ projectNodes, onUploadRequired, accountId, setActiveApp, }: {
         projectNodes: {
             [key: string]: IntermediateRepresentationNodeLocalDev;
         };
+        onUploadRequired: () => void;
         accountId: number;
         setActiveApp: (appUid: string | undefined) => Promise<void>;
     }): Promise<void>;

package/lib/DevServerManagerV2.js

@@ -20,7 +20,7 @@ class DevServerManagerV2 {
     async iterateDevServers(callback) {
         await Promise.all(this.devServers.map(devServer => callback(devServer)));
     }
-    async setup({ projectNodes, accountId, setActiveApp, }) {
+    async setup({ projectNodes, onUploadRequired, accountId, setActiveApp, }) {
         let env;
         const accountConfig = (0, config_1.getAccountConfig)(accountId);
         if (accountConfig) {
@@ -31,6 +31,7 @@ class DevServerManagerV2 {
             if (serverInterface.setup) {
                 await serverInterface.setup({
                     components: projectNodes,
+                    onUploadRequired,
                     promptUser: promptUtils_1.promptUser,
                     logger: logger_1.logger,
                     urls: {

package/lib/LocalDevManagerV2.js

@@ -10,7 +10,6 @@ const logger_1 = require("@hubspot/local-dev-lib/logger");
 const localDevAuth_1 = require("@hubspot/local-dev-lib/api/localDevAuth");
 const appsDev_1 = require("@hubspot/local-dev-lib/api/appsDev");
 const config_1 = require("@hubspot/local-dev-lib/config");
-const project_parsing_lib_1 = require("@hubspot/project-parsing-lib");
 const constants_1 = require("./constants");
 const SpinniesManager_1 = __importDefault(require("./ui/SpinniesManager"));
 const DevServerManagerV2_1 = __importDefault(require("./DevServerManagerV2"));
@@ -213,13 +212,16 @@ class LocalDevManagerV2 {
             : (0, ui_1.uiCommandReference)('hs project upload');
     }
     logUploadWarning(reason) {
-        let warning = reason;
-        if (!warning) {
+        let warning;
+        if (reason) {
+            warning = reason;
+        }
+        else {
             warning =
                 this.publicAppActiveInstalls && this.publicAppActiveInstalls > 0
-                    ? (0, lang_1.i18n)(`${i18nKey}.uploadWarning.defaultMarketplaceAppWarning`, {
+                    ? (0, lang_1.i18n)(`${i18nKey}.uploadWarning.defaultPublicAppWarning`, {
                         installCount: this.publicAppActiveInstalls,
-                        accountText: this.publicAppActiveInstalls === 1 ? 'account' : 'accounts',
+                        installText: this.publicAppActiveInstalls === 1 ? 'install' : 'installs',
                     })
                     : (0, lang_1.i18n)(`${i18nKey}.uploadWarning.defaultWarning`);
         }
@@ -266,10 +268,10 @@ class LocalDevManagerV2 {
         const deployedComponentNames = this.deployedBuild.subbuildStatuses.map(subbuildStatus => subbuildStatus.buildName);
         const missingProjectNodes = [];
         Object.values(this.projectNodes).forEach(node => {
-            if (!deployedComponentNames.includes(node.uid)) {
-                const userFriendlyName = (0, project_parsing_lib_1.mapToUserFriendlyName)(node.componentType);
-                const label = userFriendlyName ? `[${userFriendlyName}] ` : '';
-                missingProjectNodes.push(`${label}${node.uid}`);
+            if ((0, structure_1.isAppIRNode)(node) || (0, structure_1.isCardIRNode)(node)) {
+                if (!deployedComponentNames.includes(node.uid)) {
+                    missingProjectNodes.push(`${(0, lang_1.i18n)(`${i18nKey}.uploadWarning.appLabel`)} ${node.uid}`);
+                }
             }
         });
         if (missingProjectNodes.length) {
@@ -282,7 +284,9 @@ class LocalDevManagerV2 {
         this.watcher = chokidar_1.default.watch(this.projectDir, {
             ignoreInitial: true,
         });
-        const configPaths = Object.values(this.projectNodes).map(component => component.localDev.componentConfigPath);
+        const configPaths = Object.values(this.projectNodes)
+            .filter(structure_1.isAppIRNode)
+            .map(component => component.localDev.componentConfigPath);
         const projectConfigPath = path_1.default.join(this.projectDir, constants_1.PROJECT_CONFIG_FILE);
         configPaths.push(projectConfigPath);
         this.watcher.on('add', filePath => {
@@ -313,6 +317,7 @@ class LocalDevManagerV2 {
         try {
             await DevServerManagerV2_1.default.setup({
                 projectNodes: this.projectNodes,
+                onUploadRequired: this.logUploadWarning.bind(this),
                 accountId: this.targetTestingAccountId,
                 setActiveApp: this.setActiveApp.bind(this),
             });

package/lib/app/migrate.d.ts

@@ -0,0 +1,7 @@
+import { CLIAccount } from '@hubspot/local-dev-lib/types/Accounts';
+import { ArgumentsCamelCase } from 'yargs';
+import { MigrateAppOptions } from '../../types/Yargs';
+export declare function downloadProjectFiles(derivedAccountId: number, projectName: string, buildId: number, projectDest: string): Promise<void>;
+export declare function migrateApp2025_2(derivedAccountId: number, options: ArgumentsCamelCase<MigrateAppOptions>): Promise<void>;
+export declare function logInvalidAccountError(i18nKey: string): void;
+export declare function migrateApp2023_2(derivedAccountId: number, options: ArgumentsCamelCase<MigrateAppOptions>, accountConfig: CLIAccount): Promise<void>;