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

package/lib/types/type.d.ts

@@ -18,7 +18,7 @@ export interface EventParams extends Event {
     arguments?: any[];
 }
 export interface JsonProps {
-    [key: string]: string | number | boolean;
+    [key: string]: any;
 }
 /**
  * @description 事件类型
@@ -34,18 +34,14 @@ export interface PresetParams {
      */
     serverUrl?: string;
     /**
-     * @description 站点 ID
+     * @description 手动指定客户端平台类型（h5、pc、ipad、other）
      */
-    siteId?: string | number;
+    platform?: PlatformType | string;
     /**
      * @description 是否在网页控制台打印发送的数据
      * @default false
      */
     showLog?: boolean;
-    /**
-     * @description pc或h5
-     */
-    platform?: "h5" | "pc";
     /**
      * @description 是否开启全埋点 指的是：页面浏览、元素点击事件自动上报
      * @default true
@@ -56,11 +52,6 @@ export interface PresetParams {
      * @default true
      */
     useClientTime?: boolean;
-    /**
-     * @description 队列单条数据最大发送时长，超过该时长将自动发送下一条数据，单位：毫秒
-     * @default 500
-     */
-    queueTimeout?: number;
     /**
      * @description 接口发送超时时长，超过该时长未发送成功将强制取消，单位：毫秒
      * @default 3000
@@ -76,6 +67,13 @@ export interface PresetParams {
      * @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 {
     /**
@@ -87,26 +85,22 @@ export interface InitParams extends PresetParams {
      */
     serverUrl: string;
 }
-export interface ConfigTypes extends InitParams {
+export declare type PlatformType = "h5" | "pc" | "ipad" | "other";
+export interface SystemsInfoTypes {
+    language?: string;
     /**
-     * @description sdk版本
-     * @default "1.0.0"
+     * 网络类型
      */
-    sdkVersion: string;
-}
-export interface SystemsInfo {
-    language?: string;
-    location?: string;
     network?: string;
     ua?: string;
+    /**
+     * @description 客户端（Mac/Android/iPhone/iPad/iPod/WeChat）
+     */
     client?: string;
-    navigationStart?: number;
-    navigation?: string;
-    dns?: string;
-    tcp?: string;
-    "tcp (ssl)"?: string;
-    request?: string;
-    response?: string;
+    /**
+     * @description 客户端平台类型（h5、pc、ipad）
+     */
+    platform?: PlatformType | string;
 }
 export interface TrackParams {
     /**
@@ -119,7 +113,7 @@ export interface TrackParams {
      */
     desc?: string;
     /**
-     * @description 自定义属性
+     * @description 自定义业务参数
      * @default {}
      */
     business?: {
@@ -139,48 +133,96 @@ export interface TargetEleProps {
      * @description class类名
      */
     className?: string;
-}
-export interface TargetEleProps {
     /**
-     * @description dom节点名称
+     * @description 元素触发位置：[x, y]
      */
-    nodeName?: string;
+    position?: [number, number];
+}
+/**
+ * @description 基础系统信息
+ */
+export interface PrivateParamProps {
     /**
-     * @description id类名
+     * @description 当前URL
      */
-    id?: string;
+    currentUrl?: string;
     /**
-     * @description class类名
+     * @description 目标URL
      */
-    className?: string;
+    targetUrl?: string;
     /**
-     * @description 元素位置
+     * @description 手动埋点参数
      */
-    position?: number[];
-}
-export interface ExtroInfoProps {
-    sourceUrl?: string;
-    targetUrl?: string;
     business?: JsonProps;
-    position?: number[];
+    /**
+     * @description 触发元素属性
+     */
     targetEle?: TargetEleProps;
-    currentUrl?: string;
+    /**
+     * @description 页面可视区宽度
+     */
     pageWidth?: number;
+    /**
+     * @description 页面可视区高度
+     */
     pageHeight?: number;
+    /**
+     * @description 显示屏宽度
+     */
     screenWidth?: number;
+    /**
+     * @description 显示屏高度
+     */
     screenHeight?: number;
-    pointerType?: string;
+    /**
+     * @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;
-    extroInfo?: ExtroInfoProps;
+    /**
+     * @description 发送请求事件
+     */
+    requestTime?: number;
+    /**
+     * @description 私有参数
+     */
+    privateParamMap?: PrivateParamProps;
 }
 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.1.1",
+  "version": "1.2.0-beta.0",
   "description": "event tracking in web",
   "author": "飞象前端团队",
   "license": "ISC",
@@ -56,7 +56,6 @@
     "typescript": "^4.3.4"
   },
   "dependencies": {
-    "@fle-sdk/event-tracking-web": "^1.1.1"
-  },
-  "gitHead": "685abeb34facc4f7aebe86d98137fc7593826233"
+    "@fle-sdk/event-tracking-web": "^1.1.2-alpha.0"
+  }
 }