@hubspot/ui-extensions-dev-server 0.9.5 → 0.10.0

package/dist/lib/DevModeUnifiedInterface.d.ts

@@ -1,7 +1,7 @@
-import { AppExtensionMapping, UnifiedProjectComponentMap, UnifiedDevModeSetupArguments } from './types';
+import { AppExtensionMapping, UnifiedProjectComponentMap, UnifiedDevModeSetupArguments, ProfileVariables } from './types';
 import { DevModeParentInterface } from './DevModeParentInterface';
 declare class DevModeUnifiedInterface extends DevModeParentInterface {
-    _generateAppExtensionMappings(components: UnifiedProjectComponentMap): AppExtensionMapping[];
+    _generateAppExtensionMappings(components: UnifiedProjectComponentMap, profileData?: ProfileVariables): AppExtensionMapping[];
     setup(args: UnifiedDevModeSetupArguments): Promise<void>;
 }
 export { DevModeUnifiedInterface as DevModeUnifiedInterfaceNonSingleton };

package/dist/lib/DevModeUnifiedInterface.js

@@ -20,8 +20,16 @@ const constants_1 = require("./constants");
 const types_1 = require("./types");
 const DevModeParentInterface_1 = require("./DevModeParentInterface");
 const utils_1 = require("./utils");
