@rk911/tracker-sdk 1.6.4

package/index.js

@@ -0,0 +1,403 @@
+import { Tracker } from './core/tracker.js'
+import {
+  createDadianProxy,
+  createImpressionDirective,
+  createPageStayMixin,
+} from './core/compat.js'
+import { WebAdapter } from './platforms/web.js'
+import { WeappAdapter } from './platforms/weapp.js'
+import { AppAdapter } from './platforms/app.js'
+import { getProjectRules } from './customize/index.js'
+
+// 插件注册表
+import { PageViewPlugin } from './plugins/page-view.js'
+import { ClickPlugin } from './plugins/click.js'
+import { PageStayPlugin } from './plugins/page-stay.js'
+import { ExposurePlugin } from './plugins/exposure.js'
+import { JsErrorPlugin } from './plugins/js-error.js'
+import { ApiWatchPlugin } from './plugins/api-watch.js'
+import { AppLifecyclePlugin } from './plugins/app-lifecycle.js'
+import { PerformancePlugin } from './plugins/performance.js'
+import { ScrollDepthPlugin } from './plugins/scroll-depth.js'
+
+const PLUGIN_MAP = {
+  'page-view': PageViewPlugin,
+  click: ClickPlugin,
+  'page-stay': PageStayPlugin,
+  exposure: ExposurePlugin,
+  'js-error': JsErrorPlugin,
+  performance: PerformancePlugin,
+  'scroll-depth': ScrollDepthPlugin,
+  'api-watch': ApiWatchPlugin,
+  'app-lifecycle': AppLifecyclePlugin,
+}
+
+// 单例
+let trackerInstance = null
+
+/**
+ * 自动检测当前运行平台
+ */
+function detectPlatform() {
+  try {
+    if (
+      typeof wx !== 'undefined' &&
+      typeof wx.getSystemInfoSync === 'function' &&
+      typeof document === 'undefined'
+    ) {
+      return 'weapp'
+    }
+  } catch (e) {}
+
+  if (typeof window !== 'undefined' && typeof document !== 'undefined') {
+    return 'web'
+  }
+
+  return 'web'
+}
+
+/**
+ * 创建平台适配器
+ */
+function createAdapter(platform, config) {
+  switch (platform) {
+    case 'weapp':
+      return new WeappAdapter(config)
+    case 'app':
+      return new AppAdapter(config)
+    default:
+      return new WebAdapter(config)
+  }
+}
+
+/**
+ * 创建 Tracker 实例
+ */
+export function createTracker(config) {
+  if (trackerInstance) {
+    trackerInstance.destroy()
+  }
+
+  var platform = config.platform || detectPlatform()
+  config.platform = platform
+
+  // 自动加载项目定制规则（未显式传入时按 appId 匹配）
+  if (!config.projectRules && config.appId) {
+    config.projectRules = getProjectRules(config.appId)
+  }
+
+  var adapter = createAdapter(platform, config)
+  trackerInstance = new Tracker(config, adapter)
+
+  // 注册插件
+  var pluginNames = config.plugins || []
+  pluginNames.forEach(function (pluginName) {
+    var PluginClass = null
+
+    if (typeof pluginName === 'string') {
+      PluginClass = PLUGIN_MAP[pluginName]
+    } else if (typeof pluginName === 'function') {
+      PluginClass = pluginName
+    } else if (pluginName && typeof pluginName.install === 'function') {
+      // 直接传入插件实例
+      trackerInstance.use(pluginName)
+      return
+    }
+
+    if (PluginClass) {
+      trackerInstance.use(new PluginClass())
+    }
+  })
+
+  return trackerInstance
+}
+
+/**
+ * 获取当前 Tracker 单例
+ */
+export function getTracker() {
+  return trackerInstance
+}
+
+/**
+ * 设备注册 — 无 deviceId 时调用后端接口获取，失败重试最多 3 次
+ */
+function registerDeviceIfNeeded(tracker) {
+  var adapter = tracker.getAdapter()
+  var config = tracker.getConfig()
+  var existingId = adapter.getStorage('deviceId')
+  if (existingId) {
+    tracker.setDeviceId(existingId)
+    return
+  }
+
+  // [PROJECT-ADAPT] appId 默认值
+  // 店长端 appId=1, apph5 appId=12/13, 小程序 appId=18
+  // 各项目在初始化时传入自己的 appId，此处 ||1 为兜底
+  var deviceInfo = { appId: Number(config.appId) || 1, id: '' }
+  if (typeof adapter.getDetailedDeviceInfo === 'function') {
+    Object.assign(deviceInfo, adapter.getDetailedDeviceInfo())
+  }
+
+  // [PROJECT-ADAPT] 设备注册请求头
+  // 当前网关要求 appId/deviceId 作为自定义 header
+  var header = { 'content-type': 'application/json', appId: String(config.appId), deviceId: '' }
+  if (typeof config.getAuthHeaders === 'function') {
+    Object.assign(header, config.getAuthHeaders() || {})
+  }
+
+  var registerUrl = config.dadianUrl + (config.deviceRegister.url || '/api/point/device/add')
+  var maxRetries = 3
+
+  function attempt(retryCount) {
+    adapter
+      .request({ method: 'POST', url: registerUrl, data: deviceInfo, header: header })
+      .then(function (res) {
+        if (res && res.data && res.data.code === 0 && res.data.data) {
+          adapter.setStorage('deviceId', res.data.data)
+          tracker.setDeviceId(res.data.data)
+          if (config.debug) {
+            console.log('[TrackerSDK] device registered:', res.data.data)
+          }
+        } else if (retryCount < maxRetries) {
+          var delay = 1000 * Math.pow(2, retryCount)
+          setTimeout(function () { attempt(retryCount + 1) }, delay)
+          if (config.debug) {
+            console.warn('[TrackerSDK] device register bad response, retry ' + (retryCount + 1) + '/' + maxRetries + ' in ' + delay + 'ms')
+          }
+        }
+      })
+      .catch(function (err) {
+        if (retryCount < maxRetries) {
+          var delay = 1000 * Math.pow(2, retryCount)
+          setTimeout(function () { attempt(retryCount + 1) }, delay)
+          if (config.debug) {
+            console.warn('[TrackerSDK] device register failed, retry ' + (retryCount + 1) + '/' + maxRetries + ' in ' + delay + 'ms')
+          }
+        } else if (config.debug) {
+          console.warn('[TrackerSDK] device register failed after ' + maxRetries + ' retries:', err)
+        }
+      })
+  }
+
+  attempt(0)
+}
+
+/**
+ * 自动检测 userId：每次从 localStorage/cookie 实时读取
+ * 不依赖内存缓存，确保清除存储后不会残留旧用户、切换账号后能及时更新
+ */
+function _ensureUserId(tracker) {
+  var adapter = tracker.getAdapter()
+  // 从源头实时读取（登录页写入了 uni.setStorageSync('userId', ...)）
+  var uid = adapter.getStorage('userId')
+  // 降级：从 cookie 读（rkfeb-userId）
+  if (!uid && typeof document !== 'undefined') {
+    var match = document.cookie.match(/(?:^|;\s*)rkfeb-userId=([^;]+)/)
+    if (match) uid = decodeURIComponent(match[1])
+  }
+  var currentUid = tracker.getSession().getUserId()
+  if (uid && uid !== currentUid) {
+    tracker.setUser(uid)
+  } else if (!uid && currentUid) {
+    // 源头已清空（退出登录/清除缓存），同步清除内存中的旧值
+    tracker.setUser(null)
+  }
+}
+
+/**
+ * Vue.use 插件入口
+ *
+ * 用法：
+ *   import TrackerSDK from './tracker-sdk/index.js'
+ *   Vue.use(TrackerSDK, {
+ *     appId: '1',
+ *     dadianUrl: 'https://state.renruikeji.cn',
+ *     platform: 'web',
+ *     tokenKey: 'token',
+ *     plugins: ['page-view', 'click', 'page-stay', 'js-error', 'app-lifecycle', 'api-watch', 'scroll-depth'],
+ *     legacy: true,
+ *     getAuthHeaders: () => ({ Authorization: orgToken, token: orgToken }),
+ *   })
+ */
+function install(Vue, options) {
+  if (install._installed) return
+  install._installed = true
+
+  var tracker = createTracker(options || {})
+
+  // 0. 暴露 tracker 实例到 window（供验证脚本访问）
+  if (typeof window !== 'undefined') {
+    window.__tracker = tracker
+  }
+
+  // 0.1 设备注册（无 deviceId 时自动注册）
+  registerDeviceIfNeeded(tracker)
+
+  // 0.2 自动检测 userId（从 Cookie 或 storage 中读取已登录用户）
+  _ensureUserId(tracker)
+
+  // 0.3 注册 userId 刷新钩子：每次 flush 前从 storage 实时读取，
+  // 避免自动事件（page_view/click）在 userId 更新前用旧值发出
+  tracker.getQueue().setRefreshUserId(function () {
+    _ensureUserId(tracker)
+  })
+
+  // 1. 注册 $dadian（兼容现有所有业务调用）
+  var _rawDadian = createDadianProxy(tracker)
+  Vue.prototype.$dadian = function (frontUrl, postParam) {
+    _ensureUserId(tracker)
+    return _rawDadian(frontUrl, postParam)
+  }
+
+  // 2. 注册 $track（统一的上报方法，替代 $dadian）
+  // 行为与 $dadian 完全一致：第一个参数直接作为 frontUrl，不做任何路由拼接
+  Vue.prototype.$track = function (frontUrl, postParam) {
+    _ensureUserId(tracker)
+
+    // postParam 处理（与 $dadian 一致）
+    var postParamStr = ''
+    if (postParam && Object.keys(postParam).length > 0) {
+      var config = tracker.getConfig()
+      if (config.platform === 'weapp' && config.eventBus) {
+        var bus = config.eventBus
+        postParamStr = JSON.stringify(Object.assign({}, postParam, {
+          wxAppOnLaunch: bus.wxAppOnLaunch,
+          pageFrom: bus.pageFrom,
+          mallOrderExt: bus.mallOrderExt,
+        }))
+      } else {
+        postParamStr = JSON.stringify(postParam)
+      }
+    }
+
+    // 开关关（默认）：旧接口也报一次（与 $dadian 一致）
+    var config = tracker.getConfig()
+    if (!config.useUnifiedReport) {
+      var header = { 'content-type': 'application/json' }
+      var hasLegacyAuth = false
+      if (typeof config.getAuthHeaders === 'function') {
+        var authHeaders = config.getAuthHeaders() || {}
+        if (authHeaders.Authorization || authHeaders.token || authHeaders['rsb-token']) {
+          hasLegacyAuth = true
+          Object.assign(header, authHeaders)
+        }
+      }
+      if (hasLegacyAuth) {
+        tracker.getQueue().pushLegacy(
+          config.dadianUrl + '/api/point/task/activeReport',
+          { frontUrl: frontUrl, postParam: postParamStr },
+          header
+        )
+      }
+    }
+
+    // SDK 事件入队（始终走）
+    tracker.track('custom', {
+      eventName: frontUrl || 'manual',
+      frontUrl: frontUrl,
+      postParam: postParamStr,
+      elementId: frontUrl,
+    })
+
+    // 项目定制：从 footer 导航类 frontUrl 中提取目标路由，
+    // 在 track() 之后更新 referrer 链（确保目标页事件能拿到正确来源页）
+    // 必须在 track 之后：否则当前事件的 referrer 会被提前污染
+    var rules = config.projectRules
+    if (rules && typeof rules.extractNavTarget === 'function') {
+      var navTarget = rules.extractNavTarget(null, frontUrl)
+      if (navTarget) {
+        tracker.updatePageRoute(navTarget)
+      }
+    }
+  }
+
+  // 3. 注册 $tracker 实例引用（含 resetSession 供登出时调用）
+  Vue.prototype.$tracker = tracker
+  Vue.prototype.$trackerResetSession = function () {
+    tracker.getSession().resetSession()
+    tracker.getQueue()._flushedEventIds.clear()
+  }
+
+  // 3.1 动态参数解析器快捷方式
+  Vue.prototype.$registerParam = function (name, fn) {
+    tracker.registerParam(name, fn)
+  }
+
+  // 4. 注册 v-impression 指令（兼容旧业务代码）
+  var adapter = tracker.getAdapter()
+  if (adapter.supportsIntersectionObserver()) {
+    Vue.directive('impression', createImpressionDirective(tracker))
+  }
+
+  // 5. 注册 v-track-exposure 指令（新的曝光指令，走自动采集链路）
+  var exposurePlugin = tracker.plugins.find(function (p) {
+    return p.name === 'exposure'
+  })
+  if (exposurePlugin && typeof exposurePlugin.createDirective === 'function') {
+    var trackExposureDirective = exposurePlugin.createDirective()
+    if (trackExposureDirective) {
+      Vue.directive('track-exposure', trackExposureDirective)
+    }
+  }
+
+  // 6. 注册页面停留 mixin
+  var hasPageStayPlugin = (options.plugins || []).some(function (p) {
+    return p === 'page-stay' || (p && p.name === 'page-stay')
+  })
+  if (hasPageStayPlugin) {
+    Vue.mixin(createPageStayMixin(tracker))
+  }
+
+  // 7. 注册 Vue 错误捕获（组件 render/lifecycle/watch 中的异常）
+  var jsErrorPlugin = tracker.plugins.find(function (p) {
+    return p.name === 'js-error'
+  })
+  if (jsErrorPlugin) {
+    var _prevErrorHandler = Vue.config.errorHandler
+    Vue.config.errorHandler = function (err, vm, info) {
+      jsErrorPlugin.handleVueError(err, vm, info)
+      if (_prevErrorHandler) _prevErrorHandler.call(this, err, vm, info)
+    }
+  }
+
+  // [PROJECT-ADAPT] 小程序生命周期注册
+  // H5 端通过 history API 监听路由变化，小程序端通过 onShow/onHide
+  if (tracker.getConfig().platform === 'weapp') {
+    var pageViewPlugin = tracker.plugins.find(function (p) {
+      return p.name === 'page-view'
+    })
+    var lifecyclePlugin = tracker.plugins.find(function (p) {
+      return p.name === 'app-lifecycle'
+    })
+
+    Vue.mixin({
+      onShow: function () {
+        if (pageViewPlugin) {
+          pageViewPlugin.trackPageShow()
+        }
+        if (lifecyclePlugin) {
+          lifecyclePlugin.trackAppShow()
+        }
+      },
+      onHide: function () {
+        if (lifecyclePlugin) {
+          lifecyclePlugin.trackAppHide()
+        }
+      },
+    })
+  }
+}
+
+// 默认导出 Vue 插件对象
+export default {
+  install: install,
+  createTracker: createTracker,
+  getTracker: getTracker,
+}
+
+// 具名导出
+export { Tracker } from './core/tracker.js'
+export { WebAdapter } from './platforms/web.js'
+export { WeappAdapter } from './platforms/weapp.js'
+export { AppAdapter } from './platforms/app.js'

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@rk911/tracker-sdk",
+  "version": "1.6.4",
+  "description": "人康多端埋点 SDK — 自动化采集 + 手动埋点兼容",
+  "main": "index.js",
+  "module": "index.js",
+  "files": [
+    "index.js",
+    "core/",
+    "platforms/",
+    "plugins/",
+    "customize/"
+  ],
+  "keywords": ["tracker", "analytics", "uni-app", "埋点"],
+  "author": "rk-team",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}

