@hubspot/ui-extensions-dev-server 0.8.46 → 0.8.47

package/dist/lib/DevModeInterface.d.ts

@@ -1,9 +1,8 @@
-import { ProjectComponentMap, AppExtensionMapping, DevModeStartArguments, DevModeSetupArguments } from './types';
+import { ProjectComponentMap, AppExtensionMapping, DevModeSetupArguments } from './types';
 import { DevModeParentInterface } from './DevModeParentInterface';
 declare class DevModeInterface extends DevModeParentInterface {
     _generateAppExtensionMappings(components: ProjectComponentMap): AppExtensionMapping[];
     setup(args: DevModeSetupArguments): Promise<void>;
-    start({ requestPorts, accountId, projectConfig, }: DevModeStartArguments): Promise<void>;
 }
 export { DevModeInterface as DevModeInterfaceNonSingleton };
 declare const _default: DevModeInterface;

package/dist/lib/DevModeInterface.js

@@ -12,10 +12,8 @@ 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 config_1 = require("./config");
-const DevServerState_1 = require("./DevServerState");
 const DevModeParentInterface_1 = require("./DevModeParentInterface");
 class DevModeInterface extends DevModeParentInterface_1.DevModeParentInterface {
     _generateAppExtensionMappings(components) {
@@ -49,56 +47,6 @@ class DevModeInterface extends DevModeParentInterface_1.DevModeParentInterface {
             yield this.parentSetup(args);
         });
     }
-    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,
-            });
-            if (this.isRunning) {
-                this.logger.debug('Dev server is already running, not starting again');
-                return;
-            }
-            let expressPort = constants_1.EXPRESS_DEFAULT_PORT;
-            let webSocketPort = constants_1.WEBSOCKET_DEFAULT_PORT;
-            if (requestPorts) {
-                try {
-                    const portData = yield requestPorts([
-                        { instanceId: constants_1.EXPRESS_SERVER_ID, port: constants_1.EXPRESS_DEFAULT_PORT },
-                        { instanceId: constants_1.VITE_DEV_SERVER_ID, port: constants_1.WEBSOCKET_DEFAULT_PORT },
-                    ]);
-                    expressPort = portData[constants_1.EXPRESS_SERVER_ID];
-                    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)(((_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,
-                accountId,
-                platformVersion: this._getPlatformVersion(projectConfig),
-                expressPort,
-                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;
-            extensionsMetadata.forEach((metadata) => {
-                const { config: { data: { title, appName }, }, } = metadata;
-                this.logger.info(`Running extension '${title}' from app '${appName}'`);
-            });
-            this.isRunning = true;
-        });
-    }
 }
 exports.DevModeInterfaceNonSingleton = DevModeInterface;
 exports.default = new DevModeInterface();

package/dist/lib/DevModeParentInterface.d.ts

@@ -9,11 +9,11 @@ export declare abstract class DevModeParentInterface {
     isConfigured?: boolean;
     isRunning?: boolean;
     shutdown?: () => Promise<void>;
-    protected abstract start(args: DevModeStartArguments): Promise<void>;
     protected abstract _generateAppExtensionMappings(components: ProjectComponentMap | UnifiedProjectComponentMap): AppExtensionMapping[];
     _getPlatformVersion(projectConfig?: ProjectConfig): PlatformVersion;
     _reset(): void;
     parentSetup({ onUploadRequired, promptUser, logger, urls, setActiveApp, choices, }: DevModeBaseSetupArguments): Promise<void>;
+    start({ requestPorts, accountId, projectConfig, }: DevModeStartArguments): Promise<void>;
     fileChange(filePath: string, __event: unknown): Promise<void>;
     cleanup(): Promise<void>;
 }

package/dist/lib/DevModeParentInterface.js

@@ -11,7 +11,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DevModeParentInterface = void 0;
 const constants_1 = require("./constants");
+const dev_1 = require("./dev");
+const config_1 = require("./config");
+const constants_2 = require("./constants");
 const utils_1 = require("./utils");
+const DevServerState_1 = require("./DevServerState");
 const defaultLogger = {
     info: (...args) => {
         console.log(...args);
@@ -97,6 +101,68 @@ class DevModeParentInterface {
             }
         });
     }
