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

package/dist/lib/DevModeInterface.d.ts

@@ -1,9 +1,8 @@
-import type { ExtensionConfig, Logger, PlatformVersion, ProjectComponentMap } from './types';
+import { ExtensionConfig, Logger, PlatformVersion, ProjectComponentMap, ProjectConfig } from './types';
 import { PromptModule } from 'inquirer';
 import { DevServerState } from './DevServerState';
 interface SetupArguments {
     components: ProjectComponentMap;
-    extensionConfig?: ExtensionConfig;
     onUploadRequired?: VoidFunction;
     promptUser: PromptModule;
     logger: Logger;
@@ -12,11 +11,6 @@ interface SetupArguments {
         web: string;
     };
 }
-interface ProjectConfig {
-    name: string;
-    srcDir: string;
-    platformVersion?: PlatformVersion;
-}
 interface StartArguments {
     accountId?: number;
     requestPorts?: (requestPortsData: Array<{
@@ -38,9 +32,11 @@ declare class DevModeInterface {
     shutdown?: () => Promise<void>;
     logger: Logger;
     urls?: SetupArguments['urls'];
+    isConfigured?: boolean;
+    isRunning?: boolean;
     _generateAppExtensionMappings(components: ProjectComponentMap): AppExtensionMapping[];
     _getPlatformVersion(projectConfig?: ProjectConfig): PlatformVersion;
-    setup({ components, extensionConfig, onUploadRequired, promptUser, logger, urls, }: SetupArguments): Promise<void>;
+    setup({ components, onUploadRequired, promptUser, logger, urls, }: SetupArguments): Promise<void>;
     fileChange(filePath: string, __event: unknown): Promise<void>;
     start({ requestPorts, accountId, projectConfig }: StartArguments): Promise<void>;
     cleanup(): Promise<void>;

package/dist/lib/DevModeInterface.js

@@ -39,10 +39,9 @@ class DevModeInterface {
         // Loop over all of the app configs that are passed in
         const allComponentNames = Object.keys(components);
         return allComponentNames.reduce((appExtensionMappings, componentName) => {
-            var _a, _b;
             const component = components[componentName];
-            if (!((_b = (_a = component.config.extensions) === null || _a === void 0 ? void 0 : _a.crm) === null || _b === void 0 ? void 0 : _b.cards)) {
-                return appExtensionMappings; // It's not an app
+            if (!constants_1.SUPPORTED_APP_TYPES.includes(component.type)) {
+                return appExtensionMappings; // It's not a modern app, skip it
             }
             // Load all of the extension configs for a particular app.json file
             const extensionsConfigForApp = (0, config_1.loadExtensionConfig)(component.config, component.path);
@@ -72,15 +71,16 @@ class DevModeInterface {
                 return (0, utils_1.throwUnhandledPlatformVersionError)(platformVersion);
         }
     }
-    setup({ components, extensionConfig, onUploadRequired, promptUser, logger, urls, }) {
+    setup({ components, onUploadRequired, promptUser, logger, urls, }) {
         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;
-            if (extensionConfig) {
-                this.configs = [extensionConfig];
-                return;
-            }
             const choices = this._generateAppExtensionMappings(components);
             if (choices.length === 0) {
                 throw new Error('No extensions to run');
@@ -107,6 +107,7 @@ class DevModeInterface {
                 });
                 this.configs = answers.extensions;
             }
+            this.isConfigured = true;
         });
     }
     // The contract is for this to be async, so eslint can chill
@@ -124,6 +125,14 @@ class DevModeInterface {
     }
     start({ requestPorts, accountId, projectConfig }) {
         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) {
@@ -149,16 +158,19 @@ class DevModeInterface {
                 urls: this.urls,
             });
             this.shutdown = yield (0, dev_1.startDevMode)(this.devServerState);
-            this.devServerState.extensionsMetadata.forEach((metadata) => {
+            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;
         });
     }
     cleanup() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this.shutdown) {
+            if (this.shutdown && this.isRunning) {
                 yield this.shutdown();
+                this.isRunning = false;
             }
         });
     }

package/dist/lib/build.js

@@ -39,7 +39,7 @@ function buildSingleExtension({ file, outputDir = constants_1.OUTPUT_DIR, emptyO
                     fileName: () => output,
                 },
                 rollupOptions: Object.assign(Object.assign({}, constants_1.ROLLUP_OPTIONS), { plugins: [
-                        (0, manifestPlugin_1.default)({ output, extensionPath: root }),
+                        (0, manifestPlugin_1.default)({ output, extensionPath: root, logger: console }),
                         (0, friendlyLoggingPlugin_1.default)({ logger: console }),
                         (0, codeBlockingPlugin_1.default)({ logger: console }),
                     ] }),

package/dist/lib/constants.d.ts

@@ -1,5 +1,4 @@
 export declare const OUTPUT_DIR = "dist";
-export declare const MAIN_APP_CONFIG = "app.json";
 export declare const MANIFEST_FILE = "manifest.json";
 export declare const EXPRESS_SERVER_ID = "ui-extensions-dev-server";
 export declare const VITE_DEV_SERVER_ID = "ui-extensions-vite-dev-server";
@@ -22,3 +21,6 @@ export declare const PLATFORM_VERSION: {
     readonly V20231: "2023.1";
     readonly V20232: "2023.2";
 };
+export declare const PUBLIC_APP = "public-app";
+export declare const PRIVATE_APP = "private-app";
+export declare const SUPPORTED_APP_TYPES: string[];

package/dist/lib/constants.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PLATFORM_VERSION = exports.SERVER_CAPABILITIES = exports.WEBSOCKET_MESSAGE_VERSION = exports.EXTENSIONS_MESSAGE_VERSION = exports.ROLLUP_OPTIONS = exports.WEBSOCKET_DEFAULT_PORT = exports.EXPRESS_DEFAULT_PORT = exports.VITE_DEV_SERVER_ID = exports.EXPRESS_SERVER_ID = exports.MANIFEST_FILE = exports.MAIN_APP_CONFIG = exports.OUTPUT_DIR = void 0;
+exports.SUPPORTED_APP_TYPES = exports.PRIVATE_APP = exports.PUBLIC_APP = exports.PLATFORM_VERSION = exports.SERVER_CAPABILITIES = exports.WEBSOCKET_MESSAGE_VERSION = exports.EXTENSIONS_MESSAGE_VERSION = exports.ROLLUP_OPTIONS = exports.WEBSOCKET_DEFAULT_PORT = exports.EXPRESS_DEFAULT_PORT = exports.VITE_DEV_SERVER_ID = exports.EXPRESS_SERVER_ID = exports.MANIFEST_FILE = exports.OUTPUT_DIR = void 0;
 exports.OUTPUT_DIR = 'dist';
-exports.MAIN_APP_CONFIG = 'app.json';
 exports.MANIFEST_FILE = 'manifest.json';
 exports.EXPRESS_SERVER_ID = 'ui-extensions-dev-server';
 exports.VITE_DEV_SERVER_ID = 'ui-extensions-vite-dev-server';
@@ -32,3 +31,8 @@ exports.PLATFORM_VERSION = {
     V20231: '2023.1',
     V20232: '2023.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.SUPPORTED_APP_TYPES = [exports.PUBLIC_APP, exports.PRIVATE_APP];

package/dist/lib/plugins/devBuildPlugin.js

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

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

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

package/dist/lib/plugins/manifestPlugin.js

@@ -9,8 +9,6 @@ const fs_1 = require("fs");
 const path_1 = require("path");
 const constants_1 = require("../constants");
 const path_2 = __importDefault(require("path"));
-// @ts-expect-error no type defs for the logger
-const logger_1 = require("@hubspot/cli-lib/logger");
 const utils_1 = require("../utils");
 const PACKAGE_LOCK_FILE = 'package-lock.json';
 const PACKAGE_FILE = 'package.json';
@@ -20,7 +18,7 @@ const manifestPlugin = (options) => {
         name: 'ui-extensions-manifest-generation-plugin',
         enforce: 'post',
         generateBundle(_rollupOptions, bundle) {
-            const { output, minify = false, extensionPath = process.cwd() } = options;
+            const { output, minify = false, extensionPath = process.cwd(), logger, } = options;
             try {
                 const filename = path_2.default.parse(output).name;
                 const manifest = _generateManifestContents(bundle, extensionPath);
@@ -33,7 +31,7 @@ const manifestPlugin = (options) => {
                 });
             }
             catch (e) {
-                logger_1.logger.warn(`\nUnable to write manifest file in ${output}, ${e}`);
+                logger.warn(`\nUnable to write manifest file in ${output}, ${e}`);
             }
         },
     };

package/dist/lib/types.d.ts

@@ -1,4 +1,4 @@
-import { PLATFORM_VERSION } from './constants';
+import { PLATFORM_VERSION, PRIVATE_APP, PUBLIC_APP } from './constants';
 export interface ObjectTypes {
     name: string;
 }
@@ -26,7 +26,12 @@ export interface ExtensionConfigMap {
 interface CardConfig {
     file: string;
 }
-export interface AppConfig {
+export interface ProjectConfig {
+    name: string;
+    srcDir: string;
+    platformVersion?: PlatformVersion;
+}
+export interface PrivateAppConfig {
     name: string;
     description: string;
     scopes: string[];
@@ -38,7 +43,35 @@ export interface AppConfig {
     };
     uid?: string;
 }
+export interface PublicAppConfig {
+    name: string;
+    uid: string;
+    logo?: string;
+    description?: string;
+    allowedExternalUrls?: string[];
+    auth?: {
+        preventAdditionalScopes: boolean;
+        preventOptionalScopes: boolean;
+        redirectUrls: string[];
+        requiredScopes: string[];
+        optionalScopes: string[];
+        additionalScopes: string[];
+    };
+    support?: {
+        supportUrl: string;
+        supportEmail: string;
+        documentationUrl: string;
+        supportPhone: string;
+    };
+    extensions: {
+        crm: {
+            cards: CardConfig[];
+        };
+    };
+}
+export type AppConfig = PrivateAppConfig | PublicAppConfig;
 export interface ProjectComponent {
+    type: typeof PUBLIC_APP | typeof PRIVATE_APP;
     config: AppConfig;
     path: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/ui-extensions-dev-server",
-  "version": "0.8.11",
+  "version": "0.8.12",
   "description": "",
   "scripts": {
     "test": "jest",
@@ -10,14 +10,15 @@
     "prepare": "npm run build",
     "lint": "echo 'no lint step for @hubspot/ui-extensions-dev-server'",
     "jest": "jest --watch",
-    "integration-test": "npm run build && npm run integration-test --prefix ./integrationTests/fixtures"
+    "integration-test-private-app": "npm run integration-test-private-app --prefix ./integrationTests/fixtures",
+    "integration-test-public-app": "npm run integration-test-public-app --prefix ./integrationTests/fixtures",
+    "integration-test": "npm run build && npm run integration-test-private-app && npm run integration-test-public-app"
   },
   "publishConfig": {
     "access": "public"
   },
   "exports": {
-    ".": "./dist/index.js",
-    "./self": "./dist/lib/self.js"
+    ".": "./dist/index.js"
   },
   "files": [
     "dist",
@@ -26,10 +27,6 @@
   "license": "MIT",
   "dependencies": {
     "@hubspot/app-functions-dev-server": "^0.8.11",
-    "@hubspot/cli-lib": "^4.1.6",
-    "command-line-args": "^5.2.1",
-    "command-line-usage": "^7.0.1",
-    "console-log-colors": "^0.4.0",
     "cors": "^2.8.5",
     "detect-port": "1.5.1",
     "estraverse": "^5.3.0",
@@ -67,5 +64,5 @@
       "optional": true
     }
   },
-  "gitHead": "67d77644bf3e0748827773954c3c8024699f2717"
+  "gitHead": "de63cea5e941c10de794210c1a095ae2468d6a9d"
 }

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

@@ -1,8 +0,0 @@
-import { Rollup } from 'vite';
-export interface CodeInjectionPluginOptions {
-    file: string;
-    root?: string;
-}
-export type CodeInjectionPlugin = (options: CodeInjectionPluginOptions) => Rollup.Plugin;
-declare const codeInjectionPlugin: CodeInjectionPlugin;
-export default codeInjectionPlugin;

package/dist/lib/plugins/codeInjectionPlugin.js

@@ -1,30 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const codeInjectionPlugin = (options) => {
-    const { file, root = process.cwd() } = options;
-    return {
-        name: 'ui-extensions-code-injection-plugin',
-        enforce: 'post',
-        transform(code, fileBeingTransformed) {
-            const absoluteFilePath = path_1.default.isAbsolute(file)
-                ? file
-                : path_1.default.join(root, file);
-            if (fileBeingTransformed !== absoluteFilePath) {
-                return { code, map: null }; // Not the file we care about, return the same code
-            }
-            // Update the code to import the self script which houses our overrides
-            // This needs to be the first line in the source file so that the overrides get hoisted
-            // to the top of the generated source file
-            const updatedCode = `import "@hubspot/ui-extensions-dev-server/self"; ${code}`;
-            // Return the updated source code.  We don't need to include the new code in the
-            // sourcemap because we don't want it to show up in the users code when they
-            // view the source mapped code in the browser
-            return { code: updatedCode, map: null };
-        },
-    };
-};
-exports.default = codeInjectionPlugin;

package/dist/lib/self.js

@@ -1,4 +0,0 @@
-"use strict";
-/* eslint-disable hubspot-dev/no-confusing-browser-globals */
-// Set methods on the self object to undefined so they are not available within the worker code
-self.importScripts = undefined;