trackersdk2 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,151 @@
+type TagNames = string;
+interface TrackerConfig {
+    serverUrl: string;
+    appId: string;
+    userId?: string;
+    autoTrack?: boolean;
+    enableAutoClickTagNameList?: Array<TagNames>;
+    debug?: boolean;
+    batchSize?: number;
+    batchInterval?: number;
+}
+interface TrackProperties {
+    [propName: string]: string | number | boolean | null | undefined;
+}
+type TrackerEventType = "custom" | "click" | "pv" | "uv" | "error" | "performance";
+interface TrackEvent {
+    eventType: TrackerEventType;
+    properties?: TrackProperties;
+    event?: string;
+}
+
+declare class TrackerSDK {
+    private config;
+    private autoTrackClickHandler;
+    private eventQueue;
+    private batchTimer;
+    private hasSentBeforeUnload;
+    constructor();
+    init(config: TrackerConfig): void;
+    /**
+     * @description 重试批量上报之前上报失败的数据
+     * @returns Promise<void>
+     */
+    private retryFailedBatches;
+    /**
+     * @description 监听页面卸载事件，确保数据上报
+     * @returns void
+     */
+    private setupPageUnloadHandler;
+    /**
+     * @description 获取设备id
+     */
+    private getDeviceId;
+    /**
+     *  @description navigator.sendBeacon 和 fetch 双通道实现数据上报
+     *  @param data 上报的负载
+     */
+    private send;
+    /**
+     * @description 入队列
+     * @param payload 上报的负载
+     */
+    private enqueue;
+    /**
+     * @description 刷新队列，批量上报
+     * @return void
+     */
+    private flush;
+    /**
+     * @description navigator.sendBeacon单条错误上报失败的fetch回退方案
+     * @param payload any
+     * */
+    private fallbackSend;
+    /**
+     * @description 错误事件立即上报
+     * @param data 上报的负载
+     * @returns void
+     */
+    sendImmediately(payload: TrackEvent): void;
+    /**
+     * @description 批量上报
+     * @param events 上报的事件数组
+     * @returns Promise<void>
+     */
+    private sendBatch;
+    /**
+     * @description 批量上报的fetch回退方案
+     * @param payload 上报的负载
+     * @returns Promise<void>
+     */
+    private fallbackSendBatch;
+    private saveFailedBatch;
+    /**
+     * @description 自定义点击事件
+     */
+    track(event: string, properties?: Record<string, any>): void;
+    /**
+     * @description 用于自动点击埋点
+     *
+     * @param element 点击的DOM元素
+     */
+    trackClick(element: Element): void;
+    /**
+     * @description 自动pv
+     *
+     * @param path pv的页面路径
+     * @param properties 上报数据
+     */
+    trackPV(path: string, properties?: Record<string, any>): void;
+    /**
+     * @description 统计uv（每天每个设备只上报一次）
+     *
+     */
+    trackUV(): void;
+    /** @description 初始化错误事件监听
+     *
+     */
+    setupErrorTracking(): void;
+    /**
+     * @description vue3 全局错误处理器
+     */
+    setupVueErrorHandlder(app: any): void;
+    private setupPerformanceTracking;
+    /**
+     * @description 监控FCP
+     * @returns void
+     */
+    private observeFCP;
+    /**
+     * @description 监控LCP
+     * @returns void
+     */
+    private observeLCP;
+    /**
+     * @description 监控CLS
+     * @returns void
+     */
+    private observeCLS;
+    /**
+     * @description 监控TTFB
+     * @returns void
+     */
+    private observeTTFB;
+    /**
+     * @description 全埋点(谨慎使用,存在性能问题)
+     */
+    enableAutoTracking(): void;
+    /**
+     * @description: 设置可触发自动埋点的DOM元素标签名称白名单
+     */
+    setEnableAutoClickTagNameList(tagNameList: Array<TagNames>): void;
+}
+declare const tracker: TrackerSDK;
+
+declare const _default: {
+    install(app: any, options: TrackerConfig): void;
+};
+
+declare function useTracker(): TrackerSDK;
+
+export { _default as default, tracker, useTracker };