auto-point 0.0.18 → 0.0.20

package/AP/auto_point.js

@@ -167,10 +167,10 @@
       })
       // 挂载页面离开事件监听
       window.addEventListener('visibilitychange', () => {
-        if (navigator && navigator.sendBeacon && document.visibilityState === 'hidden') {
-          let type = "pagehide"
-          let value = "hidden"
-          let describe = "Webpage hidden point"
+        if (navigator && navigator.sendBeacon) {
+          let type = "visibilitychange"
+          let value = document.visibilityState
+          let describe = "Webpage visibility state is changed to: " + document.visibilityState
           this.#add_point(this.#create_active_point_data(type, value, describe))
           this.#send()
         }
@@ -199,8 +199,6 @@
       navigator.sendBeacon(this.#SERVER, JSON.stringify(this.#POINT_LIST));
       // 发送后清空埋点列表数据
       this.#POINT_LIST = new Array()
-    } else {
-      console.log("无新埋点数据")
     }
   }
 

package/README.md

@@ -12,4 +12,34 @@ npm i -S auto-point
 
 **Step 3**： 执行init()方法并传入配置参数，进行初始化。注意，AP应当在页面加载前进行初始化，否则将无法记录AP初始化前的浏览器动作。初始化完成后AP已经可以根据配置进行自动埋点动作收集和发送工作了。
 
-**Step 4**： 初始化完成后可以根据需求，自行添加一些其他埋点信息，可以使用AP.add_point()方法添加一些自定义埋点数据，推荐使用object类型的数据，这些数据会与自动记录的埋点数据一起交给中间件处理之后发送给服务端。
+**Step 4**： 初始化完成后可以根据需求，自行添加一些其他埋点信息，可以使用AP.add_point()方法添加一些自定义埋点数据，推荐使用object类型的数据，这些数据会与自动记录的埋点数据一起交给中间件处理之后发送给服务端。
+
+**示例**
+```javascript
+// 假设AP已经初始化完成
+// 添加一个自定义埋点
+import AP from "auto-point";
+const ap = new AP().init({
+    server: 'https://your-server.com/api/track', // 替换为真实的服务端地址
+    send_time: 5000, // 发送间隔：5秒
+    events: ['click'], // 监听的事件类型
+    point_sing: 'data-track-id' // 埋点标记属性名 如果元素上带有该属性名，AP会自动记录该属性值，否则不会记录
+});
+
+// 挂载中间件（在发送数据前执行）
+ap.middleware(function() {
+    // 示例：添加用户信息到埋点数据
+    console.log('执行中间件：准备发送埋点数据', this.point_list);
+    // 注意：中间件函数中的 this 指向 AP 实例
+    // 可以在这里修改 this.#POINT_LIST 中的数据
+});
+
+// 添加自定义埋点数据
+ap.add_point({
+    type: 'custom',
+    data: {
+        name: 'custom_point',
+        value: 'custom_value'
+    }
+});
+```

package/package.json

@@ -13,5 +13,5 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "version": "0.0.18"
+  "version": "0.0.20"
 }