@hubspot/cli 6.2.0 → 6.2.2-experimental.0

package/lib/prompts/secretPrompt.js

@@ -1,25 +1,22 @@
+"use strict";
 const { promptUser } = require('./promptUtils');
 const { i18n } = require('../lang');
-
 const i18nKey = 'lib.prompts.secretPrompt';
-
 const SECRET_VALUE_PROMPT = {
-  name: 'secretValue',
-  type: 'password',
-  mask: '*',
-  message: i18n(`${i18nKey}.enterValue`),
-  validate(val) {
-    if (typeof val !== 'string') {
-      return i18n(`${i18nKey}.errors.invalidValue`);
-    }
-    return true;
-  },
+    name: 'secretValue',
+    type: 'password',
+    mask: '*',
+    message: i18n(`${i18nKey}.enterValue`),
+    validate(val) {
+        if (typeof val !== 'string') {
+            return i18n(`${i18nKey}.errors.invalidValue`);
+        }
+        return true;
+    },
 };
-
 function secretValuePrompt() {
-  return promptUser([SECRET_VALUE_PROMPT]);
+    return promptUser([SECRET_VALUE_PROMPT]);
 }
-
 module.exports = {
-  secretValuePrompt,
+    secretValuePrompt,
 };

package/lib/prompts/selectPublicAppPrompt.d.ts

@@ -0,0 +1,5 @@
+export function selectPublicAppPrompt({ accountId, accountName, isMigratingApp, }: {
+    accountId: any;
+    accountName: any;
+    isMigratingApp?: boolean | undefined;
+}): Promise<any>;

package/lib/prompts/selectPublicAppPrompt.js

@@ -1,93 +1,67 @@
+"use strict";
 const { promptUser } = require('./promptUtils');
 const { i18n } = require('../lang');
 const { uiLine } = require('../ui');
 const { logError } = require('../errorHandlers/index');
 const { logger } = require('@hubspot/local-dev-lib/logger');
-const {
-  fetchPublicAppsForPortal,
-} = require('@hubspot/local-dev-lib/api/appsDev');
+const { fetchPublicAppsForPortal, } = require('@hubspot/local-dev-lib/api/appsDev');
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
-
 const i18nKey = 'lib.prompts.selectPublicAppPrompt';
