@hubspot/cli 4.1.8-beta.0 → 4.1.8-beta.2

package/README.md

@@ -4,7 +4,7 @@ Provides an `hs` command for interacting with HubSpot. [Learn more about buildin
 
 ## Getting started
 
-For more information on using these tools, see [Local Development Tooling: Getting Started](https://designers.hubspot.com/tutorials/getting-started-with-local-development)
+For more information on using these tools, see [Local Development Tooling: Getting Started](https://developers.hubspot.com/docs/cms/guides/getting-started-with-local-development)
 
 ### Installation
 
@@ -33,7 +33,7 @@ and copying the output to either your `.bashrc` or `.zshrc`, and then sourcing t
 
 ## Commands
 
-A full breakdown of the commands can be found on the [local development tools reference page](https://designers.hubspot.com/docs/developer-reference/local-development-cli).
+A full breakdown of the commands can be found on the [local development tools reference page](https://developers.hubspot.com/docs/cms/developer-reference/local-development-cli).
 
 **Note:** When `@hubspot/cli` is installed local to a project, the commands need to be prefixed with either `yarn` if using `yarn` or `npx` if using `npm`.
 

package/commands/accounts/list.js

@@ -12,7 +12,7 @@ const {
 } = require('../../lib/commonOpts');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 const { loadAndValidateOptions } = require('../../lib/validation');
-const { getSandboxType } = require('../../lib/sandboxes');
+const { getSandboxTypeAsString } = require('../../lib/sandboxes');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
 
 const i18nKey = 'cli.commands.accounts.subcommands.list';
@@ -58,7 +58,7 @@ const getPortalData = mappedPortalData => {
         portalData.push([portal.name, portal.portalId, portal.authType]);
       } else {
         portalData.push([
-          `↳ ${portal.name} [${getSandboxType(
+          `↳ ${portal.name} [${getSandboxTypeAsString(
             portal.sandboxAccountType
           )} sandbox]`,
           portal.portalId,

package/commands/create/api-sample.js

@@ -39,7 +39,7 @@ module.exports = {
     const downloadSpinner = ora(i18n(`${i18nKey}.loading.apiSamples`));
     downloadSpinner.start();
     const samplesConfig = await fetchJsonFromRepository(
-      'sample-apps-list',
+      'HubSpot/sample-apps-list',
       'main/samples.json'
     );
     downloadSpinner.stop();

package/commands/project/add.js

@@ -0,0 +1,56 @@
+const { logger } = require('@hubspot/cli-lib/logger');
+const { getAccountId } = require('@hubspot/cli-lib/lib/config');
+const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
+
+const { trackCommandUsage } = require('../../lib/usageTracking');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { projectAddPrompt } = require('../../lib/prompts/projectAddPrompt');
+const { createProjectComponent } = require('../../lib/projects');
+const { loadAndValidateOptions } = require('../../lib/validation');
+
+const i18nKey = 'cli.commands.project.subcommands.add';
+
+exports.command = 'add';
+exports.describe = null; //i18n(`${i18nKey}.describe`);
+
+exports.handler = async options => {
+  await loadAndValidateOptions(options);
+
+  const accountId = getAccountId(options);
+
+  logger.log('');
+  logger.log(i18n(`${i18nKey}.creatingComponent.message`));
+  logger.log('');
+  const { type, name } = await projectAddPrompt(options);
+
+  trackCommandUsage('project-add', null, accountId);
+
+  try {
+    await createProjectComponent(options.type || type, options.name || name);
+    logger.log('');
+    logger.log(
+      i18n(`${i18nKey}.success.message`, {
+        componentName: options.name || name,
+      })
+    );
+  } catch (error) {
+    logErrorInstance(error);
+  }
+};
+
+exports.builder = yargs => {
+  yargs.options({
+    type: {
+      describe: i18n(`${i18nKey}.options.type.describe`),
+      type: 'string',
+    },
+    name: {
+      describe: i18n(`${i18nKey}.options.name.describe`),
+      type: 'string',
+    },
+  });
+
+  yargs.example([['$0 project add', i18n(`${i18nKey}.examples.default`)]]);
+
+  return yargs;
+};

package/commands/project/create.js

@@ -14,7 +14,6 @@ const {
 } = require('../../lib/prompts/createProjectPrompt');
 const { createProjectConfig } = require('../../lib/projects');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
-const { PROJECT_TEMPLATES } = require('@hubspot/cli-lib/lib/constants');
 const { uiFeatureHighlight } = require('../../lib/ui');
 const { logger } = require('@hubspot/cli-lib/logger');
 
@@ -35,7 +34,8 @@ exports.handler = async options => {
   await createProjectConfig(
     path.resolve(getCwd(), options.location || location),
     options.name || name,
-    options.template || template
+    options.template || template,
+    options.repoPath
   );
 
   logger.log('');
@@ -61,7 +61,10 @@ exports.builder = yargs => {
     template: {
       describe: i18n(`${i18nKey}.options.template.describe`),
       type: 'string',
-      choices: PROJECT_TEMPLATES.map(template => template.name),
+    },
+    repoPath: {
+      describe: i18n(`${i18nKey}.options.repoPath.describe`),
+      type: 'string',
     },
   });
 

package/commands/project/deploy.js

@@ -14,6 +14,7 @@ const { deployProject, fetchProject } = require('@hubspot/cli-lib/api/dfs');
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { getProjectConfig, pollDeployStatus } = require('../../lib/projects');
 const { projectNamePrompt } = require('../../lib/prompts/projectNamePrompt');
+const { buildIdPrompt } = require('../../lib/prompts/buildIdPrompt');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
 const { getAccountConfig } = require('@hubspot/cli-lib');
 
@@ -28,46 +29,59 @@ exports.handler = async options => {
 
   const accountId = getAccountId(options);
   const accountConfig = getAccountConfig(accountId);
-  const { project, buildId } = options;
+  const { project: projectOption, buildId: buildIdOption } = options;
   const sandboxType = accountConfig && accountConfig.sandboxAccountType;
 
   trackCommandUsage('project-deploy', { type: sandboxType }, accountId);
 
   const { projectConfig } = await getProjectConfig();
 
-  let projectName = project;
+  let projectName = projectOption;
 
-  if (!projectName && projectConfig) {
+  if (!projectOption && projectConfig) {
     projectName = projectConfig.name;
   }
 
-  const namePrompt = await projectNamePrompt(accountId, {
+  const namePromptResponse = await projectNamePrompt(accountId, {
     project: projectName,
   });
 
-  if (!projectName && namePrompt.projectName) {
-    projectName = namePrompt.projectName;
+  if (!projectName && namePromptResponse.projectName) {
+    projectName = namePromptResponse.projectName;
   }
 
-  let exitCode = EXIT_CODES.SUCCESS;
+  let buildIdToDeploy = buildIdOption;
 
-  const getBuildId = async () => {
-    const { latestBuild } = await fetchProject(accountId, projectName);
-    if (latestBuild && latestBuild.buildId) {
-      return latestBuild.buildId;
+  if (!buildIdOption) {
+    const { latestBuild, deployedBuildId } = await fetchProject(
+      accountId,
+      projectName
+    );
+    if (!latestBuild || !latestBuild.buildId) {
+      logger.error(i18n(`${i18nKey}.errors.noBuilds`));
+      process.exit(EXIT_CODES.ERROR);
     }
+    const buildIdPromptResponse = await buildIdPrompt(
+      latestBuild.buildId,
+      deployedBuildId,
+      projectName
+    );
+
+    buildIdToDeploy = buildIdPromptResponse.buildId;
+  }
+
+  if (!buildIdToDeploy) {
     logger.error(i18n(`${i18nKey}.errors.noBuildId`));
-    exitCode = EXIT_CODES.ERROR;
-    return;
-  };
+    process.exit(EXIT_CODES.ERROR);
+  }
 
-  try {
-    const deployedBuildId = buildId || (await getBuildId());
+  let exitCode = EXIT_CODES.SUCCESS;
 
+  try {
     const deployResp = await deployProject(
       accountId,
       projectName,
-      deployedBuildId
+      buildIdToDeploy
     );
 
     if (deployResp.error) {
@@ -84,7 +98,7 @@ exports.handler = async options => {
       accountId,
       projectName,
       deployResp.id,
-      deployedBuildId
+      buildIdToDeploy
     );
   } catch (e) {
     if (e.statusCode === 400) {

package/commands/project/dev.js

@@ -0,0 +1,278 @@
+const {
+  addAccountOptions,
+  addConfigOptions,
+  getAccountId,
+  addUseEnvironmentOptions,
+  addTestingOptions,
+} = require('../../lib/commonOpts');
+const { trackCommandUsage } = require('../../lib/usageTracking');
+const { loadAndValidateOptions } = require('../../lib/validation');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { logger } = require('@hubspot/cli-lib/logger');
+const { getConfigAccounts } = require('@hubspot/cli-lib/lib/config');
+const { createProject, fetchProject } = require('@hubspot/cli-lib/api/dfs');
+const { handleExit } = require('@hubspot/cli-lib/lib/process');
+const {
+  getProjectConfig,
+  ensureProjectExists,
+  handleProjectUpload,
+  pollProjectBuildAndDeploy,
+} = require('../../lib/projects');
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
+const { uiAccountDescription, uiLine } = require('../../lib/ui');
+const { confirmPrompt } = require('../../lib/prompts/promptUtils');
+const {
+  selectTargetAccountPrompt,
+} = require('../../lib/prompts/projectDevTargetAccountPrompt');
+const SpinniesManager = require('../../lib/SpinniesManager');
+const {
+  LocalDevManager,
+  UPLOAD_PERMISSIONS,
+} = require('../../lib/LocalDevManager');
+const { getAccountConfig, getEnv } = require('@hubspot/cli-lib');
+const { sandboxNamePrompt } = require('../../lib/prompts/sandboxesPrompt');
+const {
+  validateSandboxUsageLimits,
+  DEVELOPER_SANDBOX,
+  getAvailableSyncTypes,
+} = require('../../lib/sandboxes');
+const { getValidEnv } = require('@hubspot/cli-lib/lib/environment');
+const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
+const { buildSandbox } = require('../../lib/sandbox-create');
+const { syncSandbox } = require('../../lib/sandbox-sync');
+
+const i18nKey = 'cli.commands.project.subcommands.dev';
+
+exports.command = 'dev [--account] [--mockServers]';
+exports.describe = null; //i18n(`${i18nKey}.describe`);
+
+exports.handler = async options => {
+  await loadAndValidateOptions(options);
+  const accountId = getAccountId(options);
+  const accountConfig = getAccountConfig(accountId);
+  const env = getValidEnv(getEnv(accountId));
+
+  trackCommandUsage('project-dev', null, accountId);
+
+  const { projectConfig, projectDir } = await getProjectConfig();
+
+  logger.log(i18n(`${i18nKey}.logs.introHeader`));
+  uiLine();
+  logger.log(i18n(`${i18nKey}.logs.introBody1`));
+  logger.log();
+  logger.log(i18n(`${i18nKey}.logs.introBody2`));
+  uiLine();
+  logger.log();
+
+  if (!projectConfig) {
+    logger.error(i18n(`${i18nKey}.errors.noProjectConfig`));
+    process.exit(EXIT_CODES.ERROR);
+  }
+
+  const accounts = getConfigAccounts();
+  let targetAccountId = options.accountId;
+  let createNewSandbox = false;
+  let chooseNonSandbox = false;
+
+  if (!targetAccountId) {
+    const {
+      targetAccountId: promptTargetAccountId,
+      chooseNonSandbox: promptChooseNonSandbox,
+      createNewSandbox: promptCreateNewSandbox,
+    } = await selectTargetAccountPrompt(accounts, accountConfig, false);
+
+    targetAccountId = promptTargetAccountId;
+    chooseNonSandbox = promptChooseNonSandbox;
+    createNewSandbox = promptCreateNewSandbox;
+  }
+
+  logger.log();
+
+  // Show a warning if the user chooses a non-sandbox account (false)
+  let shouldTargetNonSandboxAccount;
+  if (chooseNonSandbox) {
+    uiLine();
+    logger.warn(i18n(`${i18nKey}.logs.prodAccountWarning`));
+    uiLine();
+    logger.log();
+
+    shouldTargetNonSandboxAccount = await confirmPrompt(
+      i18n(`${i18nKey}.prompt.targetNonSandbox`)
+    );
+
+    if (shouldTargetNonSandboxAccount) {
+      const {
+        targetAccountId: promptNonSandboxTargetAccountId,
+      } = await selectTargetAccountPrompt(accounts, accountConfig, true);
+
+      targetAccountId = promptNonSandboxTargetAccountId;
+      logger.log();
+    } else {
+      process.exit(EXIT_CODES.SUCCESS);
+    }
+  } else if (createNewSandbox) {
+    try {
+      await validateSandboxUsageLimits(accountConfig, DEVELOPER_SANDBOX, env);
+    } catch (err) {
+      logErrorInstance(err);
+      process.exit(EXIT_CODES.ERROR);
+    }
+    try {
+      const { name } = await sandboxNamePrompt(DEVELOPER_SANDBOX);
+      const { result } = await buildSandbox({
+        name,
+        type: DEVELOPER_SANDBOX,
+        accountConfig,
+        env,
+      });
+
+      targetAccountId = result.sandbox.sandboxHubId;
+
+      const sandboxAccountConfig = getAccountConfig(
+        result.sandbox.sandboxHubId
+      );
+      const syncTasks = await getAvailableSyncTypes(
+        accountConfig,
+        sandboxAccountConfig
+      );
+      await syncSandbox({
+        accountConfig: sandboxAccountConfig,
+        parentAccountConfig: accountConfig,
+        env,
+        syncTasks,
+        allowEarlyTermination: false, // Don't let user terminate early in this flow
+        skipPolling: true, // Skip polling, sync will run and complete in the background
+      });
+    } catch (err) {
+      logErrorInstance(err);
+      process.exit(EXIT_CODES.ERROR);
+    }
+  }
+
+  const projectExists = await ensureProjectExists(
+    targetAccountId,
+    projectConfig.name,
+    {
+      allowCreate: false,
+      noLogs: true,
+      withPolling: true,
+    }
+  );
+
+  const isNonSandboxAccount = shouldTargetNonSandboxAccount;
+
+  let uploadPermission = isNonSandboxAccount
+    ? UPLOAD_PERMISSIONS.manual
+    : UPLOAD_PERMISSIONS.always;
+
+  if (projectExists) {
+    const { sourceIntegration } = await fetchProject(
+      targetAccountId,
+      projectConfig.name
+    );
+    if (sourceIntegration) {
+      uploadPermission = UPLOAD_PERMISSIONS.never;
+    }
+  }
+
+  const spinnies = SpinniesManager.init();
+
+  if (!projectExists) {
+    uiLine();
+    logger.warn(
+      i18n(`${i18nKey}.logs.projectMustExistExplanation`, {
+        accountIdentifier: uiAccountDescription(targetAccountId),
+        projectName: projectConfig.name,
+      })
+    );
+    uiLine();
+
+    const shouldCreateProject = await confirmPrompt(
+      i18n(`${i18nKey}.prompt.createProject`, {
+        accountIdentifier: uiAccountDescription(targetAccountId),
+        projectName: projectConfig.name,
+      })
+    );
+
+    if (shouldCreateProject) {
+      try {
+        spinnies.add('createProject', {
+          text: i18n(`${i18nKey}.status.creatingProject`, {
+            accountIdentifier: uiAccountDescription(targetAccountId),
+            projectName: projectConfig.name,
+          }),
+        });
+        await createProject(targetAccountId, projectConfig.name);
+        spinnies.succeed('createProject', {
+          text: i18n(`${i18nKey}.status.createdProject`, {
+            accountIdentifier: uiAccountDescription(targetAccountId),
+            projectName: projectConfig.name,
+          }),
+        });
+      } catch (err) {
+        logger.log(i18n(`${i18nKey}.logs.failedToCreateProject`));
+        process.exit(EXIT_CODES.ERROR);
+      }
+    } else {
+      // We cannot continue if the project does not exist in the target account
+      logger.log(i18n(`${i18nKey}.logs.choseNotToCreateProject`));
+      process.exit(EXIT_CODES.SUCCESS);
+    }
+  }
+
+  spinnies.add('devModeSetup', {
+    text: i18n(`${i18nKey}.status.startupMessage`, {
+      projectName: projectConfig.name,
+    }),
+    isParent: true,
+  });
+
+  let result;
+  if (uploadPermission === UPLOAD_PERMISSIONS.always) {
+    result = await handleProjectUpload(
+      targetAccountId,
+      projectConfig,
+      projectDir,
+      (...args) => pollProjectBuildAndDeploy(...args, true),
+      i18n(`${i18nKey}.logs.initialUploadMessage`)
+    );
+  }
+
+  if (result && !result.succeeded) {
+    spinnies.fail('devModeSetup', {
+      text: i18n(`${i18nKey}.status.startupFailed`),
+    });
+    process.exit(EXIT_CODES.ERROR);
+  } else {
+    spinnies.remove('devModeSetup');
+  }
+
+  const LocalDev = new LocalDevManager({
+    debug: options.debug,
+    mockServers: options.mockServers,
+    projectConfig,
+    projectDir,
+    targetAccountId,
+    uploadPermission,
+  });
+
+  await LocalDev.start();
+
+  handleExit(LocalDev.stop);
+};
+
+exports.builder = yargs => {
+  addConfigOptions(yargs, true);
+  addAccountOptions(yargs, true);
+  addUseEnvironmentOptions(yargs, true);
+  addTestingOptions(yargs, true);
+
+  yargs.option('mockServers', {
+    describe: 'mock servers',
+    type: 'boolean',
+    default: false,
+  });
+  yargs.example([['$0 project dev', i18n(`${i18nKey}.examples.default`)]]);
+
+  return yargs;
+};

package/commands/project/download.js

@@ -22,18 +22,24 @@ const {
   ensureProjectExists,
 } = require('../../lib/projects');
 const { loadAndValidateOptions } = require('../../lib/validation');
+const {
+  downloadProjectPrompt,
+} = require('../../lib/prompts/downloadProjectPrompt');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
 
 const i18nKey = 'cli.commands.project.subcommands.download';
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 
-exports.command = 'download <name> [dest]';
+exports.command = 'download [--project]';
 exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
   await loadAndValidateOptions(options);
 
-  const { name: projectName, dest, buildNumber } = options;
+  const { project, dest, buildNumber } = options;
+  let { project: promptedProjectName } = await downloadProjectPrompt(options);
+  let projectName = promptedProjectName || project;
+
   const accountId = getAccountId(options);
 
   trackCommandUsage('project-download', null, accountId);
@@ -50,7 +56,8 @@ exports.handler = async options => {
         accountId: chalk.bold(accountId),
       })
     );
-    process.exit(EXIT_CODES.ERROR);
+    let { name: promptedProjectName } = await downloadProjectPrompt(options);
+    let projectName = promptedProjectName || project;
   }
 
   const absoluteDestPath = dest ? path.resolve(getCwd(), dest) : getCwd();
@@ -58,7 +65,7 @@ exports.handler = async options => {
   const projectConfigCreated = await createProjectConfig(
     absoluteDestPath,
     projectName,
-    'no-template'
+    { name: 'no-template' }
   );
 
   if (!projectConfigCreated) {
@@ -119,23 +126,27 @@ exports.handler = async options => {
 exports.builder = yargs => {
   addUseEnvironmentOptions(yargs, true);
 
-  yargs.positional('name', {
-    describe: i18n(`${i18nKey}.positionals.name.describe`),
-    type: 'string',
-  });
-  yargs.positional('dest', {
-    describe: i18n(`${i18nKey}.positionals.dest.describe`),
-    type: 'string',
-  });
-  yargs.option('buildNumber', {
-    describe: i18n(`${i18nKey}.options.buildNumber.describe`),
-    type: 'number',
+  yargs.options({
+    project: {
+      describe: i18n(`${i18nKey}.options.project.describe`),
+      type: 'string',
+    },
+    dest: {
+      describe: i18n(`${i18nKey}.options.dest.describe`),
+      type: 'string',
+    },
+    buildNumber: {
+      describe: i18n(`${i18nKey}.options.buildNumber.describe`),
+      type: 'number',
+    },
   });
+
   yargs.example([
     [
-      '$0 project download myProject myProjectFolder',
+      '$0 project download --project=myProject --dest=myProjectFolder',
       i18n(`${i18nKey}.examples.default`),
     ],
   ]);
+
   return yargs;
 };