@hubspot/ui-extensions-dev-server 0.8.39 → 0.8.40

package/dist/lib/DevModeInterface.js

@@ -85,9 +85,9 @@ class DevModeInterface {
         this.isConfigured = false;
         this.isRunning = false;
     }
-    setup(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ components, onUploadRequired, promptUser, logger, urls, setActiveApp, }) {
-            var _b, _c, _d;
+    setup({ components, onUploadRequired, promptUser, logger, urls, setActiveApp, }) {
+        var _a, _b, _c;
+        return __awaiter(this, void 0, void 0, function* () {
             logger.debug('Setup function was invoked', { components, urls });
             if (this.isConfigured) {
                 logger.debug('Dev server has already been configured, skipping');
@@ -124,7 +124,7 @@ class DevModeInterface {
             }
             this.isConfigured = true;
             if (typeof setActiveApp === 'function') {
-                yield setActiveApp((_d = (_c = (_b = this.configs) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.appConfig) === null || _d === void 0 ? void 0 : _d.uid);
+                yield setActiveApp((_c = (_b = (_a = this.configs) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.appConfig) === null || _c === void 0 ? void 0 : _c.uid);
             }
         });
     }
@@ -141,9 +141,9 @@ class DevModeInterface {
             }
         });
     }
-    start(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ requestPorts, accountId, projectConfig }) {
-            var _b, _c, _d, _e;
+    start({ requestPorts, accountId, projectConfig }) {
+        var _a, _b, _c, _d;
+        return __awaiter(this, void 0, void 0, function* () {
             this.logger.debug('Start function was invoked', {
                 accountId,
                 projectConfig,
@@ -164,10 +164,13 @@ class DevModeInterface {
                     webSocketPort = portData[constants_1.VITE_DEV_SERVER_ID];
                 }
                 catch (e) {
+                    if ((e === null || e === void 0 ? void 0 : e.status) === 409) {
+                        throw new Error('Another instance is already running. To proceed, please stop the existing server and try again.');
+                    }
                     this.logger.debug('Call to port manager failed, using default ports');
                 }
             }
-            const { proxy: localDevUrlMapping } = (0, config_1.loadLocalConfig)(((_c = (_b = this.configs) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.path) || '', this.logger) || {};
+            const { proxy: localDevUrlMapping } = (0, config_1.loadLocalConfig)(((_b = (_a = this.configs) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.path) || '', this.logger) || {};
             this.devServerState = new DevServerState_1.DevServerState({
                 localDevUrlMapping,
                 extensionConfigs: this.configs,
@@ -177,7 +180,7 @@ class DevModeInterface {
                 webSocketPort,
                 logger: this.logger,
                 urls: this.urls,
-                appConfig: (_e = (_d = this.configs) === null || _d === void 0 ? void 0 : _d[0]) === null || _e === void 0 ? void 0 : _e.appConfig,
+                appConfig: (_d = (_c = this.configs) === null || _c === void 0 ? void 0 : _c[0]) === null || _d === void 0 ? void 0 : _d.appConfig,
             });
             this.shutdown = yield (0, dev_1.startDevMode)(this.devServerState);
             const { extensionsMetadata } = this.devServerState;

package/dist/lib/ast.js

@@ -1,7 +1,7 @@
 "use strict";
 /* eslint-disable hubspot-dev/no-unsupported-ts-syntax */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.traverseAbstractSyntaxTree = traverseAbstractSyntaxTree;
+exports.traverseAbstractSyntaxTree = void 0;
 // @ts-expect-error no type defs
 const estraverse_1 = require("estraverse");
 function _isVariableImported(node, variableName) {
@@ -62,3 +62,4 @@ function traverseAbstractSyntaxTree(ast, checks) {
     });
     return state;
 }
+exports.traverseAbstractSyntaxTree = traverseAbstractSyntaxTree;

package/dist/lib/bin/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/lib/bin/cli.js

@@ -0,0 +1,115 @@
+#!/usr/bin/env node
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const node_util_1 = require("node:util");
+const node_child_process_1 = require("node:child_process");
+const commander_1 = require("commander");
+const ora_1 = __importDefault(require("ora"));
+const chalk_1 = __importDefault(require("chalk"));
+const build_1 = require("../build");
+const program = new commander_1.Command()
+    .name('ui-extension-tools')
+    .alias('uie')
+    .description('Tools for managing and building HubSpot UI Extensions.');
+const buildSteps = {
+    lockfile: {
+        start: 'Processing lockfile...',
+        fn: generateLockfile,
+        success: 'Lockfile ready',
+        error: 'Error generating lockfile',
+    },
+    install: {
+        start: 'Installing dependencies...',
+        fn: installDeps,
+        success: 'Dependencies installed',
+        error: 'Error installing dependencies',
+    },
+    build: {
+        start: 'Building remote extension...',
+        fn: build,
+        success: 'Extension build complete',
+        error: 'Error building extension',
+    },
+};
+program
+    .command('build <module>', { isDefault: true })
+    .description('Build extension source code.')
+    .action((module) => __awaiter(void 0, void 0, void 0, function* () {
+    const options = getOptions(module);
+    yield runCommand('lockfile', options);
+    yield runCommand('install', options);
+    yield runCommand('build', options);
+}));
+program.parse(process.argv);
+function runCommand(command, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { start, fn, success, error } = buildSteps[command];
+        const spinner = (0, ora_1.default)();
+        try {
+            spinner.start(start);
+            yield fn(options);
+            spinner.succeed(chalk_1.default.green(success));
+        }
+        catch (err) {
+            spinner.fail(chalk_1.default.red(error));
+            process.exit(1);
+        }
+        finally {
+            spinner.stop();
+        }
+    });
+}
+// Mirrors: https://git.hubteam.com/HubSpot/Artifactor/blob/f5cbea91d7a7dfb6278e878ae583e69022384fb5/ArtifactorFunctions/functions/node_18x/uie-remote-build/index.js#L59-L63
+function build({ extensionRoot, extensionDist, entrypoint }) {
+    return (0, build_1.remoteBuild)(extensionRoot, entrypoint, extensionDist);
+}
+// Mirrors: https://git.hubteam.com/HubSpot/Artifactor/blob/f5cbea91d7a7dfb6278e878ae583e69022384fb5/ArtifactorFunctions/functions/node_18x/uie-remote-build/index.js#L53-L57
+function installDeps(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield execAsync('npm ci --ignore-scripts --no-audit --no-optional --no-fund', options);
+    });
+}
+// Mirrors: https://git.hubteam.com/HubSpot/Artifactor/blob/f5cbea91d7a7dfb6278e878ae583e69022384fb5/ArtifactorFunctions/functions/node_18x/uie-remote-build/index.js#L131-L136
+function generateLockfile(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { extensionRoot, spinner } = options;
+        if (node_fs_1.default.existsSync(node_path_1.default.join(extensionRoot, 'package-lock.json'))) {
+            spinner.info('Existing lockfile found, skipping generation');
+        }
+        else {
+            spinner.info('No lockfile found, generating...');
+            yield execAsync('npm install --package-lock-only', options);
+        }
+    });
+}
+function getOptions(modulePath) {
+    const entrypoint = node_path_1.default.isAbsolute(modulePath)
+        ? modulePath
+        : node_path_1.default.resolve(process.cwd(), modulePath);
+    const extensionRoot = node_path_1.default.dirname(entrypoint);
+    const extensionDist = node_path_1.default.join(extensionRoot, 'dist');
+    const spinner = (0, ora_1.default)();
+    return {
+        extensionRoot,
+        extensionDist,
+        entrypoint,
+        spinner,
+    };
+}
+function execAsync(command, options) {
+    return (0, node_util_1.promisify)(node_child_process_1.exec)(command, { cwd: options.extensionRoot });
+}

package/dist/lib/build.js

@@ -12,9 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extensionErrorBaseMessage = void 0;
-exports.buildSingleExtension = buildSingleExtension;
-exports.remoteBuild = remoteBuild;
+exports.remoteBuild = exports.buildSingleExtension = exports.extensionErrorBaseMessage = void 0;
 const vite_1 = require("vite");
 const constants_1 = require("./constants");
 const manifestPlugin_1 = __importDefault(require("./plugins/manifestPlugin"));
@@ -24,9 +22,9 @@ const codeBlockingPlugin_1 = __importDefault(require("./plugins/codeBlockingPlug
 const friendlyLoggingPlugin_1 = __importDefault(require("./plugins/friendlyLoggingPlugin"));
 const allowedExtensions = ['.js', '.ts', '.tsx', '.jsx'];
 exports.extensionErrorBaseMessage = `Supported file extensions are [${allowedExtensions.join(', ')}], received:`;
-function buildSingleExtension(_a) {
-    return __awaiter(this, arguments, void 0, function* ({ file, outputDir = constants_1.OUTPUT_DIR, emptyOutDir = true, minify = false, root = process.cwd(), // This is the vite default, so using that as our default
-    logLevel = 'info', }) {
+function buildSingleExtension({ file, outputDir = constants_1.OUTPUT_DIR, emptyOutDir = true, minify = false, root = process.cwd(), // This is the vite default, so using that as our default
+logLevel = 'info', }) {
+    return __awaiter(this, void 0, void 0, function* () {
         const output = (0, utils_1.getUrlSafeFileName)(file);
         yield (0, vite_1.build)({
             logLevel,
@@ -53,8 +51,9 @@ function buildSingleExtension(_a) {
         });
     });
 }
-function remoteBuild(root_1, entryPoint_1) {
-    return __awaiter(this, arguments, void 0, function* (root, entryPoint, outputDir = constants_1.OUTPUT_DIR, logLevel) {
+exports.buildSingleExtension = buildSingleExtension;
+function remoteBuild(root, entryPoint, outputDir = constants_1.OUTPUT_DIR, logLevel) {
+    return __awaiter(this, void 0, void 0, function* () {
         const fileInfo = path_1.default.parse(entryPoint);
         if (!allowedExtensions.includes(fileInfo.ext)) {
             throw new Error(`${exports.extensionErrorBaseMessage} ${fileInfo.ext}`);
@@ -68,3 +67,4 @@ function remoteBuild(root_1, entryPoint_1) {
         });
     });
 }
+exports.remoteBuild = remoteBuild;

package/dist/lib/config.js

@@ -5,12 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadConfigByPath = loadConfigByPath;
-exports.validateCardConfig = validateCardConfig;
-exports.loadExtensionConfig = loadExtensionConfig;
-exports.validateProxyConfigKey = validateProxyConfigKey;
-exports.validateProxyConfigValue = validateProxyConfigValue;
-exports.loadLocalConfig = loadLocalConfig;
+exports.loadLocalConfig = exports.validateProxyConfigValue = exports.validateProxyConfigKey = exports.loadExtensionConfig = exports.validateCardConfig = exports.loadConfigByPath = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const utils_1 = require("./utils");
@@ -18,6 +13,7 @@ function loadConfigByPath(configPath) {
     const source = fs_1.default.readFileSync(configPath).toString();
     return JSON.parse(source);
 }
+exports.loadConfigByPath = loadConfigByPath;
 function validateCardConfig(config) {
     if (!config || typeof config !== 'object') {
         return new Error('Card config must be an object');
@@ -54,6 +50,7 @@ function validateCardConfig(config) {
     }
     return true;
 }
+exports.validateCardConfig = validateCardConfig;
 function loadExtensionConfig(appConfig, appPath) {
     var _a, _b;
     const crmCardsSubConfigFiles = (_b = (_a = appConfig === null || appConfig === void 0 ? void 0 : appConfig.extensions) === null || _a === void 0 ? void 0 : _a.crm) === null || _b === void 0 ? void 0 : _b.cards;
@@ -84,6 +81,7 @@ function loadExtensionConfig(appConfig, appPath) {
     });
     return outputConfig;
 }
+exports.loadExtensionConfig = loadExtensionConfig;
 function validateProxyConfigKey(urlKey, logger, localConfigPath) {
     try {
         const url = new URL(urlKey);
@@ -95,6 +93,7 @@ function validateProxyConfigKey(urlKey, logger, localConfigPath) {
         logger.warn(`The key "${urlKey}" in "${localConfigPath}" is an invalid url`);
     }
 }
+exports.validateProxyConfigKey = validateProxyConfigKey;
 function validateProxyConfigValue(value, key, logger, localConfigPath) {
     try {
         // eslint-disable-next-line no-new
@@ -104,6 +103,7 @@ function validateProxyConfigValue(value, key, logger, localConfigPath) {
         logger.warn(`The value "${value}" for key "${key}" in "${localConfigPath}" is an invalid url`);
     }
 }
+exports.validateProxyConfigValue = validateProxyConfigValue;
 function loadLocalConfig(appPath, logger) {
     const localConfigFilename = 'local.json';
     const localConfigPath = path_1.default.join(appPath, localConfigFilename);
@@ -125,3 +125,4 @@ function loadLocalConfig(appPath, logger) {
         return undefined;
     }
 }
+exports.loadLocalConfig = loadLocalConfig;

package/dist/lib/dev.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.startDevMode = startDevMode;
+exports.startDevMode = void 0;
 const vite_1 = require("vite");
 const path_1 = __importDefault(require("path"));
 const server_1 = __importDefault(require("./server"));
@@ -73,3 +73,4 @@ function startDevMode(devServerState) {
         return shutdownServer;
     });
 }
+exports.startDevMode = startDevMode;

package/dist/lib/plugins/codeBlockingPlugin.js

@@ -6,7 +6,7 @@ const ast_1 = require("../ast");
 const codeBlockingPlugin = ({ logger }) => {
     return {
         name: 'ui-extensions-code-blocking-plugin',
-        enforce: 'post', // run after default rollup plugins
+        enforce: 'post',
         transform(code, filename) {
             if ((0, utils_1.isNodeModule)(filename)) {
                 return { code, map: null }; // We don't want to parse node modules

package/dist/lib/plugins/devBuildPlugin.js

@@ -68,7 +68,7 @@ const devBuildPlugin = (options) => {
                 } }));
         }
     };
-    const devBuild = (server_1, extensionMetadata_1, ...args_1) => __awaiter(void 0, [server_1, extensionMetadata_1, ...args_1], void 0, function* (server, extensionMetadata, emptyOutDir = false) {
+    const devBuild = (server, extensionMetadata, emptyOutDir = false) => __awaiter(void 0, void 0, void 0, function* () {
         try {
             const { config: extensionConfig } = extensionMetadata;
             yield (0, vite_1.build)({
@@ -150,7 +150,7 @@ const devBuildPlugin = (options) => {
                 yield devBuild(localServer, devServerState.extensionsMetadata[i], i === 0);
             }
         }),
-        handleHotUpdate: (_a) => __awaiter(void 0, [_a], void 0, function* ({ file, server }) {
+        handleHotUpdate: ({ file, server }) => __awaiter(void 0, void 0, void 0, function* () {
             // If the file is not in the relevantModules list, it's update is inconsequential
             const extensionsToRebuild = devServerState.extensionsMetadata.filter((metadata) => {
                 const { config } = metadata;

package/dist/lib/plugins/manifestPlugin.js

@@ -16,7 +16,7 @@ const EXTENSIONS_PATH = 'src/app/extensions/';
 const manifestPlugin = (options) => {
     return {
         name: 'ui-extensions-manifest-generation-plugin',
-        enforce: 'post', // run after default rollup plugins
+        enforce: 'post',
         generateBundle(_rollupOptions, bundle) {
             const { output, minify = false, extensionPath = process.cwd(), logger, } = options;
             try {

package/dist/lib/plugins/relevantModulesPlugin.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRelevantModules = getRelevantModules;
+exports.getRelevantModules = void 0;
 const utils_1 = require("../utils");
 const relevantModules = {};
 function getRelevantModules(output) {
     return relevantModules[output] || [];
 }
+exports.getRelevantModules = getRelevantModules;
 const relevantModulesPlugin = ({ output, logger }) => {
     return {
         name: 'ui-extensions-relevant-modules-plugin',

package/dist/lib/server.js

@@ -31,9 +31,9 @@ function listen(app, port) {
         });
     });
 }
-function startDevServer(_a) {
-    return __awaiter(this, arguments, void 0, function* ({ devServerState, viteDevServer, }) {
-        var _b;
+function startDevServer({ devServerState, viteDevServer, }) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
         const app = (0, express_1.default)();
         // Setup middleware
         app.use((0, cors_1.default)());
@@ -75,7 +75,7 @@ function startDevServer(_a) {
             }
             throw new Error(e);
         }
-        (_b = devServerState.extensionsMetadata) === null || _b === void 0 ? void 0 : _b.forEach((metadata) => {
+        (_a = devServerState.extensionsMetadata) === null || _a === void 0 ? void 0 : _a.forEach((metadata) => {
             const { baseMessage } = metadata;
             devServerState.logger.debug(`Listening at ${baseMessage.callback}`);
         });

package/dist/lib/utils.js

@@ -3,14 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnhandledPlatformVersionError = void 0;
-exports.getUrlSafeFileName = getUrlSafeFileName;
-exports.stripAnsiColorCodes = stripAnsiColorCodes;
-exports.loadManifest = loadManifest;
-exports.buildSourceId = buildSourceId;
-exports.isNodeModule = isNodeModule;
-exports.throwUnhandledPlatformVersionError = throwUnhandledPlatformVersionError;
-exports.extractAllowedUrls = extractAllowedUrls;
+exports.extractAllowedUrls = exports.throwUnhandledPlatformVersionError = exports.UnhandledPlatformVersionError = exports.isNodeModule = exports.buildSourceId = exports.loadManifest = exports.stripAnsiColorCodes = exports.getUrlSafeFileName = void 0;
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 const constants_1 = require("./constants");
@@ -18,6 +11,7 @@ function getUrlSafeFileName(filePath) {
     const { name } = path_1.default.parse(filePath);
     return encodeURIComponent(`${name}.js`);
 }
+exports.getUrlSafeFileName = getUrlSafeFileName;
 // Strips ANSI color codes out of strings because we don't want to pass them to the browser
 function stripAnsiColorCodes(stringWithColorCodes) {
     if (!stringWithColorCodes) {
@@ -27,6 +21,7 @@ function stripAnsiColorCodes(stringWithColorCodes) {
     // eslint-disable-next-line no-control-regex
     /[\u001b][[]*([0-9]{1,4};?)*[m]/g, '');
 }
+exports.stripAnsiColorCodes = stripAnsiColorCodes;
 function loadManifest(outputDir, output) {
     try {
         return JSON.parse(fs_1.default
@@ -37,12 +32,14 @@ function loadManifest(outputDir, output) {
         return {};
     }
 }
+exports.loadManifest = loadManifest;
 function buildSourceId(appConfig, extensionConfig) {
     if (appConfig.uid && extensionConfig.data.uid) {
         return `${appConfig.uid}::${extensionConfig.data.uid}`;
     }
     return null;
 }
+exports.buildSourceId = buildSourceId;
 function isNodeModule(filepath) {
     if (!filepath) {
         return false;
@@ -50,6 +47,7 @@ function isNodeModule(filepath) {
     const directory = path_1.default.parse(filepath).dir;
     return directory.includes('node_modules');
 }
+exports.isNodeModule = isNodeModule;
 class UnhandledPlatformVersionError extends Error {
     constructor(platformVersion) {
         super(`Unsupported platform version "${platformVersion}"`);
@@ -59,9 +57,11 @@ exports.UnhandledPlatformVersionError = UnhandledPlatformVersionError;
 function throwUnhandledPlatformVersionError(platformVersion) {
     throw new UnhandledPlatformVersionError(platformVersion);
 }
+exports.throwUnhandledPlatformVersionError = throwUnhandledPlatformVersionError;
 function extractAllowedUrls(appConfig) {
     if (!appConfig || !('allowedUrls' in appConfig) || !appConfig.allowedUrls) {
         return [];
     }
     return appConfig.allowedUrls;
 }
+exports.extractAllowedUrls = extractAllowedUrls;

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@hubspot/ui-extensions-dev-server",
-  "version": "0.8.39",
+  "version": "0.8.40",
   "description": "",
+  "bin": {
+    "uie": "./dist/lib/bin/cli.js"
+  },
   "scripts": {
     "test": "jest",
     "clean": "rm -rf dist/",
@@ -24,12 +27,15 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@hubspot/app-functions-dev-server": "0.8.39",
+    "@hubspot/app-functions-dev-server": "0.8.40",
+    "chalk": "^5.4.1",
+    "commander": "^13.0.0",
     "cors": "^2.8.5",
     "detect-port": "1.5.1",
     "estraverse": "^5.3.0",
     "express": "^4.18.2",
     "inquirer": "8.2.0",
+    "ora": "^8.1.1",
     "vite": "^4.4.9"
   },
   "devDependencies": {
@@ -63,5 +69,5 @@
       "optional": true
     }
   },
-  "gitHead": "3dbfe0afee58682d51c4a5eb7e0e40a6e3920631"
+  "gitHead": "1f4550a901eeba1e56943ef50c6ea7af30f95bc1"
 }