@frontmcp/ui 0.5.0 → 0.6.0

package/src/adapters/platform-meta.js

@@ -1,310 +0,0 @@
-"use strict";
-/**
- * Platform Metadata Adapters
- *
- * Build platform-specific _meta fields for tool UI responses.
- * Adapts the UI configuration to the format expected by each
- * AI platform (OpenAI, Claude, Gemini, etc.).
- *
- * This module is SDK-independent and can be used by external systems
- * like AgentLink without requiring @frontmcp/sdk.
- *
- * @packageDocumentation
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildUIMeta = buildUIMeta;
-exports.buildOpenAICSP = buildOpenAICSP;
-exports.buildToolDiscoveryMeta = buildToolDiscoveryMeta;
-// ============================================
-// Main Builder Function
-// ============================================
-/**
- * Build platform-specific UI metadata for tool response.
- *
- * For inline serving mode (default), HTML is embedded directly in `_meta['ui/html']`.
- * For static mode, the static widget URI is provided in tools/list
- * and the tool response contains only structured data.
- *
- * @example
- * ```typescript
- * import { buildUIMeta } from '@frontmcp/ui/adapters';
- *
- * const meta = buildUIMeta({
- *   uiConfig: { template: (ctx) => `<div>${ctx.output.value}</div>` },
- *   platformType: 'openai',
- *   html: '<div>Hello World</div>',
- * });
- * ```
- */
-function buildUIMeta(options) {
-    const { uiConfig, platformType, html, token, directUrl, rendererType, contentHash, manifestUri } = options;
-    const meta = {};
-    // Add manifest-related fields if provided
-    if (rendererType) {
-        meta['ui/type'] = rendererType;
-    }
-    if (contentHash) {
-        meta['ui/contentHash'] = contentHash;
-    }
-    if (manifestUri) {
-        meta['ui/manifestUri'] = manifestUri;
-    }
-    // For inline mode, embed HTML directly in response
-    // This is the only serving mode that uses buildUIMeta
-    // (static mode returns structured data only, no UI _meta)
-    meta['ui/html'] = html;
-    // Always include MIME type for platforms that need it
-    meta['ui/mimeType'] = getMimeType(platformType);
-    // Include token if provided
-    if (token) {
-        meta['ui/widgetToken'] = token;
-    }
-    // Include direct URL if provided
-    if (directUrl) {
-        meta['ui/directUrl'] = directUrl;
-    }
-    // Platform-specific fields
-    switch (platformType) {
-        case 'openai':
-            return buildOpenAIMeta(meta, uiConfig);
-        case 'claude':
-            return buildClaudeMeta(meta, uiConfig);
-        case 'gemini':
-            return buildGeminiMeta(meta, uiConfig);
-        case 'cursor':
-        case 'continue':
-        case 'cody':
-            return buildIDEMeta(meta, uiConfig);
-        case 'generic-mcp':
-            return buildGenericMeta(meta, uiConfig);
-        case 'ext-apps':
-            return buildExtAppsMeta(meta, uiConfig);
-        default:
-            // Unknown platform - just return universal fields
-            return meta;
-    }
-}
-// ============================================
-// Helper Functions
-// ============================================
-/**
- * Get MIME type based on platform.
- */
-function getMimeType(platformType) {
-    switch (platformType) {
-        case 'openai':
-            return 'text/html+skybridge';
-        default:
-            return 'text/html+mcp';
-    }
-}
-/**
- * Build OpenAI-specific metadata for tool CALL response (inline mode).
- *
- * NOTE: Per OpenAI's pizzaz example, the call response should only include
- * invocation status in _meta. The outputTemplate, resultCanProduceWidget, etc.
- * are discovery-time fields that belong in tools/list _meta, NOT in call response.
- *
- * For static mode: OpenAI fetches the widget HTML from the outputTemplate URI
- * (set in tools/list) and injects structuredContent as window.openai.toolOutput.
- * For inline mode: HTML is embedded directly in _meta['ui/html'].
- */
-function buildOpenAIMeta(meta, uiConfig) {
-    // Only include invocation status in call response _meta
-    // (per pizzaz example - they don't include outputTemplate in call response)
-    if (uiConfig.invocationStatus?.invoking) {
-        meta['openai/toolInvocation/invoking'] = uiConfig.invocationStatus.invoking;
-    }
-    if (uiConfig.invocationStatus?.invoked) {
-        meta['openai/toolInvocation/invoked'] = uiConfig.invocationStatus.invoked;
-    }
-    return meta;
-}
-/**
- * Build OpenAI CSP format.
- */
-function buildOpenAICSP(csp) {
-    const result = {};
-    if (csp.connectDomains?.length) {
-        result.connect_domains = csp.connectDomains;
-    }
-    if (csp.resourceDomains?.length) {
-        result.resource_domains = csp.resourceDomains;
-    }
-    return result;
-}
-/**
- * Build Claude-specific metadata.
- * Claude widgets are network-blocked, so we don't include URI references.
- */
-function buildClaudeMeta(meta, uiConfig) {
-    // Claude uses inline HTML only (network-blocked)
-    // Don't include resource URI since Claude can't fetch it
-    if (uiConfig.widgetDescription) {
-        meta['claude/widgetDescription'] = uiConfig.widgetDescription;
-    }
-    return meta;
-}
-/**
- * Build Gemini-specific metadata.
- */
-function buildGeminiMeta(meta, uiConfig) {
-    // Gemini support is limited - include inline HTML
-    // Future: Add Gemini-specific fields when they're defined
-    if (uiConfig.widgetDescription) {
-        meta['gemini/widgetDescription'] = uiConfig.widgetDescription;
-    }
-    return meta;
-}
-/**
- * Build IDE-specific metadata (Cursor, Continue, Cody).
- * For inline mode, HTML is embedded directly in _meta['ui/html'].
- */
-function buildIDEMeta(meta, uiConfig) {
-    if (uiConfig.widgetDescription) {
-        meta['ide/widgetDescription'] = uiConfig.widgetDescription;
-    }
-    return meta;
-}
-/**
- * Build generic MCP client metadata.
- * For inline mode, HTML is embedded directly in _meta['ui/html'].
- */
-function buildGenericMeta(meta, uiConfig) {
-    if (uiConfig.widgetAccessible) {
-        meta['openai/widgetAccessible'] = true;
-    }
-    if (uiConfig.csp) {
-        meta['openai/widgetCSP'] = buildOpenAICSP(uiConfig.csp);
-    }
-    return meta;
-}
-/**
- * Build MCP Apps (ext-apps) metadata per specification.
- * For inline mode, HTML is embedded directly in _meta['ui/html'].
- *
- * Per MCP Apps spec: https://github.com/modelcontextprotocol/ext-apps
- * - ui/csp: Content security policy for sandboxed iframe
- * - ui/displayMode: How the UI should be displayed
- * - ui/prefersBorder: Whether to show border around UI
- * - ui/domain: Optional dedicated sandbox domain
- */
-function buildExtAppsMeta(meta, uiConfig) {
-    // MCP Apps uses text/html+mcp MIME type
-    meta['ui/mimeType'] = 'text/html+mcp';
-    // CSP configuration (uses camelCase per MCP Apps spec)
-    if (uiConfig.csp) {
-        const csp = {};
-        if (uiConfig.csp.connectDomains?.length) {
-            csp.connectDomains = uiConfig.csp.connectDomains;
-        }
-        if (uiConfig.csp.resourceDomains?.length) {
-            csp.resourceDomains = uiConfig.csp.resourceDomains;
-        }
-        if (Object.keys(csp).length > 0) {
-            meta['ui/csp'] = csp;
-        }
-    }
-    // Display mode preference
-    if (uiConfig.displayMode) {
-        // Map generic display modes to MCP Apps specific values
-        const displayModeMap = {
-            inline: 'inline',
-            fullscreen: 'fullscreen',
-            pip: 'pip',
-            // Map OpenAI-style values
-            widget: 'inline',
-            panel: 'fullscreen',
-        };
-        const mappedMode = displayModeMap[uiConfig.displayMode];
-        if (mappedMode) {
-            meta['ui/displayMode'] = mappedMode;
-        }
-    }
-    // Border preference (default: true for visual clarity in sandbox)
-    if (uiConfig.prefersBorder !== undefined) {
-        meta['ui/prefersBorder'] = uiConfig.prefersBorder;
-    }
-    // Dedicated sandbox domain (optional)
-    if (uiConfig.sandboxDomain) {
-        meta['ui/domain'] = uiConfig.sandboxDomain;
-    }
-    return meta;
-}
-/**
- * Build tool discovery metadata (for tools/list response).
- */
-function buildToolDiscoveryMeta(options) {
-    const { uiConfig, platformType, staticWidgetUri } = options;
-    const meta = {};
-    switch (platformType) {
-        case 'openai':
-            // OpenAI-specific discovery fields
-            meta['openai/outputTemplate'] = staticWidgetUri;
-            meta['openai/resultCanProduceWidget'] = true;
-            if (uiConfig.widgetAccessible) {
-                meta['openai/widgetAccessible'] = true;
-            }
-            if (uiConfig.csp) {
-                meta['openai/widgetCSP'] = buildOpenAICSP(uiConfig.csp);
-            }
-            if (uiConfig.displayMode) {
-                meta['openai/displayMode'] = uiConfig.displayMode;
-            }
-            if (uiConfig.widgetDescription) {
-                meta['openai/widgetDescription'] = uiConfig.widgetDescription;
-            }
-            break;
-        case 'generic-mcp':
-            // Generic MCP uses OpenAI-like format
-            meta['openai/outputTemplate'] = staticWidgetUri;
-            meta['openai/resultCanProduceWidget'] = true;
-            if (uiConfig.widgetAccessible) {
-                meta['openai/widgetAccessible'] = true;
-            }
-            if (uiConfig.csp) {
-                meta['openai/widgetCSP'] = buildOpenAICSP(uiConfig.csp);
-            }
-            break;
-        case 'ext-apps':
-            // MCP Apps discovery metadata per specification
-            meta['ui/resourceUri'] = staticWidgetUri;
-            meta['ui/mimeType'] = 'text/html+mcp';
-            if (uiConfig.csp) {
-                const csp = {};
-                if (uiConfig.csp.connectDomains?.length) {
-                    csp.connectDomains = uiConfig.csp.connectDomains;
-                }
-                if (uiConfig.csp.resourceDomains?.length) {
-                    csp.resourceDomains = uiConfig.csp.resourceDomains;
-                }
-                if (Object.keys(csp).length > 0) {
-                    meta['ui/csp'] = csp;
-                }
-            }
-            if (uiConfig.displayMode) {
-                const displayModeMap = {
-                    inline: 'inline',
-                    fullscreen: 'fullscreen',
-                    pip: 'pip',
-                };
-                const mappedMode = displayModeMap[uiConfig.displayMode];
-                if (mappedMode) {
-                    meta['ui/displayMode'] = mappedMode;
-                }
-            }
-            if (uiConfig.prefersBorder !== undefined) {
-                meta['ui/prefersBorder'] = uiConfig.prefersBorder;
-            }
-            if (uiConfig.sandboxDomain) {
-                meta['ui/domain'] = uiConfig.sandboxDomain;
-            }
-            break;
-        // Claude, Gemini, IDEs don't need discovery metadata
-        // They use inline HTML at call time
-        default:
-            break;
-    }
-    return meta;
-}
-//# sourceMappingURL=platform-meta.js.map

