@frontmcp/ui 0.5.0 → 0.6.0

package/widgets/progress.d.ts

@@ -0,0 +1,133 @@
+/**
+ * Progress and Status Widgets
+ *
+ * Components for displaying progress, loading states, and status information.
+ */
+/**
+ * Progress bar options
+ */
+export interface ProgressBarOptions {
+    /** Progress value (0-100) */
+    value: number;
+    /** Show percentage text */
+    showLabel?: boolean;
+    /** Label position */
+    labelPosition?: 'inside' | 'outside' | 'none';
+    /** Size */
+    size?: 'sm' | 'md' | 'lg';
+    /** Color variant */
+    variant?: 'primary' | 'success' | 'warning' | 'danger' | 'info';
+    /** Animated (striped) */
+    animated?: boolean;
+    /** Additional CSS classes */
+    className?: string;
+    /** Custom label */
+    label?: string;
+}
+/**
+ * Build a progress bar
+ */
+export declare function progressBar(options: ProgressBarOptions): string;
+/**
+ * Step definition
+ */
+export interface Step {
+    /** Step label */
+    label: string;
+    /** Step description */
+    description?: string;
+    /** Step status */
+    status: 'completed' | 'current' | 'upcoming';
+    /** Icon (optional) */
+    icon?: string;
+    /** URL for clickable steps */
+    href?: string;
+}
+/**
+ * Multi-step progress options
+ */
+export interface StepProgressOptions {
+    /** Steps */
+    steps: Step[];
+    /** Orientation */
+    orientation?: 'horizontal' | 'vertical';
+    /** Connector style */
+    connector?: 'line' | 'dashed' | 'none';
+    /** Additional CSS classes */
+    className?: string;
+}
+/**
+ * Build a multi-step progress indicator
+ */
+export declare function stepProgress(options: StepProgressOptions): string;
+/**
+ * Circular progress options
+ */
+export interface CircularProgressOptions {
+    /** Progress value (0-100) */
+    value: number;
+    /** Size in pixels */
+    size?: number;
+    /** Stroke width */
+    strokeWidth?: number;
+    /** Color variant */
+    variant?: 'primary' | 'success' | 'warning' | 'danger';
+    /** Show percentage */
+    showLabel?: boolean;
+    /** Custom label */
+    label?: string;
+    /** Additional CSS classes */
+    className?: string;
+}
+/**
+ * Build a circular progress indicator
+ */
+export declare function circularProgress(options: CircularProgressOptions): string;
+/**
+ * Status indicator options
+ */
+export interface StatusIndicatorOptions {
+    /** Status state */
+    status: 'online' | 'offline' | 'busy' | 'away' | 'loading' | 'error' | 'success';
+    /** Status label */
+    label?: string;
+    /** Size */
+    size?: 'sm' | 'md' | 'lg';
+    /** Show pulse animation */
+    pulse?: boolean;
+    /** Additional CSS classes */
+    className?: string;
+}
+/**
+ * Build a status indicator
+ */
+export declare function statusIndicator(options: StatusIndicatorOptions): string;
+/**
+ * Skeleton loader options
+ */
+export interface SkeletonOptions {
+    /** Skeleton type */
+    type?: 'text' | 'circle' | 'rect' | 'card';
+    /** Width (CSS value) */
+    width?: string;
+    /** Height (CSS value) */
+    height?: string;
+    /** Number of text lines */
+    lines?: number;
+    /** Animated */
+    animated?: boolean;
+    /** Additional CSS classes */
+    className?: string;
+}
+/**
+ * Build a skeleton loader
+ */
+export declare function skeleton(options?: SkeletonOptions): string;
+/**
+ * Build a content skeleton with avatar and text
+ */
+export declare function contentSkeleton(options?: {
+    animated?: boolean;
+    className?: string;
+}): string;
+//# sourceMappingURL=progress.d.ts.map

