@zero-library/chat-copilot 1.0.1 → 1.0.3

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import * as react from 'react';
-import react__default from 'react';
+import react__default, { ReactNode } from 'react';
+import { BubbleProps } from '@ant-design/x-v2';
 import { ButtonProps, ThemeConfig } from 'antd';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { createRequest, RequestConfig, RenderControl } from '@zero-library/common';
@@ -66,10 +67,10 @@ interface AgentConfig {
 }
 interface AgentInfo {
     id: string;
-    name: string;
-    description: string;
-    iconUrl: string;
-    agentType: AgentTypeEnum;
+    name?: string;
+    description?: string;
+    iconUrl?: string;
+    agentType?: AgentTypeEnum;
     updatedAt?: string;
     tagIds?: string[];
     spec?: AgentSpec;
@@ -77,6 +78,65 @@ interface AgentInfo {
     userInput?: Variable[];
 }
 
+/**
+ * ChatSender 组件暴露的方法接口
+ */
+interface ChatSenderHandle {
+    /** 聚焦输入框 */
+    focus: (options?: {
+        cursor?: 'start' | 'end';
+    }) => void;
+}
+/**
+ * 文件上传配置接口
+ */
+interface FileUpload {
+    /** 上传时的额外参数 */
+    params?: ObjectType<any>;
+    /** 文件上传配置列表 */
+    config: FileUploadConfig;
+    /** 文件上传请求函数 */
+    request: AttachmentsProps['fileUpload'];
+}
+/**
+ * ChatSender 组件属性接口
+ */
+interface SenderProps {
+    /** 输入框占位符 */
+    placeholder?: string;
+    /** 输入框内容 */
+    content?: string;
+    /** 文件列表 */
+    fileList?: InputFile[];
+    /** 是否打开文件选择头部 */
+    headerOpen?: boolean;
+    /** 是否正在发送消息 */
+    loading?: boolean;
+    /** 内容变化回调 */
+    onContentChange: (value: string) => void;
+    /** 文件列表变化回调 */
+    onFileListChange: (files: InputFile[]) => void;
+    /** 头部打开状态变化回调 */
+    onHeaderOpenChange: (open: boolean) => void;
+    /** 发送消息回调 */
+    onSend: () => void;
+    /** 取消发送回调 */
+    onCancel?: () => void;
+    /** 输入框聚焦回调 */
+    onFocus?: () => void;
+    /** 头部额外内容 */
+    extraHeader?: React.ReactNode;
+    /** 底部额外内容 */
+    extraFooter?: React.ReactNode;
+    /** 底部下方额外内容 */
+    extraFooterBelow?: React.ReactNode;
+    /** 发送按钮属性 */
+    sendBtnProps?: ButtonProps;
+    /** 文件上传配置 */
+    fileUpload?: FileUpload;
+}
+declare const _default$3: react.ForwardRefExoticComponent<SenderProps & react.RefAttributes<ChatSenderHandle>>;
+
 interface UserInputType {
     inputs: Variable[];
     outputs: Variable[];
@@ -238,9 +298,13 @@ interface ConvMeta {
      * 1 正常 2 debug
      */
     mode?: number;
+    /** 项目或知识库ID */
     libraryId?: string;
+    /** 会话来源 */
     source?: number;
+    /** 项目或知识库类型 */
     libraryType?: LibraryTypeEnum;
+    /** 技能会话ID */
     skillConversationId?: string;
 }
 
@@ -291,6 +355,18 @@ interface FileUrlType {
     fileUrl?: string;
     ext?: string;
 }
+interface FirstMessageRenderCtx {
+    index: number;
+    member: 1 | 2;
+}
+interface FirstMessage extends Omit<BubbleProps, 'content' | 'contentRender' | 'role' | 'placement'> {
+    /** 会话成员类型 */
+    member?: 1 | 2;
+    /** 直接传入要展示的节点 */
+    content?: ReactNode;
+    /** 动态生成要展示的节点 */
+    contentRender?: (ctx: FirstMessageRenderCtx) => ReactNode;
+}
 /**
  * 消息引用类型
  * 用于消息回复时的引用信息
@@ -300,8 +376,6 @@ interface MessageQuoteMsg {
     id?: string;
     /** 被引用的消息内容 */
     msgContent?: string;
-    /** 被引用消息的附件文件列表 */
-    msgFiles?: InputFile[];
 }
 /**
  * 引用内容接口
@@ -483,11 +557,17 @@ type MessageEvent = RunStartedEvent | TextEvent | FilesEvent | StepStartedEvent
  * 定义智能体和用户之间的消息结构
  */
 interface ConversationMessage {
+    /** 消息ID */
     messageId: string;
+    /** 会话ID */
     conversationId: string;
+    /** 执行ID */
     executionId: string;
+    /** 角色：1-智能体 2-用户 */
     role: number;
+    /** 消息内容 */
     content: MessageEvent[];
+    /** 上传文件内容 */
     files?: InputFile[];
     /** 消息反馈：1-赞 2-踩 */
     feedback?: number;
@@ -495,6 +575,7 @@ interface ConversationMessage {
     params?: string;
     /** 引用的消息信息 */
     quoteMsg?: MessageQuoteMsg;
+    /** 创建时间 */
     createdAt: string;
     /** 是否被打断标志 */
     stopFlag?: boolean;
@@ -563,6 +644,21 @@ interface ChatHandle {
      * chatRef.current?.switchConversation(item)
      */
     switchConversation: (id: ConversationType['id']) => Promise<void>;
+    /**
+   * 切换智能体会话
+   * 切换到指定的智能体并创建或获取会话
+   *
+   * @param agentId - 目标智能体ID
+   * @param strategy - 会话策略，1-使用最近会话，2-创建新会话
+   *
+   * @example
+   * // 切换到指定智能体并创建新会话
+   * chatRef.current?.switchAgentConversation('agent-001')
+   *
+   * @example
+   * // 切换到指定智能体并使用最近会话
+   * chatRef.current?.switchAgentConversation('agent-001', 1)
+   */
     /**
      * 基于当前接收者创建新的会话
      *
@@ -594,6 +690,7 @@ interface ChatHandle {
      * // 清除引用
      * chatRef.current?.setReferences()
      */
+    setReferences: (references?: ReferencesType) => void;
     /**
      * 直接设置输入框中的文本内容
      *
@@ -1078,6 +1175,12 @@ interface ChatHooks {
      * }
      */
     onAppRightVerify?: (appKey: string) => boolean | Promise<boolean> | void;
+    /**
+     * 文件预览前回调函数
+     * 在文件预览打开前调用，返回false可阻止预览
+     * @param file - 被预览的文件对象, 如果不存在则表示正在关闭预览
+     * @param isBuiltIn - 是否为内嵌布局
+     */
     onBeforeFilePreview?: (file?: FileUrlType, isBuiltIn?: boolean) => boolean | Promise<boolean> | void;
     /**
      * 文件预览后的回调函数
@@ -1249,7 +1352,7 @@ interface ChatLayoutWelcomeMessage {
  */
 interface ChatLayoutMessageList {
     /** 首条消息配置 */
-    firstMessages?: ConversationMessage[];
+    firstMessages?: FirstMessage[];
     /** 头像显示控制：可以是全局布尔值或按成员类型分别控制 */
     avatar?: boolean | Partial<Record<ConversationMemberEnum, boolean>>;
     /** 智能体消息操作区渲染控制 */
@@ -1357,67 +1460,21 @@ interface AttachmentsProps {
     /** 文件列表变化回调函数 */
     onChange: (fileList: InputFile[]) => void;
 }
-
 /**
- * ChatSender 组件暴露的方法接口
- */
-interface ChatSenderHandle {
-    /** 聚焦输入框 */
-    focus: (options?: {
-        cursor?: 'start' | 'end';
-    }) => void;
-}
-/**
- * 文件上传配置接口
+ * 附件上传组件
+ * 支持多文件上传、文件类型验证、文件大小限制等功能
  */
-interface FileUpload {
-    /** 上传时的额外参数 */
-    params?: ObjectType<any>;
-    /** 文件上传配置列表 */
-    config: FileUploadConfig;
-    /** 文件上传请求函数 */
-    request: AttachmentsProps['fileUpload'];
-}
-/**
- * ChatSender 组件属性接口
- */
-interface SenderProps {
-    /** 输入框占位符 */
-    placeholder?: string;
-    /** 输入框内容 */
-    content?: string;
-    /** 文件列表 */
-    fileList?: InputFile[];
-    /** 是否打开文件选择头部 */
-    headerOpen?: boolean;
-    /** 是否正在发送消息 */
-    loading?: boolean;
-    /** 内容变化回调 */
-    onContentChange: (value: string) => void;
-    /** 文件列表变化回调 */
-    onFileListChange: (files: InputFile[]) => void;
-    /** 头部打开状态变化回调 */
-    onHeaderOpenChange: (open: boolean) => void;
-    /** 发送消息回调 */
-    onSend: () => void;
-    /** 取消发送回调 */
-    onCancel?: () => void;
-    /** 输入框聚焦回调 */
-    onFocus?: () => void;
-    /** 头部额外内容 */
-    extraHeader?: React.ReactNode;
-    /** 底部额外内容 */
-    extraFooter?: React.ReactNode;
-    /** 底部下方额外内容 */
-    extraFooterBelow?: React.ReactNode;
-    /** 发送按钮属性 */
-    sendBtnProps?: ButtonProps;
-    /** 文件上传配置 */
-    fileUpload?: FileUpload;
+declare const _default$2: react.ForwardRefExoticComponent<AttachmentsProps & react.RefAttributes<unknown>>;
+
+interface RoleContent {
+    role: number;
+    user: ConversationMemberEnum;
+    placement: BubbleProps['placement'];
+    avatar?: any;
 }
-declare const _default$3: react.ForwardRefExoticComponent<SenderProps & react.RefAttributes<ChatSenderHandle>>;
 
 interface MessageRenderProps {
+    role: RoleContent;
     message: ConversationMessage;
     messageIndex?: number;
     loading?: boolean;
@@ -1426,10 +1483,8 @@ interface MessageRenderProps {
     /** message自定义标记渲染组件 */
     customComponents?: ChatLayoutMessageList['customComponents'];
 }
-declare const _default$2: react__default.MemoExoticComponent<({ message, messageIndex, loading, containerRef, customComponents }: MessageRenderProps) => react_jsx_runtime.JSX.Element>;
-
-declare const _default$1: ({ firstMessages, welcomeMessage, avatar, agentActions, customComponents }: ChatLayoutMessageList) => react_jsx_runtime.JSX.Element;
+declare const _default$1: react__default.MemoExoticComponent<({ role, message, messageIndex, loading, containerRef, customComponents }: MessageRenderProps) => react_jsx_runtime.JSX.Element>;
 
 declare const _default: react.ForwardRefExoticComponent<ChatProps & react.RefAttributes<ChatHandle>>;
 
-export { type AgentConfig, type AgentInfo, type AgentSpec, _default$1 as BubbleListItems, type ChatConfig, _default as ChatCopilot, type ChatHandle, type ChatProps, _default$3 as ChatSender, type ConversationMessage, type FileUploadConfig, type InputFile, _default$2 as MessageRender };
+export { type AgentConfig, type AgentInfo, type AgentSpec, _default$2 as Attachments, type AttachmentsProps, type ChatConfig, _default as ChatCopilot, type ChatHandle, type ChatHooks, type ChatLayout, type ChatParams, type ChatProps, _default$3 as ChatSender, type ChatServices, type ConversationMessage, type ConversationStrategy, type FileUploadConfig, type InputFile, _default$1 as MessageRender, type MessageRenderProps, type ReferencesType, type RequestInstance, type SenderProps };