@fle-sdk/event-tracking-web 1.2.0-beta.0 → 1.2.0

package/lib/types/type.d.ts

@@ -1,228 +1,466 @@
-export interface Target extends Window {
-    /**
-     * @description 自定义扩展取消监听函数
-     * @default
-     */
-    detachEvent?: (type: string, fun: (event: Event) => void, bol: boolean) => void;
-    /**
-     * @description 自定义扩展添加监听函数
-     * @default
-     */
-    attachEvent?: (type: string, fun: (event: Event) => void, bol: boolean) => void;
-}
-export interface EventParams extends Event {
-    /**
-     * @description 重写添加 arguments
-     * @default
-     */
-    arguments?: any[];
-}
-export interface JsonProps {
-    [key: string]: any;
-}
-/**
- * @description 事件类型
- */
-export declare type EventTypes = "PageView" | "PageRetained" | "CustomTrack" | "WebClick";
-export interface PresetParams {
-    /**
-     * @description 应用唯一标识（由接口生成）
-     */
-    appKey?: string;
-    /**
-     * @description 数据接收地址
-     */
-    serverUrl?: string;
-    /**
-     * @description 手动指定客户端平台类型（h5、pc、ipad、other）
-     */
-    platform?: PlatformType | string;
-    /**
-     * @description 是否在网页控制台打印发送的数据
-     * @default false
-     */
-    showLog?: boolean;
-    /**
-     * @description 是否开启全埋点 指的是：页面浏览、元素点击事件自动上报
-     * @default true
-     */
-    autoTrack?: boolean;
-    /**
-     * @description （是否使用客户端系统时间）注意：客户端系统时间可能会不准确，导致该字段不准确
-     * @default true
-     */
-    useClientTime?: boolean;
-    /**
-     * @description 接口发送超时时长，超过该时长未发送成功将强制取消，单位：毫秒
-     * @default 3000
-     */
-    sendTimeout?: number;
-    /**
-     * @description 是否采集单页面应用的路由变化
-     * @default false
-     */
-    isTrackSinglePage?: boolean;
-    /**
-     * @description 数据类型
-     * @default "application/x-www-form-urlencoded"
-     */
-    contentType?: "application/x-www-form-urlencoded" | "application/json";
-    /**
-     * @description 全局自定义业务参数
-     * @default {}
-     */
-    business?: {
-        [key: string]: any;
-    };
-}
-export interface InitParams extends PresetParams {
-    /**
-     * @description 应用唯一标识（由接口生成）
-     */
-    appKey: string;
-    /**
-     * @description 数据接收地址
-     */
-    serverUrl: string;
-}
-export declare type PlatformType = "h5" | "pc" | "ipad" | "other";
-export interface SystemsInfoTypes {
-    language?: string;
-    /**
-     * 网络类型
-     */
-    network?: string;
-    ua?: string;
-    /**
-     * @description 客户端（Mac/Android/iPhone/iPad/iPod/WeChat）
-     */
-    client?: string;
-    /**
-     * @description 客户端平台类型（h5、pc、ipad）
-     */
-    platform?: PlatformType | string;
-}
-export interface TrackParams {
-    /**
-     * @description 控件/自定义事件的唯一标识
-     */
-    partkey: string | number;
-    /**
-     * @description 自定义代码埋点描述
-     * @default "自定义代码埋点上报"
-     */
-    desc?: string;
-    /**
-     * @description 自定义业务参数
-     * @default {}
-     */
-    business?: {
-        [key: string]: any;
-    };
-}
-export interface TargetEleProps {
-    /**
-     * @description dom节点名称
-     */
-    nodeName?: string;
-    /**
-     * @description id类名
-     */
-    id?: string;
-    /**
-     * @description class类名
-     */
-    className?: string;
-    /**
-     * @description 元素触发位置：[x, y]
-     */
-    position?: [number, number];
-}
-/**
- * @description 基础系统信息
- */
-export interface PrivateParamProps {
-    /**
-     * @description 当前URL
-     */
-    currentUrl?: string;
-    /**
-     * @description 目标URL
-     */
-    targetUrl?: string;
-    /**
-     * @description 手动埋点参数
-     */
-    business?: JsonProps;
-    /**
-     * @description 触发元素属性
-     */
-    targetEle?: TargetEleProps;
-    /**
-     * @description 页面可视区宽度
-     */
-    pageWidth?: number;
-    /**
-     * @description 页面可视区高度
-     */
-    pageHeight?: number;
-    /**
-     * @description 显示屏宽度
-     */
-    screenWidth?: number;
-    /**
-     * @description 显示屏高度
-     */
-    screenHeight?: number;
-    /**
-     * @description 手动触发的指针类型
-     */
-    pointerType?: "mouse" | "touch" | "pen";
-    /**
-     * @description 触发元素链路
-     */
-    elementSelector?: string;
-    /**
-     * @description 用户信息
-     */
-    userInfo?: JsonProps;
-    /**
-     * @description 路由参数
-     */
-    urlParams?: JsonProps;
-    /**
-     * @description 系统信息
-     */
-    systemsInfo?: SystemsInfoTypes;
-    /**
-     * @description SDk版本
-     */
-    sdkVersion?: string;
-    /**
-     * @description 页面停留时长（毫秒）
-     */
-    retainedDuration?: number;
-}
-export interface TrackingPostParams {
-    /**
-     * @description 事件类型
-     */
-    event: EventTypes;
-    /**
-     * @description 埋点事件描述
-     */
-    desc: string;
-    /**
-     * @description 当前埋点事件Key
-     */
-    itemKey?: string;
-    /**
-     * @description 发送请求事件
-     */
-    requestTime?: number;
-    /**
-     * @description 私有参数
-     */
-    privateParamMap?: PrivateParamProps;
-}
-export declare type HistoryType = "load" | "beforeunload" | "pushState" | "replaceState" | "popstate" | "hashchange";
+export interface Target extends Window {
+    /**
+     * @description 自定义扩展取消监听函数
+     * @default
+     */
+    detachEvent?: (type: string, fun: (event: Event) => void, bol: boolean) => void;
+    /**
+     * @description 自定义扩展添加监听函数
+     * @default
+     */
+    attachEvent?: (type: string, fun: (event: Event) => void, bol: boolean) => void;
+}
+export declare type ContentType = "application/x-www-form-urlencoded" | "application/json";
+export interface EventParams extends Event {
+    /**
+     * @description 重写添加 arguments
+     * @default
+     */
+    arguments?: IArguments | unknown[];
+}
+/**
+ * @description JSON对象类型，支持嵌套对象和基本类型
+ * 使用 Record 类型以支持更灵活的值类型
+ * 先定义 JsonProps，避免在 JsonValue 中直接循环引用
+ */
+export interface JsonProps extends Record<string, JsonValue | unknown> {
+}
+/**
+ * @description JSON值类型，支持所有可序列化的值
+ * 包含基本类型、JsonProps 对象和 JsonValue 数组
+ */
+export declare type JsonValue = string | number | boolean | null | undefined | JsonProps | JsonValue[];
+/**
+ * @description 事件类型
+ */
+export declare type EventTypes = "PageView" | "PageRetained" | "CustomTrack" | "WebClick";
+export interface PresetParams {
+    /**
+     * @description 应用唯一标识（由接口生成）
+     */
+    appKey?: string;
+    /**
+     * @description 数据接收地址
+     */
+    serverUrl?: string;
+    /**
+     * @description 手动指定客户端平台类型（h5、pc、ipad、other）
+     */
+    platform?: PlatformType | string;
+    /**
+     * @description 是否在网页控制台打印发送的数据
+     * @default false
+     */
+    showLog?: boolean;
+    /**
+     * @description 是否开启全埋点 指的是：页面浏览、元素点击事件自动上报
+     * @default false
+     */
+    autoTrack?: boolean;
+    /**
+     * @description （是否使用客户端系统时间）注意：客户端系统时间可能会不准确，导致该字段不准确
+     * @default true
+     */
+    useClientTime?: boolean;
+    /**
+     * @description 接口发送超时时长，超过该时长未发送成功将强制取消，单位：毫秒
+     * @default 3000
+     */
+    sendTimeout?: number;
+    /**
+     * @description 是否采集单页面应用的路由变化
+     * @default false
+     */
+    isTrackSinglePage?: boolean;
+    /**
+     * @description 数据类型
+     * @default "application/json"
+     */
+    contentType?: ContentType;
+    /**
+     * @description 全局自定义业务参数
+     * @default {}
+     */
+    business?: JsonProps;
+    /**
+     * @description 请求头
+     * @default {}
+     */
+    header?: JsonProps;
+    /**
+     * @description 数据采样率，0-1之间，1表示100%采样
+     * @default 1
+     */
+    sampleRate?: number;
+    /**
+     * @description 是否启用批量发送
+     * @default false
+     */
+    batchSend?: boolean;
+    /**
+     * @description 批量发送间隔时间(ms)
+     * @default 5000
+     */
+    batchInterval?: number;
+    /**
+     * @description 批量发送最大数量
+     * @default 10
+     */
+    batchMaxSize?: number;
+}
+export interface InitParams extends PresetParams {
+    /**
+     * @description 应用唯一标识（由接口生成）
+     */
+    appKey: string;
+    /**
+     * @description 数据接收地址
+     */
+    serverUrl: string;
+}
+export declare type PlatformType = "h5" | "pc" | "ipad" | "other";
+export interface SystemsInfoTypes {
+    language?: string;
+    /**
+     * 网络类型
+     */
+    network?: string;
+    ua?: string;
+    /**
+     * @description 客户端（Mac/Android/iPhone/iPad/iPod/WeChat）
+     */
+    client?: string;
+    /**
+     * @description 客户端平台类型（h5、pc、ipad）
+     */
+    platform?: PlatformType | string;
+}
+export interface TrackParams {
+    /**
+     * @description 控件/自定义事件的唯一标识
+     */
+    partkey: string | number;
+    /**
+     * @description 自定义代码埋点描述
+     * @default "自定义代码埋点上报"
+     */
+    desc?: string;
+    /**
+     * @description 自定义业务参数
+     * @default {}
+     */
+    business?: JsonProps;
+    /**
+     * @description 请求头
+     * @default {}
+     */
+    header?: JsonProps;
+}
+export interface TargetEleProps {
+    /**
+     * @description dom节点名称
+     */
+    nodeName?: string;
+    /**
+     * @description id类名
+     */
+    id?: string;
+    /**
+     * @description class类名
+     */
+    className?: string;
+    /**
+     * @description 元素触发位置：[x, y]
+     */
+    position?: [number, number];
+}
+/**
+ * @description 基础系统信息
+ */
+export interface PrivateParamProps {
+    /**
+     * @description 当前URL
+     */
+    currentUrl?: string;
+    /**
+     * @description 目标URL
+     */
+    targetUrl?: string;
+    /**
+     * @description 手动埋点参数
+     */
+    business?: JsonProps;
+    /**
+     * @description 触发元素属性
+     */
+    targetEle?: TargetEleProps;
+    /**
+     * @description 页面可视区宽度
+     */
+    pageWidth?: number;
+    /**
+     * @description 页面可视区高度
+     */
+    pageHeight?: number;
+    /**
+     * @description 显示屏宽度
+     */
+    screenWidth?: number;
+    /**
+     * @description 显示屏高度
+     */
+    screenHeight?: number;
+    /**
+     * @description 手动触发的指针类型
+     */
+    pointerType?: PointerType;
+    /**
+     * @description 触发元素链路
+     */
+    elementSelector?: string;
+    /**
+     * @description 用户信息
+     */
+    userInfo?: JsonProps;
+    /**
+     * @description 路由参数
+     */
+    urlParams?: JsonProps;
+    /**
+     * @description 系统信息
+     */
+    systemsInfo?: SystemsInfoTypes;
+    /**
+     * @description SDk版本
+     */
+    sdkVersion?: string;
+    /**
+     * @description 页面停留时长（毫秒）
+     */
+    retainedDuration?: number;
+    /**
+     * @description 设备唯一标识
+     */
+    deviceId?: string;
+}
+export interface TrackingPostParams {
+    /**
+     * @description 事件类型
+     */
+    event: EventTypes;
+    /**
+     * @description 埋点事件描述
+     */
+    desc: string;
+    /**
+     * @description 当前埋点事件Key
+     */
+    itemKey?: string;
+    /**
+     * @description 发送请求时间戳（毫秒）
+     */
+    requestTime?: number;
+    /**
+     * @description 私有参数
+     */
+    privateParamMap?: PrivateParamProps;
+}
+/**
+ * @description 获取参数选项接口
+ */
+export interface GetParamsOptions {
+    event: EventTypes;
+    desc: string;
+    privateParamMap?: PrivateParamProps;
+    itemKey?: string;
+}
+/**
+ * @description Ajax请求参数接口
+ */
+export interface AjaxParams {
+    type?: HttpMethod;
+    url: string;
+    data?: string;
+    contentType?: ContentType;
+    header?: JsonProps;
+    success?: (data: JsonProps) => void;
+    error?: (err?: Error | JsonProps, status?: number) => void;
+    timeout?: number;
+    credentials?: boolean;
+    cors?: boolean;
+}
+/**
+ * @description SendBeacon参数接口
+ */
+export interface SendBeaconParams {
+    url: string;
+    data: TrackingPostParams | JsonProps;
+    contentType: ContentType;
+}
+export declare type HistoryType = "load" | "beforeunload" | "pushState" | "replaceState" | "popstate" | "hashchange";
+/**
+ * @description HTTP请求方法类型
+ */
+export declare type HttpMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
+/**
+ * @description 指针设备类型
+ */
+export declare type PointerType = "mouse" | "touch" | "pen";
+/**
+ * @description 网络连接类型
+ */
+export declare type NetworkConnectionType = "slow-2g" | "2g" | "3g" | "4g" | "5g";
+/**
+ * @description 网络连接信息接口
+ */
+export interface NetworkConnection {
+    effectiveType?: NetworkConnectionType;
+    downlink?: number;
+    rtt?: number;
+    saveData?: boolean;
+}
+/**
+ * @description 浏览器信息接口
+ */
+export interface BrowserInfo {
+    name: string;
+    version: number;
+}
+/**
+ * @description 响应结果接口
+ */
+export interface TrackingResponse {
+    success: boolean;
+    message?: string;
+    data?: JsonProps;
+    code?: number;
+}
+/**
+ * @description 批量发送数据格式
+ */
+export interface BatchTrackingData {
+    events: TrackingPostParams[];
+    timestamp?: number;
+    deviceId?: string;
+}
+/**
+ * @description 工具类型：将对象的所有属性变为必需
+ */
+export declare type RequiredFields<T, K extends keyof T> = T & Required<Pick<T, K>>;
+/**
+ * @description 工具类型：将对象的所有属性变为可选
+ */
+export declare type PartialFields<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+/**
+ * @description 工具类型：深度只读
+ */
+export declare type DeepReadonly<T> = {
+    readonly [P in keyof T]: T[P] extends object ? DeepReadonly<T[P]> : T[P];
+};
+/**
+ * @description 工具类型：深度部分
+ */
+export declare type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+/**
+ * @description 工具类型：提取函数参数类型
+ */
+export declare type Parameters<T extends (...args: any) => any> = T extends (...args: infer P) => any ? P : never;
+/**
+ * @description 工具类型：提取函数返回类型
+ */
+export declare type ReturnType<T extends (...args: any) => any> = T extends (...args: any) => infer R ? R : any;
+/**
+ * @description 设备指纹信息
+ */
+export interface DeviceFingerprint {
+    /**
+     * @description 用户代理字符串
+     */
+    userAgent?: string;
+    /**
+     * @description 屏幕宽度
+     */
+    screenWidth?: number;
+    /**
+     * @description 屏幕高度
+     */
+    screenHeight?: number;
+    /**
+     * @description 颜色深度
+     */
+    colorDepth?: number;
+    /**
+     * @description 像素深度
+     */
+    pixelDepth?: number;
+    /**
+     * @description 时区
+     */
+    timezone?: string;
+    /**
+     * @description 时区偏移
+     */
+    timezoneOffset?: number;
+    /**
+     * @description 浏览器语言
+     */
+    language?: string;
+    /**
+     * @description 支持的语言列表
+     */
+    languages?: string[];
+    /**
+     * @description 平台信息
+     */
+    platform?: string;
+    /**
+     * @description WebGL指纹
+     */
+    webgl?: string;
+    /**
+     * @description Canvas指纹
+     */
+    canvas?: string;
+    /**
+     * @description 音频指纹
+     */
+    audio?: string;
+    /**
+     * @description 字体指纹
+     */
+    fonts?: string;
+    /**
+     * @description 插件指纹
+     */
+    plugins?: string;
+    /**
+     * @description 是否支持localStorage
+     */
+    localStorage?: boolean;
+    /**
+     * @description 是否支持sessionStorage
+     */
+    sessionStorage?: boolean;
+    /**
+     * @description 是否支持IndexedDB
+     */
+    indexedDB?: boolean;
+    /**
+     * @description CPU核心数
+     */
+    hardwareConcurrency?: number;
+    /**
+     * @description 设备内存(GB)
+     */
+    deviceMemory?: number;
+    /**
+     * @description 最大触摸点数
+     */
+    maxTouchPoints?: number;
+    /**
+     * @description 网络连接信息
+     */
+    connection?: string | NetworkConnection;
+}