@hubspot/cli 7.1.0-beta.0 → 7.1.0-experimental.0

package/commands/project/dev/unifiedFlow.js

@@ -0,0 +1,110 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unifiedProjectDevFlow = unifiedProjectDevFlow;
+const path_1 = __importDefault(require("path"));
+const util_1 = __importDefault(require("util"));
+const logger_1 = require("@hubspot/local-dev-lib/logger");
+const errors_1 = require("@hubspot/project-parsing-lib/src/lib/errors");
+const project_parsing_lib_1 = require("@hubspot/project-parsing-lib");
+const config_1 = require("@hubspot/local-dev-lib/config");
+const environment_1 = require("@hubspot/local-dev-lib/environment");
+const errorHandlers_1 = require("../../../lib/errorHandlers");
+const exitCodes_1 = require("../../../lib/enums/exitCodes");
+const projects_1 = require("../../../lib/projects");
+const localDev_1 = require("../../../lib/localDev");
+const projectDevTargetAccountPrompt_1 = require("../../../lib/prompts/projectDevTargetAccountPrompt");
+const SpinniesManager_1 = __importDefault(require("../../../lib/ui/SpinniesManager"));
+const LocalDevManagerV2_1 = __importDefault(require("../../../lib/LocalDevManagerV2"));
+const process_1 = require("../../../lib/process");
+const accountTypes_1 = require("../../../lib/accountTypes");
+const ui_1 = require("../../../lib/ui");
+const lang_1 = require("../../../lib/lang");
+const i18nKey = 'commands.project.subcommands.dev';
+async function unifiedProjectDevFlow(args, accountConfig, projectConfig, projectDir) {
+    logger_1.logger.log('Unified Apps Local Dev');
+    const targetProjectAccountId = args.derivedAccountId;
+    const env = (0, environment_1.getValidEnv)((0, config_1.getEnv)(targetProjectAccountId));
+    let projectNodes;
+    // Get IR
+    try {
+        const intermediateRepresentation = await (0, project_parsing_lib_1.translateForLocalDev)({
+            projectSourceDir: path_1.default.join(projectDir, projectConfig.srcDir),
+            platformVersion: projectConfig.platformVersion,
+            accountId: targetProjectAccountId,
+        });
+        projectNodes = intermediateRepresentation.intermediateNodesIndexedByUid;
+        logger_1.logger.debug(util_1.default.inspect(projectNodes, false, null, true));
+    }
+    catch (e) {
+        if ((0, errors_1.isTranslationError)(e)) {
+            logger_1.logger.error(e.toString());
+        }
+        else {
+            (0, errorHandlers_1.logError)(e);
+        }
+        return process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
+    // @TODO Do we need to do more than this or leave it to the dev servers?
+    if (!Object.keys(projectNodes).length) {
+        logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.errors.noRunnableComponents`, {
+            projectDir,
+            command: (0, ui_1.uiCommandReference)('hs project add'),
+        }));
+        process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
+    }
+    // @TODO Validate component types (i.e. previously you could not have both private and public apps)
+    const accounts = (0, config_1.getConfigAccounts)();
+    // TODO Ideally this should require the user to target a Combined account
+    // For now, check if the account is either developer or standard
+    const derivedAccountIsRecommendedType = (0, accountTypes_1.isAppDeveloperAccount)(accountConfig) || (0, accountTypes_1.isStandardAccount)(accountConfig);
+    if (!derivedAccountIsRecommendedType) {
+        logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.errors.invalidUnifiedAppsAccount`));
+        process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
+    }
+    let targetTestingAccountId = null;
+    const devAccountPromptResponse = await (0, projectDevTargetAccountPrompt_1.selectDeveloperTestTargetAccountPrompt)(accounts, accountConfig);
+    targetTestingAccountId = devAccountPromptResponse.targetAccountId;
+    if (!!devAccountPromptResponse.notInConfigAccount) {
+        // When the developer test account isn't configured in the CLI config yet
+        // Walk the user through adding the account's PAK to the config
+        await (0, localDev_1.useExistingDevTestAccount)(env, devAccountPromptResponse.notInConfigAccount);
+    }
+    else if (devAccountPromptResponse.createNestedAccount) {
+        // Create a new developer test account and automatically add it to the CLI config
+        targetTestingAccountId = await (0, localDev_1.createDeveloperTestAccountForLocalDev)(targetProjectAccountId, accountConfig, env);
+    }
+    // Check if project exists in HubSpot
+    const { projectExists, project: uploadedProject } = await (0, projects_1.ensureProjectExists)(targetProjectAccountId, projectConfig.name, {
+        allowCreate: false,
+        noLogs: true,
+    });
+    let deployedBuild;
+    let isGithubLinked = false;
+    let project = uploadedProject;
+    SpinniesManager_1.default.init();
+    if (projectExists && project) {
+        deployedBuild = project.deployedBuild;
+        isGithubLinked = Boolean(project.sourceIntegration && project.sourceIntegration.source === 'GITHUB');
+    }
+    else {
+        project = await (0, localDev_1.createNewProjectForLocalDev)(projectConfig, targetProjectAccountId, false, false);
+        deployedBuild = await (0, localDev_1.createInitialBuildForNewProject)(projectConfig, projectDir, targetProjectAccountId);
+    }
+    const LocalDev = new LocalDevManagerV2_1.default({
+        projectNodes,
+        debug: args.debug,
+        deployedBuild,
+        isGithubLinked,
+        targetProjectAccountId,
+        targetTestingAccountId: targetTestingAccountId,
+        projectConfig,
+        projectDir,
+        projectId: project.id,
+        env,
+    });
+    await LocalDev.start();
+    (0, process_1.handleExit)(({ isSIGHUP }) => LocalDev.stop(!isSIGHUP));
+}

