ibc-ai-web-sdk 2.0.0

package/index.d.ts

@@ -0,0 +1,96 @@
+/**
+ * IBC AI Web SDK - 类型声明文件
+ * 为 JavaScript 项目提供 TypeScript 类型提示
+ */
+
+import type {
+  AIChatConfig,
+  AIChatClient,
+  AIResponse,
+  Message,
+  SDKEvents,
+  ErrorCode,
+  TokenRefreshContext,
+  TokenRefreshResult,
+  TokenRefreshSuccess
+} from './src/types'
+
+/**
+ * AI Chat Dialog 组件配置
+ */
+export interface AIChatDialogProps {
+  config: AIChatConfig
+}
+
+/**
+ * AI Chat Dialog 组件事件
+ */
+export interface AIChatDialogEvents extends SDKEvents {
+  /** 清除对话 */
+  'clear': void
+}
+
+/**
+ * AI Chat Dialog 组件方法
+ */
+export interface AIChatDialogMethods {
+  /** 打开对话框 */
+  open(): void
+  
+  /** 关闭对话框 */
+  close(): void
+  
+  /** 清除对话（开始新对话） */
+  clearChat(): void
+
+  /** 停止当前生成 */
+  stopGeneration(): Promise<void>
+
+  /** 上传附件 */
+  uploadAttachment(file: File, options?: Record<string, any>): Promise<AIResponse>
+}
+
+/**
+ * 导入 SDK 插件
+ */
+export function install(Vue: any): void
+
+/**
+ * AI Chat Dialog 组件
+ */
+export const AIChatDialog: any
+
+/**
+ * AI Chat Client
+ */
+export const AIChatClient: {
+  new(config: AIChatConfig): AIChatClient
+}
+
+export function createAIChatDialog(options?: Partial<AIChatConfig>): any
+
+export function installVuePlugin(Vue: any): void
+
+/**
+ * 默认导出
+ */
+export default {
+  install,
+  AIChatDialog,
+  AIChatClient,
+  createAIChatDialog,
+  installVuePlugin
+}
+
+// 导出类型
+export {
+  AIChatConfig,
+  AIChatClient,
+  AIResponse,
+  Message,
+  SDKEvents,
+  ErrorCode,
+  TokenRefreshContext,
+  TokenRefreshResult,
+  TokenRefreshSuccess
+}

package/miniprogram/README.md

