@ai-sdk/react 4.0.0-beta.18 → 4.0.0-beta.181

package/dist/index.d.ts

@@ -1,6 +1,11 @@
-import { UIMessage, AbstractChat, ChatInit, CompletionRequestOptions, UseCompletionOptions, DeepPartial } from 'ai';
-export { CreateUIMessage, UIMessage, UseCompletionOptions } from 'ai';
+import { UIMessage, AbstractChat, ChatInit, CompletionRequestOptions, UseCompletionOptions, DeepPartial, Experimental_RealtimeSessionOptions, Experimental_RealtimeStatus, Experimental_RealtimeServerEvent, Experimental_AbstractRealtimeSession, Experimental_RealtimeState, ToolUIPart, UITools, DynamicToolUIPart } from 'ai';
+export { CreateUIMessage, Experimental_RealtimeStatus, UIMessage, UseCompletionOptions } from 'ai';
 import { FlexibleSchema, FetchFunction, Resolvable, InferSchema } from '@ai-sdk/provider-utils';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
+import { CSSProperties, ReactNode } from 'react';
+import { MCPAppResource } from '@ai-sdk/mcp';
+export { MCPAppResource } from '@ai-sdk/mcp';
 
 declare class Chat<UI_MESSAGE extends UIMessage> extends AbstractChat<UI_MESSAGE> {
     #private;
@@ -175,4 +180,119 @@ declare function useObject<SCHEMA extends FlexibleSchema, RESULT = InferSchema<S
 initialValue, fetch, onError, onFinish, headers, credentials, }: Experimental_UseObjectOptions<SCHEMA, RESULT>): Experimental_UseObjectHelpers<RESULT, INPUT>;
 declare const experimental_useObject: typeof useObject;
 
-export { Chat, Experimental_UseObjectHelpers, Experimental_UseObjectOptions, UseChatHelpers, UseChatOptions, UseCompletionHelpers, experimental_useObject, useChat, useCompletion };
+type UseRealtimeOptions = Experimental_RealtimeSessionOptions;
+type RealtimeStateKey = keyof Experimental_RealtimeState;
+declare class RealtimeStore extends Experimental_AbstractRealtimeSession {
+    protected state: Experimental_RealtimeState;
+    private callbacks;
+    get status(): Experimental_RealtimeStatus;
+    get messages(): UIMessage[];
+    get events(): Experimental_RealtimeServerEvent[];
+    get isCapturing(): boolean;
+    get isPlaying(): boolean;
+    subscribe(key: RealtimeStateKey, onChange: () => void): () => void;
+    protected setState<K extends RealtimeStateKey>(key: K, value: Experimental_RealtimeState[K]): void;
+    protected pushMessage(message: UIMessage): void;
+    protected updateMessages(updater: (messages: UIMessage[]) => UIMessage[]): void;
+    protected pushEvent(event: Experimental_RealtimeServerEvent): void;
+}
+type UseRealtimeReturn = {
+    status: Experimental_RealtimeStatus;
+    messages: UIMessage[];
+    events: Experimental_RealtimeServerEvent[];
+    isCapturing: boolean;
+    isPlaying: boolean;
+    connect: () => Promise<void>;
+    disconnect: () => void;
+    addToolOutput: (callId: string, result: unknown) => void;
+    sendEvent: RealtimeStore['sendEvent'];
+    sendTextMessage: (text: string) => void;
+    sendAudio: (base64Audio: string) => void;
+    commitAudio: () => void;
+    clearAudioBuffer: () => void;
+    requestResponse: (options?: {
+        modalities?: string[];
+    }) => void;
+    cancelResponse: () => void;
+    startAudioCapture: (stream: MediaStream) => void;
+    stopAudioCapture: () => void;
+    stopPlayback: () => void;
+};
+declare function useRealtime(options: UseRealtimeOptions): UseRealtimeReturn;
+declare const experimental_useRealtime: typeof useRealtime;
+
+type MCPAppDisplayMode = 'inline' | 'fullscreen' | 'pip';
+type MCPAppMetadata = {
+    resourceUri: string;
+    mimeType: MCPAppResource['mimeType'];
+    visibility?: Array<'model' | 'app'>;
+};
+type MCPAppHostContext = {
+    theme?: 'light' | 'dark';
+    displayMode?: MCPAppDisplayMode;
+    availableDisplayModes?: MCPAppDisplayMode[];
+    [key: string]: unknown;
+};
+type MCPAppToolCallParams = {
+    name: string;
+    arguments?: Record<string, unknown>;
+};
+type MCPAppBridgeHandlers = {
+    /**
+     * Tools the MCP App is allowed to invoke via `tools/call`. Deny-by-default:
+     * if omitted, the (untrusted) app cannot call any tool. List only the tools
+     * the app is meant to see.
+     */
+    allowedTools?: string[];
+    callTool?: (params: MCPAppToolCallParams) => Promise<unknown> | unknown;
+    readResource?: (params: {
+        uri: string;
+    }) => Promise<unknown> | unknown;
+    listResources?: (params?: unknown) => Promise<unknown> | unknown;
+    openLink?: (params: {
+        url: string;
+    }) => Promise<unknown> | unknown;
+    sendMessage?: (params: unknown) => Promise<unknown> | unknown;
+    updateModelContext?: (params: unknown) => Promise<unknown> | unknown;
+    requestDisplayMode?: (params: {
+        mode: MCPAppDisplayMode;
+    }) => Promise<{
+        mode: MCPAppDisplayMode;
+    }> | {
+        mode: MCPAppDisplayMode;
+    };
+    onSizeChange?: (params: {
+        width?: number;
+        height?: number;
+    }) => void;
+    onInitialized?: () => void;
+    onRequestTeardown?: (params: unknown) => void;
+    onLog?: (params: unknown) => void;
+    onError?: (error: Error) => void;
+};
+type MCPAppSandboxConfig = {
+    url: string | URL;
+    title?: string;
+    className?: string;
+    style?: CSSProperties;
+    targetOrigin?: string;
+    outerSandbox?: string;
+    innerSandbox?: string;
+};
+type MCPAppRendererProps = {
+    part: ToolUIPart<UITools> | DynamicToolUIPart;
+    sandbox: MCPAppSandboxConfig;
+    resource?: MCPAppResource;
+    loadResource?: (app: MCPAppMetadata) => Promise<MCPAppResource>;
+    handlers?: MCPAppBridgeHandlers;
+    hostInfo?: {
+        name: string;
+        version: string;
+    };
+    hostContext?: MCPAppHostContext;
+    fallback?: ReactNode;
+};
+
+declare function MCPAppRenderer({ part, sandbox, resource: resourceProp, loadResource, handlers, hostInfo, hostContext, fallback, }: MCPAppRendererProps): string | number | boolean | Iterable<react.ReactNode> | react_jsx_runtime.JSX.Element | null;
+
+export { Chat, Experimental_UseObjectHelpers, Experimental_UseObjectOptions, UseRealtimeOptions as Experimental_UseRealtimeOptions, UseRealtimeReturn as Experimental_UseRealtimeReturn, MCPAppBridgeHandlers, MCPAppMetadata, MCPAppRendererProps, MCPAppSandboxConfig, UseChatHelpers, UseChatOptions, UseCompletionHelpers, MCPAppRenderer as experimental_MCPAppRenderer, experimental_useObject, experimental_useRealtime, useChat, useCompletion };