@frontmcp/ui 0.6.0 → 0.6.2

package/esm/build/index.d.ts

@@ -1,295 +0,0 @@
-/**
- * Build-Time API for Tool UI
- *
- * Provides pre-compilation capabilities for tool UI templates.
- * Produces a **universal HTML document** that works across all platforms:
- * - OpenAI ChatGPT (Apps SDK)
- * - Anthropic Claude
- * - MCP Apps (ext-apps / SEP-1865)
- * - Google Gemini
- * - Any MCP-compatible host
- *
- * The build embeds the FrontMCP Bridge which auto-detects the host
- * at runtime and adapts its communication protocol accordingly.
- *
- * @packageDocumentation
- */
-import type { UITemplateConfig } from '../types';
-import type { ThemeConfig, DeepPartial } from '../theme';
-/**
- * Network access mode for the target environment.
- *
- * - `'open'`: Can fetch external resources (CDN scripts, fonts)
- * - `'blocked'`: Network is sandboxed, must inline everything
- */
-export type NetworkMode = 'open' | 'blocked';
-/**
- * Script loading strategy.
- *
- * - `'cdn'`: Load scripts from CDN (smaller HTML, requires network)
- * - `'inline'`: Embed scripts in HTML (larger, works offline)
- * - `'auto'`: Choose based on network mode
- */
-export type ScriptStrategy = 'cdn' | 'inline' | 'auto';
-/**
- * Build configuration options.
- * Capability-based rather than platform-specific.
- */
-export interface BuildConfig {
-    /**
-     * Network access mode.
-     * @default 'open'
-     */
-    network?: NetworkMode;
-    /**
-     * Script loading strategy.
-     * @default 'auto' (uses 'inline' if network is 'blocked')
-     */
-    scripts?: ScriptStrategy;
-    /**
-     * Whether to include the FrontMCP Bridge runtime.
-     * The bridge auto-detects the host platform at runtime.
-     * @default true
-     */
-    includeBridge?: boolean;
-    /**
-     * Whether to minify the output HTML.
-     * @default false
-     */
-    minify?: boolean;
-}
-/**
- * Options for building a tool UI template.
- *
- * @example
- * ```typescript
- * const result = await buildToolUI({
- *   template: {
- *     template: (ctx) => `<div>${ctx.output.value}</div>`,
- *     widgetAccessible: true,
- *   },
- *   toolName: 'my_tool',
- *   input: { query: 'hello' },
- *   output: { value: 'world' },
- * });
- *
- * // Universal HTML that works on any platform
- * console.log(result.html);
- * ```
- */
-export interface BuildOptions<In = unknown, Out = unknown> {
-    /**
-     * UI template configuration.
-     */
-    template: UITemplateConfig<In, Out>;
-    /**
-     * Name of the tool this UI is for.
-     */
-    toolName: string;
-    /**
-     * Tool input arguments.
-     */
-    input?: In;
-    /**
-     * Tool output/result data.
-     */
-    output?: Out;
-    /**
-     * Theme configuration override.
-     */
-    theme?: DeepPartial<ThemeConfig>;
-    /**
-     * Build configuration.
-     * Controls network mode, script strategy, etc.
-     */
-    config?: BuildConfig;
-    /**
-     * Title for the HTML document.
-     */
-    title?: string;
-    /** @deprecated Use `input` instead */
-    sampleInput?: In;
-    /** @deprecated Use `output` instead */
-    sampleOutput?: Out;
-    /** @deprecated Use `config.includeBridge` instead */
-    injectAdapters?: boolean;
-    /** @deprecated Use `config.minify` instead */
-    minify?: boolean;
-    /** @deprecated Platform is now auto-detected at runtime */
-    platform?: string;
-}
-/**
- * MIME types for different host platforms.
- * Returned as suggestions - the MCP server response layer decides which to use.
- */
-export interface MimeTypes {
-    /** For OpenAI ChatGPT Apps SDK */
-    openai: 'text/html+skybridge';
-    /** For Claude, MCP Apps, and standard MCP hosts */
-    mcp: 'text/html+mcp';
-    /** Generic HTML (fallback) */
-    html: 'text/html';
-}
-/**
- * Result of building a tool UI template.
- */
-export interface BuildResult {
-    /**
-     * Complete HTML document string.
-     * This is universal - works on all platforms.
-     */
-    html: string;
-    /**
-     * Size of the HTML in bytes.
-     */
-    size: number;
-    /**
-     * Size of the gzipped HTML in bytes (estimated).
-     */
-    gzipSize: number;
-    /**
-     * SHA-256 hash of the HTML content.
-     */
-    hash: string;
-    /**
-     * Suggested MIME types for different hosts.
-     * The MCP server response layer should select based on detected client.
-     */
-    mimeTypes: MimeTypes;
-    /**
-     * Renderer type used (html, react, mdx).
-     */
-    rendererType: string;
-    /**
-     * Build timestamp (ISO 8601).
-     */
-    buildTime: string;
-    /**
-     * Build configuration used.
-     */
-    config: Required<BuildConfig>;
-}
-/**
- * Build a tool UI template into a universal HTML document.
- *
- * The output HTML:
- * - Works on ALL platforms (OpenAI, Claude, MCP Apps, Gemini, etc.)
- * - Includes FrontMCP Bridge that auto-detects the host at runtime
- * - Adapts communication protocol based on detected platform
- *
- * @example Basic usage
- * ```typescript
- * import { buildToolUI } from '@frontmcp/ui/build';
- *
- * const result = await buildToolUI({
- *   template: { template: WeatherWidget },
- *   toolName: 'get_weather',
- *   output: { temperature: 72, conditions: 'sunny' },
- * });
- *
- * // Upload to CDN - works everywhere
- * await uploadToCDN('widgets/get_weather.html', result.html);
- * ```
- *
- * @example With blocked network (for Claude Artifacts)
- * ```typescript
- * const result = await buildToolUI({
- *   template: { template: WeatherWidget },
- *   toolName: 'get_weather',
- *   config: { network: 'blocked' }, // Inlines all scripts
- * });
- * ```
- *
- * @example MCP server response
- * ```typescript
- * const result = await buildToolUI({ template, toolName, output });
- *
- * // In MCP server - choose MIME type based on client
- * const mimeType = isOpenAIClient(clientInfo)
- *   ? result.mimeTypes.openai  // 'text/html+skybridge'
- *   : result.mimeTypes.mcp;    // 'text/html+mcp'
- *
- * return { content: [{ type: mimeType, data: result.html }] };
- * ```
- */
-export declare function buildToolUI<In = unknown, Out = unknown>(options: BuildOptions<In, Out>): Promise<BuildResult>;
-/**
- * Options for building a static widget that reads from host at runtime.
- */
-export interface StaticWidgetOptions<In = unknown, Out = unknown> {
-    /**
-     * UI template configuration.
-     */
-    template: UITemplateConfig<In, Out>;
-    /**
-     * Name of the tool this UI is for.
-     */
-    toolName: string;
-    /**
-     * Theme configuration override.
-     */
-    theme?: DeepPartial<ThemeConfig>;
-    /**
-     * Build configuration.
-     */
-    config?: BuildConfig;
-    /**
-     * Title for the HTML document.
-     */
-    title?: string;
-}
-/**
- * Build a static widget that reads data from the host platform at runtime.
- *
- * Unlike buildToolUI which pre-renders with data, this creates a widget
- * that waits for data from the host platform via the FrontMCP Bridge.
- *
- * @example
- * ```typescript
- * import { buildStaticWidget } from '@frontmcp/ui/build';
- *
- * const widget = await buildStaticWidget({
- *   template: {
- *     template: (ctx) => `<div id="weather">${ctx.output?.temperature || 'Loading...'}</div>`,
- *   },
- *   toolName: 'get_weather',
- * });
- *
- * // This widget will receive data via FrontMCP Bridge
- * await uploadToCDN('widgets/get_weather.html', widget.html);
- * ```
- */
-export declare function buildStaticWidget<In = unknown, Out = unknown>(options: StaticWidgetOptions<In, Out>): Promise<BuildResult>;
-/**
- * @deprecated Use BuildConfig instead
- */
-export type BuildTargetPlatform = 'chatgpt' | 'claude' | 'mcp-apps' | 'universal';
-/**
- * @deprecated Use BuildOptions with config instead
- */
-export interface MultiBuildOptions<In = unknown, Out = unknown> extends Omit<BuildOptions<In, Out>, 'platform'> {
-    platforms?: BuildTargetPlatform[];
-}
-/**
- * @deprecated Use BuildResult instead (same result for all platforms now)
- */
-export interface MultiBuildResult {
-    bundles: Record<string, BuildResult>;
-    totalTime: number;
-}
-/**
- * @deprecated Use buildToolUI with config.network instead
- */
-export declare function buildToolUIMulti<In = unknown, Out = unknown>(options: MultiBuildOptions<In, Out>): Promise<MultiBuildResult>;
-export { createTemplateHelpers } from '../runtime/wrapper';
-export type { UITemplateConfig, UITemplate, TemplateContext, TemplateHelpers, TemplateBuilderFn, UIContentSecurityPolicy, WidgetServingMode, WidgetDisplayMode, } from '../types';
-export type { ThemeConfig, PlatformCapabilities, DeepPartial } from '../theme';
-export { DEFAULT_THEME, OPENAI_PLATFORM, CLAUDE_PLATFORM } from '../theme';
-export { buildToolWidgetManifest, batchBuildWidgets, detectUIType, isFilePathTemplate, buildCSPForType, buildCSPMetaContent, getRendererAssets, buildToolResponseMeta, getOutputModeForClient, buildFileComponent, buildFileComponents, needsFileComponentRebuild, getCachedFileComponent, getPlatformFromClientInfo, } from './widget-manifest';
-export type { BatchBuildOptions, BatchBuildResult, BuildMetaOptions, FileComponentBuildOptions, FileComponentBuildResult, } from './widget-manifest';
-export type { UIType, BundlingMode, DisplayMode, OutputMode, CSPDirectives, RendererAssets, WidgetManifest, WidgetConfig, BuildManifestResult, BuildManifestOptions, UIMetaFields, OpenAIMetaFields, ToolResponseMeta, RuntimePayload, } from '../types/ui-runtime';
-export { DEFAULT_CSP_BY_TYPE, DEFAULT_RENDERER_ASSETS, isUIType, isBundlingMode, isDisplayMode, isResourceMode, isOutputMode, } from '../types/ui-runtime';
-export type { ResourceMode, CDNResource } from '../types/ui-runtime';
-export { REACT_CDN, REACT_DOM_CDN, MARKED_CDN, HANDLEBARS_CDN, MDX_RUNTIME_CDN, TAILWIND_CDN, CLOUDFLARE_CDN, getDefaultAssets, buildCDNScriptTag, buildScriptsForUIType, buildTailwindScriptTag, hasInlineScripts, getURLsToPreFetch, getTailwindForPlatform, buildCloudflareStylesheetTag, buildCloudflareScriptTag, buildCDNInfoForUIType, } from './cdn-resources';
-export type { CDNInfo, CDNPlatform } from './cdn-resources';
-//# sourceMappingURL=index.d.ts.map

