@hubspot/ui-extensions-dev-server 0.8.15 → 0.8.17

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 import { remoteBuild, buildSingleExtension } from './lib/build';
-import DevModeInterface from './lib/DevModeInterface';
-export { remoteBuild, buildSingleExtension, DevModeInterface };
+import DevModeInterface, { DevModeInterfaceNonSingleton } from './lib/DevModeInterface';
+export { remoteBuild, buildSingleExtension, DevModeInterface, DevModeInterfaceNonSingleton, };

package/dist/index.js

@@ -1,11 +1,32 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DevModeInterface = exports.buildSingleExtension = exports.remoteBuild = void 0;
+exports.DevModeInterfaceNonSingleton = exports.DevModeInterface = exports.buildSingleExtension = exports.remoteBuild = void 0;
 const build_1 = require("./lib/build");
 Object.defineProperty(exports, "remoteBuild", { enumerable: true, get: function () { return build_1.remoteBuild; } });
 Object.defineProperty(exports, "buildSingleExtension", { enumerable: true, get: function () { return build_1.buildSingleExtension; } });
-const DevModeInterface_1 = __importDefault(require("./lib/DevModeInterface"));
+const DevModeInterface_1 = __importStar(require("./lib/DevModeInterface"));
 exports.DevModeInterface = DevModeInterface_1.default;
+Object.defineProperty(exports, "DevModeInterfaceNonSingleton", { enumerable: true, get: function () { return DevModeInterface_1.DevModeInterfaceNonSingleton; } });

package/dist/lib/DevModeInterface.d.ts

@@ -10,6 +10,7 @@ interface SetupArguments {
         api: string;
         web: string;
     };
+    setActiveApp: (appUid: string | undefined) => Promise<void>;
 }
 interface StartArguments {
     accountId?: number;
@@ -36,10 +37,12 @@ declare class DevModeInterface {
     isRunning?: boolean;
     _generateAppExtensionMappings(components: ProjectComponentMap): AppExtensionMapping[];
     _getPlatformVersion(projectConfig?: ProjectConfig): PlatformVersion;
-    setup({ components, onUploadRequired, promptUser, logger, urls, }: SetupArguments): Promise<void>;
+    _reset(): void;
+    setup({ components, onUploadRequired, promptUser, logger, urls, setActiveApp, }: SetupArguments): Promise<void>;
     fileChange(filePath: string, __event: unknown): Promise<void>;
     start({ requestPorts, accountId, projectConfig }: StartArguments): Promise<void>;
     cleanup(): Promise<void>;
 }
+export { DevModeInterface as DevModeInterfaceNonSingleton };
 declare const _default: DevModeInterface;
 export default _default;

package/dist/lib/DevModeInterface.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DevModeInterfaceNonSingleton = void 0;
 const dev_1 = require("./dev");
 const constants_1 = require("./constants");
 const constants_2 = require("./constants");
@@ -49,6 +50,9 @@ class DevModeInterface {
             // Loop over the loaded extension configs and generate the list of choices to use to prompt the user for input
             extensionConfigKeys.forEach((extensionKey) => {
                 const extensionConfig = extensionsConfigForApp[extensionKey];
+                if (extensionConfig.appConfig) {
+                    extensionConfig.appConfig.isPublicApp = component.type === constants_1.PUBLIC_APP;
+                }
                 appExtensionMappings.push({
                     name: `${componentName}/${extensionConfig.data.title}`,
                     value: extensionConfig,
@@ -71,7 +75,18 @@ class DevModeInterface {
                 return (0, utils_1.throwUnhandledPlatformVersionError)(platformVersion);
         }
     }
-    setup({ components, onUploadRequired, promptUser, logger, urls, }) {
+    _reset() {
+        this.configs = undefined;
+        this.devServerState = undefined;
+        this.onUploadRequired = undefined;
+        this.shutdown = undefined;
+        this.logger = defaultLogger;
+        this.urls = undefined;
+        this.isConfigured = false;
+        this.isRunning = false;
+    }
+    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) {
@@ -108,6 +123,9 @@ class DevModeInterface {
                 this.configs = answers.extensions;
             }
             this.isConfigured = true;
+            if (typeof setActiveApp === 'function') {
+                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);
+            }
         });
     }
     // The contract is for this to be async, so eslint can chill
@@ -149,7 +167,7 @@ class DevModeInterface {
                     this.logger.debug('Call to port manager failed, using default ports');
                 }
             }
-            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) || '') || {};
+            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,
@@ -172,11 +190,13 @@ class DevModeInterface {
     }
     cleanup() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this.shutdown && this.isRunning) {
+            if (this.shutdown) {
                 yield this.shutdown();
-                this.isRunning = false;
             }
+            // Since the DevModeInterface is a singleton, we need to wipe out the state when we shutdown
+            this._reset();
         });
     }
 }