+    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,
+            });
+            if (this.isRunning) {
+                this.logger.debug('Dev server is already running, not starting again');
+                return;
+            }
+            let expressPort = constants_2.EXPRESS_DEFAULT_PORT;
+            let webSocketPort = constants_2.WEBSOCKET_DEFAULT_PORT;
+            if (requestPorts) {
+                try {
+                    const portData = yield requestPorts([
+                        { instanceId: constants_2.EXPRESS_SERVER_ID, port: constants_2.EXPRESS_DEFAULT_PORT },
+                        { instanceId: constants_2.VITE_DEV_SERVER_ID, port: constants_2.WEBSOCKET_DEFAULT_PORT },
+                    ]);
+                    expressPort = portData[constants_2.EXPRESS_SERVER_ID];
+                    webSocketPort = portData[constants_2.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)(((_b = (_a = this.configs) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.path) || '', this.logger) || {};
+            try {
+                this.devServerState = new DevServerState_1.DevServerState({
+                    localDevUrlMapping,
+                    extensionConfigs: this.configs,
+                    accountId,
+                    platformVersion: this._getPlatformVersion(projectConfig),
+                    expressPort,
+                    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,
+                });
+            }
+            catch (e) {
+                this.logger.debug('Error setting up DevServerState', e);
+                throw e;
+            }
+            try {
+                this.shutdown = yield (0, dev_1.startDevMode)(this.devServerState);
+            }
+            catch (e) {
+                this.logger.debug('Error starting dev mode', e);
+                throw e;
+            }
+            const { extensionsMetadata } = this.devServerState;
+            extensionsMetadata.forEach((metadata) => {
+                const { config: { data: { title, appName }, }, } = metadata;
+                this.logger.info(`Running extension '${title}' from app '${appName}'`);
+            });
+            this.isRunning = true;
+        });
+    }
     // The contract is for this to be async, so eslint can chill
     // eslint-disable-next-line require-await
     fileChange(filePath, __event) {

package/dist/lib/DevModeUnifiedInterface.d.ts

@@ -1,19 +1,8 @@
-import { ProjectConfig, AppExtensionMapping, UnifiedProjectComponentMap, UnifiedDevModeSetupArguments } from './types';
+import { AppExtensionMapping, UnifiedProjectComponentMap, UnifiedDevModeSetupArguments } from './types';
 import { DevModeParentInterface } from './DevModeParentInterface';
-interface StartArguments {
-    accountId?: number;
-    requestPorts?: (requestPortsData: Array<{
-        instanceId: string;
-        port?: number;
-    }>) => Promise<{
-        [instanceId: string]: number;
-    }>;
-    projectConfig?: ProjectConfig;
-}
 declare class DevModeUnifiedInterface extends DevModeParentInterface {
     _generateAppExtensionMappings(components: UnifiedProjectComponentMap): AppExtensionMapping[];
     setup(args: UnifiedDevModeSetupArguments): Promise<void>;
-    start({ requestPorts, accountId, projectConfig }: StartArguments): Promise<void>;
 }
 export { DevModeUnifiedInterface as DevModeUnifiedInterfaceNonSingleton };
 declare const _default: DevModeUnifiedInterface;

package/dist/lib/DevModeUnifiedInterface.js

@@ -16,28 +16,28 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DevModeUnifiedInterfaceNonSingleton = void 0;
 const path_1 = __importDefault(require("path"));
-const dev_1 = require("./dev");
 const constants_1 = require("./constants");
-const config_1 = require("./config");
-const DevServerState_1 = require("./DevServerState");
+const types_1 = require("./types");
 const DevModeParentInterface_1 = require("./DevModeParentInterface");
 const utils_1 = require("./utils");
 class DevModeUnifiedInterface extends DevModeParentInterface_1.DevModeParentInterface {
     _generateAppExtensionMappings(components) {
         var _a, _b, _c, _d;
         const mappings = [];
-        // Loop over all of the app configs that are passed in
+        // Loop over all of the components that are passed in
         const allComponentUids = Object.keys(components);
-        // First, find the app data.
+        // Find the app component
         const appUid = allComponentUids.find((componentUid) => {
-            return components[componentUid].componentType === 'APPLICATION';
+            return (components[componentUid].componentType ===
+                types_1.UnifiedComponentTypes.APPLICATION);
         });
-        // TODO: Should we throw an error or something here instead? At least log something?
+        // This should fail a lot sooner (on the cli side), but added this just in case.
         if (!appUid) {
+            this.logger.error('Application configuration is missing.');
             return mappings;
         }
         const appData = components[appUid];
-        // Use the app data to generate the app config in the expected shape.
+        // Use the app data to generate the app config in the expected shape, to match old projects.
         const appConfig = {
             name: appData.config.name,
             description: (_a = appData.config) === null || _a === void 0 ? void 0 : _a.description,
@@ -63,22 +63,21 @@ class DevModeUnifiedInterface extends DevModeParentInterface_1.DevModeParentInte
         // Build the extension mapping data
         extensionUids.forEach((extensionUid) => {
             const extension = components[extensionUid];
+            // Update the extension entrypoint to be "relative" to the extension directory (eg from /app/card/card.jsx to ./card.jsx)
+            extension.config.entrypoint = `./${path_1.default.basename(extension.config.entrypoint)}`;
             // Add them to the app config
             switch (extension.componentType) {
-                case 'CARD':
+                case types_1.UnifiedComponentTypes.CARD:
                 default:
                     appConfig.extensions.crm.cards.push({
                         file: extension.config.entrypoint,
                     });
             }
-            // Generate the name
+            // Generate the name and other extension data for the mapping.
             const extensionName = `${appData.config.name}/${extension.config.name}`;
-            // Transform the type from a format like CRM_CARD to crm-card
-            const extensionType = extension.componentType
-                .toLowerCase()
-                .replace('_', '-');
             const extensionOutput = (0, utils_1.getUrlSafeFileName)(path_1.default.resolve(extension.localDev.componentRoot, extension.config.entrypoint));
             const filePath = path_1.default.resolve(extension.localDev.componentRoot, extension.config.entrypoint);
+            // Build the config in the correct shape
             const extensionData = {
                 title: extension.config.name,
                 uid: extension.uid,
@@ -91,15 +90,17 @@ class DevModeUnifiedInterface extends DevModeParentInterface_1.DevModeParentInte
                 sourceId: `${appConfig.uid}::${extension.uid}`,
             };
             // Generate object types
-            extension.config.objectTypes.forEach((objectType) => {
-                extensionData.objectTypes.push({
-                    name: objectType,
+            if (extension.config.objectTypes) {
+                extension.config.objectTypes.forEach((objectType) => {
+                    extensionData.objectTypes.push({
+                        name: objectType,
+                    });
                 });
-            });
+            }
             mappings.push({
                 name: extensionName,
                 value: {
-                    type: extensionType,
+                    type: extension.componentType.toLowerCase(),
                     data: extensionData,
                     output: extensionOutput,
                     path: appData.localDev.componentRoot,
@@ -117,62 +118,6 @@ class DevModeUnifiedInterface extends DevModeParentInterface_1.DevModeParentInte
             yield this.parentSetup(args);
         });
     }
-    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,
-            });
-            if (this.isRunning) {
-                this.logger.debug('Dev server is already running, not starting again');
-                return;
-            }
-            let expressPort = constants_1.EXPRESS_DEFAULT_PORT;
-            let webSocketPort = constants_1.WEBSOCKET_DEFAULT_PORT;
-            if (requestPorts) {
-                try {
-                    const portData = yield requestPorts([
-                        { instanceId: constants_1.EXPRESS_SERVER_ID, port: constants_1.EXPRESS_DEFAULT_PORT },
-                        { instanceId: constants_1.VITE_DEV_SERVER_ID, port: constants_1.WEBSOCKET_DEFAULT_PORT },
-                    ]);
-                    expressPort = portData[constants_1.EXPRESS_SERVER_ID];
-                    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)(((_b = (_a = this.configs) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.path) || '', this.logger) || {};
-            try {
-                this.devServerState = new DevServerState_1.DevServerState({
-                    localDevUrlMapping,
-                    extensionConfigs: this.configs,
-                    accountId,
-                    platformVersion: this._getPlatformVersion(projectConfig),
-                    expressPort,
-                    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,
-                });
-            }
-            catch (e) {
-                this.logger.error('Error setting up DevServerState', e);
-                throw e;
-            }
-            this.shutdown = yield (0, dev_1.startDevMode)(this.devServerState);
-            const { extensionsMetadata } = this.devServerState;
-            extensionsMetadata.forEach((metadata) => {
-                const { config: { data: { title, appName }, }, } = metadata;
-                this.logger.info(`Running extension '${title}' from app '${appName}'`);
-            });
-            this.isRunning = true;
-        });
-    }
 }
 exports.DevModeUnifiedInterfaceNonSingleton = DevModeUnifiedInterface;
 exports.default = new DevModeUnifiedInterface();

package/dist/lib/types.d.ts

@@ -70,12 +70,16 @@ export interface PublicAppAuth {
     optionalScopes: string[];
     additionalScopes: string[];
 }
+export declare enum UnifiedAppAuthTypes {
+    OAUTH = "OAUTH",
+    STATIC = "STATIC"
+}
 export interface UnifiedAppAuth {
-    type: 'OAUTH';
-    redirectUrls: string[];
-    requiredScopes: string[];
-    optionalScopes: string[];
-    conditionallyRequiredScopes: string[];
+    type: UnifiedAppAuthTypes;
+    redirectUrls?: string[];
+    requiredScopes?: string[];
+    optionalScopes?: string[];
+    conditionallyRequiredScopes?: string[];
 }
 export type AppAuth = PublicAppAuth | UnifiedAppAuth;
 export interface PublicAppConfig {
@@ -109,20 +113,27 @@ export interface ProjectComponent {
 export interface ProjectComponentMap {
     [key: string]: ProjectComponent;
 }
-export interface UnifiedExtensionComponent {
+export type UnifiedCardConfig = {
     uid: string;
+    type: 'card';
     config: {
         name: string;
-        description: string;
+        description?: string;
         location: string;
         entrypoint: string;
-        objectTypes: string[];
-        previewImage: {
+        objectTypes?: string[];
+        previewImage?: {
             file: string;
             altText: string;
         };
     };
-    componentType: 'CARD';
+};
+export declare enum UnifiedComponentTypes {
+    CARD = "CARD",
+    APPLICATION = "APPLICATION"
+}
+export type UnifiedExtensionComponent = Omit<UnifiedCardConfig, 'type'> & {
+    componentType: UnifiedComponentTypes.CARD;
     componentDeps: {
         app: string;
     };
@@ -132,27 +143,27 @@ export interface UnifiedExtensionComponent {
         componentRoot: string;
         componentConfigPath: string;
     };
-}
+};
 export interface UnifiedAppComponent {
     uid: string;
     config: {
         description: string;
         name: string;
-        logo: string;
+        logo?: string;
         auth: UnifiedAppAuth;
-        permittedUrls: {
+        permittedUrls?: {
             fetch: string[];
             iframe: string[];
             img: string[];
         };
-        support: {
+        support?: {
             supportEmail: string;
             documentationUrl: string;
             supportUrl: string;
             supportPhone: string;
         };
     };
-    componentType: 'APPLICATION';
+    componentType: UnifiedComponentTypes.APPLICATION;
     componentDeps: {};
     metaFilePath: string;
     files: {};

package/dist/lib/types.js

@@ -1,2 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnifiedComponentTypes = exports.UnifiedAppAuthTypes = void 0;
+var UnifiedAppAuthTypes;
+(function (UnifiedAppAuthTypes) {
+    UnifiedAppAuthTypes["OAUTH"] = "OAUTH";
+    UnifiedAppAuthTypes["STATIC"] = "STATIC";
+})(UnifiedAppAuthTypes || (exports.UnifiedAppAuthTypes = UnifiedAppAuthTypes = {}));
+var UnifiedComponentTypes;
+(function (UnifiedComponentTypes) {
+    UnifiedComponentTypes["CARD"] = "CARD";
+    UnifiedComponentTypes["APPLICATION"] = "APPLICATION";
+})(UnifiedComponentTypes || (exports.UnifiedComponentTypes = UnifiedComponentTypes = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/ui-extensions-dev-server",
-  "version": "0.8.46",
+  "version": "0.8.47",
   "description": "",
   "bin": {
     "uie": "./dist/lib/bin/cli.js"
@@ -27,7 +27,7 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@hubspot/app-functions-dev-server": "0.8.46",
+    "@hubspot/app-functions-dev-server": "0.8.47",
     "chalk": "5.4.1",
     "commander": "13.0.0",
     "cors": "2.8.5",
@@ -69,5 +69,5 @@
       "optional": true
     }
   },
-  "gitHead": "a97919f0e9d8a69a039f7a2861e074af93f2dda0"
+  "gitHead": "6aa0e60d7241a0218512617a5126df688f8fb894"
 }