@hubspot/cli 6.2.1 → 6.2.2-experimental.0

package/commands/sandbox/delete.js

@@ -1,10 +1,5 @@
-const {
-  addAccountOptions,
-  addConfigOptions,
-  addUseEnvironmentOptions,
-  getAccountId,
-  addTestingOptions,
-} = require('../../lib/commonOpts');
+"use strict";
+const { addAccountOptions, addConfigOptions, addUseEnvironmentOptions, getAccountId, addTestingOptions, } = require('../../lib/commonOpts');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 const { loadAndValidateOptions } = require('../../lib/validation');
@@ -13,236 +8,184 @@ const { isSpecifiedError } = require('@hubspot/local-dev-lib/errors/index');
 const { deleteSandbox } = require('@hubspot/local-dev-lib/api/sandboxHubs');
 const { i18n } = require('../../lib/lang');
 const { deleteSandboxPrompt } = require('../../lib/prompts/sandboxesPrompt');
-const {
-  getConfig,
-  getEnv,
-  removeSandboxAccountFromConfig,
-  updateDefaultAccount,
-} = require('@hubspot/local-dev-lib/config');
-const {
-  selectAndSetAsDefaultAccountPrompt,
-} = require('../../lib/prompts/accountsPrompt');
+const { getConfig, getEnv, removeSandboxAccountFromConfig, updateDefaultAccount, } = require('@hubspot/local-dev-lib/config');
+const { selectAndSetAsDefaultAccountPrompt, } = require('../../lib/prompts/accountsPrompt');
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 const { promptUser } = require('../../lib/prompts/promptUtils');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
-
 const { getValidEnv } = require('@hubspot/local-dev-lib/environment');
 const { uiAccountDescription, uiBetaTag } = require('../../lib/ui');
-
 const i18nKey = 'commands.sandbox.subcommands.delete';
-
 exports.command = 'delete [--account]';