-
-const fetchPublicAppOptions = async (
-  accountId,
-  accountName,
-  isMigratingApp = false
-) => {
-  try {
-    const { data: publicApps } = await fetchPublicAppsForPortal(accountId);
-    const filteredPublicApps = publicApps.filter(
-      app => !app.projectId && !app.sourceId
-    );
-
-    if (
-      !filteredPublicApps.length ||
-      (isMigratingApp &&
-        !filteredPublicApps.some(
-          app => !app.preventProjectMigrations || !app.listingInfo
-        ))
-    ) {
-      const headerTranslationKey = isMigratingApp
-        ? 'noAppsMigration'
-        : 'noAppsClone';
-      const messageTranslationKey = isMigratingApp
-        ? 'noAppsMigrationMessage'
-        : 'noAppsCloneMessage';
-      uiLine();
-      logger.error(i18n(`${i18nKey}.errors.${headerTranslationKey}`));
-      logger.log(
-        i18n(`${i18nKey}.errors.${messageTranslationKey}`, { accountName })
-      );
-      uiLine();
-      process.exit(EXIT_CODES.SUCCESS);
+const fetchPublicAppOptions = async (accountId, accountName, isMigratingApp = false) => {
+    try {
+        const { data: { results: publicApps }, } = await fetchPublicAppsForPortal(accountId);
+        const filteredPublicApps = publicApps.filter(app => !app.projectId && !app.sourceId);
+        if (!filteredPublicApps.length ||
+            (isMigratingApp &&
+                !filteredPublicApps.some(app => !app.preventProjectMigrations || !app.listingInfo))) {
+            const headerTranslationKey = isMigratingApp
+                ? 'noAppsMigration'
+                : 'noAppsClone';
+            const messageTranslationKey = isMigratingApp
+                ? 'noAppsMigrationMessage'
+                : 'noAppsCloneMessage';
+            uiLine();
+            logger.error(i18n(`${i18nKey}.errors.${headerTranslationKey}`));
+            logger.log(i18n(`${i18nKey}.errors.${messageTranslationKey}`, { accountName }));
+            uiLine();
+            process.exit(EXIT_CODES.SUCCESS);
+        }
+        return filteredPublicApps;
+    }
+    catch (error) {
+        logError(error, { accountId });
+        logger.error(i18n(`${i18nKey}.errors.errorFetchingApps`));
+        process.exit(EXIT_CODES.ERROR);
     }
-    return filteredPublicApps;
-  } catch (error) {
-    logError(error, { accountId });
-    logger.error(i18n(`${i18nKey}.errors.errorFetchingApps`));
-    process.exit(EXIT_CODES.ERROR);
-  }
 };
-
-const selectPublicAppPrompt = async ({
-  accountId,
-  accountName,
-  isMigratingApp = false,
-}) => {
-  const publicApps = await fetchPublicAppOptions(
-    accountId,
-    accountName,
-    isMigratingApp
-  );
-  const translationKey = isMigratingApp
-    ? 'selectAppIdMigrate'
-    : 'selectAppIdClone';
-
-  return promptUser([
-    {
-      name: 'appId',
-      message: i18n(`${i18nKey}.${translationKey}`, {
-        accountName,
-      }),
-      type: 'list',
-      choices: publicApps.map(app => {
-        const { preventProjectMigrations, listingInfo } = app;
-        if (isMigratingApp && preventProjectMigrations && listingInfo) {
-          return {
-            name: `${app.name} (${app.id})`,
-            disabled: i18n(`${i18nKey}.errors.cannotBeMigrated`),
-          };
-        }
-        return {
-          name: `${app.name} (${app.id})`,
-          value: app.id,
-        };
-      }),
-    },
-  ]);
+const selectPublicAppPrompt = async ({ accountId, accountName, isMigratingApp = false, }) => {
+    const publicApps = await fetchPublicAppOptions(accountId, accountName, isMigratingApp);
+    const translationKey = isMigratingApp
+        ? 'selectAppIdMigrate'
+        : 'selectAppIdClone';
+    return promptUser([
+        {
+            name: 'appId',
+            message: i18n(`${i18nKey}.${translationKey}`, {
+                accountName,
+            }),
+            type: 'list',
+            choices: publicApps.map(app => {
+                const { preventProjectMigrations, listingInfo } = app;
+                if (isMigratingApp && preventProjectMigrations && listingInfo) {
+                    return {
+                        name: `${app.name} (${app.id})`,
+                        disabled: i18n(`${i18nKey}.errors.cannotBeMigrated`),
+                    };
+                }
+                return {
+                    name: `${app.name} (${app.id})`,
+                    value: app.id,
+                };
+            }),
+        },
+    ]);
 };
-
 module.exports = {
-  selectPublicAppPrompt,
+    selectPublicAppPrompt,
 };

package/lib/prompts/setAsDefaultAccountPrompt.d.ts

@@ -0,0 +1 @@
+export function setAsDefaultAccountPrompt(accountName: any): Promise<any>;

package/lib/prompts/setAsDefaultAccountPrompt.js

@@ -1,30 +1,23 @@
-const {
-  getConfig,
-  updateDefaultAccount,
-} = require('@hubspot/local-dev-lib/config');
+"use strict";
+const { getConfig, updateDefaultAccount, } = require('@hubspot/local-dev-lib/config');
 const { promptUser } = require('./promptUtils');
 const { i18n } = require('../lang');
-
 const i18nKey = 'lib.prompts.setAsDefaultAccountPrompt';
-
-const setAsDefaultAccountPrompt = async accountName => {
-  const config = getConfig();
-
-  const { setAsDefault } = await promptUser([
-    {
-      name: 'setAsDefault',
-      type: 'confirm',
-      when: config.defaultPortal !== accountName,
-      message: i18n(`${i18nKey}.setAsDefaultAccountMessage`),
-    },
-  ]);
-
-  if (setAsDefault) {
-    updateDefaultAccount(accountName);
-  }
-  return setAsDefault;
+const setAsDefaultAccountPrompt = async (accountName) => {
+    const config = getConfig();
+    const { setAsDefault } = await promptUser([
+        {
+            name: 'setAsDefault',
+            type: 'confirm',
+            when: config.defaultPortal !== accountName,
+            message: i18n(`${i18nKey}.setAsDefaultAccountMessage`),
+        },
+    ]);
+    if (setAsDefault) {
+        updateDefaultAccount(accountName);
+    }
+    return setAsDefault;
 };
-
 module.exports = {
-  setAsDefaultAccountPrompt,
+    setAsDefaultAccountPrompt,
 };

package/lib/prompts/uploadPrompt.d.ts

@@ -0,0 +1 @@
+export function uploadPrompt(promptOptions?: {}): Promise<any>;

package/lib/prompts/uploadPrompt.js

@@ -1,39 +1,37 @@
+"use strict";
 const path = require('path');
 const { getCwd } = require('@hubspot/local-dev-lib/path');
 const { promptUser } = require('./promptUtils');
 const { i18n } = require('../lang');
-
 const i18nKey = 'lib.prompts.uploadPrompt';
-
 const uploadPrompt = (promptOptions = {}) => {
-  return promptUser([
-    {
-      name: 'src',
-      message: i18n(`${i18nKey}.enterSrc`),
-      when: !promptOptions.src,
-      default: '.',
-      validate: input => {
-        if (!input) {
-          return i18n(`${i18nKey}.errors.srcRequired`);
-        }
-        return true;
-      },
-    },
-    {
-      name: 'dest',
-      message: i18n(`${i18nKey}.enterDest`),
-      when: !promptOptions.dest,
-      default: path.basename(getCwd()),
-      validate: input => {
-        if (!input) {
-          return i18n(`${i18nKey}.errors.destRequired`);
-        }
-        return true;
-      },
-    },
-  ]);
+    return promptUser([
+        {
+            name: 'src',
+            message: i18n(`${i18nKey}.enterSrc`),
+            when: !promptOptions.src,
+            default: '.',
+            validate: input => {
+                if (!input) {
+                    return i18n(`${i18nKey}.errors.srcRequired`);
+                }
+                return true;
+            },
+        },
+        {
+            name: 'dest',
+            message: i18n(`${i18nKey}.enterDest`),
+            when: !promptOptions.dest,
+            default: path.basename(getCwd()),
+            validate: input => {
+                if (!input) {
+                    return i18n(`${i18nKey}.errors.destRequired`);
+                }
+                return true;
+            },
+        },
+    ]);
 };
-
 module.exports = {
-  uploadPrompt,
+    uploadPrompt,
 };

package/lib/regex.d.ts

@@ -0,0 +1 @@
+export const STRING_WITH_NO_SPACES_REGEX: RegExp;

package/lib/regex.js

@@ -1,5 +1,5 @@
+"use strict";
 const STRING_WITH_NO_SPACES_REGEX = /^\S*$/;
-
 module.exports = {
-  STRING_WITH_NO_SPACES_REGEX,
+    STRING_WITH_NO_SPACES_REGEX,
 };

package/lib/sandboxSync.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @param {Object} accountConfig - Account config of sandbox portal
+ * @param {Object} parentAccountConfig - Account config of parent portal
+ * @param {String} env - Environment (QA/Prod)
+ * @param {Array} syncTasks - Array of available sync tasks
+ * @returns
+ */
+export function syncSandbox({ accountConfig, parentAccountConfig, env, syncTasks, slimInfoMessage, }: Object): Promise<void>;

package/lib/sandboxSync.js

@@ -1,27 +1,17 @@
+"use strict";
 const SpinniesManager = require('./ui/SpinniesManager');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { i18n } = require('./lang');
 const { getAvailableSyncTypes } = require('./sandboxes');
 const { initiateSync } = require('@hubspot/local-dev-lib/api/sandboxSync');
-const {
-  debugError,
-  logError,
-  ApiErrorContext,
-} = require('./errorHandlers/index');
+const { debugError, logError, ApiErrorContext, } = require('./errorHandlers/index');
 const { isSpecifiedError } = require('@hubspot/local-dev-lib/errors/index');
 const { getSandboxTypeAsString } = require('./sandboxes');
 const { getAccountId } = require('@hubspot/local-dev-lib/config');
-const {
-  uiAccountDescription,
-  uiLine,
-  uiLink,
-  uiCommandDisabledBanner,
-} = require('./ui');
+const { uiAccountDescription, uiLine, uiLink, uiCommandDisabledBanner, } = require('./ui');
 const { isDevelopmentSandbox } = require('./accountTypes');
-
 const i18nKey = 'lib.sandbox.sync';
-
 /**
  * @param {Object} accountConfig - Account config of sandbox portal
  * @param {Object} parentAccountConfig - Account config of parent portal
@@ -29,163 +19,105 @@ const i18nKey = 'lib.sandbox.sync';
  * @param {Array} syncTasks - Array of available sync tasks
  * @returns
  */
-const syncSandbox = async ({
-  accountConfig,
-  parentAccountConfig,
-  env,
-  syncTasks,
-  slimInfoMessage = false,
-}) => {
-  const accountId = getAccountId(accountConfig.portalId);
-  const parentAccountId = getAccountId(parentAccountConfig.portalId);
-  const isDevSandbox = isDevelopmentSandbox(accountConfig);
-  SpinniesManager.init({
-    succeedColor: 'white',
-  });
-  let availableSyncTasks = syncTasks;
-
-  const baseUrl = getHubSpotWebsiteOrigin(env);
-  const syncStatusUrl = `${baseUrl}/sandboxes-developer/${parentAccountId}/${getSandboxTypeAsString(
-    accountConfig.accountType
-  )}`;
-
-  try {
-    // If no sync tasks exist, fetch sync types based on default account. Parent account required for fetch
-    if (
-      !availableSyncTasks ||
-      (typeof availableSyncTasks === 'object' &&
-        availableSyncTasks.length === 0)
-    ) {
-      availableSyncTasks = await getAvailableSyncTypes(
-        parentAccountConfig,
-        accountConfig
-      );
-    }
-
-    SpinniesManager.add('sandboxSync', {
-      text: i18n(`${i18nKey}.loading.startSync`),
+const syncSandbox = async ({ accountConfig, parentAccountConfig, env, syncTasks, slimInfoMessage = false, }) => {
+    const accountId = getAccountId(accountConfig.portalId);
+    const parentAccountId = getAccountId(parentAccountConfig.portalId);
+    const isDevSandbox = isDevelopmentSandbox(accountConfig);
+    SpinniesManager.init({
+        succeedColor: 'white',
     });
-
-    await initiateSync(
-      parentAccountId,
-      accountId,
-      availableSyncTasks,
-      accountId
-    );
-    let spinniesText = isDevSandbox
-      ? `${i18nKey}.loading.succeedDevSb`
-      : `${i18nKey}.loading.succeed`;
-    SpinniesManager.succeed('sandboxSync', {
-      text: i18n(
-        slimInfoMessage ? `${i18nKey}.loading.successDevSbInfo` : spinniesText,
-        {
-          accountName: uiAccountDescription(accountId),
-          url: uiLink(
-            i18n(`${i18nKey}.info.syncStatusDetailsLinkText`),
-            syncStatusUrl
-          ),
+    let availableSyncTasks = syncTasks;
+    const baseUrl = getHubSpotWebsiteOrigin(env);
+    const syncStatusUrl = `${baseUrl}/sandboxes-developer/${parentAccountId}/${getSandboxTypeAsString(accountConfig.accountType)}`;
+    try {
+        // If no sync tasks exist, fetch sync types based on default account. Parent account required for fetch
+        if (!availableSyncTasks ||
+            (typeof availableSyncTasks === 'object' &&
+                availableSyncTasks.length === 0)) {
+            availableSyncTasks = await getAvailableSyncTypes(parentAccountConfig, accountConfig);
         }
-      ),
-    });
-  } catch (err) {
-    debugError(err);
-
-    SpinniesManager.fail('sandboxSync', {
-      text: i18n(`${i18nKey}.loading.fail`),
-    });
-
-    logger.log('');
-    if (
-      isSpecifiedError(err, {
-        statusCode: 403,
-        category: 'BANNED',
-        subCategory: 'sandboxes-sync-api.SYNC_NOT_ALLOWED_INVALID_USER',
-      })
-    ) {
-      logger.error(
-        i18n(`${i18nKey}.failure.invalidUser`, {
-          accountName: uiAccountDescription(accountId),
-          parentAccountName: uiAccountDescription(parentAccountId),
-        })
-      );
-    } else if (
-      isSpecifiedError(err, {
-        statusCode: 429,
-        category: 'RATE_LIMITS',
-        subCategory: 'sandboxes-sync-api.SYNC_IN_PROGRESS',
-      })
-    ) {
-      logger.error(
-        i18n(`${i18nKey}.failure.syncInProgress`, {
-          url: `${baseUrl}/sandboxes-developer/${parentAccountId}/syncactivitylog`,
-        })
-      );
-    } else if (
-      isSpecifiedError(err, {
-        statusCode: 403,
-        category: 'BANNED',
-        subCategory: 'sandboxes-sync-api.SYNC_NOT_ALLOWED_INVALID_USERID',
-      })
-    ) {
-      // This will only trigger if a user is not a super admin of the target account.
-      logger.error(
-        i18n(`${i18nKey}.failure.notSuperAdmin`, {
-          account: uiAccountDescription(accountId),
-        })
-      );
-    } else if (
-      isSpecifiedError(err, {
-        statusCode: 404,
-        category: 'OBJECT_NOT_FOUND',
-        subCategory: 'SandboxErrors.SANDBOX_NOT_FOUND',
-      })
-    ) {
-      logger.error(
-        i18n(`${i18nKey}.failure.objectNotFound`, {
-          account: uiAccountDescription(accountId),
-        })
-      );
-    } else if (
-      isSpecifiedError(err, {
-        statusCode: 404,
-      })
-    ) {
-      uiCommandDisabledBanner(
-        'hs sandbox sync',
-        'https://app.hubspot.com/l/docs/guides/crm/project-cli-commands#developer-projects-cli-commands-beta'
-      );
-    } else {
-      logError(
-        err,
-        new ApiErrorContext({
-          accountId: parentAccountId,
-          request: 'sandbox sync',
-        })
-      );
+        SpinniesManager.add('sandboxSync', {
+            text: i18n(`${i18nKey}.loading.startSync`),
+        });
+        await initiateSync(parentAccountId, accountId, availableSyncTasks, accountId);
+        let spinniesText = isDevSandbox
+            ? `${i18nKey}.loading.succeedDevSb`
+            : `${i18nKey}.loading.succeed`;
+        SpinniesManager.succeed('sandboxSync', {
+            text: i18n(slimInfoMessage ? `${i18nKey}.loading.successDevSbInfo` : spinniesText, {
+                accountName: uiAccountDescription(accountId),
+                url: uiLink(i18n(`${i18nKey}.info.syncStatusDetailsLinkText`), syncStatusUrl),
+            }),
+        });
     }
-    logger.log('');
-    throw err;
-  }
-
-  if (!slimInfoMessage) {
-    logger.log();
-    uiLine();
-    logger.info(
-      i18n(
-        `${i18nKey}.info.${isDevSandbox ? 'syncMessageDevSb' : 'syncMessage'}`,
-        {
-          url: uiLink(
-            i18n(`${i18nKey}.info.syncStatusDetailsLinkText`),
-            syncStatusUrl
-          ),
+    catch (err) {
+        debugError(err);
+        SpinniesManager.fail('sandboxSync', {
+            text: i18n(`${i18nKey}.loading.fail`),
+        });
+        logger.log('');
+        if (isSpecifiedError(err, {
+            statusCode: 403,
+            category: 'BANNED',
+            subCategory: 'sandboxes-sync-api.SYNC_NOT_ALLOWED_INVALID_USER',
+        })) {
+            logger.error(i18n(`${i18nKey}.failure.invalidUser`, {
+                accountName: uiAccountDescription(accountId),
+                parentAccountName: uiAccountDescription(parentAccountId),
+            }));
+        }
+        else if (isSpecifiedError(err, {
+            statusCode: 429,
+            category: 'RATE_LIMITS',
+            subCategory: 'sandboxes-sync-api.SYNC_IN_PROGRESS',
+        })) {
+            logger.error(i18n(`${i18nKey}.failure.syncInProgress`, {
+                url: `${baseUrl}/sandboxes-developer/${parentAccountId}/syncactivitylog`,
+            }));
+        }
+        else if (isSpecifiedError(err, {
+            statusCode: 403,
+            category: 'BANNED',
+            subCategory: 'sandboxes-sync-api.SYNC_NOT_ALLOWED_INVALID_USERID',
+        })) {
+            // This will only trigger if a user is not a super admin of the target account.
+            logger.error(i18n(`${i18nKey}.failure.notSuperAdmin`, {
+                account: uiAccountDescription(accountId),
+            }));
         }
-      )
-    );
-    uiLine();
-    logger.log();
-  }
+        else if (isSpecifiedError(err, {
+            statusCode: 404,
+            category: 'OBJECT_NOT_FOUND',
+            subCategory: 'SandboxErrors.SANDBOX_NOT_FOUND',
+        })) {
+            logger.error(i18n(`${i18nKey}.failure.objectNotFound`, {
+                account: uiAccountDescription(accountId),
+            }));
+        }
+        else if (isSpecifiedError(err, {
+            statusCode: 404,
+        })) {
+            uiCommandDisabledBanner('hs sandbox sync', 'https://app.hubspot.com/l/docs/guides/crm/project-cli-commands#developer-projects-cli-commands-beta');
+        }
+        else {
+            logError(err, new ApiErrorContext({
+                accountId: parentAccountId,
+                request: 'sandbox sync',
+            }));
+        }
+        logger.log('');
+        throw err;
+    }
+    if (!slimInfoMessage) {
+        logger.log();
+        uiLine();
+        logger.info(i18n(`${i18nKey}.info.${isDevSandbox ? 'syncMessageDevSb' : 'syncMessage'}`, {
+            url: uiLink(i18n(`${i18nKey}.info.syncStatusDetailsLinkText`), syncStatusUrl),
+        }));
+        uiLine();
+        logger.log();
+    }
 };
-
 module.exports = {
-  syncSandbox,
+    syncSandbox,
 };

package/lib/sandboxes.d.ts

@@ -0,0 +1,40 @@
+export namespace sandboxTypeMap {
+    let dev: "DEVELOPMENT_SANDBOX";
+    let developer: "DEVELOPMENT_SANDBOX";
+    let development: "DEVELOPMENT_SANDBOX";
+    let standard: "STANDARD_SANDBOX";
+}
+export namespace sandboxApiTypeMap {
+    let STANDARD_SANDBOX: number;
+    let DEVELOPMENT_SANDBOX: number;
+}
+export namespace syncTypes {
+    let OBJECT_RECORDS: string;
+}
+export function getSandboxTypeAsString(accountType: any): "development" | "standard";
+export function getHasSandboxesByType(parentAccountConfig: any, type: any): boolean;
+export function getSandboxLimit(error: any): number;
+/**
+ * @param {Object} accountConfig - Account config of sandbox portal
+ * @param {String} sandboxType - Sandbox type for limit validation
+ * @param {String} env - Environment
+ * @returns {null}
+ */
+export function validateSandboxUsageLimits(accountConfig: Object, sandboxType: string, env: string): null;
+export function getAvailableSyncTypes(parentAccountConfig: any, config: any): Promise<{
+    type: string;
+}[]>;
+/**
+ * @param {Object} accountConfig - Account config of sandbox portal
+ * @param {Array} availableSyncTasks - Array of available sync tasks
+ * @param {Boolean} skipPrompt - Option to skip contact records prompt and return all available sync tasks
+ * @returns {Array} Adjusted available sync task items
+ */
+export function getSyncTypesWithContactRecordsPrompt(accountConfig: Object, syncTasks: any, skipPrompt?: boolean): any[];
+export function handleSandboxCreateError({ err, env, accountId, name, accountConfig, }: {
+    err: any;
+    env: any;
+    accountId: any;
+    name: any;
+    accountConfig: any;
+}): void;