@deep-eye/core 0.9.0 → 1.0.0

package/dist/components/chat/types.d.ts

@@ -1,26 +1,183 @@
 import type { Component, Ref } from 'vue';
-/** The three OpenAI chat roles rendered by AiConversation. */
-export type ConversationRole = 'user' | 'assistant' | 'tool';
+export type ConversationRole = 'system' | 'user' | 'assistant' | 'tool';
 export type AutoScrollMode = 'always' | 'smart' | 'off';
-export type ConversationStreamStatus = 'idle' | 'streaming' | 'completed' | 'aborted' | 'error';
-export type ToolCallStatus = 'pending' | 'running' | 'success' | 'error';
-/**
- * OpenAI-compatible message data accepted by AiConversation.
- *
- * `isStreaming` is an optional rendering hint maintained by useConversation;
- * callers passing static OpenAI messages never need to set it.
- */
-export interface ConversationMessage {
+export type ConversationStreamStatus = 'idle' | 'streaming' | 'completed' | 'incomplete' | 'aborted' | 'error';
+export type ToolCallStatus = 'pending' | 'requires-approval' | 'running' | 'success' | 'error' | 'denied' | 'cancelled' | 'requires-action';
+export interface ChatToolState {
+    status: ToolCallStatus;
+    error?: string;
+    arguments?: string;
+    isArgumentsEditable?: boolean;
+}
+export type ChatToolStates = Readonly<Record<string, ChatToolState>>;
+export type ChatColorMode = 'light' | 'dark' | 'auto';
+export type ChatFileCategory = 'image' | 'document' | 'audio' | 'video' | 'unsupported';
+export type ChatPreviewKind = 'image' | 'pdf' | 'docx' | 'excel' | 'pptx' | 'html' | 'text' | 'audio' | 'video' | 'unsupported';
+export interface ChatResourceFile {
+    fileName: string;
+    fileType: string;
+    size: number;
+    url: string;
+}
+export interface QiniuUploadFileItem {
     id: string;
-    role: ConversationRole;
-    content?: string;
-    /** Visible reasoning text, rendered separately from the final answer. */
-    reasoning?: string;
-    isStreaming?: boolean;
-    tool_calls?: ConversationToolCall[];
-    toolStatus?: ToolCallStatus;
-    toolResult?: unknown;
-    toolError?: string;
+    bucketType: number;
+    fileKey: string;
+    fileName: string;
+    fileType: string;
+    fileMineType: string;
+    mimeType: string;
+    size: number;
+    duration: number;
+    w: number;
+    h: number;
+    status: number;
+    url: string;
+}
+export interface ChatAttachmentLimits {
+    maxFiles: number;
+    imageMaxSize: number;
+    documentMaxSize: number;
+    audioMaxSize: number;
+    videoMaxSize: number;
+}
+export interface ChatUploadConfig {
+    cloudBaseUrl: string;
+    credentialHeaders?: () => HeadersInit | Promise<HeadersInit>;
+    dir?: string;
+    limits?: Partial<ChatAttachmentLimits>;
+}
+export interface ChatAttachmentMenuItem {
+    id: string;
+    label: string;
+    icon: Component;
+    disabled?: boolean;
+}
+/** A quick-access mode button rendered after the `+` attachment icon (Doubao-style). */
+export interface ChatSenderQuickAction {
+    id: string;
+    label: string;
+    icon?: Component;
+    /** Overrides the textarea placeholder while this action is active. */
+    placeholder?: string;
+}
+export interface QiniuUploadCredential {
+    uptoken: string;
+    fileKey: string;
+    uploadUrl: string;
+}
+export interface ChatAttachmentError {
+    code: 'unsupported_type' | 'file_too_large' | 'too_many_files' | 'duplicate_file' | 'missing_config' | 'credential_error' | 'upload_error' | 'invalid_response';
+    message: string;
+}
+interface ChatComposerAttachmentBase {
+    id: string;
+    previewUrl?: string;
+}
+export interface UploadingChatAttachment extends ChatComposerAttachmentBase {
+    status: 'uploading';
+    file: File;
+    progress: number;
+}
+export interface FailedChatAttachment extends ChatComposerAttachmentBase {
+    status: 'error';
+    file: File;
+    progress: number;
+    error: ChatAttachmentError;
+}
+export interface UploadedChatAttachment extends ChatComposerAttachmentBase {
+    status: 'uploaded';
+    uploadResult: QiniuUploadFileItem;
+    resource: ChatResourceFile;
+}
+export type ChatComposerAttachment = UploadingChatAttachment | FailedChatAttachment | UploadedChatAttachment;
+export interface ImagePixelLimit {
+    max_pixels?: number;
+    min_pixels?: number;
+}
+export interface ConversationTextPart {
+    type: 'text';
+    text: string;
+}
+export interface ConversationImagePart {
+    type: 'image_url';
+    image_url: ({
+        url: string;
+        file_id?: never;
+    } | {
+        url?: never;
+        file_id: string;
+    }) & {
+        detail?: 'low' | 'high' | 'xhigh';
+        image_pixel_limit?: ImagePixelLimit | null;
+    };
+}
+export interface ConversationVideoPart {
+    type: 'video_url';
+    video_url: ({
+        url: string;
+        file_id?: never;
+    } | {
+        url?: never;
+        file_id: string;
+    }) & {
+        detail?: string;
+        fps?: number;
+        image_pixel_limit?: ImagePixelLimit | null;
+    };
+}
+export interface ConversationAudioPart {
+    type: 'input_audio';
+    input_audio: {
+        url: string;
+        file_id?: never;
+        data?: never;
+        format?: string;
+    } | {
+        url?: never;
+        file_id: string;
+        data?: never;
+        format?: string;
+    } | {
+        url?: never;
+        file_id?: never;
+        data: string;
+        format: string;
+    };
+}
+export interface ConversationFilePart {
+    type: 'file';
+    file: {
+        file_url: string;
+        file_id?: never;
+        file_data?: never;
+        filename?: string;
+    } | {
+        file_url?: never;
+        file_id: string;
+        file_data?: never;
+        filename?: string;
+    } | {
+        file_url?: never;
+        file_id?: never;
+        file_data: string;
+        filename: string;
+    };
+}
+export type ConversationContentPart = ConversationTextPart | ConversationImagePart | ConversationVideoPart | ConversationAudioPart | ConversationFilePart;
+export type ConversationInputContent = string | ConversationContentPart[];
+export interface SystemMessage {
+    id?: string;
+    role: 'system';
+    content: ConversationInputContent;
+    name?: string;
+}
+export interface UserMessage {
+    id?: string;
+    role: 'user';
+    content: ConversationInputContent;
+    resource_files: ChatResourceFile[];
+    name?: string;
 }
 export interface ConversationToolCall {
     id: string;
@@ -30,90 +187,65 @@ export interface ConversationToolCall {
         arguments: string;
     };
 }
+export interface ChatToolActionPayload {
+    action: 'approve' | 'deny' | 'cancel' | 'submit-action';
+    toolCall: ConversationToolCall;
+    arguments: string;
+}
+export interface AssistantMessage {
+    id?: string;
+    role: 'assistant';
+    content?: string;
+    encrypted_content?: string;
+    name?: string;
+    reasoning_content?: string;
+    tool_calls?: ConversationToolCall[];
+    /** GA-only original file metadata surfaced from `response.output_item.done`. */
+    resource_files?: Record<string, unknown>[];
+}
+export interface ToolMessage {
+    id?: string;
+    role: 'tool';
+    content: string;
+    tool_call_id: string;
+    name?: string;
+}
+export type ConversationMessage = SystemMessage | UserMessage | AssistantMessage | ToolMessage;
+export interface ChatModelInput {
+    role: 'user';
+    content: ConversationContentPart[];
+}
+export interface ChatSendPayload {
+    message: UserMessage;
+    modelInput: ChatModelInput;
+    attachments: readonly UploadedChatAttachment[];
+}
+export interface ChatQueueItem {
+    id: string;
+    payload: ChatSendPayload;
+}
 export interface OpenGenUIContent {
     type: string;
     [key: string]: unknown;
 }
 export type ToolRenderer = Component;
+export type ChatPreviewRenderer = Component;
+export type ChatPreviewRendererMap = Partial<Record<ChatPreviewKind | string, ChatPreviewRenderer>>;
+export type ChatToolRendererMap = Record<string, ToolRenderer>;
 export interface ChatActionbarCopyPayload {
-    message: ConversationMessage;
+    message: AssistantMessage;
     text: string;
 }
 export interface ChatMessageProps {
     message: ConversationMessage;
+    streaming?: boolean;
+    toolMessages?: readonly ToolMessage[];
     theme?: ConversationTheme;
     userAvatar?: string;
     assistantAvatar?: string;
+    toolStates?: ChatToolStates;
 }
-export interface ConversationToolCallDelta {
-    /** Index into the assistant message's tool_calls array. */
-    index: number;
-    id?: string;
-    function?: {
-        name?: string;
-        argumentsDelta?: string;
-    };
-    /** Required for unambiguous lifecycle updates when several tools are active. */
-    toolStatus?: ToolCallStatus;
-    toolResult?: unknown;
-    toolError?: string;
-}
-/**
- * A frontend-friendly form of `choices[0].delta`.
- *
- * `id` is the local ConversationMessage id.
- */
-export interface ConversationDelta {
-    id: string;
-    role?: ConversationRole;
-    contentDelta?: string;
-    /** Incremental visible reasoning text. */
-    reasoningDelta?: string;
-    done?: boolean;
-}
-/** A function call delta in an OpenAI-compatible chat completion chunk. */
-export interface OpenAiChatCompletionToolCallDelta {
-    index: number;
-    id?: string;
-    type?: 'function';
-    function?: {
-        name?: string;
-        arguments?: string;
-    };
-}
-/** The `choices[].delta` payload in an OpenAI-compatible SSE chunk. */
-export interface OpenAiChatCompletionDelta {
-    role?: 'assistant';
-    content?: string | null;
-    /** Used by reasoning-capable OpenAI-compatible providers. */
-    reasoning_content?: string | null;
-    /** Alternate field used by some OpenAI-compatible providers. */
-    reasoning?: string | null;
-    tool_calls?: OpenAiChatCompletionToolCallDelta[];
-}
-/** One choice in an OpenAI-compatible `chat.completion.chunk` response. */
-export interface OpenAiChatCompletionChoice {
-    index: number;
-    delta: OpenAiChatCompletionDelta;
-    /** `null`, `"null"`, and `""` mean that streaming continues. */
-    finish_reason: string | null;
-}
-/**
- * OpenAI-compatible SSE payload accepted by `useConversation().appendDelta`.
- * `session_id` is included for compatible backends.
- */
-export interface OpenAiChatCompletionChunk {
-    id: string;
-    object: 'chat.completion.chunk';
-    created: number;
-    model: string;
-    session_id?: string;
-    choices: OpenAiChatCompletionChoice[];
-}
-/** Input accepted by `useConversation().appendDelta`. */
-export type ConversationStreamInput = ConversationDelta | OpenAiChatCompletionChunk | string;
-export interface ConversationTheme {
-    /** CSS custom-property references supplied by the consuming design system. */
+export interface ChatTheme {
     userBubbleBg?: string;
     userBubbleColor?: string;
     userBubbleBorderColor?: string;
@@ -128,103 +260,284 @@ export interface ConversationTheme {
     toolErrorColor?: string;
     borderRadius?: string;
     spacing?: string;
+    inputBg?: string;
+    inputBorder?: string;
+    inputFocusBorder?: string;
+    buttonPrimaryBg?: string;
+    buttonPrimaryColor?: string;
+    buttonSecondaryBg?: string;
+    buttonSecondaryColor?: string;
 }
+export type ConversationTheme = ChatTheme;
 export interface ConversationAskFormAnswer {
     formId: string;
     question: string;
     value: string;
     label?: string;
-    /** True when an optional question was skipped. */
     skipped?: boolean;
 }
-/** Bubbled from interactive content tags such as ask-form or artifact. */
 export interface ConversationUiAction {
     type: 'submit' | 'open-artifact';
     value?: string;
     label?: string;
     source?: string;
-    /** Stable form identifier from `ask-form id`; falls back to the parsed node id. */
     formId?: string;
-    /** The ask-form question associated with this submission. */
     question?: string;
-    /** All answers from a multi-question ask-form submission, in display order. */
     answers?: ConversationAskFormAnswer[];
-    /** `open-artifact` payload: stable id from `artifact id`, falls back to the parsed node id. */
     artifactId?: string;
-    /** `open-artifact` payload: card title. */
     title?: string;
-    /** `open-artifact` payload: html|code|markdown|text (text) or pdf|word|excel|ppt|zip|file (file). */
     artifactType?: string;
-    /** `open-artifact` payload: language annotation when artifactType is `code`. */
     language?: string;
-    /** `open-artifact` payload: inline content for text-type artifacts (from `slotText`). */
     content?: string;
-    /** `open-artifact` payload: file URL for file-type artifacts. */
     src?: string;
 }
-export interface AiConversationProps {
-    /** Accepts a static array or the messages Ref returned by conversation composables. */
-    messages: readonly ConversationMessage[] | Ref<readonly ConversationMessage[]>;
+export interface ConversationListConfig {
     theme?: ConversationTheme;
     autoScroll?: AutoScrollMode;
-    /** 用户头像 URL；未传且无 `#user-avatar` 插槽时不显示头像 */
     userAvatar?: string;
-    /** 助手头像 URL；未传时使用内置标识 */
     assistantAvatar?: string;
+    toolStates?: ChatToolStates;
 }
-export interface AiConversationExpose {
+export interface ConversationListProps extends ConversationListConfig {
+    messages: readonly ConversationMessage[];
+    streamingMessageIndex?: number;
+    status?: ConversationStreamStatus;
+}
+export interface ConversationListExpose {
     scrollToBottom: () => void;
 }
 export interface UseConversationReturn {
     messages: Ref<ConversationMessage[]>;
-    appendDelta: (delta: ConversationStreamInput) => void;
-    setMessages: (messages: ConversationMessage[]) => void;
-    reset: () => void;
-}
-export interface ConversationStreamConsumeOptions {
-    /** Continue the last assistant message and ignore already consumed event IDs. */
-    resume?: boolean;
-    signal?: AbortSignal;
-}
-export type ConversationStreamSource = Response | Promise<Response> | ReadableStream<Uint8Array>;
-export interface UseConversationStreamReturn {
-    messages: Ref<ConversationMessage[]>;
-    status: Ref<ConversationStreamStatus>;
-    error: Ref<Error | null>;
-    /** `event: session` data used only by the runKeep resume request. */
-    runSessionId: Ref<string | null>;
-    /** Chunk `session_id` used by the next runKeep chat request. */
-    chatSessionId: Ref<string | null>;
-    /** Last successfully consumed numeric SSE id; `-1` before the first event. */
-    lastEventId: Ref<number>;
-    consume: (input: ConversationStreamSource, options?: ConversationStreamConsumeOptions) => Promise<void>;
-    abort: () => void;
+    appendMessage: (message: ConversationMessage) => void;
+    setMessages: (messages: readonly ConversationMessage[]) => void;
     reset: () => void;
 }
-export interface ChatSenderTheme {
-    inputBg?: string;
-    inputBorder?: string;
-    inputFocusBorder?: string;
-    buttonPrimaryBg?: string;
-    buttonPrimaryColor?: string;
-    buttonSecondaryBg?: string;
-    buttonSecondaryColor?: string;
-}
 export interface ChatSenderProps {
     placeholder?: string;
     disabled?: boolean;
     showAttachment?: boolean;
-    showToolbar?: boolean;
     maxRows?: number;
-    modelValue?: string;
-    theme?: ChatSenderTheme;
+    draft?: string;
+    attachments?: readonly ChatComposerAttachment[];
+    uploadConfig?: ChatUploadConfig;
+    attachmentLimits?: Partial<ChatAttachmentLimits>;
+    streaming?: boolean;
+    theme?: ChatTheme;
+    showScreenshot?: boolean;
+    customMenuItems?: readonly ChatAttachmentMenuItem[];
+    quickActions?: readonly ChatSenderQuickAction[];
+    activeQuickAction?: string | null;
+}
+export type ResponseStatus = 'in_progress' | 'completed' | 'incomplete' | 'failed';
+export type ResponseOutputItemStatus = 'in_progress' | 'completed' | 'incomplete' | 'failed';
+export interface ResponseOutputTextPart {
+    type: 'output_text';
+    text: string;
+    [key: string]: unknown;
+}
+export interface ResponseUnknownContentPart {
+    type: string;
+    [key: string]: unknown;
+}
+export type ResponseMessageContentPart = ResponseOutputTextPart | ResponseUnknownContentPart;
+export interface ResponseOutputMessage {
+    type: 'message';
+    id?: string;
+    role: 'assistant';
+    content: ResponseMessageContentPart[];
+    status?: ResponseOutputItemStatus;
+    [key: string]: unknown;
+}
+export interface ResponseReasoningSummaryPart {
+    type: 'summary_text';
+    text?: string;
+    [key: string]: unknown;
+}
+export interface ResponseReasoningTextPart {
+    type: 'reasoning_text';
+    text: string;
+    [key: string]: unknown;
+}
+export interface ResponseReasoningItem {
+    type: 'reasoning';
+    id?: string;
+    summary?: ResponseReasoningSummaryPart[];
+    content?: ResponseReasoningTextPart[];
+    encrypted_content?: string;
+    status?: ResponseOutputItemStatus;
+    [key: string]: unknown;
+}
+export interface ResponseFunctionCallItem {
+    type: 'function_call';
+    id?: string;
+    call_id: string;
+    name: string;
+    arguments: string;
+    status?: ResponseOutputItemStatus;
+    [key: string]: unknown;
+}
+export interface ResponseUnknownOutputItem {
+    type: string;
+    id?: string;
+    status?: string;
+    [key: string]: unknown;
+}
+export type ResponseOutputItem = ResponseOutputMessage | ResponseReasoningItem | ResponseFunctionCallItem | ResponseUnknownOutputItem;
+export interface ResponseError {
+    code?: string | null;
+    message: string;
+    [key: string]: unknown;
+}
+export interface ResponseObject {
+    created_at: number;
+    id: string;
+    max_output_tokens?: number | null;
+    model: string;
+    object: 'response';
+    output?: ResponseOutputItem[];
+    status?: ResponseStatus;
+    error?: ResponseError | null;
+    incomplete_details?: {
+        reason?: string;
+        [key: string]: unknown;
+    } | null;
+    instructions?: string | null;
+    previous_response_id?: string | null;
+    thinking?: {
+        type: 'enabled' | 'disabled' | 'auto';
+        [key: string]: unknown;
+    } | null;
+    service_tier?: string;
+    text?: Record<string, unknown>;
+    tools?: unknown[];
+    top_p?: number | null;
+    temperature?: number | null;
+    usage?: Record<string, unknown> | null;
+    store?: boolean;
+    caching?: Record<string, unknown>;
+    expire_at?: number | null;
+    context_management?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+interface ResponseStreamEventBase<T extends string> {
+    type: T;
+    sequence_number: number;
+}
+interface ResponseLifecycleEvent<T extends string> extends ResponseStreamEventBase<T> {
+    response: ResponseObject;
+}
+export type ResponseCreatedEvent = ResponseLifecycleEvent<'response.created'>;
+export type ResponseInProgressEvent = ResponseLifecycleEvent<'response.in_progress'>;
+export type ResponseCompletedEvent = ResponseLifecycleEvent<'response.completed'>;
+export type ResponseIncompleteEvent = ResponseLifecycleEvent<'response.incomplete'>;
+export type ResponseFailedEvent = ResponseLifecycleEvent<'response.failed'>;
+export interface ResponseOutputItemAddedEvent extends ResponseStreamEventBase<'response.output_item.added'> {
+    output_index: number;
+    item: ResponseOutputItem;
+}
+export interface ResponseOutputItemDoneEvent extends ResponseStreamEventBase<'response.output_item.done'> {
+    output_index: number;
+    item: ResponseOutputItem;
+    /** GA-only original file metadata attached to the completed output item. */
+    resource_files?: Record<string, unknown>;
+}
+export interface ResponseContentPartAddedEvent extends ResponseStreamEventBase<'response.content_part.added'> {
+    item_id: string;
+    output_index: number;
+    content_index: number;
+    part: ResponseMessageContentPart;
+}
+export interface ResponseContentPartDoneEvent extends ResponseStreamEventBase<'response.content_part.done'> {
+    item_id: string;
+    output_index: number;
+    content_index: number;
+    part: ResponseMessageContentPart;
+}
+export interface ResponseOutputTextDeltaEvent extends ResponseStreamEventBase<'response.output_text.delta'> {
+    item_id: string;
+    output_index: number;
+    content_index: number;
+    delta: string;
+}
+export interface ResponseOutputTextDoneEvent extends ResponseStreamEventBase<'response.output_text.done'> {
+    item_id: string;
+    output_index: number;
+    content_index: number;
+    text: string;
 }
+export interface ResponseReasoningSummaryPartAddedEvent extends ResponseStreamEventBase<'response.reasoning_summary_part.added'> {
+    item_id: string;
+    output_index: number;
+    summary_index: number;
+    part: ResponseReasoningSummaryPart;
+}
+export interface ResponseReasoningSummaryPartDoneEvent extends ResponseStreamEventBase<'response.reasoning_summary_part.done'> {
+    item_id: string;
+    output_index: number;
+    summary_index: number;
+    part: ResponseReasoningSummaryPart;
+}
+export interface ResponseReasoningSummaryTextDeltaEvent extends ResponseStreamEventBase<'response.reasoning_summary_text.delta'> {
+    item_id: string;
+    output_index: number;
+    summary_index: number;
+    delta: string;
+}
+export interface ResponseReasoningSummaryTextDoneEvent extends ResponseStreamEventBase<'response.reasoning_summary_text.done'> {
+    item_id: string;
+    output_index: number;
+    summary_index: number;
+    text: string;
+}
+export interface ResponseFunctionCallArgumentsDeltaEvent extends ResponseStreamEventBase<'response.function_call_arguments.delta'> {
+    item_id: string;
+    output_index: number;
+    delta: string;
+}
+export interface ResponseFunctionCallArgumentsDoneEvent extends ResponseStreamEventBase<'response.function_call_arguments.done'> {
+    item_id: string;
+    output_index: number;
+    arguments: string;
+}
+export interface ResponseApiErrorEvent extends ResponseStreamEventBase<'error'> {
+    code?: string | null;
+    message: string;
+    param?: string | null;
+}
+export type ResponseStreamEvent = ResponseCreatedEvent | ResponseInProgressEvent | ResponseCompletedEvent | ResponseIncompleteEvent | ResponseFailedEvent | ResponseOutputItemAddedEvent | ResponseOutputItemDoneEvent | ResponseContentPartAddedEvent | ResponseContentPartDoneEvent | ResponseOutputTextDeltaEvent | ResponseOutputTextDoneEvent | ResponseReasoningSummaryPartAddedEvent | ResponseReasoningSummaryPartDoneEvent | ResponseReasoningSummaryTextDeltaEvent | ResponseReasoningSummaryTextDoneEvent | ResponseFunctionCallArgumentsDeltaEvent | ResponseFunctionCallArgumentsDoneEvent | ResponseApiErrorEvent;
+export interface ResponseSseFrame {
+    event?: string;
+    id?: string;
+    retry?: number;
+    data: string;
+    raw: string;
+}
+export interface ChatBotConsumeOptions {
+    signal?: AbortSignal;
+    onEvent?: (event: ResponseStreamEvent, frame: ResponseSseFrame) => void;
+}
+export type ResponseStreamSource = Response | Promise<Response>;
 export interface ChatBotProps {
-    messages: readonly ConversationMessage[] | Ref<readonly ConversationMessage[]>;
+    messages: readonly ConversationMessage[];
+    draft?: string;
+    attachments?: readonly ChatComposerAttachment[];
     showSidebar?: boolean;
     sidebarWidth?: string | number;
     senderConfig?: Partial<ChatSenderProps>;
-    conversationConfig?: Partial<AiConversationProps>;
-    theme?: ConversationTheme;
+    conversationConfig?: ConversationListConfig;
+    theme?: ChatTheme;
+    colorMode?: ChatColorMode;
+    uploadConfig?: ChatUploadConfig;
+    attachmentLimits?: Partial<ChatAttachmentLimits>;
+    previewRenderers?: ChatPreviewRendererMap;
+    toolRenderers?: ChatToolRendererMap;
+    toolStates?: ChatToolStates;
+}
+export interface ChatBotExpose {
+    consume: (input: ResponseStreamSource, options?: ChatBotConsumeOptions) => Promise<void>;
+    abort: () => void;
+    scrollToBottom: () => void;
+    sendNextQueued: () => void;
 }
+export {};
 //# sourceMappingURL=types.d.ts.map