@frontmcp/sdk 0.6.3 → 0.7.2

package/mcp-apps/types.d.ts

@@ -1,323 +0,0 @@
-/**
- * @file types.ts
- * @description MCP Apps specification types.
- *
- * Implements types from the MCP Apps extension specification:
- * https://github.com/modelcontextprotocol/ext-apps/blob/main/specification/draft/apps.mdx
- *
- * @module @frontmcp/sdk/mcp-apps/types
- */
-/**
- * MCP Apps content MIME type.
- * MVP specification supports only HTML5 documents.
- */
-export declare const MCP_APPS_MIME_TYPE: "text/html+mcp";
-/**
- * Supported MIME types for MCP Apps resources.
- */
-export type McpAppsMimeType = typeof MCP_APPS_MIME_TYPE;
-/**
- * Content Security Policy configuration for UI resources.
- * Hosts construct CSP headers from these declared domains.
- */
-export interface McpAppsCSP {
-    /** Domains allowed for network requests (fetch, XHR, WebSocket) */
-    connectDomains?: string[];
-    /** Domains allowed for static assets (images, scripts, fonts) */
-    resourceDomains?: string[];
-}
-/**
- * UI Resource metadata as defined in MCP Apps spec.
- * Included in `_meta.ui` field of resource declarations.
- */
-export interface UIResourceMeta {
-    /** Content Security Policy configuration */
-    csp?: McpAppsCSP;
-    /** Dedicated sandbox origin for this resource */
-    domain?: string;
-    /** Whether host should render visual boundary around UI */
-    prefersBorder?: boolean;
-}
-/**
- * Complete UI Resource declaration for MCP Apps.
- */
-export interface UIResource {
-    /** Resource URI (must start with "ui://") */
-    uri: string;
-    /** Human-readable display name */
-    name: string;
-    /** Optional description */
-    description?: string;
-    /** MIME type - must be "text/html+mcp" for MVP */
-    mimeType: McpAppsMimeType;
-    /** UI-specific metadata */
-    _meta?: {
-        ui?: UIResourceMeta;
-    };
-}
-/**
- * Display modes for UI rendering.
- */
-export type McpAppsDisplayMode = 'inline' | 'fullscreen' | 'pip';
-/**
- * Platform types for host environment.
- */
-export type McpAppsPlatform = 'web' | 'desktop' | 'mobile';
-/**
- * Device capability flags.
- */
-export interface DeviceCapabilities {
-    /** Touch input available */
-    touch?: boolean;
-    /** Hover interactions available */
-    hover?: boolean;
-}
-/**
- * Safe area insets for device screens.
- */
-export interface SafeAreaInsets {
-    top: number;
-    right: number;
-    bottom: number;
-    left: number;
-}
-/**
- * Viewport dimensions.
- */
-export interface ViewportInfo {
-    width: number;
-    height: number;
-    maxHeight?: number;
-    maxWidth?: number;
-}
-/**
- * Tool information passed to UI.
- */
-export interface ToolInfo {
-    /** Request ID for this tool invocation */
-    id?: string | number;
-    /** Tool definition */
-    tool: {
-        name: string;
-        description?: string;
-        inputSchema?: Record<string, unknown>;
-    };
-}
-/**
- * Host context provided to UI on initialization.
- * Contains environment information from the host.
- */
-export interface McpAppsHostContext {
-    /** Tool information for this UI context */
-    toolInfo?: ToolInfo;
-    /** Current theme */
-    theme?: 'light' | 'dark';
-    /** Current display mode */
-    displayMode?: McpAppsDisplayMode;
-    /** Viewport dimensions */
-    viewport?: ViewportInfo;
-    /** User's locale (BCP 47 tag) */
-    locale?: string;
-    /** User's timezone (IANA name) */
-    timeZone?: string;
-    /** Host platform type */
-    platform?: McpAppsPlatform;
-    /** Device capabilities */
-    deviceCapabilities?: DeviceCapabilities;
-    /** Safe area insets */
-    safeAreaInsets?: SafeAreaInsets;
-}
-/**
- * Base JSON-RPC 2.0 message.
- */
-export interface JsonRpcMessage {
-    jsonrpc: '2.0';
-}
-/**
- * JSON-RPC request message.
- */
-export interface JsonRpcRequest extends JsonRpcMessage {
-    id: string | number;
-    method: string;
-    params?: unknown;
-}
-/**
- * JSON-RPC response message.
- */
-export interface JsonRpcResponse extends JsonRpcMessage {
-    id: string | number;
-    result?: unknown;
-    error?: JsonRpcError;
-}
-/**
- * JSON-RPC notification (no response expected).
- */
-export interface JsonRpcNotification extends JsonRpcMessage {
-    method: string;
-    params?: unknown;
-}
-/**
- * JSON-RPC error object.
- */
-export interface JsonRpcError {
-    code: number;
-    message: string;
-    data?: unknown;
-}
-/**
- * UI Initialize request parameters.
- * Sent by UI to host on startup.
- */
-export interface McpUiInitializeParams {
-    /** Protocol version */
-    protocolVersion: string;
-    /** UI capabilities */
-    capabilities?: {
-        /** Supported message types */
-        messages?: string[];
-    };
-}
-/**
- * UI Initialize response from host.
- */
-export interface McpUiInitializeResult {
-    /** Protocol version (should match request) */
-    protocolVersion: string;
-    /** Host capabilities */
-    capabilities: {
-        /** Host-provided extensions */
-        extensions?: Record<string, unknown>;
-    };
-    /** Host context information */
-    hostContext: McpAppsHostContext;
-}
-/**
- * Tool input notification parameters.
- * Sent by host to UI with complete tool arguments.
- */
-export interface McpUiToolInputParams {
-    /** Tool arguments */
-    arguments: Record<string, unknown>;
-}
-/**
- * Tool input partial notification parameters.
- * Sent by host to UI during streaming.
- */
-export interface McpUiToolInputPartialParams {
-    /** Partial tool arguments (incremental) */
-    argumentsDelta: string;
-}
-/**
- * Tool result notification parameters.
- * Sent by host to UI after tool execution.
- */
-export interface McpUiToolResultParams {
-    /** Tool execution result */
-    content: Array<{
-        type: 'text' | 'image' | 'resource';
-        text?: string;
-        data?: string;
-        mimeType?: string;
-        uri?: string;
-    }>;
-    /** Structured content for UI rendering only */
-    structuredContent?: Record<string, unknown>;
-    /** Additional metadata */
-    _meta?: Record<string, unknown>;
-}
-/**
- * Tool cancelled notification parameters.
- */
-export interface McpUiToolCancelledParams {
-    /** Reason for cancellation */
-    reason?: string;
-}
-/**
- * Size change notification parameters.
- * Sent by host when UI viewport changes.
- */
-export interface McpUiSizeChangeParams {
-    /** New viewport dimensions */
-    viewport: ViewportInfo;
-}
-/**
- * Host context change notification parameters.
- */
-export interface McpUiHostContextChangeParams {
-    /** Changed context fields */
-    changes: Partial<McpAppsHostContext>;
-}
-/**
- * Open link request parameters.
- * Sent by UI to request host open a URL.
- */
-export interface McpUiOpenLinkParams {
-    /** URL to open */
-    url: string;
-}
-/**
- * Send message request parameters.
- * Sent by UI to send content to host's chat.
- */
-export interface McpUiMessageParams {
-    /** Message content */
-    content: string;
-}
-/**
- * MCP Apps protocol method names.
- */
-export declare const MCP_APPS_METHODS: {
-    readonly INITIALIZE: "ui/initialize";
-    readonly INITIALIZED: "ui/notifications/initialized";
-    readonly TOOL_INPUT: "ui/notifications/tool-input";
-    readonly TOOL_INPUT_PARTIAL: "ui/notifications/tool-input-partial";
-    readonly TOOL_RESULT: "ui/notifications/tool-result";
-    readonly TOOL_CANCELLED: "ui/notifications/tool-cancelled";
-    readonly SIZE_CHANGE: "ui/notifications/size-change";
-    readonly HOST_CONTEXT_CHANGE: "ui/host-context-change";
-    readonly RESOURCE_TEARDOWN: "ui/resource-teardown";
-    readonly OPEN_LINK: "ui/open-link";
-    readonly MESSAGE: "ui/message";
-    readonly TOOLS_CALL: "tools/call";
-    readonly RESOURCES_READ: "resources/read";
-    readonly NOTIFICATIONS_MESSAGE: "notifications/message";
-    readonly PING: "ping";
-    readonly SANDBOX_READY: "ui/notifications/sandbox-ready";
-    readonly SANDBOX_RESOURCE_READY: "ui/notifications/sandbox-resource-ready";
-};
-/**
- * MCP Apps extension capability declaration.
- * Advertised by clients during connection.
- */
-export interface McpAppsExtensionCapability {
-    /** Supported MIME types */
-    mimeTypes: McpAppsMimeType[];
-}
-/**
- * Client extensions object including MCP Apps.
- */
-export interface McpClientExtensions {
-    'io.modelcontextprotocol/ui'?: McpAppsExtensionCapability;
-    [key: string]: unknown;
-}
-/**
- * Tool metadata extension for MCP Apps.
- * Added to tool's `_meta` field to link to UI resource.
- */
-export interface ToolUIMeta {
-    /** URI of the UI resource template */
-    'ui/resourceUri'?: string;
-    /** MIME type of the UI resource */
-    'ui/mimeType'?: McpAppsMimeType;
-}
-/**
- * Extended tool result metadata including MCP Apps fields.
- */
-export interface McpAppsToolResultMeta extends ToolUIMeta {
-    /** Additional platform-specific metadata */
-    [key: string]: unknown;
-}
-/**
- * Current MCP Apps protocol version.
- */
-export declare const MCP_APPS_PROTOCOL_VERSION: "2025-01-01";

