@hubspot/cli 6.2.0 → 6.2.2-beta.0

package/README.md

@@ -1,6 +1,12 @@
 # @hubspot/cli
 
-Provides an `hs` command for interacting with HubSpot. [Learn more about building on HubSpot](https://developers.hubspot.com).
+[![Official Release](https://img.shields.io/npm/v/@hubspot/cli/latest?label=Official%20Release)](https://www.npmjs.com/package/@hubspot/cli) [![Latest Version](https://img.shields.io/github/v/tag/hubspot/hubspot-cli?label=Latest%20Version)](https://www.npmjs.com/package/@hubspot/cli?activeTab=versions)
+
+A CLI for HubSpot developers to enable local development and automation. [Learn more about building on HubSpot](https://developers.hubspot.com).
+
+## Contributing
+
+For more information on developing, see the [Contributing Guide](CONTRIBUTING.md).
 
 ## Getting started
 
@@ -37,100 +43,6 @@ A full breakdown of the commands can be found on the [local development tools re
 
 **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`.
 
-Initialize the CLI and create a config file
-
-```bash
-hs init
-```
-
-Show all commands
-
-```bash
-hs help
-```
-
-Upload a file or directory to the Design Manager
-
-```bash
-hs upload --account=DEV [src] [dest]
-```
-
-Fetch a file or directory by path from the Design Manager
-
-```bash
-hs fetch --account=DEV [path] [dest]
-
-# Overwrite existing files
-hs fetch --account=DEV --overwrite [path] [dest]
-```
-
-Watch a directory of files and automatically upload changes to the Design Manager
-
-```bash
-hs watch --account=DEV [src] [dest]
-```
-
-Create a new asset locally
-
-```bash
-hs create [type] [dest]
-```
-
-Delete a file or directory from the Design Manager
-
-```bash
-hs remove --account=DEV [path]
-```
-
-Authenticate against an account using either `personalaccesskey` or `oauth2`
-
-```bash
-hs auth personalaccesskey
-```
-
-### File Manager Commands
-
-Upload a file or directory to the File Manager
-
-```bash
-hs filemanager upload --account=DEV [src] [dest]
-```
-
-Fetch a file or directory from the File Manager
-
-```bash
-hs filemanager fetch --account=DEV [src] [dest]
-
-# Overwrite existing files
-hs filemanager fetch --account=DEV --overwrite [path] [dest]
-```
-
-### HubDB Commands
-
-Create a new HubDB table
-
-```bash
-hs hubdb create <src>
-```
-
-Fetch a HubDB table
-
-```bash
-hs hubdb fetch <id or name> <src>
-```
-
-Clear all rows in a HubDB table
-
-```bash
-hs hubdb clear <id or name>
-```
-
-Delete a HubDB table
-
-```bash
-hs hubdb delete <id or name>
-```
-
 ## Authentication
 
 There are two ways that the tools can authenticate with HubSpot.
@@ -152,3 +64,8 @@ The CLI will exit with one of the following exit codes:
 - `0`: A successful run
 - `1`: There was a config problem or an internal error
 - `2`: There are warnings or validation issues
+
+
+## Changelog
+
+The best way to stay up to date is to check out the [Github Releases](https://github.com/HubSpot/hubspot-cli/releases) and also follow our [developer changelog posts](https://developers.hubspot.com/changelog) for an easier to read breakdown of major changes.

package/bin/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/bin/cli.js

@@ -1,23 +1,18 @@
 #!/usr/bin/env node
-
+"use strict";
 const yargs = require('yargs');
 const updateNotifier = require('update-notifier');
 const chalk = require('chalk');
-
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { addUserAgentHeader } = require('@hubspot/local-dev-lib/http');
 const { logError } = require('../lib/errorHandlers/index');
 const { setLogLevel, getCommandName } = require('../lib/commonOpts');
-const {
-  trackHelpUsage,
-  trackConvertFieldsUsage,
-} = require('../lib/usageTracking');
+const { trackHelpUsage, trackConvertFieldsUsage, } = require('../lib/usageTracking');
 const { getIsInProject } = require('../lib/projects');
 const pkg = require('../package.json');
 const { i18n } = require('../lib/lang');
 const { EXIT_CODES } = require('../lib/enums/exitCodes');
 const { UI_COLORS, uiCommandReference } = require('../lib/ui');
-
 const removeCommand = require('../commands/remove');
 const initCommand = require('../commands/init');
 const logsCommand = require('../commands/logs');
@@ -43,160 +38,144 @@ const accountsCommand = require('../commands/accounts');
 const sandboxesCommand = require('../commands/sandbox');
 const cmsCommand = require('../commands/cms');
 const feedbackCommand = require('../commands/feedback');
-
 const notifier = updateNotifier({
-  pkg: { ...pkg, name: '@hubspot/cli' },
-  distTag: 'latest',
-  shouldNotifyInNpmScript: true,
+    pkg: { ...pkg, name: '@hubspot/cli' },
+    distTag: 'latest',
+    shouldNotifyInNpmScript: true,
 });
-
 const i18nKey = 'commands.generalErrors';
-
 const CMS_CLI_PACKAGE_NAME = '@hubspot/cms-cli';
-
 notifier.notify({
-  message:
-    pkg.name === CMS_CLI_PACKAGE_NAME
-      ? i18n(`${i18nKey}.updateNotify.cmsUpdateNotification`, {
-          packageName: CMS_CLI_PACKAGE_NAME,
-          updateCommand: uiCommandReference('{updateCommand}'),
+    message: pkg.name === CMS_CLI_PACKAGE_NAME
+        ? i18n(`${i18nKey}.updateNotify.cmsUpdateNotification`, {
+            packageName: CMS_CLI_PACKAGE_NAME,
+            updateCommand: uiCommandReference('{updateCommand}'),
         })
-      : i18n(`${i18nKey}.updateNotify.cliUpdateNotification`, {
-          updateCommand: uiCommandReference('{updateCommand}'),
+        : i18n(`${i18nKey}.updateNotify.cliUpdateNotification`, {
+            updateCommand: uiCommandReference('{updateCommand}'),
         }),
-  defer: false,
-  boxenOptions: {
-    borderColor: UI_COLORS.MARIGOLD_DARK,
-    margin: 1,
-    padding: 1,
-    textAlignment: 'center',
-    borderStyle: 'round',
-    title:
-      pkg.name === CMS_CLI_PACKAGE_NAME
-        ? null
-        : chalk.bold(i18n(`${i18nKey}.updateNotify.notifyTitle`)),
-  },
+    defer: false,
+    boxenOptions: {
+        borderColor: UI_COLORS.MARIGOLD_DARK,
+        margin: 1,
+        padding: 1,
+        textAlignment: 'center',
+        borderStyle: 'round',
+        title: pkg.name === CMS_CLI_PACKAGE_NAME
+            ? null
+            : chalk.bold(i18n(`${i18nKey}.updateNotify.notifyTitle`)),
+    },
 });
-
 const getTerminalWidth = () => {
-  const width = yargs.terminalWidth();
-
-  if (width >= 100) return width * 0.9;
-
-  return width;
+    const width = yargs.terminalWidth();
+    if (width >= 100)
+        return width * 0.9;
+    return width;
 };
-
 const handleFailure = (msg, err, yargs) => {
-  if (msg) {
-    logger.error(msg);
-  } else if (err) {
-    logError(err);
-  }
-
-  if (msg === null) {
-    yargs.showHelp();
-    process.exit(EXIT_CODES.SUCCESS);
-  } else {
-    process.exit(EXIT_CODES.ERROR);
-  }
+    if (msg) {
+        logger.error(msg);
+    }
+    else if (err) {
+        logError(err);
+    }
+    if (msg === null) {
+        yargs.showHelp();
+        process.exit(EXIT_CODES.SUCCESS);
+    }
+    else {
+        process.exit(EXIT_CODES.ERROR);
+    }
 };
-
 const performChecks = argv => {
-  // "hs config set default-account" has moved to "hs accounts use"
-  if (
-    argv._[0] === 'config' &&
-    argv._[1] === 'set' &&
-    argv._[2] === 'default-account'
-  ) {
-    logger.error(i18n(`${i18nKey}.setDefaultAccountMoved`));
-    process.exit(EXIT_CODES.ERROR);
-  }
-
-  // Require "project" command when running upload/watch inside of a project
-  if (argv._.length === 1 && ['upload', 'watch'].includes(argv._[0])) {
-    if (getIsInProject(argv.src)) {
-      logger.error(
-        i18n(`${i18nKey}.srcIsProject`, {
-          src: argv.src || './',
-          command: argv._.join(' '),
-        })
-      );
-      process.exit(EXIT_CODES.ERROR);
-    } else {
-      return true;
+    // "hs config set default-account" has moved to "hs accounts use"
+    if (argv._[0] === 'config' &&
+        argv._[1] === 'set' &&
+        argv._[2] === 'default-account') {
+        logger.error(i18n(`${i18nKey}.setDefaultAccountMoved`));
+        process.exit(EXIT_CODES.ERROR);
+    }
+    // Require "project" command when running upload/watch inside of a project
+    if (argv._.length === 1 && ['upload', 'watch'].includes(argv._[0])) {
+        if (getIsInProject(argv.src)) {
+            logger.error(i18n(`${i18nKey}.srcIsProject`, {
+                src: argv.src || './',
+                command: argv._.join(' '),
+            }));
+            process.exit(EXIT_CODES.ERROR);
+        }
+        else {
+            return true;
+        }
+    }
+    else {
+        return true;
     }
-  } else {
-    return true;
-  }
 };
-
 const setRequestHeaders = () => {
-  addUserAgentHeader('HubSpot CLI', pkg.version);
+    addUserAgentHeader('HubSpot CLI', pkg.version);
 };
-
 const argv = yargs
-  .usage('The command line interface to interact with HubSpot.')
-  .middleware([setLogLevel, setRequestHeaders])
-  .exitProcess(false)
-  .fail(handleFailure)
-  .option('debug', {
+    .usage('The command line interface to interact with HubSpot.')
+    .middleware([setLogLevel, setRequestHeaders])
+    .exitProcess(false)
+    .fail(handleFailure)
+    .option('debug', {
     alias: 'd',
     default: false,
     describe: 'Set log level to debug',
     type: 'boolean',
-  })
-  .option('noHyperlinks', {
+})
+    .option('noHyperlinks', {
     default: false,
     describe: 'prevent hyperlinks from displaying in the ui',
     hidden: true,
     type: 'boolean',
-  })
-  .option('noColor', {
+})
+    .option('noColor', {
     default: false,
     describe: 'prevent color from displaying in the ui',
     hidden: true,
     type: 'boolean',
-  })
-  .check(performChecks)
-  .command(authCommand)
-  .command(initCommand)
-  .command(logsCommand)
-  .command(cmsCommand)
-  .command(lintCommand)
-  .command(hubdbCommand)
-  .command(watchCommand)
-  .command(removeCommand)
-  .command(uploadCommand)
-  .command(createCommand)
-  .command(fetchCommand)
-  .command(filemanagerCommand)
-  .command(secretsCommand)
-  .command(customObjectCommand)
-  .command(functionsCommand)
-  .command({
+})
+    .check(performChecks)
+    .command(authCommand)
+    .command(initCommand)
+    .command(logsCommand)
+    .command(cmsCommand)
+    .command(lintCommand)
+    .command(hubdbCommand)
+    .command(watchCommand)
+    .command(removeCommand)
+    .command(uploadCommand)
+    .command(createCommand)
+    .command(fetchCommand)
+    .command(filemanagerCommand)
+    .command(secretsCommand)
+    .command(customObjectCommand)
+    .command(functionsCommand)
+    .command({
     ...listCommand,
     aliases: 'ls',
-  })
-  .command(openCommand)
-  .command(mvCommand)
-  .command(projectCommands)
-  .command(themeCommand)
-  .command(moduleCommand)
-  .command(configCommand)
-  .command(accountsCommand)
-  .command(sandboxesCommand)
-  .command(feedbackCommand)
-  .help()
-  .recommendCommands()
-  .demandCommand(1, '')
-  .completion()
-  .wrap(getTerminalWidth())
-  .strict().argv;
-
+})
+    .command(openCommand)
+    .command(mvCommand)
+    .command(projectCommands)
+    .command(themeCommand)
+    .command(moduleCommand)
+    .command(configCommand)
+    .command(accountsCommand)
+    .command(sandboxesCommand)
+    .command(feedbackCommand)
+    .help()
+    .recommendCommands()
+    .demandCommand(1, '')
+    .completion()
+    .wrap(getTerminalWidth())
+    .strict().argv;
 if (argv.help) {
-  trackHelpUsage(getCommandName(argv));
+    trackHelpUsage(getCommandName(argv));
 }
-
 if (argv.convertFields) {
-  trackConvertFieldsUsage(getCommandName(argv));
+    trackConvertFieldsUsage(getCommandName(argv));
 }

package/commands/accounts/clean.d.ts

@@ -0,0 +1 @@
+export {};

package/commands/accounts/clean.js

@@ -1,136 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { logger } = require('@hubspot/local-dev-lib/logger');
-const {
-  accessTokenForPersonalAccessKey,
-} = require('@hubspot/local-dev-lib/personalAccessKey');
-
+const { accessTokenForPersonalAccessKey, } = require('@hubspot/local-dev-lib/personalAccessKey');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 const { i18n } = require('../../lib/lang');
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
-const {
-  addConfigOptions,
-  addAccountOptions,
-  addUseEnvironmentOptions,
-  addTestingOptions,
-} = require('../../lib/commonOpts');
+const { addConfigOptions, addAccountOptions, addUseEnvironmentOptions, addTestingOptions, } = require('../../lib/commonOpts');
 const { promptUser } = require('../../lib/prompts/promptUtils');
 const { getTableContents } = require('../../lib/ui/table');
 const SpinniesManager = require('../../lib/ui/SpinniesManager');
 const { getConfig, deleteAccount } = require('@hubspot/local-dev-lib/config');
 const { uiAccountDescription } = require('../../lib/ui');
 const { isSpecifiedError } = require('@hubspot/local-dev-lib/errors/index');
-
 const i18nKey = 'commands.accounts.subcommands.clean';
-
 exports.command = 'clean';
 exports.describe = i18n(`${i18nKey}.describe`);
-
-exports.handler = async options => {
-  const { qa } = options;
-  await loadAndValidateOptions(options, false);
-
-  const config = getConfig();
-
-  trackCommandUsage('accounts-clean', null);
-
-  const filteredTestAccounts = config.portals.filter(p =>
-    qa ? p.env === 'qa' : p.env !== 'qa'
-  );
-
-  if (filteredTestAccounts && filteredTestAccounts.length === 0) {
-    logger.log(i18n(`${i18nKey}.noResults`));
-    process.exit(EXIT_CODES.SUCCESS);
-  }
-
-  const accountsToRemove = [];
-  SpinniesManager.init({
-    succeedColor: 'white',
-  });
-  SpinniesManager.add('accountsClean', {
-    text: i18n(`${i18nKey}.loading.add`),
-  });
-
-  for (const account of filteredTestAccounts) {
-    try {
-      await accessTokenForPersonalAccessKey(account.portalId, true);
-    } catch (error) {
-      if (
-        isSpecifiedError(error, {
-          statusCode: 401,
-          category: 'INVALID_AUTHENTICATION',
-          subCategory: 'LocalDevAuthErrorType.PORTAL_NOT_ACTIVE',
-        }) ||
-        isSpecifiedError(error, {
-          statusCode: 404,
-          category: 'INVALID_AUTHENTICATION',
-          subCategory: 'LocalDevAuthErrorType.INVALID_PORTAL_ID',
-        })
-      ) {
-        accountsToRemove.push(account);
-      }
+exports.handler = async (options) => {
+    const { qa } = options;
+    await loadAndValidateOptions(options, false);
+    const config = getConfig();
+    trackCommandUsage('accounts-clean', null);
+    const filteredTestAccounts = config.portals.filter(p => qa ? p.env === 'qa' : p.env !== 'qa');
+    if (filteredTestAccounts && filteredTestAccounts.length === 0) {
+        logger.log(i18n(`${i18nKey}.noResults`));
+        process.exit(EXIT_CODES.SUCCESS);
     }
-  }
-
-  if (accountsToRemove.length > 0) {
-    const oneAccountFound = accountsToRemove.length === 1;
-    SpinniesManager.succeed('accountsClean', {
-      text: i18n(
-        oneAccountFound
-          ? `${i18nKey}.inactiveAccountsFound.one`
-          : `${i18nKey}.inactiveAccountsFound.other`,
-        {
-          count: accountsToRemove.length,
-        }
-      ),
+    const accountsToRemove = [];
+    SpinniesManager.init({
+        succeedColor: 'white',
     });
-    logger.log(
-      getTableContents(
-        accountsToRemove.map(p => [uiAccountDescription(p.portalId)]),
-        { border: { bodyLeft: '  ' } }
-      )
-    );
-    const { accountsCleanPrompt } = await promptUser([
-      {
-        name: 'accountsCleanPrompt',
-        type: 'confirm',
-        message: i18n(
-          oneAccountFound
-            ? `${i18nKey}.confirm.one`
-            : `${i18nKey}.confirm.other`,
-          {
-            count: accountsToRemove.length,
-          }
-        ),
-      },
-    ]);
-    if (accountsCleanPrompt) {
-      logger.log('');
-      for (const accountToRemove of accountsToRemove) {
-        await deleteAccount(accountToRemove.name);
-        logger.log(
-          i18n(`${i18nKey}.removeSuccess`, {
-            accountName: accountToRemove.name,
-          })
-        );
-      }
-    }
-  } else {
-    SpinniesManager.succeed('accountsClean', {
-      text: i18n(`${i18nKey}.noResults`),
+    SpinniesManager.add('accountsClean', {
+        text: i18n(`${i18nKey}.loading.add`),
     });
-  }
-
-  logger.log('');
-  process.exit(EXIT_CODES.SUCCESS);
+    for (const account of filteredTestAccounts) {
+        try {
+            await accessTokenForPersonalAccessKey(account.portalId, true);
+        }
+        catch (error) {
+            if (isSpecifiedError(error, {
+                statusCode: 401,
+                category: 'INVALID_AUTHENTICATION',
+                subCategory: 'LocalDevAuthErrorType.PORTAL_NOT_ACTIVE',
+            }) ||
+                isSpecifiedError(error, {
+                    statusCode: 404,
+                    category: 'INVALID_AUTHENTICATION',
+                    subCategory: 'LocalDevAuthErrorType.INVALID_PORTAL_ID',
+                })) {
+                accountsToRemove.push(account);
+            }
+        }
+    }
+    if (accountsToRemove.length > 0) {
+        const oneAccountFound = accountsToRemove.length === 1;
+        SpinniesManager.succeed('accountsClean', {
+            text: i18n(oneAccountFound
+                ? `${i18nKey}.inactiveAccountsFound.one`
+                : `${i18nKey}.inactiveAccountsFound.other`, {
+                count: accountsToRemove.length,
+            }),
+        });
+        logger.log(getTableContents(accountsToRemove.map(p => [uiAccountDescription(p.portalId)]), { border: { bodyLeft: '  ' } }));
+        const { accountsCleanPrompt } = await promptUser([
+            {
+                name: 'accountsCleanPrompt',
+                type: 'confirm',
+                message: i18n(oneAccountFound
+                    ? `${i18nKey}.confirm.one`
+                    : `${i18nKey}.confirm.other`, {
+                    count: accountsToRemove.length,
+                }),
+            },
+        ]);
+        if (accountsCleanPrompt) {
+            logger.log('');
+            for (const accountToRemove of accountsToRemove) {
+                await deleteAccount(accountToRemove.name);
+                logger.log(i18n(`${i18nKey}.removeSuccess`, {
+                    accountName: accountToRemove.name,
+                }));
+            }
+        }
+    }
+    else {
+        SpinniesManager.succeed('accountsClean', {
+            text: i18n(`${i18nKey}.noResults`),
+        });
+    }
+    logger.log('');
+    process.exit(EXIT_CODES.SUCCESS);
 };
-
 exports.builder = yargs => {
-  addConfigOptions(yargs);
-  addAccountOptions(yargs);
-  addUseEnvironmentOptions(yargs);
-  addTestingOptions(yargs);
-
-  yargs.example([['$0 accounts clean']]);
-
-  return yargs;
+    addConfigOptions(yargs);
+    addAccountOptions(yargs);
+    addUseEnvironmentOptions(yargs);
+    addTestingOptions(yargs);
+    yargs.example([['$0 accounts clean']]);
+    return yargs;
 };

package/commands/accounts/info.d.ts

@@ -0,0 +1 @@
+export {};