@hubspot/ui-extensions-dev-server 0.8.0 → 0.8.1

package/dist/cli/config.d.ts

@@ -1,9 +1,8 @@
 import { AppConfig, ExtensionConfigMap } from '../lib/types';
-declare function loadConfigByPath(configPath: string): any;
-declare function loadExtensionConfig(appConfig: AppConfig, appPath: string): ExtensionConfigMap;
+export declare function loadConfigByPath<T = unknown>(configPath: string): T;
+export declare function loadExtensionConfig(appConfig: AppConfig, appPath: string): ExtensionConfigMap;
 /**
  * @deprecated Will be removed after integration with hubspot-cli is complete
  * This version of load config makes assumptions about the location it is being ran from where the others do not
  */
-declare function loadConfig(): ExtensionConfigMap;
-export { loadConfigByPath, loadExtensionConfig, loadConfig };
+export declare function loadConfig(): ExtensionConfigMap;

package/dist/cli/config.js

@@ -26,7 +26,8 @@ function loadExtensionConfig(appConfig, appPath) {
                 const cardConfigDir = path_1.default.parse(cardConfigPath).dir;
                 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;
-                outputConfig[entryPointPath] = Object.assign(Object.assign({}, cardConfig), { output: (0, utils_1.getUrlSafeFileName)(entryPointPath), path: appPath, extensionPath: path_1.default.parse(entryPointPath).dir, data: Object.assign(Object.assign({}, cardConfig.data), { appName: appConfig.name }) });
+                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, data: Object.assign(Object.assign({}, cardConfig.data), { appName: appConfig.name, sourceId }) });
             }
         }
         catch (e) {

package/dist/cli/run.js

@@ -22,7 +22,7 @@ const inquirer_1 = __importDefault(require("inquirer"));
 const config_1 = require("./config");
 // eslint-disable-next-line no-floating-promise/no-floating-promise
 (() => __awaiter(void 0, void 0, void 0, function* () {
-    const { DEV_MODE, BUILD_MODE, extension, help, force } = (0, utils_1.parseArgs)();
+    const { DEV_MODE, BUILD_MODE, extension, location, help, force, account, } = (0, utils_1.parseArgs)();
     if (!force) {
         console.warn((0, console_log_colors_1.yellow)(`"hs-ui-extensions-dev-server" is deprecated, please use "hs project dev" for local development.
         \nSee our Getting Started guide for detailed instructions: https://app.hubspot.com/l/docs/doc/platform/create-a-project-for-ui-extensions\n`));
@@ -38,8 +38,20 @@ const config_1 = require("./config");
         let extensionConfig;
         if (extension) {
             const allExtensionsConfig = (0, config_1.loadExtensionConfig)(appConfig, appPath);
-            extensionConfig =
-                allExtensionsConfig[path_1.default.join(extensionPath, extension)];
+            const matchingConfigs = Object.values(allExtensionsConfig).filter(config => {
+                const entrypoint = path_1.default.parse(config.data.module.file).base;
+                return entrypoint === path_1.default.join(extension);
+            });
+            if (matchingConfigs.length === 1) {
+                extensionConfig = matchingConfigs[0];
+            }
+            else if (matchingConfigs.length > 1 && location) {
+                // We need to do some tie breaking
+                const filteredByLocation = matchingConfigs.filter(config => config.data.location === location);
+                if (filteredByLocation.length === 1) {
+                    extensionConfig = filteredByLocation[0];
+                }
+            }
         }
         yield index_1.DevModeInterface.setup({
             promptUser: inquirer_1.default.createPromptModule(),
@@ -51,7 +63,9 @@ const config_1 = require("./config");
             },
             extensionConfig,
         });
-        yield index_1.DevModeInterface.start({});
+        yield index_1.DevModeInterface.start({
+            accountId: account,
+        });
     }
     else if (BUILD_MODE) {
         if (extension) {

package/dist/cli/utils.js

@@ -21,8 +21,10 @@ function parseArgs() {
     const optionDefinitions = [
         { name: 'port', alias: 'p', type: Number },
         { name: 'extension', alias: 'e', type: String },
+        { name: 'location', alias: 'l', type: String },
         { name: 'help', alias: 'h', type: Boolean },
         { name: 'force', alias: 'f', type: Boolean },
+        { name: 'account', alias: 'a', type: Number },
     ];
     const options = (0, command_line_args_1.default)(optionDefinitions, DEV_MODE || BUILD_MODE ? { argv } : {});
     return Object.assign({ DEV_MODE, BUILD_MODE }, options);
@@ -50,6 +52,18 @@ function showHelp(OUTPUT_DIR) {
                     typeLabel: '{underline file}',
                     description: 'The extension entrypoint file to build or start local development for',
                 },
+                {
+                    name: 'location',
+                    alias: 'l',
+                    typeLabel: '{underline string}',
+                    description: 'The the location of the extension to run, this is only needed if two extensions use the same entrypoint file and do not have uids',
+                },
+                {
+                    name: 'account',
+                    alias: 'a',
+                    typeLabel: '{underline number}',
+                    description: 'The accountId you would like to use to run the extension',
+                },
                 {
                     name: 'help',
                     alias: 'h',

package/dist/index.js

@@ -1,6 +1,4 @@
 "use strict";
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-nocheck We aren't ready to type check these files yet
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };

package/dist/lib/DevModeInterface.js

@@ -36,10 +36,10 @@ class DevModeInterface {
             this.cardConfigs = component.config.extensions.crm.cards.map(card => path_1.default.join(component.path, card.file));
             // Load all of the extension configs for a particular app.json file
             const extensionsConfigForApp = (0, config_1.loadExtensionConfig)(component.config, component.path);
-            const extensionFilePaths = Object.keys(extensionsConfigForApp);
+            const extensionConfigKeys = Object.keys(extensionsConfigForApp);
             // Loop over the loaded extension configs and generate the list of choices to use to prompt the user for input
-            extensionFilePaths.forEach(extensionPath => {
-                const extensionConfig = extensionsConfigForApp[extensionPath];
+            extensionConfigKeys.forEach(extensionKey => {
+                const extensionConfig = extensionsConfigForApp[extensionKey];
                 appExtensionMappings.push({
                     name: `${componentName}/${extensionConfig.data.title}`,
                     value: extensionConfig,

package/dist/lib/build.d.ts

@@ -1,14 +1,14 @@
-interface BuildSingleExtenstionArgs {
+interface BuildSingleExtensionArgs {
     file: string;
     outputDir?: string;
     emptyOutDir?: boolean;
     minify?: boolean;
     root?: string;
 }
-declare const extensionErrorBaseMessage: string;
-declare function buildAllExtensions({ outputDir }: {
+export declare const extensionErrorBaseMessage: string;
+export declare function buildAllExtensions({ outputDir }: {
     outputDir: string;
 }): Promise<void>;
-declare function buildSingleExtension({ file, outputDir, emptyOutDir, minify, root, }: BuildSingleExtenstionArgs): Promise<void>;
-declare function remoteBuild(root: string, entryPoint: string, outputDir?: string): Promise<void>;
-export { buildAllExtensions, buildSingleExtension, remoteBuild, extensionErrorBaseMessage, };
+export declare function buildSingleExtension({ file, outputDir, emptyOutDir, minify, root, }: BuildSingleExtensionArgs): Promise<void>;
+export declare function remoteBuild(root: string, entryPoint: string, outputDir?: string): Promise<void>;
+export {};

package/dist/lib/build.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extensionErrorBaseMessage = exports.remoteBuild = exports.buildSingleExtension = exports.buildAllExtensions = void 0;
+exports.remoteBuild = exports.buildSingleExtension = exports.buildAllExtensions = exports.extensionErrorBaseMessage = void 0;
 const vite_1 = require("vite");
 const constants_1 = require("./constants");
 const manifestPlugin_1 = __importDefault(require("./plugins/manifestPlugin"));
@@ -21,8 +21,7 @@ const utils_1 = require("./utils");
 const config_1 = require("../cli/config");
 const codeInjectionPlugin_1 = __importDefault(require("./plugins/codeInjectionPlugin"));
 const allowedExtensions = ['.js', '.ts', '.tsx', '.jsx'];
-const extensionErrorBaseMessage = `Supported file extensions are [${allowedExtensions.join(', ')}], received:`;
-exports.extensionErrorBaseMessage = extensionErrorBaseMessage;
+exports.extensionErrorBaseMessage = `Supported file extensions are [${allowedExtensions.join(', ')}], received:`;
 function buildAllExtensions({ outputDir }) {
     return __awaiter(this, void 0, void 0, function* () {
         const config = (0, config_1.loadConfig)();
@@ -54,7 +53,10 @@ function buildSingleExtension({ file, outputDir = constants_1.OUTPUT_DIR, emptyO
                     formats: ['iife'],
                     fileName: () => output,
                 },
-                rollupOptions: Object.assign(Object.assign({}, constants_1.ROLLUP_OPTIONS), { plugins: [(0, manifestPlugin_1.default)({ output }), (0, codeInjectionPlugin_1.default)({ file })] }),
+                rollupOptions: Object.assign(Object.assign({}, constants_1.ROLLUP_OPTIONS), { plugins: [
+                        (0, manifestPlugin_1.default)({ output, extensionPath: root }),
+                        (0, codeInjectionPlugin_1.default)({ file }),
+                    ] }),
                 outDir: outputDir,
                 emptyOutDir,
                 minify,
@@ -67,7 +69,7 @@ function remoteBuild(root, entryPoint, outputDir = constants_1.OUTPUT_DIR) {
     return __awaiter(this, void 0, void 0, function* () {
         const fileInfo = path_1.default.parse(entryPoint);
         if (!allowedExtensions.includes(fileInfo.ext)) {
-            throw new Error(`${extensionErrorBaseMessage} ${fileInfo.ext}`);
+            throw new Error(`${exports.extensionErrorBaseMessage} ${fileInfo.ext}`);
         }
         yield buildSingleExtension({
             file: entryPoint,

package/dist/lib/constants.d.ts

@@ -1,9 +1,9 @@
-declare const OUTPUT_DIR = "dist";
-declare const MAIN_APP_CONFIG = "app.json";
-declare const MANIFEST_FILE = "manifest.json";
-declare const VITE_DEFAULT_PORT = 5173;
-declare const WEBSOCKET_PORT = 5174;
-declare const ROLLUP_OPTIONS: {
+export declare const OUTPUT_DIR = "dist";
+export declare const MAIN_APP_CONFIG = "app.json";
+export declare const MANIFEST_FILE = "manifest.json";
+export declare const VITE_DEFAULT_PORT = 5173;
+export declare const WEBSOCKET_PORT = 5174;
+export declare const ROLLUP_OPTIONS: {
     external: string[];
     output: {
         globals: {
@@ -13,7 +13,6 @@ declare const ROLLUP_OPTIONS: {
         extend: boolean;
     };
 };
-declare const EXTENSIONS_MESSAGE_VERSION = 1;
-declare const WEBSOCKET_MESSAGE_VERSION = 0;
-declare const SERVER_CAPABILITIES: string[];
-export { ROLLUP_OPTIONS, OUTPUT_DIR, MAIN_APP_CONFIG, MANIFEST_FILE, EXTENSIONS_MESSAGE_VERSION, VITE_DEFAULT_PORT, WEBSOCKET_MESSAGE_VERSION, WEBSOCKET_PORT, SERVER_CAPABILITIES, };
+export declare const EXTENSIONS_MESSAGE_VERSION = 2;
+export declare const WEBSOCKET_MESSAGE_VERSION = 1;
+export declare const SERVER_CAPABILITIES: string[];

package/dist/lib/constants.js

@@ -1,17 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SERVER_CAPABILITIES = exports.WEBSOCKET_PORT = exports.WEBSOCKET_MESSAGE_VERSION = exports.VITE_DEFAULT_PORT = exports.EXTENSIONS_MESSAGE_VERSION = exports.MANIFEST_FILE = exports.MAIN_APP_CONFIG = exports.OUTPUT_DIR = exports.ROLLUP_OPTIONS = void 0;
-const OUTPUT_DIR = 'dist';
-exports.OUTPUT_DIR = OUTPUT_DIR;
-const MAIN_APP_CONFIG = 'app.json';
-exports.MAIN_APP_CONFIG = MAIN_APP_CONFIG;
-const MANIFEST_FILE = 'manifest.json';
-exports.MANIFEST_FILE = MANIFEST_FILE;
-const VITE_DEFAULT_PORT = 5173;
-exports.VITE_DEFAULT_PORT = VITE_DEFAULT_PORT;
-const WEBSOCKET_PORT = 5174;
-exports.WEBSOCKET_PORT = WEBSOCKET_PORT;
-const ROLLUP_OPTIONS = {
+exports.SERVER_CAPABILITIES = exports.WEBSOCKET_MESSAGE_VERSION = exports.EXTENSIONS_MESSAGE_VERSION = exports.ROLLUP_OPTIONS = exports.WEBSOCKET_PORT = exports.VITE_DEFAULT_PORT = exports.MANIFEST_FILE = exports.MAIN_APP_CONFIG = exports.OUTPUT_DIR = void 0;
+exports.OUTPUT_DIR = 'dist';
+exports.MAIN_APP_CONFIG = 'app.json';
+exports.MANIFEST_FILE = 'manifest.json';
+exports.VITE_DEFAULT_PORT = 5173;
+exports.WEBSOCKET_PORT = 5174;
+exports.ROLLUP_OPTIONS = {
     // Deps to exclude from the bundle
     external: ['react', 'react-dom', '@remote-ui/react'],
     output: {
@@ -23,13 +18,11 @@ const ROLLUP_OPTIONS = {
         extend: true,
     },
 };
-exports.ROLLUP_OPTIONS = ROLLUP_OPTIONS;
-const EXTENSIONS_MESSAGE_VERSION = 1;
-exports.EXTENSIONS_MESSAGE_VERSION = EXTENSIONS_MESSAGE_VERSION;
-const WEBSOCKET_MESSAGE_VERSION = 0;
-exports.WEBSOCKET_MESSAGE_VERSION = WEBSOCKET_MESSAGE_VERSION;
-const SERVER_CAPABILITIES = [
+exports.EXTENSIONS_MESSAGE_VERSION = 2;
+exports.WEBSOCKET_MESSAGE_VERSION = 1;
+exports.SERVER_CAPABILITIES = [
     // Supports running app functions locally
     'app-functions-local-dev',
+    'source-id',
+    'account-id',
 ];
-exports.SERVER_CAPABILITIES = SERVER_CAPABILITIES;

package/dist/lib/dev.d.ts

@@ -9,5 +9,5 @@ interface StartDevModeArgs {
     functionsConfig: Partial<ServiceConfiguration>;
     cardConfigs: string[];
 }
-declare function startDevMode({ extensionConfig, functionsConfig, outputDir, expressPort, webSocketPort, root, cardConfigs, }: StartDevModeArgs): Promise<() => Promise<void>>;
-export { startDevMode };
+export declare function startDevMode({ extensionConfig, functionsConfig, outputDir, expressPort, webSocketPort, root, cardConfigs, }: StartDevModeArgs): Promise<() => Promise<void>>;
+export {};

package/dist/lib/dev.js

@@ -82,10 +82,13 @@ function startDevMode({ extensionConfig, functionsConfig, outputDir = constants_
         if (actualWebSocketPort !== webSocketPort) {
             logger_1.logger.debug(`WebSocket port ${webSocketPort} is in use; using next available port ${actualWebSocketPort}`);
         }
+        const { appName, title, sourceId } = extensionConfig.data;
         const baseMessage = Object.freeze({
-            appName: extensionConfig.data.appName,
-            title: extensionConfig.data.title,
+            appName,
+            title,
+            sourceId,
             callback: `http://hslocal.net:${expressPort}/${extensionConfig.output}`,
+            portalId: functionsConfig.accountId,
         });
         const viteDevServer = yield _createViteDevServer({
             outputDir,

package/dist/lib/extensionsService.js

@@ -22,6 +22,7 @@ class ExtensionsService {
                     websocket: `ws://localhost:${webSocketPort}`,
                     version: constants_1.EXTENSIONS_MESSAGE_VERSION,
                     capabilities,
+                    portalId: baseMessage.portalId,
                     extensions: [
                         Object.assign(Object.assign({}, baseMessage), { manifest: (0, utils_1.loadManifest)(outputDir, output) }),
                     ],

package/dist/lib/plugins/devBuildPlugin.js

@@ -66,6 +66,7 @@ const devBuildPlugin = options => {
                             (0, manifestPlugin_1.default)({
                                 minify: false,
                                 output: extensionConfig.output,
+                                extensionPath: extensionConfig.extensionPath,
                             }),
                             (0, codeCheckingPlugin_1.default)({
                                 output: path_1.default.join(outputDir, extensionConfig.output),

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

@@ -2,6 +2,7 @@ import { Rollup } from 'vite';
 export interface ManifestPluginOptions {
     output: string;
     minify?: boolean;
+    extensionPath?: string;
 }
 export type ManifestPlugin = (options: ManifestPluginOptions) => Rollup.Plugin;
 declare const manifestPlugin: ManifestPlugin;

package/dist/lib/plugins/manifestPlugin.js

@@ -17,10 +17,10 @@ const manifestPlugin = options => {
         name: 'ui-extensions-manifest-generation-plugin',
         enforce: 'post',
         generateBundle(_rollupOptions, bundle) {
-            const { output, minify = false } = options;
+            const { output, minify = false, extensionPath = process.cwd() } = options;
             try {
                 const filename = path_2.default.parse(output).name;
-                const manifest = _generateManifestContents(bundle);
+                const manifest = _generateManifestContents(bundle, extensionPath);
                 this.emitFile({
                     type: 'asset',
                     source: minify
@@ -35,9 +35,9 @@ const manifestPlugin = options => {
         },
     };
 };
-function _generateManifestContents(bundle) {
+function _generateManifestContents(bundle, extensionPath) {
     const baseManifest = {
-        package: _loadPackageFile(),
+        package: _loadPackageFile(extensionPath),
     };
     // The keys to bundle are the filename without any path information
     const bundles = Object.keys(bundle).filter(cur => cur.endsWith('.js'));
@@ -56,17 +56,18 @@ function _generateManifestEntry(subBundle) {
         modules: _buildModulesInfo(moduleIds, modules),
     };
 }
-function _loadJsonFileSafely(filename) {
+function _loadJsonFileSafely(extensionPath, filename) {
     try {
-        return JSON.parse((0, fs_1.readFileSync)(filename).toString());
+        return JSON.parse((0, fs_1.readFileSync)(path_2.default.join(extensionPath, filename)).toString());
     }
     catch (e) {
         return undefined;
     }
 }
-function _loadPackageFile() {
+function _loadPackageFile(extensionPath) {
     // Look for package-lock.json then fallback to package.json
-    return (_loadJsonFileSafely(PACKAGE_LOCK_FILE) || _loadJsonFileSafely(PACKAGE_FILE));
+    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();

package/dist/lib/types.d.ts

@@ -14,7 +14,9 @@ export interface ExtensionConfig {
             file: string;
         };
         objectTypes: ObjectTypes[];
+        sourceId?: string | null;
     };
+    uid?: string;
 }
 export interface ExtensionConfigMap {
     [key: string]: ExtensionConfig;
@@ -32,6 +34,7 @@ export interface AppConfig {
             cards: CardConfig[];
         };
     };
+    uid?: string;
 }
 export interface ProjectComponent {
     config: AppConfig;
@@ -44,5 +47,7 @@ export interface BaseMessage {
     appName: string;
     title: string;
     callback: string;
+    sourceId?: string | null;
+    portalId?: number;
 }
 export {};

package/dist/lib/utils.d.ts

@@ -1,4 +1,5 @@
-declare function getUrlSafeFileName(filePath: string): string;
-declare function stripAnsiColorCodes(stringWithColorCodes: string | undefined): string | null;
-declare function loadManifest(outputDir: string, output: string): any;
-export { getUrlSafeFileName, stripAnsiColorCodes, loadManifest };
+import { AppConfig, ExtensionConfig } from './types';
+export declare function getUrlSafeFileName(filePath: string): string;
+export declare function stripAnsiColorCodes(stringWithColorCodes: string | undefined | null): string | null;
+export declare function loadManifest(outputDir: string, output: string): any;
+export declare function buildSourceId(appConfig: AppConfig, extensionConfig: ExtensionConfig): string | null;

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.loadManifest = exports.stripAnsiColorCodes = exports.getUrlSafeFileName = void 0;
+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");
@@ -33,3 +33,10 @@ function loadManifest(outputDir, output) {
     }
 }
 exports.loadManifest = loadManifest;
+function buildSourceId(appConfig, extensionConfig) {
+    if (appConfig.uid && extensionConfig.uid) {
+        return `${appConfig.uid}::${extensionConfig.uid}`;
+    }
+    return null;
+}
+exports.buildSourceId = buildSourceId;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/ui-extensions-dev-server",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "",
   "scripts": {
     "test": "jest",
@@ -66,5 +66,5 @@
       "optional": true
     }
   },
-  "gitHead": "80535f127c717f76d07fca05c9f676ec29ad5d18"
+  "gitHead": "5fd5fe43bc0b09750653dd7121d56bf0d60788bb"
 }