-exports.describe = exports.describe = uiBetaTag(
-  i18n(`${i18nKey}.describe`),
-  false
-);
-
-exports.handler = async options => {
-  await loadAndValidateOptions(options, false);
-
-  const { account, force } = options;
-  const config = getConfig();
-
-  trackCommandUsage('sandbox-delete', null);
-
-  let accountPrompt;
-  if (!account) {
-    if (!force) {
-      accountPrompt = await deleteSandboxPrompt(config);
-    } else {
-      // Account is required, throw error if force flag is present and no account is specified
-      logger.log('');
-      logger.error(i18n(`${i18nKey}.failure.noAccount`));
-      process.exit(EXIT_CODES.ERROR);
+exports.describe = exports.describe = uiBetaTag(i18n(`${i18nKey}.describe`), false);
+exports.handler = async (options) => {
+    await loadAndValidateOptions(options, false);
+    const { account, force } = options;
+    const config = getConfig();
+    trackCommandUsage('sandbox-delete', null);
+    let accountPrompt;
+    if (!account) {
+        if (!force) {
+            accountPrompt = await deleteSandboxPrompt(config);
+        }
+        else {
+            // Account is required, throw error if force flag is present and no account is specified
+            logger.log('');
+            logger.error(i18n(`${i18nKey}.failure.noAccount`));
+            process.exit(EXIT_CODES.ERROR);
+        }
+        if (!accountPrompt) {
+            logger.log('');
+            logger.error(i18n(`${i18nKey}.failure.noSandboxAccounts`));
+            process.exit(EXIT_CODES.ERROR);
+        }
     }
-    if (!accountPrompt) {
-      logger.log('');
-      logger.error(i18n(`${i18nKey}.failure.noSandboxAccounts`));
-      process.exit(EXIT_CODES.ERROR);
+    const sandboxAccountId = getAccountId({
+        account: account || accountPrompt.account,
+    });
+    const isDefaultAccount = sandboxAccountId === getAccountId(config.defaultPortal);
+    const baseUrl = getHubSpotWebsiteOrigin(getValidEnv(getEnv(sandboxAccountId)));
+    let parentAccountId;
+    for (const portal of config.portals) {
+        if (portal.portalId === sandboxAccountId) {
+            if (portal.parentAccountId) {
+                parentAccountId = portal.parentAccountId;
+            }
+            else if (!force) {
+                const parentAccountPrompt = await deleteSandboxPrompt(config, true);
+                parentAccountId = getAccountId({
+                    account: parentAccountPrompt.account,
+                });
+            }
+            else {
+                logger.error(i18n(`${i18nKey}.failure.noParentAccount`));
+                process.exit(EXIT_CODES.ERROR);
+            }
+        }
     }
-  }
-
-  const sandboxAccountId = getAccountId({
-    account: account || accountPrompt.account,
-  });
-  const isDefaultAccount =
-    sandboxAccountId === getAccountId(config.defaultPortal);
-
-  const baseUrl = getHubSpotWebsiteOrigin(
-    getValidEnv(getEnv(sandboxAccountId))
-  );
-
-  let parentAccountId;
-  for (const portal of config.portals) {
-    if (portal.portalId === sandboxAccountId) {
-      if (portal.parentAccountId) {
-        parentAccountId = portal.parentAccountId;
-      } else if (!force) {
-        const parentAccountPrompt = await deleteSandboxPrompt(config, true);
-        parentAccountId = getAccountId({
-          account: parentAccountPrompt.account,
-        });
-      } else {
-        logger.error(i18n(`${i18nKey}.failure.noParentAccount`));
+    const url = `${baseUrl}/sandboxes/${parentAccountId}`;
+    const command = `hs auth ${getEnv(sandboxAccountId) === 'qa' ? '--qa' : ''} --account=${parentAccountId}`;
+    if (parentAccountId && !getAccountId({ account: parentAccountId })) {
+        logger.log('');
+        logger.error(i18n(`${i18nKey}.failure.noParentPortalAvailable`, {
+            parentAccountId,
+            url,
+            command,
+        }));
+        logger.log('');
         process.exit(EXIT_CODES.ERROR);
-      }
     }
-  }
-
-  const url = `${baseUrl}/sandboxes/${parentAccountId}`;
-  const command = `hs auth ${
-    getEnv(sandboxAccountId) === 'qa' ? '--qa' : ''
-  } --account=${parentAccountId}`;
-
-  if (parentAccountId && !getAccountId({ account: parentAccountId })) {
-    logger.log('');
-    logger.error(
-      i18n(`${i18nKey}.failure.noParentPortalAvailable`, {
-        parentAccountId,
-        url,
-        command,
-      })
-    );
-    logger.log('');
-    process.exit(EXIT_CODES.ERROR);
-  }
-
-  logger.debug(
-    i18n(`${i18nKey}.debug.deleting`, {
-      account: uiAccountDescription(sandboxAccountId),
-    })
-  );
-
-  if (isDefaultAccount) {
-    logger.info(
-      i18n(`${i18nKey}.defaultAccountWarning`, {
+    logger.debug(i18n(`${i18nKey}.debug.deleting`, {
         account: uiAccountDescription(sandboxAccountId),
-      })
-    );
-    logger.log('');
-  }
-
-  try {
-    if (!force) {
-      const { confirmSandboxDeletePrompt: confirmed } = await promptUser([
-        {
-          name: 'confirmSandboxDeletePrompt',
-          type: 'confirm',
-          message: i18n(`${i18nKey}.confirm`, {
+    }));
+    if (isDefaultAccount) {
+        logger.info(i18n(`${i18nKey}.defaultAccountWarning`, {
             account: uiAccountDescription(sandboxAccountId),
-          }),
-        },
-      ]);
-      if (!confirmed) {
-        process.exit(EXIT_CODES.SUCCESS);
-      }
+        }));
+        logger.log('');
     }
-
-    await deleteSandbox(parentAccountId, sandboxAccountId);
-
-    const deleteKey = isDefaultAccount
-      ? `${i18nKey}.success.deleteDefault`
-      : `${i18nKey}.success.delete`;
-    logger.log('');
-    logger.success(
-      i18n(deleteKey, {
-        account: account || accountPrompt.account,
-        sandboxHubId: sandboxAccountId,
-      })
-    );
-    logger.log('');
-
-    const promptDefaultAccount = removeSandboxAccountFromConfig(
-      sandboxAccountId
-    );
-    if (promptDefaultAccount && !force) {
-      await selectAndSetAsDefaultAccountPrompt(getConfig());
-    } else {
-      // If force is specified, skip prompt and set the parent account id as the default account
-      updateDefaultAccount(parentAccountId);
+    try {
+        if (!force) {
+            const { confirmSandboxDeletePrompt: confirmed } = await promptUser([
+                {
+                    name: 'confirmSandboxDeletePrompt',
+                    type: 'confirm',
+                    message: i18n(`${i18nKey}.confirm`, {
+                        account: uiAccountDescription(sandboxAccountId),
+                    }),
+                },
+            ]);
+            if (!confirmed) {
+                process.exit(EXIT_CODES.SUCCESS);
+            }
+        }
+        await deleteSandbox(parentAccountId, sandboxAccountId);
+        const deleteKey = isDefaultAccount
+            ? `${i18nKey}.success.deleteDefault`
+            : `${i18nKey}.success.delete`;
+        logger.log('');
+        logger.success(i18n(deleteKey, {
+            account: account || accountPrompt.account,
+            sandboxHubId: sandboxAccountId,
+        }));
+        logger.log('');
+        const promptDefaultAccount = removeSandboxAccountFromConfig(sandboxAccountId);
+        if (promptDefaultAccount && !force) {
+            await selectAndSetAsDefaultAccountPrompt(getConfig());
+        }
+        else {
+            // If force is specified, skip prompt and set the parent account id as the default account
+            updateDefaultAccount(parentAccountId);
+        }
+        process.exit(EXIT_CODES.SUCCESS);
     }
-    process.exit(EXIT_CODES.SUCCESS);
-  } catch (err) {
-    debugError(err);
-
-    if (isSpecifiedError(err, { statusCode: 401 })) {
-      // Intercept invalid key error
-      // This command uses the parent portal PAK to delete a sandbox, so we must specify which account needs a new key
-      logger.log('');
-      logger.error(
-        i18n(`${i18nKey}.failure.invalidKey`, {
-          account: uiAccountDescription(parentAccountId),
-        })
-      );
-    } else if (
-      isSpecifiedError(err, {
-        statusCode: 403,
-        category: 'BANNED',
-        subCategory: 'SandboxErrors.USER_ACCESS_NOT_ALLOWED',
-      })
-    ) {
-      logger.log('');
-      logger.error(
-        i18n(`${i18nKey}.failure.invalidUser`, {
-          accountName: uiAccountDescription(sandboxAccountId),
-          parentAccountName: uiAccountDescription(parentAccountId),
-        })
-      );
-      logger.log('');
-    } else if (
-      isSpecifiedError(err, {
-        statusCode: 404,
-        category: 'OBJECT_NOT_FOUND',
-        subCategory: 'SandboxErrors.SANDBOX_NOT_FOUND',
-      })
-    ) {
-      logger.log('');
-      logger.warn(
-        i18n(`${i18nKey}.failure.objectNotFound`, {
-          account: uiAccountDescription(sandboxAccountId),
-        })
-      );
-      logger.log('');
-
-      const promptDefaultAccount = removeSandboxAccountFromConfig(
-        sandboxAccountId
-      );
-      if (promptDefaultAccount && !force) {
-        await selectAndSetAsDefaultAccountPrompt(getConfig());
-      } else {
-        // If force is specified, skip prompt and set the parent account id as the default account
-        updateDefaultAccount(parentAccountId);
-      }
-      process.exit(EXIT_CODES.SUCCESS);
-    } else {
-      logError(err);
+    catch (err) {
+        debugError(err);
+        if (isSpecifiedError(err, { statusCode: 401 })) {
+            // Intercept invalid key error
+            // This command uses the parent portal PAK to delete a sandbox, so we must specify which account needs a new key
+            logger.log('');
+            logger.error(i18n(`${i18nKey}.failure.invalidKey`, {
+                account: uiAccountDescription(parentAccountId),
+            }));
+        }
+        else if (isSpecifiedError(err, {
+            statusCode: 403,
+            category: 'BANNED',
+            subCategory: 'SandboxErrors.USER_ACCESS_NOT_ALLOWED',
+        })) {
+            logger.log('');
+            logger.error(i18n(`${i18nKey}.failure.invalidUser`, {
+                accountName: uiAccountDescription(sandboxAccountId),
+                parentAccountName: uiAccountDescription(parentAccountId),
+            }));
+            logger.log('');
+        }
+        else if (isSpecifiedError(err, {
+            statusCode: 404,
+            category: 'OBJECT_NOT_FOUND',
+            subCategory: 'SandboxErrors.SANDBOX_NOT_FOUND',
+        })) {
+            logger.log('');
+            logger.warn(i18n(`${i18nKey}.failure.objectNotFound`, {
+                account: uiAccountDescription(sandboxAccountId),
+            }));
+            logger.log('');
+            const promptDefaultAccount = removeSandboxAccountFromConfig(sandboxAccountId);
+            if (promptDefaultAccount && !force) {
+                await selectAndSetAsDefaultAccountPrompt(getConfig());
+            }
+            else {
+                // If force is specified, skip prompt and set the parent account id as the default account
+                updateDefaultAccount(parentAccountId);
+            }
+            process.exit(EXIT_CODES.SUCCESS);
+        }
+        else {
+            logError(err);
+        }
+        process.exit(EXIT_CODES.ERROR);
     }
-    process.exit(EXIT_CODES.ERROR);
-  }
 };
-
 exports.builder = yargs => {
-  yargs.option('account', {
-    describe: i18n(`${i18nKey}.options.account.describe`),
-    type: 'string',
-  });
-  yargs.option('f', {
-    type: 'boolean',
-    alias: 'force',
-    describe: i18n(`${i18nKey}.examples.force`),
-  });
-
-  yargs.example([
-    [
-      '$0 sandbox delete --account=MySandboxAccount',
-      i18n(`${i18nKey}.examples.default`),
-    ],
-  ]);
-
-  addConfigOptions(yargs);
-  addAccountOptions(yargs);
-  addUseEnvironmentOptions(yargs);
-  addTestingOptions(yargs);
-
-  return yargs;
+    yargs.option('account', {
+        describe: i18n(`${i18nKey}.options.account.describe`),
+        type: 'string',
+    });
+    yargs.option('f', {
+        type: 'boolean',
+        alias: 'force',
+        describe: i18n(`${i18nKey}.examples.force`),
+    });
+    yargs.example([
+        [
+            '$0 sandbox delete --account=MySandboxAccount',
+            i18n(`${i18nKey}.examples.default`),
+        ],
+    ]);
+    addConfigOptions(yargs);
+    addAccountOptions(yargs);
+    addUseEnvironmentOptions(yargs);
+    addTestingOptions(yargs);
+    return yargs;
 };

package/commands/sandbox.d.ts

@@ -0,0 +1,3 @@
+export const command: "sandbox";
+export const describe: string | undefined;
+export function builder(yargs: any): any;

package/commands/sandbox.js

@@ -1,22 +1,18 @@
+"use strict";
 const { addConfigOptions, addAccountOptions } = require('../lib/commonOpts');
 const { i18n } = require('../lib/lang');
 const { uiBetaTag } = require('../lib/ui');
 const create = require('./sandbox/create');
 const del = require('./sandbox/delete');
-
 const i18nKey = 'commands.sandbox';
-
 exports.command = 'sandbox';
 exports.describe = uiBetaTag(i18n(`${i18nKey}.describe`), false);
-
 exports.builder = yargs => {
-  addConfigOptions(yargs);
-  addAccountOptions(yargs);
-
-  yargs
-    .command(create)
-    .command(del)
-    .demandCommand(1, '');
-
-  return yargs;
+    addConfigOptions(yargs);
+    addAccountOptions(yargs);
+    yargs
+        .command(create)
+        .command(del)
+        .demandCommand(1, '');
+    return yargs;
 };

package/commands/secrets/addSecret.d.ts

@@ -0,0 +1,4 @@
+export const command: "add <name>";
+export const describe: any;
+export function handler(options: any): Promise<void>;
+export function builder(yargs: any): any;

package/commands/secrets/addSecret.js

@@ -1,66 +1,46 @@
+"use strict";
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { logError, ApiErrorContext } = require('../../lib/errorHandlers/index');
 const { addSecret } = require('@hubspot/local-dev-lib/api/secrets');
-
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { trackCommandUsage } = require('../../lib/usageTracking');
-
-const {
-  addConfigOptions,
-  addAccountOptions,
-  addUseEnvironmentOptions,
-  getAccountId,
-} = require('../../lib/commonOpts');
+const { addConfigOptions, addAccountOptions, addUseEnvironmentOptions, getAccountId, } = require('../../lib/commonOpts');
 const { uiAccountDescription } = require('../../lib/ui');
 const { secretValuePrompt } = require('../../lib/prompts/secretPrompt');
 const { i18n } = require('../../lib/lang');
-
 const i18nKey = 'commands.secrets.subcommands.add';
-
 exports.command = 'add <name>';
 exports.describe = i18n(`${i18nKey}.describe`);
-
-exports.handler = async options => {
-  const { name: secretName } = options;
-
-  await loadAndValidateOptions(options);
-
-  const accountId = getAccountId(options);
-  trackCommandUsage('secrets-add', null, accountId);
-
-  try {
-    const { secretValue } = await secretValuePrompt();
-
-    await addSecret(accountId, secretName, secretValue);
-    logger.success(
-      i18n(`${i18nKey}.success.add`, {
-        accountIdentifier: uiAccountDescription(accountId),
-        secretName,
-      })
-    );
-  } catch (err) {
-    logger.error(
-      i18n(`${i18nKey}.errors.add`, {
-        secretName,
-      })
-    );
-    logError(
-      err,
-      new ApiErrorContext({
-        request: 'add secret',
-        accountId,
-      })
-    );
-  }
+exports.handler = async (options) => {
+    const { name: secretName } = options;
+    await loadAndValidateOptions(options);
+    const accountId = getAccountId(options);
+    trackCommandUsage('secrets-add', null, accountId);
+    try {
+        const { secretValue } = await secretValuePrompt();
+        await addSecret(accountId, secretName, secretValue);
+        logger.success(i18n(`${i18nKey}.success.add`, {
+            accountIdentifier: uiAccountDescription(accountId),
+            secretName,
+        }));
+    }
+    catch (err) {
+        logger.error(i18n(`${i18nKey}.errors.add`, {
+            secretName,
+        }));
+        logError(err, new ApiErrorContext({
+            request: 'add secret',
+            accountId,
+        }));
+    }
 };
-
 exports.builder = yargs => {
-  addConfigOptions(yargs);
-  addAccountOptions(yargs);
-  addUseEnvironmentOptions(yargs);
-  yargs.positional('name', {
-    describe: i18n(`${i18nKey}.positionals.name.describe`),
-    type: 'string',
-  });
-  return yargs;
+    addConfigOptions(yargs);
+    addAccountOptions(yargs);
+    addUseEnvironmentOptions(yargs);
+    yargs.positional('name', {
+        describe: i18n(`${i18nKey}.positionals.name.describe`),
+        type: 'string',
+    });
+    return yargs;
 };

package/commands/secrets/deleteSecret.d.ts

@@ -0,0 +1,4 @@
+export const command: "delete <name>";
+export const describe: any;
+export function handler(options: any): Promise<void>;
+export function builder(yargs: any): any;

package/commands/secrets/deleteSecret.js

@@ -1,63 +1,44 @@
+"use strict";
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { ApiErrorContext, logError } = require('../../lib/errorHandlers/index');
 const { deleteSecret } = require('@hubspot/local-dev-lib/api/secrets');
-
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 const { uiAccountDescription } = require('../../lib/ui');
-
-const {
-  addConfigOptions,
-  addAccountOptions,
-  addUseEnvironmentOptions,
-  getAccountId,
-} = require('../../lib/commonOpts');
+const { addConfigOptions, addAccountOptions, addUseEnvironmentOptions, getAccountId, } = require('../../lib/commonOpts');
 const { i18n } = require('../../lib/lang');
-
 const i18nKey = 'commands.secrets.subcommands.delete';
-
 exports.command = 'delete <name>';
 exports.describe = i18n(`${i18nKey}.describe`);
-
-exports.handler = async options => {
-  const { name: secretName } = options;
-
-  await loadAndValidateOptions(options);
-
-  const accountId = getAccountId(options);
-  trackCommandUsage('secrets-delete', null, accountId);
-
-  try {
-    await deleteSecret(accountId, secretName);
-    logger.success(
-      i18n(`${i18nKey}.success.delete`, {
-        accountIdentifier: uiAccountDescription(accountId),
-        secretName,
-      })
-    );
-  } catch (err) {
-    logger.error(
-      i18n(`${i18nKey}.errors.delete`, {
-        secretName,
-      })
-    );
-    logError(
-      err,
-      new ApiErrorContext({
-        request: 'delete a secret',
-        accountId,
-      })
-    );
-  }
+exports.handler = async (options) => {
+    const { name: secretName } = options;
+    await loadAndValidateOptions(options);
+    const accountId = getAccountId(options);
+    trackCommandUsage('secrets-delete', null, accountId);
+    try {
+        await deleteSecret(accountId, secretName);
+        logger.success(i18n(`${i18nKey}.success.delete`, {
+            accountIdentifier: uiAccountDescription(accountId),
+            secretName,
+        }));
+    }
+    catch (err) {
+        logger.error(i18n(`${i18nKey}.errors.delete`, {
+            secretName,
+        }));
+        logError(err, new ApiErrorContext({
+            request: 'delete a secret',
+            accountId,
+        }));
+    }
 };
-
 exports.builder = yargs => {
-  addConfigOptions(yargs);
-  addAccountOptions(yargs);
-  addUseEnvironmentOptions(yargs);
-  yargs.positional('name', {
-    describe: i18n(`${i18nKey}.positionals.name.describe`),
-    type: 'string',
-  });
-  return yargs;
+    addConfigOptions(yargs);
+    addAccountOptions(yargs);
+    addUseEnvironmentOptions(yargs);
+    yargs.positional('name', {
+        describe: i18n(`${i18nKey}.positionals.name.describe`),
+        type: 'string',
+    });
+    return yargs;
 };

package/commands/secrets/listSecrets.d.ts

@@ -0,0 +1,4 @@
+export const command: "list";
+export const describe: any;
+export function handler(options: any): Promise<void>;
+export function builder(yargs: any): any;