package/commands/project/migrateApp.js

@@ -71,9 +71,9 @@ exports.handler = async (options) => {
     let projectName;
     let projectDest;
     try {
-        const { name, dest } = await createProjectPrompt('', options, true);
-        projectName = options.name || name;
-        projectDest = options.dest || dest;
+        const createProjectPromptResponse = await createProjectPrompt(options);
+        projectName = createProjectPromptResponse.name;
+        projectDest = createProjectPromptResponse.dest;
         const { projectExists } = await ensureProjectExists(derivedAccountId, projectName, {
             allowCreate: false,
             noLogs: true,

package/commands/project/upload.js

@@ -20,7 +20,7 @@ const i18nKey = 'commands.project.subcommands.upload';
 exports.command = 'upload';
 exports.describe = uiBetaTag(i18n(`${i18nKey}.describe`), false);
 exports.handler = async (options) => {
-    const { forceCreate, message, derivedAccountId } = options;
+    const { forceCreate, message, derivedAccountId, skipValidation } = options;
     const accountConfig = getAccountConfig(derivedAccountId);
     const accountType = accountConfig && accountConfig.accountType;
     const { projectConfig, projectDir } = await getProjectConfig();
@@ -31,7 +31,7 @@ exports.handler = async (options) => {
         uploadCommand: true,
     });
     try {
-        const { result, uploadError } = await handleProjectUpload(derivedAccountId, projectConfig, projectDir, pollProjectBuildAndDeploy, message, useV3Api(projectConfig?.platformVersion));
+        const { result, uploadError } = await handleProjectUpload(derivedAccountId, projectConfig, projectDir, pollProjectBuildAndDeploy, message, useV3Api(projectConfig?.platformVersion), skipValidation);
         if (uploadError) {
             if (isSpecifiedError(uploadError, {
                 subCategory: PROJECT_ERROR_TYPES.PROJECT_LOCKED,
@@ -81,6 +81,11 @@ exports.builder = yargs => {
             type: 'string',
             default: '',
         },
+        'skip-validation': {
+            type: 'boolean',
+            hidden: true,
+            default: false,
+        },
     });
     yargs.example([['$0 project upload', i18n(`${i18nKey}.examples.default`)]]);
     addConfigOptions(yargs);

package/commands/sandbox/create.d.ts

@@ -1 +1,13 @@
+import { Argv, ArgumentsCamelCase } from 'yargs';
+import { CommonArgs, ConfigArgs, AccountArgs, EnvironmentArgs, TestingArgs } from '../../types/Yargs';
+export declare const command = "create";
+export declare const describe: string | undefined;
+type CombinedArgs = ConfigArgs & AccountArgs & EnvironmentArgs & TestingArgs;
+type SandboxCreateArgs = CommonArgs & CombinedArgs & {
+    name?: string;
+    force?: boolean;
+    type?: string;
+};
+export declare function handler(args: ArgumentsCamelCase<SandboxCreateArgs>): Promise<void>;
+export declare function builder(yargs: Argv): Argv<SandboxCreateArgs>;
 export {};

package/commands/sandbox/create.js

@@ -1,157 +1,175 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// @ts-nocheck
-const { addAccountOptions, addConfigOptions, addUseEnvironmentOptions, addTestingOptions, } = require('../../lib/commonOpts');
-const { i18n } = require('../../lib/lang');
-const { EXIT_CODES } = require('../../lib/enums/exitCodes');
-const { getAccountConfig, getEnv } = require('@hubspot/local-dev-lib/config');
-const { uiFeatureHighlight, uiBetaTag } = require('../../lib/ui');
-const { SANDBOX_TYPE_MAP, getAvailableSyncTypes, SYNC_TYPES, validateSandboxUsageLimits, } = require('../../lib/sandboxes');
-const { getValidEnv } = require('@hubspot/local-dev-lib/environment');
-const { logger } = require('@hubspot/local-dev-lib/logger');
-const { trackCommandUsage } = require('../../lib/usageTracking');
-const { sandboxTypePrompt } = require('../../lib/prompts/sandboxesPrompt');
-const { promptUser } = require('../../lib/prompts/promptUtils');
-const { syncSandbox } = require('../../lib/sandboxSync');
-const { logError } = require('../../lib/errorHandlers/index');
-const { isMissingScopeError } = require('@hubspot/local-dev-lib/errors/index');
-const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
-const { HUBSPOT_ACCOUNT_TYPES, HUBSPOT_ACCOUNT_TYPE_STRINGS, } = require('@hubspot/local-dev-lib/constants/config');
-const { buildSandbox } = require('../../lib/buildAccount');
-const { hubspotAccountNamePrompt, } = require('../../lib/prompts/accountNamePrompt');
+exports.describe = exports.command = void 0;
+exports.handler = handler;
+exports.builder = builder;
+const config_1 = require("@hubspot/local-dev-lib/config");
+const logger_1 = require("@hubspot/local-dev-lib/logger");
+const index_1 = require("@hubspot/local-dev-lib/errors/index");
+const urls_1 = require("@hubspot/local-dev-lib/urls");
+const config_2 = require("@hubspot/local-dev-lib/constants/config");
+const environment_1 = require("@hubspot/local-dev-lib/environment");
+const commonOpts_1 = require("../../lib/commonOpts");
+const lang_1 = require("../../lib/lang");
+const exitCodes_1 = require("../../lib/enums/exitCodes");
+const ui_1 = require("../../lib/ui");
+const sandboxes_1 = require("../../lib/sandboxes");
+const usageTracking_1 = require("../../lib/usageTracking");
+const sandboxesPrompt_1 = require("../../lib/prompts/sandboxesPrompt");
+const promptUtils_1 = require("../../lib/prompts/promptUtils");
+const sandboxSync_1 = require("../../lib/sandboxSync");
+const index_2 = require("../../lib/errorHandlers/index");
+const buildAccount_1 = require("../../lib/buildAccount");
+const accountNamePrompt_1 = require("../../lib/prompts/accountNamePrompt");
 const i18nKey = 'commands.sandbox.subcommands.create';
 exports.command = 'create';
-exports.describe = uiBetaTag(i18n(`${i18nKey}.describe`), false);
-exports.handler = async (options) => {
-    const { name, type, force, derivedAccountId } = options;
-    const accountConfig = getAccountConfig(derivedAccountId);
-    const env = getValidEnv(getEnv(derivedAccountId));
-    trackCommandUsage('sandbox-create', null, derivedAccountId);
+exports.describe = (0, ui_1.uiBetaTag)((0, lang_1.i18n)(`${i18nKey}.describe`), false);
+async function handler(args) {
+    const { name, type, force, derivedAccountId } = args;
+    const accountConfig = (0, config_1.getAccountConfig)(derivedAccountId);
+    const env = (0, environment_1.getValidEnv)((0, config_1.getEnv)(derivedAccountId));
+    (0, usageTracking_1.trackCommandUsage)('sandbox-create', {}, derivedAccountId);
+    // Check if account config exists
+    if (!accountConfig) {
+        logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.failure.noAccountConfig`, {
+            accountId: derivedAccountId,
+            authCommand: (0, ui_1.uiCommandReference)('hs auth'),
+        }));
+        process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
     // Default account is not a production portal
     if (accountConfig.accountType &&
-        accountConfig.accountType !== HUBSPOT_ACCOUNT_TYPES.STANDARD) {
-        logger.error(i18n(`${i18nKey}.failure.invalidAccountType`, {
-            accountType: HUBSPOT_ACCOUNT_TYPE_STRINGS[HUBSPOT_ACCOUNT_TYPES[accountConfig.accountType]],
-            accountName: accountConfig.name,
+        accountConfig.accountType !== config_2.HUBSPOT_ACCOUNT_TYPES.STANDARD) {
+        logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.failure.invalidAccountType`, {
+            accountType: config_2.HUBSPOT_ACCOUNT_TYPE_STRINGS[config_2.HUBSPOT_ACCOUNT_TYPES[accountConfig.accountType]],
+            accountName: accountConfig.name || '',
         }));
-        process.exit(EXIT_CODES.ERROR);
+        process.exit(exitCodes_1.EXIT_CODES.ERROR);
     }
     let typePrompt;
     let namePrompt;
-    if ((type && !SANDBOX_TYPE_MAP[type.toLowerCase()]) || !type) {
+    if ((type && !(type.toLowerCase() in sandboxes_1.SANDBOX_TYPE_MAP)) || !type) {
         if (!force) {
-            typePrompt = await sandboxTypePrompt();
+            typePrompt = await (0, sandboxesPrompt_1.sandboxTypePrompt)();
         }
         else {
-            logger.error(i18n(`${i18nKey}.failure.optionMissing.type`));
-            process.exit(EXIT_CODES.ERROR);
+            logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.failure.optionMissing.type`));
+            process.exit(exitCodes_1.EXIT_CODES.ERROR);
         }
     }
     const sandboxType = type
-        ? SANDBOX_TYPE_MAP[type.toLowerCase()]
+        ? sandboxes_1.SANDBOX_TYPE_MAP[type.toLowerCase()]
         : typePrompt.type;
     // Check usage limits and exit if parent portal has no available sandboxes for the selected type
     try {
-        await validateSandboxUsageLimits(accountConfig, sandboxType, env);
+        await (0, sandboxes_1.validateSandboxUsageLimits)(accountConfig, sandboxType, env);
     }
     catch (err) {
-        if (isMissingScopeError(err)) {
-            logger.error(i18n('lib.sandbox.create.failure.scopes.message', {
+        if ((0, index_1.isMissingScopeError)(err)) {
+            logger_1.logger.error((0, lang_1.i18n)('lib.sandbox.create.failure.scopes.message', {
                 accountName: accountConfig.name || derivedAccountId,
             }));
-            const websiteOrigin = getHubSpotWebsiteOrigin(env);
+            const websiteOrigin = (0, urls_1.getHubSpotWebsiteOrigin)(env);
             const url = `${websiteOrigin}/personal-access-key/${derivedAccountId}`;
-            logger.info(i18n('lib.sandbox.create.failure.scopes.instructions', {
+            logger_1.logger.info((0, lang_1.i18n)('lib.sandbox.create.failure.scopes.instructions', {
                 accountName: accountConfig.name || derivedAccountId,
                 url,
             }));
         }
         else {
-            logError(err);
+            (0, index_2.logError)(err);
         }
-        process.exit(EXIT_CODES.ERROR);
+        process.exit(exitCodes_1.EXIT_CODES.ERROR);
     }
     if (!name) {
         if (!force) {
-            namePrompt = await hubspotAccountNamePrompt({ accountType: sandboxType });
+            namePrompt = await (0, accountNamePrompt_1.hubspotAccountNamePrompt)({ accountType: sandboxType });
         }
         else {
-            logger.error(i18n(`${i18nKey}.failure.optionMissing.name`));
-            process.exit(EXIT_CODES.ERROR);
+            logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.failure.optionMissing.name`));
+            process.exit(exitCodes_1.EXIT_CODES.ERROR);
         }
     }
     const sandboxName = name || namePrompt.name;
     let contactRecordsSyncPromptResult = false;
     if (!force) {
-        const isStandardSandbox = sandboxType === HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX;
+        const isStandardSandbox = sandboxType === config_2.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX;
         // Prompt to sync contact records for standard sandboxes only
         if (isStandardSandbox) {
-            const { contactRecordsSyncPrompt } = await promptUser([
+            const { contactRecordsSyncPrompt } = await (0, promptUtils_1.promptUser)([
                 {
                     name: 'contactRecordsSyncPrompt',
                     type: 'confirm',
-                    message: i18n('lib.sandbox.sync.confirm.syncContactRecords.standard'),
+                    message: (0, lang_1.i18n)('lib.sandbox.sync.confirm.syncContactRecords.standard'),
                 },
             ]);
             contactRecordsSyncPromptResult = contactRecordsSyncPrompt;
         }
     }
     try {
-        const result = await buildSandbox(sandboxName, accountConfig, sandboxType, env, force);
-        const sandboxAccountConfig = getAccountConfig(result.sandbox.sandboxHubId);
+        const result = await (0, buildAccount_1.buildSandbox)(sandboxName, accountConfig, sandboxType, env, force);
+        const sandboxAccountConfig = (0, config_1.getAccountConfig)(result.sandbox.sandboxHubId);
+        // Check if sandbox account config exists
+        if (!sandboxAccountConfig) {
+            logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.failure.noSandboxAccountConfig`, {
+                accountId: result.sandbox.sandboxHubId,
+                authCommand: (0, ui_1.uiCommandReference)('hs auth'),
+            }));
+            process.exit(exitCodes_1.EXIT_CODES.ERROR);
+        }
         // For v1 sandboxes, keep sync here. Once we migrate to v2, this will be handled by BE automatically
-        const handleSyncSandbox = async (syncTasks) => {
-            await syncSandbox(sandboxAccountConfig, accountConfig, env, syncTasks);
-        };
+        async function handleSyncSandbox(syncTasks) {
+            await (0, sandboxSync_1.syncSandbox)(sandboxAccountConfig, accountConfig, env, syncTasks);
+        }
         try {
-            let availableSyncTasks = await getAvailableSyncTypes(accountConfig, sandboxAccountConfig);
+            let availableSyncTasks = await (0, sandboxes_1.getAvailableSyncTypes)(accountConfig, sandboxAccountConfig);
             if (!contactRecordsSyncPromptResult) {
-                availableSyncTasks = availableSyncTasks.filter(t => t.type !== SYNC_TYPES.OBJECT_RECORDS);
+                availableSyncTasks = availableSyncTasks.filter(t => t.type !== sandboxes_1.SYNC_TYPES.OBJECT_RECORDS);
             }
             await handleSyncSandbox(availableSyncTasks);
         }
         catch (err) {
-            logError(err);
+            (0, index_2.logError)(err);
             throw err;
         }
         const highlightItems = ['accountsUseCommand', 'projectCreateCommand'];
-        if (sandboxType === HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX) {
+        if (sandboxType === config_2.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX) {
             highlightItems.push('projectDevCommand');
         }
         else {
             highlightItems.push('projectUploadCommand');
         }
-        uiFeatureHighlight(highlightItems);
-        process.exit(EXIT_CODES.SUCCESS);
+        (0, ui_1.uiFeatureHighlight)(highlightItems);
+        process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
     }
     catch (error) {
         // Errors are logged in util functions
-        process.exit(EXIT_CODES.ERROR);
+        process.exit(exitCodes_1.EXIT_CODES.ERROR);
     }
-};
-exports.builder = yargs => {
+}
+function builder(yargs) {
     yargs.option('force', {
         type: 'boolean',
         alias: 'f',
-        describe: i18n(`${i18nKey}.options.force.describe`),
+        describe: (0, lang_1.i18n)(`${i18nKey}.options.force.describe`),
     });
     yargs.option('name', {
-        describe: i18n(`${i18nKey}.options.name.describe`),
+        describe: (0, lang_1.i18n)(`${i18nKey}.options.name.describe`),
         type: 'string',
     });
     yargs.option('type', {
-        describe: i18n(`${i18nKey}.options.type.describe`),
-        type: 'string',
+        describe: (0, lang_1.i18n)(`${i18nKey}.options.type.describe`),
+        choices: Object.keys(sandboxes_1.SANDBOX_TYPE_MAP),
     });
     yargs.example([
         [
             '$0 sandbox create --name=MySandboxAccount --type=STANDARD',
-            i18n(`${i18nKey}.examples.default`),
+            (0, lang_1.i18n)(`${i18nKey}.examples.default`),
         ],
     ]);
-    addConfigOptions(yargs);
-    addAccountOptions(yargs);
-    addUseEnvironmentOptions(yargs);
-    addTestingOptions(yargs);
+    (0, commonOpts_1.addConfigOptions)(yargs);
+    (0, commonOpts_1.addAccountOptions)(yargs);
+    (0, commonOpts_1.addUseEnvironmentOptions)(yargs);
+    (0, commonOpts_1.addTestingOptions)(yargs);
     return yargs;
-};
+}

package/commands/sandbox/delete.d.ts

@@ -1 +1,12 @@
+import { Argv, ArgumentsCamelCase } from 'yargs';
+import { CommonArgs, ConfigArgs, AccountArgs, EnvironmentArgs, TestingArgs } from '../../types/Yargs';
+export declare const command = "delete";
+export declare const describe: string | undefined;
+type CombinedArgs = ConfigArgs & AccountArgs & EnvironmentArgs & TestingArgs;
+type SandboxDeleteArgs = CommonArgs & CombinedArgs & {
+    account?: string;
+    force?: boolean;
+};
+export declare function handler(args: ArgumentsCamelCase<SandboxDeleteArgs>): Promise<void>;
+export declare function builder(yargs: Argv): Argv<SandboxDeleteArgs>;
 export {};