lib0 0.2.49 → 0.2.52

package/.github/workflows/node.js.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x, 14.x]
+        node-version: [18.x]
 
     steps:
     - uses: actions/checkout@v2

package/README.md

@@ -12,7 +12,7 @@ export const stringify = JSON.stringify
 export const parse = JSON.parse
 
 // index.js
-import * as json from 'lib0/json.js'
+import * as json from 'lib0/json'
 export const f = (arg1, arg2) => json.stringify(arg1) + json.stringify(arg2)
 
 // compiled with rollup and uglifyjs:
@@ -177,11 +177,11 @@ broadcastchannel.publish('my events', 'Hello world!') // => A: 'Hello world!' fi
 broadcastchannel.publish('my events', 'hello from tab B') // => A: 'hello from tab B'
 </code></pre>
 <dl>
-<b><code>broadcastchannel.subscribe(room: string, f: function(any):any)</code></b><br>
+<b><code>broadcastchannel.subscribe(room: string, f: function(any, any):any)</code></b><br>
 <dd><p>Subscribe to global <code>publish</code> events.</p></dd>
-<b><code>broadcastchannel.unsubscribe(room: string, f: function(any):any)</code></b><br>
+<b><code>broadcastchannel.unsubscribe(room: string, f: function(any, any):any)</code></b><br>
 <dd><p>Unsubscribe from <code>publish</code> global events.</p></dd>
-<b><code>broadcastchannel.publish(room: string, data: any)</code></b><br>
+<b><code>broadcastchannel.publish(room: string, data: any, origin: any)</code></b><br>
 <dd><p>Publish data to all subscribers (including subscribers on this tab)</p></dd>
 </dl>
 </details>
@@ -321,15 +321,7 @@ to the next byte and read it as unsigned integer.</p></dd>
 <dd><p>Look ahead and read varUint without incrementing position</p></dd>
 <b><code>decoding.peekVarInt(decoder: module:decoding.Decoder): number</code></b><br>
 <dd><p>Look ahead and read varUint without incrementing position</p></dd>
-<b><code>decoding.readVarString(decoder: module:decoding.Decoder): String</code></b><br>
-<dd><p>Read string of variable length</p>
-<ul>
-<li>varUint is used to store the length of the string</li>
-</ul>
-<p>Transforming utf8 to a string is pretty expensive. The code performs 10x better
-when String.fromCodePoint is fed with all characters as arguments.
-But most environments have a maximum number of arguments per functions.
-For effiency reasons we apply a maximum of 10000 characters at once.</p></dd>
+<b><code>decoding.readVarString</code></b><br>
 <b><code>decoding.peekVarString(decoder: module:decoding.Decoder): string</code></b><br>
 <dd><p>Look ahead and read varString without incrementing position</p></dd>
 <b><code>decoding.readFromDataView(decoder: module:decoding.Decoder, len: number): DataView</code></b><br>
@@ -480,6 +472,9 @@ decoding.hasContent(decoder) // => false - all data is read
 <dd><p>The current length of the encoded data.</p></dd>
 <b><code>encoding.toUint8Array(encoder: module:encoding.Encoder): Uint8Array</code></b><br>
 <dd><p>Transform to Uint8Array.</p></dd>
+<b><code>encoding.verifyLen(encoder: module:encoding.Encoder, len: number)</code></b><br>
+<dd><p>Verify that it is possible to write <code>len</code> bytes wtihout checking. If
+necessary, a new Buffer with the required length is attached.</p></dd>
 <b><code>encoding.write(encoder: module:encoding.Encoder, num: number)</code></b><br>
 <dd><p>Write one byte to the encoder.</p></dd>
 <b><code>encoding.set(encoder: module:encoding.Encoder, pos: number, num: number)</code></b><br>
@@ -501,16 +496,11 @@ Position must already be written (i.e. encoder.length &gt; pos)</p></dd>
 <b><code>encoding.setUint32(encoder: module:encoding.Encoder, pos: number, num: number)</code></b><br>
 <dd><p>Write two bytes as an unsigned integer at a specific location.</p></dd>
 <b><code>encoding.writeVarUint(encoder: module:encoding.Encoder, num: number)</code></b><br>
-<dd><p>Write a variable length unsigned integer.</p>
-<p>Encodes integers in the range from [0, 4294967295] / [0, 0xffffffff]. (max 32 bit unsigned integer)</p></dd>
+<dd><p>Write a variable length unsigned integer. Max encodable integer is 2^53.</p></dd>
 <b><code>encoding.writeVarInt(encoder: module:encoding.Encoder, num: number)</code></b><br>
 <dd><p>Write a variable length integer.</p>
