@hubspot/ui-extensions-dev-server 0.8.12 → 0.8.14

package/dist/lib/DevModeInterface.js

@@ -124,6 +124,7 @@ class DevModeInterface {
         });
     }
     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,
@@ -148,7 +149,9 @@ 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) || '') || {};
             this.devServerState = new DevServerState_1.DevServerState({
+                localDevUrlMapping,
                 extensionConfigs: this.configs,
                 accountId,
                 platformVersion: this._getPlatformVersion(projectConfig),
@@ -156,6 +159,7 @@ class DevModeInterface {
                 webSocketPort,
                 logger: this.logger,
                 urls: this.urls,
+                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/DevServerState.d.ts

@@ -1,6 +1,8 @@
-import { ExtensionConfig, ExtensionMetadata, Logger, PlatformVersion } from './types';
-import { ServiceConfiguration } from '@hubspot/app-functions-dev-server/dist/types';
+import { AppConfig, ExtensionConfig, ExtensionMetadata, Logger, PlatformVersion } from './types';
+import { ServiceConfiguration, ProxyServiceConfig } from '@hubspot/app-functions-dev-server';
+type DevServerStateLocalDevUrlMapping = ProxyServiceConfig['localDevUrlMapping'] | undefined;
 interface DevServerStateArgs {
+    localDevUrlMapping?: DevServerStateLocalDevUrlMapping;
     extensionConfigs?: ExtensionConfig[];
     accountId: number | undefined;
     expressPort: number;
@@ -11,17 +13,20 @@ interface DevServerStateArgs {
         api: string;
         web: string;
     };
+    appConfig?: AppConfig;
 }
 export declare class DevServerState {
     private _webSocketPort;
     private _expressPort;
     private _functionsConfig;
+    private _localDevUrlMapping;
     private _outputDir;
     private _appPath;
     private _extensionsMetadata;
     private _portalId?;
     logger: Logger;
-    constructor({ extensionConfigs, accountId, expressPort, webSocketPort, platformVersion, logger, urls, }: DevServerStateArgs);
+    appConfig?: AppConfig;
+    constructor({ localDevUrlMapping, extensionConfigs, accountId, expressPort, webSocketPort, platformVersion, logger, urls, appConfig, }: DevServerStateArgs);
     get portalId(): number | undefined;
     get webSocketPort(): number;
     get expressPort(): number;
@@ -29,5 +34,6 @@ export declare class DevServerState {
     get functionsConfig(): Partial<ServiceConfiguration>;
     get outputDir(): string;
     get appPath(): string;
+    get localDevUrlMapping(): DevServerStateLocalDevUrlMapping;
 }
 export {};

package/dist/lib/DevServerState.js

@@ -7,7 +7,7 @@ exports.DevServerState = void 0;
 const constants_1 = require("./constants");
 const path_1 = __importDefault(require("path"));
 class DevServerState {
-    constructor({ extensionConfigs, accountId, expressPort, webSocketPort, platformVersion, logger, urls, }) {
+    constructor({ localDevUrlMapping, extensionConfigs, accountId, expressPort, webSocketPort, platformVersion, logger, urls, appConfig, }) {
         if (!extensionConfigs) {
             throw new Error('Unable to load the required extension configuration files');
         }
@@ -39,7 +39,9 @@ class DevServerState {
             hubspotApiOrigin: urls.api,
             hubspotWebsiteOrigin: urls.web,
         };
+        this._localDevUrlMapping = localDevUrlMapping;
         this.logger = logger;
+        this.appConfig = appConfig;
         Object.freeze(this);
     }
     get portalId() {
@@ -63,5 +65,8 @@ class DevServerState {
     get appPath() {
         return this._appPath;
     }
+    get localDevUrlMapping() {
+        return this._localDevUrlMapping;
+    }
 }
 exports.DevServerState = DevServerState;

package/dist/lib/config.d.ts

@@ -1,3 +1,4 @@
-import { AppConfig, ExtensionConfigMap } from './types';
+import { AppConfig, ExtensionConfigMap, LocalAppConfig } 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;

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.loadExtensionConfig = exports.loadConfigByPath = void 0;
+exports.loadLocalConfig = exports.loadExtensionConfig = exports.loadConfigByPath = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const utils_1 = require("./utils");
@@ -28,7 +28,7 @@ function loadExtensionConfig(appConfig, appPath) {
                 const entryPointPath = path_1.default.join(cardConfigDir, (_b = (_a = cardConfig.data) === null || _a === void 0 ? void 0 : _a.module) === null || _b === void 0 ? void 0 : _b.file);
                 cardConfig.data.module.file = entryPointPath;
                 const sourceId = (0, utils_1.buildSourceId)(appConfig, cardConfig);
-                outputConfig[sourceId || `${entryPointPath}-${cardConfig.data.location}`] = Object.assign(Object.assign({}, cardConfig), { output: (0, utils_1.getUrlSafeFileName)(entryPointPath), path: appPath, extensionPath: path_1.default.parse(entryPointPath).dir, extensionConfigPath: cardConfigPath, data: Object.assign(Object.assign({}, cardConfig.data), { appName: appConfig.name, sourceId }) });
+                outputConfig[sourceId || `${entryPointPath}-${cardConfig.data.location}`] = Object.assign(Object.assign({}, cardConfig), { output: (0, utils_1.getUrlSafeFileName)(entryPointPath), path: appPath, extensionPath: path_1.default.parse(entryPointPath).dir, extensionConfigPath: cardConfigPath, data: Object.assign(Object.assign({}, cardConfig.data), { appName: appConfig.name, sourceId }), appConfig });
             }
         }
         catch (e) {
@@ -38,3 +38,16 @@ function loadExtensionConfig(appConfig, appPath) {
     return outputConfig;
 }
 exports.loadExtensionConfig = loadExtensionConfig;
+function loadLocalConfig(appPath) {
+    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());
+        }
+    }
+    catch (e) {
+        return undefined;
+    }
+    return undefined;
+}
+exports.loadLocalConfig = loadLocalConfig;

package/dist/lib/constants.d.ts

@@ -16,6 +16,7 @@ export declare const ROLLUP_OPTIONS: {
 };
 export declare const EXTENSIONS_MESSAGE_VERSION = 2;
 export declare const WEBSOCKET_MESSAGE_VERSION = 1;
+export declare const PROXY_CAPABILITY = "app-backend-proxy-server";
 export declare const SERVER_CAPABILITIES: string[];
 export declare const PLATFORM_VERSION: {
     readonly V20231: "2023.1";

package/dist/lib/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SUPPORTED_APP_TYPES = exports.PRIVATE_APP = exports.PUBLIC_APP = exports.PLATFORM_VERSION = exports.SERVER_CAPABILITIES = exports.WEBSOCKET_MESSAGE_VERSION = exports.EXTENSIONS_MESSAGE_VERSION = exports.ROLLUP_OPTIONS = exports.WEBSOCKET_DEFAULT_PORT = exports.EXPRESS_DEFAULT_PORT = exports.VITE_DEV_SERVER_ID = exports.EXPRESS_SERVER_ID = exports.MANIFEST_FILE = exports.OUTPUT_DIR = void 0;
+exports.SUPPORTED_APP_TYPES = exports.PRIVATE_APP = exports.PUBLIC_APP = exports.PLATFORM_VERSION = exports.SERVER_CAPABILITIES = exports.PROXY_CAPABILITY = exports.WEBSOCKET_MESSAGE_VERSION = exports.EXTENSIONS_MESSAGE_VERSION = exports.ROLLUP_OPTIONS = exports.WEBSOCKET_DEFAULT_PORT = exports.EXPRESS_DEFAULT_PORT = exports.VITE_DEV_SERVER_ID = exports.EXPRESS_SERVER_ID = exports.MANIFEST_FILE = exports.OUTPUT_DIR = void 0;
 exports.OUTPUT_DIR = 'dist';
 exports.MANIFEST_FILE = 'manifest.json';
 exports.EXPRESS_SERVER_ID = 'ui-extensions-dev-server';
@@ -21,6 +21,7 @@ exports.ROLLUP_OPTIONS = {
 };
 exports.EXTENSIONS_MESSAGE_VERSION = 2;
 exports.WEBSOCKET_MESSAGE_VERSION = 1;
+exports.PROXY_CAPABILITY = 'app-backend-proxy-server';
 exports.SERVER_CAPABILITIES = [
     // Supports running app functions locally
     'app-functions-local-dev',

package/dist/lib/server.js

@@ -19,6 +19,7 @@ const cors_1 = __importDefault(require("cors"));
 const constants_1 = require("./constants");
 const extensionsService_1 = __importDefault(require("./extensionsService"));
 const app_functions_dev_server_1 = require("@hubspot/app-functions-dev-server");
+const utils_1 = require("./utils");
 function listen(app, port) {
     return new Promise((resolve, reject) => {
         const server = app
@@ -37,9 +38,23 @@ function startDevServer({ devServerState, viteDevServer, }) {
         // Setup middleware
         app.use((0, cors_1.default)());
         app.use(express_1.default.static(devServerState.outputDir));
-        app.use('/api/crm-extensibility/execution/internal/v3', (0, app_functions_dev_server_1.AppFunctionExecutionService)(Object.assign(Object.assign({}, devServerState.functionsConfig), { logger: devServerState.logger })));
+        const capabilities = [...constants_1.SERVER_CAPABILITIES];
+        const middlewares = [
+            (0, app_functions_dev_server_1.AppFunctionExecutionService)(Object.assign(Object.assign({}, devServerState.functionsConfig), { logger: devServerState.logger })),
+        ];
+        if (devServerState.localDevUrlMapping) {
+            devServerState.logger.info('Proxy config discovered, enabling local proxy mode');
+            middlewares.push((0, app_functions_dev_server_1.AppProxyService)({
+                localDevUrlMapping: devServerState.localDevUrlMapping,
+                logger: devServerState.logger,
+                accountId: devServerState.functionsConfig.accountId,
+                allowedUrls: (0, utils_1.extractAllowedUrls)(devServerState.appConfig),
+            }));
+            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})`);
-        const endpointsAdded = extensionsService_1.default.add(app, devServerState, constants_1.SERVER_CAPABILITIES);
+        const endpointsAdded = extensionsService_1.default.add(app, devServerState, capabilities);
         const { expressPort } = devServerState;
         endpointsAdded.forEach((endpoint) => {
             devServerState.logger.debug(`Listening at http://hslocal.net:${expressPort}${endpoint}`);

package/dist/lib/types.d.ts

@@ -1,4 +1,5 @@
 import { PLATFORM_VERSION, PRIVATE_APP, PUBLIC_APP } from './constants';
+import { LocalDevUrlMapping } from '@hubspot/app-functions-dev-server';
 export interface ObjectTypes {
     name: string;
 }
@@ -19,6 +20,7 @@ export interface ExtensionConfig {
         sourceId?: string | null;
     };
     uid?: string;
+    appConfig?: AppConfig;
 }
 export interface ExtensionConfigMap {
     [key: string]: ExtensionConfig;
@@ -43,12 +45,15 @@ export interface PrivateAppConfig {
     };
     uid?: string;
 }
+export interface LocalAppConfig {
+    proxy: LocalDevUrlMapping;
+}
 export interface PublicAppConfig {
     name: string;
     uid: string;
     logo?: string;
     description?: string;
-    allowedExternalUrls?: string[];
+    allowedUrls?: string[];
     auth?: {
         preventAdditionalScopes: boolean;
         preventOptionalScopes: boolean;

package/dist/lib/utils.d.ts

@@ -8,3 +8,4 @@ export declare class UnhandledPlatformVersionError extends Error {
     constructor(platformVersion: never);
 }
 export declare function throwUnhandledPlatformVersionError(platformVersion: never): never;
+export declare function extractAllowedUrls(appConfig?: AppConfig): string[];

package/dist/lib/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.throwUnhandledPlatformVersionError = exports.UnhandledPlatformVersionError = exports.isNodeModule = exports.buildSourceId = exports.loadManifest = exports.stripAnsiColorCodes = exports.getUrlSafeFileName = void 0;
+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");
@@ -58,3 +58,10 @@ 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,6 +1,6 @@
 {
   "name": "@hubspot/ui-extensions-dev-server",
-  "version": "0.8.12",
+  "version": "0.8.14",
   "description": "",
   "scripts": {
     "test": "jest",
@@ -26,7 +26,7 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@hubspot/app-functions-dev-server": "^0.8.11",
+    "@hubspot/app-functions-dev-server": "^0.8.14",
     "cors": "^2.8.5",
     "detect-port": "1.5.1",
     "estraverse": "^5.3.0",
@@ -64,5 +64,5 @@
       "optional": true
     }
   },
-  "gitHead": "de63cea5e941c10de794210c1a095ae2468d6a9d"
+  "gitHead": "1850d1e7967463bfec84fddaa9d5b167a76b55a7"
 }