@hubspot/cli 7.5.11-experimental.0 → 7.7.0-experimental.0

package/types/Yargs.d.ts

@@ -1,4 +1,5 @@
 import { Options, CommandModule, Argv } from 'yargs';
+import { CmsPublishMode } from '@hubspot/local-dev-lib/types/Files';
 export type CommonArgs = {
     derivedAccountId: number;
     providedAccountId?: number;
@@ -23,10 +24,16 @@ export type OverwriteArgs = Options & {
 export type StringArgType = Options & {
     type: 'string';
 };
-export type ProjectDevArgs = CommonArgs & ConfigArgs & EnvironmentArgs;
+export type ProjectDevArgs = CommonArgs & ConfigArgs & EnvironmentArgs & {
+    profile?: string;
+};
 export type TestingArgs = {
     qa?: boolean;
 };
+export type CmsPublishModeArgs = {
+    'cms-publish-mode'?: CmsPublishMode;
+    m?: CmsPublishMode;
+};
 export interface YargsCommandModule<T, U> extends CommandModule<T, U> {
     builder: (yargs: Argv) => Promise<Argv<U>>;
 }

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

@@ -1,64 +0,0 @@
-import { FSWatcher } from 'chokidar';
-import { Build } from '@hubspot/local-dev-lib/types/Build';
-import { PublicApp } from '@hubspot/local-dev-lib/types/Apps';
-import { Environment } from '@hubspot/local-dev-lib/types/Config';
-import { ProjectConfig } from '../../../types/Projects';
-import { IntermediateRepresentationNodeLocalDev } from '@hubspot/project-parsing-lib/src/lib/types';
-import { AppIRNode } from '../../../types/ProjectComponents';
-type LocalDevManagerConstructorOptions = {
-    targetProjectAccountId: number;
-    targetTestingAccountId: number;
-    projectConfig: ProjectConfig;
-    projectDir: string;
-    projectId: number;
-    debug?: boolean;
-    deployedBuild?: Build;
-    isGithubLinked: boolean;
-    projectNodes: {
-        [key: string]: IntermediateRepresentationNodeLocalDev;
-    };
-    env: Environment;
-};
-declare class LocalDevManagerV2 {
-    targetProjectAccountId: number;
-    targetTestingAccountId: number;
-    projectConfig: ProjectConfig;
-    projectDir: string;
-    projectId: number;
-    debug: boolean;
-    deployedBuild?: Build;
-    isGithubLinked: boolean;
-    watcher: FSWatcher | null;
-    uploadWarnings: {
-        [key: string]: boolean;
-    };
-    projectNodes: {
-        [key: string]: IntermediateRepresentationNodeLocalDev;
-    };
-    activeApp: AppIRNode | null;
-    activePublicAppData: PublicApp | null;
-    env: Environment;
-    publicAppActiveInstalls: number | null;
-    projectSourceDir: string;
-    mostRecentUploadWarning: string | null;
-    constructor(options: LocalDevManagerConstructorOptions);
-    setActiveApp(appUid?: string): Promise<void>;
-    setActivePublicAppData(): Promise<void>;
-    checkActivePublicAppInstalls(): Promise<void>;
-    start(): Promise<void>;
-    stop(showProgress?: boolean): Promise<void>;
-    checkPublicAppInstallation(): Promise<void>;
-    updateKeypressListeners(): void;
-    getUploadCommand(): string;
-    logUploadWarning(reason?: string): void;
-    monitorConsoleOutput(): void;
-    compareLocalProjectToDeployed(): void;
-    startWatching(): void;
-    stopWatching(): Promise<void>;
-    handleWatchEvent(filePath: string, event: string, configPaths: string[]): void;
-    devServerSetup(): Promise<boolean>;
-    devServerStart(): Promise<void>;
-    devServerFileChange(filePath: string, event: string): void;
-    devServerCleanup(): Promise<boolean>;
-}
-export default LocalDevManagerV2;

package/lib/projects/localDev/LocalDevManagerV2.js

@@ -1,345 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const chokidar_1 = __importDefault(require("chokidar"));
-const chalk_1 = __importDefault(require("chalk"));
-const logger_1 = require("@hubspot/local-dev-lib/logger");
-const localDevAuth_1 = require("@hubspot/local-dev-lib/api/localDevAuth");
-const appsDev_1 = require("@hubspot/local-dev-lib/api/appsDev");
-const config_1 = require("@hubspot/local-dev-lib/config");
-const project_parsing_lib_1 = require("@hubspot/project-parsing-lib");
-const constants_1 = require("../../constants");
-const SpinniesManager_1 = __importDefault(require("../../ui/SpinniesManager"));
-const DevServerManagerV2_1 = __importDefault(require("./DevServerManagerV2"));
-const exitCodes_1 = require("../../enums/exitCodes");
-const urls_1 = require("../../projects/urls");
-const structure_1 = require("../../projects/structure");
-const ui_1 = require("../../ui");
-const index_1 = require("../../errorHandlers/index");
-const installPublicAppPrompt_1 = require("../../prompts/installPublicAppPrompt");
-const promptUtils_1 = require("../../prompts/promptUtils");
-const process_1 = require("../../process");
-const en_1 = require("../../../lang/en");
-const logger_2 = require("../../ui/logger");
-const WATCH_EVENTS = {
-    add: 'add',
-    change: 'change',
-    unlink: 'unlink',
-    unlinkDir: 'unlinkDir',
-};
-class LocalDevManagerV2 {
-    targetProjectAccountId;
-    targetTestingAccountId;
-    projectConfig;
-    projectDir;
-    projectId;
-    debug;
-    deployedBuild;
-    isGithubLinked;
-    watcher;
-    uploadWarnings;
-    projectNodes;
-    activeApp;
-    activePublicAppData;
-    env;
-    publicAppActiveInstalls;
-    projectSourceDir;
-    mostRecentUploadWarning;
-    constructor(options) {
-        this.targetProjectAccountId = options.targetProjectAccountId;
-        this.targetTestingAccountId = options.targetTestingAccountId;
-        this.projectConfig = options.projectConfig;
-        this.projectDir = options.projectDir;
-        this.projectId = options.projectId;
-        this.debug = options.debug || false;
-        this.deployedBuild = options.deployedBuild;
-        this.isGithubLinked = options.isGithubLinked;
-        this.watcher = null;
-        this.uploadWarnings = {};
-        this.projectNodes = options.projectNodes;
-        this.activeApp = null;
-        this.activePublicAppData = null;
-        this.env = options.env;
-        this.publicAppActiveInstalls = null;
-        this.mostRecentUploadWarning = null;
-        this.projectSourceDir = path_1.default.join(this.projectDir, this.projectConfig.srcDir);
-        if (!this.targetProjectAccountId ||
-            !this.projectConfig ||
-            !this.projectDir) {
-            logger_2.uiLogger.log(en_1.lib.LocalDevManager.failedToInitialize);
-            process.exit(exitCodes_1.EXIT_CODES.ERROR);
-        }
-    }
-    async setActiveApp(appUid) {
-        if (!appUid) {
-            logger_2.uiLogger.error(en_1.lib.LocalDevManager.missingUid);
-            process.exit(exitCodes_1.EXIT_CODES.ERROR);
-        }
-        const app = Object.values(this.projectNodes).find(component => component.uid === appUid) || null;
-        if (app && (0, structure_1.isAppIRNode)(app)) {
-            this.activeApp = app;
-            if (app.config.distribution === constants_1.APP_DISTRIBUTION_TYPES.MARKETPLACE) {
-                try {
-                    await this.setActivePublicAppData();
-                    await this.checkActivePublicAppInstalls();
-                    await this.checkPublicAppInstallation();
-                }
-                catch (e) {
-                    (0, index_1.logError)(e);
-                }
-            }
-        }
-        return;
-    }
-    async setActivePublicAppData() {
-        const { data: { results: portalPublicApps }, } = await (0, appsDev_1.fetchPublicAppsForPortal)(this.targetProjectAccountId);
-        const activePublicAppData = portalPublicApps.find(({ sourceId }) => sourceId === this.activeApp?.uid);
-        if (!activePublicAppData) {
-            return;
-        }
-        const { data: { uniquePortalInstallCount }, } = await (0, appsDev_1.fetchPublicAppProductionInstallCounts)(activePublicAppData.id, this.targetProjectAccountId);
-        this.activePublicAppData = activePublicAppData;
-        this.publicAppActiveInstalls = uniquePortalInstallCount;
-    }
-    async checkActivePublicAppInstalls() {
-        if (!this.activePublicAppData ||
-            !this.publicAppActiveInstalls ||
-            this.publicAppActiveInstalls < 1) {
-            return;
-        }
-        (0, ui_1.uiLine)();
-        logger_2.uiLogger.warn(en_1.lib.LocalDevManager.activeInstallWarning.installCount(this.activePublicAppData.name, this.publicAppActiveInstalls, this.publicAppActiveInstalls === 1 ? 'account' : 'accounts'));
-        logger_2.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);
-        }
-    }
-    async start() {
-        SpinniesManager_1.default.stopAll();
-        SpinniesManager_1.default.init();
-        // Local dev currently relies on the existence of a deployed build in the target account
-        if (!this.deployedBuild) {
-            logger_2.uiLogger.error(en_1.lib.LocalDevManager.noDeployedBuild(this.projectConfig.name, (0, ui_1.uiAccountDescription)(this.targetProjectAccountId), this.getUploadCommand()));
-            logger_2.uiLogger.log('');
-            process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
-        }
-        const setupSucceeded = await this.devServerSetup();
-        if (!setupSucceeded) {
-            process.exit(exitCodes_1.EXIT_CODES.ERROR);
-        }
-        else if (!this.debug) {
-            console.clear();
-        }
-        (0, ui_1.uiBetaTag)(en_1.lib.LocalDevManager.betaMessage);
-        logger_2.uiLogger.log((0, ui_1.uiLink)(en_1.lib.LocalDevManager.learnMoreLocalDevServer, 'https://developers.hubspot.com/docs/platform/project-cli-commands#start-a-local-development-server'));
-        logger_2.uiLogger.log('');
-        logger_2.uiLogger.log(chalk_1.default.hex(ui_1.UI_COLORS.SORBET)(en_1.lib.LocalDevManager.running(this.projectConfig.name, (0, ui_1.uiAccountDescription)(this.targetProjectAccountId))));
-        logger_2.uiLogger.log((0, ui_1.uiLink)(en_1.lib.LocalDevManager.viewProjectLink, (0, urls_1.getProjectDetailUrl)(this.projectConfig.name, this.targetProjectAccountId) || ''));
-        logger_2.uiLogger.log('');
-        logger_2.uiLogger.log(en_1.lib.LocalDevManager.quitHelper);
-        (0, ui_1.uiLine)();
-        logger_2.uiLogger.log('');
-        await this.devServerStart();
-        // Initialize project file watcher to detect configuration file changes
-        this.startWatching();
-        this.updateKeypressListeners();
-        this.monitorConsoleOutput();
-        // Verify that there are no mismatches between components in the local project
-        // and components in the deployed build of the project.
-        this.compareLocalProjectToDeployed();
-    }
-    async stop(showProgress = true) {
-        if (showProgress) {
-            SpinniesManager_1.default.add('cleanupMessage', {
-                text: en_1.lib.LocalDevManager.exitingStart,
-            });
-        }
-        await this.stopWatching();
-        const cleanupSucceeded = await this.devServerCleanup();
-        if (!cleanupSucceeded) {
-            if (showProgress) {
-                SpinniesManager_1.default.fail('cleanupMessage', {
-                    text: en_1.lib.LocalDevManager.exitingFail,
-                });
-            }
-            process.exit(exitCodes_1.EXIT_CODES.ERROR);
-        }
-        if (showProgress) {
-            SpinniesManager_1.default.succeed('cleanupMessage', {
-                text: en_1.lib.LocalDevManager.exitingSucceed,
-            });
-        }
-        process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
-    }
-    async checkPublicAppInstallation() {
-        if (!this.activeApp || !this.activePublicAppData) {
-            return;
-        }
-        const { data: { isInstalledWithScopeGroups, previouslyAuthorizedScopeGroups }, } = await (0, localDevAuth_1.fetchAppInstallationData)(this.targetTestingAccountId, this.projectId, this.activeApp.uid, this.activeApp.config.auth.requiredScopes, this.activeApp.config.auth.optionalScopes);
-        const isReinstall = previouslyAuthorizedScopeGroups.length > 0;
-        if (!isInstalledWithScopeGroups) {
-            await (0, installPublicAppPrompt_1.installPublicAppPrompt)(this.env, this.targetTestingAccountId, this.activePublicAppData.clientId, this.activeApp.config.auth.requiredScopes, this.activeApp.config.auth.redirectUrls, isReinstall);
-        }
-    }
-    updateKeypressListeners() {
-        (0, process_1.handleKeypress)(async (key) => {
-            if ((key.ctrl && key.name === 'c') || key.name === 'q') {
-                this.stop();
-            }
-        });
-    }
-    getUploadCommand() {
-        const currentDefaultAccount = (0, config_1.getConfigDefaultAccount)() || undefined;
-        return this.targetProjectAccountId !== (0, config_1.getAccountId)(currentDefaultAccount)
-            ? (0, ui_1.uiCommandReference)(`hs project upload --account=${this.targetProjectAccountId}`)
-            : (0, ui_1.uiCommandReference)('hs project upload');
-    }
-    logUploadWarning(reason) {
-        let warning = reason;
-        if (!warning) {
-            warning =
-                this.publicAppActiveInstalls && this.publicAppActiveInstalls > 0
-                    ? en_1.lib.LocalDevManager.uploadWarning.defaultMarketplaceAppWarning(this.publicAppActiveInstalls, this.publicAppActiveInstalls === 1 ? 'account' : 'accounts')
-                    : en_1.lib.LocalDevManager.uploadWarning.defaultWarning;
-        }
-        // Avoid logging the warning to the console if it is currently the most
-        // recently logged warning. We do not want to spam the console with the same message.
-        if (!this.uploadWarnings[warning]) {
-            logger_2.uiLogger.log('');
-            logger_2.uiLogger.warn(en_1.lib.LocalDevManager.uploadWarning.header(warning));
-            logger_2.uiLogger.log(en_1.lib.LocalDevManager.uploadWarning.stopDev);
-            if (this.isGithubLinked) {
-                logger_2.uiLogger.log(en_1.lib.LocalDevManager.uploadWarning.pushToGithub);
-            }
-            else {
-                logger_2.uiLogger.log(en_1.lib.LocalDevManager.uploadWarning.runUpload(this.getUploadCommand()));
-            }
-            logger_2.uiLogger.log(en_1.lib.LocalDevManager.uploadWarning.restartDev);
-            this.mostRecentUploadWarning = warning;
-            this.uploadWarnings[warning] = true;
-        }
-    }
-    monitorConsoleOutput() {
-        const originalStdoutWrite = process.stdout.write.bind(process.stdout);
-        function customStdoutWrite(chunk, encoding, callback) {
-            // Reset the most recently logged warning
-            if (this.mostRecentUploadWarning &&
-                this.uploadWarnings[this.mostRecentUploadWarning]) {
-                delete this.uploadWarnings[this.mostRecentUploadWarning];
-            }
-            if (typeof encoding === 'function') {
-                return originalStdoutWrite(chunk, callback);
-            }
-            return originalStdoutWrite(chunk, encoding, callback);
-        }
-        customStdoutWrite.bind(this);
-        process.stdout.write = customStdoutWrite;
-    }
-    compareLocalProjectToDeployed() {
-        const deployedComponentNames = this.deployedBuild.subbuildStatuses.map(subbuildStatus => subbuildStatus.buildName);
-        const missingProjectNodes = [];
-        Object.values(this.projectNodes).forEach(node => {
-            if (!deployedComponentNames.includes(node.uid)) {
-                const userFriendlyName = (0, project_parsing_lib_1.mapToUserFriendlyName)(node.componentType);
-                const label = userFriendlyName ? `[${userFriendlyName}] ` : '';
-                missingProjectNodes.push(`${label}${node.uid}`);
-            }
-        });
-        if (missingProjectNodes.length) {
-            this.logUploadWarning(en_1.lib.LocalDevManager.uploadWarning.missingComponents(missingProjectNodes.join(', ')));
-        }
-    }
-    startWatching() {
-        this.watcher = chokidar_1.default.watch(this.projectDir, {
-            ignoreInitial: true,
-        });
-        const configPaths = Object.values(this.projectNodes).map(component => component.localDev.componentConfigPath);
-        const projectConfigPath = path_1.default.join(this.projectDir, constants_1.PROJECT_CONFIG_FILE);
-        configPaths.push(projectConfigPath);
-        this.watcher.on('add', filePath => {
-            this.handleWatchEvent(filePath, WATCH_EVENTS.add, configPaths);
-        });
-        this.watcher.on('change', filePath => {
-            this.handleWatchEvent(filePath, WATCH_EVENTS.change, configPaths);
-        });
-        this.watcher.on('unlink', filePath => {
-            this.handleWatchEvent(filePath, WATCH_EVENTS.unlink, configPaths);
-        });
-        this.watcher.on('unlinkDir', filePath => {
-            this.handleWatchEvent(filePath, WATCH_EVENTS.unlinkDir, configPaths);
-        });
-    }
-    async stopWatching() {
-        await this.watcher?.close();
-    }
-    handleWatchEvent(filePath, event, configPaths) {
-        if (configPaths.includes(filePath)) {
-            this.logUploadWarning();
-        }
-        else {
-            this.devServerFileChange(filePath, event);
-        }
-    }
-    async devServerSetup() {
-        try {
-            await DevServerManagerV2_1.default.setup({
-                projectNodes: this.projectNodes,
-                accountId: this.targetTestingAccountId,
-                setActiveApp: this.setActiveApp.bind(this),
-            });
-            return true;
-        }
-        catch (e) {
-            if (this.debug) {
-                logger_1.logger.error(e);
-            }
-            logger_2.uiLogger.error(en_1.lib.LocalDevManager.devServer.setupError(e instanceof Error ? e.message : ''));
-            return false;
-        }
-    }
-    async devServerStart() {
-        try {
-            await DevServerManagerV2_1.default.start({
-                accountId: this.targetTestingAccountId,
-                projectConfig: this.projectConfig,
-            });
-        }
-        catch (e) {
-            if (this.debug) {
-                logger_1.logger.error(e);
-            }
-            logger_2.uiLogger.error(en_1.lib.LocalDevManager.devServer.startError(e instanceof Error ? e.message : ''));
-            process.exit(exitCodes_1.EXIT_CODES.ERROR);
-        }
-    }
-    devServerFileChange(filePath, event) {
-        try {
-            DevServerManagerV2_1.default.fileChange({ filePath, event });
-        }
-        catch (e) {
-            if (this.debug) {
-                logger_1.logger.error(e);
-            }
-            logger_2.uiLogger.error(en_1.lib.LocalDevManager.devServer.fileChangeError(e instanceof Error ? e.message : ''));
-        }
-    }
-    async devServerCleanup() {
-        try {
-            await DevServerManagerV2_1.default.cleanup();
-            return true;
-        }
-        catch (e) {
-            if (this.debug) {
-                logger_1.logger.error(e);
-            }
-            logger_2.uiLogger.error(en_1.lib.LocalDevManager.devServer.cleanupError(e instanceof Error ? e.message : ''));
-            return false;
-        }
-    }
-}
-exports.default = LocalDevManagerV2;

