@hubspot/cli 7.0.1 → 7.0.2-experimental.0

package/lib/projects/structure.d.ts

@@ -1,78 +1,9 @@
-import { ValueOf } from '@hubspot/local-dev-lib/types/Utils';
-export type Component = {
-    type: ComponentTypes;
-    config: object;
-    runnable: boolean;
-    path: string;
-};
-type PrivateAppComponentConfig = {
-    name: string;
-    description: string;
-    uid: string;
-    scopes: Array<string>;
-    public: boolean;
-    extensions?: {
-        crm: {
-            cards: Array<{
-                file: string;
-            }>;
-        };
-    };
-};
-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;
-    };
-};
-type AppCardComponentConfig = {
-    type: 'crm-card';
-    data: {
-        title: string;
-        uid: string;
-        location: string;
-        module: {
-            file: string;
-        };
-        objectTypes: Array<{
-            name: string;
-        }>;
-    };
-};
-export declare const COMPONENT_TYPES: {
-    readonly privateApp: "private-app";
-    readonly publicApp: "public-app";
-    readonly hublTheme: "hubl-theme";
-};
-type ComponentTypes = ValueOf<typeof COMPONENT_TYPES>;
+import { ComponentTypes, Component, PublicAppComponentConfig, PrivateAppComponentConfig, AppCardComponentConfig } from '../../types/Projects';
 export declare const CONFIG_FILES: {
-    [k in ValueOf<typeof COMPONENT_TYPES>]: string;
+    [k in ComponentTypes]: string;
 };
 export declare function getAppCardConfigs(appConfig: PublicAppComponentConfig | PrivateAppComponentConfig, appPath: string): Array<AppCardComponentConfig>;
 export declare function findProjectComponents(projectSourceDir: string): Promise<Array<Component>>;
 export declare function getProjectComponentTypes(components: Array<Component>): {
     [key in ComponentTypes]?: boolean;
 };
-export {};

package/lib/projects/structure.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CONFIG_FILES = exports.COMPONENT_TYPES = void 0;
+exports.CONFIG_FILES = void 0;
 exports.getAppCardConfigs = getAppCardConfigs;
 exports.findProjectComponents = findProjectComponents;
 exports.getProjectComponentTypes = getProjectComponentTypes;
@@ -42,15 +42,11 @@ const path = __importStar(require("path"));
 const fs_1 = require("@hubspot/local-dev-lib/fs");
 const logger_1 = require("@hubspot/local-dev-lib/logger");
 const index_1 = require("../errorHandlers/index");
