@assistant-ui/react
Version:
TypeScript/React library for AI Chat
79 lines • 3.98 kB
TypeScript
import { AppendMessage, ThreadMessage } from "../../../types/index.js";
import { AttachmentAdapter } from "../adapters/attachment/index.js";
import { AddToolResultOptions, ResumeRunConfig, StartRunConfig, ThreadSuggestion } from "../core/ThreadRuntimeCore.js";
import { FeedbackAdapter } from "../adapters/feedback/FeedbackAdapter.js";
import { SpeechSynthesisAdapter } from "../adapters/speech/SpeechAdapterTypes.js";
import { ThreadMessageLike } from "./ThreadMessageLike.js";
import { ExportedMessageRepository } from "../utils/MessageRepository.js";
import type { ReadonlyJSONValue } from "assistant-stream/utils";
export type ExternalStoreThreadData<TState extends "regular" | "archived"> = {
status: TState;
id: string;
remoteId?: string | undefined;
externalId?: string | undefined;
title?: string | undefined;
};
export type ExternalStoreThreadListAdapter = {
/**
* @deprecated This API is still under active development and might change without notice.
*/
threadId?: string | undefined;
isLoading?: boolean | undefined;
threads?: readonly ExternalStoreThreadData<"regular">[] | undefined;
archivedThreads?: readonly ExternalStoreThreadData<"archived">[] | undefined;
/**
* @deprecated This API is still under active development and might change without notice.
*/
onSwitchToNewThread?: (() => Promise<void> | void) | undefined;
/**
* @deprecated This API is still under active development and might change without notice.
*/
onSwitchToThread?: ((threadId: string) => Promise<void> | void) | undefined;
onRename?: (threadId: string, newTitle: string) => (Promise<void> | void) | undefined;
onArchive?: ((threadId: string) => Promise<void> | void) | undefined;
onUnarchive?: ((threadId: string) => Promise<void> | void) | undefined;
onDelete?: ((threadId: string) => Promise<void> | void) | undefined;
};
export type ExternalStoreMessageConverter<T> = (message: T, idx: number) => ThreadMessageLike;
type ExternalStoreMessageConverterAdapter<T> = {
convertMessage: ExternalStoreMessageConverter<T>;
};
type ExternalStoreAdapterBase<T> = {
isDisabled?: boolean | undefined;
isRunning?: boolean | undefined;
isLoading?: boolean | undefined;
messages?: readonly T[];
messageRepository?: ExportedMessageRepository;
suggestions?: readonly ThreadSuggestion[] | undefined;
state?: ReadonlyJSONValue | undefined;
extras?: unknown;
setMessages?: ((messages: readonly T[]) => void) | undefined;
onImport?: ((messages: readonly ThreadMessage[]) => void) | undefined;
onLoadExternalState?: ((state: any) => void) | undefined;
onNew: (message: AppendMessage) => Promise<void>;
onEdit?: ((message: AppendMessage) => Promise<void>) | undefined;
onReload?: ((parentId: string | null, config: StartRunConfig) => Promise<void>) | undefined;
onResume?: ((config: ResumeRunConfig) => Promise<void>) | undefined;
onCancel?: (() => Promise<void>) | undefined;
onAddToolResult?: ((options: AddToolResultOptions) => Promise<void> | void) | undefined;
onResumeToolCall?: ((options: {
toolCallId: string;
payload: unknown;
}) => void) | undefined;
convertMessage?: ExternalStoreMessageConverter<T> | undefined;
adapters?: {
attachments?: AttachmentAdapter | undefined;
speech?: SpeechSynthesisAdapter | undefined;
feedback?: FeedbackAdapter | undefined;
/**
* @deprecated This API is still under active development and might change without notice.
*/
threadList?: ExternalStoreThreadListAdapter | undefined;
} | undefined;
unstable_capabilities?: {
copy?: boolean | undefined;
} | undefined;
};
export type ExternalStoreAdapter<T = ThreadMessage> = ExternalStoreAdapterBase<T> & (T extends ThreadMessage ? object : ExternalStoreMessageConverterAdapter<T>);
export {};
//# sourceMappingURL=ExternalStoreAdapter.d.ts.map