@yourgpt/copilot-sdk 2.0.1 → 2.0.2-beta.2

package/dist/types-Cizh9K_f.d.ts

@@ -0,0 +1,441 @@
+import { T as ToolDefinition } from './tools-DDWrco4h.js';
+
+/**
+ * MCP (Model Context Protocol) Type Definitions
+ *
+ * This module defines all types for MCP client integration,
+ * following the MCP specification for JSON-RPC 2.0 communication.
+ */
+/**
+ * Supported MCP transport types
+ */
+type MCPTransportType = "http" | "sse" | "stdio";
+/**
+ * Base transport configuration
+ */
+interface MCPTransportConfigBase {
+    /** Transport type */
+    type: MCPTransportType;
+}
+/**
+ * HTTP Streamable transport configuration (recommended)
+ */
+interface MCPHttpTransportConfig extends MCPTransportConfigBase {
+    type: "http";
+    /** Server URL endpoint */
+    url: string;
+    /** Custom headers for authentication */
+    headers?: Record<string, string>;
+    /** Request timeout in milliseconds */
+    timeout?: number;
+}
+/**
+ * SSE (Server-Sent Events) transport configuration
+ */
+interface MCPSSETransportConfig extends MCPTransportConfigBase {
+    type: "sse";
+    /** Server URL endpoint */
+    url: string;
+    /** Custom headers for authentication */
+    headers?: Record<string, string>;
+}
+/**
+ * Stdio transport configuration (for local MCP servers)
+ */
+interface MCPStdioTransportConfig extends MCPTransportConfigBase {
+    type: "stdio";
+    /** Command to execute */
+    command: string;
+    /** Command arguments */
+    args?: string[];
+    /** Environment variables */
+    env?: Record<string, string>;
+    /** Working directory */
+    cwd?: string;
+}
+/**
+ * Union of all transport configurations
+ */
+type MCPTransportConfig = MCPHttpTransportConfig | MCPSSETransportConfig | MCPStdioTransportConfig;
+/**
+ * JSON-RPC request
+ */
+interface JsonRpcRequest {
+    jsonrpc: "2.0";
+    id: string | number;
+    method: string;
+    params?: Record<string, unknown>;
+}
+/**
+ * JSON-RPC notification (no response expected)
+ */
+interface JsonRpcNotification {
+    jsonrpc: "2.0";
+    method: string;
+    params?: Record<string, unknown>;
+}
+/**
+ * JSON-RPC success response
+ */
+interface JsonRpcSuccessResponse {
+    jsonrpc: "2.0";
+    id: string | number;
+    result: unknown;
+}
+/**
+ * JSON-RPC error response
+ */
+interface JsonRpcErrorResponse {
+    jsonrpc: "2.0";
+    id: string | number | null;
+    error: JsonRpcError;
+}
+/**
+ * JSON-RPC error object
+ */
+interface JsonRpcError {
+    code: number;
+    message: string;
+    data?: unknown;
+}
+/**
+ * JSON-RPC response (success or error)
+ */
+type JsonRpcResponse = JsonRpcSuccessResponse | JsonRpcErrorResponse;
+/**
+ * JSON-RPC message (request, notification, or response)
+ */
+type JsonRpcMessage = JsonRpcRequest | JsonRpcNotification | JsonRpcResponse;
+declare const JSON_RPC_ERROR_CODES: {
+    readonly PARSE_ERROR: -32700;
+    readonly INVALID_REQUEST: -32600;
+    readonly METHOD_NOT_FOUND: -32601;
+    readonly INVALID_PARAMS: -32602;
+    readonly INTERNAL_ERROR: -32603;
+};
+/**
+ * MCP Protocol Version
+ *
+ * The SDK supports multiple protocol versions:
+ * - 2025-06-18: Latest protocol with full features
+ * - 2025-03-26: Streamable HTTP transport
+ * - 2024-11-05: Legacy HTTP+SSE transport (deprecated)
+ */
+declare const MCP_PROTOCOL_VERSION = "2025-06-18";
+/**
+ * MCP client capabilities
+ */
+interface MCPClientCapabilities {
+    /** Roots capability (file system access) */
+    roots?: {
+        listChanged?: boolean;
+    };
+    /** Sampling capability */
+    sampling?: Record<string, never>;
+    /** Experimental capabilities */
+    experimental?: Record<string, unknown>;
+}
+/**
+ * MCP server capabilities
+ */
+interface MCPServerCapabilities {
+    /** Tools capability */
+    tools?: {
+        listChanged?: boolean;
+    };
+    /** Resources capability */
+    resources?: {
+        subscribe?: boolean;
+        listChanged?: boolean;
+    };
+    /** Prompts capability */
+    prompts?: {
+        listChanged?: boolean;
+    };
+    /** Logging capability */
+    logging?: Record<string, never>;
+    /** Experimental capabilities */
+    experimental?: Record<string, unknown>;
+}
+/**
+ * MCP client info
+ */
+interface MCPClientInfo {
+    name: string;
+    version: string;
+}
+/**
+ * MCP server info
+ */
+interface MCPServerInfo {
+    name: string;
+    version: string;
+}
+/**
+ * MCP initialization params
+ */
+interface MCPInitializeParams {
+    protocolVersion: string;
+    capabilities: MCPClientCapabilities;
+    clientInfo: MCPClientInfo;
+}
+/**
+ * MCP tool definition (from server)
+ */
+interface MCPToolDefinition {
+    /** Tool name */
+    name: string;
+    /** Tool description */
+    description?: string;
+    /** JSON Schema for input parameters */
+    inputSchema: MCPToolInputSchema;
+}
+/**
+ * MCP tool input schema (JSON Schema format)
+ */
+interface MCPToolInputSchema {
+    type: "object";
+    properties?: Record<string, MCPJsonSchemaProperty>;
+    required?: string[];
+    additionalProperties?: boolean;
+}
+/**
+ * MCP JSON Schema property
+ */
+interface MCPJsonSchemaProperty {
+    type?: string | string[];
+    description?: string;
+    enum?: unknown[];
+    items?: MCPJsonSchemaProperty;
+    properties?: Record<string, MCPJsonSchemaProperty>;
+    required?: string[];
+    default?: unknown;
+    minLength?: number;
+    maxLength?: number;
+    minimum?: number;
+    maximum?: number;
+    pattern?: string;
+    format?: string;
+    oneOf?: MCPJsonSchemaProperty[];
+    anyOf?: MCPJsonSchemaProperty[];
+    allOf?: MCPJsonSchemaProperty[];
+}
+/**
+ * MCP tool call request params
+ */
+interface MCPToolCallParams {
+    name: string;
+    arguments?: Record<string, unknown>;
+}
+/**
+ * MCP UI content (for MCP-UI support)
+ * @see https://github.com/idosal/mcp-ui
+ */
+interface MCPUIContent {
+    type: "ui";
+    resource: {
+        uri: string;
+        mimeType: "text/html" | "text/uri-list" | "application/vnd.mcp-ui.remote-dom";
+        content?: string;
+        blob?: string;
+        metadata?: {
+            title?: string;
+            width?: string;
+            height?: string;
+            sandbox?: string[];
+            className?: string;
+        };
+    };
+}
+/**
+ * MCP tool call result content types
+ */
+type MCPToolResultContent = MCPTextContent | MCPImageContent | MCPResourceContent | MCPUIContent;
+/**
+ * MCP text content
+ */
+interface MCPTextContent {
+    type: "text";
+    text: string;
+}
+/**
+ * MCP image content
+ */
+interface MCPImageContent {
+    type: "image";
+    data: string;
+    mimeType: string;
+}
+/**
+ * MCP embedded resource content
+ */
+interface MCPResourceContent {
+    type: "resource";
+    resource: {
+        uri: string;
+        mimeType?: string;
+        text?: string;
+        blob?: string;
+    };
+}
+/**
+ * MCP tool call result
+ */
+interface MCPToolCallResult {
+    content: MCPToolResultContent[];
+    isError?: boolean;
+}
+/**
+ * Elicitation request from MCP server
+ */
+interface MCPElicitationRequest {
+    /** Unique request ID */
+    requestId: string;
+    /** Elicitation mode */
+    mode: "form" | "confirm" | "select";
+    /** Message to display to user */
+    message?: string;
+    /** JSON Schema for form mode */
+    schema?: MCPToolInputSchema;
+    /** Options for select mode */
+    options?: MCPElicitationOption[];
+    /** Default values */
+    defaults?: Record<string, unknown>;
+}
+/**
+ * Elicitation option (for select mode)
+ */
+interface MCPElicitationOption {
+    value: string;
+    label?: string;
+    description?: string;
+}
+/**
+ * Elicitation response to MCP server
+ */
+interface MCPElicitationResponse {
+    /** Request ID being responded to */
+    requestId: string;
+    /** Whether user accepted */
+    accepted: boolean;
+    /** User's form data (for form/select modes) */
+    data?: Record<string, unknown>;
+    /** Rejection reason (if not accepted) */
+    reason?: string;
+}
+/**
+ * MCP client connection state
+ */
+type MCPConnectionState = "disconnected" | "connecting" | "connected" | "error";
+/**
+ * MCP client configuration
+ */
+interface MCPClientConfig {
+    /** Unique name for this client/server connection */
+    name: string;
+    /** Transport type shorthand */
+    transport: MCPTransportType;
+    /** Server URL (for http/sse transports) */
+    url?: string;
+    /** Custom headers (for http/sse transports) */
+    headers?: Record<string, string>;
+    /** Request timeout in milliseconds (default: 30000) */
+    timeout?: number;
+    /** Command to execute (for stdio transport) */
+    command?: string;
+    /** Command arguments (for stdio transport) */
+    args?: string[];
+    /** Environment variables (for stdio transport) */
+    env?: Record<string, string>;
+    /** Working directory (for stdio transport) */
+    cwd?: string;
+    /** Client info */
+    clientInfo?: MCPClientInfo;
+    /** Client capabilities */
+    capabilities?: MCPClientCapabilities;
+}
+/**
+ * MCP client state
+ */
+interface MCPClientState {
+    /** Connection state */
+    connectionState: MCPConnectionState;
+    /** Server info (after connection) */
+    serverInfo?: MCPServerInfo;
+    /** Server capabilities (after connection) */
+    serverCapabilities?: MCPServerCapabilities;
+    /** Available tools */
+    tools: MCPToolDefinition[];
+    /** Error message (if in error state) */
+    error?: string;
+    /** Last activity timestamp */
+    lastActivity?: number;
+}
+/**
+ * MCP client events
+ */
+interface MCPClientEvents {
+    /** Connection state changed */
+    onConnectionStateChange?: (state: MCPConnectionState) => void;
+    /** Tools list updated */
+    onToolsChange?: (tools: MCPToolDefinition[]) => void;
+    /** Elicitation request received */
+    onElicitationRequest?: (request: MCPElicitationRequest) => Promise<MCPElicitationResponse>;
+    /** Error occurred */
+    onError?: (error: Error) => void;
+    /** Notification received */
+    onNotification?: (method: string, params?: Record<string, unknown>) => void;
+}
+/**
+ * Configuration for useMCPClient hook
+ */
+interface UseMCPClientConfig extends MCPClientConfig, MCPClientEvents {
+    /** Auto-connect on mount (default: true) */
+    autoConnect?: boolean;
+}
+/**
+ * Configuration for useMCPTools hook
+ */
+interface UseMCPToolsConfig extends UseMCPClientConfig {
+    /** Prefix tool names with client name (default: true) */
+    prefixToolNames?: boolean;
+    /** Auto-register tools with CopilotProvider (default: true) */
+    autoRegister?: boolean;
+}
+/**
+ * Return type for useMCPClient hook
+ */
+interface UseMCPClientReturn {
+    /** Current client state */
+    state: MCPClientState;
+    /** Connect to server */
+    connect: () => Promise<void>;
+    /** Disconnect from server */
+    disconnect: () => Promise<void>;
+    /** Call a tool */
+    callTool: (name: string, args?: Record<string, unknown>) => Promise<MCPToolCallResult>;
+    /** Refresh tools list */
+    refreshTools: () => Promise<MCPToolDefinition[]>;
+    /** Whether client is connected */
+    isConnected: boolean;
+    /** Whether client is loading */
+    isLoading: boolean;
+}
+/**
+ * Return type for useMCPTools hook
+ */
+interface UseMCPToolsReturn extends UseMCPClientReturn {
+    /** Tools converted to ToolDefinition format */
+    toolDefinitions: ToolDefinition[];
+}
+/**
+ * MCP error class
+ */
+declare class MCPError extends Error {
+    code?: number | undefined;
+    data?: unknown | undefined;
+    constructor(message: string, code?: number | undefined, data?: unknown | undefined);
+    static fromJsonRpcError(error: JsonRpcError): MCPError;
+}
+
+export { type MCPElicitationRequest as A, type MCPElicitationResponse as B, type MCPElicitationOption as C, type UseMCPClientReturn as D, type UseMCPToolsConfig as E, type UseMCPToolsReturn as F, MCPError as G, MCP_PROTOCOL_VERSION as H, JSON_RPC_ERROR_CODES as I, type JsonRpcRequest as J, type MCPClientConfig as M, type UseMCPClientConfig as U, type MCPClientEvents as a, type MCPClientState as b, type MCPToolCallResult as c, type MCPToolDefinition as d, type MCPServerInfo as e, type MCPServerCapabilities as f, type MCPConnectionState as g, type JsonRpcNotification as h, type JsonRpcMessage as i, type JsonRpcResponse as j, type MCPClientInfo as k, type MCPClientCapabilities as l, type MCPInitializeParams as m, type MCPToolCallParams as n, type MCPTransportType as o, type MCPTransportConfig as p, type MCPHttpTransportConfig as q, type MCPSSETransportConfig as r, type MCPStdioTransportConfig as s, type JsonRpcError as t, type MCPToolInputSchema as u, type MCPToolResultContent as v, type MCPTextContent as w, type MCPImageContent as x, type MCPResourceContent as y, type MCPUIContent as z };