+exports.DevModeInterfaceNonSingleton = DevModeInterface;
 exports.default = new DevModeInterface();

package/dist/lib/DevServerState.d.ts

@@ -35,5 +35,6 @@ export declare class DevServerState {
     get outputDir(): string;
     get appPath(): string;
     get localDevUrlMapping(): DevServerStateLocalDevUrlMapping;
+    isPublicApp(): boolean;
 }
 export {};

package/dist/lib/DevServerState.js

@@ -68,5 +68,9 @@ class DevServerState {
     get localDevUrlMapping() {
         return this._localDevUrlMapping;
     }
+    isPublicApp() {
+        var _a;
+        return !!((_a = this.appConfig) === null || _a === void 0 ? void 0 : _a.isPublicApp);
+    }
 }
 exports.DevServerState = DevServerState;

package/dist/lib/build.d.ts

@@ -1,11 +1,14 @@
+import { InlineConfig } from 'vite';
 interface BuildSingleExtensionArgs {
     file: string;
     outputDir?: string;
     emptyOutDir?: boolean;
     minify?: boolean;
     root?: string;
+    logLevel?: InlineConfig['logLevel'];
 }
 export declare const extensionErrorBaseMessage: string;
-export declare function buildSingleExtension({ file, outputDir, emptyOutDir, minify, root, }: BuildSingleExtensionArgs): Promise<void>;
-export declare function remoteBuild(root: string, entryPoint: string, outputDir?: string): Promise<void>;
+export declare function buildSingleExtension({ file, outputDir, emptyOutDir, minify, root, // This is the vite default, so using that as our default
+logLevel, }: BuildSingleExtensionArgs): Promise<void>;
+export declare function remoteBuild(root: string, entryPoint: string, outputDir?: string, logLevel?: BuildSingleExtensionArgs['logLevel']): Promise<void>;
 export {};

package/dist/lib/build.js

@@ -23,10 +23,11 @@ const friendlyLoggingPlugin_1 = __importDefault(require("./plugins/friendlyLoggi
 const allowedExtensions = ['.js', '.ts', '.tsx', '.jsx'];
 exports.extensionErrorBaseMessage = `Supported file extensions are [${allowedExtensions.join(', ')}], received:`;
 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,
             root,
             define: {
                 'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV || 'production'),
@@ -51,7 +52,7 @@ function buildSingleExtension({ file, outputDir = constants_1.OUTPUT_DIR, emptyO
     });
 }
 exports.buildSingleExtension = buildSingleExtension;
-function remoteBuild(root, entryPoint, outputDir = constants_1.OUTPUT_DIR) {
+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)) {
@@ -62,6 +63,7 @@ function remoteBuild(root, entryPoint, outputDir = constants_1.OUTPUT_DIR) {
             outputDir,
             minify: true,
             root,
+            logLevel,
         });
     });
 }

package/dist/lib/config.d.ts

@@ -1,4 +1,6 @@
-import { AppConfig, ExtensionConfigMap, LocalAppConfig } from './types';
+import { AppConfig, ExtensionConfigMap, LocalAppConfig, Logger } from './types';
 export declare function loadConfigByPath<T = unknown>(configPath: string): T;
 export declare function loadExtensionConfig(appConfig: AppConfig, appPath: string): ExtensionConfigMap;
