@automerge/automerge-repo-network-broadcastchannel 1.0.0-alpha.4 → 1.0.0

package/dist/index.d.ts

@@ -1,9 +1,12 @@
 import { NetworkAdapter, PeerId, Message } from "@automerge/automerge-repo";
+export type BroadcastChannelNetworkAdapterOptions = {
+    channelName: string;
+};
 export declare class BroadcastChannelNetworkAdapter extends NetworkAdapter {
     #private;
+    constructor(options?: BroadcastChannelNetworkAdapterOptions);
     connect(peerId: PeerId): void;
     send(message: Message): void;
-    join(): void;
-    leave(): void;
+    disconnect(): void;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EACd,MAAM,EACN,OAAO,EACR,MAAM,2BAA2B,CAAA;AAElC,qBAAa,8BAA+B,SAAQ,cAAc;;IAGhE,OAAO,CAAC,MAAM,EAAE,MAAM;IA8CtB,IAAI,CAAC,OAAO,EAAE,OAAO;IAcrB,IAAI;IAOJ,KAAK;CAIN"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EACd,MAAM,EACN,OAAO,EACR,MAAM,2BAA2B,CAAA;AAElC,MAAM,MAAM,qCAAqC,GAAG;IAClD,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,qBAAa,8BAA+B,SAAQ,cAAc;;gBAKpD,OAAO,CAAC,EAAE,qCAAqC;IAK3D,OAAO,CAAC,MAAM,EAAE,MAAM;IAoDtB,IAAI,CAAC,OAAO,EAAE,OAAO;IAcrB,UAAU;CAIX"}

package/dist/index.js

@@ -1,9 +1,14 @@
 import { NetworkAdapter, } from "@automerge/automerge-repo";
 export class BroadcastChannelNetworkAdapter extends NetworkAdapter {
     #broadcastChannel;
+    #options;
+    constructor(options) {
+        super();
+        this.#options = { ...(options ?? {}), channelName: "broadcast" };
+    }
     connect(peerId) {
         this.peerId = peerId;
-        this.#broadcastChannel = new BroadcastChannel(`broadcast`);
+        this.#broadcastChannel = new BroadcastChannel(this.#options.channelName);
         this.#broadcastChannel.addEventListener("message", (e) => {
             const message = e.data;
             if ("targetId" in message && message.targetId !== this.peerId) {
@@ -35,6 +40,10 @@ export class BroadcastChannelNetworkAdapter extends NetworkAdapter {
                     break;
             }
         });
+        this.#broadcastChannel.postMessage({
+            senderId: this.peerId,
+            type: "arrive",
+        });
         this.emit("ready", { network: this });
     }
     #announceConnection(peerId) {
@@ -51,14 +60,8 @@ export class BroadcastChannelNetworkAdapter extends NetworkAdapter {
             this.#broadcastChannel.postMessage(message);
         }
     }
-    join() {
-        this.#broadcastChannel.postMessage({
-            senderId: this.peerId,
-            type: "arrive",
-        });
-    }
-    leave() {
-        // TODO
+    disconnect() {
+        // TODO:
         throw new Error("Unimplemented: leave on BroadcastChannelNetworkAdapter");
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo-network-broadcastchannel",
-  "version": "1.0.0-alpha.4",
+  "version": "1.0.0",
   "description": "BroadcastChannel network adapter for Automerge Repo",
   "repository": "https://github.com/automerge/automerge-repo",
   "author": "Peter van Hardenberg <pvh@pvh.ca>",
@@ -14,10 +14,10 @@
     "test": "mocha --no-warnings --experimental-specifier-resolution=node --exit"
   },
   "peerDependencies": {
-    "@automerge/automerge": "^2.1.0-alpha.12"
+    "@automerge/automerge": "^2.1.0"
   },
   "dependencies": {
-    "@automerge/automerge-repo": "^1.0.0-alpha.4"
+    "@automerge/automerge-repo": "^1.0.0"
   },
   "watch": {
     "build": {
@@ -30,5 +30,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "fbf71f0c3aaa2786a4e279f336f01d665f53ce5b"
+  "gitHead": "89c6ee2714d43dbebd69c7a62f148d17869608d6"
 }

package/src/index.ts

@@ -5,12 +5,23 @@ import {
   Message,
 } from "@automerge/automerge-repo"
 
+export type BroadcastChannelNetworkAdapterOptions = {
+  channelName: string
+}
+
 export class BroadcastChannelNetworkAdapter extends NetworkAdapter {
   #broadcastChannel: BroadcastChannel
 
+  #options: BroadcastChannelNetworkAdapterOptions
+
+  constructor(options?: BroadcastChannelNetworkAdapterOptions) {
+    super()
+    this.#options = { ...(options ?? {}), channelName: "broadcast" }
+  }
+
   connect(peerId: PeerId) {
     this.peerId = peerId
-    this.#broadcastChannel = new BroadcastChannel(`broadcast`)
+    this.#broadcastChannel = new BroadcastChannel(this.#options.channelName)
 
     this.#broadcastChannel.addEventListener(
       "message",
@@ -47,6 +58,12 @@ export class BroadcastChannelNetworkAdapter extends NetworkAdapter {
         }
       }
     )
+
+    this.#broadcastChannel.postMessage({
+      senderId: this.peerId,
+      type: "arrive",
+    })
+
     this.emit("ready", { network: this })
   }
 
@@ -68,15 +85,8 @@ export class BroadcastChannelNetworkAdapter extends NetworkAdapter {
     }
   }
 
-  join() {
-    this.#broadcastChannel.postMessage({
-      senderId: this.peerId,
-      type: "arrive",
-    })
-  }
-
-  leave() {
-    // TODO
+  disconnect() {
+    // TODO:
     throw new Error("Unimplemented: leave on BroadcastChannelNetworkAdapter")
   }
 }

package/test/index.test.ts

@@ -3,6 +3,7 @@ import {
   type SetupFn,
   runAdapterTests,
 } from "../../automerge-repo/src/helpers/tests/network-adapter-tests.js"
+import { PeerId } from "@automerge/automerge-repo"
 
 describe("BroadcastChannel", () => {
   const setup: SetupFn = async () => {
@@ -14,4 +15,29 @@ describe("BroadcastChannel", () => {
   }
 
   runAdapterTests(setup)
+
+  it("allows a channel name to be specified in the options and limits messages to that channel", async () => {
+    const a = new BroadcastChannelNetworkAdapter({ channelName: "test" })
+    const b = new BroadcastChannelNetworkAdapter({ channelName: "test" })
+
+    // this adapter should never connect
+    const c = new BroadcastChannelNetworkAdapter()
+
+    const aConnect = new Promise<void>(resolve => {
+      a.once("peer-candidate", () => resolve())
+    })
+
+    const cShouldNotConnect = new Promise<void>((resolve, reject) => {
+      c.once("peer-candidate", () => reject("c should not connect"))
+
+      setTimeout(() => {
+        resolve()
+      }, 100)
+    })
+
+    a.connect("a" as PeerId)
+    b.connect("b" as PeerId)
+
+    return Promise.all([aConnect, cShouldNotConnect])
+  })
 })