reporting-lib 0.3.4 → 0.4.1

package/dist/performance/pageStayTimeTracker.d.ts

@@ -0,0 +1,38 @@
+import { PageLeaveMeta } from "../util/pageDuration.js";
+import type { TrackPageStayTimeOptions, HistoryInstance } from "../types/index.js";
+interface PageStayTimeOptions {
+    enabled?: boolean;
+    minDuration?: number;
+    debounceMs?: number;
+    onLeave?: (duration: number, reason: string, meta?: PageLeaveMeta) => void;
+}
+/**
+ * 初始化页面停留时间追踪
+ * @param options 配置选项
+ * @param historyInstance 路由 history 实例（可选）
+ * @param defaultOnLeave 默认的上报回调函数（可选）
+ */
+export declare function initPageStayTimeTracker(options?: PageStayTimeOptions, historyInstance?: HistoryInstance, defaultOnLeave?: (duration: number, reason: string) => void): void;
+export declare function switchPageStayTag(tag: string, reason?: string): void;
+/**
+ * 初始化页面停留时间追踪（带默认上报逻辑）
+ * @param trackOptions 追踪配置选项
+ * @param historyInstance 路由 history 实例（可选）
+ */
+export declare function initPageStayTracking(trackOptions?: TrackPageStayTimeOptions, historyInstance?: HistoryInstance): void;
+/**
+ * 停止页面停留时间追踪
+ */
+export declare function stopPageStayTimeTracker(): void;
+/**
+ * 监听路由变化（仅监听，不做其他操作）
+ * @param callback 路由变化时的回调函数
+ * @param historyInstance 路由 history 实例（可选，如果不传则使用 init 时传入的 history）
+ * @returns 返回取消监听的函数
+ */
+export declare function listenRouteChange(callback: (location: {
+    location: any;
+    action: string;
+}) => void, historyInstance?: HistoryInstance): () => void;
+export {};
+//# sourceMappingURL=pageStayTimeTracker.d.ts.map

package/dist/performance/pageStayTimeTracker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pageStayTimeTracker.d.ts","sourceRoot":"","sources":["../../src/performance/pageStayTimeTracker.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAA4B,MAAM,yBAAyB,CAAC;AAElF,OAAO,KAAK,EAAE,wBAAwB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAMnF,UAAU,mBAAmB;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;CAC5E;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,GAAE,mBAAwB,EACjC,eAAe,CAAC,EAAE,eAAe,EACjC,cAAc,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,QAkD5D;AAED,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,QAE7D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,YAAY,CAAC,EAAE,wBAAwB,EACvC,eAAe,CAAC,EAAE,eAAe,QAelC;AAED;;GAEG;AACH,wBAAgB,uBAAuB,SAStC;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAAE,QAAQ,EAAE,GAAG,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,KAAK,IAAI,EAC/D,eAAe,CAAC,EAAE,eAAe,GAChC,MAAM,IAAI,CAWZ"}

package/dist/performance/pageStayTimeTracker.js

