@unif/react-native-chat-sdk 0.4.1 → 0.5.0

package/src/index.md

@@ -1,188 +0,0 @@
----
-title: SDK 概览
-nav:
-  title: SDK
-  path: /sdk
----
-
-# @unif/react-native-chat-sdk
-
-聊天 SDK 包，提供 Provider 抽象、Hooks、状态管理和流式处理工具。
-
-## 架构
-
-```
-┌─────────────────────────────────────────┐
-│            useXChat (Hook)              │
-│   组合 Provider + store，输出 messages  │
-├─────────────────────────────────────────┤
-│           ChatProvider 层               │
-│  AbstractChatProvider → OpenAI/DeepSeek │
-├─────────────────────────────────────────┤
-│              工具层                     │
-│   XRequest → XStream → SSEParser       │
-├─────────────────────────────────────────┤
-│              数据层                     │
-│   chatStore / sessionStore / modelStore │
-└─────────────────────────────────────────┘
-```
-
-## 核心 Hooks
-
-### useXChat — 聊天操作
-
-```tsx
-import { useXChat, OpenAIChatProvider, XRequest } from '@unif/react-native-chat-sdk';
-
-const request = new XRequest({
-  baseURL: 'https://api.openai.com',
-  getToken: async () => 'sk-...',
-});
-const provider = new OpenAIChatProvider({ request, model: 'gpt-4o' });
-
-const { messages, requesting, onRequest, abort } = useXChat({ provider });
-
-// 发起请求
-onRequest({ message: { text: '你好' } });
-
-// 中止请求
-abort();
-```
-
-**返回值:**
-
-| 属性 | 说明 | 类型 |
-|------|------|------|
-| messages | 可渲染消息列表 | `MessageInfo<Message>[]` |
-| requesting | 是否请求中 | `boolean` |
-| suggestions | 建议提示 | `SuggestionItem[]` |
-| onRequest | 发起请求 | `(input: Input) => void` |
-| abort | 中止请求 | `() => void` |
-
-### useXConversations — 会话管理
-
-```tsx
-import { useXConversations } from '@unif/react-native-chat-sdk';
-import AsyncStorage from '@react-native-async-storage/async-storage';
-
-const {
-  sessions, activeId,
-  switchSession, newSession, deleteSession,
-} = useXConversations({ storage: AsyncStorage });
-```
-
-### useXModel — 模型选择
-
-```tsx
-import { useXModel } from '@unif/react-native-chat-sdk';
-
-const { selectedModel, setSelectedModel } = useXModel({
-  models: [
-    { id: 'gpt-4o', name: 'GPT-4o', desc: '最强模型' },
-    { id: 'gpt-4o-mini', name: 'GPT-4o Mini', desc: '快速响应' },
-  ],
-  defaultModel: 'gpt-4o',
-});
-```
-
-## Provider 体系
-
-### 内置 Provider
-
-| Provider | 说明 |
-|----------|------|
-| `OpenAIChatProvider` | 兼容 OpenAI API 格式（含 Azure、Moonshot、通义千问等） |
-| `DeepSeekChatProvider` | 继承 OpenAI，额外处理 `reasoning_content` 字段 |
-
-### 自定义 Provider
-
-继承 `AbstractChatProvider`，实现 3 个抽象方法：
-
-```tsx
-import { AbstractChatProvider } from '@unif/react-native-chat-sdk';
-
-class MyProvider extends AbstractChatProvider {
-  transformParams(input) {
-    // 转换请求参数为你的 API 格式
-    return { query: input.message.text, model: input.model };
-  }
-
-  transformLocalMessage(input) {
-    // 创建本地用户消息
-    return { id: generateId(), text: input.message.text, role: 'user', status: 'local', ... };
-  }
-
-  transformMessage(output, current) {
-    // 解析流式响应，累积到 assistant 消息
-    const data = JSON.parse(output.data);
-    return { ...current, text: (current?.text || '') + data.content, status: 'updating' };
-  }
-}
-```
-
-## 工具类
-
-### XRequest
-
-面向 LLM 的 HTTP 请求工具，内置 token 注入和 SSE 解析。
-
-```tsx
-const request = new XRequest({
-  baseURL: 'https://api.example.com',
-  endpoint: '/v1/chat/completions',
-  getToken: async () => await loadToken(),
-  timeout: 120000,
-});
-```
-
-### XStream
-
-SSE 流适配器（RN 原生实现，基于 react-native-sse）。
-
-### SSEParser
-
-SSE 解析器，提供 `event_id` 幂等去重和 `seq` 严格排序。
-
-## ChatProvider — 全局模式
-
-```tsx
-import { ChatProvider, useChatContext } from '@unif/react-native-chat-sdk';
-
-// 根组件
-<ChatProvider provider={provider} storage={AsyncStorage} models={MODELS}>
-  <App />
-</ChatProvider>
-
-// 子组件
-const { messages, onRequest, sessions, selectedModel } = useChatContext();
-```
-
-## 类型定义
-
-### ChatMessage
-
-```typescript
-interface ChatMessage {
-  id: string;
-  text: string;
-  role: 'user' | 'assistant' | 'system';
-  createdAt: Date;
-  messageType: 'text' | 'card' | 'system';
-  status: 'local' | 'loading' | 'updating' | 'success' | 'error' | 'abort';
-  cardType?: string;
-  cardData?: { data: Record<string, unknown>; actions: string[] };
-  turnId: string;
-  extra?: Record<string, unknown>;
-}
-```
-
-### MessageInfo
-
-```typescript
-interface MessageInfo<Message> {
-  id: string;
-  message: Message;
-  status: MessageStatus;
-  extra?: Record<string, unknown>;
-}
-```