@rtc-agent/component 0.2.7-rc.4 → 0.2.8-rc.0

package/dist/master-lock.d.ts

@@ -1,28 +1,28 @@
 /**
- * MasterLock: 基于 Web Locks API 的 Master Tab 选举
+ * MasterLock: Master Tab election based on Web Locks API.
  *
- * 设计原则：
- * - 每个 Tab 各自持有一个 MasterLock，自己判断是否为 Master
- * - Worker 不参与选举，不知道也不关心谁是 Master
- * - Tab 关闭 → 浏览器自动释放锁 → 其他 Tab 排队获得 → 自动升级
- * - 锁名含 userId，多用户隔离
+ * Design principles:
+ * - Each Tab holds its own MasterLock; the Tab itself decides whether it is the Master.
+ * - Workers do not participate in the election — they neither know nor care who the Master is.
+ * - Tab closes -> browser auto-releases the lock -> other Tabs acquire it in queue order -> auto-upgrade.
+ * - Lock name contains userId for multi-user isolation.
  *
- * 用法：
+ * Usage:
  * ```ts
  * const lock = new MasterLock('user-123');
  * lock.onAcquire = () => { console.log('became master'); };
  * lock.onRelease = () => { console.log('lost master'); };
- * await lock.acquire();  // 开始尝试获取锁（可能排队）
+ * await lock.acquire();  // Start trying to acquire the lock (may queue)
  * // ... later
- * lock.release();        // 主动释放（Tab 关闭时浏览器自动释放）
+ * lock.release();        // Actively release (browser auto-releases when Tab closes)
  * ```
  *
  * @see docs/shared-worker-proposal.md §4.3
  */
 export interface MasterLockCallbacks {
-    /** 获得锁 → 成为 Master */
+    /** Acquired lock -> become Master */
     onAcquire?: () => void;
-    /** 失去锁 → 降级为非 Master */
+    /** Lost lock -> demote to non-Master */
     onRelease?: () => void;
 }
 export declare class MasterLock {
@@ -30,43 +30,43 @@ export declare class MasterLock {
     private _isMaster;
     private _controlled;
     private _abortController?;
-    /** 获得锁时的回调 */
+    /** Callback invoked when the lock is acquired */
     onAcquire?: () => void;
-    /** 失去锁时的回调 */
+    /** Callback invoked when the lock is lost */
     onRelease?: () => void;
     constructor(userId: string);
     /**
-     * 当前 Tab 是否为 Master
+     * Whether the current Tab is the Master.
      */
     get isMaster(): boolean;
     /**
-     * 是否已经开始选举流程（调用了 acquire）
+     * Whether the election process has started (i.e. acquire() was called).
      */
     get isControlled(): boolean;
     /**
-     * 开始尝试获取 Master 锁
+     * Start attempting to acquire the Master lock.
      *
-     * - 如果没有其他 Master，立即获得锁
-     * - 如果已有 Master，排队等待（浏览器调度，零轮询）
-     * - 获得锁后调用 onAcquire 回调
-     * - Tab 关闭 → 浏览器自动释放 → 排队的 Tab 获得锁
+     * - If no other Master exists, the lock is acquired immediately.
+     * - If a Master already exists, queue and wait (browser-scheduled, zero polling).
+     * - Calls onAcquire callback once the lock is obtained.
+     * - Tab closes -> browser auto-releases -> queued Tab acquires the lock.
      *
-     * 幂等：多次调用只有第一次生效。
+     * Idempotent: only the first call takes effect; subsequent calls are ignored.
      */
     acquire(): Promise<void>;
     /**
-     * 主动释放 Master 锁
+     * Actively release the Master lock.
      *
-     * - 如果当前是 Master → 释放锁 → 触发 onRelease
-     * - 如果正在排队 → 取消排队（abort）
-     * - 如果已经不是 Master → no-op
+     * - If currently Master -> release the lock -> trigger onRelease.
+     * - If still queuing -> cancel the queue (abort).
+     * - If already not Master -> no-op.
      */
     release(): void;
     /**
-     * 检测 Web Locks API 是否可用
+     * Check whether the Web Locks API is available.
      */
     private _isWebLocksAvailable;
-    /** 用于解除 acquire callback 中的阻塞 */
+    /** Used to unblock the acquire callback's await */
     private _releaseResolve?;
 }
 //# sourceMappingURL=master-lock.d.ts.map

package/dist/master-lock.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"master-lock.d.ts","sourceRoot":"","sources":["../src/master-lock.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAOH,MAAM,WAAW,mBAAmB;IAChC,sBAAsB;IACtB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,wBAAwB;IACxB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;CAC1B;AAED,qBAAa,UAAU;IACnB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,gBAAgB,CAAC,CAAkB;IAE3C,cAAc;IACd,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,cAAc;IACd,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;gBAEX,MAAM,EAAE,MAAM;IAI1B;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED;;;;;;;;;OASG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAqD9B;;;;;;OAMG;IACH,OAAO,IAAI,IAAI;IAmBf;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAI5B,iCAAiC;IACjC,OAAO,CAAC,eAAe,CAAC,CAAa;CACxC"}
+{"version":3,"file":"master-lock.d.ts","sourceRoot":"","sources":["../src/master-lock.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAOH,MAAM,WAAW,mBAAmB;IAChC,qCAAqC;IACrC,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,wCAAwC;IACxC,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;CAC1B;AAED,qBAAa,UAAU;IACnB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,gBAAgB,CAAC,CAAkB;IAE3C,iDAAiD;IACjD,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,6CAA6C;IAC7C,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;gBAEX,MAAM,EAAE,MAAM;IAI1B;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED;;;;;;;;;OASG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAqD9B;;;;;;OAMG;IACH,OAAO,IAAI,IAAI;IAmBf;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAI5B,mDAAmD;IACnD,OAAO,CAAC,eAAe,CAAC,CAAa;CACxC"}