@hubspot/cli 5.2.0 → 5.2.1-beta.1

package/lang/en.lyaml

@@ -475,21 +475,10 @@ en:
             describe: "Start local dev for the current project"
             logs:
               betaMessage: "HubSpot projects local development"
-              nonSandboxWarning: "Testing in a sandbox is strongly recommended. To switch the target account, select an option below or run {{#bold}}`hs accounts use`{{/bold}} before running the command again."
               placeholderAccountSelection: "Using default account as target account (for now)"
-              projectMustExistExplanation: "The project {{ projectName }} does not exist in the target account {{ accountIdentifier}}. This command requires the project to exist in the target account."
-              choseNotToCreateProject: "Exiting because this command requires the project to exist in the target account."
-              initialUploadMessage: "HubSpot Local Dev Server Startup"
-              declineDefaultAccountExplanation: "To develop on a different account, run {{ useCommand }} to change your default account, then re-run {{ devCommand }}."
-            status:
-              creatingProject: "Creating project {{ projectName }} in {{ accountIdentifier }}"
-              createdProject: "Created project {{ projectName }} in {{ accountIdentifier }}"
-              failedToCreateProject: "Failed to create project in the target account."
-            prompt:
-              createProject: "Create new project {{ projectName}} in {{#bold}}[{{ accountIdentifier }}]{{/bold}}?"
             errors:
               noProjectConfig: "No project detected. Please run this command again from a project directory."
-              projectLockedError: "Your project is locked. This may mean that another user is running the {{#bold}}`hs project watch`{{/bold}} command for this project. If this is you, unlock the project in Projects UI."
+              invalidProjectComponents: "Projects cannot contain both private and public apps. Move your apps to separate projects before attempting local development."
             examples:
               default: "Start local dev for the current project"
           create:
@@ -952,6 +941,25 @@ en:
           setupError: "Failed to setup local dev server: {{ message }}"
           startError: "Failed to start local dev server: {{ message }}"
           fileChangeError: "Failed to notify local dev server of file change: {{ message }}"
+      localDev:
+        confirmDefaultAccountIsTarget:
+          declineDefaultAccountExplanation: "To develop on a different account, run {{ useCommand }} to change your default account, then re-run {{ devCommand }}."
+        checkCorrectParentAccountType:
+          standardAccountNotSupported: "This project contains a public app. Local development of public apps is only supported on developer accounts and developer test accounts. Change your default account using {{#bold}}`hs accounts use`{{/bold}}, or link a new account with {{#bold}}`hs auth`{{/bold}}."
+        suggestRecommendedNestedAccount:
+          nonSandboxWarning: "Testing in a sandbox is strongly recommended. To switch the target account, select an option below or run {{#bold}}`hs accounts use`{{/bold}} before running the command again."
+          publicAppNonDeveloperTestAccountWarning: "Local development of public apps is only supported in {{#bold}}developer test accounts{{/bold}}."
+          privateAppNonDeveloperTestAccountWarning: "Local development of private apps is only supported in {{#bold}}developer test accounts{{/bold}}"
+        createNewProjectForLocalDev:
+          projectMustExistExplanation: "The project {{ projectName }} does not exist in the target account {{ accountIdentifier}}. This command requires the project to exist in the target account."
+          createProject: "Create new project {{ projectName}} in {{#bold}}[{{ accountIdentifier }}]{{/bold}}?"
+          choseNotToCreateProject: "Exiting because this command requires the project to exist in the target account."
+          creatingProject: "Creating project {{ projectName }} in {{ accountIdentifier }}"
+          createdProject: "Created project {{ projectName }} in {{ accountIdentifier }}"
+          failedToCreateProject: "Failed to create project in the target account."
+        createInitialBuildForNewProject:
+          initialUploadMessage: "HubSpot Local Dev Server Startup"
+          projectLockedError: "Your project is locked. This may mean that another user is running the {{#bold}}`hs project watch`{{/bold}} command for this project. If this is you, unlock the project in Projects UI."
       projects:
         config:
           srcOutsideProjectDir: "Invalid value for 'srcDir' in {{ projectConfig }}: {{#bold}}srcDir: \"{{ srcDir }}\"{{/bold}}\n\t'srcDir' must be a relative path to a folder under the project root, such as \".\" or \"./src\""
