@hubspot/cli 7.2.1-experimental.0 → 7.2.2-experimental.0

package/lib/LocalDevManagerV2.js

@@ -1,382 +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 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 lang_1 = require("./lang");
-const process_1 = require("./process");
-const WATCH_EVENTS = {
-    add: 'add',
-    change: 'change',
-    unlink: 'unlink',
-    unlinkDir: 'unlinkDir',
-};
-const i18nKey = 'lib.LocalDevManager';
-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_1.logger.log((0, lang_1.i18n)(`${i18nKey}.failedToInitialize`));
-            process.exit(exitCodes_1.EXIT_CODES.ERROR);
-        }
-    }
-    async setActiveApp(appUid) {
-        if (!appUid) {
-            logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.missingUid`, {
-                devCommand: (0, ui_1.uiCommandReference)('hs project dev'),
-            }));
-            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_1.logger.warn((0, lang_1.i18n)(`${i18nKey}.activeInstallWarning.installCount`, {
-            appName: this.activePublicAppData.name,
-            installCount: this.publicAppActiveInstalls,
-            installText: this.publicAppActiveInstalls === 1 ? 'install' : 'installs',
-        }));
-        logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.activeInstallWarning.explanation`));
-        (0, ui_1.uiLine)();
-        const proceed = await (0, promptUtils_1.confirmPrompt)((0, lang_1.i18n)(`${i18nKey}.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_1.logger.error((0, lang_1.i18n)(`${i18nKey}.noDeployedBuild`, {
-                projectName: this.projectConfig.name,
-                accountIdentifier: (0, ui_1.uiAccountDescription)(this.targetProjectAccountId),
-                uploadCommand: this.getUploadCommand(),
-            }));
-            logger_1.logger.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)((0, lang_1.i18n)(`${i18nKey}.betaMessage`));
-        logger_1.logger.log((0, ui_1.uiLink)((0, lang_1.i18n)(`${i18nKey}.learnMoreLocalDevServer`), 'https://developers.hubspot.com/docs/platform/project-cli-commands#start-a-local-development-server'));
-        logger_1.logger.log();
-        logger_1.logger.log(chalk_1.default.hex(ui_1.UI_COLORS.SORBET)((0, lang_1.i18n)(`${i18nKey}.running`, {
-            accountIdentifier: (0, ui_1.uiAccountDescription)(this.targetProjectAccountId),
-            projectName: this.projectConfig.name,
-        })));
-        logger_1.logger.log((0, ui_1.uiLink)((0, lang_1.i18n)(`${i18nKey}.viewProjectLink`), (0, urls_1.getProjectDetailUrl)(this.projectConfig.name, this.targetProjectAccountId) || ''));
-        logger_1.logger.log();
-        logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.quitHelper`));
-        (0, ui_1.uiLine)();
-        logger_1.logger.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: (0, lang_1.i18n)(`${i18nKey}.exitingStart`),
-            });
-        }
-        await this.stopWatching();
-        const cleanupSucceeded = await this.devServerCleanup();
-        if (!cleanupSucceeded) {
-            if (showProgress) {
-                SpinniesManager_1.default.fail('cleanupMessage', {
-                    text: (0, lang_1.i18n)(`${i18nKey}.exitingFail`),
-                });
-            }
-            process.exit(exitCodes_1.EXIT_CODES.ERROR);
-        }
-        if (showProgress) {
-            SpinniesManager_1.default.succeed('cleanupMessage', {
-                text: (0, lang_1.i18n)(`${i18nKey}.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;
-        if (reason) {
-            warning = reason;
-        }
-        else {
-            warning =
-                this.publicAppActiveInstalls && this.publicAppActiveInstalls > 0
-                    ? (0, lang_1.i18n)(`${i18nKey}.uploadWarning.defaultPublicAppWarning`, {
-                        installCount: this.publicAppActiveInstalls,
-                        installText: this.publicAppActiveInstalls === 1 ? 'install' : 'installs',
-                    })
-                    : (0, lang_1.i18n)(`${i18nKey}.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_1.logger.log();
-            logger_1.logger.warn((0, lang_1.i18n)(`${i18nKey}.uploadWarning.header`, { warning }));
-            logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.uploadWarning.stopDev`, {
-                command: (0, ui_1.uiCommandReference)('hs project dev'),
-            }));
-            if (this.isGithubLinked) {
-                logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.uploadWarning.pushToGithub`));
-            }
-            else {
-                logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.uploadWarning.runUpload`, {
-                    command: this.getUploadCommand(),
-                }));
-            }
-            logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.uploadWarning.restartDev`, {
-                command: (0, ui_1.uiCommandReference)('hs project dev'),
-            }));
-            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 ((0, structure_1.isAppIRNode)(node) || (0, structure_1.isCardIRNode)(node)) {
-                if (!deployedComponentNames.includes(node.uid)) {
-                    missingProjectNodes.push(`${(0, lang_1.i18n)(`${i18nKey}.uploadWarning.appLabel`)} ${node.uid}`);
-                }
-            }
-        });
-        if (missingProjectNodes.length) {
-            this.logUploadWarning((0, lang_1.i18n)(`${i18nKey}.uploadWarning.missingComponents`, {
-                missingComponents: missingProjectNodes.join(', '),
-            }));
-        }
-    }
-    startWatching() {
-        this.watcher = chokidar_1.default.watch(this.projectDir, {
-            ignoreInitial: true,
-        });
-        const configPaths = Object.values(this.projectNodes)
-            .filter(structure_1.isAppIRNode)
-            .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,
-                onUploadRequired: this.logUploadWarning.bind(this),
-                accountId: this.targetTestingAccountId,
-                setActiveApp: this.setActiveApp.bind(this),
-            });
-            return true;
-        }
-        catch (e) {
-            if (this.debug) {
-                logger_1.logger.error(e);
-            }
-            logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.devServer.setupError`, {
-                message: 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_1.logger.error((0, lang_1.i18n)(`${i18nKey}.devServer.startError`, {
-                message: 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_1.logger.error((0, lang_1.i18n)(`${i18nKey}.devServer.fileChangeError`, {
-                message: 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_1.logger.error((0, lang_1.i18n)(`${i18nKey}.devServer.cleanupError`, {
-                message: e instanceof Error ? e.message : '',
-            }));
-            return false;
-        }
-    }
-}
-exports.default = LocalDevManagerV2;

package/lib/customObject.d.ts

@@ -1,3 +0,0 @@
-import { SchemaDefinition, ObjectDefinition } from '@hubspot/local-dev-lib/types/Schemas';
-export declare function isSchemaDefinition(schema: unknown): schema is SchemaDefinition;
-export declare function isObjectDefinition(object: unknown): object is ObjectDefinition;

package/lib/customObject.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSchemaDefinition = isSchemaDefinition;
-exports.isObjectDefinition = isObjectDefinition;
-function isSchemaDefinition(schema) {
-    return (typeof schema === 'object' &&
-        schema !== null &&
-        'labels' in schema &&
-        'name' in schema &&
-        'properties' in schema &&
-        'requiredProperties' in schema);
-}
-function isObjectDefinition(object) {
-    return typeof object === 'object' && object !== null && 'inputs' in object;
-}

package/lib/projects/create.d.ts

@@ -1,5 +0,0 @@
-import { RepoPath } from '@hubspot/local-dev-lib/types/Github';
-import { ProjectTemplate, ComponentTemplate } from '../../types/Projects';
-export declare const EMPTY_PROJECT_TEMPLATE_NAME = "no-template";
-export declare function getProjectComponentListFromRepo(githubRef: string): Promise<ComponentTemplate[]>;
-export declare function getProjectTemplateListFromRepo(templateSource: RepoPath, githubRef: string): Promise<ProjectTemplate[]>;

package/lib/projects/create.js

@@ -1,51 +0,0 @@
-"use strict";
-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';
-exports.EMPTY_PROJECT_TEMPLATE_NAME = 'no-template';
-const PROJECT_TEMPLATE_PROPERTIES = ['name', 'label', 'path', 'insertPath'];
-async function getProjectComponentListFromRepo(githubRef) {
-    let config;
-    try {
-        const { data } = await (0, github_1.fetchRepoFile)(constants_1.HUBSPOT_PROJECT_COMPONENTS_GITHUB_PATH, 'config.json', githubRef);
-        config = data;
-    }
-    catch (err) {
-        (0, index_1.debugError)(err);
-    }
-    if (config) {
-        return config[constants_1.PROJECT_COMPONENT_TYPES.COMPONENTS] || [];
-    }
-    return [];
-}
-async function getProjectTemplateListFromRepo(templateSource, githubRef) {
-    let config;
-    try {
-        const { data } = await (0, github_1.fetchRepoFile)(templateSource, 'config.json', githubRef);
-        config = data;
-    }
-    catch (e) {
-        (0, index_1.debugError)(e);
-        logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.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`));
-        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`));
-        return process.exit(exitCodes_1.EXIT_CODES.ERROR);
-    }
-    return templates;
-}

package/lib/testUtils.d.ts

@@ -1,12 +0,0 @@
-import { HubSpotHttpError } from '@hubspot/local-dev-lib/models/HubSpotHttpError';
-type MockResponse = {
-    status: number;
-    data: {
-        message?: string;
-        errorType?: string;
-        category?: string;
-        subCategory?: string;
-    };
-};
-export declare const makeHubSpotHttpError: (message: string, response: MockResponse) => HubSpotHttpError;
-export {};

package/lib/testUtils.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeHubSpotHttpError = void 0;
-const HubSpotHttpError_1 = require("@hubspot/local-dev-lib/models/HubSpotHttpError");
-const makeHubSpotHttpError = (message, response) => {
-    return new HubSpotHttpError_1.HubSpotHttpError(message, {
-        cause: { isAxiosError: true, response },
-    });
-};
-exports.makeHubSpotHttpError = makeHubSpotHttpError;

package/types/ProjectComponents.d.ts

@@ -1,38 +0,0 @@
-import { IntermediateRepresentationNodeLocalDev } from '@hubspot/project-parsing-lib/src/lib/types';
-import { IR_COMPONENT_TYPES, APP_DISTRIBUTION_TYPES, APP_AUTH_TYPES } from '../lib/constants';
-import { ValueOf } from '@hubspot/local-dev-lib/types/Utils';
-type AppDistributionType = ValueOf<typeof APP_DISTRIBUTION_TYPES>;
-type AppAuthType = ValueOf<typeof APP_AUTH_TYPES>;
-type AppConfig = {
-    description: string;
-    name: string;
-    logo: string;
-    distribution: AppDistributionType;
-    auth: {
-        type: AppAuthType;
-        redirectUrls: string[];
-        requiredScopes: string[];
-        optionalScopes: string[];
-        conditionallyRequiredScopes: string[];
-    };
-};
-type CardConfig = {
-    name: string;
-    description: string;
-    previewImage: {
-        file: string;
-        altText: string;
-    };
-    entrypoint: string;
-    location: string;
-    objectTypes: string[];
-};
-export interface AppIRNode extends IntermediateRepresentationNodeLocalDev {
-    componentType: typeof IR_COMPONENT_TYPES.APPLICATION;
-    config: AppConfig;
-}
-export interface CardIRNode extends IntermediateRepresentationNodeLocalDev {
-    componentType: typeof IR_COMPONENT_TYPES.CARD;
-    config: CardConfig;
-}
-export {};

package/types/ProjectComponents.js

@@ -1,3 +0,0 @@
-"use strict";
-// These types are for Unified Apps and projects on platform version 2025.1 and above
-Object.defineProperty(exports, "__esModule", { value: true });