@hubspot/cli 7.4.9-experimental.0 → 7.5.0-beta.0

package/lib/projects/buildAndDeploy.js

@@ -8,16 +8,17 @@ exports.useV3Api = useV3Api;
 exports.displayWarnLogs = displayWarnLogs;
 exports.pollProjectBuildAndDeploy = pollProjectBuildAndDeploy;
 const chalk_1 = __importDefault(require("chalk"));
-const logger_1 = require("@hubspot/local-dev-lib/logger");
 const projects_1 = require("@hubspot/local-dev-lib/api/projects");
 const constants_1 = require("../constants");
 const SpinniesManager_1 = __importDefault(require("../ui/SpinniesManager"));
-const lang_1 = require("../lang");
 const errorHandlers_1 = require("../errorHandlers");
 const ui_1 = require("../ui");
 const urls_1 = require("./urls");
 const exitCodes_1 = require("../enums/exitCodes");
-const i18nKey = 'lib.projectBuildAndDeploy';
+const en_1 = require("../../lang/en");
+const logger_1 = require("../ui/logger");
+const constants_2 = require("@hubspot/project-parsing-lib/src/lib/constants");
+const project_parsing_lib_1 = require("@hubspot/project-parsing-lib");
 const SPINNER_STATUS = {
     SPINNING: 'spinning',
 };
