@hubspot/cli 6.2.0 → 6.2.2-experimental.0

package/lib/accountTypes.d.ts

@@ -0,0 +1,6 @@
+export function isStandardAccount(config: any): any;
+export function isSandbox(config: any): any;
+export function isStandardSandbox(config: any): any;
+export function isDevelopmentSandbox(config: any): any;
+export function isDeveloperTestAccount(config: any): any;
+export function isAppDeveloperAccount(config: any): any;

package/lib/accountTypes.js

@@ -1,34 +1,18 @@
-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);
-
+"use strict";
+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,
+    isStandardAccount,
+    isSandbox,
+    isStandardSandbox,
+    isDevelopmentSandbox,
+    isDeveloperTestAccount,
+    isAppDeveloperAccount,
 };

package/lib/buildAccount.d.ts

@@ -0,0 +1,22 @@
+export function buildNewAccount({ name, accountType, accountConfig, env, portalLimit, force, }: {
+    name: any;
+    accountType: any;
+    accountConfig: any;
+    env: any;
+    portalLimit: any;
+    force?: boolean | undefined;
+}): Promise<{
+    configAccountName: string | undefined;
+    result: import("@hubspot/local-dev-lib/types/developerTestAccounts").DeveloperTestAccount | {
+        sandbox: import("@hubspot/local-dev-lib/types/Sandbox").Sandbox;
+        personalAccessKey: string;
+        name: any;
+    } | undefined;
+}>;
+export function saveAccountToConfig({ env, personalAccessKey, accountName, accountId, force, }: {
+    env: any;
+    personalAccessKey: any;
+    accountName: any;
+    accountId: any;
+    force?: boolean | undefined;
+}): Promise<string | undefined>;

package/lib/buildAccount.js

@@ -1,197 +1,148 @@
-const {
-  getAccessToken,
-  updateConfigWithAccessToken,
-} = require('@hubspot/local-dev-lib/personalAccessKey');
-const {
-  personalAccessKeyPrompt,
-} = require('./prompts/personalAccessKeyPrompt');
-const {
-  accountNameExistsInConfig,
-  updateAccountConfig,
-  writeConfig,
-  getAccountId,
-} = require('@hubspot/local-dev-lib/config');
+"use strict";
+const { getAccessToken, updateConfigWithAccessToken, } = require('@hubspot/local-dev-lib/personalAccessKey');
+const { personalAccessKeyPrompt, } = require('./prompts/personalAccessKeyPrompt');
+const { accountNameExistsInConfig, updateAccountConfig, writeConfig, getAccountId, } = require('@hubspot/local-dev-lib/config');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { i18n } = require('./lang');
 const { cliAccountNamePrompt } = require('./prompts/accountNamePrompt');
 const SpinniesManager = require('./ui/SpinniesManager');
 const { debugError, logError } = require('./errorHandlers/index');
-const {
-  createDeveloperTestAccount,
-} = require('@hubspot/local-dev-lib/api/developerTestAccounts');
-const {
-  HUBSPOT_ACCOUNT_TYPES,
-} = require('@hubspot/local-dev-lib/constants/config');
+const { createDeveloperTestAccount, } = require('@hubspot/local-dev-lib/api/developerTestAccounts');
+const { HUBSPOT_ACCOUNT_TYPES, } = require('@hubspot/local-dev-lib/constants/config');
 const { createSandbox } = require('@hubspot/local-dev-lib/api/sandboxHubs');
 const { sandboxApiTypeMap, handleSandboxCreateError } = require('./sandboxes');
