@havue/solutions 1.1.1 → 1.2.0

package/bc-connect/dist/bc-connect.umd.js

@@ -6,14 +6,14 @@ var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { en
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 
   var BcConnectEventTypeEnum = /* @__PURE__ */ ((BcConnectEventTypeEnum2) => {
-    BcConnectEventTypeEnum2["Broadcast"] = "Hello world";
-    BcConnectEventTypeEnum2["Broadcast_Reply"] = "I can hear you";
-    BcConnectEventTypeEnum2["Main_Node_Hearbeat"] = "苍天还在，别立黄天";
-    BcConnectEventTypeEnum2["Res_Main_Node_Hearbeat"] = "苍天在上，受我一拜";
-    BcConnectEventTypeEnum2["Req_Be_Main_Node"] = "苍天已死，黄天当立";
-    BcConnectEventTypeEnum2["Res_Be_Main_Node"] = "我是黄天，尔等退下";
-    BcConnectEventTypeEnum2["Node_Type_Change"] = "node type change";
-    BcConnectEventTypeEnum2["Friend_List_Update"] = "friend list update";
+    BcConnectEventTypeEnum2["Broadcast"] = "__BCM_INIT__";
+    BcConnectEventTypeEnum2["Broadcast_Reply"] = "__BCM_INIT_REPLY__";
+    BcConnectEventTypeEnum2["Main_Node_Hearbeat"] = "__BCM_MAIN_NODE_HEARBEAT__";
+    BcConnectEventTypeEnum2["Res_Main_Node_Hearbeat"] = "__BCM_MAIN_NODE_HEARBEAT_REPLY__";
+    BcConnectEventTypeEnum2["Req_Be_Main_Node"] = "__BCM_REQ_BE_MAIN_NODE__";
+    BcConnectEventTypeEnum2["Res_Be_Main_Node"] = "__BCM_REQ_BE_MAIN_NODE_REJECT__";
+    BcConnectEventTypeEnum2["Node_Type_Change"] = "__BCM_NODE_TYPE_CHANGE__";
+    BcConnectEventTypeEnum2["Friend_List_Update"] = "__BCM_FRIEND_LIST_UPDATE__";
     return BcConnectEventTypeEnum2;
   })(BcConnectEventTypeEnum || {});
   var BcConnectNodeTypeEnum = /* @__PURE__ */ ((BcConnectNodeTypeEnum2) => {
@@ -24,25 +24,30 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
   const MessageTimeout = 300;
   class BroadcastChannelManager {
     constructor(name, debug = false) {
-      /** 通道名称 */
+      /** 通道名称 | Channel name */
       __publicField(this, "_bcName");
-      /** BroadcastChannel实例 */
+      /** BroadcastChannel instance */
       __publicField(this, "_broadcastChannel");
-      /** 事件map */
+      /** Event map */
       __publicField(this, "_eventMap");
-      /** 主节点发送心跳的interval */
+      /** 主节点发送心跳的interval | The interval at which the master node sends the heartbeat */
       __publicField(this, "_mainNodeMsgInterval", null);
-      /** 认为主节点掉线的timeout */
-      __publicField(this, "_mainNoceMsgTimeoutTimer", null);
-      /** 当前实例id */
+      /** 认为主节点掉线的timeout | timeout to consider the primary node to be offline */
+      __publicField(this, "_mainNodeMsgTimeoutTimer", null);
+      /** 更新友方列表的timeout | Update the timeout of the friend list */
+      __publicField(this, "_updateFriendListTimer", null);
+      /** 当前实例id | Current instance id */
       __publicField(this, "id", Date.now() + Math.random());
-      /** 记录的友方id数组 */
+      /** 其他广播通道id列表 | List of other broadcast channel ids */
       __publicField(this, "_oldFrendChannelIdList", []);
-      /** 正在更新的右方id数组 */
+      /** 正在更新的id数组 | The id array being updated */
       __publicField(this, "_friendChannelIdSet", /* @__PURE__ */ new Set());
-      /** 当前节点类型 */
+      /** 当前节点类型 | Current node type */
       __publicField(this, "_nodeType");
-      /** 是否开启调试模式，会在控制台打印相关信息 */
+      /**
+       * 是否开启调试模式，会在控制台打印相关信息
+       * If debug mode is enabled, it will print information to the console
+       */
       __publicField(this, "_debug", false);
       this._debug = debug;
       this._bcName = name;
@@ -65,9 +70,19 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     close() {
       this._debug && console.log("BC:bc close");
       this._broadcastChannel && this._broadcastChannel.close();
+      this._broadcastChannel = void 0;
+      this._updateFriendListTimer && clearTimeout(this._updateFriendListTimer);
+      this._updateFriendListTimer = null;
+      this._mainNodeMsgInterval && clearInterval(this._mainNodeMsgInterval);
+      this._mainNodeMsgInterval = null;
+      this._mainNodeMsgTimeoutTimer && clearTimeout(this._mainNodeMsgTimeoutTimer);
+      this._mainNodeMsgTimeoutTimer = null;
+      this._oldFrendChannelIdList = [];
+      this._friendChannelIdSet.clear();
+      this._nodeType = void 0;
     }
     /**
-     * 切换节点类型
+     * 切换节点类型 | Switching node type
      * @param {BcConnectNodeTypeEnum} type
      * @returns
      */
@@ -76,30 +91,31 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
         return;
       }
       this._nodeType = type;
-      this.emit("node type change", {
-        type: "node type change",
+      this.emit("__BCM_NODE_TYPE_CHANGE__", {
+        type: "__BCM_NODE_TYPE_CHANGE__",
         data: type,
         id: this.id
       });
     }
-    /** 更新友方列表 */
+    /** 更新广播id列表 | Update the list of broadcast ids */
     _updateFriendList() {
       this.send(
-        "Hello world"
+        "__BCM_INIT__"
         /* Broadcast */
       );
-      setTimeout(() => {
+      this._updateFriendListTimer && clearTimeout(this._updateFriendListTimer);
+      this._updateFriendListTimer = setTimeout(() => {
         this._oldFrendChannelIdList = this._getNewFriendList();
         this._debug && console.log("BC:connect:updateFriendChannelIdList:", this._oldFrendChannelIdList);
-        this.emit("friend list update", {
-          type: "friend list update",
+        this.emit("__BCM_FRIEND_LIST_UPDATE__", {
+          type: "__BCM_FRIEND_LIST_UPDATE__",
           data: [...this._oldFrendChannelIdList],
           id: this.id
         });
         this._updataNodeType();
       }, MessageTimeout);
     }
-    /** 绑定事件 */
+    /** 绑定事件 | Bind event */
     _bindBroadcastChannelEvent() {
       this._broadcastChannel && (this._broadcastChannel.onmessage = (event) => {
         const { type, targetId } = event.data;
@@ -108,63 +124,63 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
         }
         this.emit(type, event.data);
       });
-      this.on("Hello world", (data) => {
+      this.on("__BCM_INIT__", (data) => {
         const { id } = data;
         if (!this._friendChannelIdSet.has(id)) {
           this._friendChannelIdSet.add(id);
         }
-        this.sendToTarget("I can hear you", id);
+        this.sendToTarget("__BCM_INIT_REPLY__", id);
       });
-      this.on("I can hear you", (data) => {
+      this.on("__BCM_INIT_REPLY__", (data) => {
         const { id } = data;
         this._addFriend(id);
       });
-      this.on("苍天已死，黄天当立", (data) => {
+      this.on("__BCM_REQ_BE_MAIN_NODE__", (data) => {
         const { id } = data;
         if (id > this.id) {
-          this.sendToTarget("我是黄天，尔等退下", id);
+          this.sendToTarget("__BCM_REQ_BE_MAIN_NODE_REJECT__", id);
         }
       });
-      this.on("苍天在上，受我一拜", (data) => {
+      this.on("__BCM_MAIN_NODE_HEARBEAT_REPLY__", (data) => {
         this._addFriend(data.id);
       });
       this._bindNodeEvent();
     }
-    /** 监听节点类型切换事件 */
+    /** 监听节点类型切换事件 |  */
     _bindNodeEvent() {
       const onMainNodeHearbeat = (data) => {
         this._timeoutToBeMainNode();
         this._catchOldFriend();
         this._addFriend(data.id);
         this.send(
-          "苍天在上，受我一拜"
+          "__BCM_MAIN_NODE_HEARBEAT_REPLY__"
           /* Res_Main_Node_Hearbeat */
         );
       };
-      this.on("node type change", (info) => {
+      this.on("__BCM_NODE_TYPE_CHANGE__", (info) => {
         const { data } = info;
         this._mainNodeMsgInterval && clearInterval(this._mainNodeMsgInterval);
-        this._debug && console.log("BC:代理类型切换：", info.data);
+        this._debug && console.log("BC:NODE_TYPE_CHANGE：", info.data);
         if (data === "main") {
           this._mainNodeMsgInterval = setInterval(() => {
             this._catchOldFriend();
             this.send(
-              "苍天还在，别立黄天"
+              "__BCM_MAIN_NODE_HEARBEAT__"
               /* Main_Node_Hearbeat */
             );
           }, MessageTimeout);
         } else if (data === "normal") {
           this._timeoutToBeMainNode();
         }
-        this.on("苍天还在，别立黄天", onMainNodeHearbeat);
+        this.on("__BCM_MAIN_NODE_HEARBEAT__", onMainNodeHearbeat);
       });
     }
-    /** 获取最新的友方列表 */
+    /** 获取最新的节点列表 | Get the latest node list */
     _getNewFriendList() {
       return [...this._friendChannelIdSet].sort((a, b) => a - b);
     }
     /**
-     * 更新当前节点类型
+     * 更新当前节点类型 | Update the current node type
      */
     _updataNodeType() {
       this._mainNodeMsgInterval && clearInterval(this._mainNodeMsgInterval);
@@ -187,21 +203,21 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       }
     }
     _timeoutToBeMainNode() {
-      this._mainNoceMsgTimeoutTimer && clearTimeout(this._mainNoceMsgTimeoutTimer);
-      this._mainNoceMsgTimeoutTimer = setTimeout(() => {
+      this._mainNodeMsgTimeoutTimer && clearTimeout(this._mainNodeMsgTimeoutTimer);
+      this._mainNodeMsgTimeoutTimer = setTimeout(() => {
         this._req_beMainNode();
       }, MessageTimeout * 3);
     }
     /**
-     * 保持记录的活跃的友方id列表
-     * 清空正在记录的友方id列表
+     * 保存最新的节点列表到_oldFrendChannelIdList，清空_friendChannelIdSet
+     * Save the latest node list to _oldFrendChannelIdList and clear _friendChannelIdSet
      */
     _catchOldFriend() {
       const newFriendList = this._getNewFriendList();
       if (this._oldFrendChannelIdList.join() !== newFriendList.join()) {
         this._debug && console.log("BC:updateFriendChannelIdList:", newFriendList);
-        this.emit("friend list update", {
-          type: "friend list update",
+        this.emit("__BCM_FRIEND_LIST_UPDATE__", {
+          type: "__BCM_FRIEND_LIST_UPDATE__",
           data: [...newFriendList],
           id: this.id
         });
@@ -216,12 +232,12 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       this._friendChannelIdSet.clear();
     }
     /**
-     * 申请成为主节点
+     * 申请成为主节点 | Apply to be a master node
      */
     _req_beMainNode() {
       this._debug && console.log("BC:req_beMainNode");
       this.send(
-        "苍天已死，黄天当立"
+        "__BCM_REQ_BE_MAIN_NODE__"
         /* Req_Be_Main_Node */
       );
       const timer = setTimeout(() => {
@@ -232,13 +248,13 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       }, MessageTimeout);
       const handleRes_beMainNode = () => {
         clearTimeout(timer);
-        this.off("我是黄天，尔等退下", handleRes_beMainNode);
+        this.off("__BCM_REQ_BE_MAIN_NODE_REJECT__", handleRes_beMainNode);
       };
-      this.on("我是黄天，尔等退下", handleRes_beMainNode);
+      this.on("__BCM_REQ_BE_MAIN_NODE_REJECT__", handleRes_beMainNode);
     }
     /**
-     * 添加友方
-     * @param id 节点id
+     * add node
+     * @param id id
      */
     _addFriend(id) {
       if (!this._friendChannelIdSet.has(id)) {
@@ -246,9 +262,9 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       }
     }
     /**
-     * 广播消息
-     * @param type 消息类型
-     * @param data 数据
+     * 广播消息 | Send Broadcast message
+     * @param type 消息类型 | Message type
+     * @param data 数据 | data
      */
     send(type, data) {
       var _a;
@@ -259,10 +275,10 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       });
     }
     /**
-     * 给特定id的节点发送消息
-     * @param type 消息类型
-     * @param targetId 目标节点id
-     * @param data 数据
+     * 给特定id的节点发送消息 | Send a message to a node with a specific id
+     * @param type 消息类型 | Message type
+     * @param targetId 目标节点id | Target Node id
+     * @param data 数据 | data
      */
     sendToTarget(type, targetId, data) {
       var _a;
@@ -274,9 +290,9 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       });
     }
     /**
-     * 注册事件
-     * @param { string } event 事件类型
-     * @param callback 回调
+     * 注册事件 | Registering events
+     * @param { string } event 事件类型 | Event type
+     * @param callback 回调 | callback
      * @returns void
      */
     on(event, callback) {
@@ -291,9 +307,9 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       callbacks.push(callback);
     }
     /**
-     * 注销事件
-     * @param { string } event 事件类型
-     * @param callback 事件回调
+     * 注销事件 | Remove events
+     * @param { string } event 事件类型 | Event type
+     * @param callback 事件回调 | callback
      * @returns
      */
     off(event, callback) {
@@ -309,9 +325,9 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       callbacks.splice(index, 1);
     }
     /**
-     * 触发事件
-     * @param { string } event 事件类型
-     * @param data 数据
+     * 触发事件 | Triggering events
+     * @param { string } event 事件类型 | Event type
+     * @param data 数据 | data
      */
     emit(event, data) {
       const callbacks = this._eventMap.get(event) || [];
@@ -320,7 +336,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       });
     }
     /**
-     * 销毁
+     * 销毁 | destroy
      */
     destroy() {
       var _a;
@@ -334,8 +350,8 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       this._nodeType = void 0;
       this._mainNodeMsgInterval && clearInterval(this._mainNodeMsgInterval);
       this._mainNodeMsgInterval = null;
-      this._mainNoceMsgTimeoutTimer && clearInterval(this._mainNoceMsgTimeoutTimer);
-      this._mainNoceMsgTimeoutTimer = null;
+      this._mainNodeMsgTimeoutTimer && clearInterval(this._mainNodeMsgTimeoutTimer);
+      this._mainNodeMsgTimeoutTimer = null;
       this._debug && console.log("BC:destroy");
     }
   }

package/bc-connect/dist/types/src/manager.d.ts

@@ -1,61 +1,71 @@
-/** 事件数据类型 */
+/** 事件数据类型 | Event Datatypes */
 export type BcConnectSendMessageType = {
-    /** 事件类型 */
+    /** 事件类型 | type */
     type: string;
-    /** 数据 */
+    /** 数据 | data */
     data: any;
-    /** 发送事件的实例id */
+    /** 发送事件的实例id | BroadcastChannelManager instance id */
     id: number;
-    /** 消息是发送给目标实例id的 */
+    /** 此消息的目标实例id | The target instance id for this message */
     targetId?: number;
 };
-/** 事件类型 */
+/** 事件类型 | Event types */
 export declare enum BcConnectEventTypeEnum {
-    /** 初始广播 */
-    Broadcast = "Hello world",
-    /** 回复初始广播 */
-    Broadcast_Reply = "I can hear you",
-    /** 主节点心跳 */
-    Main_Node_Hearbeat = "\u82CD\u5929\u8FD8\u5728\uFF0C\u522B\u7ACB\u9EC4\u5929",
-    /** 回复主节点心跳 */
-    Res_Main_Node_Hearbeat = "\u82CD\u5929\u5728\u4E0A\uFF0C\u53D7\u6211\u4E00\u62DC",
-    /** 长时间未收到主节点心跳，我想当主节点，你们同意吗 */
-    Req_Be_Main_Node = "\u82CD\u5929\u5DF2\u6B7B\uFF0C\u9EC4\u5929\u5F53\u7ACB",
-    /** 排资论辈，我应是主节点，不同意 */
-    Res_Be_Main_Node = "\u6211\u662F\u9EC4\u5929\uFF0C\u5C14\u7B49\u9000\u4E0B",
-    /** 当前BC节点类型更改 */
-    Node_Type_Change = "node type change",
-    /** 其他标签页BC节点id列表更新 */
-    Friend_List_Update = "friend list update"
+    /** 初始广播 | Initial broadcast */
+    Broadcast = "__BCM_INIT__",
+    /** 回复初始广播 | Reply to initial broadcast */
+    Broadcast_Reply = "__BCM_INIT_REPLY__",
+    /** 主节点心跳 | Master node heartbeat */
+    Main_Node_Hearbeat = "__BCM_MAIN_NODE_HEARBEAT__",
+    /** 回复主节点心跳 | Reply to the master node heartbeat */
+    Res_Main_Node_Hearbeat = "__BCM_MAIN_NODE_HEARBEAT_REPLY__",
+    /**
+     * 长时间未收到主节点心跳，申请成为主节点
+     * It has not received the heartbeat of the master node for a long time.
+     *  Apply to become the master node
+     */
+    Req_Be_Main_Node = "__BCM_REQ_BE_MAIN_NODE__",
+    /** 拒绝其他节点成为主节点 | Reject other nodes as master nodes */
+    Res_Be_Main_Node = "__BCM_REQ_BE_MAIN_NODE_REJECT__",
+    /** 当前节点类型更改 | The current node type has changed */
+    Node_Type_Change = "__BCM_NODE_TYPE_CHANGE__",
+    /** 其他标签页BC节点id列表更新 | Other TAB node id list updated */
+    Friend_List_Update = "__BCM_FRIEND_LIST_UPDATE__"
 }
-/** 当前webview BroadcastChannel节点类型 */
+/** BroadcastChannel节点类型 | BroadcastChannel node type */
 export declare enum BcConnectNodeTypeEnum {
     Main = "main",
     Normal = "normal"
 }
 /**
  * 使用BroadcastChannel与其他标签页进行通信
+ * Use BroadcastChannel to communicate with other tabs
  */
 export declare class BroadcastChannelManager {
-    /** 通道名称 */
+    /** 通道名称 | Channel name */
     private _bcName;
-    /** BroadcastChannel实例 */
+    /** BroadcastChannel instance */
     private _broadcastChannel;
-    /** 事件map */
+    /** Event map */
     private _eventMap;
-    /** 主节点发送心跳的interval */
+    /** 主节点发送心跳的interval | The interval at which the master node sends the heartbeat */
     private _mainNodeMsgInterval;
-    /** 认为主节点掉线的timeout */
-    private _mainNoceMsgTimeoutTimer;
-    /** 当前实例id */
+    /** 认为主节点掉线的timeout | timeout to consider the primary node to be offline */
+    private _mainNodeMsgTimeoutTimer;
+    /** 更新友方列表的timeout | Update the timeout of the friend list */
+    private _updateFriendListTimer;
+    /** 当前实例id | Current instance id */
     id: number;
-    /** 记录的友方id数组 */
+    /** 其他广播通道id列表 | List of other broadcast channel ids */
     private _oldFrendChannelIdList;
-    /** 正在更新的右方id数组 */
+    /** 正在更新的id数组 | The id array being updated */
     private _friendChannelIdSet;
-    /** 当前节点类型 */
+    /** 当前节点类型 | Current node type */
     private _nodeType;
-    /** 是否开启调试模式，会在控制台打印相关信息 */
+    /**
+     * 是否开启调试模式，会在控制台打印相关信息
+     * If debug mode is enabled, it will print information to the console
+     */
     private _debug;
     constructor(name: string, debug?: boolean);
     get nodeType(): BcConnectNodeTypeEnum | undefined;
@@ -63,73 +73,73 @@ export declare class BroadcastChannelManager {
     connect(): void;
     close(): void;
     /**
-     * 切换节点类型
+     * 切换节点类型 | Switching node type
      * @param {BcConnectNodeTypeEnum} type
      * @returns
      */
     private _setNodeType;
-    /** 更新友方列表 */
+    /** 更新广播id列表 | Update the list of broadcast ids */
     private _updateFriendList;
-    /** 绑定事件 */
+    /** 绑定事件 | Bind event */
     private _bindBroadcastChannelEvent;
-    /** 监听节点类型切换事件 */
+    /** 监听节点类型切换事件 |  */
     private _bindNodeEvent;
-    /** 获取最新的友方列表 */
+    /** 获取最新的节点列表 | Get the latest node list */
     private _getNewFriendList;
     /**
-     * 更新当前节点类型
+     * 更新当前节点类型 | Update the current node type
      */
     private _updataNodeType;
     private _timeoutToBeMainNode;
     /**
-     * 保持记录的活跃的友方id列表
-     * 清空正在记录的友方id列表
+     * 保存最新的节点列表到_oldFrendChannelIdList，清空_friendChannelIdSet
+     * Save the latest node list to _oldFrendChannelIdList and clear _friendChannelIdSet
      */
     private _catchOldFriend;
     /**
-     * 申请成为主节点
+     * 申请成为主节点 | Apply to be a master node
      */
     private _req_beMainNode;
     /**
-     * 添加友方
-     * @param id 节点id
+     * add node
+     * @param id id
      */
     _addFriend(id: number): void;
     /**
-     * 广播消息
-     * @param type 消息类型
-     * @param data 数据
+     * 广播消息 | Send Broadcast message
+     * @param type 消息类型 | Message type
+     * @param data 数据 | data
      */
     send(type: string, data?: any): void;
     /**
-     * 给特定id的节点发送消息
-     * @param type 消息类型
-     * @param targetId 目标节点id
-     * @param data 数据
+     * 给特定id的节点发送消息 | Send a message to a node with a specific id
+     * @param type 消息类型 | Message type
+     * @param targetId 目标节点id | Target Node id
+     * @param data 数据 | data
      */
     sendToTarget(type: string, targetId: number, data?: any): void;
     /**
-     * 注册事件
-     * @param { string } event 事件类型
-     * @param callback 回调
+     * 注册事件 | Registering events
+     * @param { string } event 事件类型 | Event type
+     * @param callback 回调 | callback
      * @returns void
      */
     on(event: string, callback: (_: BcConnectSendMessageType) => void): void;
     /**
-     * 注销事件
-     * @param { string } event 事件类型
-     * @param callback 事件回调
+     * 注销事件 | Remove events
+     * @param { string } event 事件类型 | Event type
+     * @param callback 事件回调 | callback
      * @returns
      */
     off(event: string, callback?: (_: BcConnectSendMessageType) => void): void;
     /**
-     * 触发事件
-     * @param { string } event 事件类型
-     * @param data 数据
+     * 触发事件 | Triggering events
+     * @param { string } event 事件类型 | Event type
+     * @param data 数据 | data
      */
     emit(event: string, data: BcConnectSendMessageType): void;
     /**
-     * 销毁
+     * 销毁 | destroy
      */
     destroy(): void;
 }

package/bc-connect/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@havue/bc-connect",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Javascript class for Broadcast channel connect",
   "keywords": [
     "havue",