-<p>Encodes integers in the range from [-2147483648, -2147483647].</p>
-<p>We don't use zig-zag encoding because we want to keep the option open
-to use the same function for BigInt and 53bit integers (doubles).</p>
 <p>We use the 7th bit instead for signaling that this is a negative number.</p></dd>
-<b><code>encoding.writeVarString(encoder: module:encoding.Encoder, str: String)</code></b><br>
-<dd><p>Write a variable length string.</p></dd>
+<b><code>encoding.writeVarString</code></b><br>
 <b><code>encoding.writeBinaryEncoder(encoder: module:encoding.Encoder, append: module:encoding.Encoder)</code></b><br>
 <dd><p>Write the content of another Encoder.</p></dd>
 <b><code>encoding.writeUint8Array(encoder: module:encoding.Encoder, uint8Array: Uint8Array)</code></b><br>
@@ -819,11 +809,16 @@ In practice, when decoding several million small strings, the GC will kick in mo
 <b><code>()</code></b><br>
 <b><code>(queue: module:list.List&lt;N&gt;)</code></b><br>
 <b><code>()</code></b><br>
-<b><code>ode(queue: module:list.List&lt;N&gt;, node: N)</code></b><br>
+<b><code>(queue: module:list.List&lt;N&gt;, node: N)</code></b><br>
 <dd><p>Remove a single node from the queue. Only works with Queues that operate on Doubly-linked lists of nodes.</p></dd>
+<b><code>()</code></b><br>
+<b><code>ode</code></b><br>
 <b><code>ode()</code></b><br>
 <b><code>etween(queue: module:list.List&lt;N&gt;, left: N| null, right: N| null, node: N)</code></b><br>
 <b><code>etween()</code></b><br>
+<b><code>(queue: module:list.List&lt;N&gt;, node: N, newNode: N)</code></b><br>
+<dd><p>Remove a single node from the queue. Only works with Queues that operate on Doubly-linked lists of nodes.</p></dd>
+<b><code>()</code></b><br>
 <b><code>(queue: module:list.List&lt;N&gt;, n: N)</code></b><br>
 <b><code>()</code></b><br>
 <b><code>nt(queue: module:list.List&lt;N&gt;, n: N)</code></b><br>
@@ -834,6 +829,10 @@ In practice, when decoding several million small strings, the GC will kick in mo
 <b><code>()</code></b><br>
 <b><code>(list: module:list.List&lt;N&gt;, f: function(N):M): Array&lt;M&gt;</code></b><br>
 <b><code>()</code></b><br>
+<b><code>(list: module:list.List&lt;N&gt;)</code></b><br>
+<b><code>()</code></b><br>
+<b><code>(list: module:list.List&lt;N&gt;, f: function(N):M)</code></b><br>
+<b><code>()</code></b><br>
 </dl>
 </details>
 <details><summary><b>[lib0/logging]</b> Isomorphic logging module with support for colors!</summary>
@@ -1098,6 +1097,7 @@ library has some insane environment where global Promise objects are overwritten
 <dl>
 <b><code>random.rand</code></b><br>
 <b><code>random.uint32</code></b><br>
+<b><code>random.uint53</code></b><br>
 <b><code>random.oneOf(arr: Array&lt;T&gt;): T</code></b><br>
 <b><code>random.uuidv4</code></b><br>
 </dl>
@@ -1170,8 +1170,8 @@ integrate this algorithm.</p>
 <pre>import * as testing from 'lib0/testing'</pre>
 
 <pre class="prettyprint source lang-js"><code>// test.js template for creating a test executable
-import { runTests } from 'lib0/testing.js'
-import * as log from 'lib0/logging.js'
+import { runTests } from 'lib0/testing'
+import * as log from 'lib0/logging'
 import * as mod1 from './mod1.test.js'
 import * as mod2 from './mod2.test.js'
 import { isBrowser, isNode } from 'lib0/environment.js'

package/broadcastchannel.d.ts

@@ -1,8 +1,8 @@
-export function subscribe(room: string, f: (arg0: any) => any): Set<Function>;
-export function unsubscribe(room: string, f: (arg0: any) => any): boolean;
-export function publish(room: string, data: any): void;
+export function subscribe(room: string, f: (arg0: any, arg1: any) => any): Set<(arg0: any, arg1: any) => any>;
+export function unsubscribe(room: string, f: (arg0: any, arg1: any) => any): boolean;
+export function publish(room: string, data: any, origin?: any): void;
 export type Channel = {
-    subs: Set<Function>;
+    subs: Set<(arg0: any, arg1: any) => any>;
     bc: any;
 };
 //# sourceMappingURL=broadcastchannel.d.ts.map

