@hubspot/ui-extensions-dev-server 1.1.5 → 1.1.7

package/dist/lib/app-functions/types.d.ts

@@ -0,0 +1,172 @@
+import { PLATFORM_VERSION } from './constants.ts';
+export interface AppFunctionsManifest {
+    runtime: string;
+    version: string;
+    appFunctions: {
+        [name: string]: FunctionDeclaration;
+    };
+}
+interface FunctionDeclaration {
+    /** relative path to the function source file */
+    file: string;
+    /** list of secret names */
+    secrets: string[];
+}
+export interface MultiFunctionInfo {
+    srcDir: string;
+    distDir?: string;
+    appFunctions: {
+        [name: string]: FunctionDeclaration;
+    };
+}
+export interface SingleFunctionInfo {
+    srcDir: string;
+    distDir?: string;
+    /** name of the app function */
+    name: string;
+    /** relative path to the function source file */
+    file: string;
+    /** list of secret names */
+    secrets: string[];
+}
+export type PlatformVersion = (typeof PLATFORM_VERSION)[keyof typeof PLATFORM_VERSION];
+export interface ServiceConfiguration {
+    accountId: number;
+    app: ApplicationInfo;
+    functionTimeoutMs: number;
+    hubspotApiOrigin: string;
+    hubspotWebsiteOrigin: string;
+    logger: Pick<typeof console, 'debug' | 'info' | 'warn' | 'error'>;
+    platformVersion: PlatformVersion;
+}
+export interface ApplicationInfo {
+    /** absolute path of the app directory (ex: "/path/to/src/app/") */
+    path: string;
+    /** parsed app.json */
+    config?: {
+        name: string;
+        description: string;
+        scopes: string[];
+        public: boolean;
+        extensions: unknown;
+    };
+}
+/**
+ * Interface for app function execution requests from UI extensions.
+ * It should be consistent with the types declared in
+ * - ui-extensions-remote-renderer
+ * - CRMExtensibility (execution service backend)
+ */
+export interface ServerlessExecutionRequest {
+    appId: number;
+    extensibleCardId: number;
+    serverlessFunction: string;
+    location: ExtensionPointName;
+    objectQuery?: ObjectQuery;
+    parameters?: JsonValue;
+    event?: {
+        type: 'SERVERLESS_ACTION_HOOK';
+        payload: JsonValue;
+    };
+    objectId?: number;
+    objectTypeId?: string;
+}
+export interface ObjectQuery {
+    objectId: number;
+    objectTypeId: string;
+    objectPropertyNames: string[];
+}
+export type ExtensionPointName = 'uie.playground.middle' | 'crm.record.tab' | 'crm.record.sidebar';
+/**
+ * App function signature
+ */
+export type AppFunction = (context: FunctionContext, sendResponse: FunctionCallback) => Promise<void>;
+export type FunctionCallback = (response: JsonValue) => void;
+export interface FunctionContext {
+    parameters?: JsonValue;
+    event?: {
+        type: 'SERVERLESS_ACTION_HOOK';
+        payload: JsonValue;
+    };
+    propertiesToSend?: {
+        [name: string]: unknown;
+    };
+    secrets?: {
+        [name: string]: string;
+    } & {
+        PRIVATE_APP_ACCESS_TOKEN?: string;
+    };
+}
+export interface ApiException extends Error {
+    code: number;
+}
+export declare function isApiException(err: unknown): err is ApiException;
+export type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+export interface LocalExecutionInputs {
+    appId?: number;
+    objectQuery?: ServerlessExecutionRequest['objectQuery'];
+    parameters?: ServerlessExecutionRequest['parameters'];
+    event?: ServerlessExecutionRequest['event'];
+}
+export interface LocalDevUrlMapping {
+    [hostUrl: string]: string;
+}
+export interface ProxyServiceConfig {
+    logger: Pick<typeof console, 'debug' | 'info' | 'warn' | 'error'>;
+    localDevUrlMapping: LocalDevUrlMapping;
+    accountId: number;
+    allowedUrls: string[];
+}
+interface Context {
+    correlationId: string[];
+    httpMethod: string[];
+    appServerStatusCode?: string[];
+    portalId: string[];
+    requestUri: string[];
+}
+export interface AppProxyServiceSuccessResponse {
+    status: 'success';
+    responseBody: unknown;
+    context: Context;
+}
+export interface AppProxyServiceErrorResponse {
+    status: 'error';
+    category: string;
+    message: string;
+    context: Context;
+    errors?: unknown[];
+    responseBody?: unknown;
+}
+export type AppProxyServiceResponse = AppProxyServiceSuccessResponse | AppProxyServiceErrorResponse;
+export interface ProxyServerError {
+    status: number;
+    data?: unknown;
+    message: string;
+    category: string;
+}
+export interface ProxyRequest {
+    requestUri: string;
+    method: string;
+    requestTimeoutMillis: number;
+    requestBody: unknown;
+    requestHeaders?: Record<string, string>;
+}
+export type PrivateAppUserToken = {
+    userId: number;
+    portalId: number;
+    appId: number;
+    scopeGroups: string[];
+    userTokenKey: string;
+    expiresAt: string;
+    clientId: string;
+    privateAppTokenInfo?: {
+        userId: number;
+        portalId: number;
+        appId: number;
+        scopeGroups: string[];
+        expiresAt: string;
+    };
+};
+export {};