@@ -1065,10 +1073,12 @@ en:
       prompts:
         projectDevTargetAccountPrompt:
           createNewSandboxOption: "<Test on a new development sandbox>"
+          createNewDeveloperTestAccountOption: "<Test on a new developer test account>"
           chooseDefaultAccountOption: "<{{#bold}}\U00002757{{/bold}} Test on this production account {{#bold}}\U00002757{{/bold}}>"
-          promptMessage: "[--account] Choose a sandbox under {{ accountIdentifier }} to test with:"
+          promptMessage: "[--account] Choose a {{ accountType }} under {{ accountIdentifier }} to test with:"
           sandboxLimit: "Your account reached the limit of {{ limit }} development sandboxes"
           sandboxLimitWithSuggestion: "Your account reached the limit of {{ limit }} development sandboxes. Run {{ authCommand }} to add an existing one to the config."
+          developerTestAccountLimit: "Your account reached the limit of {{ limit }} developer test accounts."
           confirmDefaultAccount: "Continue testing on {{#bold}}{{ accountName }} ({{ accountType }}){{/bold}}? (Y/n)"
         projectLogsPrompt:
           projectName:
@@ -1150,6 +1160,13 @@ en:
             invalidTemplate: "[--template] Could not find template {{ template }}. Please choose an available template."
             noProjectsInConfig: "Please ensure that there is a config.json file that contains a \"projects\" field."
             missingPropertiesInConfig: "Please ensure that each of the projects in your config.json file contain the following properties: [\"name\", \"label\", \"path\", \"insertPath\"]."
+        developerTestAccountPrompt:
+          name:
+            message: "Name your developer test account"
+            errors:
+              invalidName: "You entered an invalid name. Please try again."
+              nameRequired: "The name may not be blank. Please try again."
+              accountNameExists: "Account with name \"{{ name }}\" already exists in the CLI config, please enter a different name."
         downloadProjectPrompt:
           selectProject: "Select a project to download:"
           errors:
@@ -1217,6 +1234,25 @@ en:
         options:
           options:
             describe: "Options to pass to javascript fields files"
