npm - @kbapp/data-analysis - Versions diffs - 0.0.1 - Mend

@kbapp/data-analysis 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 (14) hide show

package/README.MD +454 -0
package/dist/data-analysis.d.ts +86 -0
package/dist/helpers/filter-undefined-properties.d.ts +8 -0
package/dist/helpers/load-script.d.ts +10 -0
package/dist/helpers/object-to-map.d.ts +5 -0
package/dist/index.d.ts +3 -0
package/dist/index.es.js +863 -0
package/dist/index.umd.js +1 -0
package/dist/lib/gsido-proxy.d.ts +24 -0
package/dist/models/DocActionEvent.d.ts +85 -0
package/dist/models/DocVisitEvent.d.ts +85 -0
package/examples/index.html +209 -0
package/package.json +30 -0
package/tsconfig.json +19 -0

package/dist/index.umd.js ADDED Viewed

@@ -0,0 +1 @@

package/dist/lib/gsido-proxy.d.ts ADDED Viewed

@@ -0,0 +1,24 @@
+/**
+ * 定义 Gsido 代理对象的类型
+ * 1. 继承 GsIdo 命名空间的所有方法，且所有方法返回值转为 Promise 类型
+ * 2. 新增 SDK 配置方法
+ */
+type GsidoProxyType = {
+    [K in keyof typeof GsIdo]: (typeof GsIdo)[K] extends (...args: infer A) => infer R ? (...args: A) => Promise<Awaited<R>> : never;
+} & {
+    /** 配置 GsIdo SDK 地址（需在调用其他方法前执行） */
+    configureSdk: (config: {
+        sdkURL: string;
+    }) => void;
+    getGsido: () => typeof GsIdo | undefined;
+};
+/**
+ * GsIdo 代理对象：自动加载 SDK + 所有方法 Promise 化
+ * 特性：
+ * 1. 先通过 configureSdk 配置 SDK 地址，再调用其他方法
+ * 2. 所有方法返回 Promise，自动等待 SDK 加载完成后执行
+ * 3. SDK 单例加载，重复调用不重复请求
+ * 4. ES6 模块导出，无全局挂载
+ */
+export declare const GsidoProxy: GsidoProxyType;
+export {};

package/dist/models/DocActionEvent.d.ts ADDED Viewed

@@ -0,0 +1,85 @@
+/**
+ *
+ * @description 稿件动作 开吧意义上的第二类埋点
+ * @example
+ * **示例代码**
+```js
+import { DocActionEvent } from '@kbapp/data-analysis';
+kbTracker.report({
+    name: 'DocActionEvent', // 事件名称
+    params: DocActionEvent.createDocTrackEvent({
+        act: '动作标识',
+        biz: '业务类型',
+        unit: '业务单元',
+        ref1: '对象标识1 可为空',
+        ref2: '对象标识2 可为空',
+        ref3: '对象标识3 可为空',
+        sid: '站点 ID 可为空',
+        title: '稿件标题',
+        channel: '所属单位 可为空',
+        depart: '所属部门 可为空',
+        suid: '分享人的用用户id 可为空'
+    }),
+})
+```
+ */
+export declare class DocActionEvent {
+    /**
+     * 动作标识. 以下为保留关键字, 语义相同的动作请复用如下定义:
+     * 点赞: like
+     * 分享: share
+     * 评论: reply
+     * 评论的评论: reply_r
+     * 评论的点赞: reply_l
+     * 投票: vote
+     * 签到: sign
+     * 购买: buy
+     * 打赏: reward
+     *
+     * 动作语义不符合如上定义时, 请自行定义动作标识.
+     */
+    act: string;
+    /** 业务类型. {@link KbModule}. 非空. */
+    biz: string;
+    /** 业务单元. 用以保持稿件定义的同构性: 同一个业务单元下的 ref 含义和层级结构总是一致的. 可为空. */
+    unit?: string;
+    /** 对象标识1. 非空. */
+    ref1: string;
+    /** 对象标识2. 可为空. */
+    ref2?: string;
+    /** 对象标识3. 可为空. */
+    ref3?: string;
+    /** 站点 ID. 可为空. */
+    sid?: number;
+    /**
+     * 稿件标题. 非空.
+     * 此为冗余字段, 以便在分析平台查询. 考核统计场景下应使用维表.
+     */
+    title: string;
+    /**
+     * 所属单位. 可为空.
+     * 此为冗余字段, 以便在分析平台查询. 考核统计场景下应使用维表.
+     */
+    channel?: string;
+    /**
+     * 所属部门. 部门是单位的下属组织. 可为空.
+     * 此为冗余字段, 以便在分析平台查询. 考核统计场景下应使用维表.
+     */
+    depart?: string;
+    /** 分享人的用用户id, 分享出去的链接自动追加 suid=xxx */
+    suid?: string;
+    /** 稿件标识, 拼接非空字段得到: biz-unit-ref1-ref2-ref3-siteId  */
+    docId: string;
+    constructor(params: Omit<DocActionEvent, 'docId'>);
+    /**
+     *
+     * @description 生成稿件标识
+     */
+    static generateDocId(params: DocActionEvent): string;
+    /**
+     *
+     * @description 生成稿件数据(自动生成docId)
+     */
+    static createDocTrackEvent(params: Omit<DocActionEvent, 'docId'>): Pick<DocActionEvent, "unit" | "channel" | "title" | "docId" | "act" | "biz" | "ref1" | "ref2" | "ref3" | "sid" | "depart" | "suid" | undefined>;
+}

