@will1123/lx-ui-utils 1.0.0

package/README.md

@@ -0,0 +1,234 @@
+# @lx-ui/utils
+
+LX UI 通用工具函数库，提供常用的工具函数和 AI 相关功能。
+
+## 特性
+
+- 🚀 **TypeScript 支持** - 完整的类型定义
+- 📦 **Tree-Shaking 支持** - 按需引入，减少打包体积
+- 🎯 **零依赖** - 无需安装额外依赖
+- 🔧 **AI 相关工具** - SSE、思考过程提取、Markdown 渲染
+
+## 安装
+
+```bash
+npm install @lx-ui/utils
+# 或
+yarn add @lx-ui/utils
+# 或
+pnpm add @lx-ui/utils
+```
+
+## 使用方法
+
+### 全量导入
+
+```typescript
+import { sse, extractThinking, renderMarkdown } from '@lx-ui/utils'
+```
+
+### 按需导入（推荐）
+
+```typescript
+import { sse } from '@lx-ui/utils'
+import { extractThinking } from '@lx-ui/utils'
+import { renderMarkdown } from '@lx-ui/utils'
+```
+
+## API 文档
+
+### SSE (Server-Sent Events)
+
+封装 SSE 请求，支持流式响应。
+
+#### 类型定义
+
+```typescript
+interface SSEConfig {
+  url: string                      // 请求 URL
+  method?: 'GET' | 'POST'          // 请求方法，默认 GET
+  headers?: Record<string, string> // 请求头
+  body?: any                       // 请求体（POST 请求时使用）
+  timeout?: number                 // 请求超时时间（毫秒）
+}
+
+interface SSEHandlers {
+  onMessage?: (message: SSEMessage) => void
+  onOpen?: () => void
+  onClose?: () => void
+  onError?: (error: Error) => void
+}
+```
+
+#### 使用示例
+
+```typescript
+import { sse } from '@lx-ui/utils'
+
+// GET 请求（使用 EventSource）
+const connection = sse(
+  {
+    url: 'https://api.example.com/stream'
+  },
+  {
+    onMessage: (message) => {
+      console.log('收到消息:', message.data)
+    },
+    onOpen: () => {
+      console.log('连接已打开')
+    },
+    onClose: () => {
+      console.log('连接已关闭')
+    },
+    onError: (error) => {
+      console.error('连接错误:', error)
+    }
+  }
+)
+
+// 关闭连接
+connection.close()
+
+// POST 请求（使用 fetch）
+const connection2 = sse(
+  {
+    url: 'https://api.example.com/stream',
+    method: 'POST',
+    headers: {
+      'Authorization': 'Bearer your-token'
+    },
+    body: {
+      prompt: '你好'
+    },
+    timeout: 30000
+  },
+  {
+    onMessage: (message) => {
+      console.log('收到消息:', message.data)
+    }
+  }
+)
+```
+
+### 思考过程提取
+
+从 AI 响应中提取 `<think>` 标签内容。
+
+#### 类型定义
+
+```typescript
+interface ThinkingExtractConfig {
+  tagName?: string      // 思考标签名称，默认 'think'
+  includeTags?: boolean // 是否包含标签本身
+  removeRest?: boolean  // 是否移除剩余内容
+}
+
+interface ThinkingResult {
+  thinking: string      // 提取的思考内容
+  rest: string          // 剩余内容
+  hasThinking: boolean  // 是否找到思考内容
+}
+```
+
+#### 使用示例
+
+```typescript
+import { extractThinking, createThinkingExtractor } from '@lx-ui/utils'
+
+// 完整模式
+const text = `<think>
+这是 AI 的思考过程
+</think>
+这是实际回答内容`
+
+const result = extractThinking(text)
+console.log(result.thinking) // "\n这是 AI 的思考过程\n"
+console.log(result.rest)     // "这是实际回答内容"
+console.log(result.hasThinking) // true
+
+// 流式模式（用于 SSE）
+const extractor = createThinkingExtractor({
+  tagName: 'think',
+  includeTags: false
+})
+
+// 逐步追加文本
+const chunk1 = extractor.append('<think>这是')
+console.log(chunk1.thinking) // "这是"
+
+const chunk2 = extractor.append('思考过程')
+console.log(chunk2.thinking) // "这是思考过程"
+
+const chunk3 = extractor.append('</think>实际回答')
+console.log(chunk3.thinking) // "这是思考过程"
+console.log(chunk3.isComplete) // true
+```
+
+### Markdown 渲染
+
+将 Markdown 文本渲染为 HTML。
+
+#### 类型定义
+
+```typescript
+interface MarkdownRenderConfig {
+  highlight?: boolean              // 是否启用代码高亮
+  highlightLanguages?: Record<string, string>
+  taskList?: boolean               // 是否渲染任务列表，默认 true
+  table?: boolean                  // 是否渲染表格，默认 true
+  link?: boolean                   // 是否渲染链接，默认 true
+  image?: boolean                  // 是否渲染图片，默认 true
+}
+```
+
+#### 使用示例
+
+```typescript
+import { renderMarkdown, createMarkdownRenderer } from '@lx-ui/utils'
+
+// 完整模式
+const markdown = `# 标题
+
+这是一段**粗体**和*斜体*文字。
+
+- [ ] 未完成任务
+- [x] 已完成任务
+
+| 列1 | 列2 |
+|-----|-----|
+| A   | B   |
+
+[链接](https://example.com)
+`
+
+const html = renderMarkdown(markdown)
+console.log(html)
+
+// 流式模式（用于 SSE）
+const renderer = createMarkdownRenderer({
+  table: true,
+  taskList: true,
+  onUpdate: (html) => {
+    console.log('更新渲染:', html)
+  }
+})
+
+// 逐步追加文本
+renderer.append('# 标题\n\n这是一段')
+renderer.append('**粗体**文字。')
+renderer.complete()
+```
+
+## 构建
+
+```bash
+# 安装依赖
+yarn install
+
+# 构建 utils 包
+yarn workspace @lx-ui/utils build
+```
+
+## 许可证
+
+MIT