@syfei49/mini-dynamic-renderer 1.0.0 → 1.0.3

package/README.md

@@ -1,102 +1,94 @@
-# @syfei49/mini-dynamic-renderer
-
-微信小程序对话接口动态渲染 SDK（v1.0.0 测试版）。
-
-引入后自动注册 `wx.request` 拦截器；当匹配的接口返回成功（`statusCode === 200`）时，在当前页面弹出 `hello world` 测试弹窗。
-
-## 安装
-
-```bash
-cd your-miniprogram-project
-npm install @syfei49/mini-dynamic-renderer
-```
-
-## 接入
-
-### 1. 在 `app.js` 顶部引入（自动注册拦截器）
-
-```javascript
-require('@syfei49/mini-dynamic-renderer');
-```
-
-### 2. 微信开发者工具构建 npm
-
-打开微信开发者工具 → **工具** → **构建 npm**
-
-### 3. 正常发起请求即可触发弹窗
-
-```javascript
-wx.request({
-  url: 'https://your-domain.com/api/chat',
-  method: 'POST',
-  data: { query: '你好' },
-  success(res) {
-    // 原有业务逻辑不变
-  }
-});
-```
-
-## 配置（可选）
-
-如需自定义拦截规则，可在 `app.js` 中显式初始化：
-
-```javascript
-const sdk = require('@syfei49/mini-dynamic-renderer');
-
-sdk.init({
-  // URL 匹配规则：字符串为包含匹配，也支持 RegExp，'*' 表示全部
-  urlPatterns: ['/api/chat'],
-  debug: true
-});
-```
-
-### 配置项
-
-| 字段 | 类型 | 默认值 | 说明 |
-|------|------|--------|------|
-| `urlPatterns` | `Array<string\|RegExp>` | `['*']` | 需要拦截的 URL 规则 |
-| `debug` | `boolean` | `false` | 是否输出调试日志 |
-
-## API
-
-| 方法 | 说明 |
-|------|------|
-| `init(config?)` | 初始化并注册拦截器 |
-| `getConfig()` | 获取当前配置 |
-| `isInitialized()` | 是否已初始化 |
-| `uninstall()` | 卸载拦截器，恢复原始 `wx.request` |
-| `parseRenderConfig(data)` | 解析响应中的渲染配置（预留） |
-
-## 发布到 npm
-
-在包根目录 `code/` 下执行：
-
-```bash
-# 1. 确认已登录
-npm whoami
-
-# 2. 确认 registry
-npm config get registry
-# 应为 https://registry.npmjs.org/
-
-# 3. 检查包名是否可用（404 表示可用）
-npm view @syfei49/mini-dynamic-renderer
-
-# 4. 预览将要发布的文件
-npm pack --dry-run
-
-# 5. 正式发布（作用域包首次需 public）
-npm publish --access public
-```
-
-后续版本更新：
-
-```bash
-npm version patch   # 或 minor / major
-npm publish --access public
-```
-
-## 版本说明
-
-- **v1.0.0**：拦截 `wx.request` 成功响应，弹出 `hello world` 测试弹窗
-- 后续版本将支持根据后端 `renderConfig` 动态渲染图片上传、文本等组件
+# @syfei49/mini-dynamic-renderer
+
+uni-app 浮层 AI 客服插件（v1.0.3）。在指定页面右下角显示 AI 浮层图标，点击后从底部弹出抽屉聊天面板，支持文字、图片、拍照/相册上传及 `[NEED_ICON]` 分类图标引导。
+
+## 安装
+
+```bash
+cd your-uniapp-project
+npm install @syfei49/mini-dynamic-renderer
+```
+
+微信开发者工具 → **工具** → **构建 npm**
+
+## 接入
+
+### 1. App.vue 初始化
+
+```vue
+<script setup>
+import { init } from '@syfei49/mini-dynamic-renderer'
+
+init({
+  baseUrl: 'https://your-api.com/prod-api',
+  chatApiPath: '/mini/ai/chat',
+  uploadApiPath: '/mini/common/upload',
+  getToken: () => uni.getStorageSync('token'),
+  visiblePages: ['pages/user/user'],
+  requireLogin: true,
+  loginPage: '/pages/login/login?noauto=1'
+})
+</script>
+```
+
+### 2. 在需要显示浮层的页面引入组件
+
+以 `pages/user/user.vue` 为例：
+
+```vue
+<script setup>
+import LyAiAssistant from '@syfei49/mini-dynamic-renderer/components/ly-ai-assistant/ly-ai-assistant.vue'
+import { openChat } from '@syfei49/mini-dynamic-renderer'
+</script>
+
+<template>
+  <view>
+    <!-- 页面内容 -->
+    <LyAiAssistant />
+  </view>
+</template>
+```
+
+> 微信小程序 `App.vue` 的 template 不会被渲染，所以浮层组件需要放在具体页面里。
+
+### 2. 在任意页面打开抽屉（可选）
+
+```javascript
+import { openChat } from '@syfei49/mini-dynamic-renderer'
+
+openChat()
+```
+
+## 配置项
+
+| 字段 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| `baseUrl` | `string` | `''` | API 根地址 |
+| `chatApiPath` | `string` | `'/mini/ai/chat'` | 对话接口路径 |
+| `uploadApiPath` | `string` | `'/mini/common/upload'` | 图片上传路径 |
+| `getToken` | `Function` | `() => ''` | 返回 Authorization |
+| `getHeaders` | `Function` | `() => ({})` | 额外请求头 |
+| `visiblePages` | `string[]` | `['pages/user/user']` | 显示浮层图标的页面路由 |
+| `floatIcon` | `string` | 内置默认图标 | 浮层按钮图片 URL |
+| `requireLogin` | `boolean` | `true` | 打开前检查登录 |
+| `loginPage` | `string` | `'/pages/login/login'` | 未登录跳转页 |
+| `debug` | `boolean` | `false` | 调试日志 |
+| `enableInterceptor` | `boolean` | `false` | 是否启用 wx.request 拦截（预留） |
+
+## API
+
+| 方法 | 说明 |
+|------|------|
+| `init(config?)` | 初始化插件 |
+| `openChat()` | 打开聊天抽屉 |
+| `closeChat()` | 关闭聊天抽屉 |
+| `getConfig()` | 获取当前配置 |
+| `isInitialized()` | 是否已初始化 |
+| `uninstall()` | 卸载拦截器，恢复原始 `wx.request` |
+| `parseRenderConfig(data)` | 解析响应中的渲染配置（预留） |
+
+## 版本说明
+
+- **v1.0.3**：uni-app 浮层 AI 插件、抽屉聊天、迁移 aiChat 全能力、文档拆分
+- v1.0.0：wx.request 拦截 + hello world 弹窗（测试版）
+- 后续版本将根据后端 `renderConfig` 动态渲染更多组件类型