package/widgets/progress.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"progress.d.ts","sourceRoot":"","sources":["../../src/widgets/progress.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAQH;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,2BAA2B;IAC3B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,qBAAqB;IACrB,aAAa,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;IAC9C,WAAW;IACX,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAC1B,oBAAoB;IACpB,OAAO,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;IAChE,yBAAyB;IACzB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mBAAmB;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAyF/D;AAMD;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB;IAClB,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,UAAU,CAAC;IAC7C,sBAAsB;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8BAA8B;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,YAAY;IACZ,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,kBAAkB;IAClB,WAAW,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC;IACxC,sBAAsB;IACtB,SAAS,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;IACvC,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,MAAM,CAkHjE;AAMD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,qBAAqB;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oBAAoB;IACpB,OAAO,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;IACvD,sBAAsB;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,mBAAmB;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,MAAM,CAgDzE;AAMD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,mBAAmB;IACnB,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;IACjF,mBAAmB;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW;IACX,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAC1B,2BAA2B;IAC3B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,MAAM,CAmCvE;AAMD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;IAC3C,wBAAwB;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yBAAyB;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2BAA2B;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,eAAe;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,OAAO,GAAE,eAAoB,GAAG,MAAM,CAyC9D;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,OAAO,GAAE;IAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAO,GAAG,MAAM,CAWhG"}

package/widgets/resource.d.ts

@@ -0,0 +1,163 @@
+/**
+ * OpenAI App SDK Resource Widgets
+ *
+ * Components for displaying resources in OpenAI's App SDK format.
+ * These widgets are designed to work with OpenAI Canvas and similar interfaces.
+ */
+import { type CardOptions } from '../components/card';
+import { type BadgeVariant } from '../components/badge';
+/**
+ * Resource type identifiers
+ */
+export type ResourceType = 'document' | 'image' | 'code' | 'data' | 'file' | 'link' | 'user' | 'event' | 'message' | 'task' | 'custom';
+/**
+ * Resource metadata
+ */
+export interface ResourceMeta {
+    /** Creation timestamp */
+    createdAt?: string | Date;
+    /** Last modified timestamp */
+    updatedAt?: string | Date;
+    /** Author/creator */
+    author?: string;
+    /** File size (bytes) */
+    size?: number;
+    /** MIME type */
+    mimeType?: string;
+    /** Tags */
+    tags?: string[];
+    /** Custom metadata */
+    [key: string]: unknown;
+}
+/**
+ * Resource action
+ */
+export interface ResourceAction {
+    /** Action label */
+    label: string;
+    /** Action icon */
+    icon?: string;
+    /** Action URL */
+    href?: string;
+    /** HTMX attributes */
+    htmx?: {
+        get?: string;
+        post?: string;
+        delete?: string;
+        target?: string;
+        swap?: string;
+        confirm?: string;
+    };
+    /** Variant */
+    variant?: 'primary' | 'secondary' | 'danger' | 'ghost';
+    /** Disabled */
+    disabled?: boolean;
+}
+/**
+ * Base resource options
+ */
+export interface ResourceOptions {
+    /** Resource type */
+    type: ResourceType;
+    /** Resource title */
+    title: string;
+    /** Resource description */
+    description?: string;
+    /** Resource icon */
+    icon?: string;
+    /** Resource thumbnail URL */
+    thumbnail?: string;
+    /** Resource URL */
+    url?: string;
+    /** Resource metadata */
+    meta?: ResourceMeta;
+    /** Resource status */
+    status?: {
+        label: string;
+        variant: BadgeVariant;
+    };
+    /** Available actions */
+    actions?: ResourceAction[];
+    /** Additional CSS classes */
+    className?: string;
+    /** Card options */
+    cardOptions?: Partial<CardOptions>;
+}
+/**
+ * Build a resource widget
+ */
+export declare function resourceWidget(options: ResourceOptions): string;
+/**
+ * Resource list options
+ */
+export interface ResourceListOptions {
+    /** Resources to display */
+    resources: ResourceOptions[];
+    /** List title */
+    title?: string;
+    /** Empty state message */
+    emptyMessage?: string;
+    /** Grid or list layout */
+    layout?: 'list' | 'grid';
+    /** Grid columns */
+    columns?: 1 | 2 | 3 | 4;
+    /** Additional CSS classes */
+    className?: string;
+    /** Show load more button */
+    showLoadMore?: boolean;
+    /** Load more URL */
+    loadMoreUrl?: string;
+}
+/**
+ * Build a resource list widget
+ */
+export declare function resourceList(options: ResourceListOptions): string;
+/**
+ * Build a compact resource item (for inline display)
+ */
+export declare function resourceItem(options: Omit<ResourceOptions, 'cardOptions'>): string;
+/**
+ * Code preview options
+ */
+export interface CodePreviewOptions {
+    /** Code content */
+    code: string;
+    /** Language */
+    language?: string;
+    /** Filename */
+    filename?: string;
+    /** Show line numbers */
+    lineNumbers?: boolean;
+    /** Max height */
+    maxHeight?: string;
+    /** Copy button */
+    showCopy?: boolean;
+    /** Additional CSS classes */
+    className?: string;
+}
+/**
+ * Build a code preview widget
+ */
+export declare function codePreview(options: CodePreviewOptions): string;
+/**
+ * Image preview options
+ */
+export interface ImagePreviewOptions {
+    /** Image URL */
+    src: string;
+    /** Alt text */
+    alt: string;
+    /** Caption */
+    caption?: string;
+    /** Max height */
+    maxHeight?: string;
+    /** Clickable (opens in new tab) */
+    clickable?: boolean;
+    /** Additional CSS classes */
+    className?: string;
+}
+/**
+ * Build an image preview widget
+ */
+export declare function imagePreview(options: ImagePreviewOptions): string;
+//# sourceMappingURL=resource.d.ts.map