package/dist/lib/app-functions/types.js

@@ -0,0 +1,6 @@
+export function isApiException(err) {
+    return (!!err &&
+        typeof err === 'object' &&
+        'code' in err &&
+        typeof err.code === 'number');
+}

package/dist/lib/app-functions/utils.d.ts

@@ -0,0 +1,15 @@
+type PropertyMap = {
+    [key: string]: unknown;
+};
+export declare function filterMap(properties: PropertyMap, filterKeys: string[]): PropertyMap;
+interface Diffs {
+    added: string[];
+    deleted: string[];
+}
+export declare function diffLists(before: string[], after: string[]): Diffs;
+export declare function formatSeconds(ms: number, fractionDigits?: number): string;
+export declare class UnhandledPlatformVersionError extends Error {
+    constructor(platformVersion: never);
+}
+export declare function throwUnhandledPlatformVersionError(platformVersion: never): never;
+export {};

package/dist/lib/app-functions/utils.js

@@ -0,0 +1,28 @@
+export function filterMap(properties, filterKeys) {
+    return Object.keys(properties)
+        .filter((key) => filterKeys.includes(key))
+        .reduce((result, key) => {
+        result[key] = properties[key];
+        return result;
+    }, {});
+}
+export function diffLists(before, after) {
+    return {
+        added: after.filter((item) => !before.includes(item)),
+        deleted: before.filter((item) => !after.includes(item)),
+    };
+}
+export function formatSeconds(ms, fractionDigits = 0) {
+    const seconds = Number(ms / 1000.0);
+    return seconds > 1
+        ? `${seconds.toFixed(fractionDigits)} seconds`
+        : `${seconds.toFixed(fractionDigits)} second`;
+}
+export class UnhandledPlatformVersionError extends Error {
+    constructor(platformVersion) {
+        super(`Unsupported platform version "${platformVersion}"`);
+    }
+}
+export function throwUnhandledPlatformVersionError(platformVersion) {
+    throw new UnhandledPlatformVersionError(platformVersion);
+}

package/dist/lib/ast.js

@@ -183,7 +183,8 @@ function _processAssociationsHook(node, output) {
             type: propertyType,
             toObjectTypeId,
             requestProperties: propertiesArray,
-            paginationOptions,
+            // We need to only store paginationOptions if it's not an empty object. Otherwise it causes BE validation issues.
+            ...(Object.keys(paginationOptions).length > 0 && { paginationOptions }),
             options: otherOptions,
         },
     });

package/dist/lib/server.js