+function getComponentName(componentType) {
+    if (componentType === types_1.UnifiedComponentTypes.SETTINGS) {
+        return 'Settings';
+    }
+    if (componentType === types_1.UnifiedComponentTypes.PAGE) {
+        return 'App Home';
+    }
+}
 class DevModeUnifiedInterface extends DevModeParentInterface_1.DevModeParentInterface {
-    _generateAppExtensionMappings(components) {
+    _generateAppExtensionMappings(components, profileData) {
         var _a, _b, _c, _d;
         const mappings = [];
         // Loop over all of the components that are passed in
@@ -55,6 +63,7 @@ class DevModeUnifiedInterface extends DevModeParentInterface_1.DevModeParentInte
             allowedUrls: ((_d = appData.config) === null || _d === void 0 ? void 0 : _d.permittedUrls)
                 ? Object.values(appData.config.permittedUrls).flat()
                 : [],
+            variables: profileData || {},
         };
         // Then get all the supported extensions
         const extensionUids = allComponentUids.filter((componentUid) => {
@@ -62,12 +71,14 @@ class DevModeUnifiedInterface extends DevModeParentInterface_1.DevModeParentInte
         });
         // Build the extension mapping data
         extensionUids.forEach((extensionUid) => {
+            var _a;
             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)}`;
             // Hardcode the extension name if this is a settings extension (the user does not provide a name for their settings card).
-            if (extension.componentType === types_1.UnifiedComponentTypes.SETTINGS) {
-                extension.config.name = 'Settings';
+            if (extension.componentType === types_1.UnifiedComponentTypes.SETTINGS ||
+                extension.componentType === types_1.UnifiedComponentTypes.PAGE) {
+                extension.config.name = (_a = getComponentName(extension.componentType)) !== null && _a !== void 0 ? _a : '';
             }
             // Add them to the app config
             switch (extension.componentType) {
@@ -117,8 +128,9 @@ class DevModeUnifiedInterface extends DevModeParentInterface_1.DevModeParentInte
         return mappings;
     }
     setup(args) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            args.choices = this._generateAppExtensionMappings(args.components);
+            args.choices = this._generateAppExtensionMappings(args.components, (_a = args.profileData) !== null && _a !== void 0 ? _a : {});
             yield this.parentSetup(args);
         });
     }

package/dist/lib/bin/cli.js

@@ -46,6 +46,7 @@ const buildSteps = {
     },
 };
 program
+    .option('-v, --profile-variables <path>', 'path to a json file with profile variables')
     .command('build <module>', { isDefault: true })
     .description('Build extension source code.')
     .action((module) => __awaiter(void 0, void 0, void 0, function* () {
@@ -74,8 +75,15 @@ function runCommand(command, options) {
     });
 }
 // Mirrors: https://git.hubteam.com/HubSpot/Artifactor/blob/f5cbea91d7a7dfb6278e878ae583e69022384fb5/ArtifactorFunctions/functions/node_18x/uie-remote-build/index.js#L59-L63
-function build({ extensionRoot, extensionDist, entrypoint }) {
-    return (0, build_1.remoteBuild)(extensionRoot, entrypoint, extensionDist);
+function build({ extensionRoot, extensionDist, entrypoint, profileVariables, }) {
+    return (0, build_1.remoteBuild)({
+        root: extensionRoot,
+        entryPoint: entrypoint,
+        outputDir: extensionDist,
+        appConfig: {
+            variables: profileVariables,
+        },
+    });
 }
 // Mirrors: https://git.hubteam.com/HubSpot/Artifactor/blob/f5cbea91d7a7dfb6278e878ae583e69022384fb5/ArtifactorFunctions/functions/node_18x/uie-remote-build/index.js#L53-L57
 function installDeps(options) {
@@ -103,11 +111,26 @@ function getOptions(modulePath) {
     const extensionRoot = node_path_1.default.dirname(entrypoint);
     const extensionDist = node_path_1.default.join(extensionRoot, 'dist');
     const spinner = (0, ora_1.default)();
+    // The Artifactor changes related to this are not yet available.
+    // When it is, this will mirror the process where if applicable, a profile-variables.json file is available in the build bundle.
+    const programOptions = program.opts();
+    let profileVariables = {};
+    if (programOptions.profileVariables) {
+        const profileVariablePath = programOptions.profileVariables;
+        const profileVariableFullPath = node_path_1.default.isAbsolute(profileVariablePath)
+            ? profileVariablePath
+            : node_path_1.default.resolve(process.cwd(), profileVariablePath);
+        if (node_fs_1.default.existsSync(profileVariableFullPath) &&
+            node_path_1.default.extname(profileVariableFullPath) === '.json') {
+            profileVariables = JSON.parse(node_fs_1.default.readFileSync(profileVariableFullPath, 'utf-8'));
+        }
+    }
     return {
         extensionRoot,
         extensionDist,
         entrypoint,
         spinner,
+        profileVariables,
     };
 }
 function execAsync(command, options) {

package/dist/lib/build.d.ts

@@ -1,4 +1,5 @@
 import { InlineConfig } from 'vite';
+import { ManifestConfig } from './types';
 interface BuildSingleExtensionArgs {
     file: string;
     outputDir?: string;
@@ -6,9 +7,17 @@ interface BuildSingleExtensionArgs {
     minify?: boolean;
     root?: string;
     logLevel?: InlineConfig['logLevel'];
+    appConfig?: ManifestConfig;
+}
+interface RemoteBuildArgs {
+    root: string;
+    entryPoint: string;
+    outputDir?: string;
+    logLevel?: BuildSingleExtensionArgs['logLevel'];
+    appConfig?: ManifestConfig;
 }
 export declare const extensionErrorBaseMessage: string;
 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>;
+logLevel, appConfig, }: BuildSingleExtensionArgs): Promise<void>;
+export declare function remoteBuild(args: RemoteBuildArgs): Promise<void>;
 export {};

package/dist/lib/build.js

@@ -23,7 +23,7 @@ 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', }) {
+logLevel = 'info', appConfig, }) {
     return __awaiter(this, void 0, void 0, function* () {
         const output = (0, utils_1.getUrlSafeFileName)(file);
         yield (0, vite_1.build)({
@@ -40,7 +40,12 @@ logLevel = 'info', }) {
                     fileName: () => output,
                 },
                 rollupOptions: Object.assign(Object.assign({}, constants_1.ROLLUP_OPTIONS), { plugins: [
-                        (0, manifestPlugin_1.default)({ output, extensionPath: root, logger: console }),
+                        (0, manifestPlugin_1.default)({
+                            output,
+                            extensionPath: root,
+                            logger: console,
+                            manifestConfig: appConfig,
+                        }),
                         (0, friendlyLoggingPlugin_1.default)({ logger: console }),
                         (0, codeBlockingPlugin_1.default)({ logger: console, extensionPath: root }),
                     ] }),
@@ -52,8 +57,17 @@ logLevel = 'info', }) {
     });
 }
 exports.buildSingleExtension = buildSingleExtension;
-function remoteBuild(root, entryPoint, outputDir = constants_1.OUTPUT_DIR, logLevel) {
+function remoteBuild(args) {
     return __awaiter(this, void 0, void 0, function* () {
+        const { root, entryPoint, outputDir = constants_1.OUTPUT_DIR, logLevel, appConfig, } = args;
+        if (!root) {
+            console.error('remoteBuild Error: root is required');
+            return;
+        }
+        if (!entryPoint) {
+            console.error('remoteBuild Error: entryPoint is required');
+            return;
+        }
         const fileInfo = path_1.default.parse(entryPoint);
         if (!allowedExtensions.includes(fileInfo.ext)) {
             throw new Error(`${exports.extensionErrorBaseMessage} ${fileInfo.ext}`);
@@ -64,6 +78,7 @@ function remoteBuild(root, entryPoint, outputDir = constants_1.OUTPUT_DIR, logLe
             minify: true,
             root,
             logLevel,
+            appConfig,
         });
     });
 }

package/dist/lib/constants.d.ts

@@ -29,5 +29,6 @@ export declare const PUBLIC_APP = "public-app";
 export declare const PRIVATE_APP = "private-app";
 export declare const CARD_EXTENSION = "CARD";
 export declare const SETTINGS_EXTENSION = "SETTINGS";
+export declare const PAGE_EXTENSION = "PAGE";
 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_EXTENSION_TYPES = exports.SUPPORTED_APP_TYPES = exports.SETTINGS_EXTENSION = 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.SUPPORTED_EXTENSION_TYPES = exports.SUPPORTED_APP_TYPES = exports.PAGE_EXTENSION = exports.SETTINGS_EXTENSION = 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';
@@ -41,5 +41,10 @@ exports.PUBLIC_APP = 'public-app';
 exports.PRIVATE_APP = 'private-app';
 exports.CARD_EXTENSION = 'CARD';
 exports.SETTINGS_EXTENSION = 'SETTINGS';
+exports.PAGE_EXTENSION = 'PAGE';
 exports.SUPPORTED_APP_TYPES = [exports.PUBLIC_APP, exports.PRIVATE_APP];
-exports.SUPPORTED_EXTENSION_TYPES = [exports.CARD_EXTENSION, exports.SETTINGS_EXTENSION];
+exports.SUPPORTED_EXTENSION_TYPES = [
+    exports.CARD_EXTENSION,
+    exports.SETTINGS_EXTENSION,
+    exports.PAGE_EXTENSION,
+];

package/dist/lib/plugins/devBuildPlugin.js

@@ -49,6 +49,14 @@ const codeBlockingPlugin_1 = __importDefault(require("./codeBlockingPlugin"));
 function addVersionToBaseMessage(baseMessage) {
     return Object.assign(Object.assign({}, baseMessage), { version: constants_1.WEBSOCKET_MESSAGE_VERSION });
 }
+function isValidVariablesRecord(obj) {
+    if (!obj || typeof obj !== 'object')
+        return false;
+    return Object.entries(obj).every(([key, value]) => typeof key === 'string' &&
+        (typeof value === 'string' ||
+            typeof value === 'number' ||
+            typeof value === 'boolean'));
+}
 const devBuildPlugin = (options) => {
     const { devServerState } = options;
     const { logger } = devServerState;
@@ -72,6 +80,14 @@ const devBuildPlugin = (options) => {
         try {
             const { config: extensionConfig } = extensionMetadata;
             const { extensionPath } = extensionConfig;
+            let manifestConfig = {};
+            if (devServerState.appConfig &&
+                'variables' in devServerState.appConfig &&
+                isValidVariablesRecord(devServerState.appConfig.variables)) {
+                manifestConfig = {
+                    variables: devServerState.appConfig.variables,
+                };
+            }
             yield (0, vite_1.build)({
                 logLevel: 'warn',
                 mode: 'development',
@@ -98,6 +114,7 @@ const devBuildPlugin = (options) => {
                                 output: extensionConfig.output,
                                 extensionPath,
                                 logger,
+                                manifestConfig,
                             }),
                             (0, codeCheckingPlugin_1.default)({
                                 output: path_1.default.join(devServerState.outputDir, extensionConfig.output),

package/dist/lib/plugins/manifestPlugin.d.ts

@@ -1,10 +1,11 @@
 import { Rollup } from 'vite';
-import { Logger } from '../types';
+import { Logger, ManifestConfig } from '../types';
 export interface ManifestPluginOptions {
     output: string;
     minify?: boolean;
     extensionPath?: string;
     logger: Logger;
+    manifestConfig?: ManifestConfig;
 }
 export type ManifestPlugin = (options: ManifestPluginOptions) => Rollup.Plugin;
 declare const manifestPlugin: ManifestPlugin;

package/dist/lib/plugins/manifestPlugin.js

@@ -47,7 +47,7 @@ const manifestPlugin = (options) => {
             const { output, minify = false, extensionPath = process.cwd(), logger, } = options;
             try {
                 const filename = path_2.default.parse(output).name;
-                const manifest = _generateManifestContents(bundle, extensionPath, allDataDependencies);
+                const manifest = _generateManifestContents(bundle, extensionPath, allDataDependencies, options === null || options === void 0 ? void 0 : options.manifestConfig);
                 this.emitFile({
                     type: 'asset',
                     source: minify
@@ -62,22 +62,31 @@ const manifestPlugin = (options) => {
         },
     };
 };
-function _generateManifestContents(bundle, extensionPath, allDataDependencies) {
+function _generateManifestContents(bundle, extensionPath, allDataDependencies, appConfig) {
     const baseManifest = {
         package: _loadPackageFile(extensionPath),
     };
     const dataDependencies = {
         dataDeps: allDataDependencies !== null && allDataDependencies !== void 0 ? allDataDependencies : [],
     };
+    const variables = {
+        variables: {},
+    };
+    if (appConfig &&
+        'variables' in appConfig &&
+        typeof appConfig.variables === 'object' &&
+        appConfig.variables !== null) {
+        variables.variables = appConfig.variables;
+    }
     // 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]], extensionPath)), dataDependencies), baseManifest);
+        return Object.assign(Object.assign(Object.assign(Object.assign({}, _generateManifestEntry(bundle[bundles[0]], extensionPath)), dataDependencies), baseManifest), variables);
     }
     const manifest = bundles.reduce((acc, current) => {
         return Object.assign(Object.assign({}, acc), { [current]: _generateManifestEntry(bundle[current], extensionPath) });
     }, {});
-    return Object.assign(Object.assign(Object.assign({}, manifest), dataDependencies), baseManifest);
+    return Object.assign(Object.assign(Object.assign(Object.assign({}, manifest), dataDependencies), baseManifest), variables);
 }
 function _generateManifestEntry(subBundle, extensionPath) {
     const { facadeModuleId, moduleIds, modules } = subBundle;

package/dist/lib/types.d.ts

@@ -130,10 +130,11 @@ export type UnifiedCardConfig = {
 export declare enum UnifiedComponentTypes {
     CARD = "CARD",
     APPLICATION = "APPLICATION",
-    SETTINGS = "SETTINGS"
+    SETTINGS = "SETTINGS",
+    PAGE = "PAGE"
 }
 export type UnifiedExtensionComponent = Omit<UnifiedCardConfig, 'type'> & {
-    componentType: UnifiedComponentTypes.CARD | UnifiedComponentTypes.SETTINGS;
+    componentType: UnifiedComponentTypes.CARD | UnifiedComponentTypes.SETTINGS | UnifiedComponentTypes.PAGE;
     componentDeps: {
         app: string;
     };
@@ -162,6 +163,9 @@ export interface UnifiedAppComponent {
             supportUrl: string;
             supportPhone: string;
         };
+        variables?: {
+            [key: string]: string | number | boolean;
+        };
     };
     componentType: UnifiedComponentTypes.APPLICATION;
     componentDeps: {};
@@ -175,6 +179,9 @@ export interface UnifiedAppComponent {
 export type UnifiedAppConfig = Omit<PublicAppConfig, 'auth'> & {
     auth: UnifiedAppAuth;
     isPublicApp: boolean;
+    variables?: {
+        [key: string]: string | number | boolean;
+    };
 };
 export type UnifiedComponent = UnifiedExtensionComponent | UnifiedAppComponent;
 export interface UnifiedProjectComponentMap {
@@ -273,5 +280,11 @@ export interface DevModeSetupArguments extends DevModeBaseSetupArguments {
 }
 export interface UnifiedDevModeSetupArguments extends DevModeBaseSetupArguments {
     components: UnifiedProjectComponentMap;
+    profileData?: ProfileVariables;
+}
+export type ProfileVariableValue = string | number | boolean;
+export type ProfileVariables = Record<string, ProfileVariableValue>;
+export interface ManifestConfig {
+    variables?: ProfileVariables;
 }
 export {};

package/dist/lib/types.js

@@ -11,4 +11,5 @@ var UnifiedComponentTypes;
     UnifiedComponentTypes["CARD"] = "CARD";
     UnifiedComponentTypes["APPLICATION"] = "APPLICATION";
     UnifiedComponentTypes["SETTINGS"] = "SETTINGS";
+    UnifiedComponentTypes["PAGE"] = "PAGE";
 })(UnifiedComponentTypes || (exports.UnifiedComponentTypes = UnifiedComponentTypes = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/ui-extensions-dev-server",
-  "version": "0.9.5",
+  "version": "0.10.0",
   "description": "",
   "bin": {
     "uie": "./dist/lib/bin/cli.js"
@@ -27,7 +27,7 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@hubspot/app-functions-dev-server": "0.9.2",
+    "@hubspot/app-functions-dev-server": "0.10.0",
     "body-parser": "1.20.3",
     "chalk": "5.4.1",
     "commander": "13.0.0",
@@ -70,5 +70,5 @@
       "optional": true
     }
   },
-  "gitHead": "8344193a13ab5874924b02d67413dad052558ecf"
+  "gitHead": "34ce86d7cfaa1f163bf67838bbb56c054d0f72cc"
 }