package/utils/metadata.utils.d.ts

@@ -1,5 +0,0 @@
-import 'reflect-metadata';
-import { Type } from '../common';
-export declare function getMetadata<T = any>(key: any, target: any, propertyKey?: string | symbol): T | undefined;
-export declare function setMetadata(key: any, value: any, target: any, propertyKey?: string | symbol): void;
-export declare function hasAsyncWith(klass: Type<any>): boolean;

package/utils/server.utils.d.ts

@@ -1,19 +0,0 @@
-import { ServerRequest, ServerRequestHandler, ServerResponse } from '../common';
-type Runner<T> = (req: ServerRequest) => Promise<T> | T;
-type SuccessWriter<T> = (res: ServerResponse, result: T) => void | Promise<void>;
-type ErrorWriter = (res: ServerResponse, err: any) => void | Promise<void>;
-export declare function withResponseHandler<T>(runner: Runner<T>): {
-    /** Set the success writer; chainable. */
-    success(fn: SuccessWriter<T>): /*elided*/ any;
-    /**
-     * Set the error writer and finalize into a ServerHookHandler.
-     * Calling this returns the Express-like/host handler.
-     */
-    fail(fn: ErrorWriter): ServerRequestHandler;
-    /**
-     * If you prefer not to end with .fail(), you can call .build() after setting .success().
-     * It will use the default error writer unless overridden via .fail() earlier.
-     */
-    build(): ServerRequestHandler;
-};
-export {};