package/src/adapters/platform-meta.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"platform-meta.js","sourceRoot":"","sources":["../../../src/adapters/platform-meta.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;AA0JH,kCA4DC;AA6CD,wCAeC;AAgKD,wDA0FC;AAxYD,+CAA+C;AAC/C,wBAAwB;AACxB,+CAA+C;AAE/C;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,WAAW,CAA8B,OAAoC;IAC3F,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAE3G,MAAM,IAAI,GAAe,EAAE,CAAC;IAE5B,0CAA0C;IAC1C,IAAI,YAAY,EAAE,CAAC;QACjB,IAAI,CAAC,SAAS,CAAC,GAAG,YAAY,CAAC;IACjC,CAAC;IACD,IAAI,WAAW,EAAE,CAAC;QAChB,IAAI,CAAC,gBAAgB,CAAC,GAAG,WAAW,CAAC;IACvC,CAAC;IACD,IAAI,WAAW,EAAE,CAAC;QAChB,IAAI,CAAC,gBAAgB,CAAC,GAAG,WAAW,CAAC;IACvC,CAAC;IAED,mDAAmD;IACnD,sDAAsD;IACtD,0DAA0D;IAC1D,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;IAEvB,sDAAsD;IACtD,IAAI,CAAC,aAAa,CAAC,GAAG,WAAW,CAAC,YAAY,CAAC,CAAC;IAEhD,4BAA4B;IAC5B,IAAI,KAAK,EAAE,CAAC;QACV,IAAI,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC;IACjC,CAAC;IAED,iCAAiC;IACjC,IAAI,SAAS,EAAE,CAAC;QACd,IAAI,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;IACnC,CAAC;IAED,2BAA2B;IAC3B,QAAQ,YAAY,EAAE,CAAC;QACrB,KAAK,QAAQ;YACX,OAAO,eAAe,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEzC,KAAK,QAAQ;YACX,OAAO,eAAe,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEzC,KAAK,QAAQ;YACX,OAAO,eAAe,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEzC,KAAK,QAAQ,CAAC;QACd,KAAK,UAAU,CAAC;QAChB,KAAK,MAAM;YACT,OAAO,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEtC,KAAK,aAAa;YAChB,OAAO,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAE1C,KAAK,UAAU;YACb,OAAO,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAE1C;YACE,kDAAkD;YAClD,OAAO,IAAI,CAAC;IAChB,CAAC;AACH,CAAC;AAED,+CAA+C;AAC/C,mBAAmB;AACnB,+CAA+C;AAE/C;;GAEG;AACH,SAAS,WAAW,CAAC,YAA4B;IAC/C,QAAQ,YAAY,EAAE,CAAC;QACrB,KAAK,QAAQ;YACX,OAAO,qBAAqB,CAAC;QAC/B;YACE,OAAO,eAAe,CAAC;IAC3B,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,eAAe,CAAU,IAAgB,EAAE,QAAmC;IACrF,wDAAwD;IACxD,4EAA4E;IAC5E,IAAI,QAAQ,CAAC,gBAAgB,EAAE,QAAQ,EAAE,CAAC;QACxC,IAAI,CAAC,gCAAgC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC;IAC9E,CAAC;IACD,IAAI,QAAQ,CAAC,gBAAgB,EAAE,OAAO,EAAE,CAAC;QACvC,IAAI,CAAC,+BAA+B,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC;IAC5E,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACH,SAAgB,cAAc,CAAC,GAA4B;IAIzD,MAAM,MAAM,GAAgE,EAAE,CAAC;IAE/E,IAAI,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,CAAC;QAC/B,MAAM,CAAC,eAAe,GAAG,GAAG,CAAC,cAAc,CAAC;IAC9C,CAAC;IAED,IAAI,GAAG,CAAC,eAAe,EAAE,MAAM,EAAE,CAAC;QAChC,MAAM,CAAC,gBAAgB,GAAG,GAAG,CAAC,eAAe,CAAC;IAChD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe,CAAU,IAAgB,EAAE,QAAmC;IACrF,iDAAiD;IACjD,yDAAyD;IAEzD,IAAI,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QAC/B,IAAI,CAAC,0BAA0B,CAAC,GAAG,QAAQ,CAAC,iBAAiB,CAAC;IAChE,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACH,SAAS,eAAe,CAAU,IAAgB,EAAE,QAAmC;IACrF,kDAAkD;IAClD,0DAA0D;IAE1D,IAAI,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QAC/B,IAAI,CAAC,0BAA0B,CAAC,GAAG,QAAQ,CAAC,iBAAiB,CAAC;IAChE,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;GAGG;AACH,SAAS,YAAY,CAAU,IAAgB,EAAE,QAAmC;IAClF,IAAI,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QAC/B,IAAI,CAAC,uBAAuB,CAAC,GAAG,QAAQ,CAAC,iBAAiB,CAAC;IAC7D,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;GAGG;AACH,SAAS,gBAAgB,CAAU,IAAgB,EAAE,QAAmC;IACtF,IAAI,QAAQ,CAAC,gBAAgB,EAAE,CAAC;QAC9B,IAAI,CAAC,yBAAyB,CAAC,GAAG,IAAI,CAAC;IACzC,CAAC;IAED,IAAI,QAAQ,CAAC,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,kBAAkB,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,gBAAgB,CAAU,IAAgB,EAAE,QAAmC;IACtF,wCAAwC;IACxC,IAAI,CAAC,aAAa,CAAC,GAAG,eAAe,CAAC;IAEtC,uDAAuD;IACvD,IAAI,QAAQ,CAAC,GAAG,EAAE,CAAC;QACjB,MAAM,GAAG,GAA8D,EAAE,CAAC;QAE1E,IAAI,QAAQ,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,CAAC;YACxC,GAAG,CAAC,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC,cAAc,CAAC;QACnD,CAAC;QAED,IAAI,QAAQ,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,EAAE,CAAC;YACzC,GAAG,CAAC,eAAe,GAAG,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC;QACrD,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC;QACvB,CAAC;IACH,CAAC;IAED,0BAA0B;IAC1B,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;QACzB,wDAAwD;QACxD,MAAM,cAAc,GAAoD;YACtE,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE,YAAY;YACxB,GAAG,EAAE,KAAK;YACV,0BAA0B;YAC1B,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE,YAAY;SACpB,CAAC;QACF,MAAM,UAAU,GAAG,cAAc,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACxD,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC;QACtC,CAAC;IACH,CAAC;IAED,kEAAkE;IAClE,IAAI,QAAQ,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;QACzC,IAAI,CAAC,kBAAkB,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC;IACpD,CAAC;IAED,sCAAsC;IACtC,IAAI,QAAQ,CAAC,aAAa,EAAE,CAAC;QAC3B,IAAI,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC;IAC7C,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAuCD;;GAEG;AACH,SAAgB,sBAAsB,CACpC,OAA+C;IAE/C,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;IAE5D,MAAM,IAAI,GAAe,EAAE,CAAC;IAE5B,QAAQ,YAAY,EAAE,CAAC;QACrB,KAAK,QAAQ;YACX,mCAAmC;YACnC,IAAI,CAAC,uBAAuB,CAAC,GAAG,eAAe,CAAC;YAChD,IAAI,CAAC,+BAA+B,CAAC,GAAG,IAAI,CAAC;YAE7C,IAAI,QAAQ,CAAC,gBAAgB,EAAE,CAAC;gBAC9B,IAAI,CAAC,yBAAyB,CAAC,GAAG,IAAI,CAAC;YACzC,CAAC;YAED,IAAI,QAAQ,CAAC,GAAG,EAAE,CAAC;gBACjB,IAAI,CAAC,kBAAkB,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC1D,CAAC;YAED,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;gBACzB,IAAI,CAAC,oBAAoB,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC;YACpD,CAAC;YAED,IAAI,QAAQ,CAAC,iBAAiB,EAAE,CAAC;gBAC/B,IAAI,CAAC,0BAA0B,CAAC,GAAG,QAAQ,CAAC,iBAAiB,CAAC;YAChE,CAAC;YACD,MAAM;QAER,KAAK,aAAa;YAChB,sCAAsC;YACtC,IAAI,CAAC,uBAAuB,CAAC,GAAG,eAAe,CAAC;YAChD,IAAI,CAAC,+BAA+B,CAAC,GAAG,IAAI,CAAC;YAE7C,IAAI,QAAQ,CAAC,gBAAgB,EAAE,CAAC;gBAC9B,IAAI,CAAC,yBAAyB,CAAC,GAAG,IAAI,CAAC;YACzC,CAAC;YAED,IAAI,QAAQ,CAAC,GAAG,EAAE,CAAC;gBACjB,IAAI,CAAC,kBAAkB,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC1D,CAAC;YACD,MAAM;QAER,KAAK,UAAU;YACb,gDAAgD;YAChD,IAAI,CAAC,gBAAgB,CAAC,GAAG,eAAe,CAAC;YACzC,IAAI,CAAC,aAAa,CAAC,GAAG,eAAe,CAAC;YAEtC,IAAI,QAAQ,CAAC,GAAG,EAAE,CAAC;gBACjB,MAAM,GAAG,GAA8D,EAAE,CAAC;gBAC1E,IAAI,QAAQ,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,CAAC;oBACxC,GAAG,CAAC,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC,cAAc,CAAC;gBACnD,CAAC;gBACD,IAAI,QAAQ,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,EAAE,CAAC;oBACzC,GAAG,CAAC,eAAe,GAAG,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC;gBACrD,CAAC;gBACD,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAChC,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC;gBACvB,CAAC;YACH,CAAC;YAED,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;gBACzB,MAAM,cAAc,GAAoD;oBACtE,MAAM,EAAE,QAAQ;oBAChB,UAAU,EAAE,YAAY;oBACxB,GAAG,EAAE,KAAK;iBACX,CAAC;gBACF,MAAM,UAAU,GAAG,cAAc,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;gBACxD,IAAI,UAAU,EAAE,CAAC;oBACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC;gBACtC,CAAC;YACH,CAAC;YAED,IAAI,QAAQ,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACzC,IAAI,CAAC,kBAAkB,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC;YACpD,CAAC;YAED,IAAI,QAAQ,CAAC,aAAa,EAAE,CAAC;gBAC3B,IAAI,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC;YAC7C,CAAC;YACD,MAAM;QAER,qDAAqD;QACrD,oCAAoC;QACpC;YACE,MAAM;IACV,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["/**\n * Platform Metadata Adapters\n *\n * Build platform-specific _meta fields for tool UI responses.\n * Adapts the UI configuration to the format expected by each\n * AI platform (OpenAI, Claude, Gemini, etc.).\n *\n * This module is SDK-independent and can be used by external systems\n * like AgentLink without requiring @frontmcp/sdk.\n *\n * @packageDocumentation\n */\n\nimport type { UITemplateConfig, UIContentSecurityPolicy } from '../types';\n\n// ============================================\n// Platform Types\n// ============================================\n\n/**\n * Supported AI platform types.\n * Used to determine which metadata format to generate.\n */\nexport type AIPlatformType =\n  | 'openai'\n  | 'claude'\n  | 'gemini'\n  | 'cursor'\n  | 'continue'\n  | 'cody'\n  | 'generic-mcp'\n  | 'ext-apps'\n  | 'unknown';\n\n// ============================================\n// UI Metadata\n// ============================================\n\n/**\n * UI metadata to include in tool response _meta field.\n * Contains both universal fields and platform-specific annotations.\n */\nexport interface UIMetadata {\n  // Universal fields\n  /** Inline rendered HTML (universal) */\n  'ui/html'?: string;\n  /** MIME type for the HTML content */\n  'ui/mimeType'?: string;\n  /** Widget token for authenticated operations */\n  'ui/widgetToken'?: string;\n  /** Direct URL to widget (for direct-url serving mode) */\n  'ui/directUrl'?: string;\n\n  // Widget manifest fields (new)\n  /** Renderer type for the widget (html, react, mdx, markdown, auto) */\n  'ui/type'?: string;\n  /** Manifest URI for accessing widget configuration */\n  'ui/manifestUri'?: string;\n  /** Hash of the widget content for cache validation */\n  'ui/contentHash'?: string;\n  /** Required renderer assets for lazy loading */\n  'ui/requiredRenderers'?: string[];\n\n  // OpenAI-specific fields\n  /** OpenAI: Resource URI for widget template */\n  'openai/outputTemplate'?: string;\n  /** OpenAI: Whether widget can invoke tools */\n  'openai/widgetAccessible'?: boolean;\n  /** OpenAI: Whether tool result can produce a widget (CRITICAL for ChatGPT) */\n  'openai/resultCanProduceWidget'?: boolean;\n  /** OpenAI: CSP configuration */\n  'openai/widgetCSP'?: {\n    connect_domains?: string[];\n    resource_domains?: string[];\n  };\n  /** OpenAI: Display mode preference */\n  'openai/displayMode'?: string;\n  /** OpenAI: Widget description */\n  'openai/widgetDescription'?: string;\n  /** OpenAI: Status text while tool is executing */\n  'openai/toolInvocation/invoking'?: string;\n  /** OpenAI: Status text after tool execution completes */\n  'openai/toolInvocation/invoked'?: string;\n\n  // Claude-specific fields\n  /** Claude: Widget description */\n  'claude/widgetDescription'?: string;\n\n  // Gemini-specific fields\n  /** Gemini: Widget description */\n  'gemini/widgetDescription'?: string;\n\n  // IDE-specific fields (Cursor, Continue, Cody)\n  /** IDE: Resource URI for widget template */\n  'ide/outputTemplate'?: string;\n  /** IDE: Widget description */\n  'ide/widgetDescription'?: string;\n\n  // MCP Apps (ext-apps) fields - per specification\n  /** MCP Apps: Resource URI for UI template */\n  'ui/resourceUri'?: string;\n  /** MCP Apps: CSP configuration */\n  'ui/csp'?: {\n    connectDomains?: string[];\n    resourceDomains?: string[];\n  };\n  /** MCP Apps: Dedicated sandbox domain */\n  'ui/domain'?: string;\n  /** MCP Apps: Whether to show border around UI */\n  'ui/prefersBorder'?: boolean;\n  /** MCP Apps: Display mode */\n  'ui/displayMode'?: 'inline' | 'fullscreen' | 'pip';\n\n  /** Allow additional platform-specific fields */\n  [key: string]: unknown;\n}\n\n// ============================================\n// Build Options\n// ============================================\n\n/**\n * Options for building UI metadata.\n */\nexport interface BuildUIMetaOptions<In = unknown, Out = unknown> {\n  /** Tool UI configuration */\n  uiConfig: UITemplateConfig<In, Out>;\n  /** Detected platform type */\n  platformType: AIPlatformType;\n  /** Rendered HTML content */\n  html: string;\n  /** Widget access token */\n  token?: string;\n  /** Direct URL for widget serving */\n  directUrl?: string;\n  /** Renderer type for the widget (html, react, mdx, markdown, auto) */\n  rendererType?: string;\n  /** Hash of the widget content for cache validation */\n  contentHash?: string;\n  /** Manifest URI for accessing widget configuration */\n  manifestUri?: string;\n}\n\n// ============================================\n// Main Builder Function\n// ============================================\n\n/**\n * Build platform-specific UI metadata for tool response.\n *\n * For inline serving mode (default), HTML is embedded directly in `_meta['ui/html']`.\n * For static mode, the static widget URI is provided in tools/list\n * and the tool response contains only structured data.\n *\n * @example\n * ```typescript\n * import { buildUIMeta } from '@frontmcp/ui/adapters';\n *\n * const meta = buildUIMeta({\n *   uiConfig: { template: (ctx) => `<div>${ctx.output.value}</div>` },\n *   platformType: 'openai',\n *   html: '<div>Hello World</div>',\n * });\n * ```\n */\nexport function buildUIMeta<In = unknown, Out = unknown>(options: BuildUIMetaOptions<In, Out>): UIMetadata {\n  const { uiConfig, platformType, html, token, directUrl, rendererType, contentHash, manifestUri } = options;\n\n  const meta: UIMetadata = {};\n\n  // Add manifest-related fields if provided\n  if (rendererType) {\n    meta['ui/type'] = rendererType;\n  }\n  if (contentHash) {\n    meta['ui/contentHash'] = contentHash;\n  }\n  if (manifestUri) {\n    meta['ui/manifestUri'] = manifestUri;\n  }\n\n  // For inline mode, embed HTML directly in response\n  // This is the only serving mode that uses buildUIMeta\n  // (static mode returns structured data only, no UI _meta)\n  meta['ui/html'] = html;\n\n  // Always include MIME type for platforms that need it\n  meta['ui/mimeType'] = getMimeType(platformType);\n\n  // Include token if provided\n  if (token) {\n    meta['ui/widgetToken'] = token;\n  }\n\n  // Include direct URL if provided\n  if (directUrl) {\n    meta['ui/directUrl'] = directUrl;\n  }\n\n  // Platform-specific fields\n  switch (platformType) {\n    case 'openai':\n      return buildOpenAIMeta(meta, uiConfig);\n\n    case 'claude':\n      return buildClaudeMeta(meta, uiConfig);\n\n    case 'gemini':\n      return buildGeminiMeta(meta, uiConfig);\n\n    case 'cursor':\n    case 'continue':\n    case 'cody':\n      return buildIDEMeta(meta, uiConfig);\n\n    case 'generic-mcp':\n      return buildGenericMeta(meta, uiConfig);\n\n    case 'ext-apps':\n      return buildExtAppsMeta(meta, uiConfig);\n\n    default:\n      // Unknown platform - just return universal fields\n      return meta;\n  }\n}\n\n// ============================================\n// Helper Functions\n// ============================================\n\n/**\n * Get MIME type based on platform.\n */\nfunction getMimeType(platformType: AIPlatformType): string {\n  switch (platformType) {\n    case 'openai':\n      return 'text/html+skybridge';\n    default:\n      return 'text/html+mcp';\n  }\n}\n\n/**\n * Build OpenAI-specific metadata for tool CALL response (inline mode).\n *\n * NOTE: Per OpenAI's pizzaz example, the call response should only include\n * invocation status in _meta. The outputTemplate, resultCanProduceWidget, etc.\n * are discovery-time fields that belong in tools/list _meta, NOT in call response.\n *\n * For static mode: OpenAI fetches the widget HTML from the outputTemplate URI\n * (set in tools/list) and injects structuredContent as window.openai.toolOutput.\n * For inline mode: HTML is embedded directly in _meta['ui/html'].\n */\nfunction buildOpenAIMeta<In, Out>(meta: UIMetadata, uiConfig: UITemplateConfig<In, Out>): UIMetadata {\n  // Only include invocation status in call response _meta\n  // (per pizzaz example - they don't include outputTemplate in call response)\n  if (uiConfig.invocationStatus?.invoking) {\n    meta['openai/toolInvocation/invoking'] = uiConfig.invocationStatus.invoking;\n  }\n  if (uiConfig.invocationStatus?.invoked) {\n    meta['openai/toolInvocation/invoked'] = uiConfig.invocationStatus.invoked;\n  }\n\n  return meta;\n}\n\n/**\n * Build OpenAI CSP format.\n */\nexport function buildOpenAICSP(csp: UIContentSecurityPolicy): {\n  connect_domains?: string[];\n  resource_domains?: string[];\n} {\n  const result: { connect_domains?: string[]; resource_domains?: string[] } = {};\n\n  if (csp.connectDomains?.length) {\n    result.connect_domains = csp.connectDomains;\n  }\n\n  if (csp.resourceDomains?.length) {\n    result.resource_domains = csp.resourceDomains;\n  }\n\n  return result;\n}\n\n/**\n * Build Claude-specific metadata.\n * Claude widgets are network-blocked, so we don't include URI references.\n */\nfunction buildClaudeMeta<In, Out>(meta: UIMetadata, uiConfig: UITemplateConfig<In, Out>): UIMetadata {\n  // Claude uses inline HTML only (network-blocked)\n  // Don't include resource URI since Claude can't fetch it\n\n  if (uiConfig.widgetDescription) {\n    meta['claude/widgetDescription'] = uiConfig.widgetDescription;\n  }\n\n  return meta;\n}\n\n/**\n * Build Gemini-specific metadata.\n */\nfunction buildGeminiMeta<In, Out>(meta: UIMetadata, uiConfig: UITemplateConfig<In, Out>): UIMetadata {\n  // Gemini support is limited - include inline HTML\n  // Future: Add Gemini-specific fields when they're defined\n\n  if (uiConfig.widgetDescription) {\n    meta['gemini/widgetDescription'] = uiConfig.widgetDescription;\n  }\n\n  return meta;\n}\n\n/**\n * Build IDE-specific metadata (Cursor, Continue, Cody).\n * For inline mode, HTML is embedded directly in _meta['ui/html'].\n */\nfunction buildIDEMeta<In, Out>(meta: UIMetadata, uiConfig: UITemplateConfig<In, Out>): UIMetadata {\n  if (uiConfig.widgetDescription) {\n    meta['ide/widgetDescription'] = uiConfig.widgetDescription;\n  }\n\n  return meta;\n}\n\n/**\n * Build generic MCP client metadata.\n * For inline mode, HTML is embedded directly in _meta['ui/html'].\n */\nfunction buildGenericMeta<In, Out>(meta: UIMetadata, uiConfig: UITemplateConfig<In, Out>): UIMetadata {\n  if (uiConfig.widgetAccessible) {\n    meta['openai/widgetAccessible'] = true;\n  }\n\n  if (uiConfig.csp) {\n    meta['openai/widgetCSP'] = buildOpenAICSP(uiConfig.csp);\n  }\n\n  return meta;\n}\n\n/**\n * Build MCP Apps (ext-apps) metadata per specification.\n * For inline mode, HTML is embedded directly in _meta['ui/html'].\n *\n * Per MCP Apps spec: https://github.com/modelcontextprotocol/ext-apps\n * - ui/csp: Content security policy for sandboxed iframe\n * - ui/displayMode: How the UI should be displayed\n * - ui/prefersBorder: Whether to show border around UI\n * - ui/domain: Optional dedicated sandbox domain\n */\nfunction buildExtAppsMeta<In, Out>(meta: UIMetadata, uiConfig: UITemplateConfig<In, Out>): UIMetadata {\n  // MCP Apps uses text/html+mcp MIME type\n  meta['ui/mimeType'] = 'text/html+mcp';\n\n  // CSP configuration (uses camelCase per MCP Apps spec)\n  if (uiConfig.csp) {\n    const csp: { connectDomains?: string[]; resourceDomains?: string[] } = {};\n\n    if (uiConfig.csp.connectDomains?.length) {\n      csp.connectDomains = uiConfig.csp.connectDomains;\n    }\n\n    if (uiConfig.csp.resourceDomains?.length) {\n      csp.resourceDomains = uiConfig.csp.resourceDomains;\n    }\n\n    if (Object.keys(csp).length > 0) {\n      meta['ui/csp'] = csp;\n    }\n  }\n\n  // Display mode preference\n  if (uiConfig.displayMode) {\n    // Map generic display modes to MCP Apps specific values\n    const displayModeMap: Record<string, 'inline' | 'fullscreen' | 'pip'> = {\n      inline: 'inline',\n      fullscreen: 'fullscreen',\n      pip: 'pip',\n      // Map OpenAI-style values\n      widget: 'inline',\n      panel: 'fullscreen',\n    };\n    const mappedMode = displayModeMap[uiConfig.displayMode];\n    if (mappedMode) {\n      meta['ui/displayMode'] = mappedMode;\n    }\n  }\n\n  // Border preference (default: true for visual clarity in sandbox)\n  if (uiConfig.prefersBorder !== undefined) {\n    meta['ui/prefersBorder'] = uiConfig.prefersBorder;\n  }\n\n  // Dedicated sandbox domain (optional)\n  if (uiConfig.sandboxDomain) {\n    meta['ui/domain'] = uiConfig.sandboxDomain;\n  }\n\n  return meta;\n}\n\n// ============================================\n// Tool Discovery Metadata\n// ============================================\n\n/**\n * Build metadata for tool discovery (tools/list response).\n * This includes fields that should be present at discovery time,\n * not in individual tool call responses.\n *\n * @example\n * ```typescript\n * import { buildToolDiscoveryMeta } from '@frontmcp/ui/adapters';\n *\n * const toolMeta = buildToolDiscoveryMeta({\n *   uiConfig: { template: MyWidget, widgetAccessible: true },\n *   platformType: 'openai',\n *   staticWidgetUri: 'ui://widget/my_tool.html',\n * });\n *\n * // Use in tools/list response\n * const tool = {\n *   name: 'my_tool',\n *   description: '...',\n *   inputSchema: {...},\n *   _meta: toolMeta,\n * };\n * ```\n */\nexport interface BuildToolDiscoveryMetaOptions<In = unknown, Out = unknown> {\n  /** Tool UI configuration */\n  uiConfig: UITemplateConfig<In, Out>;\n  /** Detected platform type */\n  platformType: AIPlatformType;\n  /** Static widget URI (e.g., ui://widget/my_tool.html) */\n  staticWidgetUri: string;\n}\n\n/**\n * Build tool discovery metadata (for tools/list response).\n */\nexport function buildToolDiscoveryMeta<In = unknown, Out = unknown>(\n  options: BuildToolDiscoveryMetaOptions<In, Out>,\n): UIMetadata {\n  const { uiConfig, platformType, staticWidgetUri } = options;\n\n  const meta: UIMetadata = {};\n\n  switch (platformType) {\n    case 'openai':\n      // OpenAI-specific discovery fields\n      meta['openai/outputTemplate'] = staticWidgetUri;\n      meta['openai/resultCanProduceWidget'] = true;\n\n      if (uiConfig.widgetAccessible) {\n        meta['openai/widgetAccessible'] = true;\n      }\n\n      if (uiConfig.csp) {\n        meta['openai/widgetCSP'] = buildOpenAICSP(uiConfig.csp);\n      }\n\n      if (uiConfig.displayMode) {\n        meta['openai/displayMode'] = uiConfig.displayMode;\n      }\n\n      if (uiConfig.widgetDescription) {\n        meta['openai/widgetDescription'] = uiConfig.widgetDescription;\n      }\n      break;\n\n    case 'generic-mcp':\n      // Generic MCP uses OpenAI-like format\n      meta['openai/outputTemplate'] = staticWidgetUri;\n      meta['openai/resultCanProduceWidget'] = true;\n\n      if (uiConfig.widgetAccessible) {\n        meta['openai/widgetAccessible'] = true;\n      }\n\n      if (uiConfig.csp) {\n        meta['openai/widgetCSP'] = buildOpenAICSP(uiConfig.csp);\n      }\n      break;\n\n    case 'ext-apps':\n      // MCP Apps discovery metadata per specification\n      meta['ui/resourceUri'] = staticWidgetUri;\n      meta['ui/mimeType'] = 'text/html+mcp';\n\n      if (uiConfig.csp) {\n        const csp: { connectDomains?: string[]; resourceDomains?: string[] } = {};\n        if (uiConfig.csp.connectDomains?.length) {\n          csp.connectDomains = uiConfig.csp.connectDomains;\n        }\n        if (uiConfig.csp.resourceDomains?.length) {\n          csp.resourceDomains = uiConfig.csp.resourceDomains;\n        }\n        if (Object.keys(csp).length > 0) {\n          meta['ui/csp'] = csp;\n        }\n      }\n\n      if (uiConfig.displayMode) {\n        const displayModeMap: Record<string, 'inline' | 'fullscreen' | 'pip'> = {\n          inline: 'inline',\n          fullscreen: 'fullscreen',\n          pip: 'pip',\n        };\n        const mappedMode = displayModeMap[uiConfig.displayMode];\n        if (mappedMode) {\n          meta['ui/displayMode'] = mappedMode;\n        }\n      }\n\n      if (uiConfig.prefersBorder !== undefined) {\n        meta['ui/prefersBorder'] = uiConfig.prefersBorder;\n      }\n\n      if (uiConfig.sandboxDomain) {\n        meta['ui/domain'] = uiConfig.sandboxDomain;\n      }\n      break;\n\n    // Claude, Gemini, IDEs don't need discovery metadata\n    // They use inline HTML at call time\n    default:\n      break;\n  }\n\n  return meta;\n}\n"]}

package/src/base-template/bridge.d.ts

@@ -1,89 +0,0 @@
-/**
- * Platform Bridge - Reactive Data Store for Tool UI
- *
- * Provides a reactive interface for tool output data that works across:
- * - React (via useSyncExternalStore)
- * - HTMX (via custom events)
- * - Vanilla JS (via subscribe callbacks)
- *
- * Uses Object.defineProperty to intercept when platforms inject data,
- * automatically detecting and notifying subscribers when data changes.
- *
- * @example React integration
- * ```tsx
- * import { useSyncExternalStore } from 'react';
- *
- * function useToolOutput() {
- *   return useSyncExternalStore(
- *     window.__frontmcp.bridge.subscribe,
- *     window.__frontmcp.bridge.getSnapshot,
- *     window.__frontmcp.bridge.getServerSnapshot
- *   );
- * }
- * ```
- *
- * @example Vanilla JS
- * ```javascript
- * const unsubscribe = window.__frontmcp.bridge.subscribe(() => {
- *   const state = window.__frontmcp.bridge.getState();
- *   if (!state.loading) {
- *     renderWidget(state.data);
- *   }
- * });
- * ```
- *
- * @example HTMX
- * ```html
- * <div hx-trigger="frontmcp:change from:document" hx-get="/render">
- *   Loading...
- * </div>
- * ```
- */
-/**
- * Bridge state containing data, loading status, and error information.
- */
-export interface BridgeState<T = unknown> {
-    /** Current data (null when loading or no data) */
-    data: T | null;
-    /** Whether the bridge is waiting for data */
-    loading: boolean;
-    /** Error message if data loading failed */
-    error: string | null;
-}
-/**
- * Platform Bridge interface for reactive data access.
- */
-export interface PlatformBridge<T = unknown> {
-    /** Get current state snapshot */
-    getState(): BridgeState<T>;
-    /** Subscribe to state changes */
-    subscribe(callback: () => void): () => void;
-    /** React useSyncExternalStore compatible getSnapshot */
-    getSnapshot(): BridgeState<T>;
-    /** React SSR compatible getServerSnapshot */
-    getServerSnapshot(): BridgeState<T>;
-    /** Check if bridge has received data */
-    hasData(): boolean;
-    /** Manually set data (for testing or custom injection) */
-    setData(data: T): void;
-    /** Manually set error */
-    setError(error: string): void;
-    /** Reset to loading state */
-    reset(): void;
-}
-/**
- * Render the Platform Bridge inline script.
- *
- * This script creates a reactive data store that:
- * 1. Installs interceptors on window.openai to detect data injection
- * 2. Provides subscribe/getState API for React/HTMX/vanilla integration
- * 3. Dispatches custom events for HTMX compatibility
- * 4. Handles the race condition between iframe load and data injection
- *
- * @returns Script tag with bridge implementation
- */
-export declare function renderBridgeScript(): string;
-/**
- * Generate TypeScript types for the bridge (for documentation/IDE support).
- */
-export declare const BRIDGE_TYPES = "\ninterface BridgeState<T = unknown> {\n  data: T | null;\n  loading: boolean;\n  error: string | null;\n}\n\ninterface PlatformBridge<T = unknown> {\n  getState(): BridgeState<T>;\n  subscribe(callback: () => void): () => void;\n  getSnapshot(): BridgeState<T>;\n  getServerSnapshot(): BridgeState<T>;\n  hasData(): boolean;\n  setData(data: T): void;\n  setError(error: string): void;\n  reset(): void;\n}\n\ndeclare global {\n  interface Window {\n    __frontmcp: {\n      bridge: PlatformBridge;\n      // ... other __frontmcp methods\n    };\n  }\n}\n";