package/widgets/resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../../src/widgets/resource.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAQ,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAS,KAAK,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAO/D;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB,UAAU,GACV,OAAO,GACP,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,OAAO,GACP,SAAS,GACT,MAAM,GACN,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,yBAAyB;IACzB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,8BAA8B;IAC9B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,qBAAqB;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,sBAAsB;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,mBAAmB;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iBAAiB;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sBAAsB;IACtB,IAAI,CAAC,EAAE;QACL,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,cAAc;IACd,OAAO,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,OAAO,CAAC;IACvD,eAAe;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,oBAAoB;IACpB,IAAI,EAAE,YAAY,CAAC;IACnB,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,2BAA2B;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mBAAmB;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wBAAwB;IACxB,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,sBAAsB;IACtB,MAAM,CAAC,EAAE;QACP,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,YAAY,CAAC;KACvB,CAAC;IACF,wBAAwB;IACxB,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mBAAmB;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;CACpC;AAyED;;GAEG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,eAAe,GAAG,MAAM,CAgI/D;AAMD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,2BAA2B;IAC3B,SAAS,EAAE,eAAe,EAAE,CAAC;IAC7B,iBAAiB;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0BAA0B;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,0BAA0B;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,mBAAmB;IACnB,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACxB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4BAA4B;IAC5B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,oBAAoB;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,MAAM,CAoDjE;AAMD;;GAEG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG,MAAM,CA6BlF;AAMD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,eAAe;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wBAAwB;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kBAAkB;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAkE/D;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,gBAAgB;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,eAAe;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,cAAc;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mCAAmC;IACnC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,MAAM,CAsBjE"}

package/src/adapters/index.d.ts

@@ -1,10 +0,0 @@
-/**
- * @frontmcp/ui Adapters
- *
- * Platform-specific adapters for building UI metadata.
- * These adapters are SDK-independent and can be used by external systems
- * like AgentLink without requiring @frontmcp/sdk.
- *
- * @packageDocumentation
- */
-export { type AIPlatformType, type UIMetadata, type BuildUIMetaOptions, type BuildToolDiscoveryMetaOptions, buildUIMeta, buildToolDiscoveryMeta, buildOpenAICSP, } from './platform-meta';