package/utils/string.utils.d.ts

@@ -1 +0,0 @@
-export declare function idFromString(name: string): string;

package/utils/token.utils.d.ts

@@ -1,11 +0,0 @@
-import { Token, Type } from '../common';
-export declare const tokenName: (t: Token) => string;
-export declare const isClass: (x: any) => x is Type;
-export declare const isPromise: (v: any) => v is Promise<any>;
-export declare function getAsyncWithTokens(klass: Type<any>): Type<any>[] | null;
-/** Read param types for static with(...) only; TDZ-friendly. */
-export declare function readWithParamTypes(klass: Type, forWhat: 'discovery' | 'invocation'): Type[];
-/** Discover deps for a CLASS token or a concrete Type (ctor/with). */
-export declare function depsOfClass(klass: Type, phase: 'discovery' | 'invocation'): Type[];
-/** Discover deps for a Function token  without the first N args. */
-export declare function depsOfFunc(fn: (...args: any[]) => any | Promise<any>, phase: 'discovery' | 'invocation'): Type[];

package/utils/uri-template.utils.d.ts

@@ -1,57 +0,0 @@
-/**
- * Parsed URI template information
- */
-export interface ParsedUriTemplate {
-    pattern: RegExp;
-    paramNames: string[];
-}
-/**
- * Parse a URI template (RFC 6570 Level 1) into a regex pattern and parameter names.
- * Supports simple string substitution: {param}
- *
- * Note: This implements RFC 6570 Level 1 only (simple string substitution).
- * Advanced operators like {+path}, {#fragment}, or {?query} are not supported.
- *
- * @example
- * parseUriTemplate("file:///{path}") => { pattern: /^file:\/\/\/([^/]+)$/, paramNames: ["path"] }
- * parseUriTemplate("users/{userId}/posts/{postId}") => { pattern: /^users\/([^/]+)\/posts\/([^/]+)$/, paramNames: ["userId", "postId"] }
- *
- * @throws Error if template is too long (>1000 chars) or has too many parameters (>50)
- */
-export declare function parseUriTemplate(template: string): ParsedUriTemplate;
-/**
- * Match a URI against a URI template and extract parameters.
- * Returns null if no match, or an object with extracted parameters.
- *
- * @example
- * matchUriTemplate("file:///{path}", "file:///documents/readme.txt")
- * => { path: "documents" } // Note: only captures first segment
- *
- * matchUriTemplate("users/{userId}/posts/{postId}", "users/123/posts/456")
- * => { userId: "123", postId: "456" }
- */
-export declare function matchUriTemplate(template: string, uri: string): Record<string, string> | null;
-/**
- * Expand a URI template with the given parameters.
- *
- * @example
- * expandUriTemplate("file:///{path}", { path: "documents/readme.txt" })
- * => "file:///documents%2Freadme.txt"
- *
- * expandUriTemplate("users/{userId}/posts/{postId}", { userId: "123", postId: "456" })
- * => "users/123/posts/456"
- *
- * @throws Error if a required parameter is missing
- */
-export declare function expandUriTemplate(template: string, params: Record<string, string>): string;
-/**
- * Extract parameter names from a URI template.
- *
- * @example
- * extractTemplateParams("users/{userId}/posts/{postId}") => ["userId", "postId"]
- */
-export declare function extractTemplateParams(template: string): string[];
-/**
- * Check if a string is a URI template (contains {param} placeholders).
- */
-export declare function isUriTemplate(uri: string): boolean;