@@ -50,19 +51,14 @@ function getSubtaskType(task) {
     return task.deployType;
 }
 function handleTaskStatusError(statusText) {
-    logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.makePollTaskStatusFunc.errorFetchingTaskStatus`, {
-        taskType: statusText.TYPE_KEY === constants_1.PROJECT_BUILD_TEXT.TYPE_KEY
-            ? 'build'
-            : 'deploy',
-        openCommand: (0, ui_1.uiCommandReference)('hs project open'),
-    }));
+    logger_1.uiLogger.error(en_1.lib.projectBuildAndDeploy.makePollTaskStatusFunc.errorFetchingTaskStatus(statusText.TYPE_KEY === constants_1.PROJECT_BUILD_TEXT.TYPE_KEY ? 'build' : 'deploy'));
     process.exit(exitCodes_1.EXIT_CODES.ERROR);
 }
 function makePollTaskStatusFunc({ statusFn, structureFn, statusText, statusStrings, linkToHubSpot, }) {
     return async function (accountId, taskName, taskId, deployedBuildId, silenceLogs = false) {
         const displayId = deployedBuildId || taskId;
         if (linkToHubSpot && !silenceLogs) {
-            logger_1.logger.log(`\n${linkToHubSpot(accountId, taskName, taskId, deployedBuildId)}\n`);
+            logger_1.uiLogger.log(`\n${linkToHubSpot(accountId, taskName, taskId, deployedBuildId)}\n`);
         }
         SpinniesManager_1.default.init();
         const overallTaskSpinniesKey = `overallTaskStatus-${statusText.STATUS_TEXT}`;
@@ -77,14 +73,27 @@ function makePollTaskStatusFunc({ statusFn, structureFn, statusText, statusStrin
             structureFn(accountId, taskName, taskId),
         ]);
         const subtasks = getSubtasks(initialTaskStatus);
-        const tasksById = subtasks.reduce((acc, subtask) => {
+        const hiddenComponentBuildIds = [];
+        const tasksById = subtasks
+            .filter(subtask => {
+            // TODO: Remove this filtering logic when visible=false for SERVERLESS_PACKAGE
+            const shouldBeVisible = getSubtaskType(subtask) !== (0, project_parsing_lib_1.mapToInternalType)(constants_2.AppFunctionsPackageKey);
+            if (!shouldBeVisible) {
+                hiddenComponentBuildIds.push(subtask.id);
+            }
+            return shouldBeVisible;
+        })
+            .reduce((acc, subtask) => {
             const { id, visible } = subtask;
             if (visible) {
                 acc[id] = subtask;
             }
             return acc;
         }, {});
-        const structuredTasks = Object.keys(taskStructure).map(key => {
+        const structuredTasks = Object.keys(taskStructure)
+            // TODO: Remove this filtering logic when visible=false for SERVERLESS_PACKAGE
+            .filter(buildId => !hiddenComponentBuildIds.includes(buildId))
+            .map(key => {
             return {
                 ...tasksById[key],
                 subtasks: taskStructure[key]
@@ -95,9 +104,10 @@ function makePollTaskStatusFunc({ statusFn, structureFn, statusText, statusStrin
         const numComponents = structuredTasks.length;
         const componentCountText = silenceLogs
             ? ''
-            : (0, lang_1.i18n)(numComponents === 1
-                ? `${i18nKey}.makePollTaskStatusFunc.componentCountSingular`
-                : `${i18nKey}.makePollTaskStatusFunc.componentCount`, { numComponents }) + '\n';
+            : numComponents === 1
+                ? en_1.lib.projectBuildAndDeploy.makePollTaskStatusFunc
+                    .componentCountSingular
+                : en_1.lib.projectBuildAndDeploy.makePollTaskStatusFunc.componentCount(numComponents);
         SpinniesManager_1.default.update(overallTaskSpinniesKey, {
             text: `${statusStrings.INITIALIZE(taskName, displayId)}\n${componentCountText}`,
         });
@@ -129,7 +139,7 @@ function makePollTaskStatusFunc({ statusFn, structureFn, statusText, statusStrin
                     taskStatus = data;
                 }
                 catch (e) {
-                    logger_1.logger.debug(e);
+                    logger_1.uiLogger.debug(e);
                     (0, errorHandlers_1.logError)(e, new errorHandlers_1.ApiErrorContext({
                         accountId,
                         projectName: taskName,
@@ -152,8 +162,10 @@ function makePollTaskStatusFunc({ statusFn, structureFn, statusText, statusStrin
                         if (status === statusText.STATES.SUCCESS ||
                             status === statusText.STATES.FAILURE) {
                             const taskStatusText = subtask.status === statusText.STATES.SUCCESS
-                                ? (0, lang_1.i18n)(`${i18nKey}.makePollTaskStatusFunc.successStatusText`)
-                                : (0, lang_1.i18n)(`${i18nKey}.makePollTaskStatusFunc.failedStatusText`);
+                                ? en_1.lib.projectBuildAndDeploy.makePollTaskStatusFunc
+                                    .successStatusText
+                                : en_1.lib.projectBuildAndDeploy.makePollTaskStatusFunc
+                                    .failedStatusText;
                             const hasNewline = spinner?.text?.includes('\n') || Boolean(topLevelTask);
                             const updatedText = `${spinner?.text?.replace('\n', '')} ${taskStatusText}${hasNewline ? '\n' : ''}`;
                             if (status === statusText.STATES.SUCCESS) {
@@ -181,23 +193,23 @@ function makePollTaskStatusFunc({ statusFn, structureFn, statusText, statusStrin
                         if (!silenceLogs) {
                             const failedSubtasks = subtasks.filter(subtask => subtask.status === 'FAILURE');
                             (0, ui_1.uiLine)();
-                            logger_1.logger.log(`${statusStrings.SUBTASK_FAIL(failedSubtasks.length === 1
+                            logger_1.uiLogger.log(`${statusStrings.SUBTASK_FAIL(failedSubtasks.length === 1
                                 ? getSubtaskName(failedSubtasks[0])
                                 : failedSubtasks.length + ' components', displayId)}\n`);
-                            logger_1.logger.log('See below for a summary of errors.');
+                            logger_1.uiLogger.log(en_1.lib.projectBuildAndDeploy.makePollTaskStatusFunc.errorSummary);
                             (0, ui_1.uiLine)();
                             const displayErrors = failedSubtasks.filter(subtask => subtask?.standardError?.subCategory !==
                                 constants_1.PROJECT_ERROR_TYPES.SUBBUILD_FAILED &&
                                 subtask?.standardError?.subCategory !==
                                     constants_1.PROJECT_ERROR_TYPES.SUBDEPLOY_FAILED);
                             displayErrors.forEach(subTask => {
-                                logger_1.logger.log(`\n--- ${chalk_1.default.bold(getSubtaskName(subTask))} failed with the following error ---`);
-                                logger_1.logger.error(subTask.errorMessage);
+                                logger_1.uiLogger.log(`\n--- ${chalk_1.default.bold(getSubtaskName(subTask))} failed with the following error ---`);
+                                logger_1.uiLogger.error(subTask.errorMessage);
                                 // Log nested errors
                                 if (subTask.standardError && subTask.standardError.errors) {
-                                    logger_1.logger.log();
+                                    logger_1.uiLogger.log('');
                                     subTask.standardError.errors.forEach(error => {
-                                        logger_1.logger.log(error.message);
+                                        logger_1.uiLogger.log(error.message);
                                     });
                                 }
                             });
@@ -224,11 +236,11 @@ function pollBuildAutodeployStatus(accountId, taskName, buildId) {
                 build = response.data;
             }
             catch (e) {
-                logger_1.logger.debug(e);
-                return reject(new Error((0, lang_1.i18n)(`${i18nKey}.pollBuildAutodeployStatusError`, { buildId })));
+                logger_1.uiLogger.debug(e);
+                return reject(new Error(en_1.lib.projectBuildAndDeploy.pollBuildAutodeployStatusError(buildId)));
             }
             if (!build || !build.status) {
-                return reject(new Error((0, lang_1.i18n)(`${i18nKey}.pollBuildAutodeployStatusError`, { buildId })));
+                return reject(new Error(en_1.lib.projectBuildAndDeploy.pollBuildAutodeployStatusError(buildId)));
             }
             if (build.deployStatusTaskLocator || maxIntervals <= 0) {
                 clearInterval(pollInterval);
@@ -287,9 +299,9 @@ async function displayWarnLogs(accountId, projectName, taskId, isDeploy = false)
     if (result && result.logs) {
         const logLength = result.logs.length;
         result.logs.forEach((log, i) => {
-            logger_1.logger.warn(log.message);
+            logger_1.uiLogger.warn(log.message);
             if (i < logLength - 1) {
-                logger_1.logger.log('');
+                logger_1.uiLogger.log('');
             }
         });
     }
@@ -311,10 +323,7 @@ async function pollProjectBuildAndDeploy(accountId, projectConfig, tempFile, bui
     }
     else if (buildStatus.isAutoDeployEnabled) {
         if (!silenceLogs) {
-            logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.pollProjectBuildAndDeploy.buildSucceededAutomaticallyDeploying`, {
-                accountIdentifier: (0, ui_1.uiAccountDescription)(accountId),
-                buildId,
-            }));
+            logger_1.uiLogger.log(en_1.lib.projectBuildAndDeploy.pollProjectBuildAndDeploy.buildSucceededAutomaticallyDeploying(buildId, (0, ui_1.uiAccountDescription)(accountId)));
             await displayWarnLogs(accountId, projectConfig.name, buildId);
         }
         // autoDeployId of 0 indicates a skipped deploy
@@ -331,22 +340,17 @@ async function pollProjectBuildAndDeploy(accountId, projectConfig, tempFile, bui
             }
         }
         else if (!silenceLogs) {
-            logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.pollProjectBuildAndDeploy.unableToFindAutodeployStatus`, {
-                buildId,
-                viewDeploysLink: (0, ui_1.uiLink)((0, lang_1.i18n)(`${i18nKey}.pollProjectBuildAndDeploy.viewDeploys`), (0, urls_1.getProjectActivityUrl)(projectConfig.name, accountId)),
-            }));
+            logger_1.uiLogger.log(en_1.lib.projectBuildAndDeploy.pollProjectBuildAndDeploy.unableToFindAutodeployStatus(buildId, (0, ui_1.uiLink)(en_1.lib.projectBuildAndDeploy.pollProjectBuildAndDeploy.viewDeploys, (0, urls_1.getProjectActivityUrl)(projectConfig.name, accountId))));
         }
     }
     try {
         if (tempFile) {
             tempFile.removeCallback();
-            logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.pollProjectBuildAndDeploy.cleanedUpTempFile`, {
-                path: tempFile.name,
-            }));
+            logger_1.uiLogger.debug(en_1.lib.projectBuildAndDeploy.pollProjectBuildAndDeploy.cleanedUpTempFile(tempFile.name));
         }
     }
     catch (e) {
-        logger_1.logger.error(e);
+        (0, errorHandlers_1.logError)(e);
     }
     if (result && result.deployResult) {
         await displayWarnLogs(accountId, projectConfig.name, result.deployResult.deployId, true);

package/lib/projects/config.d.ts

@@ -0,0 +1,9 @@
+import { ProjectConfig } from '../../types/Projects';
+export declare function writeProjectConfig(configPath: string, config: ProjectConfig): boolean;
+export declare function getIsInProject(dir?: string): boolean;
+export interface LoadedProjectConfig {
+    projectDir: string | null;
+    projectConfig: ProjectConfig | null;
+}
+export declare function getProjectConfig(dir?: string): Promise<LoadedProjectConfig>;
+export declare function validateProjectConfig(projectConfig: ProjectConfig | null, projectDir: string | null): asserts projectConfig is ProjectConfig;

package/lib/projects/config.js

@@ -0,0 +1,79 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeProjectConfig = writeProjectConfig;
+exports.getIsInProject = getIsInProject;
+exports.getProjectConfig = getProjectConfig;
+exports.validateProjectConfig = validateProjectConfig;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const findup_sync_1 = __importDefault(require("findup-sync"));
+const path_2 = require("@hubspot/local-dev-lib/path");
+const constants_1 = require("../constants");
+const en_1 = require("../../lang/en");
+const exitCodes_1 = require("../enums/exitCodes");
+const logger_1 = require("../ui/logger");
+function writeProjectConfig(configPath, config) {
+    try {
+        fs_extra_1.default.ensureFileSync(configPath);
+        fs_extra_1.default.writeFileSync(configPath, JSON.stringify(config, null, 2));
+        logger_1.uiLogger.debug(`Wrote project config at ${configPath}`);
+    }
+    catch (e) {
+        logger_1.uiLogger.debug(e);
+        return false;
+    }
+    return true;
+}
+function getIsInProject(dir) {
+    const configPath = getProjectConfigPath(dir);
+    return !!configPath;
+}
+function getProjectConfigPath(dir) {
+    const projectDir = dir ? (0, path_2.getAbsoluteFilePath)(dir) : (0, path_2.getCwd)();
+    const configPath = (0, findup_sync_1.default)(constants_1.PROJECT_CONFIG_FILE, {
+        cwd: projectDir,
+        nocase: true,
+    });
+    return configPath;
+}
+async function getProjectConfig(dir) {
+    const configPath = getProjectConfigPath(dir);
+    if (!configPath) {
+        return { projectConfig: null, projectDir: null };
+    }
+    try {
+        const config = fs_extra_1.default.readFileSync(configPath);
+        const projectConfig = JSON.parse(config.toString());
+        return {
+            projectDir: path_1.default.dirname(configPath),
+            projectConfig,
+        };
+    }
+    catch (e) {
+        logger_1.uiLogger.error(en_1.lib.projects.getProjectConfig.error);
+        return { projectConfig: null, projectDir: null };
+    }
+}
+function validateProjectConfig(projectConfig, projectDir) {
+    if (!projectConfig || !projectDir) {
+        logger_1.uiLogger.error(en_1.lib.projects.validateProjectConfig.configNotFound);
+        return process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
+    if (!projectConfig.name || !projectConfig.srcDir) {
+        logger_1.uiLogger.error(en_1.lib.projects.validateProjectConfig.configMissingFields);
+        return process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
+    const resolvedPath = path_1.default.resolve(projectDir, projectConfig.srcDir);
+    if (!resolvedPath.startsWith(projectDir)) {
+        const projectConfigFile = path_1.default.relative('.', path_1.default.join(projectDir, constants_1.PROJECT_CONFIG_FILE));
+        logger_1.uiLogger.error(en_1.lib.projects.validateProjectConfig.srcOutsideProjectDir(projectConfigFile, projectConfig.srcDir));
+        return process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
+    if (!fs_extra_1.default.existsSync(resolvedPath)) {
+        logger_1.uiLogger.error(en_1.lib.projects.validateProjectConfig.srcDirNotFound(projectConfig.srcDir, projectDir));
+        return process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
+}

package/lib/projects/create.js

@@ -3,13 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EMPTY_PROJECT_TEMPLATE_NAME = void 0;
 exports.getProjectComponentListFromRepo = getProjectComponentListFromRepo;
 exports.getProjectTemplateListFromRepo = getProjectTemplateListFromRepo;
-const logger_1 = require("@hubspot/local-dev-lib/logger");
 const github_1 = require("@hubspot/local-dev-lib/api/github");
 const constants_1 = require("../constants");
 const exitCodes_1 = require("../enums/exitCodes");
-const lang_1 = require("../lang");
 const index_1 = require("../errorHandlers/index");
-const i18nKey = 'lib.projects.create';
+const en_1 = require("../../lang/en");
+const logger_1 = require("../ui/logger");
 exports.EMPTY_PROJECT_TEMPLATE_NAME = 'no-template';
 const PROJECT_TEMPLATE_PROPERTIES = ['name', 'label', 'path', 'insertPath'];
 async function getProjectComponentListFromRepo(githubRef) {
@@ -34,17 +33,17 @@ async function getProjectTemplateListFromRepo(templateSource, githubRef) {
     }
     catch (e) {
         (0, index_1.debugError)(e);
-        logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.errors.missingConfigFileTemplateSource`));
+        logger_1.uiLogger.error(en_1.lib.projects.create.errors.missingConfigFileTemplateSource);
         return process.exit(exitCodes_1.EXIT_CODES.ERROR);
     }
     if (!config || !config[constants_1.PROJECT_COMPONENT_TYPES.PROJECTS]) {
-        logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.errors.noProjectsInConfig`));
+        logger_1.uiLogger.error(en_1.lib.projects.create.errors.noProjectsInConfig);
         return process.exit(exitCodes_1.EXIT_CODES.ERROR);
     }
     const templates = config[constants_1.PROJECT_COMPONENT_TYPES.PROJECTS];
     const templatesContainAllProperties = templates.every(config => PROJECT_TEMPLATE_PROPERTIES.every(p => Object.prototype.hasOwnProperty.call(config, p)));
     if (!templatesContainAllProperties) {
-        logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.errors.missingPropertiesInConfig`));
+        logger_1.uiLogger.error(en_1.lib.projects.create.errors.missingPropertiesInConfig);
         return process.exit(exitCodes_1.EXIT_CODES.ERROR);
     }
     return templates;

