@hubspot/ui-extensions-dev-server 0.8.30 → 0.8.33

package/dist/lib/DevModeInterface.d.ts

@@ -1,4 +1,4 @@
-import { ExtensionConfig, Logger, PlatformVersion, ProjectComponentMap, ProjectConfig } from './types';
+import { ExtensionOutputConfig, Logger, PlatformVersion, ProjectComponentMap, ProjectConfig } from './types';
 import { PromptModule } from 'inquirer';
 import { DevServerState } from './DevServerState';
 interface SetupArguments {
@@ -24,10 +24,10 @@ interface StartArguments {
 }
 interface AppExtensionMapping {
     name: string;
-    value: ExtensionConfig;
+    value: ExtensionOutputConfig;
 }
 declare class DevModeInterface {
-    configs?: ExtensionConfig[];
+    configs?: ExtensionOutputConfig[];
     devServerState?: DevServerState;
     onUploadRequired?: VoidFunction;
     shutdown?: () => Promise<void>;

package/dist/lib/DevServerState.d.ts

@@ -1,9 +1,9 @@
-import { AppConfig, ExtensionConfig, ExtensionMetadata, Logger, PlatformVersion } from './types';
+import { AppConfig, ExtensionOutputConfig, ExtensionMetadata, Logger, PlatformVersion } from './types';
 import { ServiceConfiguration, ProxyServiceConfig } from '@hubspot/app-functions-dev-server';
 type DevServerStateLocalDevUrlMapping = ProxyServiceConfig['localDevUrlMapping'] | undefined;
 interface DevServerStateArgs {
     localDevUrlMapping?: DevServerStateLocalDevUrlMapping;
-    extensionConfigs?: ExtensionConfig[];
+    extensionConfigs?: ExtensionOutputConfig[];
     accountId: number | undefined;
     expressPort: number;
     webSocketPort: number;

package/dist/lib/config.d.ts

@@ -1,5 +1,6 @@
 import { AppConfig, ExtensionConfigMap, LocalAppConfig, Logger } from './types';
 export declare function loadConfigByPath<T = unknown>(configPath: string): T;
+export declare function validateCardConfig(config?: unknown): Error | true;
 export declare function loadExtensionConfig(appConfig: AppConfig, appPath: string): ExtensionConfigMap;
 export declare function validateProxyConfigKey(urlKey: string, logger: Logger, localConfigPath: string): void;
 export declare function validateProxyConfigValue(value: string, key: string, logger: Logger, localConfigPath: string): void;

package/dist/lib/config.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadLocalConfig = exports.validateProxyConfigValue = exports.validateProxyConfigKey = exports.loadExtensionConfig = exports.loadConfigByPath = void 0;
+exports.loadLocalConfig = exports.validateProxyConfigValue = exports.validateProxyConfigKey = exports.loadExtensionConfig = exports.validateCardConfig = exports.loadConfigByPath = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const utils_1 = require("./utils");
@@ -14,6 +14,43 @@ function loadConfigByPath(configPath) {
     return JSON.parse(source);
 }
 exports.loadConfigByPath = loadConfigByPath;
+function validateCardConfig(config) {
+    if (!config || typeof config !== 'object') {
+        return new Error('Card config must be an object');
+    }
+    if (!('type' in config) || config.type !== 'crm-card') {
+        return new Error('`type` must be "crm-card"');
+    }
+    if (!('data' in config) ||
+        typeof config.data !== 'object' ||
+        config.data === null) {
+        return new Error('`data` must be an object');
+    }
+    const { data } = config;
+    if (!('title' in data) || typeof data.title !== 'string') {
+        return new Error('`data` must have a `title` string');
+    }
+    if (!('location' in data) || typeof data.location !== 'string') {
+        return new Error('`data` must have a `location` string');
+    }
+    if (!('module' in data) ||
+        typeof data.module !== 'object' ||
+        data.module === null) {
+        return new Error('`data` must have a `module` object');
+    }
+    if (!('file' in data.module) || typeof data.module.file !== 'string') {
+        return new Error('`data.module` must have a `file` string');
+    }
+    if (!('objectTypes' in data) || !Array.isArray(data.objectTypes)) {
+        return new Error('`data.module` must have an `objectTypes` array');
+    }
+    if (data.objectTypes.length === 0 ||
+        data.objectTypes.some(({ name }) => typeof name !== 'string')) {
+        return new Error('all `data.module.objectTypes` objects must have `name` strings');
+    }
+    return true;
+}
+exports.validateCardConfig = validateCardConfig;
 function loadExtensionConfig(appConfig, appPath) {
     var _a, _b;
     const crmCardsSubConfigFiles = (_b = (_a = appConfig === null || appConfig === void 0 ? void 0 : appConfig.extensions) === null || _a === void 0 ? void 0 : _a.crm) === null || _b === void 0 ? void 0 : _b.cards;
@@ -26,6 +63,10 @@ function loadExtensionConfig(appConfig, appPath) {
         const cardConfigPath = path_1.default.join(appPath, card.file);
         try {
             const cardConfig = loadConfigByPath(cardConfigPath);
+            const validation = validateCardConfig(cardConfig);
+            if (validation !== true) {
+                console.error(`[DevServer] Extension config ${cardConfigPath} is invalid: ${validation.message}`);
+            }
             if (cardConfig && cardConfig.data) {
                 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);

package/dist/lib/types.d.ts

@@ -4,6 +4,18 @@ export interface ObjectTypes {
     name: string;
 }
 export interface ExtensionConfig {
+    type: string;
+    data: {
+        title: string;
+        location: string;
+        module: {
+            file: string;
+        };
+        objectTypes: ObjectTypes[];
+        uid?: string;
+    };
+}
+export interface ExtensionOutputConfig extends ExtensionConfig {
     type: string;
     output: string;
     path: string;
@@ -17,13 +29,13 @@ export interface ExtensionConfig {
             file: string;
         };
         objectTypes: ObjectTypes[];
+        uid?: string;
         sourceId?: string | null;
     };
-    uid?: string;
     appConfig?: AppConfig;
 }
 export interface ExtensionConfigMap {
-    [key: string]: ExtensionConfig;
+    [key: string]: ExtensionOutputConfig;
 }
 interface CardConfig {
     file: string;
@@ -95,7 +107,7 @@ export interface BaseMessage {
 }
 export interface ExtensionMetadata {
     baseMessage: BaseMessage;
-    config: ExtensionConfig;
+    config: ExtensionOutputConfig;
 }
 export type PlatformVersion = (typeof PLATFORM_VERSION)[keyof typeof PLATFORM_VERSION];
 export interface FunctionMetadata {

package/dist/lib/utils.js

@@ -34,8 +34,8 @@ function loadManifest(outputDir, output) {
 }
 exports.loadManifest = loadManifest;
 function buildSourceId(appConfig, extensionConfig) {
-    if (appConfig.uid && extensionConfig.uid) {
-        return `${appConfig.uid}::${extensionConfig.uid}`;
+    if (appConfig.uid && extensionConfig.data.uid) {
+        return `${appConfig.uid}::${extensionConfig.data.uid}`;
     }
     return null;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/ui-extensions-dev-server",
-  "version": "0.8.30",
+  "version": "0.8.33",
   "description": "",
   "scripts": {
     "test": "jest",
@@ -24,7 +24,7 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@hubspot/app-functions-dev-server": "0.8.30",
+    "@hubspot/app-functions-dev-server": "0.8.31",
     "cors": "^2.8.5",
     "detect-port": "1.5.1",
     "estraverse": "^5.3.0",
@@ -63,5 +63,5 @@
       "optional": true
     }
   },
-  "gitHead": "389360d4b4301252237feec1cf0fcf3b01a20f0c"
+  "gitHead": "43946879c6cc1dbd76102fe92f6c1838ea34db6b"
 }