@portel/photon 1.4.1 → 1.6.0

package/dist/auto-ui/streamable-http-transport.d.ts

@@ -0,0 +1,103 @@
+/**
+ * Streamable HTTP Transport for MCP
+ *
+ * Implements the MCP Streamable HTTP transport specification (2025-03-26).
+ * This allows standard MCP clients (like Claude Desktop) to connect to Beam.
+ *
+ * Endpoint: /mcp
+ * - POST: Client sends JSON-RPC requests, server responds with JSON or SSE
+ * - GET: Opens SSE stream for server-initiated messages
+ *
+ * Configuration Schema (SEP-1596 inspired):
+ * - Returns configurationSchema in initialize response
+ * - Uses JSON Schema for rich UI generation (dropdowns, file pickers, etc.)
+ * - beam/configure tool for submitting configuration
+ * - beam/browse tool for server filesystem browsing
+ *
+ * @see https://modelcontextprotocol.io/specification/2025-03-26/basic/transports
+ */
+import type { IncomingMessage, ServerResponse } from 'http';
+import type { AnyPhotonInfo, PhotonMCPInstance, ExternalMCPInfo } from './types.js';
+export interface StreamableHTTPOptions {
+    photons: AnyPhotonInfo[];
+    photonMCPs: Map<string, PhotonMCPInstance>;
+    externalMCPs?: ExternalMCPInfo[];
+    externalMCPClients?: Map<string, any>;
+    externalMCPSDKClients?: Map<string, any>;
+    reconnectExternalMCP?: (name: string) => Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    loadUIAsset: (photonName: string, uiId: string) => Promise<string | null>;
+    configurePhoton?: (photonName: string, config: Record<string, any>) => Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    reloadPhoton?: (photonName: string) => Promise<{
+        success: boolean;
+        photon?: any;
+        error?: string;
+    }>;
+    removePhoton?: (photonName: string) => Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    updateMetadata?: (photonName: string, methodName: string | null, metadata: Record<string, any>) => Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    generatePhotonHelp?: (photonName: string) => Promise<string>;
+    loader?: {
+        executeTool: (mcp: any, toolName: string, args: any, options?: any) => Promise<any>;
+    };
+    broadcast?: (message: object) => void;
+    subscriptionManager?: {
+        onClientViewingBoard: (sessionId: string, photon: string, board: string, lastEventId?: number) => void;
+        onClientDisconnect: (sessionId: string) => void;
+    };
+}
+/**
+ * Handle MCP Streamable HTTP requests
+ */
+export declare function handleStreamableHTTP(req: IncomingMessage, res: ServerResponse, options: StreamableHTTPOptions): Promise<boolean>;
+/**
+ * Send a notification to all connected SSE clients
+ * @param method - The notification method name
+ * @param params - Optional parameters for the notification
+ * @param beamOnly - If true, only send to Beam clients (clientInfo.name === "beam")
+ */
+export declare function broadcastNotification(method: string, params?: Record<string, unknown>, beamOnly?: boolean): void;
+/**
+ * Send a notification to Beam clients only
+ */
+export declare function broadcastToBeam(method: string, params?: Record<string, unknown>): void;
+/**
+ * Get count of active sessions (for debugging)
+ */
+export declare function getActiveSessionCount(): {
+    total: number;
+    beam: number;
+};
+/**
+ * Send a notification to a specific session by ID
+ * Used for replaying missed events on reconnect
+ */
+export declare function sendToSession(sessionId: string, method: string, params?: Record<string, unknown>): boolean;
+/**
+ * Request elicitation from the frontend for an external MCP.
+ * This is used when external MCP servers send elicitation/create requests.
+ *
+ * @param mcpName - Name of the external MCP requesting elicitation
+ * @param request - The elicitation request params from the MCP server
+ * @returns Promise resolving to the user's response
+ */
+export declare function requestExternalElicitation(mcpName: string, request: {
+    mode: 'form' | 'url';
+    message: string;
+    requestedSchema?: any;
+    url?: string;
+}): Promise<{
+    action: 'accept' | 'decline' | 'cancel';
+    content?: any;
+}>;
+//# sourceMappingURL=streamable-http-transport.d.ts.map

package/dist/auto-ui/streamable-http-transport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streamable-http-transport.d.ts","sourceRoot":"","sources":["../../src/auto-ui/streamable-http-transport.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAM5D,OAAO,KAAK,EAOV,aAAa,EACb,iBAAiB,EACjB,eAAe,EAChB,MAAM,YAAY,CAAC;AAq1DpB,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC3C,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;IACjC,kBAAkB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACtC,qBAAqB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,oBAAoB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACvF,WAAW,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC1E,eAAe,CAAC,EAAE,CAChB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KACxB,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACnD,YAAY,CAAC,EAAE,CACb,UAAU,EAAE,MAAM,KACf,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,GAAG,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACjE,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACrF,cAAc,CAAC,EAAE,CACf,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,GAAG,IAAI,EACzB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC1B,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACnD,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7D,MAAM,CAAC,EAAE;QAAE,WAAW,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;KAAE,CAAC;IACjG,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,mBAAmB,CAAC,EAAE;QACpB,oBAAoB,EAAE,CACpB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,WAAW,CAAC,EAAE,MAAM,KACjB,IAAI,CAAC;QACV,kBAAkB,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;KACjD,CAAC;CACH;AAED;;GAEG;AACH,wBAAsB,oBAAoB,CACxC,GAAG,EAAE,eAAe,EACpB,GAAG,EAAE,cAAc,EACnB,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,OAAO,CAAC,CAwKlB;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,QAAQ,UAAQ,GACf,IAAI,CAcN;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAEtF;AAED;;GAEG;AACH,wBAAgB,qBAAqB,IAAI;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAUvE;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAYT;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE;IACP,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,GACA,OAAO,CAAC;IAAE,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAAC,OAAO,CAAC,EAAE,GAAG,CAAA;CAAE,CAAC,CAqCrE"}