@yumiai/chat-widget 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,458 @@
+import React from 'react';
+
+type MessageContentType = 'text' | 'think' | 'plan' | 'artifact' | 'json_schema' | 'html_schema' | 'json_schema_wait';
+type NotificationType = 'user_input' | 'node_notification' | 'start' | 'model_start' | 'model_result' | 'model_end' | 'agent_start' | 'agent_result' | 'agent_end' | 'artifact_start' | 'artifact_result' | 'artifact_end' | 'plan_start' | 'plan_result' | 'plan_end' | 'mcp_generating' | 'mcp_start' | 'mcp_result' | 'mcp_end' | 'finish' | 'canceled' | 'error' | 'human_input_request' | 'human_input_received' | 'human_input_timeout' | 'human_input_completed' | 'session_title' | 'compression_started' | 'compression_completed' | 'node_summary';
+interface UiConfig {
+    display_type: 'content' | 'command' | 'browser' | 'query' | 'path' | 'trigger' | 'thinking' | 'params';
+    icon?: string;
+    primary_field?: string;
+    header_field?: string;
+    compact_fields?: string[];
+    hide_fields?: string[];
+}
+interface SSEMessage {
+    interaction_id: string;
+    agent_instance_id: number;
+    call_batch_id: string;
+    parent_call_batch_id?: string;
+    level: number;
+    agent_name: string;
+    task_purpose?: string;
+    notification_type?: NotificationType;
+    tool_name?: string;
+    tool_call_id?: string;
+    tool_status?: 'success' | 'error';
+    args_preview?: string;
+    ui_config?: UiConfig;
+    parent_tool_call_id?: string;
+    content_type: MessageContentType;
+    content: string;
+    timestamp?: string;
+}
+interface PlanItem {
+    text: string;
+    status: 'pending' | 'active' | 'completed' | 'error';
+}
+interface TaskPlan {
+    title?: string;
+    items: PlanItem[];
+    progress: {
+        completed: number;
+        total: number;
+    };
+}
+type TodoTaskStatus = 'pending' | 'in_progress' | 'completed' | 'blocked';
+interface TodoTask {
+    id: string | null;
+    description: string;
+    status: TodoTaskStatus;
+    children: TodoTask[];
+}
+interface TodoGroup {
+    name: string;
+    status: TodoTaskStatus;
+    tasks: TodoTask[];
+}
+interface TodoPhase {
+    name: string;
+    status: TodoTaskStatus;
+    groups: TodoGroup[];
+    tasks: TodoTask[];
+}
+interface TodoStats {
+    total: number;
+    completed: number;
+    in_progress: number;
+    pending: number;
+    blocked: number;
+}
+interface TodoData {
+    title: string;
+    phases: TodoPhase[];
+    stats: TodoStats;
+}
+interface TodoNotificationContent {
+    operation: 'checklist_edit';
+    plan_id: string;
+    checklist_path: string;
+    checklist_content: string;
+    checklist: TodoData;
+    source_type: 'checklist_edit';
+}
+declare function isTodoNotificationContent(data: unknown): data is TodoNotificationContent;
+interface Artifact {
+    id: string;
+    name: string;
+    type: string;
+    size?: string;
+    content?: string;
+    preview?: string;
+    metadata?: {
+        gitPath?: string;
+        gitCommitHash?: string;
+        createdByAgentId?: string;
+        operationType?: string;
+    };
+}
+interface HITLRequest {
+    await_command_uuid: string;
+    schema_type: 'json_schema' | 'html_schema';
+    schema: object | string;
+    title?: string;
+    description?: string;
+}
+interface HITLResponse {
+    await_command_uuid: string;
+    data: unknown;
+    confirmed: boolean;
+}
+interface AggregatedMessage {
+    id: string;
+    agentInstanceId: number;
+    callBatchId: string;
+    parentCallBatchId?: string;
+    level: number;
+    agentName: string;
+    taskPurpose?: string;
+    notificationType?: NotificationType;
+    toolName?: string;
+    toolCallId?: string;
+    toolStatus?: 'success' | 'error';
+    toolPhase?: 'generating' | 'executing' | 'complete' | 'error';
+    argsPreview?: string;
+    uiConfig?: UiConfig;
+    parentToolCallId?: string;
+    contentType: MessageContentType;
+    contentChunks: string[];
+    timestamp: string;
+    plan?: TaskPlan;
+    artifact?: Artifact;
+    artifacts?: Artifact[];
+    hitlRequest?: HITLRequest;
+}
+interface Round {
+    interactionId: string;
+    index: number;
+    userMessage: string;
+    timestamp: string;
+    status: 'running' | 'completed' | 'error';
+    plan?: TaskPlan;
+    messages: AggregatedMessage[];
+    topPosition?: number;
+}
+type ExecutionStatus = 'idle' | 'running' | 'compressing' | 'completed' | 'error';
+interface ChatWidgetConfig {
+    showPinnedArea?: boolean;
+    showPlan?: boolean;
+    enableTypewriter?: boolean;
+    typewriterSpeed?: number;
+    autoScroll?: boolean;
+    childAgentMaxHeight?: number;
+    theme?: 'light' | 'dark' | 'auto';
+    displayLevels?: number[];
+}
+declare const DEFAULT_CONFIG: Required<ChatWidgetConfig>;
+interface ChatWidgetProps {
+    adapter: ChatWidgetAdapter;
+    sessionId?: string | number;
+    initialMessages?: Round[];
+    config?: ChatWidgetConfig;
+    renderHeaderExtra?: (sessionId: string | number) => React.ReactNode;
+    renderFooter?: (api: ChatWidgetAPI | null) => React.ReactNode;
+    renderToolResult?: (displayType: string, data: ToolCallData) => React.ReactNode | null;
+    locale?: 'zh-CN' | 'en-US';
+    onArtifactClick?: (artifact: Artifact) => void;
+    onHITLSubmit?: (response: HITLResponse) => Promise<void>;
+    onStatusChange?: (status: ExecutionStatus) => void;
+    onError?: (error: Error) => void;
+    onReady?: (api: ChatWidgetAPI) => void;
+    className?: string;
+    style?: React.CSSProperties;
+    height?: number | string;
+}
+interface ChatWidgetAPI {
+    sendMessage: (message: string, agentId?: string) => void;
+    getCurrentRound: () => Round | null;
+    getAllRounds: () => Round[];
+    scrollToBottom: () => void;
+    getStatus: () => ExecutionStatus;
+}
+interface ToolCallData {
+    tool_name: string;
+    display_type: string;
+    args: Record<string, unknown>;
+    args_preview?: Record<string, unknown>;
+    result?: unknown;
+    status: 'pending' | 'running' | 'completed' | 'failed';
+    ui_config?: UiConfig;
+}
+interface NotificationTurn {
+    type: string;
+    contents: Array<{
+        type?: string;
+        content?: string;
+        read?: boolean;
+    }>;
+    timestamp: number | null;
+    session_id: number;
+    interaction_id: string;
+    agent_id: string | null;
+    agent_instance_id: number;
+    parent_agent_instance_id: number;
+    call_batch_id: number;
+    parent_call_batch_id: number | null;
+    level: number | null;
+    card_title: string | null;
+    caller_type: string | null;
+    user_id: string | null;
+    ext: Record<string, unknown> | null;
+    turn_id: number;
+    turn_index: number;
+    status: string;
+    timestamp_start: number | null;
+    timestamp_end: number | null;
+}
+interface ResourceContent {
+    resource_id: string;
+    file_name: string;
+    git_path: string;
+    mime_type: string | null;
+    is_text_readable: boolean | null;
+    file_size: number | null;
+    is_binary: boolean;
+    content: string;
+}
+interface SessionDetail {
+    session_id: number;
+    session_title?: string;
+    status?: string;
+    created_at?: string;
+}
+interface ChatWidgetAdapter {
+    createSession(agentId: string): Promise<{
+        sessionId: number;
+        instanceId: number;
+    }>;
+    getSessionDetail(sessionId: number): Promise<SessionDetail>;
+    getSessionHistory(sessionId: number): Promise<NotificationTurn[]>;
+    getResourceContent(sessionId: number, resourceId: string): Promise<ResourceContent>;
+    submitHITLResponse(response: HITLResponse): Promise<void>;
+    getStreamUrl(): string;
+    getAuthHeaders(): Record<string, string>;
+    getExtraHeaders?(): Record<string, string>;
+    onAuthFailure?(): void;
+    refreshAuth?(): Promise<boolean>;
+}
+declare function mergeConsecutiveThinkMessages(messages: AggregatedMessage[]): AggregatedMessage[];
+interface TodoCardProps {
+    todo: TodoData;
+    compact?: boolean;
+}
+interface PinnedAreaProps {
+    round: Round | null;
+    isTransitioning: boolean;
+    config?: ChatWidgetConfig;
+    todoMap?: Map<string, TodoData>;
+}
+interface RoundHeaderProps {
+    round: Round;
+    isPinned: boolean;
+    config?: ChatWidgetConfig;
+    todoMap?: Map<string, TodoData>;
+}
+interface MessageContentProps {
+    message: AggregatedMessage;
+    enableTypewriter?: boolean;
+    typewriterSpeed?: number;
+    onArtifactClick?: (artifact: Artifact) => void;
+}
+interface ChildAgentCardProps {
+    message: AggregatedMessage;
+    children: AggregatedMessage[];
+    maxHeight?: number;
+    config?: ChatWidgetConfig;
+    defaultExpanded?: boolean;
+    parentTaskPurpose?: string;
+}
+interface PlanCardProps {
+    plan: TaskPlan;
+    status: Round['status'];
+    compact?: boolean;
+}
+
+/**
+ * ChatWidget 主组件
+ *
+ * 严格按照设计文档实现：
+ * - SSE 消息流处理
+ * - 动态置顶（滚动切换，带防抖和滞后阈值）
+ * - 多轮对话展示
+ * - 平滑过渡动画（淡入淡出）
+ * - 子 Agent 卡片
+ * - Human-in-the-loop 支持
+ */
+
+declare const ChatWidget: React.FC<ChatWidgetProps>;
+
+/**
+ * SSE 连接 Hook (SDK version)
+ *
+ * Auth and headers are fully delegated to ChatWidgetAdapter,
+ * eliminating direct localStorage / env-var coupling.
+ */
+
+type ConnectionStatus = 'idle' | 'connecting' | 'connected' | 'disconnected' | 'error';
+interface UseSSEOptions {
+    adapter: ChatWidgetAdapter;
+    autoConnect?: boolean;
+    reconnectInterval?: number;
+    maxReconnectAttempts?: number;
+    onMessage?: (message: SSEMessage) => void;
+    onStatusChange?: (status: ConnectionStatus) => void;
+    onError?: (error: Error) => void;
+}
+interface UseSSEReturn {
+    status: ConnectionStatus;
+    connect: (url: string, body?: object) => void;
+    disconnect: () => void;
+}
+declare function useSSE(options: UseSSEOptions): UseSSEReturn;
+
+/**
+ * 消息聚合 Hook
+ *
+ * 实现高性能消息聚合：
+ * - Map 索引 O(1) 查找
+ * - 字符串数组延迟拼接
+ * - requestAnimationFrame 批量更新
+ * - 延迟 JSON 解析
+ */
+
+interface MessageAggregatorState {
+    rounds: Map<string, Round>;
+    currentInteractionId: string | null;
+}
+interface UseMessageAggregatorReturn {
+    state: MessageAggregatorState;
+    todoMap: Map<string, TodoData>;
+    processMessage: (message: SSEMessage) => void;
+    getRoundsList: () => Round[];
+    getCurrentRound: () => Round | null;
+    startNewRound: (interactionId: string, userMessage: string) => void;
+    loadRounds: (rounds: Round[]) => void;
+    finalizeRound: (interactionId: string) => void;
+    clear: () => void;
+}
+declare function useMessageAggregator(): UseMessageAggregatorReturn;
+
+/**
+ * 置顶区域组件
+ * 显示当前置顶轮次的用户消息、任务计划和 Todo
+ */
+
+declare const PinnedArea: React.FC<PinnedAreaProps>;
+
+/**
+ * 轮次标题组件
+ * 在消息流中显示非置顶轮次的用户消息和计划
+ */
+
+declare const RoundHeader: React.FC<RoundHeaderProps>;
+
+/**
+ * 消息内容组件
+ * 根据消息类型渲染不同的内容
+ * 文本类型使用 Streamdown 渲染 Markdown（代码高亮、Mermaid、数学公式、CJK）
+ * 保留逐字打字机效果：将逐步展开的文本交给 Streamdown 渲染
+ */
+
+declare const MessageContent: React.FC<MessageContentProps>;
+
+/**
+ * 子 Agent 卡片组件
+ * 可折叠，固定高度，内部滚动
+ */
+
+declare const ChildAgentCard: React.FC<ChildAgentCardProps & {
+    onArtifactClick?: (artifact: Artifact) => void;
+}>;
+
+/**
+ * 任务计划卡片组件
+ */
+
+declare const PlanCard: React.FC<PlanCardProps>;
+
+declare const TodoCard: React.FC<TodoCardProps>;
+
+/**
+ * Schema 表单渲染器
+ * 根据 JSON schema 动态生成表单 UI
+ */
+
+interface SchemaNode {
+    type: string;
+    key?: string;
+    name?: string;
+    props?: Record<string, unknown>;
+    children?: SchemaNode[];
+    options?: Array<{
+        label: string;
+        value: string;
+    }>;
+    rules?: Array<{
+        required?: boolean;
+        message?: string;
+    }>;
+    schema?: SchemaNode;
+}
+interface SchemaFormRendererProps {
+    schema: SchemaNode;
+    onSubmit?: (values: Record<string, unknown>) => void | Promise<void>;
+    awaitCommandUuid?: string;
+}
+declare const SchemaFormRenderer: React.FC<SchemaFormRendererProps>;
+
+interface ToolCardBufferingProps {
+    message: AggregatedMessage;
+}
+declare const ToolCardBuffering: React.FC<ToolCardBufferingProps>;
+
+interface DefaultJetAgentsAdapterOptions {
+    baseUrl: string;
+    getToken: () => string | null;
+    refreshToken?: () => Promise<string | null>;
+    getOrgId?: () => string | null;
+    onAuthFailure?: () => void;
+}
+declare class DefaultJetAgentsAdapter implements ChatWidgetAdapter {
+    private readonly baseUrl;
+    private readonly options;
+    private refreshPromise;
+    constructor(options: DefaultJetAgentsAdapterOptions);
+    createSession(agentId: string): Promise<{
+        sessionId: number;
+        instanceId: number;
+    }>;
+    getSessionDetail(sessionId: number): Promise<SessionDetail>;
+    getSessionHistory(sessionId: number): Promise<NotificationTurn[]>;
+    getResourceContent(sessionId: number, resourceId: string): Promise<ResourceContent>;
+    submitHITLResponse(response: HITLResponse): Promise<void>;
+    getStreamUrl(): string;
+    getAuthHeaders(): Record<string, string>;
+    onAuthFailure(): void;
+    refreshAuth(): Promise<boolean>;
+    private fetchJSON;
+}
+
+declare class ChatWidgetAuthError extends Error {
+    readonly name: "ChatWidgetAuthError";
+    constructor(message?: string);
+}
+declare class ChatWidgetNetworkError extends Error {
+    readonly statusCode: number;
+    readonly name: "ChatWidgetNetworkError";
+    constructor(message: string, statusCode: number);
+}
+
+export { type AggregatedMessage, type Artifact, ChatWidget, type ChatWidgetAPI, type ChatWidgetAdapter, ChatWidgetAuthError, type ChatWidgetConfig, ChatWidgetNetworkError, type ChatWidgetProps, ChildAgentCard, type ConnectionStatus, DEFAULT_CONFIG, DefaultJetAgentsAdapter, type DefaultJetAgentsAdapterOptions, type ExecutionStatus, type HITLRequest, type HITLResponse, MessageContent, type MessageContentType, type NotificationTurn, type NotificationType, PinnedArea, PlanCard, type PlanItem, type ResourceContent, type Round, RoundHeader, type SSEMessage, SchemaFormRenderer, type SessionDetail, type TaskPlan, TodoCard, type TodoData, type TodoGroup, type TodoPhase, type TodoStats, type TodoTask, type ToolCallData, ToolCardBuffering, type UiConfig, isTodoNotificationContent, mergeConsecutiveThinkMessages, useMessageAggregator, useSSE };