@@ -1,8 +1,8 @@
 import express from 'express';
 import cors from 'cors';
-import { PROXY_CAPABILITY, SERVER_CAPABILITIES } from "./constants.js";
+import { PROXY_CAPABILITY, SERVER_CAPABILITIES, WEBSOCKET_MESSAGE_VERSION, } from "./constants.js";
 import extensionsService from "./extensionsService.js";
-import { AppFunctionExecutionService, AppProxyService, } from '@hubspot/app-functions-dev-server';
+import { AppFunctionExecutionService, AppProxyService, } from "./app-functions/services/index.js";
 import { extractAllowedUrls } from "./utils.js";
 import { ExtensionsWebSocket } from "./ExtensionsWebSocket.js";
 function listen(app, port) {
@@ -80,8 +80,19 @@ async function startDevServer({ devServerState, viteDevServer, }) {
         httpServer: server,
         shutdown: async function shutdown() {
             try {
-                await viteDevServer.pluginContainer.close();
-                // Close WebSocket server first to reject new connections
+                // Notify browsers before closing
+                const ws = devServerState.extensionsWebSocket;
+                if (ws) {
+                    devServerState.logger.debug('Sending shutdown message to connected browsers');
+                    devServerState.extensionsMetadata?.forEach((metadata) => {
+                        ws.broadcast({
+                            ...metadata.baseMessage,
+                            version: WEBSOCKET_MESSAGE_VERSION,
+                            event: 'shutdown',
+                        });
+                    });
+                }
+                // Close WebSocket server to reject new connections
                 await devServerState.getExtensionsWebSocket().close();
                 // Close HTTP server
                 await new Promise((resolve) => {

package/dist/lib/types.d.ts

@@ -1,5 +1,5 @@
 import { PLATFORM_VERSION, PRIVATE_APP, PUBLIC_APP } from './constants.ts';
-import { LocalDevUrlMapping } from '@hubspot/app-functions-dev-server';
+import { LocalDevUrlMapping } from './app-functions/types.ts';
 export interface ObjectTypes {
     name: string;
 }
@@ -216,7 +216,7 @@ export type DataDependency = {
         type: 'CrmRecordAssociationProperties';
         toObjectTypeId: string;
         requestProperties: string[];
-        paginationOptions: {
+        paginationOptions?: {
             [key: string]: any;
         };
         options: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/ui-extensions-dev-server",
-  "version": "1.1.5",
+  "version": "1.1.7",
   "description": "",
   "type": "module",
   "bin": {
@@ -33,10 +33,13 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@hubspot/app-functions-dev-server": "0.11.1",
+    "@hubspot/api-client": "12.0.1",
+    "@hubspot/local-dev-lib": "5.1.1",
+    "@sentry/node": "10.37.0",
+    "axios": "1.13.5",
     "chalk": "5.4.1",
     "commander": "13.1.0",
-    "cors": "2.8.5",
+    "cors": "2.8.6",
     "detect-port": "2.1.0",
     "estraverse": "5.3.0",
     "express": "5.1.0",
@@ -47,7 +50,6 @@
   },
   "devDependencies": {
     "@changesets/cli": "^2.29.7",
-    "@hubspot/local-dev-lib": "^3.19.2",
     "@types/cors": "^2.8.19",
     "@types/estree": "^1.0.5",
     "@types/express": "^5.0.3",
@@ -57,14 +59,15 @@
     "@typescript-eslint/parser": "^8.44.1",
     "acorn": "^8.15.0",
     "ava": "5.3.1",
-    "axios": "1.12.2",
     "eslint": "^8.56.0",
     "eslint-plugin-import": "^2.31.0",
     "husky": "^9.1.7",
     "lint-staged": "^10.5.4",
+    "memfs": "^4.9.3",
+    "node-mocks-http": "^1.12.2",
     "prettier": "^3.6.2",
     "typescript": "^5.9.2",
-    "vitest": "^2.1.9"
+    "vitest": "^4.0.18"
   },
   "engines": {
     "node": ">=18"