auto-point 0.0.25 → 0.0.27

package/AP/auto_point.js

@@ -13,7 +13,7 @@
   set server(url) {
     this.#SERVER = url
   }
-  #SEND_FUNC = function(data){
+  #SEND_FUNC = function (data) {
     return fetch(this.#SERVER, {
       method: 'POST',
       headers: {
@@ -34,21 +34,24 @@
   get point_list() {
     return this.#POINT_LIST
   }
-  set point_list(data){
+  set point_list(data) {
     this.#POINT_LIST = data
   }
   // 埋点系统时间
-  #POINT_SYS_INIT_TIME = void(0)
-  get point_sys_init_time(){
+  #POINT_SYS_INIT_TIME = void (0)
+  get point_sys_init_time() {
     return this.#POINT_SYS_INIT_TIME
   }
   // 上次发送时间
-  #POINT_LAST_SEND_TIME = void(0)
-  get point_last_send_time(){
+  #POINT_LAST_SEND_TIME = void (0)
+  get point_last_send_time() {
     return this.#POINT_LAST_SEND_TIME
   }
   // 中间件列表
   #MIDDLEWARE = new Array()
+  get middleware() {
+    return this.#MIDDLEWARE
+  }
 
   #ERROR(msg) {
     console.error(msg)
@@ -61,7 +64,7 @@
       return false
     }
   }
-  #NotArrowFunction(obj,message){
+  #NotArrowFunction(obj, message) {
     if (typeof obj === 'function' && obj.prototype) {
       return true
     } else {
@@ -86,24 +89,34 @@
     }
   }
   #params_hash_server(server) {
-    if (server) {
+    if (server && /^https?:\/\//.test(server)) { // server 是一个url
       return true
     } else {
       throw "The server in params cannot be empty"
     }
   }
 
-  constructor() { }
+  /**
+   * @param {object} params 
+   * @param {string} params.server server - 服务端地址 未自定义send_func时必填
+   * @param {Array.<string>} [params.events] - 事件列表 默认['click']
+   * @param {number} [params.interval_time] - 发送数据间隔 单位毫秒 默认10_000毫秒
+   * @param {string} [params.point_sing] - 默认"auto_point"，添加元素点击事件的埋点标记，被标记的元素点击时触发埋点事件
+   * @param {function} [params.send_func] - 自定义发送函数，默认使用fetch发送POST请求, 使用自定义发送函数时, 可以不填写server参数
+   */
+  constructor(params) {
+    this.#init(params)
+  }
 
   #init(params) {
-    if (this.#INIT_STATE && this.#isObject(params, "Init only accepts object type data") && this.#params_hash_server(params.server)) {
+    if (this.#INIT_STATE && this.#isObject(params, "Init only accepts object type data") && (this.#params_hash_server(params.server) || this.#isFunction(params.send_func, "The server and send_func must receive an argument."))) {
       this.#SERVER = params.server
       this.#INTERVAL_TIME = params.interval_time || this.#INTERVAL_TIME
       this.#POINT_SING = params.point_sing || this.#POINT_SING
       if (params.events && this.#isArray(params.events, "events must be an Array")) {
         this.#EVENTS = params.events
       }
-      if(params.send_func && this.#isFunction(params.send_func, "send_func must be a function")){
+      if (params.send_func && this.#isFunction(params.send_func, "send_func must be a function")) {
         this.#SEND_FUNC = params.send_func
       }
       this.#POINT_SYS_INIT_TIME = new Date().getTime()
@@ -115,10 +128,12 @@
       let describe = "Webpage initialization succeeded"
       this.#add_point(this.#create_active_point_data(type, value, describe))
       this.#INIT_STATE = false
+    } else {
+      throw "Init failed"
     }
   }
 
-  #create_point_data_common_params(){
+  #create_point_data_common_params() {
     let point_item = new Object()
     point_item.location = JSON.parse(JSON.stringify(window.location))
     point_item.point_sys_init_time = this.#POINT_SYS_INIT_TIME
@@ -150,7 +165,7 @@
    * @param {string} activeValue 埋点动作记录值
    * @returns 
    */
-  #create_active_point_data(activeType, activeAttr, activeValue){
+  #create_active_point_data(activeType, activeAttr, activeValue) {
     let point_item = this.#create_point_data_common_params()
     point_item.point_type = "active"
     point_item.point_sing = activeType
@@ -172,7 +187,7 @@
         })
       })
       // 挂载hash监听
