yrjy_mini_sdk 1.0.0 → 1.0.1

package/README.md

@@ -1,463 +1,518 @@
-# 小程序埋点SDK
-
-## 项目介绍
-
-本SDK是一个专为小程序设计的埋点解决方案，兼容微信小程序和抖音小程序，基于 **UniApp + Vue3** 框架开发。
-
-- 支持页面访问埋点
-- 支持自定义事件埋点
-- 自动收集设备信息和网络状态
-- 支持用户信息关联
-- 提供简单易用的API接口
-- 支持接口自动上报（使用SDK提供的HTTP实例）
-
-## 安装方法
-
-### NPM安装
-
-```bash
-npm install mini_sdk
-```
-
-### 直接引入
-
-将SDK文件复制到项目中，然后通过相对路径引入。
-
-## 使用方法
-
-### 1. 初始化SDK
-
-#### 方法一：全局挂载（推荐）
-
-在main.js中全局注册SDK：
-
-```javascript
-import { createApp } from 'vue';
-import App from './App.vue';
-import MiniSDK from 'mini_sdk';
-
-const app = createApp(App);
-
-// 全局注册SDK（可传入配置参数）
-app.use(MiniSDK, {
-  reportUrl: 'https://your-api.com/report', // 埋点上报接口
-  enabled: true // 是否启用埋点
-});
-
-app.mount('#app');
-```
-
-使用时：
-
-```javascript
-// 组件中使用
-this.$Track.report({
-  trackType: 'event',
-  eventName: 'click_button'
-});
-
-// 非组件环境（如工具函数）
-uni.$Track.report({
-  trackType: 'event',
-  eventName: 'api_call'
-});
-```
-
-#### 方法二：按需引入
-
-在需要使用的文件中引入：
-
-```javascript
-import { Track, trackPageMixin } from 'mini_sdk';
-
-// 初始化埋点SDK
-Track.init({
-  reportUrl: 'https://your-api.com/report', // 埋点上报接口
-  enabled: true // 是否启用埋点
-});
-
-// 页面使用混入
-export default {
-  mixins: [trackPageMixin],
-  // 页面其他代码...
-};
-```
-
-### 2. 页面埋点
-
-#### 自动注入（推荐）
-
-当使用`app.use(MiniSDK)`全局注册后，trackPageMixin会自动注入到所有页面组件中，无需手动引入。
-
-#### 手动引入
-
-如果不需要全局注入，也可以在特定页面手动引入：
-
-```javascript
-import { trackPageMixin } from 'mini_sdk';
-
-export default {
-  mixins: [trackPageMixin],
-  // 页面其他代码...
-};
-```
-
-### 3. 自定义事件埋点
-
-#### 全局挂载后使用
-
-```javascript
-// 组件中使用
-this.$Track.report({
-  trackType: 'event',
-  eventName: 'click_button',
-  eventData: {
-    buttonId: 'submit',
-    viewPagePath: '/pages/index/index'
-  }
-});
-
-// 非组件环境使用
-uni.$Track.report({
-  trackType: 'event',
-  eventName: 'api_call',
-  eventData: {
-    apiUrl: '/api/user',
-    method: 'GET'
-  }
-});
-```
-
-#### 按需引入使用
-
-```javascript
-import { Track } from 'mini_sdk';
-
-// 上报自定义事件
-Track.report({
-  trackType: 'event',
-  eventName: 'click_button',
-  eventData: {
-    buttonId: 'submit',
-    viewPagePath: '/pages/index/index'
-  }
-});
-```
-
-### 4. 设置用户信息
-
-```javascript
-import { Track } from 'mini_sdk';
-
-// 设置用户信息（登录后调用）
-Track.setUserInfo({
-  id: 'user123',
-  mobile: '13800138000'
-});
-
-// 清除用户信息（登出时调用）
-Track.clearUserInfo();
-```
-
-### 5. 接口自动上报
-
-使用SDK提供的HTTP实例发送请求，接口调用会自动上报埋点。
-
-**使用示例**：
-
-```javascript
-import http from 'mini_sdk/src/axios/request.js';
-
-// 发送GET请求，会自动上报埋点
-http.get('/api/test', { id: 1 })  
-  .then(res => {
-    console.log('请求成功', res);
-  })
-  .catch(err => {
-    console.error('请求失败', err);
-  });
-
-// 发送POST请求，会自动上报埋点
-http.post('/api/test', { name: 'test' })
-  .then(res => {
-    console.log('请求成功', res);
-  })
-  .catch(err => {
-    console.error('请求失败', err);
-  });
-```
-
-### 6. 栏目管理
-
-```javascript
-import { Track } from 'mini_sdk';
-
-// 设置一级栏目
-Track.setPrimaryCategory([
-  { id: '1', title: '首页' },
-  { id: '2', title: '我的' }
-], 0);
-
-// 设置二级栏目
-Track.setSecondaryCategory([
-  { id: '1-1', title: '推荐' },
-  { id: '1-2', title: '热门' }
-], 0);
-
-// 重置或设置栏目（支持恢复默认值或直接赋值）
-
-// 重置二级栏目为默认值（空字符串）
-Track.resetCategory();
-
-// 重置一级栏目为默认值（空字符串）
-Track.resetCategory('primary');
-
-// 重置一级和二级栏目为默认值（空字符串）
-Track.resetCategory('both');
-
-// 设置二级栏目为 "新的二级栏目"
-Track.resetCategory('secondary', '新的二级栏目');
-
-// 设置一级栏目为 "新的一级栏目"
-Track.resetCategory('primary', '新的一级栏目');
-
-// 同时设置一级和二级栏目为相同值
-Track.resetCategory('both', '通用栏目');
-
-// 分别设置一级和二级栏目为不同值
-Track.resetCategory('both', {
-  primary: '新的一级栏目',
-  secondary: '新的二级栏目'
-});
-```
-
-## API文档
-
-### Track类
-
-#### `Track.init(options)`
-
-初始化埋点SDK。
-
-- `options`：配置对象
-  - `reportUrl`：埋点上报接口URL
-  - `enabled`：是否启用埋点（默认true）
-
-#### `Track.report(trackData)`
-
-上报埋点数据。
-
-- `trackData`：埋点数据对象
-  - `trackType`：埋点类型（必填）
-  - 其他自定义字段
-
-#### `Track.setUserInfo(userInfo)`
-
-设置用户信息。
-
-- `userInfo`：用户信息对象
-  - `id`：用户ID（必填）
-  - `mobile`：用户手机号（可选）
-
-#### `Track.clearUserInfo()`
-
-清除用户信息。
-
-#### `Track.enable()`
-
-开启埋点功能。
-
-#### `Track.disable()`
-
-关闭埋点功能。
-
-#### `Track.resetCategory(type, value)`
-
-重置或设置栏目信息。
-
-- `type`：操作类型，可选值："primary"（一级栏目）、"secondary"（二级栏目）、"both"（两者都操作），默认值为 "secondary"
-- `value`：可选，要设置的值。
-  - 当 `type` 为 "primary" 或 "secondary" 时，`value` 应为字符串
-  - 当 `type` 为 "both" 时，`value` 可以是字符串（同时设置两个栏目为相同值）或对象（分别设置两个栏目）
-  - 如果不提供，则重置为默认值（空字符串）
-
-### trackPageMixin
-
-页面埋点混入，自动采集页面访问数据：
-
-- 自动记录页面加载时间
-- 自动计算页面停留时间
-- 自动上报页面显示/隐藏/卸载事件
-
-## 数据上报格式
-
-埋点上报的数据格式如下：
-
-```javascript
-{
-  launchTime: 1620000000000, // 小程序启动时间
-  path: '/pages/index/index', // 启动路径
-  scene: 1001, // 启动场景
-  query: {}, // 启动参数
-  currentTime: 1620000100000, // 当前时间戳
-  system: 'iOS 14.4', // 操作系统
-  uniPlatform: 'mp-weixin', // 平台
-  deviceBrand: 'Apple', // 设备品牌
-  deviceType: 'iphone', // 设备类型
-  appId: 'wx1234567890', // 小程序AppID
-  version: '1.0.0', // 小程序版本
-  envVersion: 'release', // 小程序环境
-  userId: 'user123', // 用户ID
-  userPhone: '13800138000', // 用户手机号
-  networkType: 'wifi', // 网络类型
-  customData: { // 自定义埋点数据
-    trackType: 'page',
-    viewPagePath: '/pages/index/index',
-    timestamp: 1620000000000,
-    stayTime: 10000,
-    reportType: 'unload'
-  }
-}
-```
-
-## 注意事项
-
-1. 请确保在小程序启动时调用`Track.init()`进行初始化
-2. 页面埋点混入会自动处理页面生命周期事件，无需手动调用
-3. 自定义事件埋点需要手动调用`Track.report()`方法
-4. 为了保证埋点数据的准确性，建议在用户登录后调用`Track.setUserInfo()`设置用户信息
-5. 埋点上报接口需要根据实际后端接口进行配置
-6. 请确保小程序有网络请求权限
-
-## 兼容性
-
-- 微信小程序
-- 抖音小程序
-- 其他基于UniApp框架的小程序平台
-
-## 开发说明
-
-### 项目结构
-
-```
-src/
-├── axios/            # 网络请求模块
-│   ├── api.js        # API接口定义
-│   └── request.js    # 请求封装
-├── config/           # 配置文件
-│   └── index.js      # 全局配置
-├── struct/           # 核心结构
-│   ├── trackCore.js  # 埋点核心实现
-│   └── trackPageMixin.js  # 页面埋点混入
-└── index.js          # 入口文件
-```
-
-### 核心功能
-
-1. **页面埋点**：自动采集页面访问数据，包括页面路径、访问时间、停留时间等
-2. **设备信息采集**：自动收集设备品牌、型号、操作系统等信息
-3. **网络状态检测**：自动采集网络类型
-4. **用户信息关联**：支持关联用户ID和手机号
-5. **自定义事件**：支持自定义事件埋点
-
-## 故障排查
-
-### 埋点不上报
-
-1. 检查`Track.init()`是否调用
-2. 检查`enabled`配置是否为true
-3. 检查网络连接是否正常
-4. 检查上报接口是否正确
-
-### 数据不完整
-
-1. 检查用户信息是否正确设置
-2. 检查自定义埋点数据格式是否正确
-3. 检查设备权限是否开启
-
-## 联系我们
-
-如有问题或建议，请联系我们的开发团队。
-
-## 打包配置
-
-### 打包命令
-
-本项目使用 `rollup` 进行打包，支持以下命令：
-
-```bash
-# 安装依赖
-npm install
-
-# 开发模式（无压缩）
-npm run dev
-
-# 生产模式（有压缩）
-npm run build
-
-# 构建并发布（更新版本号并发布到npm）
-npm run release
-```
-
-### 打包配置文件
-
-项目根目录下的 `rollup.config.js` 文件用于配置打包选项，具体配置如下：
-
-```javascript
-import babel from '@rollup/plugin-babel';
-import resolve from '@rollup/plugin-node-resolve';
-import commonjs from '@rollup/plugin-commonjs';
-import terser from '@rollup/plugin-terser';
-import pkg from './package.json';
-
-const isProduction = process.env.NODE_ENV === 'production';
-
-export default {
-  input: 'src/index.js',
-  output: [
-    {
-      file: pkg.main,
-      format: 'cjs',
-      sourcemap: !isProduction
-    },
-    {
-      file: pkg.module,
-      format: 'es',
-      sourcemap: !isProduction
-    }
-  ],
-  plugins: [
-    resolve(),
-    commonjs(),
-    babel({
-      exclude: 'node_modules/**',
-      babelHelpers: 'runtime'
-    }),
-    isProduction && terser()
-  ].filter(Boolean)
-};
-```
-
-### 发布到NPM
-
-1. 确保已登录NPM账号：
-   ```bash
-   npm login
-   ```
-
-2. 运行发布命令：
-   ```bash
-   npm run release
-   ```
-
-   该命令会自动更新版本号、构建项目并发布到NPM。
-
-### 版本号管理
-
-项目使用语义化版本号（SemVer），格式为 `x.y.z`：
-
-- `x`：主版本号，不兼容的API更改
-- `y`：次版本号，向下兼容的功能添加
-- `z`：补丁版本号，向下兼容的错误修正
-
-发布命令会自动递增版本号，默认递增补丁版本号。如需递增次版本号或主版本号，请手动修改 `package.json` 文件中的 `version` 字段。
+# 小程序埋点SDK
+
+## 项目介绍
+
+本SDK是一个专为小程序设计的埋点解决方案，基于 **UniApp + Vue3** 框架开发，兼容微信小程序和抖音小程序。
+
+- 支持页面访问埋点（自动）
+- 支持自定义事件埋点（手动）
+- 支持页面跳转事件自动埋点
+- 自动收集设备信息和网络状态
+- 支持用户信息关联
+- 支持OpenID自动获取
+- 提供简单易用的API接口
+- 支持广告数据上报
+
+## 安装方法
+
+### NPM安装
+
+```bash
+npm install yrjy_mini_sdk
+```
+
+### 直接引入
+
+将SDK文件复制到项目中，然后通过相对路径引入。
+
+## 使用方法
+
+### 1. 初始化SDK
+
+#### 方法一：全局挂载（推荐）
+
+在main.js中全局注册SDK：
+
+```javascript
+import { createApp } from 'vue';
+import App from './App.vue';
+import MiniSDK from 'yrjy_mini_sdk';
+
+const app = createApp(App);
+
+// 全局注册SDK（可传入配置参数）
+app.use(MiniSDK, {
+  reportUrl: 'https://your-api.com/report', // 埋点上报接口，默认使用配置文件中的logURL
+  enabled: true // 是否启用埋点，默认true
+});
+
+app.mount('#app');
+```
+
+使用时：
+
+```javascript
+// 组件中使用
+this.$Track.report({
+  name: 'click_button',
+  action: '按钮点击'
+});
+
+// 非组件环境使用
+uni.$Track.report({
+  name: 'api_call',
+  action: '接口调用'
+});
+```
+
+#### 方法二：按需引入
+
+在需要使用的文件中引入：
+
+```javascript
+import { Track, trackPageMixin } from 'yrjy_mini_sdk';
+
+// 初始化埋点SDK
+Track.init({
+  reportUrl: 'https://your-api.com/report', // 埋点上报接口，默认使用配置文件中的logURL
+  enabled: true // 是否启用埋点，默认true
+});
+
+// 页面使用混入
+export default {
+  mixins: [trackPageMixin],
+  // 页面其他代码...
+};
+```
+
+### 2. 页面埋点
+
+页面埋点会自动采集页面访问数据，包括页面路径、访问时间、停留时间等。
+
+**实现原理**：
+- 在页面 `onLoad` 时初始化埋点数据
+- 在页面 `onShow` 时更新页面显示时间
+- 在页面 `onHide` 或 `onUnload` 时上报页面曝光事件
+
+**上报数据格式**：
+```javascript
+{
+  action: '页面曝光',
+  name: 'pageviewEvent',
+  data: {
+    path: '/pages/index/index', // 页面路径
+    loadTime: 1620000000000, // 页面加载时间
+    leaveTime: 1620000100000, // 页面离开时间
+    params: { id: '123' }, // 页面参数
+    stayTime: 10000 // 页面停留时间（毫秒）
+  }
+}
+```
+
+### 3. 自定义事件埋点
+
+#### 全局挂载后使用
+
+```javascript
+// 组件中使用
+this.$Track.report({
+  name: 'click_button',
+  action: '按钮点击',
+  data: {
+    buttonId: 'submit',
+    viewPagePath: '/pages/index/index'
+  }
+});
+
+// 非组件环境使用
+uni.$Track.report({
+  name: 'api_call',
+  action: '接口调用',
+  data: {
+    apiUrl: '/api/user',
+    method: 'GET'
+  }
+});
+```
+
+#### 按需引入使用
+
+```javascript
+import { Track } from 'yrjy_mini_sdk';
+
+// 上报自定义事件
+Track.report({
+  name: 'click_button',
+  action: '按钮点击',
+  data: {
+    buttonId: 'submit',
+    viewPagePath: '/pages/index/index'
+  }
+});
+```
+
+### 4. 设置用户信息
+
+```javascript
+import { Track } from 'yrjy_mini_sdk';
+
+// 设置用户信息（登录后调用）
+Track.setUserInfo({
+  userId: 'user123', // 用户ID（必填）
+  userPhone: '13800138000' // 用户手机号（可选）
+});
+
+// 清除用户信息（登出时调用）
+Track.clearUserInfo();
+```
+
+### 5. 栏目管理
+
+```javascript
+import { Track } from 'yrjy_mini_sdk';
+
+// 设置一级栏目
+Track.setPrimaryCategory([
+  { id: '1', title: '首页' },
+  { id: '2', title: '我的' }
+], 0); // 0为选中的索引
+
+// 设置二级栏目
+Track.setSecondaryCategory([
+  { id: '1-1', title: '推荐' },
+  { id: '1-2', title: '热门' }
+], 0); // 0为选中的索引
+
+// 重置或设置栏目（支持恢复默认值或直接赋值）
+
+// 重置二级栏目为默认值（空字符串）
+Track.resetCategory();
+
+// 重置一级栏目为默认值（空字符串）
+Track.resetCategory('primary');
+
+// 重置一级和二级栏目为默认值（空字符串）
+Track.resetCategory('both');
+
+// 设置二级栏目为 "新的二级栏目"
+Track.resetCategory('secondary', '新的二级栏目');
+
+// 设置一级栏目为 "新的一级栏目"
+Track.resetCategory('primary', '新的一级栏目');
+
+// 同时设置一级和二级栏目为相同值
+Track.resetCategory('both', '通用栏目');
+
+// 分别设置一级和二级栏目为不同值
+Track.resetCategory('both', {
+  primary: '新的一级栏目',
+  secondary: '新的二级栏目'
+});
+```
+
+### 6. 页面跳转事件（自动埋点）
+
+SDK会自动拦截小程序的页面跳转API，自动上报页面跳转事件，无需手动调用。
+
+**支持的跳转方法**：
+- `uni.navigateTo` - 保留当前页面，跳转到应用内的某个页面
+- `uni.redirectTo` - 关闭当前页面，跳转到应用内的某个页面
+- `uni.reLaunch` - 关闭所有页面，打开到应用内的某个页面
+- `uni.switchTab` - 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
+- `uni.navigateBack` - 关闭当前页面，返回上一页面或多级页面
+
+**上报数据格式**：
+```javascript
+{
+  action: '页面跳转',
+  name: 'navigationEvent',
+  data: {
+    currentPagePath: '/pages/index/index', // 当前页面路径
+    targetPagePath: '/pages/detail/detail', // 目标页面路径（navigateBack时为'back'）
+    navigationParams: { id: '123' } // 跳转参数
+  }
+}
+```
+
+### 7. OpenID自动获取
+
+SDK在初始化时会自动获取用户的OpenID，无需手动调用。
+
+**获取流程**：
+1. 调用 `uni.login()` 获取登录 code
+2. 使用 code 调用后端接口获取 OpenID
+3. 将 OpenID 缓存到内存中，供后续埋点使用
+
+**上报数据格式**：
+```javascript
+{
+  openid: 'o1234567890abcdef', // 用户OpenID
+  // ... 其他埋点数据
+}
+```
+
+**配置接口**：
+在 `src/config/index.js` 中配置获取OpenID的接口基础路径：
+```javascript
+export default {
+  miniProURL: 'https://your-api.com', // 小程序接口地址
+  // ... 其他配置
+};
+```
+
+### 8. 广告数据上报
+
+SDK支持广告数据上报，用于追踪广告效果。
+
+**支持的广告类型**：
+- `REGISTER` - 注册
+- `VIEW_CONTENT` - 关键页面访问(上传图片)
+- `RESERVATION` - 表单预约(制作完成)
+
+**实现原理**：
+SDK会自动从启动参数中获取广告相关信息，包括广告ID、子渠道等，在指定时机上报广告数据。
+
+## API文档
+
+### Track类
+
+#### `Track.init(options)`
+
+初始化埋点SDK。
+
+- `options`：配置对象
+  - `reportUrl`：埋点上报接口URL，默认使用配置文件中的logURL
+  - `enabled`：是否启用埋点（默认true）
+
+#### `Track.report(trackData)`
+
+上报埋点数据。
+
+- `trackData`：埋点数据对象
+  - `name`：埋点类型（必填）
+  - `action`：埋点行为名称（必填）
+  - `data`：埋点数据（可选）
+
+#### `Track.customReport(action, data, name, needColumn)`
+
+自定义埋点上报，提供更灵活的埋点配置。
+
+- `action`：埋点行为名称（必填）
+- `data`：埋点数据（可选，默认{}）
+- `name`：埋点类型（可选，默认"clickEvent"）
+- `needColumn`：是否需要栏目信息（可选，默认true）
+
+#### `Track.setUserInfo(userInfo)`
+
+设置用户信息。
+
+- `userInfo`：用户信息对象
+  - `userId`：用户ID（必填）
+  - `userPhone`：用户手机号（可选）
+
+#### `Track.clearUserInfo()`
+
+清除用户信息。
+
+#### `Track.enable()`
+
+开启埋点功能。
+
+#### `Track.disable()`
+
+关闭埋点功能。
+
+#### `Track.setPrimaryCategory(categoryList, selectedIndex)`
+
+设置一级栏目。
+
+- `categoryList`：栏目列表，每个元素需包含title字段
+- `selectedIndex`：当前选中的索引
+
+#### `Track.setSecondaryCategory(categoryList, selectedIndex)`
+
+设置二级栏目。
+
+- `categoryList`：栏目列表，每个元素需包含title字段
+- `selectedIndex`：当前选中的索引
+
+#### `Track.resetCategory(type, value)`
+
+重置或设置栏目信息。
+
+- `type`：操作类型，可选值："primary"（一级栏目）、"secondary"（二级栏目）、"both"（两者都操作），默认值为 "secondary"
+- `value`：可选，要设置的值。
+  - 当 `type` 为 "primary" 或 "secondary" 时，`value` 应为字符串
+  - 当 `type` 为 "both" 时，`value` 可以是字符串（同时设置两个栏目为相同值）或对象（分别设置两个栏目）
+  - 如果不提供，则重置为默认值（空字符串）
+
+### trackPageMixin
+
+页面埋点混入，自动采集页面访问数据：
+
+- 自动记录页面加载时间
+- 自动计算页面停留时间
+- 自动上报页面曝光事件
+
+## 数据上报格式
+
+埋点上报的基础数据格式如下：
+
+```javascript
+{
+  launchTime: 1620000000000, // 小程序启动时间
+  launchPath: '/pages/index/index', // 启动路径
+  launchScene: 1001, // 启动场景
+  launchParams: '{}', // 启动参数
+  currentTime: 1620000100000, // 当前时间戳
+  system: 'iOS 14.4', // 操作系统
+  uniPlatform: 'mp-weixin', // 平台
+  deviceBrand: 'Apple', // 设备品牌
+  deviceType: 'iphone', // 设备类型
+  appId: 'wx1234567890', // 小程序AppID
+  version: '1.0.0', // 小程序版本
+  envVersion: 'release', // 小程序环境
+  userId: 'user123', // 用户ID
+  userPhone: '13800138000', // 用户手机号
+  openid: 'o1234567890abcdef', // 用户OpenID
+  networkType: 'wifi', // 网络类型
+  action: '页面曝光', // 埋点行为名称
+  name: 'pageviewEvent', // 埋点类型
+  data: '{...}', // 埋点数据（JSON字符串）
+}
+```
+
+## 兼容性
+
+- 微信小程序
+- 抖音小程序
+- 其他基于UniApp框架的小程序平台
+
+## 开发说明
+
+### 项目结构
+
+```
+src/
+├── axios/            # 网络请求模块
+│   ├── api.js        # API接口定义
+│   └── request.js    # 请求封装
+├── config/           # 配置文件
+│   └── index.js      # 全局配置
+├── struct/           # 核心结构
+│   ├── trackCore.js  # 埋点核心实现
+│   └── trackPageMixin.js  # 页面埋点混入
+├── utils/            # 工具函数
+│   └── common.js     # 通用工具函数
+└── index.js          # 入口文件
+```
+
+### 核心功能
+
+1. **页面埋点**：自动采集页面访问数据，包括页面路径、访问时间、停留时间等
+2. **设备信息采集**：自动收集设备品牌、型号、操作系统等信息
+3. **网络状态检测**：自动采集网络类型
+4. **用户信息关联**：支持关联用户ID和手机号
+5. **自定义事件**：支持自定义事件埋点
+6. **页面跳转事件**：自动拦截小程序页面跳转API，自动上报页面跳转事件
+7. **OpenID自动获取**：在初始化时自动获取用户的OpenID
+8. **广告数据上报**：支持广告效果追踪
+
+## 配置说明
+
+### 配置文件
+
+项目的配置文件位于 `src/config/index.js`，包含以下配置项：
+
+```javascript
+export default {
+  baseURL: '', // 基础接口地址
+  logURL: "https://log.cdyrjygs.com/binlog", // 埋点上报接口
+  miniProURL: 'https://crbt.cdyrjygs.com/cms-vrbt' // 小程序接口地址
+};
+```
+
+### 构建配置
+
+项目使用 Rollup 进行构建，配置文件位于 `rollup.config.js`。
+
+**构建命令**：
+```bash
+# 开发模式（无压缩）
+npm run dev
+
+# 生产模式（有压缩）
+npm run build
+
+# 构建并发布（更新版本号并发布到npm）
+npm run release
+```
+
+**生产环境优化**：
+- 代码压缩
+- 移除控制台日志
+- 移除调试器语句
+- 未使用代码移除
+
+## 故障排查
+
+### 埋点不上报
+
+1. 检查`Track.init()`是否调用
+2. 检查`enabled`配置是否为true
+3. 检查网络连接是否正常
+4. 检查上报接口是否正确
+5. 检查小程序是否有网络请求权限
+
+### 页面曝光事件不上报
+
+1. 检查页面是否正确使用了`trackPageMixin`
+2. 检查页面是否正常触发了`onHide`或`onUnload`生命周期
+3. 检查SDK是否已正确初始化
+
+### OpenID获取失败
+
+1. 检查小程序是否有登录权限
+2. 检查`miniProURL`配置是否正确
+3. 检查后端接口是否正常
+
+## 联系我们
+
+如有问题或建议，请联系我们的开发团队。
+
+## 版本号管理
+
+项目使用语义化版本号（SemVer），格式为 `x.y.z`：
+
+- `x`：主版本号，不兼容的API更改
+- `y`：次版本号，向下兼容的功能添加
+- `z`：补丁版本号，向下兼容的错误修正
+
+发布命令会自动递增版本号，默认递增补丁版本号。如需递增次版本号或主版本号，请手动修改 `package.json` 文件中的 `version` 字段。
+
+## 完整构建和发布流程
+
+1. **安装依赖**：
+   ```bash
+   npm install
+   ```
+
+2. **开发模式**（可选，用于调试）：
+   ```bash
+   npm run dev
+   ```
+
+3. **生产构建**（可选，用于本地验证）：
+   ```bash
+   npm run build
+   ```
+
+4. **发布到NPM**：
+   ```bash
+   npm run release
+   ```
+
+   该命令会自动执行以下操作：
+   - 更新版本号（默认递增补丁版本号）
+   - 构建生产版本
+   - 发布到NPM