package/lib/prompts/installPublicAppPrompt.d.ts

@@ -1 +0,0 @@
-export declare function installPublicAppPrompt(env: string, targetAccountId: number, clientId: string, scopes: string[], redirectUrls: string[], isReinstall?: boolean): Promise<void>;

package/lib/prompts/installPublicAppPrompt.js

@@ -1,41 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.installPublicAppPrompt = installPublicAppPrompt;
-const open_1 = __importDefault(require("open"));
-const urls_1 = require("@hubspot/local-dev-lib/urls");
-const logger_1 = require("@hubspot/local-dev-lib/logger");
-const promptUtils_1 = require("./promptUtils");
-const lang_1 = require("../lang");
-const exitCodes_1 = require("../enums/exitCodes");
-async function installPublicAppPrompt(env, targetAccountId, clientId, scopes, redirectUrls, isReinstall = false) {
-    logger_1.logger.log('');
-    if (isReinstall) {
-        logger_1.logger.log((0, lang_1.i18n)(`lib.prompts.installPublicAppPrompt.reinstallExplanation`));
-    }
-    else {
-        logger_1.logger.log((0, lang_1.i18n)(`lib.prompts.installPublicAppPrompt.explanation`));
-    }
-    const { shouldOpenBrowser } = await (0, promptUtils_1.promptUser)({
-        name: 'shouldOpenBrowser',
-        type: 'confirm',
-        message: (0, lang_1.i18n)(isReinstall
-            ? `lib.prompts.installPublicAppPrompt.reinstallPrompt`
-            : `lib.prompts.installPublicAppPrompt.prompt`),
-    });
-    if (!isReinstall && !shouldOpenBrowser) {
-        logger_1.logger.log((0, lang_1.i18n)(`lib.prompts.installPublicAppPrompt.decline`));
-        process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
-    }
-    else if (!shouldOpenBrowser) {
-        return;
-    }
-    const websiteOrigin = (0, urls_1.getHubSpotWebsiteOrigin)(env);
-    const url = `${websiteOrigin}/oauth/${targetAccountId}/authorize` +
-        `?client_id=${encodeURIComponent(clientId)}` +
-        `&scope=${encodeURIComponent(scopes.join(' '))}` +
-        `&redirect_uri=${encodeURIComponent(redirectUrls[0])}`;
-    (0, open_1.default)(url);
-}