+      developerTestAccount:
+        create:
+          loading:
+            add: "Creating developer test account {{#bold}}{{ accountName }}{{/bold}}"
+            fail: "Failed to create a developer test account {{#bold}}{{ accountName }}{{/bold}}."
+            succeed: "Successfully created a developer test account {{#bold}}{{ name }}{{/bold}} with portalId {{#bold}}{{ accountId }}{{/bold}}."
+          success:
+            configFileUpdated: "{{ configFilename }} updated with {{ authMethod }} for account {{ account }}."
+          failure:
+            invalidUser: "Couldn't create {{#bold}}{{ accountName }}{{/bold}} because your account has been removed from {{#bold}}{{ parentAccountName }}{{/bold}} or your permission set doesn't allow you to create the sandbox. To update your permissions, contact a super admin in {{#bold}}{{ parentAccountName }}{{/bold}}."
+            limit: "{{#bold}}{{ accountName }}{{/bold}} reached the limit of {{ limit }} developer test accounts.
+              \n- To connect a developer test account to your HubSpot CLI, run {{#bold}}hs auth{{/bold}} and follow the prompts."
+            alreadyInConfig: "{{#bold}}{{ accountName }}{{/bold}} reached the limit of {{ limit }} developer test accounts.
+              \n- To use an existing developer test account, run {{#bold}}hs accounts use{{/bold}}."
+            scopes:
+              message: "The personal access key you provided doesn't include developer test account permissions."
+              instructions: "To update CLI permissions for \"{{ accountName }}\":
+                \n- Go to {{ url }}, deactivate the existing personal access key, and create a new one that includes developer test account permissions.
+                \n- Update the CLI config for this account by running {{#bold}}hs auth{{/bold}} and entering the new key.\n"
       sandbox:
         create:
           loading:
@@ -1232,7 +1268,7 @@ en:
             configFileUpdated: "{{ configFilename }} updated with {{ authMethod }} for account {{ account }}."
           failure:
             invalidUser: "Couldn't create {{#bold}}{{ accountName }}{{/bold}} because your account has been removed from {{#bold}}{{ parentAccountName }}{{/bold}} or your permission set doesn't allow you to create the sandbox. To update your permissions, contact a super admin in {{#bold}}{{ parentAccountName }}{{/bold}}."
-            403Gating: "Couldn't create {{#bold}}{{ accountName }}{{/bold}} because {{#bold}}{{ parentAccountName }}{{/bold}} does not have access to development sandboxes. To opt in to the CRM Development Beta and use development sandboxes, visit https://app.hubspot.com/l/whats-new/betas?productUpdateId=13860216."
+            403Gating: "Couldn't create {{#bold}}{{ accountName }}{{/bold}} because {{#bold}}{{ parentAccountName }}{{/bold}} does not have access to development sandboxes. To opt in to the CRM Development Beta and use development sandboxes, visit https://app.hubspot.com/l/product-updates/in-beta?update=13899236."
             limit:
               developer:
                 one: "{{#bold}}{{ accountName }}{{/bold}} reached the limit of {{ limit }} development sandbox.
@@ -1336,7 +1372,7 @@ en:
             400: "The {{ messageDetail }} was bad."
             401: "The {{ messageDetail }} was unauthorized."
             403MissingScope: "Couldn't run the project command because there are scopes missing in your production account. To update scopes, deactivate your current personal access key for {{ accountId }}, and generate a new one. Then run `hs auth` to update the CLI with the new key."
-            403Gating: "The current target account {{ accountId }} does not have access to HubSpot projects. To opt in to the CRM Development Beta and use projects, visit https://app.hubspot.com/l/whats-new/betas?productUpdateId=13860216."
+            403Gating: "The current target account {{ accountId }} does not have access to HubSpot projects. To opt in to the CRM Development Beta and use projects, visit https://app.hubspot.com/l/product-updates/in-beta?update=13899236."
             403: "The {{ messageDetail }} was forbidden."
             404Request: 'The {{ action }} failed because "{{ request }}" was not found in account {{ accountId }}.'
             404: "The {{ messageDetail }} was not found."

package/lib/LocalDevManager.js

@@ -16,7 +16,6 @@ const { getProjectDetailUrl } = require('./projects');
 const {
   CONFIG_FILES,
   COMPONENT_TYPES,
-  findProjectComponents,
   getAppCardConfigs,
 } = require('./projectStructure');
 const {
@@ -47,6 +46,7 @@ class LocalDevManager {
     this.isGithubLinked = options.isGithubLinked;
     this.watcher = null;
     this.uploadWarnings = {};
+    this.runnableComponents = this.getRunnableComponents(options.components);
 
     this.projectSourceDir = path.join(
       this.projectDir,
@@ -57,6 +57,27 @@ class LocalDevManager {
       logger.log(i18n(`${i18nKey}.failedToInitialize`));
       process.exit(EXIT_CODES.ERROR);
     }
+
+    // The project is empty, there is nothing to run locally
+    if (!options.components.length) {
+      logger.error(i18n(`${i18nKey}.noComponents`));
+      process.exit(EXIT_CODES.SUCCESS);
+    }
+
+    // The project does not contain any components that support local development
+    if (!this.runnableComponents.length) {
+      logger.error(
+        i18n(`${i18nKey}.noRunnableComponents`, {
+          projectSourceDir: this.projectSourceDir,
+          command: uiCommandReference('hs project add'),
+        })
+      );
+      process.exit(EXIT_CODES.SUCCESS);
+    }
+  }
+
+  getRunnableComponents(components) {
+    return components.filter(component => component.runnable);
   }
 
   async start() {
@@ -75,30 +96,7 @@ class LocalDevManager {
       process.exit(EXIT_CODES.SUCCESS);
     }
 
-    const components = await findProjectComponents(this.projectSourceDir);
-
-    // The project is empty, there is nothing to run locally
-    if (!components.length) {
-      logger.error(i18n(`${i18nKey}.noComponents`));
-      process.exit(EXIT_CODES.SUCCESS);
-    }
-
-    const runnableComponents = components.filter(
-      component => component.runnable
-    );
-
-    // The project does not contain any components that support local development
-    if (!runnableComponents.length) {
-      logger.error(
-        i18n(`${i18nKey}.noRunnableComponents`, {
-          projectSourceDir: this.projectSourceDir,
-          command: uiCommandReference('hs project add'),
-        })
-      );
-      process.exit(EXIT_CODES.SUCCESS);
-    }
-
-    const setupSucceeded = await this.devServerSetup(runnableComponents);
+    const setupSucceeded = await this.devServerSetup();
 
     if (!setupSucceeded) {
       process.exit(EXIT_CODES.ERROR);
@@ -130,7 +128,7 @@ class LocalDevManager {
     await this.devServerStart();
 
     // Initialize project file watcher to detect configuration file changes
-    this.startWatching(runnableComponents);
+    this.startWatching();
 
     this.updateKeypressListeners();
 
@@ -138,7 +136,7 @@ class LocalDevManager {
 
     // Verify that there are no mismatches between components in the local project
     // and components in the deployed build of the project.
-    this.compareLocalProjectToDeployed(runnableComponents);
+    this.compareLocalProjectToDeployed();
   }
 
   async stop(showProgress = true) {
@@ -235,14 +233,14 @@ class LocalDevManager {
     }.bind(this);
   }
 
-  compareLocalProjectToDeployed(runnableComponents) {
+  compareLocalProjectToDeployed() {
     const deployedComponentNames = this.deployedBuild.subbuildStatuses.map(
       subbuildStatus => subbuildStatus.buildName
     );
 
     let missingComponents = [];
 
-    runnableComponents.forEach(({ type, config, path }) => {
+    this.runnableComponents.forEach(({ type, config, path }) => {
       if (Object.values(COMPONENT_TYPES).includes(type)) {
         const cardConfigs = getAppCardConfigs(config, path);
 
@@ -277,12 +275,12 @@ class LocalDevManager {
     }
   }
 
-  startWatching(runnableComponents) {
+  startWatching() {
     this.watcher = chokidar.watch(this.projectDir, {
       ignoreInitial: true,
     });
 
-    const configPaths = runnableComponents
+    const configPaths = this.runnableComponents
       .filter(({ type }) => Object.values(COMPONENT_TYPES).includes(type))
       .map(component => {
         const appConfigPath = path.join(
@@ -321,10 +319,10 @@ class LocalDevManager {
     }
   }
 
-  async devServerSetup(components) {
+  async devServerSetup() {
     try {
       await DevServerManager.setup({
-        components,
+        components: this.runnableComponents,
         onUploadRequired: this.logUploadWarning.bind(this),
         accountId: this.targetAccountId,
       });

package/lib/accountTypes.js

@@ -0,0 +1,34 @@
+const {
+  HUBSPOT_ACCOUNT_TYPES,
+} = require('@hubspot/local-dev-lib/constants/config');
+
+const isAccountType = (config, accountType) =>
+  config.accountType && config.accountType === accountType;
+
+const isStandardAccount = config =>
+  isAccountType(config, HUBSPOT_ACCOUNT_TYPES.STANDARD);
+
+const isSandbox = config =>
+  isAccountType(config, HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX) ||
+  isAccountType(config, HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX);
+
+const isStandardSandbox = config =>
+  isAccountType(config, HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX);
+
+const isDevelopmentSandbox = config =>
+  isAccountType(config, HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX);
+
+const isDeveloperTestAccount = config =>
+  isAccountType(config, HUBSPOT_ACCOUNT_TYPES.DEVELOPER_TEST);
+
+const isAppDeveloperAccount = config =>
+  isAccountType(config, HUBSPOT_ACCOUNT_TYPES.APP_DEVELOPER);
+
+module.exports = {
+  isStandardAccount,
+  isSandbox,
+  isStandardSandbox,
+  isDevelopmentSandbox,
+  isDeveloperTestAccount,
+  isAppDeveloperAccount,
+};

package/lib/developerTestAccountCreate.js

@@ -0,0 +1,186 @@
+const SpinniesManager = require('./ui/SpinniesManager');
+const {
+  getAccountId,
+  accountNameExistsInConfig,
+  updateAccountConfig,
+  writeConfig,
+} = require('@hubspot/local-dev-lib/config');
+const { logger } = require('@hubspot/local-dev-lib/logger');
+const {
+  createDeveloperTestAccount,
+} = require('@hubspot/local-dev-lib/developerTestAccounts');
+const { i18n } = require('./lang');
+const {
+  debugErrorAndContext,
+  logErrorInstance,
+} = require('./errorHandlers/standardErrors');
+const {
+  isMissingScopeError,
+  isSpecifiedError,
+} = require('@hubspot/local-dev-lib/errors/apiErrors');
+const {
+  getAccessToken,
+  updateConfigWithAccessToken,
+} = require('@hubspot/local-dev-lib/personalAccessKey');
+const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
+const { uiAccountDescription } = require('./ui');
+const {
+  personalAccessKeyPrompt,
+} = require('./prompts/personalAccessKeyPrompt');
+const { enterAccountNamePrompt } = require('./prompts/enterAccountNamePrompt');
+
+const i18nKey = 'cli.lib.developerTestAccount';
+
+const saveDevTestAccountToConfig = async (env, result, force = false) => {
+  let personalAccessKey = result.personalAccessKey;
+  if (!personalAccessKey) {
+    const configData = await personalAccessKeyPrompt({
+      env,
+      account: result.id,
+    });
+    personalAccessKey = configData.personalAccessKey;
+  }
+
+  const token = await getAccessToken(personalAccessKey, env);
+  const updatedConfig = await updateConfigWithAccessToken(
+    token,
+    personalAccessKey,
+    env
+  );
+
+  let validName = updatedConfig.name;
+  if (!updatedConfig.name) {
+    const nameForConfig = result.accountName
+      .toLowerCase()
+      .split(' ')
+      .join('-');
+    validName = nameForConfig;
+    const invalidAccountName = accountNameExistsInConfig(nameForConfig);
+    if (invalidAccountName) {
+      if (!force) {
+        logger.log('');
+        logger.warn(
+          i18n(
+            `cli.lib.prompts.enterAccountNamePrompt.errors.accountNameExists`,
+            { name: nameForConfig }
+          )
+        );
+        const { name: promptName } = await enterAccountNamePrompt(
+          nameForConfig + `_${result.id}`
+        );
+        validName = promptName;
+      } else {
+        // Basic invalid name handling when force flag is passed
+        validName = nameForConfig + `_${result.id}`;
+      }
+    }
+  }
+
+  updateAccountConfig({
+    ...updatedConfig,
+    environment: updatedConfig.env,
+    tokenInfo: updatedConfig.auth.tokenInfo,
+    name: validName,
+  });
+  writeConfig();
+
+  logger.log('');
+  return validName;
+};
+
+const buildDeveloperTestAccount = async ({
+  name,
+  accountConfig,
+  env,
+  maxTestPortals,
+  force = false,
+}) => {
+  SpinniesManager.init({
+    succeedColor: 'white',
+  });
+  const accountId = getAccountId(accountConfig.portalId);
+
+  let result;
+  const spinniesI18nKey = `${i18nKey}.create.loading`;
+
+  try {
+    logger.log('');
+    SpinniesManager.add('devTestAcctCreate', {
+      text: i18n(`${spinniesI18nKey}.add`, {
+        accountName: name,
+      }),
+    });
+    result = await createDeveloperTestAccount(accountId, name);
+
+    SpinniesManager.succeed('devTestAcctCreate', {
+      text: i18n(`${spinniesI18nKey}.succeed`, {
+        name: result.accountName,
+        accountId: result.id,
+      }),
+    });
+  } catch (err) {
+    debugErrorAndContext(err);
+
+    SpinniesManager.fail('devTestAcctCreate', {
+      text: i18n(`${spinniesI18nKey}.fail`, {
+        accountName: name,
+      }),
+    });
+
+    if (isMissingScopeError(err)) {
+      logger.error(
+        i18n(`${i18nKey}.create.failure.scopes.message`, {
+          accountName: uiAccountDescription(accountId),
+        })
+      );
+      const websiteOrigin = getHubSpotWebsiteOrigin(env);
+      const url = `${websiteOrigin}/personal-access-key/${accountId}`;
+      logger.info(
+        i18n(`${i18nKey}.create.failure.scopes.instructions`, {
+          accountName: uiAccountDescription(accountId),
+          url,
+        })
+      );
+    } else if (
+      isSpecifiedError(err, {
+        statusCode: 400,
+        errorType: 'TEST_PORTAL_LIMIT_REACHED',
+      })
+    ) {
+      logger.log('');
+      logger.error(
+        i18n(`${i18nKey}.create.failure.limit`, {
+          accountName: uiAccountDescription(accountId),
+          limit: maxTestPortals,
+        })
+      );
+      logger.log('');
+    } else {
+      logErrorInstance(err);
+    }
+    throw err;
+  }
+
+  let devTestAcctConfigName;
+
+  try {
+    // Response contains PAK, save to config here
+    devTestAcctConfigName = await saveDevTestAccountToConfig(
+      env,
+      result,
+      force
+    );
+  } catch (err) {
+    logErrorInstance(err);
+    throw err;
+  }
+
+  return {
+    devTestAcctConfigName,
+    result,
+  };
+};
+
+module.exports = {
+  buildDeveloperTestAccount,
+};

package/lib/developerTestAccounts.js

@@ -1,11 +1,57 @@
 const {
   HUBSPOT_ACCOUNT_TYPES,
 } = require('@hubspot/local-dev-lib/constants/config');
+const { getAccountId, getConfig } = require('@hubspot/local-dev-lib/config');
+const { i18n } = require('./lang');
+const {
+  fetchDeveloperTestAccounts,
+} = require('@hubspot/local-dev-lib/developerTestAccounts');
+
+const getHasDevTestAccounts = appDeveloperAccountConfig => {
+  const config = getConfig();
+  const parentPortalId = getAccountId(appDeveloperAccountConfig.portalId);
+  for (const portal of config.portals) {
+    if (
+      Boolean(portal.parentAccountId) &&
+      portal.parentAccountId === parentPortalId &&
+      portal.accountType === HUBSPOT_ACCOUNT_TYPES.DEVELOPER_TEST
+    ) {
+      return true;
+    }
+  }
+  return false;
+};
 
-const isDeveloperTestAccount = config =>
-  config.accountType &&
-  config.accountType === HUBSPOT_ACCOUNT_TYPES.DEVELOPER_TEST;
+const i18nKey = 'cli.lib.developerTestAccount';
 
+const validateDevTestAccountUsageLimits = async accountConfig => {
+  const accountId = getAccountId(accountConfig.portalId);
+  const response = await fetchDeveloperTestAccounts(accountId);
+  if (response) {
+    const limit = response.maxTestPortals;
+    const count = response.results.length;
+    if (count >= limit) {
+      const hasDevTestAccounts = getHasDevTestAccounts(accountConfig);
+      if (hasDevTestAccounts) {
+        throw new Error(
+          i18n(`${i18nKey}.create.failure.alreadyInConfig`, {
+            accountName: accountConfig.name || accountId,
+            limit,
+          })
+        );
+      } else {
+        throw new Error(
+          i18n(`${i18nKey}.create.failure.limit`, {
+            accountName: accountConfig.name || accountId,
+            limit,
+          })
+        );
+      }
+    }
+    return response;
+  }
+  return null;
+};
 module.exports = {
-  isDeveloperTestAccount,
+  validateDevTestAccountUsageLimits,
 };