npm - @kbapp/media-fusion-tracker - Versions diffs - 0.0.1 - Mend

@kbapp/media-fusion-tracker 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (34) hide show

package/examples/index.html ADDED Viewed

@@ -0,0 +1,241 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>测试demo</title>
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/css/bootstrap.min.css" rel="stylesheet"
+        integrity="sha384-GLhlTQ8iRABdZLl6O3oVMWSktQOp6b7In1Zl3/Jr59b6EGGoI1aFkw7cmDA6j6gD" crossorigin="anonymous" />
+</head>
+<body>
+    <div id="app">
+        <div class="card m-2" v-for="(item, index) in list" :key="index">
+            <h5 class="card-header">
+                <div class="d-flex justify-content-between align-items-center">
+                    <span class="flex-grow-1">{{item.title}}</span>
+                    <template v-if="item.done.status.loading">
+                        <button type="button" class="btn btn-primary" disabled>
+                            <span class="spinner-grow spinner-grow-sm" role="status" aria-hidden="true"></span>
+                        </button>
+                    </template>
+                    <template v-else>
+                        <button type="button" class="btn btn-primary" @click="item.done">{{item.buttonText}}</button>
+                    </template>
+                </div>
+            </h5>
+            <div class="card-body">
+                <template v-if="item.subtitle">
+                    <div class="card-title fw-bold">{{item.subtitle}}</div>
+                </template>
+                <template v-if="item.desc">
+                    <div class="card-text">{{item.desc}}</div>
+                </template>
+                <template v-if="item.done.status.data">
+                    <div class="alert alert-success mt-2" role="alert">{{item.done.status.data}}</div>
+                </template>
+                <template v-if="item.done.status.error">
+                    <div class="alert alert-danger mt-2" role="alert">{{item.done.status.error}}</div>
+                </template>
+            </div>
+        </div>
+    </div>
+</body>
+<script src="https://unpkg.com/vconsole@latest/dist/vconsole.min.js"></script>
+<script>
+    // VConsole 默认会挂载到 `window.VConsole` 上
+    var vConsole = new window.VConsole();
+</script>
+<script type="module">
+    import { createApp, ref, reactive } from 'https://unpkg.com/vue@3/dist/vue.esm-browser.js'
+    import { MediaFusionTracker, DocActionEvent, DocVisitEvent } from '../dist/es/index.js'
+    /**
+     * 装饰器，用于处理done函数的调用
+     * @param {Function} callback - 实际执行的函数
+     * @returns {Function} - 装饰后的函数
+     */
+    const decorateDone = (callback) => {
+        /** 状态 */
+        const status = reactive({
+            /** 请求中 */
+            loading: false,
+            /** 请求完成 */
+            data: null,
+            /** 异常值 */
+            error: null,
+        })
+        async function done() {
+            status.data = null
+            status.error = null
+            status.loading = true
+            try {
+                const data = await Promise.resolve(callback())
+                status.data = data
+            } catch (error) {
+                status.error = error
+                throw error
+            } finally {
+                status.loading = false
+            }
+        }
+        done['status'] = status
+        return done
+    }
+    const kbTracker = new MediaFusionTracker({
+        sdkUrl: 'https://page.kaiba315.com.cn/js/gsido-h5-min-1.0.7.1_final.js', // 个推SDK地址
+        appid: 'xzc9chqi1s5bPYs3SWtPm2', // 埋点应用ID，由开吧分配
+        enableLog: true, // 开发环境可设为true，开启埋点日志输出
+    })
+    const list = reactive([
+        {
+            title: 'report',
+            subtitle: '普通事件上报',
+            buttonText: '执行',
+            desc: `执行结果 上报事件`,
+            done: decorateDone(async () => {
+                kbTracker.report({
+                    name: 'test_event_name',
+                    params: {
+                        test_event_params: '1',
+                    },
+                })
+                return '上报成功'
+            }),
+        },
+        {
+            title: 'report.DocVisitEvent',
+            subtitle: 'DocVisitEvent上报',
+            buttonText: '执行',
+            desc: `执行结果 上报事件`,
+            done: decorateDone(async () => {
+                kbTracker.report({
+                    name: 'DocVisitEvent',
+                    params: DocVisitEvent.createDocTrackEvent({
+                        biz: 'MISC_PAGE',
+                        ref1: 'about',
+                        ref2: 'index',
+                        title: '关于',
+                        suid: '1234',
+                        pubTime: '2024-01-01 12:00:00',
+                    }),
+                })
+                return '上报成功'
+            }),
+        },
+        {
+            title: 'report.DocActionEvent',
+            subtitle: 'DocActionEvent上报',
+            buttonText: '执行',
+            desc: `执行结果 上报事件`,
+            done: decorateDone(async () => {
+                kbTracker.report({
+                    name: 'DocActionEvent',
+                    params: DocActionEvent.createDocTrackEvent({
+                        act: 'click',
+                        biz: 'MISC_PAGE',
+                        ref1: 'about',
+                        ref2: 'index',
+                        title: '关于',
+                        suid: '1234',
+                    }),
+                })
+                return '上报成功'
+            }),
+        },
+        {
+            title: 'setReportGlobalAttrs',
+            subtitle: '设置全局公共上报属性',
+            buttonText: '执行',
+            desc: `执行结果 上报事件`,
+            done: decorateDone(async () => {
+                kbTracker.setReportGlobalAttrs({
+                    userId: '123456', // 用户唯一标识
+                    appVersion: '1.0.0', // APP版本号
+                })
+                return '设置成功'
+            }),
+        },
+        {
+            title: 'report',
+            subtitle: '有好剧上报测试',
+            buttonText: '执行',
+            desc: `执行结果 上报事件`,
+            done: decorateDone(async () => {
+                // 设置公共上报的属性
+                kbTracker.setReportGlobalAttrs({
+                    /**
+                     *
+                     * 用户 id, 有则填,
+                     * 注意!!!:下方填写的uid仅为示例,具体填写请参考说明
+                     */
+                    uid: 5864291,
+                    /**
+                     * 按 http 通用请求中的 kb_os 参数规则填写:
+                    * 微信小程序中打开页面: WXTiny
+                    * 微信页面中打开页面: WX-Web
+                    * 其他载体打开页面: Browser
+                    *
+                    * 注意!!!:下方填写的os仅为示例,具体填写请参考说明
+                    */
+                    os: 'WX-Web',
+                    /**
+                     * 按 http 通用请求中的 kb_ep 参数规则填写:
+                    * 开吧客户端: 16
+                    * 非客户端且非小程序打开 H5 页面: 201
+                    * 有好剧小程序: 921
+                    * 大剧院小程序: 922
+                    *
+                    * 注意!!!:下方填写的ep仅为示例,具体填写请参考说明
+                    */
+                    ep: 921
+                })
+                /** 上报浏览点 */
+                kbTracker.report({
+                    name: 'DocVisitEvent',
+                    params: DocVisitEvent.createDocTrackEvent({
+                        biz: '业务类型',
+                        unit: '业务单元',
+                        ref1: '对象标识1 可为空',
+                        ref2: '对象标识2 可为空',
+                        ref3: '对象标识3 可为空',
+                        sid: '站点 ID 可为空',
+                        title: '稿件标题',
+                        channel: '所属单位 可为空',
+                        depart: '所属部门 可为空',
+                        suid: '分享人的用用户id 可为空'
+                    }),
+                });
+                return '上报成功'
+            }),
+        },
+    ])
+    createApp({
+        setup() {
+            return {
+                list,
+            }
+        },
+    }).mount('#app')
+</script>
+</html>