package/esm/build/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/build/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAmB,MAAM,UAAU,CAAC;AAClE,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAUzD;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;AAE7C;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;IAEzB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,YAAY,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,OAAO;IACvD;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAEpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,EAAE,CAAC;IAEX;;OAEG;IACH,MAAM,CAAC,EAAE,GAAG,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;IAEjC;;;OAGG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAGf,sCAAsC;IACtC,WAAW,CAAC,EAAE,EAAE,CAAC;IACjB,uCAAuC;IACvC,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,qDAAqD;IACrD,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,8CAA8C;IAC9C,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,kCAAkC;IAClC,MAAM,EAAE,qBAAqB,CAAC;IAC9B,mDAAmD;IACnD,GAAG,EAAE,eAAe,CAAC;IACrB,8BAA8B;IAC9B,IAAI,EAAE,WAAW,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,SAAS,EAAE,SAAS,CAAC;IAErB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;CAC/B;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAsB,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,OAAO,EAC3D,OAAO,EAAE,YAAY,CAAC,EAAE,EAAE,GAAG,CAAC,GAC7B,OAAO,CAAC,WAAW,CAAC,CAyEtB;AA0HD;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,OAAO;IAC9D;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAEpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;IAEjC;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,iBAAiB,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,OAAO,EACjE,OAAO,EAAE,mBAAmB,CAAC,EAAE,EAAE,GAAG,CAAC,GACpC,OAAO,CAAC,WAAW,CAAC,CAatB;AAMD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,WAAW,CAAC;AAElF;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,OAAO,CAC5D,SAAQ,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC;IAC/C,SAAS,CAAC,EAAE,mBAAmB,EAAE,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACrC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,OAAO,EAChE,OAAO,EAAE,iBAAiB,CAAC,EAAE,EAAE,GAAG,CAAC,GAClC,OAAO,CAAC,gBAAgB,CAAC,CAoB3B;AAMD,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,YAAY,EACV,gBAAgB,EAChB,UAAU,EACV,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,UAAU,CAAC;AAClB,YAAY,EAAE,WAAW,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAM3E,OAAO,EAEL,uBAAuB,EACvB,iBAAiB,EAEjB,YAAY,EACZ,kBAAkB,EAElB,eAAe,EACf,mBAAmB,EAEnB,iBAAiB,EAEjB,qBAAqB,EACrB,sBAAsB,EAEtB,kBAAkB,EAClB,mBAAmB,EACnB,yBAAyB,EACzB,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EACV,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,EAEhB,yBAAyB,EACzB,wBAAwB,GACzB,MAAM,mBAAmB,CAAC;AAG3B,YAAY,EACV,MAAM,EACN,YAAY,EACZ,WAAW,EACX,UAAU,EACV,aAAa,EACb,cAAc,EACd,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,oBAAoB,EAEpB,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAEhB,cAAc,GACf,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,mBAAmB,EACnB,uBAAuB,EACvB,QAAQ,EACR,cAAc,EACd,aAAa,EACb,cAAc,EACd,YAAY,GACb,MAAM,qBAAqB,CAAC;AAE7B,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAMrE,OAAO,EAEL,SAAS,EACT,aAAa,EACb,UAAU,EACV,cAAc,EACd,eAAe,EACf,YAAY,EAEZ,cAAc,EAEd,gBAAgB,EAChB,iBAAiB,EACjB,qBAAqB,EACrB,sBAAsB,EACtB,gBAAgB,EAChB,iBAAiB,EAEjB,sBAAsB,EACtB,4BAA4B,EAC5B,wBAAwB,EAExB,qBAAqB,GACtB,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC"}