package/broadcastchannel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"broadcastchannel.d.ts","sourceRoot":"","sources":["broadcastchannel.js"],"names":[],"mappings":"AAkFO,gCAHI,MAAM,YACG,GAAG,KAAE,GAAG,iBAEsC;AAS3D,kCAHI,MAAM,YACG,GAAG,KAAE,GAAG,WAE2C;AAShE,8BAHI,MAAM,QACN,GAAG,QAMb;;UA/Ea,aAAa;QACb,GAAG"}
+{"version":3,"file":"broadcastchannel.d.ts","sourceRoot":"","sources":["broadcastchannel.js"],"names":[],"mappings":"AAkFO,gCAHI,MAAM,YACG,GAAG,QAAE,GAAG,KAAE,GAAG,cAvDN,GAAG,QAAE,GAAG,KAAE,GAAG,EAyD0B;AAS3D,kCAHI,MAAM,YACG,GAAG,QAAE,GAAG,KAAE,GAAG,WAEsC;AAUhE,8BAJI,MAAM,QACN,GAAG,WACH,GAAG,QAMb;;UAhFa,WAAa,GAAG,QAAE,GAAG,KAAE,GAAG,CAAC;QAC3B,GAAG"}

package/broadcastchannel.js

@@ -23,7 +23,7 @@ import * as storage from './storage.js'
 
 /**
  * @typedef {Object} Channel
- * @property {Set<Function>} Channel.subs
+ * @property {Set<function(any, any):any>} Channel.subs
  * @property {any} Channel.bc
  */
 
@@ -67,7 +67,7 @@ const getChannel = room =>
     /**
      * @param {{data:ArrayBuffer}} e
      */
-    bc.onmessage = e => subs.forEach(sub => sub(e.data))
+    bc.onmessage = e => subs.forEach(sub => sub(e.data, 'broadcastchannel'))
     return {
       bc, subs
     }
@@ -78,7 +78,7 @@ const getChannel = room =>
  *
  * @function
  * @param {string} room
- * @param {function(any):any} f
+ * @param {function(any, any):any} f
  */
 export const subscribe = (room, f) => getChannel(room).subs.add(f)
 
@@ -87,7 +87,7 @@ export const subscribe = (room, f) => getChannel(room).subs.add(f)
  *
  * @function
  * @param {string} room
- * @param {function(any):any} f
+ * @param {function(any, any):any} f
  */
 export const unsubscribe = (room, f) => getChannel(room).subs.delete(f)
 
@@ -97,9 +97,10 @@ export const unsubscribe = (room, f) => getChannel(room).subs.delete(f)
  * @function
  * @param {string} room
  * @param {any} data
+ * @param {any} [origin]
  */