-exports.COMPONENT_TYPES = {
-    privateApp: 'private-app',
-    publicApp: 'public-app',
-    hublTheme: 'hubl-theme',
-};
+const Projects_1 = require("../../types/Projects");
 exports.CONFIG_FILES = {
-    [exports.COMPONENT_TYPES.privateApp]: 'app.json',
-    [exports.COMPONENT_TYPES.publicApp]: 'public-app.json',
-    [exports.COMPONENT_TYPES.hublTheme]: 'theme.json',
+    [Projects_1.ComponentTypes.PrivateApp]: 'app.json',
+    [Projects_1.ComponentTypes.PublicApp]: 'public-app.json',
+    [Projects_1.ComponentTypes.HublTheme]: 'theme.json',
 };
 function getComponentTypeFromConfigFile(configFile) {
     let key;
@@ -129,7 +125,7 @@ async function findProjectComponents(projectSourceDir) {
             const parsedConfig = loadConfigFile(projectFile);
             if (parsedConfig) {
                 const isLegacy = getIsLegacyApp(parsedConfig, dir);
-                const isHublTheme = base === exports.CONFIG_FILES[exports.COMPONENT_TYPES.hublTheme];
+                const isHublTheme = base === exports.CONFIG_FILES[Projects_1.ComponentTypes.HublTheme];
                 const componentType = getComponentTypeFromConfigFile(base);
                 if (componentType) {
                     components.push({

package/lib/projects/upload.d.ts

@@ -4,5 +4,5 @@ type ProjectUploadCallbackFunction<T> = (accountId: number, projectConfig: Proje
 type ProjectUploadDefaultResult = {
     uploadError?: unknown;
 };
-export declare function handleProjectUpload<T = ProjectUploadDefaultResult>(accountId: number, projectConfig: ProjectConfig, projectDir: string, callbackFunc: ProjectUploadCallbackFunction<T>, uploadMessage: string): Promise<unknown>;
+export declare function handleProjectUpload<T = ProjectUploadDefaultResult>(accountId: number, projectConfig: ProjectConfig, projectDir: string, callbackFunc: ProjectUploadCallbackFunction<T>, uploadMessage: string, sendIR?: boolean): Promise<unknown>;
 export {};

package/lib/projects/upload.js

@@ -15,8 +15,11 @@ const SpinniesManager_1 = __importDefault(require("../ui/SpinniesManager"));
 const ui_1 = require("../ui");
 const lang_1 = require("../lang");
 const exitCodes_1 = require("../enums/exitCodes");
+const project_parsing_lib_1 = require("@hubspot/project-parsing-lib");
+const errorHandlers_1 = require("../errorHandlers");
+const node_util_1 = __importDefault(require("node:util"));
 const i18nKey = 'lib.projectUpload';
-async function uploadProjectFiles(accountId, projectName, filePath, uploadMessage, platformVersion) {
+async function uploadProjectFiles(accountId, projectName, filePath, uploadMessage, platformVersion, intermediateRepresentation) {
     SpinniesManager_1.default.init({});
     const accountIdentifier = (0, ui_1.uiAccountDescription)(accountId);
     SpinniesManager_1.default.add('upload', {
@@ -29,7 +32,7 @@ async function uploadProjectFiles(accountId, projectName, filePath, uploadMessag
     let buildId;
     let error;
     try {
-        const { data: upload } = await (0, projects_1.uploadProject)(accountId, projectName, filePath, uploadMessage, platformVersion);
+        const { data: upload } = await (0, projects_1.uploadProject)(accountId, projectName, filePath, uploadMessage, platformVersion, intermediateRepresentation);
         buildId = upload.buildId;
         SpinniesManager_1.default.succeed('upload', {
             text: (0, lang_1.i18n)(`${i18nKey}.uploadProjectFiles.succeed`, {
@@ -55,7 +58,7 @@ async function uploadProjectFiles(accountId, projectName, filePath, uploadMessag
     }
     return { buildId, error };
 }
-async function handleProjectUpload(accountId, projectConfig, projectDir, callbackFunc, uploadMessage) {
+async function handleProjectUpload(accountId, projectConfig, projectDir, callbackFunc, uploadMessage, sendIR = false) {
     const srcDir = path_1.default.resolve(projectDir, projectConfig.srcDir);
     const filenames = fs_extra_1.default.readdirSync(srcDir);
     if (!filenames || filenames.length === 0) {
@@ -75,9 +78,28 @@ async function handleProjectUpload(accountId, projectConfig, projectDir, callbac
         logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.handleProjectUpload.compressed`, {
             byteCount: archive.pointer(),
         }));
-        const { buildId, error } = await uploadProjectFiles(accountId, projectConfig.name, tempFile.name, uploadMessage, projectConfig.platformVersion);
+        let intermediateRepresentation;
+        if (sendIR) {
+            try {
+                intermediateRepresentation = await (0, project_parsing_lib_1.translate)({
+                    projectSourceDir: path_1.default.join(projectDir, projectConfig.srcDir),
+                    platformVersion: projectConfig.platformVersion,
+                    accountId,
+                });
+                logger_1.logger.debug(node_util_1.default.inspect(intermediateRepresentation, false, null, true));
+            }
+            catch (e) {
+                if ((0, project_parsing_lib_1.isTranslationError)(e)) {
+                    logger_1.logger.error(e.toString());
+                }
+                else {
+                    (0, errorHandlers_1.logError)(e);
+                }
+                return process.exit(exitCodes_1.EXIT_CODES.ERROR);
+            }
+        }
+        const { buildId, error } = await uploadProjectFiles(accountId, projectConfig.name, tempFile.name, uploadMessage, projectConfig.platformVersion, intermediateRepresentation);
         if (error) {
-            console.log(error);
             uploadResult = { uploadError: error };
         }
         else if (callbackFunc) {

package/lib/sandboxSync.d.ts

@@ -1 +1,4 @@
-export {};
+import { CLIAccount } from '@hubspot/local-dev-lib/types/Accounts';
+import { Environment } from '@hubspot/local-dev-lib/types/Config';
+import { SandboxSyncTask } from '../types/Sandboxes';
+export declare function syncSandbox(accountConfig: CLIAccount, parentAccountConfig: CLIAccount, env: Environment, syncTasks: Array<SandboxSyncTask>, slimInfoMessage?: boolean): Promise<void>;

package/lib/sandboxSync.js

@@ -1,128 +1,127 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-// @ts-nocheck
-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 { isSpecifiedError } = require('@hubspot/local-dev-lib/errors/index');
-const { getSandboxTypeAsString } = require('./sandboxes');
-const { getAccountId } = require('@hubspot/local-dev-lib/config');
-const { getAccountIdentifier, } = require('@hubspot/local-dev-lib/config/getAccountIdentifier');
-const { uiAccountDescription, uiLine, uiLink, uiCommandDisabledBanner, } = require('./ui');
-const { isDevelopmentSandbox } = require('./accountTypes');
+exports.syncSandbox = syncSandbox;
+const SpinniesManager_1 = __importDefault(require("./ui/SpinniesManager"));
+const urls_1 = require("@hubspot/local-dev-lib/urls");
+const logger_1 = require("@hubspot/local-dev-lib/logger");
+const sandboxSync_1 = require("@hubspot/local-dev-lib/api/sandboxSync");
+const index_1 = require("@hubspot/local-dev-lib/errors/index");
+const config_1 = require("@hubspot/local-dev-lib/config");
+const getAccountIdentifier_1 = require("@hubspot/local-dev-lib/config/getAccountIdentifier");
+const lang_1 = require("./lang");
+const sandboxes_1 = require("./sandboxes");
+const index_2 = require("./errorHandlers/index");
+const sandboxes_2 = require("./sandboxes");
+const ui_1 = require("./ui");
+const accountTypes_1 = require("./accountTypes");
 const i18nKey = 'lib.sandbox.sync';
-/**
- * @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
- */
-const syncSandbox = async ({ accountConfig, parentAccountConfig, env, syncTasks, slimInfoMessage = false, }) => {
-    const id = getAccountIdentifier(accountConfig);
-    const accountId = getAccountId(id);
-    const parentId = getAccountIdentifier(parentAccountConfig);
-    const parentAccountId = getAccountId(parentId);
-    const isDevSandbox = isDevelopmentSandbox(accountConfig);
-    SpinniesManager.init({
+async function syncSandbox(accountConfig, parentAccountConfig, env, syncTasks, slimInfoMessage = false) {
+    const id = (0, getAccountIdentifier_1.getAccountIdentifier)(accountConfig);
+    const accountId = (0, config_1.getAccountId)(id);
+    const parentId = (0, getAccountIdentifier_1.getAccountIdentifier)(parentAccountConfig);
+    const parentAccountId = (0, config_1.getAccountId)(parentId);
+    const isDevSandbox = (0, accountTypes_1.isDevelopmentSandbox)(accountConfig);
+    if (!accountId || !parentAccountId) {
+        throw new Error((0, lang_1.i18n)(`${i18nKey}.failure.invalidUser`, {
+            accountName: (0, ui_1.uiAccountDescription)(accountId),
+            parentAccountName: (0, ui_1.uiAccountDescription)(parentAccountId),
+        }));
+    }
+    SpinniesManager_1.default.init({
         succeedColor: 'white',
     });
     let availableSyncTasks = syncTasks;
-    const baseUrl = getHubSpotWebsiteOrigin(env);
-    const syncStatusUrl = `${baseUrl}/sandboxes-developer/${parentAccountId}/${getSandboxTypeAsString(accountConfig.accountType)}`;
+    const baseUrl = (0, urls_1.getHubSpotWebsiteOrigin)(env);
+    const syncStatusUrl = `${baseUrl}/sandboxes-developer/${parentAccountId}/${(0, sandboxes_2.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);
+            availableSyncTasks = await (0, sandboxes_1.getAvailableSyncTypes)(parentAccountConfig, accountConfig);
         }
-        SpinniesManager.add('sandboxSync', {
-            text: i18n(`${i18nKey}.loading.startSync`),
+        SpinniesManager_1.default.add('sandboxSync', {
+            text: (0, lang_1.i18n)(`${i18nKey}.loading.startSync`),
         });
-        await initiateSync(parentAccountId, accountId, availableSyncTasks, accountId);
+        await (0, sandboxSync_1.initiateSync)(parentAccountId, accountId, availableSyncTasks, accountId);
         const 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),
+        SpinniesManager_1.default.succeed('sandboxSync', {
+            text: (0, lang_1.i18n)(slimInfoMessage ? `${i18nKey}.loading.successDevSbInfo` : spinniesText, {
+                accountName: (0, ui_1.uiAccountDescription)(accountId),
+                url: (0, ui_1.uiLink)((0, lang_1.i18n)(`${i18nKey}.info.syncStatusDetailsLinkText`), syncStatusUrl),
             }),
         });
     }
     catch (err) {
-        debugError(err);
-        SpinniesManager.fail('sandboxSync', {
-            text: i18n(`${i18nKey}.loading.fail`),
+        (0, index_2.debugError)(err);
+        SpinniesManager_1.default.fail('sandboxSync', {
+            text: (0, lang_1.i18n)(`${i18nKey}.loading.fail`),
         });
-        logger.log('');
-        if (isSpecifiedError(err, {
+        logger_1.logger.log('');
+        if ((0, index_1.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),
+            logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.failure.invalidUser`, {
+                accountName: (0, ui_1.uiAccountDescription)(accountId),
+                parentAccountName: (0, ui_1.uiAccountDescription)(parentAccountId),
             }));
         }
-        else if (isSpecifiedError(err, {
+        else if ((0, index_1.isSpecifiedError)(err, {
             statusCode: 429,
             category: 'RATE_LIMITS',
             subCategory: 'sandboxes-sync-api.SYNC_IN_PROGRESS',
         })) {
-            logger.error(i18n(`${i18nKey}.failure.syncInProgress`, {
+            logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.failure.syncInProgress`, {
                 url: `${baseUrl}/sandboxes-developer/${parentAccountId}/syncactivitylog`,
             }));
         }
-        else if (isSpecifiedError(err, {
+        else if ((0, index_1.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),
+            logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.failure.notSuperAdmin`, {
+                account: (0, ui_1.uiAccountDescription)(accountId),
             }));
         }
-        else if (isSpecifiedError(err, {
+        else if ((0, index_1.isSpecifiedError)(err, {
             statusCode: 404,
             category: 'OBJECT_NOT_FOUND',
             subCategory: 'SandboxErrors.SANDBOX_NOT_FOUND',
         })) {
-            logger.error(i18n(`${i18nKey}.failure.objectNotFound`, {
-                account: uiAccountDescription(accountId),
+            logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.failure.objectNotFound`, {
+                account: (0, ui_1.uiAccountDescription)(accountId),
             }));
         }
-        else if (isSpecifiedError(err, {
+        else if ((0, index_1.isSpecifiedError)(err, {
             statusCode: 404,
         })) {
-            uiCommandDisabledBanner('hs sandbox sync', 'https://app.hubspot.com/l/docs/guides/crm/project-cli-commands#developer-projects-cli-commands-beta');
+            (0, ui_1.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({
+            (0, index_2.logError)(err, new index_2.ApiErrorContext({
                 accountId: parentAccountId,
                 request: 'sandbox sync',
             }));
         }
-        logger.log('');
+        logger_1.logger.log('');
         throw err;
     }
     if (!slimInfoMessage) {
-        logger.log();
-        uiLine();
-        logger.info(i18n(`${i18nKey}.info.${isDevSandbox ? 'syncMessageDevSb' : 'syncMessage'}`, {
-            url: uiLink(i18n(`${i18nKey}.info.syncStatusDetailsLinkText`), syncStatusUrl),
+        logger_1.logger.log();
+        (0, ui_1.uiLine)();
+        logger_1.logger.info((0, lang_1.i18n)(`${i18nKey}.info.${isDevSandbox ? 'syncMessageDevSb' : 'syncMessage'}`, {
+            url: (0, ui_1.uiLink)((0, lang_1.i18n)(`${i18nKey}.info.syncStatusDetailsLinkText`), syncStatusUrl),
         }));
-        uiLine();
-        logger.log();
+        (0, ui_1.uiLine)();
+        logger_1.logger.log();
     }
-};
-module.exports = {
-    syncSandbox,
-};
+}

package/lib/sandboxes.d.ts

@@ -1 +1,20 @@
-export {};
+import { AccountType, CLIAccount } from '@hubspot/local-dev-lib/types/Accounts';
+import { Environment } from '@hubspot/local-dev-lib/types/Config';
+import { SandboxSyncTask } from '../types/Sandboxes';
+export declare const SYNC_TYPES: {
+    readonly OBJECT_RECORDS: "object-records";
+};
+export declare const SANDBOX_TYPE_MAP: {
+    readonly dev: "DEVELOPMENT_SANDBOX";
+    readonly developer: "DEVELOPMENT_SANDBOX";
+    readonly development: "DEVELOPMENT_SANDBOX";
+    readonly standard: "STANDARD_SANDBOX";
+};
+export declare const SANDBOX_API_TYPE_MAP: {
+    readonly STANDARD_SANDBOX: 1;
+    readonly DEVELOPMENT_SANDBOX: 2;
+};
+export declare function getSandboxTypeAsString(accountType?: AccountType): string;
+export declare function getAvailableSyncTypes(parentAccountConfig: CLIAccount, config: CLIAccount): Promise<Array<SandboxSyncTask>>;
+export declare function validateSandboxUsageLimits(accountConfig: CLIAccount, sandboxType: AccountType, env: Environment): Promise<void>;
+export declare function handleSandboxCreateError(err: unknown, env: Environment, name: string, accountId: number): void;