@hubspot/cli 7.7.16-experimental.5 → 7.7.16-experimental.7

package/commands/getStarted.js

@@ -21,13 +21,18 @@ const errorHandlers_1 = require("../lib/errorHandlers");
 const upload_1 = require("../lib/projects/upload");
 const constants_1 = require("../lib/constants");
 const config_1 = require("../lib/projects/config");
+const dependencyManagement_1 = require("../lib/dependencyManagement");
 const buildAndDeploy_1 = require("../lib/projects/buildAndDeploy");
-const urls_1 = require("../lib/projects/urls");
 const links_1 = require("../lib/links");
+const urls_1 = require("../lib/app/urls");
+const config_2 = require("@hubspot/local-dev-lib/config");
+const environments_1 = require("@hubspot/local-dev-lib/constants/environments");
+const appsDev_1 = require("@hubspot/local-dev-lib/api/appsDev");
 exports.command = 'get-started';
 exports.describe = undefined;
 async function handler(args) {
     const { derivedAccountId } = args;
+    const env = (0, config_2.getEnv)(derivedAccountId) === 'qa' ? environments_1.ENVIRONMENTS.QA : environments_1.ENVIRONMENTS.PROD;
     // TODO: Put this in constants.ts once we have a defined place for the template before INBOUND
     const templateSource = 'robrown-hubspot/hubspot-project-components-ua-app-objects-beta';
     (0, usageTracking_1.trackCommandUsage)('get-started', {}, derivedAccountId);
@@ -73,7 +78,7 @@ async function handler(args) {
     }
     else {
         logger_1.uiLogger.log(' ');
-        logger_1.uiLogger.log(en_1.commands.getStarted.prompts.appSelected);
+        logger_1.uiLogger.log(en_1.commands.getStarted.logs.appSelected);
         // 1. Fetch project templates
         let latestRepoReleaseTag;
         const { dest, name } = await (0, projectNameAndDestPrompt_1.projectNameAndDestPrompt)(args);
@@ -122,7 +127,44 @@ async function handler(args) {
         logger_1.uiLogger.log(' ');
         logger_1.uiLogger.log(en_1.commands.getStarted.prompts.projectCreated.description);
         logger_1.uiLogger.log(' ');
-        // 5. Ask user if they want to upload the project
+        // 5. Install dependencies - Ask user if they want to install dependencies
+        const { shouldInstallDependencies } = await (0, promptUtils_1.promptUser)([
+            {
+                type: 'confirm',
+                name: 'shouldInstallDependencies',
+                message: en_1.commands.getStarted.prompts.installDependencies,
+                default: true,
+            },
+        ]);
+        if (shouldInstallDependencies) {
+            try {
+                // Change to the project directory to install dependencies
+                const originalCwd = process.cwd();
+                process.chdir(projectDest);
+                try {
+                    await (0, dependencyManagement_1.installPackages)({});
+                    logger_1.uiLogger.log(' ');
+                    logger_1.uiLogger.success(en_1.commands.getStarted.logs.dependenciesInstalled);
+                    logger_1.uiLogger.log(' ');
+                }
+                finally {
+                    // Always restore the original working directory
+                    process.chdir(originalCwd);
+                }
+            }
+            catch (err) {
+                logger_1.uiLogger.log(' ');
+                logger_1.uiLogger.error(en_1.commands.getStarted.errors.installDepsFailed);
+                console.log(err);
+                logger_1.uiLogger.log(' ');
+            }
+        }
+        else {
+            logger_1.uiLogger.log(' ');
+            logger_1.uiLogger.log(en_1.commands.getStarted.logs.dependenciesNotInstalled);
+            logger_1.uiLogger.log(' ');
+        }
+        // 6. Ask user if they want to upload the project
         const { shouldUpload } = await (0, promptUtils_1.promptUser)([
             {
                 type: 'confirm',
@@ -162,8 +204,9 @@ async function handler(args) {
                     (0, errorHandlers_1.debugError)(uploadError);
                 }
                 else if (result) {
-                    logger_1.uiLogger.log(' ');
                     logger_1.uiLogger.success(en_1.commands.getStarted.logs.uploadSuccess);
+                    const { data: { results }, } = await (0, appsDev_1.fetchPublicAppsForPortal)(derivedAccountId);
+                    const lastCreatedApp = results.sort((a, b) => b.createdAt - a.createdAt)[0];
                     if (process.env.BROWSER !== 'none') {
                         logger_1.uiLogger.log(' ');
                         logger_1.uiLogger.log(en_1.commands.getStarted.developerOverviewBrowserOpenPrep);
@@ -172,11 +215,15 @@ async function handler(args) {
                             {
                                 name: 'shouldOpenOverview',
                                 type: 'confirm',
-                                message: en_1.commands.getStarted.openDeveloperOverviewPrompt,
+                                message: en_1.commands.getStarted.openInstallUrl,
                             },
                         ]);
                         if (shouldOpenOverview) {
-                            (0, open_1.default)((0, urls_1.getProjectComponentDistributionUrl)(name, 'get_started_app', derivedAccountId), { url: true });
+                            (0, open_1.default)((0, urls_1.getStaticAuthAppInstallUrl)({
+                                targetAccountId: derivedAccountId,
+                                env: env,
+                                appId: lastCreatedApp.id,
+                            }), { url: true });
                             logger_1.uiLogger.log(' ');
                             logger_1.uiLogger.success(en_1.commands.getStarted.openedDeveloperOverview);
                         }

package/commands/project/dev/unifiedFlow.js

@@ -58,6 +58,7 @@ async function unifiedProjectDevFlow({ args, targetProjectAccountId, providedTar
     }
     const accounts = (0, config_2.getConfigAccounts)();
     const accountIsCombined = await (0, accountTypes_1.isUnifiedAccount)(targetProjectAccountConfig);
+    const targetProjectAccountIsTestAccountOrSandbox = (0, accountTypes_1.isTestAccountOrSandbox)(targetProjectAccountConfig);
     if (!accountIsCombined && !profileConfig) {
         logger_1.uiLogger.error(en_1.commands.project.dev.errors.accountNotCombined);
         process.exit(exitCodes_1.EXIT_CODES.ERROR);
@@ -67,6 +68,12 @@ async function unifiedProjectDevFlow({ args, targetProjectAccountId, providedTar
         // Bypass the prompt for the testing account if the user has a profile configured
         targetTestingAccountId = profileConfig.accountId;
     }
+    else if (
+    // Bypass the prompt for the testing account if default account is already a test account
+    !targetTestingAccountId &&
+        targetProjectAccountIsTestAccountOrSandbox) {
+        targetTestingAccountId = targetProjectAccountId;
+    }
     else if (!targetTestingAccountId) {
         logger_1.uiLogger.log('');
         (0, ui_1.uiLine)();

package/commands/testAccount/create.js

@@ -77,11 +77,13 @@ async function handler(args) {
         if (formatOutputAsJson) {
             jsonOutput.accountName = data.accountName;
             jsonOutput.accountId = data.id;
-            jsonOutput.personalAccessKey = data.personalAccessKey;
         }
         testAccountId = data.id;
     }
     catch (err) {
+        SpinniesManager_1.default.fail('createTestAccount', {
+            text: en_1.commands.testAccount.create.polling.createFailure,
+        });
         (0, errorHandlers_1.logError)(err);
         process.exit(exitCodes_1.EXIT_CODES.ERROR);
     }
@@ -92,21 +94,35 @@ async function handler(args) {
         await (0, polling_1.poll)(() => (0, developerTestAccounts_1.fetchDeveloperTestAccountGateSyncStatus)(derivedAccountId, testAccountId), {
             successStates: ['SUCCESS'],
             errorStates: [],
-        }, 5000 // 5 seconds
-        );
-        // HACK: The status endpoint sometimes returns an early success status.
-        // Sleep for an extra 5 seconds to make sure the status is actually success.
-        await new Promise(resolve => setTimeout(resolve, 5000));
-        SpinniesManager_1.default.succeed('createTestAccount', {
-            text: en_1.commands.testAccount.create.polling.success(testAccountConfig.accountName, testAccountId),
         });
     }
     catch (err) {
         (0, errorHandlers_1.debugError)(err);
         SpinniesManager_1.default.fail('createTestAccount', {
-            text: en_1.commands.testAccount.create.polling.failure,
+            text: en_1.commands.testAccount.create.polling.syncFailure,
         });
+        process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
+    // HACK: The status endpoint sometimes returns an early success status.
+    // Sleep for an extra 5 seconds to make sure the sync is actually complete.
+    await new Promise(resolve => setTimeout(resolve, 5000));
+    try {
+        // Attempt to generate a new personal access key for the test account now that gate sync is complete.
+        const { data } = await (0, developerTestAccounts_1.generateDeveloperTestAccountPersonalAccessKey)(derivedAccountId, testAccountId);
+        if (data.personalAccessKey && data.personalAccessKey) {
+            jsonOutput.personalAccessKey = data.personalAccessKey;
+        }
     }
+    catch (err) {
+        (0, errorHandlers_1.debugError)(err);
+        SpinniesManager_1.default.fail('createTestAccount', {
+            text: en_1.commands.testAccount.create.polling.pakFailure,
+        });
+        process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
+    SpinniesManager_1.default.succeed('createTestAccount', {
+        text: en_1.commands.testAccount.create.polling.success(testAccountConfig.accountName, testAccountId),
+    });
     if (formatOutputAsJson) {
         logger_1.uiLogger.json(jsonOutput);
     }

package/lang/en.d.ts

@@ -28,7 +28,7 @@ export declare const commands: {
         readonly openDesignManagerPrompt: "Open Design Manager in your browser?";
         readonly openedDesignManager: "Redirected to Design Manager!";
         readonly developerOverviewBrowserOpenPrep: "We'll take you to your HubSpot account and walk you through installing and previewing your new app.";
-        readonly openDeveloperOverviewPrompt: "Open HubSpot to go to your account?";
+        readonly openInstallUrl: "Open HubSpot to install your app in your account?";
         readonly openedDeveloperOverview: "HubSpot opened!";
         readonly prompts: {
             readonly selectOption: "Are you looking to build apps or CMS?";
@@ -36,17 +36,20 @@ export declare const commands: {
                 readonly app: "App";
                 readonly cms: "CMS";
             };
+            readonly installDependencies: "Would you like to install dependencies now?";
             readonly uploadProject: "Would you like to upload your project to HubSpot now?";
-            readonly appSelected: `We'll create a new project with a sample app for you.
-Projects are what you can use to create apps, themes, and more at HubSpot.
-Usually you'll use the ${string} command, but we'll go ahead and make one now.`;
             readonly projectCreated: {
                 readonly title: string;
-                readonly description: `Upload your project to HubSpot - typically, you'll use the command ${string} for this.
-We'll start the process now.`;
+                readonly description: `Let's prepare and upload your project to HubSpot.
+You can use ${string} to ${string} and ${string} to ${string} your project.`;
             };
         };
         readonly logs: {
+            readonly appSelected: `We'll create a new project with a sample app for you.
+Projects are what you can use to create apps, themes, and more at HubSpot.
+Usually you'll use the ${string} command, but we'll go ahead and make one now.`;
+            readonly dependenciesInstalled: "Dependencies installed successfully.";
+            readonly dependenciesNotInstalled: `Dependencies not installed. Remember to do this later with the command ${string} from the project directory.`;
             readonly uploadingProject: "Uploading your project to HubSpot...";
             readonly uploadSuccess: "Project uploaded successfully!";
             readonly developerOverviewLink: "Open this link to navigate to your HubSpot developer portal";
@@ -54,6 +57,7 @@ We'll start the process now.`;
         readonly errors: {
             readonly uploadFailed: "Failed to upload project to HubSpot.";
             readonly configFileNotFound: "Could not find project configuration for upload.";
+            readonly installDepsFailed: "Failed to install dependencies.";
         };
     };
     readonly completion: {
@@ -1499,10 +1503,10 @@ ${string}`;
         readonly describe: "Commands for managing apps.";
         readonly subcommands: {
             readonly install: {
-                readonly describe: "Install an app.";
+                readonly describe: "Install an OAuth app into a test account.";
                 readonly options: {
                     readonly appUid: "The uid of the app to install";
-                    readonly projectName: "The name of the project to install the app to";
+                    readonly projectName: "The name of the project that contains the app";
                 };
                 readonly positionals: {
                     readonly testAccountId: "The id of the test account to install the app into";
@@ -1829,7 +1833,9 @@ ${string}`;
                 readonly start: (testAccountName: string) => string;
                 readonly syncing: "Test account created! Syncing account data... (may take a few minutes - you can exit and the sync will continue)";
                 readonly success: (testAccountName: string, testAccountId: number) => string;
-                readonly failure: "Failed to sync data into test account. The account may not be ready to use.";
+                readonly createFailure: "Failed to create test account.";
+                readonly syncFailure: "Failed to sync data into test account. The account may not be ready to use.";
+                readonly pakFailure: "Failed to generate a personal access key for the test account.";
             };
             readonly options: {
                 readonly configPath: "The path to the test account config";

package/lang/en.js

@@ -42,7 +42,7 @@ exports.commands = {
         openDesignManagerPrompt: 'Open Design Manager in your browser?',
         openedDesignManager: 'Redirected to Design Manager!',
         developerOverviewBrowserOpenPrep: "We'll take you to your HubSpot account and walk you through installing and previewing your new app.",
-        openDeveloperOverviewPrompt: 'Open HubSpot to go to your account?',
+        openInstallUrl: 'Open HubSpot to install your app in your account?',
         openedDeveloperOverview: 'HubSpot opened!',
         prompts: {
             selectOption: 'Are you looking to build apps or CMS?',
@@ -50,14 +50,17 @@ exports.commands = {
                 app: 'App',
                 cms: 'CMS',
             },
+            installDependencies: 'Would you like to install dependencies now?',
             uploadProject: 'Would you like to upload your project to HubSpot now?',
-            appSelected: `We'll create a new project with a sample app for you.\nProjects are what you can use to create apps, themes, and more at HubSpot.\nUsually you'll use the ${(0, ui_1.uiCommandReference)('hs project create')} command, but we'll go ahead and make one now.`,
             projectCreated: {
                 title: chalk_1.default.bold('Next steps:'),
-                description: `Upload your project to HubSpot - typically, you'll use the command ${(0, ui_1.uiCommandReference)('hs project upload')} for this.\nWe'll start the process now.`,
+                description: `Let's prepare and upload your project to HubSpot.\nYou can use ${(0, ui_1.uiCommandReference)('hs project install-deps')} to ${chalk_1.default.bold('install dependencies')} and ${(0, ui_1.uiCommandReference)('hs project upload')} to ${chalk_1.default.bold('upload')} your project.`,
             },
         },
         logs: {
+            appSelected: `We'll create a new project with a sample app for you.\nProjects are what you can use to create apps, themes, and more at HubSpot.\nUsually you'll use the ${(0, ui_1.uiCommandReference)('hs project create')} command, but we'll go ahead and make one now.`,
+            dependenciesInstalled: 'Dependencies installed successfully.',
+            dependenciesNotInstalled: `Dependencies not installed. Remember to do this later with the command ${(0, ui_1.uiCommandReference)('hs project install-deps')} from the project directory.`,
             uploadingProject: 'Uploading your project to HubSpot...',
             uploadSuccess: 'Project uploaded successfully!',
             developerOverviewLink: 'Open this link to navigate to your HubSpot developer portal',
@@ -65,6 +68,7 @@ exports.commands = {
         errors: {
             uploadFailed: 'Failed to upload project to HubSpot.',
             configFileNotFound: 'Could not find project configuration for upload.',
+            installDepsFailed: 'Failed to install dependencies.',
         },
     },
     completion: {
@@ -1497,10 +1501,10 @@ exports.commands = {
         describe: 'Commands for managing apps.',
         subcommands: {
             install: {
-                describe: 'Install an app.',
+                describe: 'Install an OAuth app into a test account.',
                 options: {
                     appUid: 'The uid of the app to install',
-                    projectName: 'The name of the project to install the app to',
+                    projectName: 'The name of the project that contains the app',
                 },
                 positionals: {
                     testAccountId: 'The id of the test account to install the app into',
@@ -1827,7 +1831,9 @@ exports.commands = {
                 start: (testAccountName) => `Creating test account "${chalk_1.default.bold(testAccountName)}"...`,
                 syncing: 'Test account created! Syncing account data... (may take a few minutes - you can exit and the sync will continue)',
                 success: (testAccountName, testAccountId) => `Test account "${chalk_1.default.bold(testAccountName)}" successfully created with id: ${chalk_1.default.bold(testAccountId)}`,
-                failure: 'Failed to sync data into test account. The account may not be ready to use.',
+                createFailure: 'Failed to create test account.',
+                syncFailure: 'Failed to sync data into test account. The account may not be ready to use.',
+                pakFailure: 'Failed to generate a personal access key for the test account.',
             },
             options: {
                 configPath: 'The path to the test account config',

package/lib/accountTypes.d.ts

@@ -5,4 +5,5 @@ export declare function isStandardSandbox(accountConfig: CLIAccount): boolean;
 export declare function isDevelopmentSandbox(accountConfig: CLIAccount): boolean;
 export declare function isDeveloperTestAccount(accountConfig: CLIAccount): boolean;
 export declare function isAppDeveloperAccount(accountConfig: CLIAccount): boolean;
+export declare function isTestAccountOrSandbox(accountConfig: CLIAccount): boolean;
 export declare function isUnifiedAccount(account: CLIAccount): Promise<boolean>;

package/lib/accountTypes.js

@@ -6,33 +6,44 @@ exports.isStandardSandbox = isStandardSandbox;
 exports.isDevelopmentSandbox = isDevelopmentSandbox;
 exports.isDeveloperTestAccount = isDeveloperTestAccount;
 exports.isAppDeveloperAccount = isAppDeveloperAccount;
+exports.isTestAccountOrSandbox = isTestAccountOrSandbox;
 exports.isUnifiedAccount = isUnifiedAccount;
 const config_1 = require("@hubspot/local-dev-lib/constants/config");
 const hasFeature_1 = require("./hasFeature");
 const constants_1 = require("./constants");
 const getAccountIdentifier_1 = require("@hubspot/local-dev-lib/config/getAccountIdentifier");
 function isAccountType(accountConfig, accountType) {
-    return (Boolean(accountConfig.accountType) &&
-        accountConfig.accountType === accountType);
+    return Boolean(accountConfig.accountType && accountType.includes(accountConfig.accountType));
 }
 function isStandardAccount(accountConfig) {
-    return isAccountType(accountConfig, config_1.HUBSPOT_ACCOUNT_TYPES.STANDARD);
+    return isAccountType(accountConfig, [config_1.HUBSPOT_ACCOUNT_TYPES.STANDARD]);
 }
 function isSandbox(accountConfig) {
-    return (isAccountType(accountConfig, config_1.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX) ||
-        isAccountType(accountConfig, config_1.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX));
+    return isAccountType(accountConfig, [
+        config_1.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX,
+        config_1.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX,
+    ]);
 }
 function isStandardSandbox(accountConfig) {
-    return isAccountType(accountConfig, config_1.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX);
+    return isAccountType(accountConfig, [config_1.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX]);
 }
 function isDevelopmentSandbox(accountConfig) {
-    return isAccountType(accountConfig, config_1.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX);
+    return isAccountType(accountConfig, [
+        config_1.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX,
+    ]);
 }
 function isDeveloperTestAccount(accountConfig) {
-    return isAccountType(accountConfig, config_1.HUBSPOT_ACCOUNT_TYPES.DEVELOPER_TEST);
+    return isAccountType(accountConfig, [config_1.HUBSPOT_ACCOUNT_TYPES.DEVELOPER_TEST]);
 }
 function isAppDeveloperAccount(accountConfig) {
-    return isAccountType(accountConfig, config_1.HUBSPOT_ACCOUNT_TYPES.APP_DEVELOPER);
+    return isAccountType(accountConfig, [config_1.HUBSPOT_ACCOUNT_TYPES.APP_DEVELOPER]);
+}
+function isTestAccountOrSandbox(accountConfig) {
+    return isAccountType(accountConfig, [
+        config_1.HUBSPOT_ACCOUNT_TYPES.DEVELOPER_TEST,
+        config_1.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX,
+        config_1.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX,
+    ]);
 }
 async function isUnifiedAccount(account) {
     const accountId = (0, getAccountIdentifier_1.getAccountIdentifier)(account);

package/lib/app/urls.d.ts

@@ -2,7 +2,7 @@ import { Environment } from '@hubspot/local-dev-lib/types/Config';
 type PrivateAppInstallUrlArgs = {
     targetAccountId: number;
     env: Environment;
-    appId: string;
+    appId: number;
 };
 type PublicAppInstallUrlArgs = {
     targetAccountId: number;

package/lib/projects/localDev/AppDevModeInterface.js

@@ -84,7 +84,7 @@ class AppDevModeInterface {
         return (0, urls_1.getStaticAuthAppInstallUrl)({
             targetAccountId: this.localDevState.targetTestingAccountId,
             env: this.localDevState.env,
-            appId: `${app.id}`,
+            appId: app.id,
         });
     }
     async fetchAppData() {

package/package.json

@@ -1,12 +1,12 @@
 {
     "name": "@hubspot/cli",
-    "version": "7.7.16-experimental.5",
+    "version": "7.7.16-experimental.7",
     "description": "The official CLI for developing on HubSpot",
     "license": "Apache-2.0",
     "repository": "https://github.com/HubSpot/hubspot-cli",
     "dependencies": {
-        "@hubspot/local-dev-lib": "3.11.0",
-        "@hubspot/project-parsing-lib": "0.5.0",
+        "@hubspot/local-dev-lib": "3.13.0",
+        "@hubspot/project-parsing-lib": "0.5.1",
         "@hubspot/serverless-dev-runtime": "7.0.6",
         "@hubspot/theme-preview-dev-server": "0.0.10",
         "@hubspot/ui-extensions-dev-server": "0.9.2",