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

package/dist/index.d.ts

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

package/dist/index.js

@@ -23,10 +23,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DevModeInterfaceNonSingleton = exports.DevModeInterface = exports.buildSingleExtension = exports.remoteBuild = void 0;
+exports.DevModeUnifiedInterfaceNonSingleton = exports.DevModeUnifiedInterface = 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 = __importStar(require("./lib/DevModeInterface"));
 exports.DevModeInterface = DevModeInterface_1.default;
 Object.defineProperty(exports, "DevModeInterfaceNonSingleton", { enumerable: true, get: function () { return DevModeInterface_1.DevModeInterfaceNonSingleton; } });
+const DevModeUnifiedInterface_1 = __importStar(require("./lib/DevModeUnifiedInterface"));
+exports.DevModeUnifiedInterface = DevModeUnifiedInterface_1.default;
+Object.defineProperty(exports, "DevModeUnifiedInterfaceNonSingleton", { enumerable: true, get: function () { return DevModeUnifiedInterface_1.DevModeUnifiedInterfaceNonSingleton; } });

package/dist/lib/DevModeInterface.d.ts

@@ -1,47 +1,9 @@
-import { ExtensionOutputConfig, Logger, PlatformVersion, ProjectComponentMap, ProjectConfig } from './types';
-import { PromptModule } from 'inquirer';
-import { DevServerState } from './DevServerState';
-interface SetupArguments {
-    components: ProjectComponentMap;
-    onUploadRequired?: VoidFunction;
-    promptUser: PromptModule;
-    logger: Logger;
-    urls: {
-        api: string;
-        web: string;
-    };
-    setActiveApp: (appUid: string | undefined) => Promise<void>;
-}
-interface StartArguments {
-    accountId?: number;
-    requestPorts?: (requestPortsData: Array<{
-        instanceId: string;
-        port?: number;
-    }>) => Promise<{
-        [instanceId: string]: number;
-    }>;
-    projectConfig?: ProjectConfig;
-}
-interface AppExtensionMapping {
-    name: string;
-    value: ExtensionOutputConfig;
-}
-declare class DevModeInterface {
-    configs?: ExtensionOutputConfig[];
-    devServerState?: DevServerState;
-    onUploadRequired?: VoidFunction;
-    shutdown?: () => Promise<void>;
-    logger: Logger;
-    urls?: SetupArguments['urls'];
-    isConfigured?: boolean;
-    isRunning?: boolean;
+import { ProjectComponentMap, AppExtensionMapping, DevModeStartArguments, DevModeSetupArguments } from './types';
+import { DevModeParentInterface } from './DevModeParentInterface';
+declare class DevModeInterface extends DevModeParentInterface {
     _generateAppExtensionMappings(components: ProjectComponentMap): AppExtensionMapping[];
-    _getPlatformVersion(projectConfig?: ProjectConfig): PlatformVersion;
-    _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>;
+    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

@@ -14,28 +14,10 @@ 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");
 const config_1 = require("./config");
 const DevServerState_1 = require("./DevServerState");
-const utils_1 = require("./utils");
-const defaultLogger = {
-    info: (...args) => {
-        console.log(...args);
-    },
-    debug: (...args) => {
-        console.log(...args);
-    },
-    warn: (...args) => {
-        console.error(...args);
-    },
-    error: (...args) => {
-        console.error(...args);
-    },
-};
-class DevModeInterface {
-    constructor() {
-        this.logger = defaultLogger;
-    }
+const DevModeParentInterface_1 = require("./DevModeParentInterface");
+class DevModeInterface extends DevModeParentInterface_1.DevModeParentInterface {
     _generateAppExtensionMappings(components) {
         // Loop over all of the app configs that are passed in
         const allComponentNames = Object.keys(components);
@@ -61,87 +43,13 @@ class DevModeInterface {
             return appExtensionMappings;
         }, []);
     }
-    _getPlatformVersion(projectConfig) {
-        const { platformVersion } = projectConfig !== null && projectConfig !== void 0 ? projectConfig : {};
-        if (!platformVersion) {
-            return constants_2.PLATFORM_VERSION.V20231;
-        }
-        switch (platformVersion) {
-            case constants_2.PLATFORM_VERSION.V20231:
-                return constants_2.PLATFORM_VERSION.V20231;
-            case constants_2.PLATFORM_VERSION.V20232:
-                return constants_2.PLATFORM_VERSION.V20232;
-            default:
-                return (0, utils_1.throwUnhandledPlatformVersionError)(platformVersion);
-        }
-    }
-    _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;
+    setup(args) {
         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');
-                return;
-            }
-            this.logger = logger;
-            this.onUploadRequired = onUploadRequired;
-            this.urls = urls;
-            const choices = this._generateAppExtensionMappings(components);
-            if (choices.length === 0) {
-                throw new Error('No extensions to run');
-            }
-            else if (choices.length === 1) {
-                this.configs = [choices[0].value];
-            }
-            else {
-                const answers = yield promptUser({
-                    type: 'checkbox',
-                    name: 'extensions',
-                    message: 'Which extension(s) would you like to run?',
-                    validate: (input) => {
-                        if (!input || input.length === 0) {
-                            return 'Select at least one extension to run';
-                        }
-                        const appNames = new Set(input.map((choice) => choice.data.appName));
-                        if (appNames.size > 1) {
-                            return 'Running multiple extensions is only supported for a single application';
-                        }
-                        return true;
-                    },
-                    choices,
-                });
-                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);
-            }
+            args.choices = this._generateAppExtensionMappings(args.components);
+            yield this.parentSetup(args);
         });
     }
