@frontmcp/sdk 0.4.1 → 0.5.0

package/src/mcp-apps/schemas.d.ts

@@ -0,0 +1,403 @@
+/**
+ * @file schemas.ts
+ * @description Zod schemas for MCP Apps specification validation.
+ *
+ * @module @frontmcp/sdk/mcp-apps/schemas
+ */
+import { z } from 'zod';
+/**
+ * MCP Apps MIME type schema.
+ */
+export declare const McpAppsMimeTypeSchema: z.ZodLiteral<"text/html+mcp">;
+/**
+ * Display mode schema.
+ */
+export declare const McpAppsDisplayModeSchema: z.ZodEnum<{
+    inline: "inline";
+    fullscreen: "fullscreen";
+    pip: "pip";
+}>;
+/**
+ * Platform type schema.
+ */
+export declare const McpAppsPlatformSchema: z.ZodEnum<{
+    web: "web";
+    desktop: "desktop";
+    mobile: "mobile";
+}>;
+/**
+ * Theme schema.
+ */
+export declare const ThemeSchema: z.ZodEnum<{
+    light: "light";
+    dark: "dark";
+}>;
+/**
+ * Content Security Policy schema.
+ */
+export declare const McpAppsCSPSchema: z.ZodObject<{
+    connectDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    resourceDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strict>;
+/**
+ * UI Resource metadata schema.
+ */
+export declare const UIResourceMetaSchema: z.ZodObject<{
+    csp: z.ZodOptional<z.ZodObject<{
+        connectDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        resourceDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>;
+    domain: z.ZodOptional<z.ZodString>;
+    prefersBorder: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+/**
+ * UI Resource schema.
+ */
+export declare const UIResourceSchema: z.ZodObject<{
+    uri: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    mimeType: z.ZodLiteral<"text/html+mcp">;
+    _meta: z.ZodOptional<z.ZodObject<{
+        ui: z.ZodOptional<z.ZodObject<{
+            csp: z.ZodOptional<z.ZodObject<{
+                connectDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                resourceDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            }, z.core.$strict>>;
+            domain: z.ZodOptional<z.ZodString>;
+            prefersBorder: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strict>>;
+    }, z.core.$strip>>;
+}, z.core.$strict>;
+/**
+ * Device capabilities schema.
+ */
+export declare const DeviceCapabilitiesSchema: z.ZodObject<{
+    touch: z.ZodOptional<z.ZodBoolean>;
+    hover: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+/**
+ * Safe area insets schema.
+ */
+export declare const SafeAreaInsetsSchema: z.ZodObject<{
+    top: z.ZodNumber;
+    right: z.ZodNumber;
+    bottom: z.ZodNumber;
+    left: z.ZodNumber;
+}, z.core.$strict>;
+/**
+ * Viewport info schema.
+ */
+export declare const ViewportInfoSchema: z.ZodObject<{
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+    maxHeight: z.ZodOptional<z.ZodNumber>;
+    maxWidth: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+/**
+ * Tool info schema.
+ */
+export declare const ToolInfoSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    tool: z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        inputSchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>;
+}, z.core.$strict>;
+/**
+ * Host context schema.
+ */
+export declare const McpAppsHostContextSchema: z.ZodObject<{
+    toolInfo: z.ZodOptional<z.ZodObject<{
+        id: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        tool: z.ZodObject<{
+            name: z.ZodString;
+            description: z.ZodOptional<z.ZodString>;
+            inputSchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        }, z.core.$strip>;
+    }, z.core.$strict>>;
+    theme: z.ZodOptional<z.ZodEnum<{
+        light: "light";
+        dark: "dark";
+    }>>;
+    displayMode: z.ZodOptional<z.ZodEnum<{
+        inline: "inline";
+        fullscreen: "fullscreen";
+        pip: "pip";
+    }>>;
+    viewport: z.ZodOptional<z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        maxHeight: z.ZodOptional<z.ZodNumber>;
+        maxWidth: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    locale: z.ZodOptional<z.ZodString>;
+    timeZone: z.ZodOptional<z.ZodString>;
+    platform: z.ZodOptional<z.ZodEnum<{
+        web: "web";
+        desktop: "desktop";
+        mobile: "mobile";
+    }>>;
+    deviceCapabilities: z.ZodOptional<z.ZodObject<{
+        touch: z.ZodOptional<z.ZodBoolean>;
+        hover: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>>;
+    safeAreaInsets: z.ZodOptional<z.ZodObject<{
+        top: z.ZodNumber;
+        right: z.ZodNumber;
+        bottom: z.ZodNumber;
+        left: z.ZodNumber;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+/**
+ * JSON-RPC error schema.
+ */
+export declare const JsonRpcErrorSchema: z.ZodObject<{
+    code: z.ZodNumber;
+    message: z.ZodString;
+    data: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$strict>;
+/**
+ * JSON-RPC request schema.
+ */
+export declare const JsonRpcRequestSchema: z.ZodObject<{
+    jsonrpc: z.ZodLiteral<"2.0">;
+    id: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+    method: z.ZodString;
+    params: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$strict>;
+/**
+ * JSON-RPC response schema.
+ */
+export declare const JsonRpcResponseSchema: z.ZodObject<{
+    jsonrpc: z.ZodLiteral<"2.0">;
+    id: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+    result: z.ZodOptional<z.ZodUnknown>;
+    error: z.ZodOptional<z.ZodObject<{
+        code: z.ZodNumber;
+        message: z.ZodString;
+        data: z.ZodOptional<z.ZodUnknown>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+/**
+ * JSON-RPC notification schema.
+ */
+export declare const JsonRpcNotificationSchema: z.ZodObject<{
+    jsonrpc: z.ZodLiteral<"2.0">;
+    method: z.ZodString;
+    params: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$strict>;
+/**
+ * UI Initialize params schema.
+ */
+export declare const McpUiInitializeParamsSchema: z.ZodObject<{
+    protocolVersion: z.ZodString;
+    capabilities: z.ZodOptional<z.ZodObject<{
+        messages: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>;
+}, z.core.$strict>;
+/**
+ * UI Initialize result schema.
+ */
+export declare const McpUiInitializeResultSchema: z.ZodObject<{
+    protocolVersion: z.ZodString;
+    capabilities: z.ZodObject<{
+        extensions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>;
+    hostContext: z.ZodObject<{
+        toolInfo: z.ZodOptional<z.ZodObject<{
+            id: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+            tool: z.ZodObject<{
+                name: z.ZodString;
+                description: z.ZodOptional<z.ZodString>;
+                inputSchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            }, z.core.$strip>;
+        }, z.core.$strict>>;
+        theme: z.ZodOptional<z.ZodEnum<{
+            light: "light";
+            dark: "dark";
+        }>>;
+        displayMode: z.ZodOptional<z.ZodEnum<{
+            inline: "inline";
+            fullscreen: "fullscreen";
+            pip: "pip";
+        }>>;
+        viewport: z.ZodOptional<z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+            maxHeight: z.ZodOptional<z.ZodNumber>;
+            maxWidth: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>;
+        locale: z.ZodOptional<z.ZodString>;
+        timeZone: z.ZodOptional<z.ZodString>;
+        platform: z.ZodOptional<z.ZodEnum<{
+            web: "web";
+            desktop: "desktop";
+            mobile: "mobile";
+        }>>;
+        deviceCapabilities: z.ZodOptional<z.ZodObject<{
+            touch: z.ZodOptional<z.ZodBoolean>;
+            hover: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strict>>;
+        safeAreaInsets: z.ZodOptional<z.ZodObject<{
+            top: z.ZodNumber;
+            right: z.ZodNumber;
+            bottom: z.ZodNumber;
+            left: z.ZodNumber;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+/**
+ * Tool input params schema.
+ */
+export declare const McpUiToolInputParamsSchema: z.ZodObject<{
+    arguments: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, z.core.$strict>;
+/**
+ * Tool input partial params schema.
+ */
+export declare const McpUiToolInputPartialParamsSchema: z.ZodObject<{
+    argumentsDelta: z.ZodString;
+}, z.core.$strict>;
+/**
+ * Tool result content item schema.
+ */
+export declare const ToolResultContentItemSchema: z.ZodObject<{
+    type: z.ZodEnum<{
+        image: "image";
+        resource: "resource";
+        text: "text";
+    }>;
+    text: z.ZodOptional<z.ZodString>;
+    data: z.ZodOptional<z.ZodString>;
+    mimeType: z.ZodOptional<z.ZodString>;
+    uri: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Tool result params schema.
+ */
+export declare const McpUiToolResultParamsSchema: z.ZodObject<{
+    content: z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<{
+            image: "image";
+            resource: "resource";
+            text: "text";
+        }>;
+        text: z.ZodOptional<z.ZodString>;
+        data: z.ZodOptional<z.ZodString>;
+        mimeType: z.ZodOptional<z.ZodString>;
+        uri: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    structuredContent: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strict>;
+/**
+ * Tool cancelled params schema.
+ */
+export declare const McpUiToolCancelledParamsSchema: z.ZodObject<{
+    reason: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * Size change params schema.
+ */
+export declare const McpUiSizeChangeParamsSchema: z.ZodObject<{
+    viewport: z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        maxHeight: z.ZodOptional<z.ZodNumber>;
+        maxWidth: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+/**
+ * Host context change params schema.
+ */
+export declare const McpUiHostContextChangeParamsSchema: z.ZodObject<{
+    changes: z.ZodObject<{
+        toolInfo: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+            id: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+            tool: z.ZodObject<{
+                name: z.ZodString;
+                description: z.ZodOptional<z.ZodString>;
+                inputSchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            }, z.core.$strip>;
+        }, z.core.$strict>>>;
+        theme: z.ZodOptional<z.ZodOptional<z.ZodEnum<{
+            light: "light";
+            dark: "dark";
+        }>>>;
+        displayMode: z.ZodOptional<z.ZodOptional<z.ZodEnum<{
+            inline: "inline";
+            fullscreen: "fullscreen";
+            pip: "pip";
+        }>>>;
+        viewport: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+            maxHeight: z.ZodOptional<z.ZodNumber>;
+            maxWidth: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>>;
+        locale: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        timeZone: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        platform: z.ZodOptional<z.ZodOptional<z.ZodEnum<{
+            web: "web";
+            desktop: "desktop";
+            mobile: "mobile";
+        }>>>;
+        deviceCapabilities: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+            touch: z.ZodOptional<z.ZodBoolean>;
+            hover: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strict>>>;
+        safeAreaInsets: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+            top: z.ZodNumber;
+            right: z.ZodNumber;
+            bottom: z.ZodNumber;
+            left: z.ZodNumber;
+        }, z.core.$strict>>>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+/**
+ * Open link params schema.
+ */
+export declare const McpUiOpenLinkParamsSchema: z.ZodObject<{
+    url: z.ZodString;
+}, z.core.$strict>;
+/**
+ * Message params schema.
+ */
+export declare const McpUiMessageParamsSchema: z.ZodObject<{
+    content: z.ZodString;
+}, z.core.$strict>;
+/**
+ * MCP Apps extension capability schema.
+ */
+export declare const McpAppsExtensionCapabilitySchema: z.ZodObject<{
+    mimeTypes: z.ZodArray<z.ZodLiteral<"text/html+mcp">>;
+}, z.core.$strict>;
+/**
+ * Tool UI metadata schema.
+ */
+export declare const ToolUIMetaSchema: z.ZodObject<{
+    'ui/resourceUri': z.ZodOptional<z.ZodString>;
+    'ui/mimeType': z.ZodOptional<z.ZodLiteral<"text/html+mcp">>;
+}, z.core.$loose>;
+/**
+ * Validate a UI resource URI.
+ */
+export declare function isValidUIResourceUri(uri: string): boolean;
+/**
+ * Validate MCP Apps protocol version.
+ */
+export declare function isValidProtocolVersion(version: string): boolean;
+/**
+ * Parse and validate UI resource.
+ */
+export declare function parseUIResource(data: unknown): z.infer<typeof UIResourceSchema> | null;
+/**
+ * Parse and validate host context.
+ */
+export declare function parseHostContext(data: unknown): z.infer<typeof McpAppsHostContextSchema> | null;
+/**
+ * Default protocol version.
+ */
+export declare const DEFAULT_PROTOCOL_VERSION: "2025-01-01";