package/utils/uri-validation.utils.d.ts

@@ -1,40 +0,0 @@
-/**
- * Validate that a URI has a valid scheme per RFC 3986.
- *
- * @param uri - The URI to validate
- * @returns true if the URI has a valid scheme, false otherwise
- *
- * @example
- * isValidMcpUri('file:///path/to/file') // true
- * isValidMcpUri('https://example.com/resource') // true
- * isValidMcpUri('custom://my-resource') // true
- * isValidMcpUri('/path/to/file') // false (no scheme)
- * isValidMcpUri('123://invalid') // false (scheme must start with letter)
- */
-export declare function isValidMcpUri(uri: string): boolean;
-/**
- * Extract the scheme from a URI.
- *
- * @param uri - The URI to extract the scheme from
- * @returns The scheme in lowercase, or null if no valid scheme found
- *
- * @example
- * extractUriScheme('file:///path') // 'file'
- * extractUriScheme('HTTPS://example.com') // 'https'
- * extractUriScheme('/no/scheme') // null
- */
-export declare function extractUriScheme(uri: string): string | null;
-/**
- * Validate that a URI template has a valid scheme per RFC 3986.
- * URI templates follow RFC 6570 and can contain template expressions like {var}.
- * The scheme portion should still be a valid static scheme.
- *
- * @param uriTemplate - The URI template to validate
- * @returns true if the URI template has a valid scheme, false otherwise
- *
- * @example
- * isValidMcpUriTemplate('users://{userId}/profile') // true
- * isValidMcpUriTemplate('file:///{path}') // true
- * isValidMcpUriTemplate('{scheme}://dynamic') // false (scheme must be static)
- */
-export declare function isValidMcpUriTemplate(uriTemplate: string): boolean;