package/dist/models/DocVisitEvent.d.ts ADDED Viewed

@@ -0,0 +1,85 @@
+/**
+ *
+ * @description 稿件浏览 开吧意义上的第一类埋点
+ * @example
+ * **示例代码**
+```js
+import { DocVisitEvent } from '@kbapp/data-analysis';
+kbTracker.report({
+    name: 'DocVisitEvent', // 事件名称
+    params: DocVisitEvent.createDocTrackEvent({
+        biz: '业务类型',
+        unit: '业务单元',
+        ref1: '对象标识1 可为空',
+        ref2: '对象标识2 可为空',
+        ref3: '对象标识3 可为空',
+        sid: '站点 ID 可为空',
+        title: '稿件标题',
+        channel: '所属单位 可为空',
+        depart: '所属部门 可为空',
+        suid: '分享人的用用户id 可为空'
+    }),
+});
+```
+ */
+export declare class DocVisitEvent {
+    /**
+     * 访问来源, {@link Doc#getDocId()} 上级页面的稿件标识. 可为空.
+     */
+    referer?: string;
+    /**
+     * 业务类型. {@link KbModule}. 非空.
+     */
+    biz: string;
+    /**
+     * 业务单元. 用以保持稿件定义的同构性: 同一个业务单元下的 ref 含义和层级结构总是一致的. 可为空.
+     */
+    unit?: string;
+    /**
+     * 对象标识1. 非空.
+     */
+    ref1: string;
+    /**
+     * 对象标识2. 可为空.
+     */
+    ref2?: string;
+    /**
+     * 对象标识3. 可为空.
+     */
+    ref3?: string;
+    /**
+     * 站点 ID. 可为空.
+     */
+    sid?: number;
+    /**
+     * 稿件标题. 非空.
+     * 此为冗余字段, 以便在分析平台查询. 考核统计场景下应使用维表.
+     */
+    title: string;
+    /**
+     * 所属单位. 可为空.
+     * 此为冗余字段, 以便在分析平台查询. 考核统计场景下应使用维表.
+     */
+    channel?: string;
+    /**
+     * 所属部门. 部门是单位的下属组织. 可为空.
+     * 此为冗余字段, 以便在分析平台查询. 考核统计场景下应使用维表.
+     */
+    depart?: string;
+    /** 分享人的用用户id, 分享出去的链接自动追加 suid=xxx */
+    suid?: string;
+    /** 稿件标识, 拼接非空字段得到: biz-unit-ref1-ref2-ref3-siteId, 可通过 createDocTrackEvent 自动生成  */
+    docId: string;
+    constructor(params: Omit<DocVisitEvent, 'docId'>);
+    /**
+     *
+     * @description 生成稿件标识
+     */
+    static generateDocId(params: DocVisitEvent): string;
+    /**
+     *
+     * @description 生成稿件数据(自动生成docId)
+     */
+    static createDocTrackEvent(params: Omit<DocVisitEvent, 'docId'>): Pick<DocVisitEvent, "unit" | "channel" | "title" | "docId" | "biz" | "ref1" | "ref2" | "ref3" | "sid" | "depart" | "suid" | "referer" | undefined>;
+}

