@hubspot/cli 7.7.21-experimental.1 → 7.7.23-experimental.0

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

@@ -1,7 +1,7 @@
-import { IntermediateRepresentationNodeLocalDev } from '@hubspot/project-parsing-lib/src/lib/types';
-import LocalDevState from './LocalDevState';
-import LocalDevLogger from './LocalDevLogger';
-import { LocalDevStateConstructorOptions, LocalDevStateListener, LocalDevServerMessage } from '../../../types/LocalDev';
+import { IntermediateRepresentationNodeLocalDev } from '@hubspot/project-parsing-lib/src/lib/types.js';
+import LocalDevState from './LocalDevState.js';
+import LocalDevLogger from './LocalDevLogger.js';
+import { LocalDevStateConstructorOptions, LocalDevStateListener, LocalDevServerMessage } from '../../../types/LocalDev.js';
 declare class LocalDevProcess {
     private state;
     private _logger;
@@ -24,6 +24,7 @@ declare class LocalDevProcess {
     private getIntermediateRepresentation;
     private updateProjectNodes;
     private updateProjectNodesAfterUpload;
+    private openLocalDevUi;
     handleFileChange(filePath: string, event: string): Promise<void>;
     handleConfigFileChange(): Promise<void>;
     start(): Promise<void>;

package/lib/projects/localDev/LocalDevProcess.js

@@ -1,26 +1,26 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const project_parsing_lib_1 = require("@hubspot/project-parsing-lib");
-const path_1 = __importDefault(require("path"));
-const LocalDevState_1 = __importDefault(require("./LocalDevState"));
-const LocalDevLogger_1 = __importDefault(require("./LocalDevLogger"));
-const DevServerManagerV2_1 = __importDefault(require("./DevServerManagerV2"));
-const exitCodes_1 = require("../../enums/exitCodes");
-const transform_1 = require("@hubspot/project-parsing-lib/src/lib/transform");
-const config_1 = require("../config");
-const upload_1 = require("../upload");
-const buildAndDeploy_1 = require("../buildAndDeploy");
+import { translateForLocalDev } from '@hubspot/project-parsing-lib';
+import { hasLocalStateFlag } from '@hubspot/local-dev-lib/config';
+import path from 'path';
+import open from 'open';
+import LocalDevState from './LocalDevState.js';
+import LocalDevLogger from './LocalDevLogger.js';
+import DevServerManagerV2 from './DevServerManagerV2.js';
+import { EXIT_CODES } from '../../enums/exitCodes.js';
+import { mapToUserFriendlyName } from '@hubspot/project-parsing-lib/src/lib/transform.js';
+import { getProjectConfig } from '../config.js';
+import { handleProjectUpload } from '../upload.js';
+import { pollProjectBuildAndDeploy } from '../buildAndDeploy.js';
+import { getLocalDevUiUrl } from '../urls.js';
+import { CONFIG_LOCAL_STATE_FLAGS } from '../../constants.js';
+import { isAutoOpenBrowserEnabled } from '../../configOptions.js';
 class LocalDevProcess {
     state;
     _logger;
     devServerManager;
     constructor(options) {
-        this.state = new LocalDevState_1.default(options);
-        this._logger = new LocalDevLogger_1.default(this.state);
-        this.devServerManager = new DevServerManagerV2_1.default({
+        this.state = new LocalDevState(options);
+        this._logger = new LocalDevLogger(this.state);
+        this.devServerManager = new DevServerManagerV2({
             localDevState: this.state,
             logger: this._logger,
         });
@@ -62,7 +62,7 @@ class LocalDevProcess {
         }
         catch (e) {
             this.logger.devServerStartError(e);
-            process.exit(exitCodes_1.EXIT_CODES.ERROR);
+            process.exit(EXIT_CODES.ERROR);
         }
     }
     async cleanupDevServers() {
@@ -80,7 +80,7 @@ class LocalDevProcess {
         const missingProjectNodes = [];
         Object.values(this.projectNodes).forEach(node => {
             if (!deployedComponentNames.includes(node.uid)) {
-                const userFriendlyName = (0, transform_1.mapToUserFriendlyName)(node.componentType);
+                const userFriendlyName = mapToUserFriendlyName(node.componentType);
                 const label = userFriendlyName ? `[${userFriendlyName}] ` : '';
                 missingProjectNodes.push(`${label}${node.uid}`);
             }
@@ -90,7 +90,7 @@ class LocalDevProcess {
         }
     }
     async projectConfigValidForUpload() {
-        const { projectConfig } = await (0, config_1.getProjectConfig)();
+        const { projectConfig } = await getProjectConfig();
         if (!projectConfig) {
             return false;
         }
@@ -103,8 +103,8 @@ class LocalDevProcess {
         return true;
     }
     getIntermediateRepresentation(projectNodesAtLastUpload) {
-        return (0, project_parsing_lib_1.translateForLocalDev)({
-            projectSourceDir: path_1.default.join(this.state.projectDir, this.state.projectConfig.srcDir),
+        return translateForLocalDev({
+            projectSourceDir: path.join(this.state.projectDir, this.state.projectConfig.srcDir),
             platformVersion: this.state.projectConfig.platformVersion,
             accountId: this.state.targetProjectAccountId,
         }, {
@@ -124,6 +124,10 @@ class LocalDevProcess {
         this.state.projectNodesAtLastUpload =
             intermediateRepresentation.intermediateNodesIndexedByUid;
     }
+    openLocalDevUi() {
+        const showWelcomeScreen = !hasLocalStateFlag(CONFIG_LOCAL_STATE_FLAGS.LOCAL_DEV_UI_WELCOME);
+        open(getLocalDevUiUrl(this.state.targetTestingAccountId, showWelcomeScreen));
+    }
     async handleFileChange(filePath, event) {
         await this.updateProjectNodes();
         try {
@@ -142,13 +146,16 @@ class LocalDevProcess {
         // Local dev currently relies on the existence of a deployed build in the target account
         if (!this.state.deployedBuild) {
             this.logger.noDeployedBuild();
-            process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
+            process.exit(EXIT_CODES.SUCCESS);
         }
         const setupSucceeded = await this.setupDevServers();
         if (!setupSucceeded) {
-            process.exit(exitCodes_1.EXIT_CODES.ERROR);
+            process.exit(EXIT_CODES.ERROR);
         }
         this.logger.startupMessage();
+        if (isAutoOpenBrowserEnabled()) {
+            this.openLocalDevUi();
+        }
         await this.startDevServers();
         this.logger.monitorConsoleOutput();
         // Verify that there are no mismatches between components in the local project
@@ -164,12 +171,12 @@ class LocalDevProcess {
             if (showProgress) {
                 this.logger.cleanupError();
             }
-            process.exit(exitCodes_1.EXIT_CODES.ERROR);
+            process.exit(EXIT_CODES.ERROR);
         }
         if (showProgress) {
             this.logger.cleanupSuccess();
         }
-        process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
+        process.exit(EXIT_CODES.SUCCESS);
     }
     async uploadProject() {
         this.logger.uploadInitiated();
@@ -178,11 +185,11 @@ class LocalDevProcess {
             this.logger.projectConfigMismatch();
             return false;
         }
-        const { uploadError } = await (0, upload_1.handleProjectUpload)({
+        const { uploadError } = await handleProjectUpload({
             accountId: this.state.targetProjectAccountId,
             projectConfig: this.state.projectConfig,
             projectDir: this.state.projectDir,
-            callbackFunc: buildAndDeploy_1.pollProjectBuildAndDeploy,
+            callbackFunc: pollProjectBuildAndDeploy,
             sendIR: true,
             skipValidation: true,
         });
@@ -202,4 +209,4 @@ class LocalDevProcess {
         this.state.devServerMessage = message;
     }
 }
-exports.default = LocalDevProcess;
+export default LocalDevProcess;

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

@@ -1,8 +1,8 @@
 import { Build } from '@hubspot/local-dev-lib/types/Build';
-import { IntermediateRepresentationNodeLocalDev } from '@hubspot/project-parsing-lib/src/lib/types';
+import { IntermediateRepresentationNodeLocalDev } from '@hubspot/project-parsing-lib/src/lib/types.js';
 import { Environment } from '@hubspot/local-dev-lib/types/Config';
-import { ProjectConfig } from '../../../types/Projects';
-import { LocalDevStateConstructorOptions, LocalDevStateListener, AppLocalDevData, LocalDevServerMessage } from '../../../types/LocalDev';
+import { ProjectConfig } from '../../../types/Projects.js';
+import { LocalDevStateConstructorOptions, LocalDevStateListener, AppLocalDevData, LocalDevServerMessage } from '../../../types/LocalDev.js';
 declare class LocalDevState {
     private _targetProjectAccountId;
     private _targetTestingAccountId;

package/lib/projects/localDev/LocalDevState.js

@@ -1,6 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const constants_1 = require("../../constants");
+import { LOCAL_DEV_SERVER_MESSAGE_TYPES } from '../../constants.js';
 class LocalDevState {
     _targetProjectAccountId;
     _targetTestingAccountId;
@@ -33,7 +31,7 @@ class LocalDevState {
         this._projectNodesAtLastUpload = initialProjectNodes;
         this._env = env;
         this._appData = {};
-        this._devServerMessage = constants_1.LOCAL_DEV_SERVER_MESSAGE_TYPES.INITIAL;
+        this._devServerMessage = LOCAL_DEV_SERVER_MESSAGE_TYPES.INITIAL;
         this._listeners = {};
     }
     runListeners(key) {
@@ -114,4 +112,4 @@ class LocalDevState {
         }
     }
 }
-exports.default = LocalDevState;
+export default LocalDevState;

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

@@ -1,4 +1,4 @@
-import LocalDevProcess from './LocalDevProcess';
+import LocalDevProcess from './LocalDevProcess.js';
 declare class LocalDevWatcher {
     private localDevProcess;
     private watcher;

package/lib/projects/localDev/LocalDevWatcher.js

@@ -1,11 +1,6 @@
-"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 constants_1 = require("../../constants");
+import path from 'path';
+import chokidar from 'chokidar';
+import { PROJECT_CONFIG_FILE } from '../../constants.js';
 const WATCH_EVENTS = {
     add: 'add',
     change: 'change',
@@ -26,12 +21,12 @@ class LocalDevWatcher {
         return this.localDevProcess.handleFileChange(filePath, event);
     }
     start() {
-        this.watcher = chokidar_1.default.watch(this.localDevProcess.projectDir, {
+        this.watcher = chokidar.watch(this.localDevProcess.projectDir, {
             ignoreInitial: true,
             ignored: ['**/dist'],
         });
         const configPaths = Object.values(this.localDevProcess.projectNodes).map(component => component.localDev.componentConfigPath);
-        const projectConfigPath = path_1.default.join(this.localDevProcess.projectDir, constants_1.PROJECT_CONFIG_FILE);
+        const projectConfigPath = path.join(this.localDevProcess.projectDir, PROJECT_CONFIG_FILE);
         configPaths.push(projectConfigPath);
         this.watcher.on('add', filePath => {
             this.handleWatchEvent(filePath, WATCH_EVENTS.add, configPaths);
@@ -50,4 +45,4 @@ class LocalDevWatcher {
         await this.watcher?.close();
     }
 }
-exports.default = LocalDevWatcher;
+export default LocalDevWatcher;

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

@@ -1,4 +1,4 @@
-import LocalDevProcess from './LocalDevProcess';
+import LocalDevProcess from './LocalDevProcess.js';
 declare class LocalDevWebsocketServer {
     private server?;
     private _websocket?;

package/lib/projects/localDev/LocalDevWebsocketServer.js

@@ -1,10 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ws_1 = require("ws");
-const portManager_1 = require("@hubspot/local-dev-lib/portManager");
-const logger_1 = require("@hubspot/local-dev-lib/logger");
-const constants_1 = require("../../constants");
-const en_1 = require("../../../lang/en");
+import { WebSocketServer } from 'ws';
+import { isPortManagerServerRunning, requestPorts, } from '@hubspot/local-dev-lib/portManager';
+import { logger } from '@hubspot/local-dev-lib/logger';
+import { addLocalStateFlag } from '@hubspot/local-dev-lib/config';
+import { LOCAL_DEV_UI_MESSAGE_SEND_TYPES, LOCAL_DEV_UI_MESSAGE_RECEIVE_TYPES, LOCAL_DEV_SERVER_MESSAGE_TYPES, CONFIG_LOCAL_STATE_FLAGS, } from '../../constants.js';
+import { lib } from '../../../lang/en.js';
 const SERVER_INSTANCE_ID = 'local-dev-ui-websocket-server';
 const LOG_PREFIX = '[LocalDevWebsocketServer]';
 class LocalDevWebsocketServer {
@@ -24,18 +23,18 @@ class LocalDevWebsocketServer {
     }
     websocket() {
         if (!this._websocket) {
-            throw new Error(en_1.lib.LocalDevWebsocketServer.errors.notInitialized(LOG_PREFIX));
+            throw new Error(lib.LocalDevWebsocketServer.errors.notInitialized(LOG_PREFIX));
         }
         return this._websocket;
     }
     log(message) {
         if (this.debug) {
-            logger_1.logger.log(LOG_PREFIX, message);
+            logger.log(LOG_PREFIX, message);
         }
     }
     logError(message) {
         if (this.debug) {
-            logger_1.logger.error(LOG_PREFIX, message);
+            logger.error(LOG_PREFIX, message);
         }
     }
     sendMessage(message) {
@@ -45,12 +44,12 @@ class LocalDevWebsocketServer {
         const uploadSuccess = await this.localDevProcess.uploadProject();
         if (uploadSuccess) {
             this.sendMessage({
-                type: constants_1.LOCAL_DEV_UI_MESSAGE_SEND_TYPES.UPLOAD_SUCCESS,
+                type: LOCAL_DEV_UI_MESSAGE_SEND_TYPES.UPLOAD_SUCCESS,
             });
         }
         else {
             this.sendMessage({
-                type: constants_1.LOCAL_DEV_UI_MESSAGE_SEND_TYPES.UPLOAD_FAILURE,
+                type: LOCAL_DEV_UI_MESSAGE_SEND_TYPES.UPLOAD_FAILURE,
             });
         }
     }
@@ -59,25 +58,28 @@ class LocalDevWebsocketServer {
             try {
                 const message = JSON.parse(data.toString());
                 if (!message.type) {
-                    this.logError(en_1.lib.LocalDevWebsocketServer.errors.missingTypeField(data.toString()));
+                    this.logError(lib.LocalDevWebsocketServer.errors.missingTypeField(data.toString()));
                     return;
                 }
                 switch (message.type) {
-                    case constants_1.LOCAL_DEV_UI_MESSAGE_RECEIVE_TYPES.UPLOAD:
+                    case LOCAL_DEV_UI_MESSAGE_RECEIVE_TYPES.UPLOAD:
                         this.handleUpload();
                         break;
+                    case LOCAL_DEV_UI_MESSAGE_RECEIVE_TYPES.VIEWED_WELCOME_SCREEN:
+                        addLocalStateFlag(CONFIG_LOCAL_STATE_FLAGS.LOCAL_DEV_UI_WELCOME);
+                        break;
                     default:
-                        this.logError(en_1.lib.LocalDevWebsocketServer.errors.unknownMessageType(message.type));
+                        this.logError(lib.LocalDevWebsocketServer.errors.unknownMessageType(message.type));
                 }
             }
             catch (e) {
-                this.logError(en_1.lib.LocalDevWebsocketServer.errors.invalidJSON(data.toString()));
+                this.logError(lib.LocalDevWebsocketServer.errors.invalidJSON(data.toString()));
             }
         });
     }
     sendProjectData() {
         this.sendMessage({
-            type: constants_1.LOCAL_DEV_UI_MESSAGE_SEND_TYPES.UPDATE_PROJECT_DATA,
+            type: LOCAL_DEV_UI_MESSAGE_SEND_TYPES.UPDATE_PROJECT_DATA,
             data: {
                 projectName: this.localDevProcess.projectName,
                 projectId: this.localDevProcess.projectId,
@@ -89,37 +91,37 @@ class LocalDevWebsocketServer {
     setupStateListeners() {
         this.localDevProcess.addStateListener('projectNodes', nodes => {
             this.sendMessage({
-                type: constants_1.LOCAL_DEV_UI_MESSAGE_SEND_TYPES.UPDATE_PROJECT_NODES,
+                type: LOCAL_DEV_UI_MESSAGE_SEND_TYPES.UPDATE_PROJECT_NODES,
                 data: nodes,
             });
         }, true);
         this.localDevProcess.addStateListener('appData', appData => {
             this.sendMessage({
-                type: constants_1.LOCAL_DEV_UI_MESSAGE_SEND_TYPES.UPDATE_APP_DATA,
+                type: LOCAL_DEV_UI_MESSAGE_SEND_TYPES.UPDATE_APP_DATA,
                 data: appData,
             });
         }, true);
     }
     async start() {
-        const portManagerIsRunning = await (0, portManager_1.isPortManagerServerRunning)();
+        const portManagerIsRunning = await isPortManagerServerRunning();
         if (!portManagerIsRunning) {
-            throw new Error(en_1.lib.LocalDevWebsocketServer.errors.portManagerNotRunning(LOG_PREFIX));
+            throw new Error(lib.LocalDevWebsocketServer.errors.portManagerNotRunning(LOG_PREFIX));
         }
-        const portData = await (0, portManager_1.requestPorts)([{ instanceId: SERVER_INSTANCE_ID }]);
+        const portData = await requestPorts([{ instanceId: SERVER_INSTANCE_ID }]);
         const port = portData[SERVER_INSTANCE_ID];
-        this.server = new ws_1.WebSocketServer({ port });
-        this.log(en_1.lib.LocalDevWebsocketServer.logs.startup(port));
+        this.server = new WebSocketServer({ port });
+        this.log(lib.LocalDevWebsocketServer.logs.startup(port));
         this.server.on('connection', (ws, req) => {
             const origin = req.headers.origin;
             if (!origin || !this.ALLOWED_ORIGINS.includes(origin)) {
-                ws.close(1008, en_1.lib.LocalDevWebsocketServer.errors.originNotAllowed(origin));
+                ws.close(1008, lib.LocalDevWebsocketServer.errors.originNotAllowed(origin));
                 return;
             }
             this._websocket = ws;
             this.sendProjectData();
             this.setupMessageHandlers();
             this.setupStateListeners();
-            this.localDevProcess.sendDevServerMessage(constants_1.LOCAL_DEV_SERVER_MESSAGE_TYPES.WEBSOCKET_SERVER_CONNECTED);
+            this.localDevProcess.sendDevServerMessage(LOCAL_DEV_SERVER_MESSAGE_TYPES.WEBSOCKET_SERVER_CONNECTED);
         });
     }
     shutdown() {
@@ -128,4 +130,4 @@ class LocalDevWebsocketServer {
         this._websocket = undefined;
     }
 }
-exports.default = LocalDevWebsocketServer;
+export default LocalDevWebsocketServer;

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

@@ -1,10 +1,10 @@
 import { CLIAccount } from '@hubspot/local-dev-lib/types/Accounts';
 import { Environment } from '@hubspot/local-dev-lib/types/Config';
-import { DeveloperTestAccount } from '@hubspot/local-dev-lib/types/developerTestAccounts';
+import { DeveloperTestAccount } from '@hubspot/local-dev-lib/types/developerTestAccounts.js';
 import { Project } from '@hubspot/local-dev-lib/types/Project';
 import { Build } from '@hubspot/local-dev-lib/types/Build';
-import { ProjectConfig } from '../../../types/Projects';
-import { ProjectDevTargetAccountPromptResponse } from '../../prompts/projectDevTargetAccountPrompt';
+import { ProjectConfig } from '../../../types/Projects.js';
+import { ProjectDevTargetAccountPromptResponse } from '../../prompts/projectDevTargetAccountPrompt.js';
 export declare function confirmDefaultAccountIsTarget(accountConfig: CLIAccount): Promise<void>;
 export declare function checkIfDefaultAccountIsSupported(accountConfig: CLIAccount, hasPublicApps: boolean): Promise<void>;
 export declare function checkIfParentAccountIsAuthed(accountConfig: CLIAccount): void;