package/src/adapters/index.js

@@ -1,18 +0,0 @@
-"use strict";
-/**
- * @frontmcp/ui Adapters
- *
- * Platform-specific adapters for building UI metadata.
- * These adapters are SDK-independent and can be used by external systems
- * like AgentLink without requiring @frontmcp/sdk.
- *
- * @packageDocumentation
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildOpenAICSP = exports.buildToolDiscoveryMeta = exports.buildUIMeta = void 0;
-var platform_meta_1 = require("./platform-meta");
-// Builder Functions
-Object.defineProperty(exports, "buildUIMeta", { enumerable: true, get: function () { return platform_meta_1.buildUIMeta; } });
-Object.defineProperty(exports, "buildToolDiscoveryMeta", { enumerable: true, get: function () { return platform_meta_1.buildToolDiscoveryMeta; } });
-Object.defineProperty(exports, "buildOpenAICSP", { enumerable: true, get: function () { return platform_meta_1.buildOpenAICSP; } });
-//# sourceMappingURL=index.js.map

package/src/adapters/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/adapters/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AAEH,iDAWyB;AAJvB,oBAAoB;AACpB,4GAAA,WAAW,OAAA;AACX,uHAAA,sBAAsB,OAAA;AACtB,+GAAA,cAAc,OAAA","sourcesContent":["/**\n * @frontmcp/ui Adapters\n *\n * Platform-specific adapters for building UI metadata.\n * These adapters are SDK-independent and can be used by external systems\n * like AgentLink without requiring @frontmcp/sdk.\n *\n * @packageDocumentation\n */\n\nexport {\n  // Platform Types\n  type AIPlatformType,\n  // Metadata Types\n  type UIMetadata,\n  type BuildUIMetaOptions,\n  type BuildToolDiscoveryMetaOptions,\n  // Builder Functions\n  buildUIMeta,\n  buildToolDiscoveryMeta,\n  buildOpenAICSP,\n} from './platform-meta';\n"]}

package/src/adapters/platform-meta.d.ts

@@ -1,165 +0,0 @@
-/**
- * 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
- */
-import type { UITemplateConfig, UIContentSecurityPolicy } from '../types';
-/**
- * Supported AI platform types.
- * Used to determine which metadata format to generate.
- */
-export type AIPlatformType = 'openai' | 'claude' | 'gemini' | 'cursor' | 'continue' | 'cody' | 'generic-mcp' | 'ext-apps' | 'unknown';
-/**
- * UI metadata to include in tool response _meta field.
- * Contains both universal fields and platform-specific annotations.
- */
-export interface UIMetadata {
-    /** Inline rendered HTML (universal) */
-    'ui/html'?: string;
-    /** MIME type for the HTML content */
-    'ui/mimeType'?: string;
-    /** Widget token for authenticated operations */
-    'ui/widgetToken'?: string;
-    /** Direct URL to widget (for direct-url serving mode) */
-    'ui/directUrl'?: string;
-    /** Renderer type for the widget (html, react, mdx, markdown, auto) */
-    'ui/type'?: string;
-    /** Manifest URI for accessing widget configuration */
-    'ui/manifestUri'?: string;
-    /** Hash of the widget content for cache validation */
-    'ui/contentHash'?: string;
-    /** Required renderer assets for lazy loading */
-    'ui/requiredRenderers'?: string[];
-    /** OpenAI: Resource URI for widget template */
-    'openai/outputTemplate'?: string;
-    /** OpenAI: Whether widget can invoke tools */
-    'openai/widgetAccessible'?: boolean;
-    /** OpenAI: Whether tool result can produce a widget (CRITICAL for ChatGPT) */
-    'openai/resultCanProduceWidget'?: boolean;
-    /** OpenAI: CSP configuration */
-    'openai/widgetCSP'?: {
-        connect_domains?: string[];
-        resource_domains?: string[];
-    };
-    /** OpenAI: Display mode preference */
-    'openai/displayMode'?: string;
-    /** OpenAI: Widget description */
-    'openai/widgetDescription'?: string;
-    /** OpenAI: Status text while tool is executing */
-    'openai/toolInvocation/invoking'?: string;
-    /** OpenAI: Status text after tool execution completes */
-    'openai/toolInvocation/invoked'?: string;
-    /** Claude: Widget description */
-    'claude/widgetDescription'?: string;
-    /** Gemini: Widget description */
-    'gemini/widgetDescription'?: string;
-    /** IDE: Resource URI for widget template */
-    'ide/outputTemplate'?: string;
-    /** IDE: Widget description */
-    'ide/widgetDescription'?: string;
-    /** MCP Apps: Resource URI for UI template */
-    'ui/resourceUri'?: string;
-    /** MCP Apps: CSP configuration */
-    'ui/csp'?: {
-        connectDomains?: string[];
-        resourceDomains?: string[];
-    };
-    /** MCP Apps: Dedicated sandbox domain */
-    'ui/domain'?: string;
-    /** MCP Apps: Whether to show border around UI */
-    'ui/prefersBorder'?: boolean;
-    /** MCP Apps: Display mode */
-    'ui/displayMode'?: 'inline' | 'fullscreen' | 'pip';
-    /** Allow additional platform-specific fields */
-    [key: string]: unknown;
-}
-/**
- * Options for building UI metadata.
- */
-export interface BuildUIMetaOptions<In = unknown, Out = unknown> {
-    /** Tool UI configuration */
-    uiConfig: UITemplateConfig<In, Out>;
-    /** Detected platform type */
-    platformType: AIPlatformType;
-    /** Rendered HTML content */
-    html: string;
-    /** Widget access token */
-    token?: string;
-    /** Direct URL for widget serving */
-    directUrl?: string;
-    /** Renderer type for the widget (html, react, mdx, markdown, auto) */
-    rendererType?: string;
-    /** Hash of the widget content for cache validation */
-    contentHash?: string;
-    /** Manifest URI for accessing widget configuration */
-    manifestUri?: string;
-}
-/**
- * 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>',
- * });
- * ```
- */
-export declare function buildUIMeta<In = unknown, Out = unknown>(options: BuildUIMetaOptions<In, Out>): UIMetadata;
-/**
- * Build OpenAI CSP format.
- */
-export declare function buildOpenAICSP(csp: UIContentSecurityPolicy): {
-    connect_domains?: string[];
-    resource_domains?: string[];
-};
-/**
- * Build metadata for tool discovery (tools/list response).
- * This includes fields that should be present at discovery time,
- * not in individual tool call responses.
- *
- * @example
- * ```typescript
- * import { buildToolDiscoveryMeta } from '@frontmcp/ui/adapters';
- *
- * const toolMeta = buildToolDiscoveryMeta({
- *   uiConfig: { template: MyWidget, widgetAccessible: true },
- *   platformType: 'openai',
- *   staticWidgetUri: 'ui://widget/my_tool.html',
- * });
- *
- * // Use in tools/list response
- * const tool = {
- *   name: 'my_tool',
- *   description: '...',
- *   inputSchema: {...},
- *   _meta: toolMeta,
- * };
- * ```
- */
-export interface BuildToolDiscoveryMetaOptions<In = unknown, Out = unknown> {
-    /** Tool UI configuration */
-    uiConfig: UITemplateConfig<In, Out>;
-    /** Detected platform type */
-    platformType: AIPlatformType;
-    /** Static widget URI (e.g., ui://widget/my_tool.html) */
-    staticWidgetUri: string;
-}
-/**
- * Build tool discovery metadata (for tools/list response).
- */
-export declare function buildToolDiscoveryMeta<In = unknown, Out = unknown>(options: BuildToolDiscoveryMetaOptions<In, Out>): UIMetadata;