@assistant-ui/react 0.4.3 → 0.4.5

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import * as react from 'react';
 import { ReactNode, ComponentType, PropsWithChildren, ComponentPropsWithoutRef, FC } from 'react';
 import { z } from 'zod';
 import { JSONSchema7 } from 'json-schema';
-import { LanguageModelV1FinishReason, LanguageModelV1LogProbs } from '@ai-sdk/provider';
+import { LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1Message } from '@ai-sdk/provider';
 import { UseBoundStore, StoreApi } from 'zustand';
 import { Primitive } from '@radix-ui/react-primitive';
 import * as PopoverPrimitive from '@radix-ui/react-popover';
@@ -16,14 +16,16 @@ type ToolExecuteFunction<TArgs, TResult> = (args: TArgs) => TResult | Promise<TR
 type Tool<TArgs = unknown, TResult = unknown> = {
     description?: string | undefined;
     parameters: z.ZodSchema<TArgs> | JSONSchema7;
-    execute: ToolExecuteFunction<TArgs, TResult>;
+    execute?: ToolExecuteFunction<TArgs, TResult>;
 };
 type ModelConfig = {
     priority?: number | undefined;
     system?: string | undefined;
     tools?: Record<string, Tool<any, any>> | undefined;
 };
-type ModelConfigProvider = () => ModelConfig;
+type ModelConfigProvider = {
+    getModelConfig: () => ModelConfig;
+};
 
 type Unsubscribe = () => void;
 
@@ -43,12 +45,13 @@ type ToolCallContentPart<TArgs = unknown, TResult = unknown> = {
     type: "tool-call";
     toolCallId: string;
     toolName: string;
+    argsText: string;
     args: TArgs;
     result?: TResult;
+    isError?: boolean;
 };
 type ThreadUserContentPart = TextContentPart | ImageContentPart | UIContentPart;
 type ThreadAssistantContentPart = TextContentPart | ToolCallContentPart | UIContentPart;