-const {
-  handleDeveloperTestAccountCreateError,
-} = require('./developerTestAccounts');
-
-async function saveAccountToConfig({
-  env,
-  personalAccessKey,
-  accountName,
-  accountId,
-  force = false,
-}) {
-  if (!personalAccessKey) {
-    const configData = await personalAccessKeyPrompt({
-      env,
-      account: accountId,
-    });
-    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 = accountName
-      .toLowerCase()
-      .split(' ')
-      .join('-');
-    validName = nameForConfig;
-    const invalidAccountName = accountNameExistsInConfig(nameForConfig);
-    if (invalidAccountName) {
-      if (!force) {
-        logger.log('');
-        logger.warn(
-          i18n(`lib.prompts.accountNamePrompt.errors.accountNameExists`, {
-            name: nameForConfig,
-          })
-        );
-        const { name: promptName } = await cliAccountNamePrompt(
-          nameForConfig + `_${accountId}`
-        );
-        validName = promptName;
-      } else {
-        // Basic invalid name handling when force flag is passed
-        validName = nameForConfig + `_${accountId}`;
-      }
-    }
-  }
-
-  updateAccountConfig({
-    ...updatedConfig,
-    environment: updatedConfig.env,
-    tokenInfo: updatedConfig.auth.tokenInfo,
-    name: validName,
-  });
-  writeConfig();
-
-  logger.log('');
-  return validName;
-}
-
-async function buildNewAccount({
-  name,
-  accountType,
-  accountConfig,
-  env,
-  portalLimit, // Used only for developer test accounts
-  force = false,
-}) {
-  SpinniesManager.init({
-    succeedColor: 'white',
-  });
-  const accountId = getAccountId(accountConfig.portalId);
-  const isSandbox =
-    accountType === HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX ||
-    accountType === HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX;
-  const isDeveloperTestAccount =
-    accountType === HUBSPOT_ACCOUNT_TYPES.DEVELOPER_TEST;
-
-  let result;
-  let spinniesI18nKey;
-  if (isSandbox) {
-    if (accountType === HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX) {
-      spinniesI18nKey = 'lib.sandbox.create.loading.standard';
+const { handleDeveloperTestAccountCreateError, } = require('./developerTestAccounts');
+async function saveAccountToConfig({ env, personalAccessKey, accountName, accountId, force = false, }) {
+    if (!personalAccessKey) {
+        const configData = await personalAccessKeyPrompt({
+            env,
+            account: accountId,
+        });
+        personalAccessKey = configData.personalAccessKey;
     }
-    if (accountType === HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX) {
-      spinniesI18nKey = 'lib.sandbox.create.loading.developer';
-    }
-  } else if (isDeveloperTestAccount) {
-    spinniesI18nKey = 'lib.developerTestAccount.create.loading';
-  }
-
-  logger.log('');
-  SpinniesManager.add('buildNewAccount', {
-    text: i18n(`${spinniesI18nKey}.add`, {
-      accountName: name,
-    }),
-  });
-
-  let resultAccountId;
-  try {
-    if (isSandbox) {
-      const sandboxApiType = sandboxApiTypeMap[accountType]; // API expects sandbox type as 1 or 2.
-
-      const { data } = await createSandbox(accountId, name, sandboxApiType);
-      result = { name, ...data };
-      resultAccountId = result.sandbox.sandboxHubId;
-    } else if (isDeveloperTestAccount) {
-      const { data } = await createDeveloperTestAccount(accountId, name);
-      result = data;
-      resultAccountId = result.id;
+    const token = await getAccessToken(personalAccessKey, env);
+    const updatedConfig = await updateConfigWithAccessToken(token, personalAccessKey, env);
+    let validName = updatedConfig.name;
+    if (!updatedConfig.name) {
+        const nameForConfig = accountName
+            .toLowerCase()
+            .split(' ')
+            .join('-');
+        validName = nameForConfig;
+        const invalidAccountName = accountNameExistsInConfig(nameForConfig);
+        if (invalidAccountName) {
+            if (!force) {
+                logger.log('');
+                logger.warn(i18n(`lib.prompts.accountNamePrompt.errors.accountNameExists`, {
+                    name: nameForConfig,
+                }));
+                const { name: promptName } = await cliAccountNamePrompt(nameForConfig + `_${accountId}`);
+                validName = promptName;
+            }
+            else {
+                // Basic invalid name handling when force flag is passed
+                validName = nameForConfig + `_${accountId}`;
+            }
+        }
     }
-
-    SpinniesManager.succeed('buildNewAccount', {
-      text: i18n(`${spinniesI18nKey}.succeed`, {
-        accountName: name,
-        accountId: resultAccountId,
-      }),
+    updateAccountConfig({
+        ...updatedConfig,
+        environment: updatedConfig.env,
+        tokenInfo: updatedConfig.auth.tokenInfo,
+        name: validName,
     });
-  } catch (err) {
-    debugError(err);
-
-    SpinniesManager.fail('buildNewAccount', {
-      text: i18n(`${spinniesI18nKey}.fail`, {
-        accountName: name,
-      }),
+    writeConfig();
+    logger.log('');
+    return validName;
+}
+async function buildNewAccount({ name, accountType, accountConfig, env, portalLimit, // Used only for developer test accounts
+force = false, }) {
+    SpinniesManager.init({
+        succeedColor: 'white',
     });
-
+    const accountId = getAccountId(accountConfig.portalId);
+    const isSandbox = accountType === HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX ||
+        accountType === HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX;
+    const isDeveloperTestAccount = accountType === HUBSPOT_ACCOUNT_TYPES.DEVELOPER_TEST;
+    let result;
+    let spinniesI18nKey;
     if (isSandbox) {
-      handleSandboxCreateError({ err, env, accountConfig, name, accountId });
+        if (accountType === HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX) {
+            spinniesI18nKey = 'lib.sandbox.create.loading.standard';
+        }
+        if (accountType === HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX) {
+            spinniesI18nKey = 'lib.sandbox.create.loading.developer';
+        }
     }
-    if (isDeveloperTestAccount) {
-      handleDeveloperTestAccountCreateError({
-        err,
-        env,
-        accountId,
-        portalLimit,
-      });
+    else if (isDeveloperTestAccount) {
+        spinniesI18nKey = 'lib.developerTestAccount.create.loading';
     }
-  }
-
-  let configAccountName;
-
-  try {
-    // Response contains PAK, save to config here
-    configAccountName = await saveAccountToConfig({
-      env,
-      personalAccessKey: result.personalAccessKey,
-      accountName: name,
-      accountId: resultAccountId,
-      force,
+    logger.log('');
+    SpinniesManager.add('buildNewAccount', {
+        text: i18n(`${spinniesI18nKey}.add`, {
+            accountName: name,
+        }),
     });
-  } catch (err) {
-    logError(err);
-    throw err;
-  }
-
-  return {
-    configAccountName,
-    result,
-  };
+    let resultAccountId;
+    try {
+        if (isSandbox) {
+            const sandboxApiType = sandboxApiTypeMap[accountType]; // API expects sandbox type as 1 or 2.
+            const { data } = await createSandbox(accountId, name, sandboxApiType);
+            result = { name, ...data };
+            resultAccountId = result.sandbox.sandboxHubId;
+        }
+        else if (isDeveloperTestAccount) {
+            const { data } = await createDeveloperTestAccount(accountId, name);
+            result = data;
+            resultAccountId = result.id;
+        }
+        SpinniesManager.succeed('buildNewAccount', {
+            text: i18n(`${spinniesI18nKey}.succeed`, {
+                accountName: name,
+                accountId: resultAccountId,
+            }),
+        });
+    }
+    catch (err) {
+        debugError(err);
+        SpinniesManager.fail('buildNewAccount', {
+            text: i18n(`${spinniesI18nKey}.fail`, {
+                accountName: name,
+            }),
+        });
+        if (isSandbox) {
+            handleSandboxCreateError({ err, env, accountConfig, name, accountId });
+        }
+        if (isDeveloperTestAccount) {
+            handleDeveloperTestAccountCreateError({
+                err,
+                env,
+                accountId,
+                portalLimit,
+            });
+        }
+    }
+    let configAccountName;
+    try {
+        // Response contains PAK, save to config here
+        configAccountName = await saveAccountToConfig({
+            env,
+            personalAccessKey: result.personalAccessKey,
+            accountName: name,
+            accountId: resultAccountId,
+            force,
+        });
+    }
+    catch (err) {
+        logError(err);
+        throw err;
+    }
+    return {
+        configAccountName,
+        result,
+    };
 }
-
 module.exports = {
-  buildNewAccount,
-  saveAccountToConfig,
+    buildNewAccount,
+    saveAccountToConfig,
 };

package/lib/commonOpts.d.ts

@@ -0,0 +1,20 @@
+export function addAccountOptions(program: any): any;
+export function addConfigOptions(yargs: any): any;
+export function addOverwriteOptions(yargs: any): any;
+export function addModeOptions(yargs: any, { read, write }: {
+    read: any;
+    write: any;
+}): any;
+export function addTestingOptions(yargs: any): any;
+export function addUseEnvironmentOptions(yargs: any): any;
+/**
+ * Get command name from Yargs `argv`
+ * @param {object} argv
+ */
+export function getCommandName(argv: object): any;
+export function getMode(command?: {}): string;
+/**
+ * Obtains accountId using supplied --account flag or from environment variables
+ */
+export function getAccountId(options?: {}): number | null;
+export function setLogLevel(options?: {}): void;

package/lib/commonOpts.js

@@ -1,129 +1,96 @@
-const {
-  LOG_LEVEL,
-  setLogLevel: setLoggerLogLevel,
-} = require('@hubspot/local-dev-lib/logger');
-const {
-  DEFAULT_MODE,
-  MODE,
-} = require('@hubspot/local-dev-lib/constants/files');
-const {
-  getAccountId: getAccountIdFromConfig,
-  getAccountConfig,
-  getAndLoadConfigIfNeeded,
-} = require('@hubspot/local-dev-lib/config');
+"use strict";
+const { LOG_LEVEL, setLogLevel: setLoggerLogLevel, } = require('@hubspot/local-dev-lib/logger');
+const { DEFAULT_MODE, MODE, } = require('@hubspot/local-dev-lib/constants/files');
+const { getAccountId: getAccountIdFromConfig, getAccountConfig, getAndLoadConfigIfNeeded, } = require('@hubspot/local-dev-lib/config');
 const { i18n } = require('./lang');
-
 const i18nKey = 'lib.commonOpts';
-
-const addAccountOptions = program =>
-  program.option('portal', {
+const addAccountOptions = program => program.option('portal', {
     alias: ['p', 'account', 'a'],
     describe: i18n(`${i18nKey}.options.portal.describe`),
     type: 'string',
-  });
-
-const addConfigOptions = yargs =>
-  yargs.option('config', {
+});
+const addConfigOptions = yargs => yargs.option('config', {
     alias: 'c',
     describe: i18n(`${i18nKey}.options.config.describe`),
     type: 'string',
-  });
-
-const addOverwriteOptions = yargs =>
-  yargs.option('overwrite', {
+});
+const addOverwriteOptions = yargs => yargs.option('overwrite', {
     alias: 'o',
     describe: i18n(`${i18nKey}.options.overwrite.describe`),
     type: 'boolean',
     default: false,
-  });
-
+});
 const addModeOptions = (yargs, { read, write }) => {
-  const modes = `<${Object.values(MODE).join(' | ')}>`;
-
-  return yargs.option('mode', {
-    alias: 'm',
-    describe: i18n(
-      `${i18nKey}.options.modes.describe.${
-        read ? 'read' : write ? 'write' : 'default'
-      }`,
-      { modes }
-    ),
-    type: 'string',
-  });
+    const modes = `<${Object.values(MODE).join(' | ')}>`;
+    return yargs.option('mode', {
+        alias: 'm',
+        describe: i18n(`${i18nKey}.options.modes.describe.${read ? 'read' : write ? 'write' : 'default'}`, { modes }),
+        type: 'string',
+    });
 };
-
-const addTestingOptions = yargs =>
-  yargs.option('qa', {
+const addTestingOptions = yargs => yargs.option('qa', {
     describe: i18n(`${i18nKey}.options.qa.describe`),
     type: 'boolean',
     default: false,
     hidden: true,
-  });
-
-const addUseEnvironmentOptions = yargs =>
-  yargs.option('use-env', {
+});
+const addUseEnvironmentOptions = yargs => yargs.option('use-env', {
     describe: i18n(`${i18nKey}.options.useEnv.describe`),
     type: 'boolean',
     default: false,
-  });
-
+});
 const setLogLevel = (options = {}) => {
-  const { debug } = options;
-  if (debug) {
-    setLoggerLogLevel(LOG_LEVEL.DEBUG);
-  } else {
-    setLoggerLogLevel(LOG_LEVEL.LOG);
-  }
+    const { debug } = options;
+    if (debug) {
+        setLoggerLogLevel(LOG_LEVEL.DEBUG);
+    }
+    else {
+        setLoggerLogLevel(LOG_LEVEL.LOG);
+    }
 };
-
 /**
  * Get command name from Yargs `argv`
  * @param {object} argv
  */
 const getCommandName = argv => (argv && argv._ && argv._[0]) || '';
-
 /**
  * Obtains accountId using supplied --account flag or from environment variables
  */
 const getAccountId = (options = {}) => {
-  const { portal, account } = options;
-
-  if (options.useEnv && process.env.HUBSPOT_PORTAL_ID) {
-    return parseInt(process.env.HUBSPOT_PORTAL_ID, 10);
-  }
-
-  return getAccountIdFromConfig(portal || account);
+    const { portal, account } = options;
+    if (options.useEnv && process.env.HUBSPOT_PORTAL_ID) {
+        return parseInt(process.env.HUBSPOT_PORTAL_ID, 10);
+    }
+    return getAccountIdFromConfig(portal || account);
 };
-
 const getMode = (command = {}) => {
-  // 1. --mode
-  const { mode } = command;
-  if (mode && typeof mode === 'string') {
-    return mode.toLowerCase();
-  }
-  // 2. config[portal].defaultMode
-  const accountId = getAccountId(command);
-  if (accountId) {
-    const accountConfig = getAccountConfig(accountId);
-    if (accountConfig && accountConfig.defaultMode) {
-      return accountConfig.defaultMode;
+    // 1. --mode
+    const { mode } = command;
+    if (mode && typeof mode === 'string') {
+        return mode.toLowerCase();
+    }
+    // 2. config[portal].defaultMode
+    const accountId = getAccountId(command);
+    if (accountId) {
+        const accountConfig = getAccountConfig(accountId);
+        if (accountConfig && accountConfig.defaultMode) {
+            return accountConfig.defaultMode;
+        }
     }
-  }
-  // 3. config.defaultMode
-  // 4. DEFAULT_MODE
-  const config = getAndLoadConfigIfNeeded();
-  return (config && config.defaultMode) || DEFAULT_MODE;
+    // 3. config.defaultMode
+    // 4. DEFAULT_MODE
+    const config = getAndLoadConfigIfNeeded();
+    return (config && config.defaultMode) || DEFAULT_MODE;
 };
-
 module.exports = {
-  addAccountOptions,
-  addConfigOptions,
-  addOverwriteOptions,
-  addModeOptions,
-  addTestingOptions,
-  addUseEnvironmentOptions,
-  getCommandName,
-  getMode,
-  getAccountId,
-  setLogLevel,
+    addAccountOptions,
+    addConfigOptions,
+    addOverwriteOptions,
+    addModeOptions,
+    addTestingOptions,
+    addUseEnvironmentOptions,
+    getCommandName,
+    getMode,
+    getAccountId,
+    setLogLevel,
 };