-export declare function loadLocalConfig(appPath: string): LocalAppConfig | undefined;
+export declare function validateProxyConfigKey(urlKey: string, logger: Logger, localConfigPath: string): void;
+export declare function validateProxyConfigValue(value: string, key: string, logger: Logger, localConfigPath: string): void;
+export declare function loadLocalConfig(appPath: string, logger: Logger): LocalAppConfig | undefined;

package/dist/lib/config.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadLocalConfig = exports.loadExtensionConfig = exports.loadConfigByPath = void 0;
+exports.loadLocalConfig = exports.validateProxyConfigValue = exports.validateProxyConfigKey = exports.loadExtensionConfig = exports.loadConfigByPath = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const utils_1 = require("./utils");
@@ -17,6 +17,9 @@ exports.loadConfigByPath = loadConfigByPath;
 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;
+    if (!crmCardsSubConfigFiles) {
+        throw new Error("Unable to find extensions files, make sure the 'extensions.crm.cards' array is defined in the application configuration file");
+    }
     const outputConfig = {};
     crmCardsSubConfigFiles.forEach((card) => {
         var _a, _b;
@@ -38,16 +41,47 @@ function loadExtensionConfig(appConfig, appPath) {
     return outputConfig;
 }
 exports.loadExtensionConfig = loadExtensionConfig;
-function loadLocalConfig(appPath) {
+function validateProxyConfigKey(urlKey, logger, localConfigPath) {
     try {
-        const localConfig = path_1.default.join(appPath, 'local.json');
-        if (fs_1.default.existsSync(localConfig)) {
-            return JSON.parse(fs_1.default.readFileSync(localConfig).toString());
+        const url = new URL(urlKey);
+        if (url.pathname !== '/') {
+            logger.warn(`The key "${urlKey}" in "${localConfigPath}" is invalid, paths are not supported for keys`);
         }
     }
     catch (e) {
+        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
+        new URL(value);
+    }
+    catch (e) {
+        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);
+    if (!fs_1.default.existsSync(localConfigPath)) {
+        return undefined;
+    }
+    try {
+        const localConfig = JSON.parse(fs_1.default.readFileSync(localConfigPath).toString());
+        const { proxy = {} } = localConfig;
+        Object.entries(proxy).forEach((entry) => {
+            const [key, value] = entry;
+            validateProxyConfigKey(key, logger, localConfigFilename);
+            validateProxyConfigValue(value, key, logger, localConfigFilename);
+        });
+        return localConfig;
+    }
+    catch (e) {
+        logger.error(`Error loading and parsing ${localConfigPath}, ${e}`);
         return undefined;
     }
-    return undefined;
 }
 exports.loadLocalConfig = loadLocalConfig;

package/dist/lib/server.js

@@ -39,9 +39,11 @@ function startDevServer({ devServerState, viteDevServer, }) {
         app.use((0, cors_1.default)());
         app.use(express_1.default.static(devServerState.outputDir));
         const capabilities = [...constants_1.SERVER_CAPABILITIES];
-        const middlewares = [
-            (0, app_functions_dev_server_1.AppFunctionExecutionService)(Object.assign(Object.assign({}, devServerState.functionsConfig), { logger: devServerState.logger })),
-        ];
+        const middlewares = [];
+        if (!devServerState.isPublicApp()) {
+            middlewares.push((0, app_functions_dev_server_1.AppFunctionExecutionService)(Object.assign(Object.assign({}, devServerState.functionsConfig), { logger: devServerState.logger })));
+            devServerState.logger.info(`Serving app functions locally (platform version ${devServerState.functionsConfig.platformVersion})`);
+        }
         if (devServerState.localDevUrlMapping) {
             devServerState.logger.info('Proxy config discovered, enabling local proxy mode');
             middlewares.push((0, app_functions_dev_server_1.AppProxyService)({
@@ -52,8 +54,9 @@ function startDevServer({ devServerState, viteDevServer, }) {
             }));
             capabilities.push(constants_1.PROXY_CAPABILITY);
         }
-        app.use('/api/crm-extensibility/execution/internal/v3', ...middlewares);
-        devServerState.logger.info(`Serving app functions locally (platform version ${devServerState.functionsConfig.platformVersion})`);
+        if (middlewares.length > 0) {
+            app.use('/api/crm-extensibility/execution/internal/v3', ...middlewares);
+        }
         const endpointsAdded = extensionsService_1.default.add(app, devServerState, capabilities);
         const { expressPort } = devServerState;
         endpointsAdded.forEach((endpoint) => {
@@ -77,9 +80,15 @@ function startDevServer({ devServerState, viteDevServer, }) {
         });
         return function shutdown() {
             return __awaiter(this, void 0, void 0, function* () {
-                yield viteDevServer.pluginContainer.close();
-                // Stop new connections to express server
-                server.close(() => { });
+                try {
+                    yield viteDevServer.pluginContainer.close();
+                    // Stop new connections to express server
+                    server.close(() => { });
+                    yield viteDevServer.close();
+                }
+                catch (e) {
+                    devServerState.logger.debug(`Error shutting down ${e}`);
+                }
                 devServerState.logger.info('Extension dev server done cleaning up');
             });
         };

package/dist/lib/types.d.ts

@@ -74,7 +74,10 @@ export interface PublicAppConfig {
         };
     };
 }
-export type AppConfig = PrivateAppConfig | PublicAppConfig;
+export interface NonCanonicalAppMetadata {
+    isPublicApp?: boolean;
+}
+export type AppConfig = (PrivateAppConfig | PublicAppConfig) & NonCanonicalAppMetadata;
 export interface ProjectComponent {
     type: typeof PUBLIC_APP | typeof PRIVATE_APP;
     config: AppConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/ui-extensions-dev-server",
-  "version": "0.8.15",
+  "version": "0.8.17",
   "description": "",
   "scripts": {
     "test": "jest",
@@ -10,9 +10,8 @@
     "prepare": "npm run build",
     "lint": "echo 'no lint step for @hubspot/ui-extensions-dev-server'",
     "jest": "jest --watch",
-    "integration-test-private-app": "npm run integration-test-private-app --prefix ./integrationTests/fixtures",
-    "integration-test-public-app": "npm run integration-test-public-app --prefix ./integrationTests/fixtures",
-    "integration-test": "npm run build && npm run integration-test-private-app && npm run integration-test-public-app"
+    "integration-test": "npm run --prefix 'integrationTests' integration-test",
+    "integration-test-no-setup": "npm run --prefix 'integrationTests' integration-test-no-setup"
   },
   "publishConfig": {
     "access": "public"
@@ -21,12 +20,11 @@
     ".": "./dist/index.js"
   },
   "files": [
-    "dist",
-    "README.md"
+    "dist"
   ],
   "license": "MIT",
   "dependencies": {
-    "@hubspot/app-functions-dev-server": "^0.8.15",
+    "@hubspot/app-functions-dev-server": "0.8.17",
     "cors": "^2.8.5",
     "detect-port": "1.5.1",
     "estraverse": "^5.3.0",
@@ -40,7 +38,8 @@
     "@types/inquirer": "^9.0.3",
     "@types/jest": "^29.5.4",
     "acorn": "^8.11.2",
-    "axios": "^1.4.0",
+    "ava": "4.3.3",
+    "axios": "^1.6.8",
     "jest": "^29.5.0",
     "ts-jest": "^29.1.1",
     "typescript": "^5.1.6",
@@ -64,5 +63,5 @@
       "optional": true
     }
   },
-  "gitHead": "48b7ed5d22520fb76d9ea2e8d97c9645cf3f8419"
+  "gitHead": "c056fcf4f48454c6f4cd7986fd1f5b5f619d1605"
 }