-    // The contract is for this to be async, so eslint can chill
-    // eslint-disable-next-line require-await
-    fileChange(filePath, __event) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.devServerState || !this.devServerState.extensionsMetadata) {
-                return;
-            }
-            const relevantConfigFileChanged = this.devServerState.extensionsMetadata.some((metadata) => metadata.config.extensionConfigPath === filePath);
-            if (relevantConfigFileChanged && this.onUploadRequired) {
-                this.onUploadRequired();
-            }
-        });
-    }
-    start({ requestPorts, accountId, projectConfig }) {
+    start({ requestPorts, accountId, projectConfig, }) {
         var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
             this.logger.debug('Start function was invoked', {
@@ -191,15 +99,6 @@ class DevModeInterface {
             this.isRunning = true;
         });
     }
-    cleanup() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.shutdown) {
-                yield this.shutdown();
-            }
-            // 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/DevModeParentInterface.d.ts

@@ -0,0 +1,19 @@
+import { PlatformVersion, ProjectConfig, Logger, ExtensionOutputConfig, ProjectComponentMap, AppExtensionMapping, DevModeStartArguments, DevModeSetupArguments, UnifiedProjectComponentMap, DevModeBaseSetupArguments } from './types';
+import { DevServerState } from './DevServerState';
+export declare abstract class DevModeParentInterface {
+    configs?: ExtensionOutputConfig[];
+    devServerState?: DevServerState;
+    onUploadRequired?: VoidFunction;
+    logger: Logger;
+    urls?: DevModeSetupArguments['urls'];
+    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>;
+    fileChange(filePath: string, __event: unknown): Promise<void>;
+    cleanup(): Promise<void>;
+}

package/dist/lib/DevModeParentInterface.js

@@ -0,0 +1,123 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DevModeParentInterface = void 0;
+const constants_1 = require("./constants");
+const utils_1 = require("./utils");
+const defaultLogger = {
+    info: (...args) => {
+        console.log(...args);
+    },
+    debug: (...args) => {
+        console.log(...args);
+    },
+    warn: (...args) => {
+        console.error(...args);
+    },
+    error: (...args) => {
+        console.error(...args);
+    },
+};
+class DevModeParentInterface {
+    constructor() {
+        this.logger = defaultLogger;
+    }
+    _getPlatformVersion(projectConfig) {
+        const { platformVersion } = projectConfig !== null && projectConfig !== void 0 ? projectConfig : {};
+        if (!platformVersion) {
+            return constants_1.PLATFORM_VERSION.V20231;
+        }
+        switch (platformVersion) {
+            case constants_1.PLATFORM_VERSION.V20231:
+                return constants_1.PLATFORM_VERSION.V20231;
+            case constants_1.PLATFORM_VERSION.V20232:
+                return constants_1.PLATFORM_VERSION.V20232;
+            case constants_1.PLATFORM_VERSION.V20252:
+                return constants_1.PLATFORM_VERSION.V20252;
+            default:
+                return (0, utils_1.throwUnhandledPlatformVersionError)(platformVersion);
+        }
+    }
+    _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;
+    }
+    parentSetup({ onUploadRequired, promptUser, logger, urls, setActiveApp, choices = [], }) {
+        var _a, _b, _c;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.isConfigured) {
+                logger.debug('Dev server has already been configured, skipping');
+                return;
+            }
+            this.logger = logger;
+            this.onUploadRequired = onUploadRequired;
+            this.urls = urls;
+            if (choices.length === 0) {
+                throw new Error('No extensions to run');
+            }
+            else if (choices.length === 1) {
+                this.configs = [choices[0].value];
+            }
+            else {
+                const answers = yield promptUser({
+                    type: 'checkbox',
+                    name: 'extensions',
+                    message: 'Which extension(s) would you like to run?',
+                    validate: (input) => {
+                        if (!input || input.length === 0) {
+                            return 'Select at least one extension to run';
+                        }
+                        const appNames = new Set(input.map((choice) => choice.data.appName));
+                        if (appNames.size > 1) {
+                            return 'Running multiple extensions is only supported for a single application';
+                        }
+                        return true;
+                    },
+                    choices,
+                });
+                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
+    // eslint-disable-next-line require-await
+    fileChange(filePath, __event) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.devServerState || !this.devServerState.extensionsMetadata) {
+                return;
+            }
+            const relevantConfigFileChanged = this.devServerState.extensionsMetadata.some((metadata) => metadata.config.extensionConfigPath === filePath);
+            if (relevantConfigFileChanged && this.onUploadRequired) {
+                this.onUploadRequired();
+            }
+        });
+    }
+    cleanup() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.shutdown) {
+                yield this.shutdown();
+            }
+            // Since the DevModeInterface is a singleton, we need to wipe out the state when we shutdown
+            this._reset();
+        });
+    }
+}
+exports.DevModeParentInterface = DevModeParentInterface;