@@ -0,0 +1,103 @@
+import { trackPageStayTime } from "./pageStayTime.js";
+import { buildPageDurationPayload } from "../util/pageDuration.js";
+import { lazyReportCacheSLS as sendReportToSLS } from "../report/reportSLS.js";
+import config from "../config/index.js";
+let pageStayTracker = null;
+let historyUnlisten = null;
+/**
+ * 初始化页面停留时间追踪
+ * @param options 配置选项
+ * @param historyInstance 路由 history 实例（可选）
+ * @param defaultOnLeave 默认的上报回调函数（可选）
+ */
+export function initPageStayTimeTracker(options = {}, historyInstance, defaultOnLeave) {
+    const { enabled, minDuration, debounceMs, onLeave } = options;
+    if (enabled) {
+        // 如果已经初始化过，先停止之前的追踪
+        if (pageStayTracker) {
+            pageStayTracker.stop();
+            pageStayTracker = null;
+        }
+        // 创建页面停留时间追踪器
+        const finalOnLeave = onLeave ||
+            defaultOnLeave ||
+            ((duration, reason, meta) => {
+            });
+        pageStayTracker = trackPageStayTime(finalOnLeave, {
+            minDuration,
+            debounceMs,
+        });
+        // 如果传入了 history，自动监听路由变化
+        if (historyInstance && historyInstance.listen) {
+            // 如果之前有监听，先取消
+            if (historyUnlisten) {
+                historyUnlisten();
+                historyUnlisten = null;
+            }
+            // 监听路由变化
+            historyUnlisten = historyInstance.listen(({ location, action }) => {
+                // 路由切换时，上报当前页面的停留时间
+                // action: 'PUSH' | 'POP' | 'REPLACE'
+                if (pageStayTracker && (action === 'PUSH' || action === 'REPLACE')) {
+                    pageStayTracker.manualLeave('route-change');
+                }
+            });
+        }
+    }
+    else if (pageStayTracker) {
+        // 如果禁用了，停止追踪
+        pageStayTracker.stop();
+        pageStayTracker = null;
+        if (historyUnlisten) {
+            historyUnlisten();
+            historyUnlisten = null;
+        }
+    }
+}
+export function switchPageStayTag(tag, reason) {
+    pageStayTracker?.switchPageTag(tag, reason);
+}
+/**
+ * 初始化页面停留时间追踪（带默认上报逻辑）
+ * @param trackOptions 追踪配置选项
+ * @param historyInstance 路由 history 实例（可选）
+ */
+export function initPageStayTracking(trackOptions, historyInstance) {
+    if (!trackOptions)
+        return;
+    const defaultOnLeave = (duration, reason, meta) => {
+        const payload = buildPageDurationPayload(duration, reason, meta || { startTime: 0, endTime: 0 }, { formatPageName: trackOptions?.formatPageName });
+        sendReportToSLS('pageDuration', payload);
+    };
+    initPageStayTimeTracker(trackOptions, historyInstance, defaultOnLeave);
+}
+/**
+ * 停止页面停留时间追踪
+ */
+export function stopPageStayTimeTracker() {
+    if (pageStayTracker) {
+        pageStayTracker.stop();
+        pageStayTracker = null;
+    }
+    if (historyUnlisten) {
+        historyUnlisten();
+        historyUnlisten = null;
+    }
+}
+/**
+ * 监听路由变化（仅监听，不做其他操作）
+ * @param callback 路由变化时的回调函数
+ * @param historyInstance 路由 history 实例（可选，如果不传则使用 init 时传入的 history）
+ * @returns 返回取消监听的函数
+ */
+export function listenRouteChange(callback, historyInstance) {
+    // 如果没有传入 history，从 config 中获取
+    const history = historyInstance || config.history;
+    if (!history || !history.listen) {
+        console.warn('[reporting-lib] No history instance available. Please provide history in init() or pass it as parameter.');
+        return () => { };
+    }
+    const unlisten = history.listen(callback);
+    return unlisten;
+}
+//# sourceMappingURL=pageStayTimeTracker.js.map

