@fle-sdk/event-tracking-web 1.0.8 → 1.1.0

package/lib/types/type.d.ts

@@ -1,4 +1,4 @@
-export interface _window extends Window {
+export interface Target extends Window {
     /**
      * @description 自定义扩展取消监听函数
      * @default
@@ -10,126 +10,177 @@ export interface _window extends Window {
      */
     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]: string | number | boolean;
+}
 /**
  * @description 事件类型
  */
-export declare type EventTypes = "load" | "pushState" | "beforeunload" | "replaceState" | "replaceState" | "popstate" | "hashchange" | "click" | "customTrack";
-export interface JsonProps {
-    [key: string]: any;
-}
-export interface ConfigProps extends JsonProps {
+export declare type EventTypes = "PageView" | "PageRetained" | "CustomTrack" | "WebClick";
+export interface PresetParams {
     /**
-     * @description 项目唯一标识/项目ID
-     * @default
+     * @description 应用唯一标识（由接口生成）
      */
-    appKey: string;
+    appKey?: string;
     /**
-     * @description 页面唯一标识
-     * @default
+     * @description 数据接收地址
      */
-    pageKey?: string;
+    serverUrl?: string;
     /**
-     * @description 站点Id
-     * @default
+     * @description 站点 ID
      */
     siteId?: string | number;
+    /**
+     * @description 是否在网页控制台打印发送的数据
+     * @default false
+     */
+    showLog?: boolean;
+    /**
+     * @description pc或h5
+     */
+    platform?: "h5" | "pc";
+    /**
+     * @description 是否开启全埋点 指的是：页面浏览、元素点击事件自动上报
+     * @default true
+     */
+    autoTrack?: boolean;
+    /**
+     * @description （是否使用客户端系统时间）注意：客户端系统时间可能会不准确，导致该字段不准确
+     * @default true
+     */
+    useClientTime?: boolean;
+    /**
+     * @description 队列单条数据最大发送时长，超过该时长将自动发送下一条数据，单位：毫秒
+     * @default 500
+     */
+    queueTimeout?: number;
+    /**
+     * @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";
 }
-export interface OtherInfoProps extends JsonProps, SystemInfoProps {
+export interface InitParams extends PresetParams {
     /**
-     * @description 浏览器userAgent信息
-     * @default
+     * @description 应用唯一标识（由接口生成）
      */
-    userAgent?: string;
+    appKey: string;
     /**
-     * @description 浏览器语言
-     * @default
+     * @description 数据接收地址
+     */
+    serverUrl: string;
+}
+export interface ConfigTypes extends InitParams {
+    /**
+     * @description sdk版本
+     * @default "1.0.0"
      */
+    sdkVersion: string;
+}
+export interface SystemsInfo {
     language?: string;
+    location?: string;
+    network?: string;
+    ua?: string;
+    client?: string;
+    navigationStart?: number;
+    navigation?: string;
+    dns?: string;
+    tcp?: string;
+    "tcp (ssl)"?: string;
+    request?: string;
+    response?: string;
+}
+export interface TrackParams {
     /**
-     * @description sdk 版本
-     * @default
+     * @description 控件/自定义事件的唯一标识
      */
-    sdkVersion?: string;
+    partkey: string | number;
+    /**
+     * @description 自定义代码埋点描述
+     * @default "自定义代码埋点上报"
+     */
+    desc?: string;
     /**
-     * @description 设备类型
-     * @default 'pc'
+     * @description 自定义属性
+     * @default {}
      */
-    platformType?: "h5" | "pc";
+    business?: {
+        [key: string]: any;
+    };
 }
-export interface ApiConfigProps extends JsonProps {
+export interface TargetEleProps {
     /**
-     * @description 埋点上报api接口
-     * @default
+     * @description dom节点名称
+     */
+    nodeName?: string;
+    /**
+     * @description id类名
      */
-    serverApi: string;
+    id?: string;
     /**
-     * @description 埋点上报服务器地址
-     * @default
+     * @description class类名
      */
-    serverHost: string;
-}
-export interface WebTrackingProps extends ConfigProps, ApiConfigProps {
+    className?: string;
 }
 export interface TargetEleProps {
     /**
      * @description dom节点名称
-     * @default
      */
     nodeName?: string;
     /**
      * @description id类名
-     * @default
      */
     id?: string;
     /**
      * @description class类名
-     * @default
      */
     className?: string;
+    /**
+     * @description 元素位置
+     */
+    position?: number[];
 }
-export interface ExtroInfoProps extends OtherInfoProps {
+export interface ExtroInfoProps {
     sourceUrl?: string;
     targetUrl?: string;
     business?: JsonProps;
     position?: number[];
     targetEle?: TargetEleProps;
+    currentUrl?: string;
     pageWidth?: number;
     pageHeight?: number;
     screenWidth?: number;
     screenHeight?: number;
-    screenAvailWidth?: number;
-    screenAvailHeight?: number;
-}
-export interface RequestProps {
-    url: string;
-    headers: {
-        [key: string]: string;
-    };
-    params: string;
-    async?: boolean;
-}
-export interface SystemInfoProps {
-    language?: string;
-    location?: string;
-    network?: string;
-    ua?: string;
-    client?: string;
-    navigationStart?: number;
-    navigation?: string;
-    dns?: string;
-    tcp?: string;
-    "tcp (ssl)"?: string;
-    request?: string;
-    response?: string;
+    pointerType?: string;
+    elementSelector?: string;
 }
-export interface TrackingPostProps {
+export interface TrackingPostParams {
     event: EventTypes;
-    desc?: string;
-    itemKey: string;
+    desc: string;
+    itemKey?: string;
     extroInfo?: ExtroInfoProps;
 }
-export interface CustomTrackProps {
-    desc?: string;
-    partkey: string;
-    business?: JsonProps;
+export declare type HistoryType = "load" | "beforeunload" | "pushState" | "replaceState" | "popstate" | "hashchange";
+export interface PageViewHandleParams {
+    currentUrl?: string;
+    targetUrl?: string;
+    type: HistoryType;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fle-sdk/event-tracking-web",
-  "version": "1.0.8",
+  "version": "1.1.0",
   "description": "event tracking in web",
   "author": "飞象前端团队",
   "license": "ISC",
@@ -56,7 +56,7 @@
     "typescript": "^4.3.4"
   },
   "dependencies": {
-    "@fle-sdk/event-tracking-web": "^1.0.8"
+    "@fle-sdk/event-tracking-web": "^1.1.0"
   },
-  "gitHead": "cbae0485a02f891266c4f2b9ee13aa28926fd771"
+  "gitHead": "69fda470a359c02b164907386e9054478d39af98"
 }