@hubspot/cli 7.0.1 → 7.0.2-experimental.0

package/lib/sandboxes.js

@@ -1,43 +1,45 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// @ts-nocheck
-const { i18n } = require('./lang');
-const { logger } = require('@hubspot/local-dev-lib/logger');
-const { getSandboxUsageLimits, } = require('@hubspot/local-dev-lib/api/sandboxHubs');
-const { fetchTypes } = require('@hubspot/local-dev-lib/api/sandboxSync');
-const { getAccountId, getEnv, getConfigAccounts, } = require('@hubspot/local-dev-lib/config');
-const { promptUser } = require('./prompts/promptUtils');
-const { isDevelopmentSandbox } = require('./accountTypes');
-const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
-const { HUBSPOT_ACCOUNT_TYPES, } = require('@hubspot/local-dev-lib/constants/config');
-const { getAccountIdentifier, } = require('@hubspot/local-dev-lib/config/getAccountIdentifier');
-const { uiAccountDescription } = require('./ui');
-const { isMissingScopeError, isSpecifiedError, } = require('@hubspot/local-dev-lib/errors/index');
-const { getValidEnv } = require('@hubspot/local-dev-lib/environment');
-const { logError } = require('./errorHandlers/index');
-const syncTypes = {
+exports.SANDBOX_API_TYPE_MAP = exports.SANDBOX_TYPE_MAP = exports.SYNC_TYPES = void 0;
+exports.getSandboxTypeAsString = getSandboxTypeAsString;
+exports.getAvailableSyncTypes = getAvailableSyncTypes;
+exports.validateSandboxUsageLimits = validateSandboxUsageLimits;
+exports.handleSandboxCreateError = handleSandboxCreateError;
+const logger_1 = require("@hubspot/local-dev-lib/logger");
+const sandboxHubs_1 = require("@hubspot/local-dev-lib/api/sandboxHubs");
+const sandboxSync_1 = require("@hubspot/local-dev-lib/api/sandboxSync");
+const config_1 = require("@hubspot/local-dev-lib/config");
+const urls_1 = require("@hubspot/local-dev-lib/urls");
+const config_2 = require("@hubspot/local-dev-lib/constants/config");
+const getAccountIdentifier_1 = require("@hubspot/local-dev-lib/config/getAccountIdentifier");
+const index_1 = require("@hubspot/local-dev-lib/errors/index");
+const lang_1 = require("./lang");
+const ui_1 = require("./ui");
+const index_2 = require("./errorHandlers/index");
+const i18nKey = 'lib.sandbox';
+exports.SYNC_TYPES = {
     OBJECT_RECORDS: 'object-records',
 };
-const sandboxTypeMap = {
-    dev: HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX,
-    developer: HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX,
-    development: HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX,
-    standard: HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX,
+exports.SANDBOX_TYPE_MAP = {
+    dev: config_2.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX,
+    developer: config_2.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX,
+    development: config_2.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX,
+    standard: config_2.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX,
 };
-const sandboxApiTypeMap = {
-    [HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX]: 1,
-    [HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX]: 2,
+exports.SANDBOX_API_TYPE_MAP = {
+    [config_2.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX]: 1,
+    [config_2.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX]: 2,
 };
-const getSandboxTypeAsString = accountType => {
-    if (accountType === HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX) {
+function getSandboxTypeAsString(accountType) {
+    if (accountType === config_2.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX) {
         return 'development'; // Only place we're using this specific name
     }
     return 'standard';
-};
+}
 function getHasSandboxesByType(parentAccountConfig, type) {
-    const id = getAccountIdentifier(parentAccountConfig);
-    const parentPortalId = getAccountId(id);
-    const accountsList = getConfigAccounts();
+    const id = (0, getAccountIdentifier_1.getAccountIdentifier)(parentAccountConfig);
+    const parentPortalId = (0, config_1.getAccountId)(id);
+    const accountsList = (0, config_1.getConfigAccounts)() || [];
     for (const portal of accountsList) {
         if ((portal.parentAccountId !== null ||
             portal.parentAccountId !== undefined) &&
@@ -49,79 +51,45 @@ function getHasSandboxesByType(parentAccountConfig, type) {
     }
     return false;
 }
-function getSandboxLimit(error) {
-    // Error context should contain a limit property with a list of one number. That number is the current limit
-    const limit = error.context && error.context.limit && error.context.limit[0];
-    return limit ? parseInt(limit, 10) : 1; // Default to 1
-}
 // Fetches available sync types for a given sandbox portal
 async function getAvailableSyncTypes(parentAccountConfig, config) {
-    const parentId = getAccountIdentifier(parentAccountConfig);
-    const parentPortalId = getAccountId(parentId);
-    const id = getAccountIdentifier(config);
-    const portalId = getAccountId(id);
-    const { data: { results: syncTypes }, } = await fetchTypes(parentPortalId, portalId);
+    const parentId = (0, getAccountIdentifier_1.getAccountIdentifier)(parentAccountConfig);
+    const parentPortalId = (0, config_1.getAccountId)(parentId);
+    const id = (0, getAccountIdentifier_1.getAccountIdentifier)(config);
+    const portalId = (0, config_1.getAccountId)(id);
+    if (!parentPortalId || !portalId) {
+        throw new Error((0, lang_1.i18n)(`${i18nKey}.sync.failure.syncTypeFetch`));
+    }
+    const { data: { results: syncTypes }, } = await (0, sandboxSync_1.fetchTypes)(parentPortalId, portalId);
     if (!syncTypes) {
-        throw new Error('Unable to fetch available sandbox sync types. Please try again.');
+        throw new Error((0, lang_1.i18n)(`${i18nKey}.sync.failure.syncTypeFetch`));
     }
     return syncTypes.map(t => ({ type: t.name }));
 }
-/**
- * @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
- */
-const getSyncTypesWithContactRecordsPrompt = async (accountConfig, syncTasks, skipPrompt = false) => {
-    // TODO: remove this entire helper once hs sandbox sync is fully deprecated
-    const isDevSandbox = isDevelopmentSandbox(accountConfig);
-    if (isDevSandbox) {
-        // Disable dev sandbox from syncing contacts
-        return syncTasks.filter(t => t.type !== syncTypes.OBJECT_RECORDS);
+async function validateSandboxUsageLimits(accountConfig, sandboxType, env) {
+    const id = (0, getAccountIdentifier_1.getAccountIdentifier)(accountConfig);
+    const accountId = (0, config_1.getAccountId)(id);
+    if (!accountId) {
+        throw new Error((0, lang_1.i18n)(`${i18nKey}.create.failure.usageLimitFetch`));
     }
-    if (syncTasks &&
-        syncTasks.some(t => t.type === syncTypes.OBJECT_RECORDS) &&
-        !skipPrompt) {
-        const { contactRecordsSyncPrompt } = await promptUser([
-            {
-                name: 'contactRecordsSyncPrompt',
-                type: 'confirm',
-                message: i18n('lib.sandbox.sync.confirm.syncContactRecords.standard'),
-            },
-        ]);
-        if (!contactRecordsSyncPrompt) {
-            return syncTasks.filter(t => t.type !== syncTypes.OBJECT_RECORDS);
-        }
-    }
-    return syncTasks;
-};
-/**
- * @param {Object} accountConfig - Account config of sandbox portal
- * @param {String} sandboxType - Sandbox type for limit validation
- * @param {String} env - Environment
- * @returns {null}
- */
-const validateSandboxUsageLimits = async (accountConfig, sandboxType, env) => {
-    const id = getAccountIdentifier(accountConfig);
-    const accountId = getAccountId(id);
-    const { data: { usage }, } = await getSandboxUsageLimits(accountId);
+    const { data: { usage }, } = await (0, sandboxHubs_1.getSandboxUsageLimits)(accountId);
     if (!usage) {
-        throw new Error('Unable to fetch sandbox usage limits. Please try again.');
+        throw new Error((0, lang_1.i18n)(`${i18nKey}.create.failure.usageLimitFetch`));
     }
-    if (sandboxType === HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX) {
+    if (sandboxType === config_2.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX) {
         if (usage['DEVELOPER'].available === 0) {
             const devSandboxLimit = usage['DEVELOPER'].limit;
             const plural = devSandboxLimit !== 1;
-            const hasDevelopmentSandboxes = getHasSandboxesByType(accountConfig, HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX);
+            const hasDevelopmentSandboxes = getHasSandboxesByType(accountConfig, config_2.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX);
             if (hasDevelopmentSandboxes) {
-                throw new Error(i18n(`lib.sandbox.create.failure.alreadyInConfig.developer.${plural ? 'other' : 'one'}`, {
+                throw new Error((0, lang_1.i18n)(`${i18nKey}.create.failure.alreadyInConfig.developer.${plural ? 'other' : 'one'}`, {
                     accountName: accountConfig.name || accountId,
                     limit: devSandboxLimit,
                 }));
             }
             else {
-                const baseUrl = getHubSpotWebsiteOrigin(env);
-                throw new Error(i18n(`lib.sandbox.create.failure.limit.developer.${plural ? 'other' : 'one'}`, {
+                const baseUrl = (0, urls_1.getHubSpotWebsiteOrigin)(env);
+                throw new Error((0, lang_1.i18n)(`${i18nKey}.create.failure.limit.developer.${plural ? 'other' : 'one'}`, {
                     accountName: accountConfig.name || accountId,
                     limit: devSandboxLimit,
                     link: `${baseUrl}/sandboxes-developer/${accountId}/development`,
@@ -129,20 +97,20 @@ const validateSandboxUsageLimits = async (accountConfig, sandboxType, env) => {
             }
         }
     }
-    if (sandboxType === HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX) {
+    if (sandboxType === config_2.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX) {
         if (usage['STANDARD'].available === 0) {
             const standardSandboxLimit = usage['STANDARD'].limit;
             const plural = standardSandboxLimit !== 1;
-            const hasStandardSandboxes = getHasSandboxesByType(accountConfig, HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX);
+            const hasStandardSandboxes = getHasSandboxesByType(accountConfig, config_2.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX);
             if (hasStandardSandboxes) {
-                throw new Error(i18n(`lib.sandbox.create.failure.alreadyInConfig.standard.${plural ? 'other' : 'one'}`, {
+                throw new Error((0, lang_1.i18n)(`${i18nKey}.create.failure.alreadyInConfig.standard.${plural ? 'other' : 'one'}`, {
                     accountName: accountConfig.name || accountId,
                     limit: standardSandboxLimit,
                 }));
             }
             else {
-                const baseUrl = getHubSpotWebsiteOrigin(env);
-                throw new Error(i18n(`lib.sandbox.create.failure.limit.standard.${plural ? 'other' : 'one'}`, {
+                const baseUrl = (0, urls_1.getHubSpotWebsiteOrigin)(env);
+                throw new Error((0, lang_1.i18n)(`${i18nKey}.create.failure.limit.standard.${plural ? 'other' : 'one'}`, {
                     accountName: accountConfig.name || accountId,
                     limit: standardSandboxLimit,
                     link: `${baseUrl}/sandboxes-developer/${accountId}/standard`,
@@ -150,112 +118,46 @@ const validateSandboxUsageLimits = async (accountConfig, sandboxType, env) => {
             }
         }
     }
-};
-function handleSandboxCreateError({ err, env, accountId, name, accountConfig, }) {
-    if (isMissingScopeError(err)) {
-        logger.error(i18n('lib.sandboxes.create.failure.scopes.message', {
-            accountName: uiAccountDescription(accountId),
+}
+function handleSandboxCreateError(err, env, name, accountId) {
+    if ((0, index_1.isMissingScopeError)(err)) {
+        logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.create.failure.scopes.message`, {
+            accountName: (0, ui_1.uiAccountDescription)(accountId),
         }));
-        const websiteOrigin = getHubSpotWebsiteOrigin(env);
+        const websiteOrigin = (0, urls_1.getHubSpotWebsiteOrigin)(env);
         const url = `${websiteOrigin}/personal-access-key/${accountId}`;
-        logger.info(i18n('lib.sandboxes.create.failure.scopes.instructions', {
-            accountName: uiAccountDescription(accountId),
+        logger_1.logger.info((0, lang_1.i18n)(`${i18nKey}.create.failure.scopes.instructions`, {
+            accountName: (0, ui_1.uiAccountDescription)(accountId),
             url,
         }));
     }
-    else if (isSpecifiedError(err, {
+    else if ((0, index_1.isSpecifiedError)(err, {
         statusCode: 403,
         category: 'BANNED',
         subCategory: 'SandboxErrors.USER_ACCESS_NOT_ALLOWED',
     })) {
-        logger.log('');
-        logger.error(i18n('lib.sandboxes.create.failure.invalidUser', {
+        logger_1.logger.log('');
+        logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.create.failure.invalidUser`, {
             accountName: name,
-            parentAccountName: uiAccountDescription(accountId),
+            parentAccountName: (0, ui_1.uiAccountDescription)(accountId),
         }));
-        logger.log('');
+        logger_1.logger.log('');
     }
-    else if (isSpecifiedError(err, {
+    else if ((0, index_1.isSpecifiedError)(err, {
         statusCode: 403,
         category: 'BANNED',
         subCategory: 'SandboxErrors.DEVELOPMENT_SANDBOX_ACCESS_NOT_ALLOWED',
     })) {
-        logger.log('');
-        logger.error(i18n('lib.sandboxes.create.failure.403Gating', {
+        logger_1.logger.log('');
+        logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.create.failure.403Gating`, {
             accountName: name,
-            parentAccountName: uiAccountDescription(accountId),
+            parentAccountName: (0, ui_1.uiAccountDescription)(accountId),
             accountId,
         }));
-        logger.log('');
-    }
-    else if (isSpecifiedError(err, {
-        statusCode: 400,
-        category: 'VALIDATION_ERROR',
-        subCategory: 'SandboxErrors.NUM_DEVELOPMENT_SANDBOXES_LIMIT_EXCEEDED_ERROR',
-    }) &&
-        err.error &&
-        err.error.message) {
-        logger.log('');
-        const devSandboxLimit = getSandboxLimit(err.error);
-        const plural = devSandboxLimit !== 1;
-        const hasDevelopmentSandboxes = getHasSandboxesByType(accountConfig, HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX);
-        if (hasDevelopmentSandboxes) {
-            logger.error(i18n(`lib.sandboxes.create.failure.alreadyInConfig.developer.${plural ? 'other' : 'one'}`, {
-                accountName: uiAccountDescription(accountId),
-                limit: devSandboxLimit,
-            }));
-        }
-        else {
-            const baseUrl = getHubSpotWebsiteOrigin(getValidEnv(getEnv(accountId)));
-            logger.error(i18n(`lib.sandboxes.create.failure.limit.developer.${plural ? 'other' : 'one'}`, {
-                accountName: uiAccountDescription(accountId),
-                limit: devSandboxLimit,
-                link: `${baseUrl}/sandboxes-developer/${accountId}/development`,
-            }));
-        }
-        logger.log('');
-    }
-    else if (isSpecifiedError(err, {
-        statusCode: 400,
-        category: 'VALIDATION_ERROR',
-        subCategory: 'SandboxErrors.NUM_STANDARD_SANDBOXES_LIMIT_EXCEEDED_ERROR',
-    }) &&
-        err.error &&
-        err.error.message) {
-        logger.log('');
-        const standardSandboxLimit = getSandboxLimit(err.error);
-        const plural = standardSandboxLimit !== 1;
-        const hasStandardSandboxes = getHasSandboxesByType(accountConfig, HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX);
-        if (hasStandardSandboxes) {
-            logger.error(i18n(`lib.sandboxes.create.failure.alreadyInConfig.standard.${plural ? 'other' : 'one'}`, {
-                accountName: uiAccountDescription(accountId),
-                limit: standardSandboxLimit,
-            }));
-        }
-        else {
-            const baseUrl = getHubSpotWebsiteOrigin(getValidEnv(getEnv(accountId)));
-            logger.error(i18n(`lib.sandboxes.create.failure.limit.standard.${plural ? 'other' : 'one'}`, {
-                accountName: uiAccountDescription(accountId),
-                limit: standardSandboxLimit,
-                link: `${baseUrl}/sandboxes-developer/${accountId}/standard`,
-            }));
-        }
-        logger.log('');
+        logger_1.logger.log('');
     }
     else {
-        logError(err);
+        (0, index_2.logError)(err);
     }
     throw err;
 }
-module.exports = {
-    sandboxTypeMap,
-    sandboxApiTypeMap,
-    syncTypes,
-    getSandboxTypeAsString,
-    getHasSandboxesByType,
-    getSandboxLimit,
-    validateSandboxUsageLimits,
-    getAvailableSyncTypes,
-    getSyncTypesWithContactRecordsPrompt,
-    handleSandboxCreateError,
-};

package/package.json

@@ -1,11 +1,12 @@
 {
     "name": "@hubspot/cli",
-    "version": "7.0.1",
+    "version": "7.0.2-experimental.0",
     "description": "The official CLI for developing on HubSpot",
     "license": "Apache-2.0",
     "repository": "https://github.com/HubSpot/hubspot-cli",
     "dependencies": {
         "@hubspot/local-dev-lib": "3.1.1",
+        "@hubspot/project-parsing-lib": "^0.0.2-experimental.0",
         "@hubspot/serverless-dev-runtime": "7.0.1",
         "@hubspot/theme-preview-dev-server": "0.0.10",
         "@hubspot/ui-extensions-dev-server": "0.8.40",
@@ -64,14 +65,15 @@
         "list-all-commands": "yarn ts-node ./scripts/get-all-commands.ts",
         "prettier:write": "prettier --write ./**/*.{ts,js,json}",
         "test": "jest",
-        "test-cli": "yarn --cwd 'acceptance-tests' test-ci",
-        "test-cli-debug": "yarn --cwd 'acceptance-tests' test-debug",
-        "test-cli-qa": "yarn --cwd 'acceptance-tests' test-qa",
-        "test-cli-latest": "yarn build-docker && docker container run -it --rm --name=hs-cli-container hs-cli-image yarn --cwd 'acceptance-tests' test-latest",
+        "test-cli": "yarn build && yarn --cwd 'acceptance-tests' test-ci",
+        "test-cli-debug": "yarn build && yarn --cwd 'acceptance-tests' test-debug",
+        "test-cli-qa": "yarn build && yarn --cwd 'acceptance-tests' test-qa",
+        "test-cli-latest": "yarn build && yarn build-docker && docker container run -it --rm --name=hs-cli-container hs-cli-image yarn --cwd 'acceptance-tests' test-latest",
         "build-docker": "docker image build --tag hs-cli-image . && docker image prune -f",
         "circular-deps": "yarn madge --circular .",
         "release": "yarn ts-node ./scripts/release.ts release",
         "hs": "yarn build && node ./dist/bin/hs",
+        "hs-debug": "yarn build && NODE_DEBUG=http* node --inspect-brk ./dist/bin/hs",
         "update-ldl": "yarn add --exact @hubspot/local-dev-lib@latest"
     },
     "lint-staged": {

package/types/Projects.d.ts

@@ -41,3 +41,71 @@ export type ProjectTemplateRepoConfig = {
     projects?: ProjectTemplate[];
     components?: ComponentTemplate[];
 };
+export type PrivateAppComponentConfig = {
+    name: string;
+    description: string;
+    uid: string;
+    scopes: Array<string>;
+    public: boolean;
+    extensions?: {
+        crm: {
+            cards: Array<{
+                file: string;
+            }>;
+        };
+    };
+};
+export type PublicAppComponentConfig = {
+    name: string;
+    uid: string;
+    description: string;
+    allowedUrls: Array<string>;
+    auth: {
+        redirectUrls: Array<string>;
+        requiredScopes: Array<string>;
+        optionalScopes: Array<string>;
+        conditionallyRequiredScopes: Array<string>;
+    };
+    support: {
+        supportEmail: string;
+        documentationUrl: string;
+        supportUrl: string;
+        supportPhone: string;
+    };
+    extensions?: {
+        crm: {
+            cards: Array<{
+                file: string;
+            }>;
+        };
+    };
+    webhooks?: {
+        file: string;
+    };
+};
+export type AppCardComponentConfig = {
+    type: 'crm-card';
+    data: {
+        title: string;
+        uid: string;
+        location: string;
+        module: {
+            file: string;
+        };
+        objectTypes: Array<{
+            name: string;
+        }>;
+    };
+};
+export type GenericComponentConfig = PublicAppComponentConfig | PrivateAppComponentConfig | AppCardComponentConfig;
+export declare enum ComponentTypes {
+    PrivateApp = "private-app",
+    PublicApp = "public-app",
+    HublTheme = "hubl-theme"
+}
+export type Component = {
+    type: ComponentTypes;
+    config: GenericComponentConfig;
+    runnable: boolean;
+    path: string;
+};

package/types/Projects.js

@@ -1,2 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComponentTypes = void 0;
+var ComponentTypes;
+(function (ComponentTypes) {
+    ComponentTypes["PrivateApp"] = "private-app";
+    ComponentTypes["PublicApp"] = "public-app";
+    ComponentTypes["HublTheme"] = "hubl-theme";
+})(ComponentTypes || (exports.ComponentTypes = ComponentTypes = {}));

package/types/Sandboxes.d.ts

@@ -0,0 +1,3 @@
+export type SandboxSyncTask = {
+    type: string;
+};

package/types/Sandboxes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });