@opentiny/tiny-robot-kit 0.4.0 → 0.4.1-alpha.1

package/README.md

@@ -1,289 +1,86 @@
 # tiny-robot-kit
 
-封装与与AI大模型的交互逻辑与数据处理，适配多种模型提供商，提供统一的API接口。
+@opentiny/tiny-robot-kit 是 TinyRobot 提供的数据层工具包，用于统一处理 AI 大模型调用、消息状态与多会话管理。
+它帮助你在任意 UI 上快速实现聊天、流式响应和会话持久化等常见 AI 交互能力。
 
-## API参考
+## 功能概览
 
-### AIClient
+- **消息管理**：`useMessage` 管理消息状态与模型交互流程。
+- **会话管理**：`useConversation` 在 useMessage 之上提供多会话能力。
+- **工具函数（Utils）**：处理 SSE、消息格式与响应解析。
 
-主要客户端类，用于与AI模型交互。
+完整 API 请参考文档：
 
-#### 构造函数
+- `useMessage`：<https://docs.opentiny.design/tiny-robot/tools/message>
+- `useConversation`：<https://docs.opentiny.design/tiny-robot/tools/conversation>
+- 工具函数：<https://docs.opentiny.design/tiny-robot/tools/utils>
 
-```typescript
-new AIClient(config: AIModelConfig)
-```
-
-#### 方法
-
-- `chat(request: ChatCompletionRequest): Promise<ChatCompletionResponse>`
-  发送聊天请求并获取响应。
-
-- `chatStream(request: ChatCompletionRequest, handler: StreamHandler): Promise<void>`
-  发送流式聊天请求并通过处理器处理响应。
-
-
-## 基本用法
-
-### 创建客户端并发送消息
-
-```typescript
-import { AIClient } from '@opentiny/tiny-robot-kit';
-
-// 创建客户端
-const client = new AIClient({
-  provider: 'openai',
-  apiKey: 'your-api-key',
-  defaultModel: 'gpt-3.5-turbo'
-});
+## 安装
 
-// 发送消息并获取响应
-async function chat() {
-  try {
-    const response = await client.chat({
-      messages: [
-        { role: 'system', content: '你是一个有用的助手。' },
-        { role: 'user', content: '你好，请介绍一下自己。' }
-      ],
-      options: {
-        temperature: 0.7
-      }
-    });
-    
-    console.log(response.choices[0].message.content);
-  } catch (error) {
-    console.error('聊天出错:', error);
-  }
-}
-
-chat();
-```
-
-### 使用流式响应
-
-```typescript
-import { AIClient } from '@opentiny/tiny-robot-kit';
-
-const client = new AIClient({
-  provider: 'openai',
-  apiKey: 'your-api-key'
-});
-
-async function streamChat() {
-  try {
-    const controller: AbortController = new AbortController()
-    await client.chatStream({
-      messages: [
-        { role: 'user', content: '写一个简短的故事。' }
-      ],
-      options: {
-        stream: true, // 启用流式响应
-        signal: controller.signal  // 传递 AbortController 的 signal用于中断请求
-      }
-    }, {
-      onData: (data) => {
-        // 处理流式数据
-        const content = data.choices[0]?.delta?.content || '';
-        process.stdout.write(content);
-      },
-      onError: (error) => {
-        console.error('流式响应错误:', error);
-      },
-      onDone: () => {
-        console.log('\n流式响应完成');
-      }
-    });
-    // controller.abort() // 中断请求
-  } catch (error) {
-    console.error('流式聊天出错:', error);
-  }
-}
-
-streamChat();
+```bash
+pnpm add @opentiny/tiny-robot-kit
+# 或
+npm install @opentiny/tiny-robot-kit
+yarn add @opentiny/tiny-robot-kit
 ```
 
-### useMessage
-
-#### 选项
-
-`useMessage` 接受以下选项：
-
-```typescript
-interface UseMessageOptions {
-  /** AI客户端实例 */
-  client: AIClient;
-  /** 是否默认使用流式响应 */
-  useStreamByDefault?: boolean;
-  /** 错误消息模板 */
-  errorMessage?: string;
-  /** 初始消息列表 */
-  initialMessages?: ChatMessage[];
-}
-```
-
-#### 返回值
-
-`useMessage` 返回以下内容：
-```typescript
-interface UseMessageReturn {
-  messages: ChatMessage[];
-  /** 消息状态 */
-  messageState: Reactive<MessageState>;
-  /** 输入消息 */
-  inputMessage: Ref<string>;
-  /** 是否使用流式响应 */
-  useStream: Ref<boolean>;
-  /** 发送消息 */
-  sendMessage: (content?: string, clearInput?: boolean) => Promise<void>
-  /** 清空消息 */
-  clearMessages: () => void;
-  /** 添加消息 */
-  addMessage: (message: ChatMessage) => void;
-  /** 中止请求 */
-  abortRequest: () => void;
-  /** 重试请求 */
-  retryRequest: () => Promise<void>;
-}
-```
-
-#### MessageState 接口
-```typescript
-interface MessageState {
-  status: STATUS
-  errorMsg: string | null
-}
-
-enum STATUS {
-  INIT = 'init', // 初始状态
-  PROCESSING = 'processing', // AI请求正在处理中, 还未响应，显示加载动画
-  STREAMING = 'streaming', // 流式响应中分块数据返回中
-  FINISHED = 'finished', // AI请求已完成
-  ABORTED = 'aborted', // 用户中止请求
-  ERROR = 'error', // AI请求发生错误
-}
-```
-
-### useConversation
-
-对话管理与数据持久化
-
-#### 基本用法
+## 基本用法
 
-```typescript
-import { useConversation, AIClient } from '@opentiny/tiny-robot-kit'
+### useMessage —— 管理 AI 消息
 
-const client = new AIClient({
-  provider: 'openai',
-  apiKey: 'your-api-key',
-  defaultModel: 'gpt-3.5-turbo'
-});
+`useMessage` 管理消息列表、请求/处理状态、流式响应、插件体系以及工具调用逻辑，而真正的 HTTP 请求由你提供的 `responseProvider` 负责。
 
-const {
-  state,
-  messageManager, // 与 useMessage 返回一致，具体查看useMessage
-  createConversation,
-  switchConversation,
-  deleteConversation,
-  // ...
-} = useConversation({ client })
+```ts
+import { useMessage } from '@opentiny/tiny-robot-kit'
 
-const conversationId = createConversation('新对话')
+const message = useMessage({
+  // responseProvider 负责调用你的后端 / 模型接口
+  async responseProvider(requestBody, abortSignal) {
+    const res = await fetch('/api/chat', {
+      method: 'POST',
+      body: JSON.stringify(requestBody),
+      signal: abortSignal,
+      headers: { 'Content-Type': 'application/json' },
+    })
 
-messageManager.sendMessage('你好，请介绍一下自己')
+    return await res.json()
+  },
+})
 ```
 
-#### 返回值
+更多进阶用法（流式响应、插件、自定义分块（chunk）处理、工具调用等），请查看 <https://docs.opentiny.design/tiny-robot/tools/message>。
 
-`useConversation` 返回以下内容：
+### useConversation —— 管理多会话
 
-```typescript
-interface UseConversationReturn {
-  /** 会话状态 */
-  state: ConversationState;
-  /** 消息管理 */
-  messageManager: UseMessageReturn;
-  /** 创建新会话 */
-  createConversation: (title?: string, metadata?: Record<string, any>) => string;
-  /** 切换会话 */
-  switchConversation: (id: string) => void;
-  /** 删除会话 */
-  deleteConversation: (id: string) => void;
-  /** 更新会话标题 */
-  updateTitle: (id: string, title: string) => void;
-  /** 更新会话元数据 */
-  updateMetadata: (id: string, metadata: Record<string, any>) => void;
-  /** 保存会话 */
-  saveConversations: () => Promise<void>;
-  /** 加载会话 */
-  loadConversations: () => Promise<void>;
-  /** 生成会话标题 */
-  generateTitle: (id: string) => Promise<string>;
-  /** 获取当前会话 */
-  getCurrentConversation: () => Conversation | null;
-}
-```
+`useConversation` 基于 `useMessage` 之上，提供多会话管理能力，并支持多种存储策略（LocalStorage、IndexedDB、自定义等）。
 
-#### 会话状态
+```ts
+import { useConversation } from '@opentiny/tiny-robot-kit'
 
-```typescript
-interface ConversationState {
-  /** 会话列表 */
-  conversations: Conversation[];
-  /** 当前会话ID */
-  currentId: string | null;
-  /** 是否正在加载 */
-  loading: boolean;
-}
+const { conversations, activeConversation, createConversation, switchConversation } = useConversation({
+  useMessageOptions: {
+    async responseProvider(requestBody, abortSignal) {
+      const res = await fetch('/api/chat', {
+        method: 'POST',
+        body: JSON.stringify(requestBody),
+        signal: abortSignal,
+        headers: { 'Content-Type': 'application/json' },
+      })
+      return await res.json()
+    },
+  },
+})
 ```
 
-#### 会话接口
-
-```typescript
-
-interface Conversation {
-  /** 会话ID */
-  id: string;
-  /** 会话标题 */
-  title: string;
-  /** 创建时间 */
-  createdAt: number;
-  /** 更新时间 */
-  updatedAt: number;
-  /** 自定义元数据 */
-  metadata?: Record<string, any>;
-  /** 消息 */
-  messages: ChatMessage[];
-}
-```
+例如 `localStorageStrategyFactory` 和 `indexedDBStorageStrategyFactory` 等存储策略的详细用法，请参考 <https://docs.opentiny.design/tiny-robot/tools/conversation>。
 
-#### 自定义存储策略
+### 工具函数 Utils —— 处理 SSE 与响应
 
-默认使用 LocalStorage 存储会话数据，你也可以实现自定义的存储策略：
+Utils 模块提供了一些与 `useMessage` 搭配使用的常用工具函数：
 
-```typescript
-interface ConversationStorageStrategy {
-  /** 保存会话列表 */
-  saveConversations: (conversations: Conversation[]) => Promise<void> | void;
-  /** 加载会话列表 */
-  loadConversations: () => Promise<Conversation[]> | Conversation[];
-}
-
-// 自定义存储策略示例
-class CustomStorageStrategy implements ConversationStorageStrategy {
-  async saveConversations(conversations: Conversation[]) {
-    // 实现自定义存储逻辑
-  }
-
-  async loadConversations(): Promise<Conversation[]> {
-    // 实现自定义加载逻辑
-    return [];
-  }
-}
-
-// 使用自定义存储策略
-const conversationManager = useConversation({
-  client,
-  storage: new CustomStorageStrategy(),
-});
-```
+- `sseStreamToGenerator`：把 SSE `Response` 转换为异步生成器。
+- `formatMessages`：将多种形式的消息统一为 `ChatMessage[]`。
+- `extractTextFromResponse`：从大模型响应中提取纯文本内容。
+- `handleSSEStream`：通过回调方式消费 SSE 流式响应。
 
+详细函数签名与行为说明，请查看 <https://docs.opentiny.design/tiny-robot/tools/utils>。

package/dist/chunk-EES4JUCD.mjs

@@ -0,0 +1 @@
+import{computed as ce,isProxy as ue,reactive as ge,ref as L,toRaw as fe}from"vue";var le=e=>typeof e=="function"?null:Array.isArray(e)?e.length>0?new Set(e):null:new Set([e]),ee=e=>{let t=new Set,s=(o,f)=>{try{o.listener(f)}catch(m){console.error("Error in message state subscriber:",m)}};return{notify:o=>{let f=new Set(Array.isArray(o)?o:[o]),m=e(),p=Array.from(t);for(let a of p){if(a.kinds){let c=!1;for(let y of a.kinds)if(f.has(y)){c=!0;break}if(!c)continue}s(a,m)}},subscribe:(o,f)=>{let m=typeof o=="function"?o:f;if(!m)throw new Error("subscribe listener is required");let p={kinds:le(o),listener:m};return t.add(p),s(p,e()),()=>{t.delete(p)}}}};var te=e=>ge(e),$=e=>{let t=ue(e)?fe(e):e;if(Array.isArray(t))return t.map(s=>$(s));if(t&&typeof t=="object"){let s={};for(let[n,i]of Object.entries(t))s[n]=$(i);return s}return t},xe=()=>{let e=!1,t=L("idle"),s=L(void 0),n=L([]),i=ce(()=>t.value==="processing"),o=c=>{if(e)throw new Error("Message state adapter is already initialized");t.value=c.requestState,s.value=c.processingState,n.value=c.messages.map(te),e=!0},f=c=>te(c),m=()=>{if(!e)throw new Error("Message state adapter is not initialized");return{requestState:t.value,processingState:s.value,messages:$(n.value),isProcessing:i.value}},p=ee(m);return{requestState:t,processingState:s,messages:n,isProcessing:i,initialize:o,getState:m,createMessage:f,mutate:(c,y)=>{if(!e)throw new Error("Message state adapter is not initialized");let A={get requestState(){return t.value},set requestState(S){t.value=S},get processingState(){return s.value},set processingState(S){s.value=S},get messages(){return n.value},set messages(S){n.value=S.map(f)}},d=!1;if(y(A,()=>{d=!0}),d)return;(Array.isArray(c)?c:[c]).includes("messages")&&(n.value=[...n.value]),p.notify(c)},subscribe:p.subscribe}};var H=(e={})=>{let{continueContent:t="Please continue with your previous answer.",...s}=e;return{name:"length",...s,onAfterRequest:async n=>{let{lastChoice:i,appendMessage:o,requestNext:f}=n;return i?.finish_reason==="length"&&(o({role:"user",content:t}),f()),s.onAfterRequest?.(n)}}};var Q=(e={})=>{let t=(s,n)=>!!s.thinking!==n||!!s.open!==n;return{name:"thinking",...e,onCompletionChunk(s){let{choice:n,currentMessage:i,updateCurrentMessage:o}=s,f=n,m=f?.message?.reasoning_content||f?.delta?.reasoning_content,p=typeof m=="string"&&m.trim()!=="";return p?i.state&&typeof i.state=="object"?t(i.state,p)&&o(a=>{a.state.thinking=!0,a.state.open=!0}):o(a=>{a.state={thinking:p,open:p}}):i.state&&typeof i.state=="object"&&"thinking"in i.state&&t(i.state,p)&&o(a=>{a.state.thinking=!1,a.state.open=!1}),e.onCompletionChunk?.(s)},onTurnEnd(s){let{currentTurn:n,mutate:i}=s,o=n.at(-1);return o?.state&&typeof o.state=="object"&&"thinking"in o.state&&t(o.state,!1)&&i("messages",()=>{o.state.thinking=!1,o.state.open=!1}),e.onTurnEnd?.(s)}}};var D=class extends Error{constructor(t){super(t),this.name="AbortError"}};function de(e){if(e.aborted)return{promise:Promise.reject(new D(String(e.reason??"Aborted"))),cleanup:()=>{}};let t=null;return{promise:new Promise((i,o)=>{t=()=>{o(new D(String(e.reason??"Aborted")))},e.addEventListener("abort",t,{once:!0})}),cleanup:()=>{t&&(e.removeEventListener("abort",t),t=null)}}}function oe(e,t){let{promise:s,cleanup:n}=de(t);return Promise.race([e,s]).finally(n)}function ae(e,t){let s={};for(let n in e)t.includes(n)&&(s[n]=e[n]);return s}function re(e,t){let s={};for(let n in e)t.includes(n)||(s[n]=e[n]);return s}async function*J(e){if(se(e)){yield*e;return}let t=await e;if(se(t)){yield*t;return}yield t}function se(e){return e&&typeof e=="object"&&typeof e[Symbol.asyncIterator]=="function"}var X=e=>typeof e=="object"&&e!==null,ne=e=>X(e)&&typeof e.index=="number",O=(e,t)=>{for(let[s,n]of Object.entries(t)){let i=e[s];if(i)if(typeof i=="string"&&typeof n=="string")s==="type"&&i||(e[s]=i+n);else if(Array.isArray(i)&&Array.isArray(n))if(i.every(o=>ne(o))&&n.every(o=>ne(o))){let o=new Map(i.map(a=>[a.index,a])),f=new Map(n.map(a=>[a.index,a]));for(let[a,c]of f)if(o.has(a)){let y=o.get(a);o.set(a,O(y,c))}else o.set(a,c);let m=Math.max(...Array.from(o.keys()),-1)+1,p=m>i.length?Array.from({length:m}):i;for(let[a,c]of o)p[a]=c;e[s]=p}else e[s]=[...i,...n];else X(i)&&X(n)&&(e[s]=O(i,n));else e[s]=n}return e};function pe({messages:e,cancelledContent:t,createMessage:s,mutate:n}){let i=[];for(let o=0;o<e.length;o++){let f=e[o];if(f.role==="assistant"&&f.tool_calls&&f.tool_calls.length>0){let m=new Set(f.tool_calls.map(c=>c.id)),p=new Set;for(let c=o+1;c<e.length;c++){let y=e[c];y.role==="tool"&&y.tool_call_id&&m.has(y.tool_call_id)&&p.add(y.tool_call_id)}let a=f.tool_calls.map(c=>c.id).filter(c=>!p.has(c));a.length>0&&i.push({insertAfterIndex:o,missingToolCallIds:a})}}i.length!==0&&n("messages",o=>{for(let f=i.length-1;f>=0;f--){let{insertAfterIndex:m,missingToolCallIds:p}=i[f],a=p.map(c=>s({role:"tool",tool_call_id:c,content:t}));o.messages.splice(m+1,0,...a)}})}var me=e=>{let{getTools:t,beforeCallTools:s,callTool:n,onToolCallStart:i,onToolCallEnd:o,toolCallCancelledContent:f="Tool call cancelled.",toolCallFailedContent:m="Tool call failed.",autoFillMissingToolMessages:p=!1,...a}=e,c=(d,C)=>{var M,S;return d.state??(d.state={}),(M=d.state).toolCall??(M.toolCall={}),(S=d.state.toolCall)[C]??(S[C]={}),d},y=(...d)=>{let[C,{assistantMessage:M,mutate:S}]=d;S("messages",()=>{let w=c(M,C.id);w.state.toolCall[C.id].status="running"}),i?.(...d)},A=(...d)=>{let[C,{status:M,assistantMessage:S,mutate:w}]=d;w("messages",()=>{let W=c(S,C.id);W.state.toolCall[C.id].status=M}),o?.(...d)};return{name:"tool",...a,onTurnStart:d=>{let{getState:C,createMessage:M,mutate:S}=d,w=C().messages;return p&&pe({messages:w,cancelledContent:f,createMessage:M,mutate:S}),a.onTurnStart?.(d)},onBeforeRequest:async d=>{let{requestBody:C}=d,M=await t();return M&&M.length>0&&(C.tools=M),a.onBeforeRequest?.(d)},onAfterRequest:async d=>{let{currentMessage:C,lastChoice:M,appendMessage:S,abortSignal:w,setRequestState:W,requestNext:v,mutate:j,createMessage:R}=d;if(M?.finish_reason!=="tool_calls"||!C.tool_calls?.length)return;W("processing","calling-tools"),await s?.(C.tool_calls,{...d,assistantMessage:C});let G=C.tool_calls.map(async I=>{let z=Math.floor(Date.now()/1e3),V=!1,x=R({role:"tool",tool_call_id:I.id,content:"",metadata:{createdAt:z,updatedAt:z}});S(x);let B={...d,assistantMessage:C,toolMessage:x};y(I,B);try{let r=n(I,B),l=J(r);for await(let g of l)j("messages",()=>{if((typeof g=="string"&&g.length>0||g&&typeof g=="object"&&Object.keys(g).length>0)&&(V=!0),typeof g=="string")x.content+=g;else{let h={};try{let b=Array.isArray(x.content)?x.content.map(u=>u.text).join(""):x.content;h=JSON.parse(b||"{}")}catch(b){console.warn(b)}x.content=JSON.stringify(O(h,g))}x.metadata.updatedAt=Math.floor(Date.now()/1e3)});A(I,{...B,status:"success"})}catch(r){let l=r instanceof Error?r:new Error(String(r));if(w.aborted){A(I,{...B,status:"cancelled",error:l});return}console.error(r),V||j("messages",()=>{x.content=m,x.metadata.updatedAt=Math.floor(Date.now()/1e3)}),A(I,{...B,status:"failed",error:l})}});return await Promise.all(G),w.aborted||v(),a.onAfterRequest?.(d)}}};var Ce=async()=>{throw new Error("Response provider is not set")},Me=e=>{let t=[];for(let s of e){if(s.name){let n=t.findIndex(i=>i.name===s.name);n!==-1&&t.splice(n,1)}t.push(s)}return t},K=(e,t)=>typeof e.disabled=="function"?e.disabled(t):!!e.disabled,he=(e,t={})=>{let{initialMessages:s=[],requestMessageFields:n=[],requestMessageFieldsExclude:i=["state","metadata","loading"],responseProvider:o=Ce,onCompletionChunk:f,plugins:m=[]}=t,p={requestState:"idle",processingState:void 0,messages:[...s]};e.initialize(p);let a={currentTurn:[],customContext:{},abortController:null,responseProvider:o},c=[Q(),H()],y=Me(c.concat(m)),A=()=>e.getState(),d=r=>e.createMessage(r),C=e.subscribe,M=e.mutate,S=r=>!r||Object.keys(r).length===0?!1:Object.values(r).some(l=>!!l),w=r=>{let l=r;return n.length&&(l=l.map(g=>ae(g,n))),i.length&&(l=l.map(g=>re(g,i))),l},W=r=>{Object.assign(a.customContext,r)},v=(r,l)=>{M("requestState",(g,h)=>{if(g.requestState===r&&g.processingState===l){h();return}g.requestState=r,g.processingState=r==="processing"?l??"requesting":void 0})},j=(...r)=>{let l=r.map(g=>d(g));return M("messages",g=>{g.messages.push(...l)}),a.currentTurn.push(...l),l},R=r=>({getState:A,createMessage:d,mutate:M,abortSignal:r,currentTurn:a.currentTurn,customContext:a.customContext,setRequestState:v,setCustomContext:W});async function G(r,l,g={}){v("processing","requesting");let h={messages:A().messages},b=R(l);for(let _ of y.filter(T=>!K(T,b)))await _.onBeforeRequest?.({...b,requestBody:h});h.messages=w(h.messages);let u={role:"assistant",content:"",loading:!0};[u]=j(u),g.setAssistantMessage?.(u);let P=r(h,l),q=J(P),k;for await(let _ of q){v("processing","completing"),M("messages",(E,N)=>{u.loading?u.loading=void 0:N()});let T=(_.choices||[]).find(E=>E.index===0)??_.choices?.[0];if(!T)continue;k=T;let F=()=>{M("messages",()=>{u.metadata||(u.metadata={});let{created:E,...N}=_;u.metadata.createdAt=E,u.metadata.updatedAt=Math.floor(Date.now()/1e3),Object.assign(u.metadata,N);let U="delta"in T&&S(T.delta)&&T.delta||"message"in T&&S(T.message)&&T.message||null;if(U?.role&&(u.role=U.role),U){let{role:ye,...ie}=U;O(u,ie)}})},Y=E=>{M("messages",()=>{E(u)})};if(f){let E=R(l);f({...E,chunk:_,choice:T,currentMessage:u,updateCurrentMessage:Y},F)}else F();let Z=R(l);for(let E of y.filter(N=>!K(N,Z)))E.onCompletionChunk?.({...Z,abortSignal:l,chunk:_,choice:T,currentMessage:u,updateCurrentMessage:Y})}await I(u,r,l,k,g)}async function I(r,l,g,h,b){let u=!1,P=R(g),q=y.filter(k=>!K(k,P)).map(k=>{if(!k.onAfterRequest)return null;let _=F=>{j(...Array.isArray(F)?F:[F])},T=()=>{u=!0};return k.onAfterRequest({...P,currentMessage:r,lastChoice:h,appendMessage:_,requestNext:T})}).filter(k=>k!==null);await oe(Promise.all(q),g),u&&await G(l,g,b)}async function z(){let r=new AbortController;a.abortController=r,a.customContext={};let l=null,g=h=>{l=h};try{v("processing","requesting");let h=R(r.signal);for(let P of y.filter(q=>!K(q,h)))await P.onTurnStart?.(h);let b=a.responseProvider;try{await G(b,r.signal,{setAssistantMessage:g}),v("completed")}catch(P){if(r.signal.aborted||P instanceof D||P instanceof Error&&P.name==="AbortError")v("aborted");else throw P}let u=R(r.signal);for(let P of y.filter(q=>!K(q,u)))await P.onTurnEnd?.(u)}catch(h){v("error");let b=!1,u=R(r.signal);for(let P of y.filter(q=>!K(q,u)))P.onError&&(b=!0,P.onError({...u,error:h}));if(!b)throw h}finally{let h=R(r.signal);for(let b of y.filter(u=>!K(u,h)))try{b.onFinally?.(h)}catch(u){console.error(`Error in onFinally hook for plugin [${b.name||"Anonymous"}]:`,u)}a.abortController=null,a.currentTurn=[],M("messages",(b,u)=>{l?.loading?l.loading=void 0:u()})}}async function V(r){if(!r||!r.trim()){console.warn("Cannot send empty message");return}if(A().requestState==="processing"){console.warn("Cannot send message while processing is in progress");return}let l=Math.floor(Date.now()/1e3);j({role:"user",content:r.trim(),metadata:{createdAt:l,updatedAt:l}}),await z()}async function x(...r){if(A().requestState==="processing"){console.warn("Cannot send message while processing is in progress");return}j(...r),await z()}async function B(){a.abortController?.abort(),A().isProcessing&&await new Promise(r=>{let l=()=>{};l=C("requestState",g=>{g.isProcessing||(l(),r())})})}return{getState:A,subscribe:C,sendMessage:V,send:x,abort:B,setResponseProvider(r){a.responseProvider=r}}};export{ee as a,xe as b,H as c,Q as d,J as e,O as f,me as g,he as h};

package/dist/core.d.mts

@@ -0,0 +1,281 @@
+import { ChatCompletionMessageParam, ChatCompletionMessageToolCall, ChatCompletion, ChatCompletionChunk, ChatCompletionTool } from 'openai/resources/index';
+import { M as MaybePromise } from './types-CePh-Jcx.mjs';
+import { Ref, ComputedRef } from 'vue';
+
+type DeepReadonly<T> = T extends (...args: any[]) => any ? T : T extends Array<infer U> ? ReadonlyArray<DeepReadonly<U>> : T extends object ? {
+    readonly [K in keyof T]: DeepReadonly<T[K]>;
+} : T;
+type RequestState = 'idle' | 'processing' | 'completed' | 'aborted' | 'error';
+type RequestProcessingState = 'requesting' | 'completing' | string;
+type ChatMessage<Metadata extends object = Record<string, unknown>, State extends object = Record<string, unknown>> = ChatCompletionMessageParam & {
+    tool_calls?: Array<ChatCompletionMessageToolCall>;
+    loading?: boolean;
+    metadata?: Metadata;
+    state?: State;
+    [key: string]: any;
+};
+interface MessageRequestBody {
+    messages: Array<ChatMessage>;
+    [key: string]: any;
+}
+type ResponseProvider<T extends ChatCompletion | ChatCompletionChunk = ChatCompletion | ChatCompletionChunk> = (requestBody: MessageRequestBody, abortSignal: AbortSignal) => Promise<T> | AsyncGenerator<T> | Promise<AsyncGenerator<T>>;
+interface PublicMessageState {
+    requestState: RequestState;
+    processingState?: RequestProcessingState;
+    messages: ChatMessage[];
+    isProcessing: boolean;
+}
+interface InternalMessageState {
+    requestState: RequestState;
+    processingState?: RequestProcessingState;
+    messages: ChatMessage[];
+}
+interface MessageRuntime {
+    currentTurn: ChatMessage[];
+    customContext: Record<string, unknown>;
+    abortController: AbortController | null;
+    responseProvider: ResponseProvider;
+}
+interface MessageEngine {
+    getState(): PublicMessageState;
+    subscribe(listener: (state: PublicMessageState) => void): () => void;
+    subscribe(kinds: MessageUpdateKinds, listener: (state: PublicMessageState) => void): () => void;
+    sendMessage(content: string): Promise<void>;
+    send(...msgs: ChatMessage[]): Promise<void>;
+    abort(): Promise<void>;
+    setResponseProvider(provider: ResponseProvider): void;
+}
+type MessageUpdateKind = 'messages' | 'requestState';
+type MessageUpdateKinds = MessageUpdateKind | MessageUpdateKind[];
+type MessageMutationRecipe = (draft: InternalMessageState, skipNotify: () => void) => void;
+interface MutateMessageStateFn {
+    /**
+     * 在受控上下文中修改消息状态，并按声明的更新类型分发状态变更通知。
+     *
+     * 这里的“通知”语义对应 `subscribe` 订阅链路，用于驱动依赖 engine 状态快照的观察者；
+     * 它并不等同于具体框架的响应式更新机制。对于 Vue 等运行时，界面更新可能同时依赖
+     * 框架自身的响应式追踪与 `subscribe` 侧的状态通知，两者职责不同，不应混用。
+     */
+    (kinds: MessageUpdateKinds, recipe: MessageMutationRecipe): void;
+}
+interface MessageStateAdapter {
+    initialize(initialState: InternalMessageState): void;
+    getState(): PublicMessageState;
+    /**
+     * 创建一条适配当前运行时的消息对象。
+     *
+     * engine 和 core 插件里凡是“新建消息”的入口，都应统一走这个方法，
+     * 以便不同平台注入各自的运行时能力。
+     *
+     * 例如：
+     * - native/纯 TS 场景：直接返回原对象即可
+     *   `createMessage(message) { return message }`
+     * - Vue 场景：返回 reactive proxy，使后续对 message.content / message.state 的原地修改能够被追踪
+     *   `createMessage(message) { return reactive(message) }`
+     */
+    createMessage<T extends ChatMessage>(message: T): T;
+    mutate: MutateMessageStateFn;
+    subscribe(listener: (state: PublicMessageState) => void): () => void;
+    subscribe(kinds: MessageUpdateKinds, listener: (state: PublicMessageState) => void): () => void;
+}
+interface BasePluginContext {
+    getState(): PublicMessageState;
+    /**
+     * 创建一条适配当前运行时的消息对象。
+     *
+     * 插件在运行过程中如果需要主动创建并追加消息，应统一通过此接口构造消息实例，
+     * 而不是直接持有普通对象字面量。这样可以确保消息对象具备当前平台所要求的运行时能力。
+     *
+     * 对于采用响应式机制的平台（例如 Vue），该接口通常会返回带有响应式包装的消息实例。
+     * 如果插件绕过此接口直接创建普通对象，再参与后续的状态更新或原地字段修改，
+     * 可能导致消息内容、状态字段等变更无法被正确追踪。
+     */
+    createMessage<T extends ChatMessage>(message: T): T;
+    /**
+     * 在受控上下文中修改状态，并触发与 `subscribe` 对应的状态更新通知。
+     *
+     * 该通知机制面向 engine 的订阅接口，而不是具体框架的响应式系统本身。
+     * 因此，在需要让 `subscribe` 观察者感知到变更时，应通过此接口完成状态写入。
+     */
+    mutate: MutateMessageStateFn;
+    abortSignal: AbortSignal;
+    currentTurn: ChatMessage[];
+    customContext: Record<string, unknown>;
+    setRequestState: (state: RequestState, processingState?: RequestProcessingState) => void;
+    setCustomContext: (data: Record<string, unknown>) => void;
+}
+interface BeforeRequestContext extends BasePluginContext {
+    requestBody: MessageRequestBody;
+}
+interface AfterRequestContext extends BasePluginContext {
+    currentMessage: DeepReadonly<ChatMessage>;
+    lastChoice?: ChatCompletion.Choice | ChatCompletionChunk.Choice;
+    /**
+     * 使用 appendMessage 函数追加消息，可触发消息更新通知。
+     */
+    appendMessage: (message: ChatMessage | ChatMessage[]) => void;
+    requestNext: () => void;
+}
+interface CompletionChunkContext extends BasePluginContext {
+    /**
+     * 当前消息，只读。需要使用 updateCurrentMessage 函数修改当前消息，才能正常触发消息更新通知。
+     */
+    currentMessage: DeepReadonly<ChatMessage>;
+    /**
+     * 使用 updateCurrentMessage 函数修改当前消息，才能正常触发消息更新通知。
+     */
+    updateCurrentMessage: (recipe: (message: ChatMessage) => void) => void;
+    choice: ChatCompletion.Choice | ChatCompletionChunk.Choice;
+    chunk: ChatCompletion | ChatCompletionChunk;
+}
+interface MessageEnginePlugin {
+    /**
+     * 插件名称。
+     */
+    name?: string;
+    /**
+     * 是否禁用插件。
+     */
+    disabled?: boolean | ((context: BasePluginContext) => boolean);
+    /**
+     * 一次对话回合（turn）开始钩子：用户消息入队后、正式发起请求之前触发。
+     * 按插件注册顺序串行执行，便于做有序初始化/校验；出错则中断流程。
+     */
+    onTurnStart?: (context: BasePluginContext) => MaybePromise<void>;
+    /**
+     * 一次对话回合（turn）结束的生命周期钩子。
+     * 触发时机：本轮对话完成（成功、被中止）后。
+     * 执行策略：按插件注册顺序串行执行，有错误则中断流程。
+     */
+    onTurnEnd?: (context: BasePluginContext) => MaybePromise<void>;
+    /**
+     * 请求开始前的生命周期钩子。
+     * 触发时机：已组装 requestBody，正式发起请求之前。
+     * 执行策略：按插件注册顺序串行执行，避免并发修改 requestBody 产生冲突。
+     */
+    onBeforeRequest?: (context: BeforeRequestContext) => MaybePromise<void>;
+    /**
+     * 请求完成后的生命周期钩子。
+     * 触发时机：本次请求（含流式）结束后。
+     * 执行策略：并行执行（Promise.all）。
+     */
+    onAfterRequest?: (context: AfterRequestContext) => MaybePromise<void>;
+    /**
+     * 数据块处理钩子，在接收到每个响应数据块时触发。
+     * 无论是流式响应（多个增量数据块）还是非流式响应（单个完整数据块），都会触发此钩子。
+     */
+    onCompletionChunk?: (context: CompletionChunkContext) => void;
+    onError?: (context: BasePluginContext & {
+        error: unknown;
+    }) => void;
+    onFinally?: (context: BasePluginContext) => void;
+}
+interface CreateMessageEngineOptions {
+    initialMessages?: ChatMessage[];
+    /**
+     * 请求消息时，要包含的字段（白名单）。默认包含所有字段。
+     * 如果 `requestMessageFieldsExclude` 存在，会先取 `requestMessageFields` 中的字段，再排除 `requestMessageFieldsExclude` 中的字段
+     */
+    requestMessageFields?: string[];
+    /**
+     * 请求消息时，要排除的字段（黑名单）。默认会排除 `state`、`metadata`、`loading` 字段（这几个字段是给UI展示用的）。
+     * 如果 `requestMessageFields` 存在，会先取 `requestMessageFields` 中的字段，再排除 `requestMessageFieldsExclude` 中的字段
+     */
+    requestMessageFieldsExclude?: string[];
+    responseProvider?: ResponseProvider;
+    /**
+     * 全局的数据块处理钩子，在接收到每个响应数据块时触发。
+     * 注意：此钩子与插件中的 onCompletionChunk 有区别。
+     * 如果传入了此参数，默认的 chunk 处理逻辑不会自动执行，需要手动调用 runDefault 来执行默认处理逻辑。
+     */
+    onCompletionChunk?: (context: CompletionChunkContext, runDefault: () => void) => void;
+    plugins?: MessageEnginePlugin[];
+}
+
+declare const createNativeMessageAdapter: () => MessageStateAdapter;
+
+interface VueMessageStateAdapter extends MessageStateAdapter {
+    requestState: Ref<RequestState>;
+    processingState: Ref<RequestProcessingState | undefined>;
+    messages: Ref<ChatMessage[]>;
+    isProcessing: ComputedRef<boolean>;
+}
+declare const createVueMessageAdapter: () => VueMessageStateAdapter;
+
+declare const createMessageEngine: (adapter: MessageStateAdapter, options?: CreateMessageEngineOptions) => MessageEngine;
+
+declare const lengthPlugin: (options?: MessageEnginePlugin & {
+    continueContent?: string;
+}) => MessageEnginePlugin;
+
+declare const thinkingPlugin: (options?: MessageEnginePlugin) => MessageEnginePlugin;
+
+type AssistantMessageWithState = ChatMessage<Record<string, unknown>, {
+    toolCall?: Record<string, Record<string, unknown>>;
+}>;
+type ToolCallContext = BasePluginContext & {
+    assistantMessage: AssistantMessageWithState;
+    toolMessage: ChatMessage;
+};
+declare const toolPlugin: (options: MessageEnginePlugin & {
+    /**
+     * 获取工具列表的函数。会在请求大模型前调用。
+     */
+    getTools: () => Promise<ChatCompletionTool[]>;
+    /**
+     * 在处理包含 tool_calls 的响应前调用。
+     */
+    beforeCallTools?: (toolCalls: ChatCompletionMessageToolCall[], context: BasePluginContext & {
+        assistantMessage: AssistantMessageWithState;
+    }) => Promise<void>;
+    /**
+     * 执行单个工具调用并返回其文本结果的函数。
+     */
+    callTool: (toolCall: ChatCompletionMessageToolCall, context: ToolCallContext) => Promise<string | Record<string, any>> | AsyncGenerator<string | Record<string, any>>;
+    /**
+     * 工具调用开始时的回调函数。
+     * 触发时机：工具消息已创建并追加后，调用 callTool 之前触发。
+     * @param toolCall - 工具调用对象
+     * @param context - 插件上下文，包含当前工具消息
+     */
+    onToolCallStart?: (toolCall: ChatCompletionMessageToolCall, context: ToolCallContext) => void;
+    /**
+     * 工具调用结束时的回调函数。
+     * 触发时机：工具调用完成（成功、失败或取消）时触发。
+     * @param toolCall - 工具调用对象
+     * @param context - 插件上下文，包含当前工具消息、状态和错误信息
+     * @param context.status - 工具调用状态：'success' | 'failed' | 'cancelled'
+     * @param context.error - 当状态为 'failed' 或 'cancelled' 时，可能包含错误信息
+     */
+    onToolCallEnd?: (toolCall: ChatCompletionMessageToolCall, context: ToolCallContext & {
+        status: "success" | "failed" | "cancelled";
+        error?: Error;
+    }) => void;
+    /**
+     * 当请求被中止时用于工具调用取消的消息内容。
+     */
+    toolCallCancelledContent?: string;
+    /**
+     * 当工具调用执行失败（抛错或拒绝）时使用的消息内容。
+     */
+    toolCallFailedContent?: string;
+    /**
+     * 是否在请求前自动补充缺失的 tool 消息。
+     * 当 assistant 响应了 tool_calls 但未追加对应的 tool 消息时，
+     * 插件将自动补充"工具调用已取消"的 tool 消息。默认：false。
+     */
+    autoFillMissingToolMessages?: boolean;
+}) => MessageEnginePlugin;
+
+declare function normalizeToAsyncGenerator<T>(result: Promise<T> | AsyncGenerator<T> | Promise<AsyncGenerator<T>>): AsyncGenerator<T>;
+/**
+ * Merge delta data from completion responses
+ * Handles string concatenation, object merging, and array merging by index
+ *
+ * @param target - Target object to merge into
+ * @param source - Source object to merge from
+ * @returns Merged target object
+ */
+declare const combineDeltaData: (target: Record<string, any>, source: Record<string, any>) => Record<string, any>;
+
+export { type AfterRequestContext, type BasePluginContext, type BeforeRequestContext, type ChatMessage, type CompletionChunkContext, type CreateMessageEngineOptions, type DeepReadonly, type InternalMessageState, type MessageEngine, type MessageEnginePlugin, type MessageMutationRecipe, type MessageRequestBody, type MessageRuntime, type MessageStateAdapter, type MessageUpdateKind, type MessageUpdateKinds, type MutateMessageStateFn, type PublicMessageState, type RequestProcessingState, type RequestState, type ResponseProvider, type VueMessageStateAdapter, combineDeltaData, createMessageEngine, createNativeMessageAdapter, createVueMessageAdapter, lengthPlugin, normalizeToAsyncGenerator, thinkingPlugin, toolPlugin };