package/examples/index.html ADDED Viewed

@@ -0,0 +1,209 @@
+<!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 type="module">
+        import { createApp, ref, reactive } from 'https://unpkg.com/vue@3/dist/vue.esm-browser.js'
+        import { DataAnalysis, DocActionEvent, DocVisitEvent } from '../dist/index.es.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 DataAnalysis({
+            sdkUrl: 'https://page.kaiba315.com.cn/js/gsido-h5-min-1.0.7.1_final.js', // 个推SDK地址
+            appid: 'xzc9chqi1s5bPYs3SWtPm2', // 埋点应用ID，由开吧分配
+            debugger: 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',
+                        }),
+                    })
+                    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: 'reportBeginEvent',
+                subtitle: '上报事件开始',
+                buttonText: '执行',
+                desc: `执行结果 上报事件`,
+                done: decorateDone(async () => {
+                    kbTracker.reportBeginEvent({
+                        name: 'test_event_name',
+                        params: {
+                            test_event_params: '1',
+                        },
+                    })
+                    return '上报成功'
+                }),
+            },
+            {
+                title: 'reportEndEvent',
+                subtitle: '上报事件结束',
+                buttonText: '执行',
+                desc: `执行结果 上报事件`,
+                done: decorateDone(async () => {
+                    kbTracker.reportEndEvent({
+                        name: 'test_event_name',
+                        params: {
+                            test_event_params: '1',
+                        },
+                    })
+                    return '上报成功'
+                }),
+            },
+        ])
+        createApp({
+            setup() {
+                return {
+                    list,
+                }
+            },
+        }).mount('#app')
+    </script>
+</html>

package/package.json ADDED Viewed

@@ -0,0 +1,30 @@
+{
+    "name": "@kbapp/data-analysis",
+    "publishConfig": {
+        "access": "public"
+    },
+    "version": "0.0.1",
+    "description": "开吧app埋点平台",
+    "main": "./dist/index.umd.js",
+    "module": "./dist/index.es.js",
+    "types": "./dist/index.d.ts",
+    "unpkg": "./dist/index.umd.js",
+    "browser": "./dist/index.umd.js",
+    "author": "along",
+    "scripts": {
+        "dev": "npm run build && web-dev-server --root-dir ./ --port 3000 --open /examples/index.html --node-resolve --no-cache",
+        "build": "rm -rf ./dist && vite build && npx tsc --emitDeclarationOnly",
+        "publish": "npm run build && npm publish"
+    },
+    "dependencies": {
+        "@kbapp/market-partner-sdk": "^0.0.4",
+        "@types/lodash.clonedeep": "^4.5.9",
+        "lodash.clonedeep": "^4.5.0"
+    },
+    "devDependencies": {
+        "@vitejs/plugin-react": "^5.1.2",
+        "@web/dev-server": "^0.4.6",
+        "typescript": "^5.9.3",
+        "vite": "^7.3.0"
+    }
+}

package/tsconfig.json ADDED Viewed

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "target": "ES6",
+        "module": "ESNext",
+        "allowJs": true,
+        "strict": true,
+        "outDir": "./dist",
+        "baseUrl": "./",
+        "rootDir": "./src",
+        "declaration": true,
+        "declarationDir": "./dist",
+        "lib": ["esnext", "dom"],
+        "sourceMap": false,
+        "moduleResolution": "Node",
+        "esModuleInterop": true,
+        "resolveJsonModule": true
+    },
+    "include": ["src"]
+}