package/platforms/app.js

@@ -0,0 +1,36 @@
+import { WebAdapter } from './web.js'
+
+export class AppAdapter extends WebAdapter {
+  constructor(config) {
+    super(config)
+  }
+
+  getPlatformName() {
+    return 'app'
+  }
+
+  getToken() {
+    // APP WebView 内优先从 JSBridge 取 token，降级走 storage
+    try {
+      if (typeof window !== 'undefined' && window.NativeBridge && window.NativeBridge.getToken) {
+        const nativeToken = window.NativeBridge.getToken()
+        if (nativeToken) return nativeToken
+      }
+    } catch (e) {}
+    return this.getStorage(this.config.tokenKey || 'token')
+  }
+
+  getDeviceInfo() {
+    const baseInfo = super.getDeviceInfo()
+    // 尝试从 JSBridge 获取更多原生设备信息
+    try {
+      if (typeof window !== 'undefined' && window.NativeBridge && window.NativeBridge.getDeviceInfo) {
+        const nativeInfo = window.NativeBridge.getDeviceInfo()
+        if (nativeInfo) {
+          return { ...baseInfo, ...nativeInfo }
+        }
+      }
+    } catch (e) {}
+    return baseInfo
+  }
+}

package/platforms/weapp.js

@@ -0,0 +1,218 @@
+export class WeappAdapter {
+  constructor(config) {
+    this.config = config
+    this._sessionStore = new Map()
+    this._listeners = []
+  }
+
+  getPlatformName() {
+    return 'weapp'
+  }
+
+  // ---- 存储 ----
+
+  getStorage(key) {
+    try {
+      return uni.getStorageSync(key)
+    } catch (e) {
+      return null
+    }
+  }
+
+  setStorage(key, value) {
+    try {
+      uni.setStorageSync(key, value)
+    } catch (e) {}
+  }
+
+  removeStorage(key) {
+    try {
+      uni.removeStorageSync(key)
+    } catch (e) {}
+  }
+
+  // 小程序没有 sessionStorage，用内存 Map 模拟
+  getSessionStorage(key) {
+    return this._sessionStore.get(key) || null
+  }
+
+  setSessionStorage(key, value) {
+    this._sessionStore.set(key, value)
+  }
+
+  removeSessionStorage(key) {
+    this._sessionStore.delete(key)
+  }
+
+  // ---- 页面信息 ----
+
+  getCurrentPageRoute() {
+    try {
+      const pages = getCurrentPages()
+      if (pages.length > 0) {
+        return pages[pages.length - 1].route || ''
+      }
+    } catch (e) {}
+    return ''
+  }
+
+  getCurrentPagePath() {
+    return '/' + this.getCurrentPageRoute()
+  }
+
+  getToken() {
+    return this.getStorage(this.config.tokenKey || 'tokenV2')
+  }
+
+  // ---- 网络 ----
+
+  request(options) {
+    return new Promise((resolve, reject) => {
+      uni.request({
+        ...options,
+        success: (res) => resolve(res),
+        fail: (err) => reject(err),
+      })
+    })
+  }
+
+  sendBeacon(url, data) {
+    // 小程序没有 sendBeacon，降级为普通请求
+    try {
+      uni.request({
+        method: 'POST',
+        url: url,
+        data: data,
+        header: { 'content-type': 'application/json' },
+      })
+    } catch (e) {}
+    return true
+  }
+
+  // ---- 设备信息 ----
+
+  getDeviceInfo() {
+    try {
+      const info = uni.getSystemInfoSync()
+      return {
+        brand: info.brand || '',
+        model: info.model || '',
+        platform: info.platform || '',
+        system: info.system || '',
+        screenWidth: info.screenWidth || 0,
+        screenHeight: info.screenHeight || 0,
+        userAgent: '',
+      }
+    } catch (e) {
+      return {}
+    }
+  }
+
+  // ---- 生命周期事件（小程序通过 mixin/hook 在外部处理）----
+
+  onPageShow(callback) {
+    // 小程序的页面生命周期通过 Vue mixin 处理，这里仅作标记
+    this._onPageShowCallback = callback
+  }
+
+  onPageHide(callback) {
+    this._onPageHideCallback = callback
+  }
+
+  onPageClose(callback) {
+    this._onPageCloseCallback = callback
+  }
+
+  // ---- DOM 能力（小程序不支持）----
+
+  supportsDOM() {
+    return false
+  }
+
+  supportsIntersectionObserver() {
+    return false
+  }
+
+  addClickListener() {}
+  removeClickListener() {}
+
+  addErrorListener(handler) {
+    // 小程序全局错误监听
+    try {
+      if (typeof uni !== 'undefined' && uni.onError) {
+        uni.onError(handler)
+        this._listeners.push({ type: 'uniError', handler })
+      }
+    } catch (e) {}
+  }
+
+  addUnhandledRejectionListener(handler) {
+    try {
+      if (typeof uni !== 'undefined' && uni.onUnhandledRejection) {
+        uni.onUnhandledRejection(handler)
+        this._listeners.push({ type: 'uniRejection', handler })
+      }
+    } catch (e) {}
+  }
+
+  // ---- 网络状态 ----
+
+  getNetworkType() {
+    try {
+      var res = uni.getNetworkType && uni.getNetworkType({ success: function () {} })
+      // 同步方式获取不到，返回 null 由异步补充
+    } catch (e) {}
+    return this._networkType || null
+  }
+
+  initNetworkListener() {
+    var self = this
+    try {
+      uni.getNetworkType({
+        success: function (res) {
+          self._networkType = res.networkType || 'unknown'
+        },
+      })
+      uni.onNetworkStatusChange(function (res) {
+        self._networkType = res.networkType || 'unknown'
+      })
+    } catch (e) {}
+  }
+
+  // ---- 路由监听（小程序通过 mixin 处理）----
+
+  onRouteChange(callback) {
+    this._onRouteChangeCallback = callback
+  }
+
+  // ---- 工具 ----
+
+  generateId(prefix) {
+    return (
+      (prefix || '') +
+      '_' +
+      Date.now() +
+      '_' +
+      Math.random().toString(36).substr(2, 9)
+    )
+  }
+
+  getTimestamp() {
+    return Date.now()
+  }
+
+  getXPath() {
+    return ''
+  }
+
+  findTrackableElement(el) {
+    return el
+  }
+
+  // ---- 清理 ----
+
+  destroy() {
+    this._sessionStore.clear()
+    this._listeners = []
+  }
+}