bw-frontend-sdk 1.1.7 → 1.1.8

package/README.md

@@ -20,7 +20,7 @@
 npm install bw-frontend-sdk
 ```
 
-**注意**: 本SDK使用axios进行所有HTTP请求，会自动安装axios依赖。
+**注意**: 本SDK优先使用 `sendBeacon` API 发送HTTP请求（性能更好、异步非阻塞），`axios` 仅作为候补方案（当 `sendBeacon` 不可用、失败或数据过大时使用）。SDK 会自动安装 axios 依赖作为候补。
 
 ## 快速开始
 
@@ -505,38 +505,47 @@ npm run build
 npm run dev
 ```
 
-## Axios集成
+## 数据上报机制
 
-SDK默认使用axios进行所有HTTP请求，包括：
+SDK 采用智能上报策略，优先使用现代浏览器 API，自动降级保证兼容性：
 
-1. **数据上报**: 自动使用axios发送数据到后端
-2. **性能监控**: 自动监控所有axios请求的性能
-3. **错误处理**: 统一的axios错误处理机制
+### 上报优先级
 
-### 使用内置axios实例
+1. **sendBeacon（主要方式）**
+   - ✅ 异步非阻塞，不影响页面性能
+   - ✅ 页面卸载时仍能可靠发送（重要数据不丢失）
+   - ✅ 性能更好，不占用主线程
+   - ✅ 自动处理，无需额外配置
+   - ⚠️ 数据大小限制约 60KB（超过时自动使用 axios）
+
+2. **axios（候补方案）**
+   - 🔄 当 `sendBeacon` 不可用、失败或数据过大时自动使用
+   - 🔄 支持更大的数据量
+   - 🔄 兼容所有浏览器环境
+
+### 自动降级策略
 
 ```javascript
-// SDK会自动使用axios进行所有网络请求
+// SDK 会自动选择最佳上报方式
 const sdk = new FrontendSDK({
   reportUrl: 'https://your-api.com/report'
 })
 
-// 数据会自动通过axios上报
+// 优先尝试 sendBeacon，失败或不可用时自动使用 axios
 sdk.reportEvent('user_action', { action: 'click' })
 ```
 
-### 使用自定义axios配置
+### 使用自定义 axios 配置（仅候补场景）
+
+当 SDK 使用 axios 作为候补方案时，可以使用自定义配置：
 
 ```javascript
-// 如果需要自定义axios配置，可以导入axios实例
-import axiosInstance from './axios-config'
+// 导入 axios 实例（仅在 axios 作为候补时使用）
+import axiosInstance from 'bw-frontend-sdk/axios-config'
 
-// 自定义配置
+// 自定义配置（仅在 axios 作为候补时生效）
 axiosInstance.defaults.baseURL = 'https://api.example.com'
 axiosInstance.defaults.timeout = 15000
-
-// 发送请求
-const response = await axiosInstance.post('/api/data', { key: 'value' })
 ```
 
 ## 相关文档

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bw-frontend-sdk",
-  "version": "1.1.7",
-  "description": "前端异常拦截和业务埋点 SDK，使用axios进行HTTP请求",
+  "version": "1.1.8",
+  "description": "前端异常拦截和业务埋点 SDK",
   "engines": {
     "node": ">=12.0.0"
   },
@@ -39,15 +39,10 @@
     "rollup-plugin-terser": "^7.0.0"
   },
   "dependencies": {
-    "axios": ">=1.11.0 <2.0.0",
-    "ua-parser-js": ">=2.0.6 <3.0.0"
+    "axios": "^1.11.0",
+    "ua-parser-js": "^2.0.6"
   },
   "peerDependencies": {
-   "vue": ">=3.0.0 <4.0.0"
-  },
-  "peerDependenciesMeta": {
-    "vue": {
-      "optional": false
-    }
+    "vue": "^3.0.0"
   }
 }