@fle-sdk/event-tracking-web 1.2.5 → 1.2.7

package/lib/types/pending-requests.d.ts

@@ -0,0 +1,45 @@
+import { TrackingPostParams, ContentType } from "./type";
+interface PendingRequestsConfig {
+    pendingRequestsMaxSize: number;
+    sendTimeout: number;
+    serverUrl: string;
+    contentType: ContentType;
+    showLog: boolean;
+    header?: Record<string, unknown>;
+}
+interface PendingRequestsCallbacks {
+    getLocalStorage: (key: string) => string | null;
+    setLocalStorage: (key: string, value: string) => void;
+    shouldSample: () => boolean;
+    ajax: (params: {
+        url: string;
+        type: string;
+        data: string;
+        contentType?: ContentType;
+        header?: Record<string, unknown>;
+        credentials?: boolean;
+        timeout?: number;
+        cors?: boolean;
+        success?: () => void;
+        error?: (err?: unknown) => void;
+    }) => void;
+    printLog: (message: string) => void;
+}
+export declare class PendingRequestsManager {
+    private isFlushingPendingData;
+    private isUnloadListenerSetup;
+    private config;
+    private callbacks;
+    constructor(config: PendingRequestsConfig, callbacks: PendingRequestsCallbacks);
+    updateConfig(config: Partial<PendingRequestsConfig>): void;
+    addToQueue(params: TrackingPostParams): void;
+    restoreQueue(): void;
+    flushQueue(): void;
+    flushQueueWithBeacon(): void;
+    setupUnloadListener(): void;
+    private getQueueFromStorage;
+    private saveQueueToStorage;
+    private isPageUnloading;
+    private sendWithBeacon;
+}
+export {};

package/lib/types/tools.d.ts

@@ -172,16 +172,6 @@ export default class WebTrackingTools {
      * @returns 音频指纹字符串
      */
     private getAudioFingerprint;
-    /**
-     * 获取字体指纹
-     * @returns 字体指纹字符串
-     */
-    private getFontFingerprint;
-    /**
-     * 获取插件指纹
-     * @returns 插件指纹字符串
-     */
-    private getPluginsFingerprint;
     /**
      * 检测localStorage支持
      * @returns 是否支持localStorage
@@ -197,11 +187,6 @@ export default class WebTrackingTools {
      * @returns 是否支持IndexedDB
      */
     private hasIndexedDB;
-    /**
-     * 获取网络连接指纹
-     * @returns 网络连接指纹字符串
-     */
-    private getConnectionFingerprint;
     /**
      * 将指纹信息哈希为唯一ID
      * @param fingerprint 指纹信息

package/lib/types/type.d.ts

@@ -34,6 +34,31 @@ export declare type JsonValue = string | number | boolean | null | undefined | J
  * @description 事件类型
  */
 export declare type EventTypes = "PageView" | "PageRetained" | "CustomTrack" | "WebClick" | "WebExposure";
+/**
+ * @description 自动追踪配置
+ */
+export interface AutoTrackConfig {
+    /**
+     * @description 是否自动追踪页面浏览事件
+     * @default false
+     */
+    view?: boolean;
+    /**
+     * @description 是否自动追踪点击事件
+     * @default false
+     */
+    click?: boolean;
+    /**
+     * @description 是否自动追踪曝光事件
+     * @default false
+     */
+    exposure?: boolean;
+    /**
+     * @description 是否自动追踪页面停留时长
+     * @default false
+     */
+    retained?: boolean;
+}
 export interface PresetParams {
     /**
      * @description 应用唯一标识（由接口生成）
@@ -53,15 +78,12 @@ export interface PresetParams {
      */
     showLog?: boolean;
     /**
-     * @description 是否开启全埋点 指的是：页面浏览、元素点击事件自动上报
+     * @description 是否开启自动追踪，支持 boolean 或 object 配置
+     * - boolean: true 表示开启所有自动追踪，false 表示关闭所有自动追踪
+     * - object: 可以单独配置 view、click、exposure、retained 的开启/关闭
      * @default false
      */
-    autoTrack?: boolean;
-    /**
-     * @description 是否对带有 data-part-key 属性的元素点击进行上报（即使 autoTrack 为 false）
-     * @default false
-     */
-    trackPartKeyClick?: boolean;
+    autoTrack?: boolean | AutoTrackConfig;
     /**
      * @description （是否使用客户端系统时间）注意：客户端系统时间可能会不准确，导致该字段不准确
      * @default true
@@ -127,21 +149,11 @@ export interface PresetParams {
      * @default 自动从 window.location.pathname 获取
      */
     pageKey?: string;
-    /**
-     * @description 是否定时上报页面停留时长
-     * @default false
-     */
-    autoTrackPageDurationInterval?: boolean;
     /**
      * @description 定时上报页面停留时长的间隔时间（毫秒）
      * @default 30000 (30秒)
      */
     pageDurationInterval?: number;
-    /**
-     * @description 是否启用曝光埋点
-     * @default false
-     */
-    autoTrackExposure?: boolean;
     /**
      * @description 曝光进入可视区判定阈值（0-1之间）
      * @default 0.5
@@ -197,7 +209,7 @@ export interface TrackParams {
     /**
      * @description 控件/自定义事件的唯一标识
      */
-    partkey: string | number;
+    partKey: string | number;
     /**
      * @description 自定义代码埋点描述
      * @default "自定义代码埋点上报"
@@ -324,6 +336,10 @@ export interface PrivateParamProps {
      * @description 设备唯一标识
      */
     deviceId?: string;
+    /**
+     * @description 曝光元素位于第几屏
+     */
+    exposureScreenNo?: number;
 }
 export interface TrackingPostParams {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fle-sdk/event-tracking-web",
-  "version": "1.2.5",
+  "version": "1.2.7",
   "description": "event tracking in web",
   "author": "飞象前端团队",
   "license": "ISC",