-      window.addEventListener("hashchange",()=>{
+      window.addEventListener("hashchange", () => {
         let type = "hashchange"
         let value = window.location.hash
         let describe = "Webpage hash value is changed to: " + window.location.hash
@@ -202,20 +217,21 @@
   // 发送埋点数据
   async #send() {
     if (this.#POINT_LIST.length) {
-      this.#MIDDLEWARE.map((item) => {
-        if (this.#isFunction(item)) {
-          item.apply(this)
+      let point_list = this.#POINT_LIST
+      for(let middleware of this.#MIDDLEWARE){
+        if (this.#isFunction(middleware)) {
+          point_list = await middleware(point_list)
         }
-      })
-      this.#POINT_LAST_SEND_TIME = new Date().getTime() // 更新最后发送时间
-      navigator.sendBeacon(this.#SERVER, JSON.stringify(this.#POINT_LIST));
-      let res 
+      }
+      
+      let res
       try {
-        res = await this.#SEND_FUNC(this.#POINT_LIST)
+        res = await this.#SEND_FUNC(point_list)
       } catch (error) {
         console.error("Error sending data:", error)
       } finally {
-        // 发送后清空埋点列表数据
+        // 发送后清空埋点列表数据, 并更新最后发送时间
+        this.#POINT_LAST_SEND_TIME = new Date().getTime() // 更新最后发送时间
         this.#POINT_LIST = new Array()
       }
       return res
@@ -225,28 +241,12 @@
   // 根据间隔时间，定时发送埋点数据
   #timer_send() {
     setInterval(() => {
-      if(!this.#POINT_LAST_SEND_TIME || (new Date().getTime() - this.#POINT_LAST_SEND_TIME >= this.#INTERVAL_TIME)){
+      if (!this.#POINT_LAST_SEND_TIME || (new Date().getTime() - this.#POINT_LAST_SEND_TIME >= this.#INTERVAL_TIME)) {
         this.#send()
       }
     }, 200)
   }
 
-  /**
-   * @brief 埋点记录初始化
-   * @description server (必填) - 服务端地址
-   * @description send_time - 发送数据间隔 单位毫秒 默认10_000毫秒
-   * @description point_sing - 默认"auto_point"，添加元素点击事件的埋点标记，被标记的元素点击时触发埋点事件
-   * @param {object} params 
-   * @param {string} params.server
-   * @param {Array.<string>} [params.events]
-   * @param {number} [params.send_time]
-   * @param {string} [params.point_sing]
-   */
-  init(params) {
-    this.#init(params)
-    return this
-  }
-
   // 手动发送数据
   send() {
     return this.#send()
@@ -254,11 +254,11 @@
 
   /**
    * @description 挂载中间件
-   * @param {function(this):void} func 不允许传入箭头函数
-   * @return this 
+   * @param {function(point_list)} func 接收一个函数参数，该函数接收一个point_list参数，返回一个point_list
+   * @return {point_list} 处理后的埋点数据列表
    */
   middleware(func) {
-    if (this.#NotArrowFunction(func, "Middleware requires a non-arrow function parameter")) {
+    if (this.#isFunction(func, "Middleware requires a function parameter")) {
       this.#MIDDLEWARE.push(func)
     }
     return this

package/README.md

@@ -19,7 +19,7 @@ npm i -S auto-point
 // 假设AP已经初始化完成
 // 添加一个自定义埋点
 import AP from "auto-point";
-const ap = new AP().init({
+const ap = new AP({
     server: 'https://your-server.com/api/track', // 替换为真实的服务端地址
     interval_time: 5000, // 发送间隔：5秒
     events: ['click'], // 监听的事件类型
@@ -29,12 +29,10 @@ const ap = new AP().init({
     }
 });
 
-// 挂载中间件（在发送数据前执行）
-ap.middleware(function() {
-    // 示例：添加用户信息到埋点数据
-    console.log('执行中间件：准备发送埋点数据', this.point_list);
-    // 注意：中间件函数中的 this 指向 AP 实例
-    // 可以在这里修改 this.#POINT_LIST 中的数据
+// 挂载中间件（在发送数据前执行）, 中间件函数接收一个参数，即埋点数据列表，返回处理后的埋点数据列表
+ap.middleware(function(point_list) {
+    console.log('执行中间件：准备发送埋点数据', point_list);
+    return point_list
 });
 
 // 添加自定义埋点数据

package/package.json

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