package/package.json ADDED Viewed

@@ -0,0 +1,47 @@
+{
+    "name": "@kbapp/media-fusion-tracker",
+    "publishConfig": {
+        "access": "public"
+    },
+    "version": "0.0.1",
+    "description": "开吧融媒体上报平台",
+    "main": "./dist/umd/index.js",
+    "module": "./dist/es/index.js",
+    "types": "./dist/types/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/types/index.d.ts",
+            "import": "./dist/es/index.js",
+            "require": "./dist/umd/index.js"
+        },
+        "./package.json": "./package.json"
+    },
+    "author": "along",
+    "files": [
+        "dist",
+        "package.json",
+        "README.md",
+        "examples"
+    ],
+    "scripts": {
+        "dev": "npm run build && vite",
+        "build": "rm -rf ./dist && vite build",
+        "publish": "npm run build && npm publish",
+        "test": "vitest"
+    },
+    "dependencies": {
+        "@kbapp/gsido-tracker": "^0.0.1",
+        "@kbapp/tmuyun-tracker": "^1.0.1-alpha.0",
+        "@types/lodash.clonedeep": "^4.5.9",
+        "lodash.clonedeep": "^4.5.0"
+    },
+    "peerDependencies": {
+        "@kbapp/js-bridge": "^1.0.16-alpha.0"
+    },
+    "devDependencies": {
+        "typescript": "^5.9.3",
+        "vite": "^7.3.0",
+        "vite-plugin-dts": "^4.5.4",
+        "vitest": "^4.1.2"
+    }
+}