-export const publish = (room, data) => {
+export const publish = (room, data, origin = null) => {
   const c = getChannel(room)
   c.bc.postMessage(data)
-  c.subs.forEach(sub => sub(data))
+  c.subs.forEach(sub => sub(data, origin))
 }

package/decoding.d.ts

@@ -37,6 +37,8 @@ export function readVarUint(decoder: Decoder): number;
 export function readVarInt(decoder: Decoder): number;
 export function peekVarUint(decoder: Decoder): number;
 export function peekVarInt(decoder: Decoder): number;
+export function _readVarStringPolyfill(decoder: Decoder): string;
+export function _readVarStringNative(decoder: Decoder): string;
 export function readVarString(decoder: Decoder): string;
 export function peekVarString(decoder: Decoder): string;
 export function readFromDataView(decoder: Decoder, len: number): DataView;

package/decoding.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decoding.d.ts","sourceRoot":"","sources":["decoding.js"],"names":[],"mappings":"AAgCA;;GAEG;AACH;IACE;;OAEG;IACH,wBAFW,UAAU,EAepB;IAZC;;;;OAIG;IACH,KAFU,UAAU,CAEC;IACrB;;;;OAIG;IACH,KAFU,MAAM,CAEJ;CAEf;AAOM,0CAHI,UAAU,GACT,OAAO,CAE+C;AAO3D,oCAHI,OAAO,GACN,OAAO,CAEoD;AAWhE,+BAJI,OAAO,gCAEN,OAAO,CAMlB;AAaM,wCAJI,OAAO,OACP,MAAM,GACL,UAAU,CAMrB;AAYM,2CAHI,OAAO,GACN,UAAU,CAEmE;AAQlF,8CAHI,OAAO,GACN,UAAU,CAEkF;AAQjG,+BAHI,OAAO,GACN,MAAM,CAE2B;AAQtC,mCAHI,OAAO,GACN,MAAM,CAE4C;AASvD,oCAHI,OAAO,GACN,MAAM,CAQjB;AASM,oCAHI,OAAO,GACN,MAAM,CAUjB;AAUM,6CAHI,OAAO,GACN,MAAM,CAUjB;AAUM,mCAHI,OAAO,GACN,MAAM,CAE0C;AAUrD,oCAHI,OAAO,GACN,MAAM,CAImB;AAU9B,oCAHI,OAAO,GACN,MAAM,CAOX;AAYA,qCAHI,OAAO,GACN,MAAM,CAiBjB;AAaM,oCAHI,OAAO,GACN,MAAM,CAuBjB;AASM,qCAHI,OAAO,GACN,MAAM,CAOjB;AASM,oCAHI,OAAO,GACN,MAAM,CAOjB;AAeM,uCAHI,OAAO,UA0BjB;AASM,uCAHI,OAAO,GACN,MAAM,CAOjB;AAOM,0CAJI,OAAO,OACP,MAAM,GACL,QAAQ,CAMnB;AAKM,qCAFI,OAAO,UAEqE;AAKhF,qCAFI,OAAO,UAEqE;AAKhF,sCAFI,OAAO,OAE4F;AAKvG,uCAFI,OAAO,OAE8F;AAyCzG,iCAFI,OAAO,OAEqE;AAEvF;;;;GAIG;AACH;IACE;;;OAGG;IACH,wBAHW,UAAU,iBACD,OAAO,KAAE,CAAC,EAc7B;IAVC;;OAEG;IACH,eAPkB,OAAO,KAAE,CAAC,CAOR;IACpB;;;OAGG;IACH,GAFU,CAAC,GAAC,IAAI,CAEH;IACb,cAAc;IAGhB,UAWC;CACF;AAED;IACE;;;OAGG;IACH,wBAHW,UAAU,SACV,MAAM,EAShB;IALC;;;OAGG;IACH,GAFU,MAAM,CAEF;IAGhB;;OAEG;IACH,QAFY,MAAM,CAKjB;CACF;AAED;IACE;;;OAGG;IACH,wBAHW,UAAU,SACV,MAAM,EAUhB;IANC;;;OAGG;IACH,GAFU,MAAM,CAEF;IACd,cAAc;IAGhB;;OAEG;IACH,QAFY,MAAM,CAajB;CACF;AAED;IAMI;;OAEG;IACH,GAFU,MAAM,CAEN;IACV,cAAc;IAGhB,eAaC;CACF;AAED;IAMI;;OAEG;IACH,GAFU,MAAM,CAEN;IACV,cAAc;IAGhB,eAaC;CACF;AAED;IAMI;;OAEG;IACH,GAFU,MAAM,CAEN;IACV,cAAc;IACd,aAAa;IAGf;;OAEG;IACH,QAFY,MAAM,CAgBjB;CACF;AAED;IACE;;OAEG;IACH,wBAFW,UAAU,EASpB;IANC,2BAAgD;IAChD,YAAsC;IACtC;;OAEG;IACH,MAFU,MAAM,CAEH;IAGf;;OAEG;IACH,QAFY,MAAM,CAOjB;CACF"}
+{"version":3,"file":"decoding.d.ts","sourceRoot":"","sources":["decoding.js"],"names":[],"mappings":"AAkCA;;GAEG;AACH;IACE;;OAEG;IACH,wBAFW,UAAU,EAepB;IAZC;;;;OAIG;IACH,KAFU,UAAU,CAEC;IACrB;;;;OAIG;IACH,KAFU,MAAM,CAEJ;CAEf;AAOM,0CAHI,UAAU,GACT,OAAO,CAE+C;AAO3D,oCAHI,OAAO,GACN,OAAO,CAEoD;AAWhE,+BAJI,OAAO,gCAEN,OAAO,CAMlB;AAaM,wCAJI,OAAO,OACP,MAAM,GACL,UAAU,CAMrB;AAYM,2CAHI,OAAO,GACN,UAAU,CAEmE;AAQlF,8CAHI,OAAO,GACN,UAAU,CAEkF;AAQjG,+BAHI,OAAO,GACN,MAAM,CAE2B;AAQtC,mCAHI,OAAO,GACN,MAAM,CAE4C;AASvD,oCAHI,OAAO,GACN,MAAM,CAQjB;AASM,oCAHI,OAAO,GACN,MAAM,CAUjB;AAUM,6CAHI,OAAO,GACN,MAAM,CAUjB;AAUM,mCAHI,OAAO,GACN,MAAM,CAE0C;AAUrD,oCAHI,OAAO,GACN,MAAM,CAImB;AAU9B,oCAHI,OAAO,GACN,MAAM,CAOX;AAYA,qCAHI,OAAO,GACN,MAAM,CAkBjB;AAaM,oCAHI,OAAO,GACN,MAAM,CAwBjB;AASM,qCAHI,OAAO,GACN,MAAM,CAOjB;AASM,oCAHI,OAAO,GACN,MAAM,CAOjB;AAgBM,gDAJI,OAAO,UA2BjB;AAOM,8CAHI,OAAO,UAI4D;AA/BvE,uCAJI,OAAO,UA2BjB;AA6BM,uCAHI,OAAO,GACN,MAAM,CAOjB;AAOM,0CAJI,OAAO,OACP,MAAM,GACL,QAAQ,CAMnB;AAKM,qCAFI,OAAO,UAEqE;AAKhF,qCAFI,OAAO,UAEqE;AAKhF,sCAFI,OAAO,OAE4F;AAKvG,uCAFI,OAAO,OAE8F;AAyCzG,iCAFI,OAAO,OAEqE;AAEvF;;;;GAIG;AACH;IACE;;;OAGG;IACH,wBAHW,UAAU,iBACD,OAAO,KAAE,CAAC,EAc7B;IAVC;;OAEG;IACH,eAPkB,OAAO,KAAE,CAAC,CAOR;IACpB;;;OAGG;IACH,GAFU,CAAC,GAAC,IAAI,CAEH;IACb,cAAc;IAGhB,UAWC;CACF;AAED;IACE;;;OAGG;IACH,wBAHW,UAAU,SACV,MAAM,EAShB;IALC;;;OAGG;IACH,GAFU,MAAM,CAEF;IAGhB;;OAEG;IACH,QAFY,MAAM,CAKjB;CACF;AAED;IACE;;;OAGG;IACH,wBAHW,UAAU,SACV,MAAM,EAUhB;IANC;;;OAGG;IACH,GAFU,MAAM,CAEF;IACd,cAAc;IAGhB;;OAEG;IACH,QAFY,MAAM,CAajB;CACF;AAED;IAMI;;OAEG;IACH,GAFU,MAAM,CAEN;IACV,cAAc;IAGhB,eAaC;CACF;AAED;IAMI;;OAEG;IACH,GAFU,MAAM,CAEN;IACV,cAAc;IAGhB,eAaC;CACF;AAED;IAMI;;OAEG;IACH,GAFU,MAAM,CAEN;IACV,cAAc;IACd,aAAa;IAGf;;OAEG;IACH,QAFY,MAAM,CAgBjB;CACF;AAED;IACE;;OAEG;IACH,wBAFW,UAAU,EASpB;IANC,2BAAgD;IAChD,YAAsC;IACtC;;OAEG;IACH,MAFU,MAAM,CAEH;IAGf;;OAEG;IACH,QAFY,MAAM,CAOjB;CACF"}

package/decoding.js

@@ -29,6 +29,8 @@
 import * as buffer from './buffer.js'
 import * as binary from './binary.js'
 import * as math from './math.js'
+import * as number from './number.js'
+import * as string from './string.js'
 
 /**
  * A Decoder handles the decoding of an Uint8Array.
@@ -234,16 +236,17 @@ export const peekUint32 = decoder => (
  */
 export const readVarUint = decoder => {
   let num = 0
-  let len = 0
+  let mult = 1
   while (true) {
     const r = decoder.arr[decoder.pos++]
-    num = num | ((r & binary.BITS7) << len)
-    len += 7
+    // num = num | ((r & binary.BITS7) << len)
+    num = num + (r & binary.BITS7) * mult // shift $r << (7*#iterations) and add it to num
+    mult *= 128 // next iteration, shift 7 "more" to the left
     if (r < binary.BIT8) {
-      return num >>> 0 // return unsigned number!
+      return num
     }
     /* istanbul ignore if */
-    if (len > 53) {
+    if (num > number.MAX_SAFE_INTEGER) {
       throw new Error('Integer out of range!')
     }
   }
@@ -263,7 +266,7 @@ export const readVarUint = decoder => {
 export const readVarInt = decoder => {
   let r = decoder.arr[decoder.pos++]
   let num = r & binary.BITS6
-  let len = 6
+  let mult = 64
   const sign = (r & binary.BIT7) > 0 ? -1 : 1
   if ((r & binary.BIT8) === 0) {
     // don't continue reading
@@ -271,13 +274,14 @@ export const readVarInt = decoder => {
   }
   while (true) {
     r = decoder.arr[decoder.pos++]
-    num = num | ((r & binary.BITS7) << len)
-    len += 7
+    // num = num | ((r & binary.BITS7) << len)
+    num = num + (r & binary.BITS7) * mult
+    mult *= 128
     if (r < binary.BIT8) {
-      return sign * (num >>> 0)
+      return sign * num
     }
     /* istanbul ignore if */
-    if (len > 53) {
+    if (num > number.MAX_SAFE_INTEGER) {
       throw new Error('Integer out of range!')
     }
   }
@@ -312,8 +316,8 @@ export const peekVarInt = decoder => {
 }
 
 /**
- * Read string of variable length
- * * varUint is used to store the length of the string
+ * We don't test this function anymore as we use native decoding/encoding by default now.
+ * Better not modify this anymore..
  *
  * Transforming utf8 to a string is pretty expensive. The code performs 10x better
  * when String.fromCodePoint is fed with all characters as arguments.
@@ -324,7 +328,8 @@ export const peekVarInt = decoder => {
  * @param {Decoder} decoder
  * @return {String} The read String.
  */
-export const readVarString = decoder => {
+/* istanbul ignore next */
+export const _readVarStringPolyfill = decoder => {
   let remainingLen = readVarUint(decoder)
   if (remainingLen === 0) {
     return ''
@@ -349,6 +354,26 @@ export const readVarString = decoder => {
   }
 }
 
+/**
+ * @function
+ * @param {Decoder} decoder
+ * @return {String} The read String
+ */
+export const _readVarStringNative = decoder =>
+  /** @type any */ (string.utf8TextDecoder).decode(readVarUint8Array(decoder))
+
+/**
+ * Read string of variable length
+ * * varUint is used to store the length of the string
+ *
+ * @function
+ * @param {Decoder} decoder
+ * @return {String} The read String
+ *
+ */
+/* istanbul ignore next */
+export const readVarString = string.utf8TextDecoder ? _readVarStringNative : _readVarStringPolyfill
+
 /**
  * Look ahead and read varString without incrementing position
  *
@@ -608,7 +633,7 @@ export class IntDiffOptRleDecoder extends Decoder {
       const diff = readVarInt(this)
       // if the first bit is set, we read more data
       const hasCount = diff & 1
-      this.diff = diff >> 1
+      this.diff = math.floor(diff / 2) // shift >> 1
       this.count = 1
       if (hasCount) {
         this.count = readVarUint(this) + 2

package/dist/{broadcastchannel-1ac6c212.cjs → broadcastchannel-7655b66f.cjs}

@@ -1,14 +1,14 @@
 'use strict';
 
 var map = require('./map-28a001c9.cjs');
-var encoding = require('./buffer-c98f67d5.cjs');
+var encoding = require('./buffer-d3ba308b.cjs');
 var storage = require('./storage.cjs');
 
 /* eslint-env browser */
 
 /**
  * @typedef {Object} Channel
- * @property {Set<Function>} Channel.subs
+ * @property {Set<function(any, any):any>} Channel.subs
  * @property {any} Channel.bc
  */
 
@@ -52,7 +52,7 @@ const getChannel = room =>
     /**
      * @param {{data:ArrayBuffer}} e
      */
-    bc.onmessage = e => subs.forEach(sub => sub(e.data));
+    bc.onmessage = e => subs.forEach(sub => sub(e.data, 'broadcastchannel'));
     return {
       bc, subs
     }
@@ -63,7 +63,7 @@ const getChannel = room =>
  *
  * @function
  * @param {string} room
- * @param {function(any):any} f
+ * @param {function(any, any):any} f
  */
 const subscribe = (room, f) => getChannel(room).subs.add(f);
 
@@ -72,7 +72,7 @@ const subscribe = (room, f) => getChannel(room).subs.add(f);
  *
  * @function
  * @param {string} room
- * @param {function(any):any} f
+ * @param {function(any, any):any} f
  */
 const unsubscribe = (room, f) => getChannel(room).subs.delete(f);
 
@@ -82,11 +82,12 @@ const unsubscribe = (room, f) => getChannel(room).subs.delete(f);
  * @function
  * @param {string} room
  * @param {any} data
+ * @param {any} [origin]
  */
-const publish = (room, data) => {
+const publish = (room, data, origin = null) => {
   const c = getChannel(room);
   c.bc.postMessage(data);
-  c.subs.forEach(sub => sub(data));
+  c.subs.forEach(sub => sub(data, origin));
 };
 
 var broadcastchannel = /*#__PURE__*/Object.freeze({
@@ -100,4 +101,4 @@ exports.broadcastchannel = broadcastchannel;
 exports.publish = publish;
 exports.subscribe = subscribe;
 exports.unsubscribe = unsubscribe;
-//# sourceMappingURL=broadcastchannel-1ac6c212.cjs.map
+//# sourceMappingURL=broadcastchannel-7655b66f.cjs.map

package/dist/broadcastchannel-7655b66f.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"broadcastchannel-7655b66f.cjs","sources":["../broadcastchannel.js"],"sourcesContent":["/* eslint-env browser */\n\n/**\n * Helpers for cross-tab communication using broadcastchannel with LocalStorage fallback.\n *\n * ```js\n * // In browser window A:\n * broadcastchannel.subscribe('my events', data => console.log(data))\n * broadcastchannel.publish('my events', 'Hello world!') // => A: 'Hello world!' fires synchronously in same tab\n *\n * // In browser window B:\n * broadcastchannel.publish('my events', 'hello from tab B') // => A: 'hello from tab B'\n * ```\n *\n * @module broadcastchannel\n */\n\n// @todo before next major: use Uint8Array instead as buffer object\n\nimport * as map from './map.js'\nimport * as buffer from './buffer.js'\nimport * as storage from './storage.js'\n\n/**\n * @typedef {Object} Channel\n * @property {Set<function(any, any):any>} Channel.subs\n * @property {any} Channel.bc\n */\n\n/**\n * @type {Map<string, Channel>}\n */\nconst channels = new Map()\n\nclass LocalStoragePolyfill {\n  /**\n   * @param {string} room\n   */\n  constructor (room) {\n    this.room = room\n    /**\n     * @type {null|function({data:ArrayBuffer}):void}\n     */\n    this.onmessage = null\n    storage.onChange(e => e.key === room && this.onmessage !== null && this.onmessage({ data: buffer.fromBase64(e.newValue || '') }))\n  }\n\n  /**\n   * @param {ArrayBuffer} buf\n   */\n  postMessage (buf) {\n    storage.varStorage.setItem(this.room, buffer.toBase64(buffer.createUint8ArrayFromArrayBuffer(buf)))\n  }\n}\n\n// Use BroadcastChannel or Polyfill\nconst BC = typeof BroadcastChannel === 'undefined' ? LocalStoragePolyfill : BroadcastChannel\n\n/**\n * @param {string} room\n * @return {Channel}\n */\nconst getChannel = room =>\n  map.setIfUndefined(channels, room, () => {\n    const subs = new Set()\n    const bc = new BC(room)\n    /**\n     * @param {{data:ArrayBuffer}} e\n     */\n    bc.onmessage = e => subs.forEach(sub => sub(e.data, 'broadcastchannel'))\n    return {\n      bc, subs\n    }\n  })\n\n/**\n * Subscribe to global `publish` events.\n *\n * @function\n * @param {string} room\n * @param {function(any, any):any} f\n */\nexport const subscribe = (room, f) => getChannel(room).subs.add(f)\n\n/**\n * Unsubscribe from `publish` global events.\n *\n * @function\n * @param {string} room\n * @param {function(any, any):any} f\n */\nexport const unsubscribe = (room, f) => getChannel(room).subs.delete(f)\n\n/**\n * Publish data to all subscribers (including subscribers on this tab)\n *\n * @function\n * @param {string} room\n * @param {any} data\n * @param {any} [origin]\n */\nexport const publish = (room, data, origin = null) => {\n  const c = getChannel(room)\n  c.bc.postMessage(data)\n  c.subs.forEach(sub => sub(data, origin))\n}\n"],"names":["storage.onChange","buffer.fromBase64","storage.varStorage","buffer.toBase64","buffer.createUint8ArrayFromArrayBuffer","map.setIfUndefined"],"mappings":";;;;;;AAAA;AAsBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,QAAQ,GAAG,IAAI,GAAG,GAAE;AAC1B;AACA,MAAM,oBAAoB,CAAC;AAC3B;AACA;AACA;AACA,EAAE,WAAW,CAAC,CAAC,IAAI,EAAE;AACrB,IAAI,IAAI,CAAC,IAAI,GAAG,KAAI;AACpB;AACA;AACA;AACA,IAAI,IAAI,CAAC,SAAS,GAAG,KAAI;AACzB,IAAIA,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,KAAK,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAEC,mBAAiB,CAAC,CAAC,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE,CAAC,EAAC;AACrI,GAAG;AACH;AACA;AACA;AACA;AACA,EAAE,WAAW,CAAC,CAAC,GAAG,EAAE;AACpB,IAAIC,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAEC,iBAAe,CAACC,wCAAsC,CAAC,GAAG,CAAC,CAAC,EAAC;AACvG,GAAG;AACH,CAAC;AACD;AACA;AACA,MAAM,EAAE,GAAG,OAAO,gBAAgB,KAAK,WAAW,GAAG,oBAAoB,GAAG,iBAAgB;AAC5F;AACA;AACA;AACA;AACA;AACA,MAAM,UAAU,GAAG,IAAI;AACvB,EAAEC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM;AAC3C,IAAI,MAAM,IAAI,GAAG,IAAI,GAAG,GAAE;AAC1B,IAAI,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,IAAI,EAAC;AAC3B;AACA;AACA;AACA,IAAI,EAAE,CAAC,SAAS,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAAC;AAC5E,IAAI,OAAO;AACX,MAAM,EAAE,EAAE,IAAI;AACd,KAAK;AACL,GAAG,EAAC;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,SAAS,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAC;AAClE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,WAAW,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAC;AACvE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,OAAO,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,KAAK;AACtD,EAAE,MAAM,CAAC,GAAG,UAAU,CAAC,IAAI,EAAC;AAC5B,EAAE,CAAC,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,EAAC;AACxB,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,EAAC;AAC1C;;;;;;;;;;;;;;"}

package/dist/broadcastchannel.cjs

@@ -3,9 +3,9 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 require('./map-28a001c9.cjs');
-require('./buffer-c98f67d5.cjs');
+require('./buffer-d3ba308b.cjs');
 require('./storage.cjs');
-var broadcastchannel = require('./broadcastchannel-1ac6c212.cjs');
+var broadcastchannel = require('./broadcastchannel-7655b66f.cjs');
 require('./string-ad04f734.cjs');
 require('./environment-60b83194.cjs');
 require('./conditions-fb475c70.cjs');

package/dist/broadcastchannel.d.ts

@@ -1,8 +1,8 @@
-export function subscribe(room: string, f: (arg0: any) => any): Set<Function>;
-export function unsubscribe(room: string, f: (arg0: any) => any): boolean;
-export function publish(room: string, data: any): void;
+export function subscribe(room: string, f: (arg0: any, arg1: any) => any): Set<(arg0: any, arg1: any) => any>;
+export function unsubscribe(room: string, f: (arg0: any, arg1: any) => any): boolean;
+export function publish(room: string, data: any, origin?: any): void;
 export type Channel = {
-    subs: Set<Function>;
+    subs: Set<(arg0: any, arg1: any) => any>;
     bc: any;
 };
 //# sourceMappingURL=broadcastchannel.d.ts.map

package/dist/broadcastchannel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"broadcastchannel.d.ts","sourceRoot":"","sources":["../broadcastchannel.js"],"names":[],"mappings":"AAkFO,gCAHI,MAAM,YACG,GAAG,KAAE,GAAG,iBAEsC;AAS3D,kCAHI,MAAM,YACG,GAAG,KAAE,GAAG,WAE2C;AAShE,8BAHI,MAAM,QACN,GAAG,QAMb;;UA/Ea,aAAa;QACb,GAAG"}
+{"version":3,"file":"broadcastchannel.d.ts","sourceRoot":"","sources":["../broadcastchannel.js"],"names":[],"mappings":"AAkFO,gCAHI,MAAM,YACG,GAAG,QAAE,GAAG,KAAE,GAAG,cAvDN,GAAG,QAAE,GAAG,KAAE,GAAG,EAyD0B;AAS3D,kCAHI,MAAM,YACG,GAAG,QAAE,GAAG,KAAE,GAAG,WAEsC;AAUhE,8BAJI,MAAM,QACN,GAAG,WACH,GAAG,QAMb;;UAhFa,WAAa,GAAG,QAAE,GAAG,KAAE,GAAG,CAAC;QAC3B,GAAG"}