sunda-tracker 1.0.8

package/.babelrc

@@ -0,0 +1,23 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "browsers": [
+            "> 1%",
+            "last 2 versions",
+            "not ie <= 8"
+          ]
+        },
+        "modules": "commonjs",
+        "useBuiltIns": "usage",
+        "corejs": 3
+      }
+    ]
+  ],
+  "plugins": [
+    "@babel/plugin-transform-runtime",
+    "@babel/plugin-proposal-class-properties"
+  ]
+}

package/.npmrc.exclude

@@ -0,0 +1 @@
+registry=http://nexus.sunda.top/repository/npm-sunda-hosted/

package/.prettierrc.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "semi": false,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "printWidth": 80,
+  "trailingComma": "none",
+  "quoteProps": "as-needed"
+}

package/.yarnrc.exclude

@@ -0,0 +1 @@
+registry=http://nexus.sunda.top/repository/npm-sunda-hosted/

package/README.md

@@ -0,0 +1,263 @@
+# 森大埋点系统 前端 SDK
+
+## 简介
+
+森大埋点系统（Sunda Tracker）是一个轻量级的前端埋点解决方案，用于收集用户行为数据和应用性能指标。该 SDK 支持多种前端框架，包括原生 JavaScript、Vue 和 React。
+
+## 安装
+
+通过 npm 安装:
+
+```js
+npm install sunda-tracker
+```
+
+或通过 yarn 安装:
+
+```js
+yarn add sunda-tracker
+```
+
+## 如何使用
+
+### 原生 JavaScript
+
+```js
+import initTracker from 'sunda-tracker'
+
+// 初始化埋点系统，设置是否自动开启
+const tracker = initTracker({ autoTrack: true })
+
+// 手动触发埋点事件
+tracker.track('button_click', { buttonId: 'submit', page: 'home' })
+```
+
+### Vue
+
+```js
+import { createApp } from 'vue'
+import { VueTracker } from 'sunda-tracker'
+import App from './App.vue'
+
+const app = createApp(App)
+
+// 注册埋点插件
+app.use(VueTracker, { 
+  autoTrack: true,
+  // 其他配置项
+  collectUrl: 'https://analytics.example.com',
+  type: 'api' // api, es
+})
+
+app.mount('#app')
+```
+
+在 Vue 组件中使用:
+
+```js
+// 在组件中使用
+export default {
+  methods: {
+    handleClick() {
+      this.$track('button_click', { buttonId: 'submit' })
+    }
+  },
+  mounted() {
+    // 设置用户信息
+    this.$setUser({ userId: '12345', role: 'admin' })
+  }
+}
+```
+
+### React
+
+```jsx
+// 在应用入口文件 (如 index.js 或 App.js)
+import React from 'react'
+import ReactDOM from 'react-dom'
+import { TrackProvider } from './TrackContext'
+import App from './App'
+
+ReactDOM.render(
+  <TrackProvider options={{ 
+    autoTrack: true,
+    collectUrl: 'https://analytics.example.com',
+    type: 'api'
+  }}>
+    <App />
+  </TrackProvider>,
+  document.getElementById('root')
+)
+```
+
+TrackContext.js 文件:
+
+```js
+// TrackContext.js
+import React, { createContext, useContext } from 'react'
+import initTracker from 'sunda-tracker'
+
+// 默认配置
+const DEFAULT_OPTIONS = {
+  autoTrack: true,
+  collectUrl: 'https://analytics.default.com'
+}
+
+// 创建上下文
+const TrackContext = createContext(null)
+
+// 创建Provider组件
+export const TrackProvider = ({ children, options = {} }) => {
+  // 创建Track实例
+  const trackInstance = initTracker({
+    ...DEFAULT_OPTIONS,
+    ...options
+  })
+
+  // 定义跟踪方法
+  const trackMethods = {
+    track(eventName, eventData) {
+      return trackInstance.track(eventName, eventData)
+    },
+
+    setUser(userInfo) {
+      return trackInstance.setUser(userInfo)
+    },
+
+    clearUser() {
+      return trackInstance.clearUser()
+    },
+
+    trackDeviceInfo() {
+      return trackInstance.track('device', trackInstance.deviceInfo)
+    }
+  }
+
+  return (
+    <TrackContext.Provider value={trackMethods}>
+      {children}
+    </TrackContext.Provider>
+  )
+}
+
+// 创建自定义Hook
+export const useTrack = () => {
+  const context = useContext(TrackContext)
+  if (!context) {
+    throw new Error('useTrack must be used within a TrackProvider')
+  }
+  return context
+}
+```
+
+在 React 组件中使用:
+
+```jsx
+import React from 'react'
+import { useTrack } from './TrackContext'
+
+function MyComponent() {
+  const { track, setUser } = useTrack()
+  
+  const handleClick = () => {
+    track('button_click', { buttonId: 'submit', component: 'MyComponent' })
+  }
+  
+  React.useEffect(() => {
+    // 设置用户信息
+    setUser({ userId: '12345', role: 'user' })
+  }, [])
+  
+  return (
+    <button onClick={handleClick}>
+      提交
+    </button>
+  )
+}
+```
+
+### HTML 标记埋点
+
+您可以通过添加特定的 data 属性来实现声明式埋点:
+
+```html
+<button
+  data-track-type="button_click"
+  data-track-args-code="submit_button"
+  data-track-args-name="提交按钮"
+  data-track-args-page="home"
+>
+  提交
+</button>
+```
+
+## 配置选项
+
+初始化埋点系统时可用的配置选项:
+
+| 选项 | 类型 | 默认值 | 描述 |
+|------|------|--------|------|
+| autoTrack | Boolean | false | 是否自动跟踪页面浏览、点击等事件 |
+| serverUrl | String | - | 数据上报的服务器地址 |
+| appId | String | - | 应用标识 |
+| sampleRate | Number | 1 | 采样率 (0-1 之间的数值) |
+| maxCacheSize | Number | 50 | 本地缓存的最大事件数量 |
+| debug | Boolean | false | 是否开启调试模式 |
+
+## API 参考
+
+### 核心方法
+
+- **track(eventName, eventData)**: 手动触发埋点事件
+- **setUser(userInfo)**: 设置用户信息
+- **clearUser()**: 清除用户信息
+- **getDeviceInfo()**: 获取设备信息
+- **enableAutoTrack()**: 启用自动埋点
+- **disableAutoTrack()**: 禁用自动埋点
+
+### 自动采集的事件类型（计划中，目前不会采集这些）
+
+当 `autoTrack` 设置为 `true` 时，SDK 会自动采集以下事件:
+
+- 页面浏览 (`page_view`)
+- 页面离开 (`page_leave`)
+- 点击事件 (`element_click`)
+- 表单提交 (`form_submit`)
+- 错误事件 (`js_error`)
+- 资源加载失败 (`resource_error`)
+- 性能指标 (`performance`)
+
+## 高级用法
+
+### 批量上报
+
+```js
+initTracker({
+  batchSend: true,
+  batchSize: 10, // 累积10条数据后上报
+  batchTime: 5000 // 或者每5秒上报一次，以先到者为准
+})
+```
+
+### 离线缓存
+
+SDK 支持在网络不可用时缓存埋点数据，并在网络恢复后自动上报:
+
+```js
+initTracker({
+  enableOfflineCache: true,
+  maxCacheSize: 100, // 最多缓存100条事件
+  maxCacheTime: 7 * 24 * 60 * 60 * 1000 // 最长缓存7天
+})
+```
+
+## 注意事项
+
+1. 在生产环境中，建议设置合适的采样率以减少数据量
+2. 敏感信息（如密码、身份证号等）不应被埋点收集
+3. 确保遵守相关的数据隐私法规和政策
+
+
+## 许可证
+
+MIT