-type AppendContentPart = TextContentPart | ImageContentPart;
 type MessageCommonProps = {
     id: string;
     createdAt: Date;
@@ -80,25 +83,26 @@ type ThreadAssistantMessage = MessageCommonProps & {
     content: ThreadAssistantContentPart[];
     status: MessageStatus;
 };
-type AppendMessage = {
+type AppendMessage = CoreMessage & {
     parentId: string | null;
-    role: "user";
-    content: AppendContentPart[];
 };
 type ThreadMessage = ThreadSystemMessage | ThreadUserMessage | ThreadAssistantMessage;
 /** Core Message Types (without UI content parts) */
 type CoreUserContentPart = TextContentPart | ImageContentPart;
 type CoreAssistantContentPart = TextContentPart | ToolCallContentPart;
-type CoreUserMessage = MessageCommonProps & {
+type CoreSystemMessage = {
+    role: "system";
+    content: [TextContentPart];
+};
+type CoreUserMessage = {
     role: "user";
     content: CoreUserContentPart[];
 };
-type CoreAssistantMessage = MessageCommonProps & {
+type CoreAssistantMessage = {
     role: "assistant";
     content: CoreAssistantContentPart[];
-    status: MessageStatus;
 };
-type CoreThreadMessage = ThreadSystemMessage | CoreUserMessage | CoreAssistantMessage;
+type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage;
 
 type ReactThreadRuntime = ThreadRuntime & {
     unstable_synchronizer?: ComponentType;
@@ -115,7 +119,7 @@ type ChatModelRunOptions = {
     messages: ThreadMessage[];
     abortSignal: AbortSignal;
     config: ModelConfig;
-    onUpdate: (result: ChatModelRunUpdate) => void;
+    onUpdate: (result: ChatModelRunUpdate) => ThreadMessage;
 };
 type ChatModelAdapter = {
     run: (options: ChatModelRunOptions) => Promise<ChatModelRunResult>;
@@ -123,41 +127,28 @@ type ChatModelAdapter = {
 
 declare abstract class BaseAssistantRuntime<TThreadRuntime extends ReactThreadRuntime> implements AssistantRuntime {
     private _thread;
-    get capabilities(): Readonly<{
-        edit: boolean;
-        reload: boolean;
-        cancel: boolean;
-        copy: boolean;
-    }>;
     constructor(_thread: TThreadRuntime);
-    private _unsubscribe;
     get thread(): TThreadRuntime;
     set thread(thread: TThreadRuntime);
     abstract registerModelConfigProvider(provider: ModelConfigProvider): Unsubscribe;
     abstract switchToThread(threadId: string | null): void;
-    get messages(): readonly ThreadMessage[];
-    get isRunning(): boolean;
-    getBranches(messageId: string): readonly string[];
-    switchToBranch(branchId: string): void;
-    append(message: AppendMessage): void;
-    startRun(parentId: string | null): void;
-    cancelRun(): void;
-    addToolResult(options: AddToolResultOptions): void;
     private _subscriptions;
     subscribe(callback: () => void): Unsubscribe;
     private subscriptionHandler;
-    get unstable_synchronizer(): react.ComponentType | undefined;
 }
 
+type LocalRuntimeOptions = {
+    initialMessages?: readonly CoreMessage[] | undefined;
+};
 declare class LocalRuntime extends BaseAssistantRuntime<LocalThreadRuntime> {
-    private readonly _configProviders;
-    constructor(adapter: ChatModelAdapter);
+    private readonly _proxyConfigProvider;
+    constructor(adapter: ChatModelAdapter, options?: LocalRuntimeOptions);
     set adapter(adapter: ChatModelAdapter);
-    registerModelConfigProvider(provider: ModelConfigProvider): () => boolean;
+    registerModelConfigProvider(provider: ModelConfigProvider): () => void;
     switchToThread(threadId: string | null): LocalThreadRuntime;
 }
 declare class LocalThreadRuntime implements ThreadRuntime {
-    private _configProviders;
+    private configProvider;
     adapter: ChatModelAdapter;
     private _subscriptions;
     private abortController;
@@ -170,7 +161,7 @@ declare class LocalThreadRuntime implements ThreadRuntime {
     }>;
     get messages(): ThreadMessage[];
     get isRunning(): boolean;
-    constructor(_configProviders: Set<ModelConfigProvider>, adapter: ChatModelAdapter);
+    constructor(configProvider: ModelConfigProvider, adapter: ChatModelAdapter, options?: LocalRuntimeOptions);
     getBranches(messageId: string): string[];
     switchToBranch(branchId: string): void;
     append(message: AppendMessage): Promise<void>;
@@ -181,12 +172,49 @@ declare class LocalThreadRuntime implements ThreadRuntime {
     addToolResult({ messageId, toolCallId, result }: AddToolResultOptions): void;
 }
 
-declare const useLocalRuntime: (adapter: ChatModelAdapter) => LocalRuntime;
+declare const useLocalRuntime: (adapter: ChatModelAdapter, options?: LocalRuntimeOptions) => LocalRuntime;
+
+type TextContentPartProps = {
+    part: TextContentPart;
+    status: MessageStatus;
+};
+type TextContentPartComponent = ComponentType<TextContentPartProps>;
+type ImageContentPartProps = {
+    part: ImageContentPart;
+    status: MessageStatus;
+};
+type ImageContentPartComponent = ComponentType<ImageContentPartProps>;
+type UIContentPartProps = {
+    part: UIContentPart;
+    status: MessageStatus;
+};
+type UIContentPartComponent = ComponentType<UIContentPartProps>;
+type ToolCallContentPartProps<TArgs = any, TResult = any> = {
+    part: ToolCallContentPart<TArgs, TResult>;
+    status: MessageStatus;
+    addResult: (result: any) => void;
+};
+type ToolCallContentPartComponent<TArgs = any, TResult = any> = ComponentType<ToolCallContentPartProps<TArgs, TResult>>;
 
-type EdgeRuntimeOptions = {
+type EdgeChatAdapterOptions = {
     api: string;
+    maxToolRoundtrips?: number;
 };
-declare const useEdgeRuntime: (options: EdgeRuntimeOptions) => LocalRuntime;
+declare class EdgeChatAdapter implements ChatModelAdapter {
+    private options;
+    constructor(options: EdgeChatAdapterOptions);
+    roundtrip(initialContent: ThreadAssistantContentPart[], { messages, abortSignal, config, onUpdate }: ChatModelRunOptions): Promise<readonly [ThreadMessage | undefined, ChatModelRunResult]>;
+    run({ messages, abortSignal, config, onUpdate }: ChatModelRunOptions): Promise<ChatModelRunResult>;
+}
+
+type EdgeRuntimeOptions = EdgeChatAdapterOptions & LocalRuntimeOptions;
+declare const useEdgeRuntime: ({ initialMessages, ...options }: EdgeRuntimeOptions) => LocalRuntime;
+
+declare function toLanguageModelMessages(message: readonly CoreMessage[] | readonly ThreadMessage[]): LanguageModelV1Message[];
+
+declare const fromLanguageModelMessages: (lm: LanguageModelV1Message[], mergeRoundtrips: boolean) => CoreMessage[];
+
+declare const fromCoreMessages: (message: readonly CoreMessage[]) => ThreadMessage[];
 
 type AddToolResultOptions = {
     messageId: string;
@@ -206,36 +234,19 @@ type ThreadActionsState = Readonly<{
     startRun: (parentId: string | null) => void;
     cancelRun: () => void;
     addToolResult: (options: AddToolResultOptions) => void;
+    getRuntime: () => ThreadRuntime;
 }>;
 
-type TextContentPartProps = {
-    part: TextContentPart;
-    status: MessageStatus;
-};
-type TextContentPartComponent = ComponentType<TextContentPartProps>;
-type ImageContentPartProps = {
-    part: ImageContentPart;
-    status: MessageStatus;
-};
-type ImageContentPartComponent = ComponentType<ImageContentPartProps>;
-type UIContentPartProps = {
-    part: UIContentPart;
-    status: MessageStatus;
-};
-type UIContentPartComponent = ComponentType<UIContentPartProps>;
-type ToolCallContentPartProps<TArgs = any, TResult = any> = {
-    part: ToolCallContentPart<TArgs, TResult>;
-    status: MessageStatus;
-    addResult: (result: any) => void;
-};
-type ToolCallContentPartComponent<TArgs = any, TResult = any> = ComponentType<ToolCallContentPartProps<TArgs, TResult>>;
-
-type ThreadRuntime = Readonly<ThreadState & ThreadActionsState & {
+type ThreadRuntime = Readonly<ThreadState & Omit<ThreadActionsState, "getRuntime"> & {
     messages: readonly ThreadMessage[];
     subscribe: (callback: () => void) => Unsubscribe;
 }>;
 
-type AssistantRuntime = ThreadRuntime & {
+type ThreadRuntimeWithSubscribe = {
+    readonly thread: ThreadRuntime;
+    subscribe: (callback: () => void) => Unsubscribe;
+};
+type AssistantRuntime = ThreadRuntimeWithSubscribe & {
     switchToThread: (threadId: string | null) => void;
     registerModelConfigProvider: (provider: ModelConfigProvider) => Unsubscribe;
 };
@@ -247,10 +258,10 @@ declare const AssistantRuntimeProvider: react.NamedExoticComponent<PropsWithChil
 
 type AssistantActionsState = Readonly<{
     switchToThread: (threadId: string | null) => void;
+    getRuntime: () => AssistantRuntime;
 }>;
 
-type AssistantModelConfigState = Readonly<{
-    getModelConfig: ModelConfigProvider;
+type AssistantModelConfigState = Readonly<ModelConfigProvider & {
     registerModelConfigProvider: (provider: ModelConfigProvider) => () => void;
 }>;
 
@@ -1016,7 +1027,7 @@ declare const exports: {
     Text: FC<TextContentPartProps>;
 };
 
-declare class ProxyConfigProvider {
+declare class ProxyConfigProvider implements ModelConfigProvider {
     private _providers;
     getModelConfig(): ModelConfig;
     registerModelConfigProvider(provider: ModelConfigProvider): () => void;
@@ -1042,6 +1053,8 @@ declare class MessageRepository {
 
 declare const useSmooth: (text: string, smooth?: boolean) => string;
 
+declare const generateId: (size?: number) => string;
+
 type internal_BaseAssistantRuntime<TThreadRuntime extends ReactThreadRuntime> = BaseAssistantRuntime<TThreadRuntime>;
 declare const internal_BaseAssistantRuntime: typeof BaseAssistantRuntime;
 type internal_MessageRepository = MessageRepository;
@@ -1049,9 +1062,10 @@ declare const internal_MessageRepository: typeof MessageRepository;
 type internal_ProxyConfigProvider = ProxyConfigProvider;
 declare const internal_ProxyConfigProvider: typeof ProxyConfigProvider;
 declare const internal_TooltipIconButton: typeof TooltipIconButton;
+declare const internal_generateId: typeof generateId;
 declare const internal_useSmooth: typeof useSmooth;
 declare namespace internal {
-  export { internal_BaseAssistantRuntime as BaseAssistantRuntime, internal_MessageRepository as MessageRepository, internal_ProxyConfigProvider as ProxyConfigProvider, internal_TooltipIconButton as TooltipIconButton, internal_useSmooth as useSmooth };
+  export { internal_BaseAssistantRuntime as BaseAssistantRuntime, internal_MessageRepository as MessageRepository, internal_ProxyConfigProvider as ProxyConfigProvider, internal_TooltipIconButton as TooltipIconButton, internal_generateId as generateId, internal_useSmooth as useSmooth };
 }
 
-export { index$6 as ActionBarPrimitive, type ActionBarPrimitiveCopyProps, type ActionBarPrimitiveEditProps, type ActionBarPrimitiveReloadProps, type ActionBarPrimitiveRootProps, type AddToolResultOptions, type AppendContentPart, type AppendMessage, _default$9 as AssistantActionBar, type AssistantActionsState, type AssistantContextValue, _default$8 as AssistantMessage, type AssistantMessageConfig, type AssistantMessageContentProps, _default$7 as AssistantModal, index$5 as AssistantModalPrimitive, type AssistantModalPrimitiveContentProps, type AssistantModalPrimitiveRootProps, type AssistantModalPrimitiveTriggerProps, type AssistantModelConfigState, type AssistantRuntime, AssistantRuntimeProvider, type AssistantToolProps, type AssistantToolUIProps, type AssistantToolUIsState, _default$6 as BranchPicker, index$4 as BranchPickerPrimitive, type BranchPickerPrimitiveCountProps, type BranchPickerPrimitiveNextProps, type BranchPickerPrimitiveNumberProps, type BranchPickerPrimitivePreviousProps, type BranchPickerPrimitiveRootProps, type ChatModelAdapter, type ChatModelRunOptions, _default$5 as Composer, type ComposerContextValue, type ComposerInputProps, index$3 as ComposerPrimitive, type ComposerPrimitiveCancelProps, type ComposerPrimitiveIfProps, type ComposerPrimitiveInputProps, type ComposerPrimitiveRootProps, type ComposerPrimitiveSendProps, type ComposerState, exports as ContentPart, type ContentPartContextValue, index$2 as ContentPartPrimitive, type ContentPartPrimitiveDisplayProps, type ContentPartPrimitiveImageProps, type ContentPartPrimitiveInProgressProps, type ContentPartPrimitiveTextProps, type ContentPartState, type CoreAssistantContentPart, type CoreAssistantMessage, type CoreThreadMessage, type CoreUserContentPart, type CoreUserMessage, _default$4 as EditComposer, type EditComposerState, internal as INTERNAL, type ImageContentPart, type ImageContentPartComponent, type ImageContentPartProps, type MessageContextValue, index$1 as MessagePrimitive, type MessagePrimitiveContentProps, type MessagePrimitiveIfProps, type MessagePrimitiveInProgressProps, type MessagePrimitiveRootProps, type MessageState, type MessageStatus, type MessageUtilsState, type ModelConfig, type ModelConfigProvider, type ReactThreadRuntime, type StringsConfig, type SuggestionConfig, type TextContentPart, type TextContentPartComponent, type TextContentPartProps, _default$3 as Thread, type ThreadActionsState, type ThreadAssistantContentPart, type ThreadAssistantMessage, type ThreadConfig, ThreadConfigProvider, type ThreadConfigProviderProps, type ThreadContextValue, type ThreadMessage, type ThreadMessagesState, index as ThreadPrimitive, type ThreadPrimitiveEmptyProps, type ThreadPrimitiveIfProps, type ThreadPrimitiveMessagesProps, type ThreadPrimitiveRootProps, type ThreadPrimitiveScrollToBottomProps, type ThreadPrimitiveSuggestionProps, type ThreadPrimitiveViewportProps, type ThreadRootProps, type ThreadRuntime, type ThreadState, type ThreadSystemMessage, type ThreadUserContentPart, type ThreadUserMessage, type ThreadViewportState, _default as ThreadWelcome, type ThreadWelcomeConfig, type ThreadWelcomeMessageProps, type ThreadWelcomeSuggestionProps, type ToolCallContentPart, type ToolCallContentPartComponent, type ToolCallContentPartProps, type UIContentPart, type UIContentPartComponent, type UIContentPartProps, type Unsubscribe, type UseActionBarCopyProps, _default$1 as UserActionBar, _default$2 as UserMessage, type UserMessageConfig, type UserMessageContentProps, makeAssistantTool, makeAssistantToolUI, useActionBarCopy, useActionBarEdit, useActionBarReload, useAppendMessage, useAssistantContext, useAssistantInstructions, useAssistantTool, useAssistantToolUI, useBranchPickerCount, useBranchPickerNext, useBranchPickerNumber, useBranchPickerPrevious, useComposerCancel, useComposerContext, useComposerIf, useComposerSend, useContentPartContext, useContentPartDisplay, useContentPartImage, useContentPartText, useEdgeRuntime, useLocalRuntime, useMessageContext, useMessageIf, useSwitchToNewThread, useThreadConfig, useThreadContext, useThreadEmpty, useThreadIf, useThreadScrollToBottom, useThreadSuggestion };
+export { index$6 as ActionBarPrimitive, type ActionBarPrimitiveCopyProps, type ActionBarPrimitiveEditProps, type ActionBarPrimitiveReloadProps, type ActionBarPrimitiveRootProps, type AddToolResultOptions, type AppendMessage, _default$9 as AssistantActionBar, type AssistantActionsState, type AssistantContextValue, _default$8 as AssistantMessage, type AssistantMessageConfig, type AssistantMessageContentProps, _default$7 as AssistantModal, index$5 as AssistantModalPrimitive, type AssistantModalPrimitiveContentProps, type AssistantModalPrimitiveRootProps, type AssistantModalPrimitiveTriggerProps, type AssistantModelConfigState, type AssistantRuntime, AssistantRuntimeProvider, type AssistantToolProps, type AssistantToolUIProps, type AssistantToolUIsState, _default$6 as BranchPicker, index$4 as BranchPickerPrimitive, type BranchPickerPrimitiveCountProps, type BranchPickerPrimitiveNextProps, type BranchPickerPrimitiveNumberProps, type BranchPickerPrimitivePreviousProps, type BranchPickerPrimitiveRootProps, type ChatModelAdapter, type ChatModelRunOptions, type ChatModelRunResult, type ChatModelRunUpdate, _default$5 as Composer, type ComposerContextValue, type ComposerInputProps, index$3 as ComposerPrimitive, type ComposerPrimitiveCancelProps, type ComposerPrimitiveIfProps, type ComposerPrimitiveInputProps, type ComposerPrimitiveRootProps, type ComposerPrimitiveSendProps, type ComposerState, exports as ContentPart, type ContentPartContextValue, index$2 as ContentPartPrimitive, type ContentPartPrimitiveDisplayProps, type ContentPartPrimitiveImageProps, type ContentPartPrimitiveInProgressProps, type ContentPartPrimitiveTextProps, type ContentPartState, type CoreAssistantContentPart, type CoreAssistantMessage, type CoreMessage, type CoreSystemMessage, type CoreUserContentPart, type CoreUserMessage, EdgeChatAdapter, type EdgeRuntimeOptions, _default$4 as EditComposer, type EditComposerState, internal as INTERNAL, type ImageContentPart, type ImageContentPartComponent, type ImageContentPartProps, type LocalRuntimeOptions, type MessageContextValue, index$1 as MessagePrimitive, type MessagePrimitiveContentProps, type MessagePrimitiveIfProps, type MessagePrimitiveInProgressProps, type MessagePrimitiveRootProps, type MessageState, type MessageStatus, type MessageUtilsState, type ModelConfig, type ModelConfigProvider, type ReactThreadRuntime, type StringsConfig, type SuggestionConfig, type TextContentPart, type TextContentPartComponent, type TextContentPartProps, _default$3 as Thread, type ThreadActionsState, type ThreadAssistantContentPart, type ThreadAssistantMessage, type ThreadConfig, ThreadConfigProvider, type ThreadConfigProviderProps, type ThreadContextValue, type ThreadMessage, type ThreadMessagesState, index as ThreadPrimitive, type ThreadPrimitiveEmptyProps, type ThreadPrimitiveIfProps, type ThreadPrimitiveMessagesProps, type ThreadPrimitiveRootProps, type ThreadPrimitiveScrollToBottomProps, type ThreadPrimitiveSuggestionProps, type ThreadPrimitiveViewportProps, type ThreadRootProps, type ThreadRuntime, type ThreadState, type ThreadSystemMessage, type ThreadUserContentPart, type ThreadUserMessage, type ThreadViewportState, _default as ThreadWelcome, type ThreadWelcomeConfig, type ThreadWelcomeMessageProps, type ThreadWelcomeSuggestionProps, type Tool, type ToolCallContentPart, type ToolCallContentPartComponent, type ToolCallContentPartProps, type UIContentPart, type UIContentPartComponent, type UIContentPartProps, type Unsubscribe, type UseActionBarCopyProps, _default$1 as UserActionBar, _default$2 as UserMessage, type UserMessageConfig, type UserMessageContentProps, fromCoreMessages, fromLanguageModelMessages, makeAssistantTool, makeAssistantToolUI, toLanguageModelMessages, useActionBarCopy, useActionBarEdit, useActionBarReload, useAppendMessage, useAssistantContext, useAssistantInstructions, useAssistantTool, useAssistantToolUI, useBranchPickerCount, useBranchPickerNext, useBranchPickerNumber, useBranchPickerPrevious, useComposerCancel, useComposerContext, useComposerIf, useComposerSend, useContentPartContext, useContentPartDisplay, useContentPartImage, useContentPartText, useEdgeRuntime, useLocalRuntime, useMessageContext, useMessageIf, useSwitchToNewThread, useThreadConfig, useThreadContext, useThreadEmpty, useThreadIf, useThreadScrollToBottom, useThreadSuggestion };