@kbapp/media-fusion-tracker 0.0.1

package/README.MD

@@ -0,0 +1,225 @@
+# 开吧融媒体上报平台
+
+> ⚠️ 重要提示：本 SDK 基于 TypeScript 开发，所有 API 参数均带有明确的必填 / 选填类型标注。使用时请务必开启 TS 类型检查或在 IDE 中查看参数提示，必填项缺失会直接提示错误，选填项可按需传入，请勿忽略类型提示以避免使用异常。
+
+## 功能特点
+
+- 融合开吧（Gsido）和天目云双平台埋点上报能力
+- 异步加载核心上报SDK，避免包体积过大
+- 支持全局公共属性设置
+- 内置标准稿件事件模型（浏览事件、动作事件）
+- 完全TypeScript支持，提供完整的类型定义
+
+## 安装方式 1：npm
+
+```bash
+npm install @kbapp/media-fusion-tracker
+```
+
+```typescript
+import { MediaFusionTracker } from '@kbapp/media-fusion-tracker';
+
+// 创建埋点实例
+const kbTracker = new MediaFusionTracker({
+  sdkUrl: 'https://page.kaiba315.com.cn/js/gsido-h5-min-1.0.7.1_final.js',
+  appid: '由开吧分配',
+  enableLog: false, // 开发环境可设为 true，开启埋点日志输出
+});
+```
+
+## 安装方式 2：通过 script 标签引入
+
+请先引入 JS Bridge：`<script src="https://unpkg.com/@kbapp/js-bridge@latest/dist/umd/index.js"></script>`，再引入本 SDK。
+
+使用 unpkg CDN：
+
+```html
+<script src="https://unpkg.com/@kbapp/media-fusion-tracker@latest/dist/umd/index.js"></script>
+```
+
+使用 jsdelivr CDN：
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@kbapp/media-fusion-tracker@latest/dist/umd/index.js"></script>
+```
+
+> 通过 script 标签引入后，SDK 将作为全局变量 `kbMediaFusionTracker` 挂载在 window 对象上
+
+```html
+<script src="https://unpkg.com/@kbapp/js-bridge@latest/dist/umd/index.js"></script>
+<script src="https://unpkg.com/@kbapp/media-fusion-tracker@latest/dist/umd/index.js"></script>
+
+<script>
+// 通过全局变量kbMediaFusionTracker创建埋点实例
+const kbTracker = new kbMediaFusionTracker.MediaFusionTracker({
+  sdkUrl: 'https://page.kaiba315.com.cn/js/gsido-h5-min-1.0.7.1_final.js',
+  appid: '由开吧分配',
+  enableLog: false,
+});
+</script>
+```
+
+## 基本使用
+
+### 如何设置全局公共属性
+
+设置全局公共属性后，所有上报的埋点将自动携带这些属性。
+
+```typescript
+kbTracker.setReportGlobalAttrs({
+  userId: '123456',      // 用户唯一标识
+  platform: 'h5',        // 平台类型（h5/ios/android）
+  appVersion: '1.0.0',   // APP版本号
+});
+
+// 支持多次调用，属性将合并
+kbTracker.setReportGlobalAttrs({
+  channel: 'official',
+});
+```
+
+### 如何上报稿件浏览事件
+
+同时上报到开吧(gsido)和天目云两个平台。
+
+```typescript
+kbTracker.reportDocVisit({
+  biz: 'MISC_PAGE',           // 业务类型（必填）
+  title: '稿件标题',           // 稿件标题（必填）
+  pubTime: '2024-01-01 12:00:00', // 发布时间（必填）
+  unit: '业务单元',            // 业务单元（选填）
+  ref1: '对象标识1',           // 对象标识1（选填）
+  channel: '所属单位',         // 所属单位（选填）
+  depart: '所属部门',          // 所属部门（选填）
+});
+```
+
+### 如何上报稿件动作事件
+
+上报到开吧(gsido)平台，记录用户对稿件的操作（如点赞、评论、分享等）。
+
+```typescript
+kbTracker.reportDocAction({
+  act: 'click',               // 动作标识（必填）
+  biz: 'MISC_PAGE',           // 业务类型（必填）
+  title: '稿件标题',           // 稿件标题（必填）
+  unit: '业务单元',            // 业务单元（选填）
+  ref1: '对象标识1',           // 对象标识1（选填）
+});
+```
+
+**标准动作标识参考：**
+
+| 动作 | 标识 |
+|------|------|
+| 点赞 | `like` |
+| 分享 | `share` |
+| 评论 | `reply` |
+| 评论的评论 | `reply_r` |
+| 评论的点赞 | `reply_l` |
+| 投票 | `vote` |
+| 签到 | `sign` |
+| 购买 | `buy` |
+| 打赏 | `reward` |
+
+## API 参考
+
+### MediaFusionTracker 类
+
+#### 构造函数
+
+```typescript
+constructor(params: {
+  sdkUrl: string;    // 开吧(gsido)SDK地址
+  appid: string;     // 埋点应用ID，由开吧分配
+  enableLog?: boolean; // 是否开启日志，默认不开启
+})
+```
+
+#### 属性
+
+##### tmuyunTracker
+
+天目云埋点实例，可直接调用天目云 SDK 的更多方法。
+
+```typescript
+kbTracker.tmuyunTracker.report({
+  docId: 'xxx',
+  title: '标题',
+  pubTime: Date.now(),
+});
+```
+
+##### gsidoTracker
+
+开吧(gsido)埋点实例，可直接调用开吧(gsido) SDK 的更多方法。
+
+```typescript
+kbTracker.gsidoTracker.report({
+  name: 'custom_event',
+  params: { key: 'value' },
+});
+```
+
+#### 方法
+
+##### setReportGlobalAttrs
+
+设置全局公共属性，将附加到所有上报事件中。
+
+```typescript
+setReportGlobalAttrs(attrs: Record<string, any>): void
+```
+
+##### reportDocVisit
+
+上报稿件浏览事件，同时上报到开吧(gsido)和天目云平台。
+
+```typescript
+reportDocVisit(params: {
+  biz: string;           // 业务类型（必填）
+  title: string;         // 稿件标题（必填）
+  pubTime: string | number; // 发布时间（必填）YYYY-MM-DD HH:mm:ss
+  unit?: string;         // 业务单元
+  ref1?: string;         // 对象标识1
+  ref2?: string;         // 对象标识2
+  ref3?: string;         // 对象标识3
+  sid?: number;          // 站点ID
+  channel?: string;      // 所属单位
+  depart?: string;       // 所属部门
+  modules?: string[];    // 所属统计模块
+  suid?: string;         // 分享人用户ID
+  referer?: string;      // 访问来源
+}): void
+```
+
+##### reportDocAction
+
+上报稿件动作事件，上报到开吧(gsido)平台。
+
+```typescript
+reportDocAction(params: {
+  act: string;           // 动作标识（必填）
+  biz: string;           // 业务类型（必填）
+  title: string;         // 稿件标题（必填）
+  unit?: string;         // 业务单元
+  ref1?: string;         // 对象标识1
+  ref2?: string;         // 对象标识2
+  ref3?: string;         // 对象标识3
+  sid?: number;          // 站点ID
+  channel?: string;      // 所属单位
+  depart?: string;       // 所属部门
+  modules?: string[];    // 所属统计模块
+}): void
+```
+
+## 最佳实践
+
+1. **全局唯一实例**：建议在应用入口处创建一个全局唯一的 MediaFusionTracker 实例
+2. **合理使用全局属性**：将通用信息（如用户ID、平台等）设置为全局属性
+3. **开发环境开启调试**：在开发环境设置 `enableLog: true` 以查看埋点日志
+
+## 注意事项
+
+1. `sdkUrl` 和 `appid` 是必需参数，需要正确配置
+2. `reportDocAction` 中的 `act` 字段有标准值，语义相同时应复用（如点赞使用 `like`）

package/dist/es/helpers/filter-undefined-properties.js

@@ -0,0 +1,12 @@
+function i(r) {
+  if (typeof r != "object" || r === null || Array.isArray(r))
+    return {};
+  const e = {};
+  return Object.keys(r).forEach((t) => {
+    const n = r[t];
+    n !== void 0 && (e[t] = n);
+  }), e;
+}
+export {
+  i as filterUndefinedProperties
+};

package/dist/es/index.js

@@ -0,0 +1,8 @@
+import { MediaFusionTracker as e } from "./media-fusion-tracker.js";
+import { DocActionEvent as i } from "./models/DocActionEvent.js";
+import { DocVisitEvent as n } from "./models/DocVisitEvent.js";
+export {
+  i as DocActionEvent,
+  n as DocVisitEvent,
+  e as MediaFusionTracker
+};

package/dist/es/media-fusion-tracker.js

@@ -0,0 +1,35 @@
+import { TmuyunTracker as o } from "./node_modules/@kbapp/tmuyun-tracker/dist/es/index.js";
+import { GsidoTracker as i } from "./node_modules/@kbapp/gsido-tracker/dist/es/gsido-tracker.js";
+import { DocActionEvent as c } from "./node_modules/@kbapp/gsido-tracker/dist/es/models/DocActionEvent.js";
+import { DocVisitEvent as s } from "./node_modules/@kbapp/gsido-tracker/dist/es/models/DocVisitEvent.js";
+class m {
+  constructor(e) {
+    this.setReportGlobalAttrs = (t = {}) => {
+      this.gsidoTracker.setReportGlobalAttrs(t);
+    }, this.report = (t) => {
+      this.gsidoTracker.report(t), t.name === "DocVisitEvent" && this.tmuyunTracker.report({
+        docId: t.params.docId,
+        title: t.params.title,
+        pubTime: t.params.pubTime
+      });
+    }, this.reportDocVisit = (t) => {
+      const r = s.createDocTrackEvent(t);
+      this.gsidoTracker.report({
+        name: "DocVisitEvent",
+        params: r
+      }), this.tmuyunTracker.report({
+        docId: r.docId,
+        title: r.title,
+        pubTime: t.pubTime
+      });
+    }, this.reportDocAction = (t) => {
+      this.gsidoTracker.report({
+        name: "DocActionEvent",
+        params: c.createDocTrackEvent(t)
+      });
+    }, this.gsidoTracker = new i({ enableLog: e.enableLog, sdkUrl: e.sdkUrl, appid: e.appid }), this.tmuyunTracker = new o({ enableLog: e.enableLog });
+  }
+}
+export {
+  m as MediaFusionTracker
+};

package/dist/es/models/DocActionEvent.js

@@ -0,0 +1,27 @@
+import { filterUndefinedProperties as r } from "../helpers/filter-undefined-properties.js";
+class t {
+  constructor(e) {
+    this.act = e.act, this.biz = e.biz, this.unit = e.unit, this.ref1 = e.ref1, this.ref2 = e.ref2, this.ref3 = e.ref3, this.sid = e.sid, this.title = e.title, this.channel = e.channel, this.depart = e.depart, this.modules = e.modules, Object.defineProperty(this, "docId", {
+      enumerable: !0,
+      configurable: !1,
+      get: () => t.generateDocId(this)
+    });
+  }
+  /**
+   *
+   * @description 生成稿件标识
+   */
+  static generateDocId(e) {
+    return [e.biz, e.unit, e.ref1, e.ref2, e.ref3, e.sid].filter((i) => !!i).join("-");
+  }
+  /**
+   *
+   * @description 生成稿件数据(自动生成docId)
+   */
+  static createDocTrackEvent(e) {
+    return r(new t(e));
+  }
+}
+export {
+  t as DocActionEvent
+};

package/dist/es/models/DocVisitEvent.js

@@ -0,0 +1,27 @@
+import { filterUndefinedProperties as r } from "../helpers/filter-undefined-properties.js";
+class t {
+  constructor(e) {
+    this.referer = e.referer, this.suid = e.suid, this.biz = e.biz, this.unit = e.unit, this.ref1 = e.ref1, this.ref2 = e.ref2, this.ref3 = e.ref3, this.sid = e.sid, this.title = e.title, this.channel = e.channel, this.depart = e.depart, this.modules = e.modules, this.pubTime = e.pubTime, Object.defineProperty(this, "docId", {
+      enumerable: !0,
+      configurable: !1,
+      get: () => t.generateDocId(this)
+    });
+  }
+  /**
+   *
+   * @description 生成稿件标识
+   */
+  static generateDocId(e) {
+    return [e.biz, e.unit, e.ref1, e.ref2, e.ref3, e.sid].filter((i) => !!i).join("-");
+  }
+  /**
+   *
+   * @description 生成稿件数据(自动生成docId)
+   */
+  static createDocTrackEvent(e) {
+    return r(new t(e));
+  }
+}
+export {
+  t as DocVisitEvent
+};

package/dist/es/node_modules/@kbapp/gsido-tracker/dist/es/_virtual/_commonjsHelpers.js

@@ -0,0 +1,8 @@
+var e = typeof globalThis != "undefined" ? globalThis : typeof window != "undefined" ? window : typeof global != "undefined" ? global : typeof self != "undefined" ? self : {};
+function l(o) {
+  return o && o.__esModule && Object.prototype.hasOwnProperty.call(o, "default") ? o.default : o;
+}
+export {
+  e as commonjsGlobal,
+  l as getDefaultExportFromCjs
+};

package/dist/es/node_modules/@kbapp/gsido-tracker/dist/es/_virtual/index.js

@@ -0,0 +1,7 @@
+import { getDefaultExportFromCjs as r } from "./_commonjsHelpers.js";
+import { __require as o } from "../node_modules/lodash.clonedeep/index.js";
+var t = o();
+const m = /* @__PURE__ */ r(t);
+export {
+  m as default
+};

package/dist/es/node_modules/@kbapp/gsido-tracker/dist/es/_virtual/index2.js

@@ -0,0 +1,4 @@
+var e = { exports: {} };
+export {
+  e as __module
+};

package/dist/es/node_modules/@kbapp/gsido-tracker/dist/es/gsido-tracker.js

@@ -0,0 +1,86 @@
+import { IS_KB_APP_ENV as r, reportDAEvent as o } from "@kbapp/js-bridge";
+import { objectToMap as n } from "./helpers/object-to-map.js";
+import { GsidoProxy as i } from "./lib/gsido-proxy.js";
+import g from "./_virtual/index.js";
+class b {
+  constructor(t) {
+    this.globalAttrs = [], this.enableLog = t.enableLog || !1, this.debugger = t.debugger || !1, this.gsidoProxy = new i({ sdkURL: t.sdkUrl, gsAppid: t.appid }), this.gsidoProxy.init(), this.gsidoProxy.setDebugEnable(this.debugger);
+  }
+  /** 打印日志 */
+  log(...t) {
+    this.enableLog && console.log(...t);
+  }
+  /**
+   *
+   * @description 获取用于上报的属性 (合并公共属性)
+   */
+  getReportDataMergeGlobalAttrs(t) {
+    const a = {}, e = g(Object.assign.apply(null, [{}, ...this.globalAttrs, t]));
+    return Object.keys(e).forEach((s) => {
+      if (typeof e[s] == "number")
+        return a[s] = e[s];
+      e[s] && (a[s] = String(e[s]));
+    }), a;
+  }
+  /**
+   *
+   * @description 获取原始 GsIdo 对象
+   */
+  getGsido() {
+    return this.gsidoProxy.getGsido();
+  }
+  /**
+   *
+   * @description 设置上报的公共属性
+   */
+  setReportGlobalAttrs(t = {}) {
+    this.globalAttrs.push(t);
+  }
+  /**
+   *
+   * @description 上报事件
+   */
+  report(t) {
+    return r ? ((a, e) => {
+      this.log("[个推] app.桥接.埋点", { name: a, params: e }), o({
+        eventName: a,
+        eventParams: e
+      });
+    })(t.name, this.getReportDataMergeGlobalAttrs(t.params)) : ((a, e) => {
+      this.log("[个推] js.埋点", { name: a, params: e }), this.gsidoProxy.onEvent({ id: a, attrs: n(e) });
+    })(t.name, this.getReportDataMergeGlobalAttrs(t.params));
+  }
+  /**
+   *
+   * @description 持续类型事件上报 - 开始事件
+   */
+  reportBeginEvent(t) {
+    return r ? ((a, e) => {
+      this.log("[个推] app.桥接.begin埋点", { name: a, params: e }), o({
+        eventName: a,
+        eventParams: e,
+        eventType: "Begin"
+      });
+    })(t.name, this.getReportDataMergeGlobalAttrs(t.params)) : ((a, e) => {
+      this.log("[个推] js.begin埋点", { name: a, params: e }), this.gsidoProxy.onBeginEvent({ id: a, attrs: n(e) });
+    })(t.name, this.getReportDataMergeGlobalAttrs(t.params));
+  }
+  /**
+   *
+   * @description 持续类型事件上报 - 结束事件
+   */
+  reportEndEvent(t) {
+    return r ? ((a, e) => {
+      this.log("[个推] app.桥接.end埋点", { name: a, params: e }), o({
+        eventName: a,
+        eventParams: e,
+        eventType: "End"
+      });
+    })(t.name, this.getReportDataMergeGlobalAttrs(t.params)) : ((a, e) => {
+      this.log("[个推] js.end埋点", { name: a, params: e }), this.gsidoProxy.onEndEvent({ id: a, attrs: n(e) });
+    })(t.name, this.getReportDataMergeGlobalAttrs(t.params));
+  }
+}
+export {
+  b as GsidoTracker
+};

package/dist/es/node_modules/@kbapp/gsido-tracker/dist/es/helpers/filter-undefined-properties.js

@@ -0,0 +1,12 @@
+function r(e) {
+  if (typeof e != "object" || e === null || Array.isArray(e))
+    return {};
+  const n = {};
+  return Object.keys(e).forEach((t) => {
+    const o = e[t];
+    o !== void 0 && (n[t] = o);
+  }), n;
+}
+export {
+  r as filterUndefinedProperties
+};

package/dist/es/node_modules/@kbapp/gsido-tracker/dist/es/helpers/load-script.js

@@ -0,0 +1,11 @@
+const r = (o) => window[o.key] ? window[o.key] : new Promise((t, d) => {
+  const e = window.document.createElement("script");
+  e.setAttribute("src", o.src), e.async = !0, e.onload = () => {
+    t(window[o.key]);
+  }, e.onerror = (n) => {
+    d(n);
+  }, window.document.head.appendChild(e);
+});
+export {
+  r as loadScript
+};

package/dist/es/node_modules/@kbapp/gsido-tracker/dist/es/helpers/object-to-map.js

@@ -0,0 +1,9 @@
+function o(e) {
+  const c = [];
+  return Object.keys(e).forEach((n) => {
+    c.push([n, e[n]]);
+  }), new Map(c);
+}
+export {
+  o as objectToMap
+};

package/dist/es/node_modules/@kbapp/gsido-tracker/dist/es/lib/gsido-proxy.js

@@ -0,0 +1,79 @@
+import { loadScript as a } from "../helpers/load-script.js";
+var u = (l, t, n) => new Promise((d, o) => {
+  var r = (e) => {
+    try {
+      i(n.next(e));
+    } catch (c) {
+      o(c);
+    }
+  }, s = (e) => {
+    try {
+      i(n.throw(e));
+    } catch (c) {
+      o(c);
+    }
+  }, i = (e) => e.done ? d(e.value) : Promise.resolve(e.value).then(r, s);
+  i((n = n.apply(l, t)).next());
+});
+const h = (l) => {
+  let t;
+  const n = l.sdkURL, d = l.gsAppid;
+  function o() {
+    return u(this, null, function* () {
+      return n ? t || (t = new Promise((r, s) => u(null, null, function* () {
+        try {
+          yield a({ src: n, key: "GsIdo" }), r(window.GsIdo);
+        } catch (i) {
+          t = void 0, s(i);
+        }
+      }))) : Promise.reject(new Error("GsIdo SDK 地址未配置，请先在构造函数中传入 sdkURL"));
+    });
+  }
+  return {
+    load: o,
+    init: /* @__PURE__ */ (() => {
+      let r;
+      return () => r || (r = new Promise((s, i) => u(null, null, function* () {
+        try {
+          return yield o(), yield window.GsIdo.init({ gsAppid: d }), s(window.GsIdo);
+        } catch (e) {
+          i(e), r = void 0;
+        }
+      })));
+    })()
+  };
+};
+class v {
+  constructor(t) {
+    this.loader = h(t);
+  }
+  getGsido() {
+    return window.GsIdo;
+  }
+  init() {
+    return this.loader.init();
+  }
+  setDebugEnable(...t) {
+    return this.callMethod("setDebugEnable", ...t);
+  }
+  onEvent(...t) {
+    return this.callMethod("onEvent", ...t);
+  }
+  onBeginEvent(...t) {
+    return this.callMethod("onBeginEvent", ...t);
+  }
+  onEndEvent(...t) {
+    return this.callMethod("onEndEvent", ...t);
+  }
+  callMethod(t, ...n) {
+    return this.loader.init().then((d) => {
+      const o = d[t];
+      if (typeof o != "function")
+        throw new Error(`${String(t)} 不是 GsIdo 的有效方法`);
+      return o(...n);
+    });
+  }
+}
+export {
+  v as GsidoProxy
+};

package/dist/es/node_modules/@kbapp/gsido-tracker/dist/es/models/DocActionEvent.js

@@ -0,0 +1,27 @@
+import { filterUndefinedProperties as r } from "../helpers/filter-undefined-properties.js";
+class i {
+  constructor(t) {
+    this.act = t.act, this.biz = t.biz, this.unit = t.unit, this.ref1 = t.ref1, this.ref2 = t.ref2, this.ref3 = t.ref3, this.sid = t.sid, this.title = t.title, this.channel = t.channel, this.depart = t.depart, this.modules = t.modules, Object.defineProperty(this, "docId", {
+      enumerable: !0,
+      configurable: !1,
+      get: () => i.generateDocId(this)
+    });
+  }
+  /**
+   *
+   * @description 生成稿件标识
+   */
+  static generateDocId(t) {
+    return [t.biz, t.unit, t.ref1, t.ref2, t.ref3, t.sid].filter((e) => !!e).join("-");
+  }
+  /**
+   *
+   * @description 生成稿件数据(自动生成docId)
+   */
+  static createDocTrackEvent(t) {
+    return r(new i(t));
+  }
+}
+export {
+  i as DocActionEvent
+};

package/dist/es/node_modules/@kbapp/gsido-tracker/dist/es/models/DocVisitEvent.js

@@ -0,0 +1,27 @@
+import { filterUndefinedProperties as e } from "../helpers/filter-undefined-properties.js";
+class i {
+  constructor(t) {
+    this.referer = t.referer, this.suid = t.suid, this.biz = t.biz, this.unit = t.unit, this.ref1 = t.ref1, this.ref2 = t.ref2, this.ref3 = t.ref3, this.sid = t.sid, this.title = t.title, this.channel = t.channel, this.depart = t.depart, this.modules = t.modules, Object.defineProperty(this, "docId", {
+      enumerable: !0,
+      configurable: !1,
+      get: () => i.generateDocId(this)
+    });
+  }
+  /**
+   *
+   * @description 生成稿件标识
+   */
+  static generateDocId(t) {
+    return [t.biz, t.unit, t.ref1, t.ref2, t.ref3, t.sid].filter((r) => !!r).join("-");
+  }
+  /**
+   *
+   * @description 生成稿件数据(自动生成docId)
+   */
+  static createDocTrackEvent(t) {
+    return e(new i(t));
+  }
+}
+export {
+  i as DocVisitEvent
+};