@@ -0,0 +1,220 @@
+# ibc-ai-web-sdk - 微信小程序版本
+
+## 目录结构
+
+```
+miniprogram/
+├── ai-chat-dialog/          # 聊天对话框组件
+│   ├── ai-chat-dialog.js    # 组件逻辑
+│   ├── ai-chat-dialog.json  # 组件配置
+│   ├── ai-chat-dialog.wxml  # 组件模板
+│   └── ai-chat-dialog.wxss  # 组件样式
+├── core/
+│   └── AIChatClient.js      # AI 聊天客户端（wx.request）
+├── config/
+│   └── defaultConfig.js     # 默认配置
+└── utils/
+    └── markdownParser.js    # Markdown 解析器
+```
+
+## 功能特性
+
+- ✅ 自动检测微信小程序环境
+- ✅ 全屏模式（移动端默认全屏）
+- ✅ 触摸事件支持（拖拽、点击）
+- ✅ 复制功能（wx.setClipboardData）
+- ✅ Markdown 渲染（标题、粗体、代码块等）
+- ✅ 多轮对话（conversationId）
+- ✅ 可选鉴权（authFn）
+- ✅ 丰富的事件系统
+
+## 快速开始
+
+### 1. 复制组件到你的小程序项目
+
+```bash
+# 将 miniprogram 目录复制到你的小程序项目中
+cp -r miniprogram/ your-miniprogram-project/
+```
+
+### 2. 在页面中引用组件
+
+**pages/index/index.json**
+```json
+{
+  "usingComponents": {
+    "ai-chat-dialog": "/miniprogram/ai-chat-dialog/ai-chat-dialog"
+  }
+}
+```
+
+### 3. 在页面中使用
+
+**pages/index/index.wxml**
+```html
+<view class="container">
+  <button bindtap="openChat">打开 AI 助手</button>
+  
+  <!-- AI 聊天对话框 -->
+  <ai-chat-dialog
+    id="aiChat"
+    config="{{aiChatConfig}}"
+    bind:close="onChatClose"
+    bind:message-send="onMessageSend"
+    bind:message-receive="onMessageReceive"
+  />
+</view>
+```
+
+**pages/index/index.js**
+```javascript
+Page({
+  data: {
+    aiChatConfig: {
+      // API 配置（必须）
+      apiEndpoint: 'https://your-domain.com/v1/app/completion',
+      agentAppId: 'your-agent-app-id',
+      userId: 'user123',
+      bizType: 'miniprogram',
+      token: 'your-token-here',
+      
+      // UI 配置（可选）
+      title: 'AI 智能助理',
+      welcomeText: '您好！我是 AI 智能助理',
+      welcomeDesc: '我可以帮您解答系统使用问题',
+      
+      // 可选鉴权函数
+      authFn: async (token, userId) => {
+        // 调用你的鉴权接口
+        const res = await wx.request({
+          url: 'https://your-domain.com/api/check-auth',
+          method: 'POST',
+          data: { token, userId }
+        })
+        if (!res.data.valid) {
+          throw new Error('登录已过期')
+        }
+      },
+      
+      // 事件回调
+      onLoad: (client) => {
+        console.log('SDK 加载完成', client)
+      },
+      onError: (error) => {
+        console.error('SDK 错误', error)
+      }
+    }
+  },
+  
+  // 打开聊天窗口
+  openChat() {
+    this.selectComponent('#aiChat').openDialog()
+  },
+  
+  // 关闭聊天窗口
+  onChatClose() {
+    console.log('聊天窗口已关闭')
+  },
+  
+  // 消息发送事件
+  onMessageSend(data) {
+    console.log('用户发送:', data.message)
+  },
+  
+  // 消息接收事件
+  onMessageReceive(data) {
+    console.log('AI 回复:', data.response)
+  }
+})
+```
+
+## API 文档
+
+### 配置项（config）
+
+| 字段 | 类型 | 必填 | 默认值 | 说明 |
+|------|------|------|--------|------|
+| apiEndpoint | String | 是 | - | API 接口地址 |
+| agentAppId | String | 是 | - | 智能体应用 ID |
+| userId | String | 是 | - | 用户 ID |
+| bizType | String | 是 | - | 业务类型标识 |
+| token | String | 否 | '' | 认证 Token |
+| timeout | Number | 否 | 60000 | 请求超时时间（毫秒） |
+| headers | Object | 否 | {} | 自定义请求头 |
+| extendInfo | Object | 否 | null | 扩展信息 |
+| title | String | 否 | 'AI 智能助理' | 对话框标题 |
+| welcomeText | String | 否 | '您好！我是 AI 智能助理' | 欢迎文本 |
+| welcomeDesc | String | 否 | '我可以帮您解答系统使用问题' | 欢迎描述 |
+| authFn | Function | 否 | null | 可选鉴权函数 |
+| onLoad | Function | 否 | null | SDK 加载完成回调 |
+| onError | Function | 否 | null | 错误回调 |
+
+### 事件（Events）
+
+| 事件名 | 参数 | 说明 |
+|--------|------|------|
+| message-send | `{ message, index }` | 用户发送消息 |
+| message-receive | `{ response, index }` | AI 回复消息 |
+| loading-change | `boolean` | Loading 状态变化 |
+| close | - | 关闭对话框 |
+| expand | `boolean` | 展开/收起 |
+
+### 方法
+
+通过 `this.selectComponent('#aiChat').methodName()` 调用：
+
+| 方法名 | 说明 |
+|--------|------|
+| openDialog() | 打开对话框 |
+| handleClose() | 关闭对话框 |
+| clearChat() | 清除对话（开始新对话） |
+
+## 响应格式
+
+### 成功响应
+
+```json
+{
+  "success": true,
+  "code": 200,
+  "message": "成功",
+  "data": {
+    "content": "AI 回复内容（支持 Markdown）",
+    "conversationId": "conv_xxx",
+    "messageId": "msg_xxx"
+  }
+}
+```
+
+### 失败响应
+
+```json
+{
+  "success": false,
+  "code": 40001,
+  "message": "智能体不存在或已禁用",
+  "data": null
+}
+```
+
+## 注意事项
+
+1. **网络请求配置**
+   - 在微信开发者工具中，勾选"不校验合法域名"
+   - 生产环境需要在小程序后台配置 request 合法域名
+
+2. **Markdown 支持**
+   - 支持标题、粗体、斜体、代码块、链接、图片等
+   - 使用 `rich-text` 组件渲染
+
+3. **复制功能**
+   - 使用 `wx.setClipboardData()` 实现
+   - 复制成功后显示 2 秒的"已复制"提示
+
+4. **触摸事件**
+   - 支持拖拽移动对话框（桌面端）
+   - 移动端自动全屏，禁用拖拽
+
+## License
+
+MIT