package/dist/lib/DevModeUnifiedInterface.d.ts

@@ -0,0 +1,20 @@
+import { ProjectConfig, 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;
+export default _default;

package/dist/lib/DevModeUnifiedInterface.js

@@ -0,0 +1,178 @@
+"use strict";
+/* hs-eslint ignored failing-rules */
+/* eslint-disable hubspot-dev/no-unsupported-ts-syntax */
+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 });
+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 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
+        const allComponentUids = Object.keys(components);
+        // First, find the app data.
+        const appUid = allComponentUids.find((componentUid) => {
+            return components[componentUid].componentType === 'APPLICATION';
+        });
+        // TODO: Should we throw an error or something here instead? At least log something?
+        if (!appUid) {
+            return mappings;
+        }
+        const appData = components[appUid];
+        // Use the app data to generate the app config in the expected shape.
+        const appConfig = {
+            name: appData.config.name,
+            description: (_a = appData.config) === null || _a === void 0 ? void 0 : _a.description,
+            uid: appData.uid,
+            extensions: {
+                crm: {
+                    cards: [],
+                },
+            },
+            auth: (_b = appData.config) === null || _b === void 0 ? void 0 : _b.auth,
+            support: (_c = appData.config) === null || _c === void 0 ? void 0 : _c.support,
+            // All unified apps are currently "public" meaning they don't support serverless and do support a proxy.
+            // The determination of what is "public" and "private" as it relates to our usage is still up in the air.
+            isPublicApp: true,
+            allowedUrls: ((_d = appData.config) === null || _d === void 0 ? void 0 : _d.permittedUrls)
+                ? Object.values(appData.config.permittedUrls).flat()
+                : [],
+        };
+        // Then get all the supported extensions
+        const extensionUids = allComponentUids.filter((componentUid) => {
+            return constants_1.SUPPORTED_EXTENSION_TYPES.includes(components[componentUid].componentType);
+        });
+        // Build the extension mapping data
+        extensionUids.forEach((extensionUid) => {
+            const extension = components[extensionUid];
+            // Add them to the app config
+            switch (extension.componentType) {
+                case 'CARD':
+                default:
+                    appConfig.extensions.crm.cards.push({
+                        file: extension.config.entrypoint,
+                    });
+            }
+            // Generate the name
+            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);
+            const extensionData = {
+                title: extension.config.name,
+                uid: extension.uid,
+                location: extension.config.location,
+                module: {
+                    file: filePath,
+                },
+                objectTypes: [],
+                appName: appData.config.name,
+                sourceId: `${appConfig.uid}::${extension.uid}`,
+            };
+            // Generate object types
+            extension.config.objectTypes.forEach((objectType) => {
+                extensionData.objectTypes.push({
+                    name: objectType,
+                });
+            });
+            mappings.push({
+                name: extensionName,
+                value: {
+                    type: extensionType,
+                    data: extensionData,
+                    output: extensionOutput,
+                    path: appData.localDev.componentRoot,
+                    extensionPath: extension.localDev.componentRoot,
+                    extensionConfigPath: extension.localDev.componentConfigPath,
+                    appConfig,
+                },
+            });
+        });
+        return mappings;
+    }
+    setup(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            args.choices = this._generateAppExtensionMappings(args.components);
+            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/constants.d.ts

@@ -21,7 +21,10 @@ export declare const SERVER_CAPABILITIES: string[];
 export declare const PLATFORM_VERSION: {
     readonly V20231: "2023.1";
     readonly V20232: "2023.2";
+    readonly V20252: "2025.2";
 };
 export declare const PUBLIC_APP = "public-app";
 export declare const PRIVATE_APP = "private-app";
+export declare const CARD_EXTENSION = "CARD";
 export declare const SUPPORTED_APP_TYPES: string[];
+export declare const SUPPORTED_EXTENSION_TYPES: string[];

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.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.SUPPORTED_EXTENSION_TYPES = exports.SUPPORTED_APP_TYPES = exports.CARD_EXTENSION = 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';
@@ -31,9 +31,12 @@ exports.SERVER_CAPABILITIES = [
 exports.PLATFORM_VERSION = {
     V20231: '2023.1',
     V20232: '2023.2',
+    V20252: '2025.2',
 };
 exports.PUBLIC_APP = 'public-app';
 // You gotta be kidding me linter
 // eslint-disable-next-line hubspot-dev/no-private-classes
 exports.PRIVATE_APP = 'private-app';
+exports.CARD_EXTENSION = 'CARD';
 exports.SUPPORTED_APP_TYPES = [exports.PUBLIC_APP, exports.PRIVATE_APP];
+exports.SUPPORTED_EXTENSION_TYPES = [exports.CARD_EXTENSION];

package/dist/lib/plugins/manifestPlugin.js

@@ -13,7 +13,6 @@ const utils_1 = require("../utils");
 const ast_1 = require("../ast");
 const PACKAGE_LOCK_FILE = 'package-lock.json';
 const PACKAGE_FILE = 'package.json';
-const EXTENSIONS_PATH = 'src/app/extensions/';
 const manifestPlugin = (options) => {
     let allDataDependencies;
     return {
@@ -73,18 +72,18 @@ function _generateManifestContents(bundle, extensionPath, allDataDependencies) {
     // The keys to bundle are the filename without any path information
     const bundles = Object.keys(bundle).filter((cur) => cur.endsWith('.js'));
     if (bundles.length === 1) {
-        return Object.assign(Object.assign(Object.assign({}, _generateManifestEntry(bundle[bundles[0]])), dataDependencies), baseManifest);
+        return Object.assign(Object.assign(Object.assign({}, _generateManifestEntry(bundle[bundles[0]], extensionPath)), dataDependencies), baseManifest);
     }
     const manifest = bundles.reduce((acc, current) => {
-        return Object.assign(Object.assign({}, acc), { [current]: _generateManifestEntry(bundle[current]) });
+        return Object.assign(Object.assign({}, acc), { [current]: _generateManifestEntry(bundle[current], extensionPath) });
     }, {});
     return Object.assign(Object.assign(Object.assign({}, manifest), dataDependencies), baseManifest);
 }
-function _generateManifestEntry(subBundle) {
+function _generateManifestEntry(subBundle, extensionPath) {
     const { facadeModuleId, moduleIds, modules } = subBundle;
     return {
-        entry: _stripPathPriorToExtDir(facadeModuleId),
-        modules: _buildModulesInfo(moduleIds, modules),
+        entry: _stripPathPriorToExtDir(facadeModuleId, extensionPath),
+        modules: _buildModulesInfo(moduleIds, modules, extensionPath),
     };
 }
 function _loadJsonFileSafely(extensionPath, filename) {
@@ -100,10 +99,14 @@ function _loadPackageFile(extensionPath) {
     return (_loadJsonFileSafely(extensionPath, PACKAGE_LOCK_FILE) ||
         _loadJsonFileSafely(extensionPath, PACKAGE_FILE));
 }
-function _stripPathPriorToExtDir(filepath) {
-    return filepath === null || filepath === void 0 ? void 0 : filepath.split(EXTENSIONS_PATH).pop();
+function _stripPathPriorToExtDir(filepath, extensionPath) {
+    // Before stripping the path, make sure the given extensionPath ends with a slash.
+    extensionPath = extensionPath.endsWith('/')
+        ? extensionPath
+        : `${extensionPath}/`;
+    return filepath === null || filepath === void 0 ? void 0 : filepath.split(extensionPath).pop();
 }
-function _buildModulesInfo(moduleIds, modules) {
+function _buildModulesInfo(moduleIds, modules, extensionPath) {
     const accumulator = {
         internal: [],
         external: [],
@@ -111,7 +114,7 @@ function _buildModulesInfo(moduleIds, modules) {
     return moduleIds.reduce((acc, mod) => {
         const { renderedExports } = modules[mod];
         const moduleData = {
-            module: _stripPathPriorToExtDir(mod),
+            module: _stripPathPriorToExtDir(mod, extensionPath),
             renderedExports,
         };
         if ((0, utils_1.isNodeModule)(moduleData.module)) {

package/dist/lib/types.d.ts

@@ -1,5 +1,6 @@
 import { PLATFORM_VERSION, PRIVATE_APP, PUBLIC_APP } from './constants';
 import { LocalDevUrlMapping } from '@hubspot/app-functions-dev-server';
+import { PromptModule } from 'inquirer';
 export interface ObjectTypes {
     name: string;
 }
@@ -15,23 +16,24 @@ export interface ExtensionConfig {
         uid?: string;
     };
 }
+export interface ExtensionOutputDataConfig {
+    appName: string;
+    title: string;
+    location: string;
+    module: {
+        file: string;
+    };
+    objectTypes: ObjectTypes[];
+    uid?: string;
+    sourceId?: string | null;
+}
 export interface ExtensionOutputConfig extends ExtensionConfig {
     type: string;
     output: string;
     path: string;
     extensionPath: string;
     extensionConfigPath: string;
-    data: {
-        appName: string;
-        title: string;
-        location: string;
-        module: {
-            file: string;
-        };
-        objectTypes: ObjectTypes[];
-        uid?: string;
-        sourceId?: string | null;
-    };
+    data: ExtensionOutputDataConfig;
     appConfig?: AppConfig;
 }
 export interface ExtensionConfigMap {
@@ -60,20 +62,29 @@ export interface PrivateAppConfig {
 export interface LocalAppConfig {
     proxy: LocalDevUrlMapping;
 }
+export interface PublicAppAuth {
+    preventAdditionalScopes: boolean;
+    preventOptionalScopes: boolean;
+    redirectUrls: string[];
+    requiredScopes: string[];
+    optionalScopes: string[];
+    additionalScopes: string[];
+}
+export interface UnifiedAppAuth {
+    type: 'OAUTH';
+    redirectUrls: string[];
+    requiredScopes: string[];
+    optionalScopes: string[];
+    conditionallyRequiredScopes: string[];
+}
+export type AppAuth = PublicAppAuth | UnifiedAppAuth;
 export interface PublicAppConfig {
     name: string;
     uid: string;
     logo?: string;
     description?: string;
     allowedUrls?: string[];
-    auth?: {
-        preventAdditionalScopes: boolean;
-        preventOptionalScopes: boolean;
-        redirectUrls: string[];
-        requiredScopes: string[];
-        optionalScopes: string[];
-        additionalScopes: string[];
-    };
+    auth?: AppAuth;
     support?: {
         supportUrl: string;
         supportEmail: string;
@@ -98,6 +109,66 @@ export interface ProjectComponent {
 export interface ProjectComponentMap {
     [key: string]: ProjectComponent;
 }
+export interface UnifiedExtensionComponent {
+    uid: string;
+    config: {
+        name: string;
+        description: string;
+        location: string;
+        entrypoint: string;
+        objectTypes: string[];
+        previewImage: {
+            file: string;
+            altText: string;
+        };
+    };
+    componentType: 'CARD';
+    componentDeps: {
+        app: string;
+    };
+    metaFilePath: string;
+    files: {};
+    localDev: {
+        componentRoot: string;
+        componentConfigPath: string;
+    };
+}
+export interface UnifiedAppComponent {
+    uid: string;
+    config: {
+        description: string;
+        name: string;
+        logo: string;
+        auth: UnifiedAppAuth;
+        permittedUrls: {
+            fetch: string[];
+            iframe: string[];
+            img: string[];
+        };
+        support: {
+            supportEmail: string;
+            documentationUrl: string;
+            supportUrl: string;
+            supportPhone: string;
+        };
+    };
+    componentType: 'APPLICATION';
+    componentDeps: {};
+    metaFilePath: string;
+    files: {};
+    localDev: {
+        componentRoot: string;
+        componentConfigPath: string;
+    };
+}
+export type UnifiedAppConfig = Omit<PublicAppConfig, 'auth'> & {
+    auth: UnifiedAppAuth;
+    isPublicApp: boolean;
+};
+export type UnifiedComponent = UnifiedExtensionComponent | UnifiedAppComponent;
+export interface UnifiedProjectComponentMap {
+    [key: string]: UnifiedComponent;
+}
 export interface BaseMessage {
     appName: string;
     title: string;
@@ -139,4 +210,35 @@ export interface Logger {
     warn: (...args: any[]) => void;
     error: (...args: any[]) => void;
 }
+export interface AppExtensionMapping {
+    name: string;
+    value: ExtensionOutputConfig;
+}
+export interface DevModeStartArguments {
+    accountId?: number;
+    requestPorts?: (requestPortsData: Array<{
+        instanceId: string;
+        port?: number;
+    }>) => Promise<{
+        [instanceId: string]: number;
+    }>;
+    projectConfig?: ProjectConfig;
+}
+export interface DevModeBaseSetupArguments {
+    onUploadRequired?: VoidFunction;
+    promptUser: PromptModule;
+    logger: Logger;
+    urls: {
+        api: string;
+        web: string;
+    };
+    setActiveApp: (appUid: string | undefined) => Promise<void>;
+    choices?: AppExtensionMapping[];
+}
+export interface DevModeSetupArguments extends DevModeBaseSetupArguments {
+    components: ProjectComponentMap;
+}
+export interface UnifiedDevModeSetupArguments extends DevModeBaseSetupArguments {
+    components: UnifiedProjectComponentMap;
+}
 export {};

package/package.json

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