package/lib/projects/ensureProjectExists.d.ts

@@ -0,0 +1,11 @@
+import { Project } from '@hubspot/local-dev-lib/types/Project';
+export declare function ensureProjectExists(accountId: number, projectName: string, { forceCreate, allowCreate, noLogs, withPolling, uploadCommand, }?: {
+    forceCreate?: boolean | undefined;
+    allowCreate?: boolean | undefined;
+    noLogs?: boolean | undefined;
+    withPolling?: boolean | undefined;
+    uploadCommand?: boolean | undefined;
+}): Promise<{
+    projectExists: boolean;
+    project?: Project;
+}>;

package/lib/projects/ensureProjectExists.js

@@ -0,0 +1,97 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureProjectExists = ensureProjectExists;
+const projects_1 = require("@hubspot/local-dev-lib/api/projects");
+const index_1 = require("@hubspot/local-dev-lib/errors/index");
+const constants_1 = require("../constants");
+const promptUtils_1 = require("../prompts/promptUtils");
+const exitCodes_1 = require("../enums/exitCodes");
+const ui_1 = require("../ui");
+const SpinniesManager_1 = __importDefault(require("../ui/SpinniesManager"));
+const index_2 = require("../errorHandlers/index");
+const en_1 = require("../../lang/en");
+const logger_1 = require("../ui/logger");
+async function pollFetchProject(accountId, projectName) {
+    // Temporary solution for gating slowness. Retry on 403 statusCode
+    return new Promise((resolve, reject) => {
+        let pollCount = 0;
+        SpinniesManager_1.default.init();
+        SpinniesManager_1.default.add('pollFetchProject', {
+            text: en_1.lib.projects.pollFetchProject.checkingProject((0, ui_1.uiAccountDescription)(accountId)),
+        });
+        const pollInterval = setInterval(async () => {
+            try {
+                const response = await (0, projects_1.fetchProject)(accountId, projectName);
+                if (response && response.data) {
+                    SpinniesManager_1.default.remove('pollFetchProject');
+                    clearInterval(pollInterval);
+                    resolve(response);
+                }
+            }
+            catch (err) {
+                if ((0, index_1.isSpecifiedError)(err, {
+                    statusCode: 403,
+                    category: 'GATED',
+                    subCategory: 'BuildPipelineErrorType.PORTAL_GATED',
+                }) &&
+                    pollCount < 15) {
+                    pollCount += 1;
+                }
+                else {
+                    SpinniesManager_1.default.remove('pollFetchProject');
+                    clearInterval(pollInterval);
+                    reject(err);
+                }
+            }
+        }, constants_1.DEFAULT_POLLING_DELAY);
+    });
+}
+async function ensureProjectExists(accountId, projectName, { forceCreate = false, allowCreate = true, noLogs = false, withPolling = false, uploadCommand = false, } = {}) {
+    const accountIdentifier = (0, ui_1.uiAccountDescription)(accountId);
+    try {
+        const { data: project } = withPolling
+            ? await pollFetchProject(accountId, projectName)
+            : await (0, projects_1.fetchProject)(accountId, projectName);
+        return { projectExists: !!project, project };
+    }
+    catch (err) {
+        if ((0, index_1.isSpecifiedError)(err, { statusCode: 404 })) {
+            let shouldCreateProject = forceCreate;
+            if (allowCreate && !shouldCreateProject) {
+                const promptLangFunction = uploadCommand
+                    ? en_1.lib.projects.ensureProjectExists.createPromptUpload
+                    : en_1.lib.projects.ensureProjectExists.createPrompt;
+                const promptResult = await (0, promptUtils_1.promptUser)([
+                    {
+                        name: 'shouldCreateProject',
+                        message: promptLangFunction(projectName, accountIdentifier),
+                        type: 'confirm',
+                    },
+                ]);
+                shouldCreateProject = promptResult.shouldCreateProject;
+            }
+            if (shouldCreateProject) {
+                try {
+                    const { data: project } = await (0, projects_1.createProject)(accountId, projectName);
+                    logger_1.uiLogger.success(en_1.lib.projects.ensureProjectExists.createSuccess(projectName, accountIdentifier));
+                    return { projectExists: true, project };
+                }
+                catch (err) {
+                    (0, index_2.logError)(err, new index_2.ApiErrorContext({ accountId }));
+                    return { projectExists: false };
+                }
+            }
+            else {
+                if (!noLogs) {
+                    logger_1.uiLogger.log(en_1.lib.projects.ensureProjectExists.notFound(projectName, accountIdentifier));
+                }
+                return { projectExists: false };
+            }
+        }
+        (0, index_2.logError)(err, new index_2.ApiErrorContext({ accountId }));
+        process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
+}

package/lib/projects/localDev/AppDevModeInterface.d.ts

@@ -0,0 +1,26 @@
+import { PublicApp } from '@hubspot/local-dev-lib/types/Apps';
+import { AppIRNode } from '../../../types/ProjectComponents';
+import LocalDevState from './LocalDevState';
+import LocalDevLogger from './LocalDevLogger';
+type AppDevModeInterfaceConstructorOptions = {
+    localDevState: LocalDevState;
+    localDevLogger: LocalDevLogger;
+};
+declare class AppDevModeInterface {
+    localDevState: LocalDevState;
+    localDevLogger: LocalDevLogger;
+    _appNode?: AppIRNode | null;
+    appData?: PublicApp;
+    marketplaceAppInstalls?: number;
+    constructor(options: AppDevModeInterfaceConstructorOptions);
+    private get appNode();
+    private getAppInstallUrl;
+    private fetchAppData;
+    private checkMarketplaceAppInstalls;
+    private checkTestAccountAppInstallation;
+    setup(args: any): Promise<void>;
+    start(): Promise<void>;
+    fileChange(filePath: string, event: string): Promise<void>;
+    cleanup(): Promise<void>;
+}
+export default AppDevModeInterface;

package/lib/projects/localDev/AppDevModeInterface.js

@@ -0,0 +1,156 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const localDevAuth_1 = require("@hubspot/local-dev-lib/api/localDevAuth");
+const appsDev_1 = require("@hubspot/local-dev-lib/api/appsDev");
+const ui_extensions_dev_server_1 = require("@hubspot/ui-extensions-dev-server");
+const portManager_1 = require("@hubspot/local-dev-lib/portManager");
+const constants_1 = require("../../constants");
+const exitCodes_1 = require("../../enums/exitCodes");
+const structure_1 = require("../../projects/structure");
+const ui_1 = require("../../ui");
+const index_1 = require("../../errorHandlers/index");
+const installAppPrompt_1 = require("../../prompts/installAppPrompt");
+const promptUtils_1 = require("../../prompts/promptUtils");
+const en_1 = require("../../../lang/en");
+const logger_1 = require("../../ui/logger");
+const urls_1 = require("../../app/urls");
+class AppDevModeInterface {
+    localDevState;
+    localDevLogger;
+    _appNode;
+    appData;
+    marketplaceAppInstalls;
+    constructor(options) {
+        this.localDevState = options.localDevState;
+        this.localDevLogger = options.localDevLogger;
+        // Static auth apps are currently only installable in the portal that the project resides in
+        // This limitation will eventually be removed, but in the meantime we need this check or the install
+        // will always fail with a confusing message
+        if (this.appNode?.config.auth.type === constants_1.APP_AUTH_TYPES.STATIC &&
+            this.localDevState.targetTestingAccountId !==
+                this.localDevState.targetProjectAccountId) {
+            logger_1.uiLogger.error(en_1.lib.LocalDevManager.staticAuthAccountsMustMatch);
+            process.exit(exitCodes_1.EXIT_CODES.ERROR);
+        }
+        if (!this.localDevState.targetProjectAccountId ||
+            !this.localDevState.projectConfig ||
+            !this.localDevState.projectDir) {
+            logger_1.uiLogger.error(en_1.lib.LocalDevManager.failedToInitialize);
+            process.exit(exitCodes_1.EXIT_CODES.ERROR);
+        }
+    }
+    // Assumes only one app per project
+    get appNode() {
+        if (this._appNode === undefined) {
+            this._appNode =
+                Object.values(this.localDevState.projectNodes).find(structure_1.isAppIRNode) ||
+                    null;
+        }
+        return this._appNode;
+    }
+    async getAppInstallUrl() {
+        if (this.appNode?.config.auth.type === constants_1.APP_AUTH_TYPES.OAUTH) {
+            return (0, urls_1.getOauthAppInstallUrl)({
+                targetAccountId: this.localDevState.targetTestingAccountId,
+                env: this.localDevState.env,
+                clientId: this.appData.clientId, // This is only called after checking that appData exists
+                scopes: this.appNode.config.auth.requiredScopes,
+                redirectUrls: this.appNode.config.auth.redirectUrls,
+            });
+        }
+        const { data: { results }, } = await (0, appsDev_1.fetchPublicAppsForPortal)(this.localDevState.targetProjectAccountId);
+        const app = results.find(app => app.sourceId === this.appNode?.uid);
+        if (!app) {
+            logger_1.uiLogger.error(en_1.lib.LocalDevManager.staticAuthAccountsMustMatch);
+            process.exit(exitCodes_1.EXIT_CODES.ERROR);
+        }
+        return (0, urls_1.getStaticAuthAppInstallUrl)({
+            targetAccountId: this.localDevState.targetTestingAccountId,
+            env: this.localDevState.env,
+            appId: `${app.id}`,
+        });
+    }
+    async fetchAppData() {
+        const { data: { results: portalApps }, } = await (0, appsDev_1.fetchPublicAppsForPortal)(this.localDevState.targetProjectAccountId);
+        const appData = portalApps.find(({ sourceId }) => sourceId === this.appNode?.uid);
+        if (!appData) {
+            return;
+        }
+        const { data: { uniquePortalInstallCount }, } = await (0, appsDev_1.fetchPublicAppProductionInstallCounts)(appData.id, this.localDevState.targetProjectAccountId);
+        this.appData = appData;
+        this.marketplaceAppInstalls = uniquePortalInstallCount;
+    }
+    async checkMarketplaceAppInstalls() {
+        if (!this.appData || !this.marketplaceAppInstalls) {
+            return;
+        }
+        (0, ui_1.uiLine)();
+        logger_1.uiLogger.warn(en_1.lib.LocalDevManager.activeInstallWarning.installCount(this.appData.name, this.marketplaceAppInstalls));
+        logger_1.uiLogger.log(en_1.lib.LocalDevManager.activeInstallWarning.explanation);
+        (0, ui_1.uiLine)();
+        const proceed = await (0, promptUtils_1.confirmPrompt)(en_1.lib.LocalDevManager.activeInstallWarning.confirmationPrompt, { defaultAnswer: false });
+        if (!proceed) {
+            process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
+        }
+        this.localDevLogger.addUploadWarning(en_1.lib.AppDevModeInterface.defaultMarketplaceAppWarning(this.marketplaceAppInstalls));
+    }
+    async checkTestAccountAppInstallation() {
+        if (!this.appNode || !this.appData) {
+            return;
+        }
+        // If the app is static auth, always prompt the user to install the app.
+        // We are currently going this because we have no method to determine if the static auth app
+        // is already installed in the portal
+        if (this.appNode.config.auth.type === constants_1.APP_AUTH_TYPES.STATIC) {
+            return (0, installAppPrompt_1.installAppPrompt)(await this.getAppInstallUrl(), false);
+        }
+        const { data: { isInstalledWithScopeGroups, previouslyAuthorizedScopeGroups }, } = await (0, localDevAuth_1.fetchAppInstallationData)(this.localDevState.targetTestingAccountId, this.localDevState.projectId, this.appNode.uid, this.appNode.config.auth.requiredScopes, this.appNode.config.auth.optionalScopes);
+        const isReinstall = previouslyAuthorizedScopeGroups.length > 0;
+        if (!isInstalledWithScopeGroups) {
+            const installUrl = await this.getAppInstallUrl();
+            await (0, installAppPrompt_1.installAppPrompt)(installUrl, isReinstall);
+        }
+    }
+    // @ts-expect-error TODO: reconcile types between CLI and UIE Dev Server
+    // In the future, update UIE Dev Server to use LocalDevState
+    async setup(args) {
+        if (!this.appNode) {
+            return;
+        }
+        try {
+            await this.fetchAppData();
+            if (this.appNode.config.distribution === constants_1.APP_DISTRIBUTION_TYPES.MARKETPLACE) {
+                await this.checkMarketplaceAppInstalls();
+            }
+            await this.checkTestAccountAppInstallation();
+        }
+        catch (e) {
+            (0, index_1.logError)(e);
+        }
+        return ui_extensions_dev_server_1.DevModeUnifiedInterface.setup(args);
+    }
+    async start() {
+        if (!this.appNode) {
+            return;
+        }
+        return ui_extensions_dev_server_1.DevModeUnifiedInterface.start({
+            accountId: this.localDevState.targetTestingAccountId,
+            // @ts-expect-error TODO: reconcile types between CLI and UIE Dev Server
+            projectConfig: this.localDevState.projectConfig,
+            requestPorts: portManager_1.requestPorts,
+        });
+    }
+    async fileChange(filePath, event) {
+        if (!this.appNode) {
+            return;
+        }
+        return ui_extensions_dev_server_1.DevModeUnifiedInterface.fileChange(filePath, event);
+    }
+    async cleanup() {
+        if (!this.appNode) {
+            return;
+        }
+        return ui_extensions_dev_server_1.DevModeUnifiedInterface.cleanup();
+    }
+}
+exports.default = AppDevModeInterface;

package/lib/{DevServerManager.d.ts → projects/localDev/DevServerManager.d.ts}

@@ -1,4 +1,4 @@
-import { ProjectConfig, ComponentTypes, Component } from '../types/Projects';
+import { ProjectConfig, ComponentTypes, Component } from '../../../types/Projects';
 type DevServerInterface = {
     setup?: Function;
     start?: (options: object) => Promise<void>;