package/dist/performance/pageStayTimeTracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pageStayTimeTracker.js","sourceRoot":"","sources":["../../src/performance/pageStayTimeTracker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAiB,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AAClF,OAAO,EAAE,kBAAkB,IAAI,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE/E,OAAO,MAAM,MAAM,oBAAoB,CAAC;AAExC,IAAI,eAAe,GAAgD,IAAI,CAAC;AACxE,IAAI,eAAe,GAAwB,IAAI,CAAC;AAShD;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CACrC,UAA+B,EAAE,EACjC,eAAiC,EACjC,cAA2D;IAE3D,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAE9D,IAAI,OAAO,EAAE,CAAC;QACZ,oBAAoB;QACpB,IAAI,eAAe,EAAE,CAAC;YACpB,eAAe,CAAC,IAAI,EAAE,CAAC;YACvB,eAAe,GAAG,IAAI,CAAC;QACzB,CAAC;QAED,cAAc;QACd,MAAM,YAAY,GAChB,OAAO;YACP,cAAc;YACd,CAAC,CAAC,QAAgB,EAAE,MAAc,EAAE,IAAoB,EAAE,EAAE;YAE5D,CAAC,CAAC,CAAC;QAEL,eAAe,GAAG,iBAAiB,CAAC,YAAY,EAAE;YAChD,WAAW;YACX,UAAU;SACX,CAAC,CAAC;QAEH,yBAAyB;QACzB,IAAI,eAAe,IAAI,eAAe,CAAC,MAAM,EAAE,CAAC;YAC9C,cAAc;YACd,IAAI,eAAe,EAAE,CAAC;gBACpB,eAAe,EAAE,CAAC;gBAClB,eAAe,GAAG,IAAI,CAAC;YACzB,CAAC;YAED,SAAS;YACT,eAAe,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE;gBAChE,oBAAoB;gBACpB,qCAAqC;gBACrC,IAAI,eAAe,IAAI,CAAC,MAAM,KAAK,MAAM,IAAI,MAAM,KAAK,SAAS,CAAC,EAAE,CAAC;oBACnE,eAAe,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;gBAC9C,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;SAAM,IAAI,eAAe,EAAE,CAAC;QAC3B,aAAa;QACb,eAAe,CAAC,IAAI,EAAE,CAAC;QACvB,eAAe,GAAG,IAAI,CAAC;QACvB,IAAI,eAAe,EAAE,CAAC;YACpB,eAAe,EAAE,CAAC;YAClB,eAAe,GAAG,IAAI,CAAC;QACzB,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,GAAW,EAAE,MAAe;IAC5D,eAAe,EAAE,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;AAC9C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAClC,YAAuC,EACvC,eAAiC;IAEjC,IAAI,CAAC,YAAY;QAAE,OAAO;IAE1B,MAAM,cAAc,GAAG,CAAC,QAAgB,EAAE,MAAc,EAAE,IAAoB,EAAE,EAAE;QAChF,MAAM,OAAO,GAAG,wBAAwB,CACtC,QAAQ,EACR,MAAM,EACN,IAAI,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,EACpC,EAAE,cAAc,EAAE,YAAY,EAAE,cAAc,EAAE,CACjD,CAAC;QACF,eAAe,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC,CAAC;IAEF,uBAAuB,CAAC,YAAY,EAAE,eAAe,EAAE,cAAc,CAAC,CAAC;AACzE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB;IACrC,IAAI,eAAe,EAAE,CAAC;QACpB,eAAe,CAAC,IAAI,EAAE,CAAC;QACvB,eAAe,GAAG,IAAI,CAAC;IACzB,CAAC;IACD,IAAI,eAAe,EAAE,CAAC;QACpB,eAAe,EAAE,CAAC;QAClB,eAAe,GAAG,IAAI,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAC/B,QAA+D,EAC/D,eAAiC;IAEjC,8BAA8B;IAC9B,MAAM,OAAO,GAAG,eAAe,IAAM,MAAc,CAAC,OAAkC,CAAC;IAEvF,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAChC,OAAO,CAAC,IAAI,CAAC,0GAA0G,CAAC,CAAC;QACzH,OAAO,GAAG,EAAE,GAAE,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC1C,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,34 @@
+import { PageLeaveMeta } from "../util/pageDuration.js";
+export interface TrackPageStayTimeOptions {
+    enabled?: boolean;
+    minDuration?: number;
+    debounceMs?: number;
+    onLeave?: (duration: number, reason: string, meta?: PageLeaveMeta) => void;
+    formatPageName?: (pageName: string, context: {
+        duration: number;
+        reason: string;
+        startTime: number;
+        endTime: number;
+        pagePath?: string;
+        pageTag?: string;
+    }) => string;
+}
+export interface HistoryInstance {
+    listen: (callback: (location: {
+        location: any;
+        action: string;
+    }) => void) => () => void;
+}
+export interface InitOptions {
+    reportUrl?: string;
+    source?: string;
+    version?: string;
+    userId?: string | number;
+    slsProject?: string;
+    slsLogstore?: string;
+    slsEndpoint?: string;
+    trackerAll?: boolean;
+    trackPageStayTime?: TrackPageStayTimeOptions;
+    history?: HistoryInstance;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGxD,MAAM,WAAW,wBAAwB;IACvC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;IAC3E,cAAc,CAAC,EAAE,CACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,KACE,MAAM,CAAC;CACb;AAGD,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAAE,QAAQ,EAAE,GAAG,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,KAAK,MAAM,IAAI,CAAC;CACzF;AAGD,MAAM,WAAW,WAAW;IAE1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,iBAAiB,CAAC,EAAE,wBAAwB,CAAC;IAE7C,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B"}

package/dist/types/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/dist/util/pageDuration.d.ts

@@ -0,0 +1,27 @@
+export type PageLeaveMeta = {
+    startTime: number;
+    endTime: number;
+    pagePath?: string;
+    pageTag?: string;
+};
+type FormatPageName = (pageName: string, context: {
+    duration: number;
+    reason: string;
+    startTime: number;
+    endTime: number;
+    pagePath?: string;
+    pageTag?: string;
+}) => string;
+export interface BuildPayloadOptions {
+    formatPageName?: FormatPageName;
+}
+export interface PageDurationPayload {
+    pageName: string;
+    duration: number;
+    startTime: number;
+    endTime: number;
+}
+export declare const getBasePageName: (fallbackPath?: string) => string;
+export declare const buildPageDurationPayload: (duration: number, reason: string, meta: PageLeaveMeta, options?: BuildPayloadOptions) => PageDurationPayload;
+export {};
+//# sourceMappingURL=pageDuration.d.ts.map

package/dist/util/pageDuration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pageDuration.d.ts","sourceRoot":"","sources":["../../src/util/pageDuration.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,KAAK,cAAc,GAAG,CACpB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE;IACP,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,KACE,MAAM,CAAC;AAEZ,MAAM,WAAW,mBAAmB;IAClC,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,eAAO,MAAM,eAAe,GAAI,eAAe,MAAM,WAQpD,CAAC;AAEF,eAAO,MAAM,wBAAwB,GACnC,UAAU,MAAM,EAChB,QAAQ,MAAM,EACd,MAAM,aAAa,EACnB,UAAS,mBAAwB,KAChC,mBAgBF,CAAC"}

package/dist/util/pageDuration.js

@@ -0,0 +1,27 @@
+export const getBasePageName = (fallbackPath) => {
+    try {
+        if (fallbackPath)
+            return fallbackPath || "/";
+        const { pathname = "/" } = window.location || {};
+        return pathname || "/";
+    }
+    catch {
+        return "/";
+    }
+};
+export const buildPageDurationPayload = (duration, reason, meta, options = {}) => {
+    const { startTime, endTime, pagePath, pageTag } = meta;
+    const basePageName = getBasePageName(pagePath);
+    const decoratedName = pageTag ? `${basePageName}#${pageTag}` : basePageName;
+    const { formatPageName } = options;
+    const pageName = typeof formatPageName === "function"
+        ? formatPageName(decoratedName, { duration, reason, ...meta })
+        : decoratedName;
+    return {
+        pageName,
+        duration,
+        startTime,
+        endTime,
+    };
+};
+//# sourceMappingURL=pageDuration.js.map

package/dist/util/pageDuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pageDuration.js","sourceRoot":"","sources":["../../src/util/pageDuration.ts"],"names":[],"mappings":"AA8BA,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,YAAqB,EAAE,EAAE;IACvD,IAAI,CAAC;QACH,IAAI,YAAY;YAAE,OAAO,YAAY,IAAI,GAAG,CAAC;QAC7C,MAAM,EAAE,QAAQ,GAAG,GAAG,EAAE,GAAG,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC;QACjD,OAAO,QAAQ,IAAI,GAAG,CAAC;IACzB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,GAAG,CAAC;IACb,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,QAAgB,EAChB,MAAc,EACd,IAAmB,EACnB,UAA+B,EAAE,EACZ,EAAE;IACvB,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IACvD,MAAM,YAAY,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;IAC/C,MAAM,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,YAAY,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC;IAC5E,MAAM,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;IACnC,MAAM,QAAQ,GACZ,OAAO,cAAc,KAAK,UAAU;QAClC,CAAC,CAAC,cAAc,CAAC,aAAa,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC;QAC9D,CAAC,CAAC,aAAa,CAAC;IAEpB,OAAO;QACL,QAAQ;QACR,QAAQ;QACR,SAAS;QACT,OAAO;KACR,CAAC;AACJ,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reporting-lib",
-  "version": "0.3.4",
+  "version": "0.4.1",
   "description": "A comprehensive monitoring and reporting library for web applications",
   "type": "module",
   "main": "dist/index.js",