@automerge/automerge-repo-network-broadcastchannel 1.0.18 → 1.1.0-alpha.1

package/dist/index.d.ts

@@ -13,14 +13,14 @@
  * @module
  *
  */
-import { Message, NetworkAdapter, PeerId } from "@automerge/automerge-repo";
+import { NetworkAdapter, type Message, type PeerId, type StorageId } from "@automerge/automerge-repo";
 export type BroadcastChannelNetworkAdapterOptions = {
     channelName: string;
 };
 export declare class BroadcastChannelNetworkAdapter extends NetworkAdapter {
     #private;
     constructor(options?: BroadcastChannelNetworkAdapterOptions);
-    connect(peerId: PeerId): void;
+    connect(peerId: PeerId, storageId: StorageId | undefined, isEphemeral: boolean): void;
     send(message: Message): void;
     disconnect(): void;
 }

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAE3E,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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EACL,cAAc,EACd,KAAK,OAAO,EACZ,KAAK,MAAM,EACX,KAAK,SAAS,EACf,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,CACL,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,SAAS,GAAG,SAAS,EAChC,WAAW,EAAE,OAAO;IA0DtB,IAAI,CAAC,OAAO,EAAE,OAAO;IAcrB,UAAU;CAIX"}

package/dist/index.js

@@ -13,16 +13,17 @@
  * @module
  *
  */
-import { NetworkAdapter } from "@automerge/automerge-repo";
+import { NetworkAdapter, } from "@automerge/automerge-repo";
 export class BroadcastChannelNetworkAdapter extends NetworkAdapter {
     #broadcastChannel;
     #options;
     constructor(options) {
         super();
-        this.#options = { ...(options ?? {}), channelName: "broadcast" };
+        this.#options = { channelName: "broadcast", ...(options ?? {}) };
     }
-    connect(peerId) {
+    connect(peerId, storageId, isEphemeral) {
         this.peerId = peerId;
+        this.storageId = storageId;
         this.#broadcastChannel = new BroadcastChannel(this.#options.channelName);
         this.#broadcastChannel.addEventListener("message", (e) => {
             const message = e.data;
@@ -37,10 +38,10 @@ export class BroadcastChannelNetworkAdapter extends NetworkAdapter {
                         targetId: senderId,
                         type: "welcome",
                     });
-                    this.#announceConnection(senderId);
+                    this.#announceConnection(senderId, storageId, isEphemeral);
                     break;
                 case "welcome":
-                    this.#announceConnection(senderId);
+                    this.#announceConnection(senderId, storageId, isEphemeral);
                     break;
                 default:
                     if (!("data" in message)) {
@@ -61,8 +62,8 @@ export class BroadcastChannelNetworkAdapter extends NetworkAdapter {
         });
         this.emit("ready", { network: this });
     }
-    #announceConnection(peerId) {
-        this.emit("peer-candidate", { peerId });
+    #announceConnection(peerId, storageId, isEphemeral) {
+        this.emit("peer-candidate", { peerId, storageId, isEphemeral });
     }
     send(message) {
         if ("data" in message) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo-network-broadcastchannel",
-  "version": "1.0.18",
+  "version": "1.1.0-alpha.1",
   "description": "BroadcastChannel network adapter for Automerge Repo",
   "repository": "https://github.com/automerge/automerge-repo/tree/master/packages/automerge-repo-network-broadcastchannel",
   "author": "Peter van Hardenberg <pvh@pvh.ca>",
@@ -13,7 +13,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@automerge/automerge-repo": "^1.0.18"
+    "@automerge/automerge-repo": "^1.1.0-alpha.1"
   },
   "watch": {
     "build": {
@@ -26,5 +26,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "737bde99e0387bef70b53cb0b14d8f08f48f7a92"
+  "gitHead": "11805d698f860bd6ffb3ca028d3b57e718690b5a"
 }

package/src/index.ts

@@ -14,7 +14,12 @@
  *
  */
 
-import { Message, NetworkAdapter, PeerId } from "@automerge/automerge-repo"
+import {
+  NetworkAdapter,
+  type Message,
+  type PeerId,
+  type StorageId,
+} from "@automerge/automerge-repo"
 
 export type BroadcastChannelNetworkAdapterOptions = {
   channelName: string
@@ -27,11 +32,16 @@ export class BroadcastChannelNetworkAdapter extends NetworkAdapter {
 
   constructor(options?: BroadcastChannelNetworkAdapterOptions) {
     super()
-    this.#options = { ...(options ?? {}), channelName: "broadcast" }
+    this.#options = { channelName: "broadcast", ...(options ?? {}) }
   }
 
-  connect(peerId: PeerId) {
+  connect(
+    peerId: PeerId,
+    storageId: StorageId | undefined,
+    isEphemeral: boolean
+  ) {
     this.peerId = peerId
+    this.storageId = storageId
     this.#broadcastChannel = new BroadcastChannel(this.#options.channelName)
 
     this.#broadcastChannel.addEventListener(
@@ -51,10 +61,10 @@ export class BroadcastChannelNetworkAdapter extends NetworkAdapter {
               targetId: senderId,
               type: "welcome",
             })
-            this.#announceConnection(senderId)
+            this.#announceConnection(senderId, storageId, isEphemeral)
             break
           case "welcome":
-            this.#announceConnection(senderId)
+            this.#announceConnection(senderId, storageId, isEphemeral)
             break
           default:
             if (!("data" in message)) {
@@ -78,8 +88,12 @@ export class BroadcastChannelNetworkAdapter extends NetworkAdapter {
     this.emit("ready", { network: this })
   }
 
-  #announceConnection(peerId: PeerId) {
-    this.emit("peer-candidate", { peerId })
+  #announceConnection(
+    peerId: PeerId,
+    storageId: StorageId | undefined,
+    isEphemeral: boolean
+  ) {
+    this.emit("peer-candidate", { peerId, storageId, isEphemeral })
   }
 
   send(message: Message) {
@@ -109,6 +123,13 @@ type ArriveMessage = {
   /** The peer ID of the sender of this message */
   senderId: PeerId
 
+  /** Unique ID of the storage that the sender peer is using, is persistent across sessions */
+  storageId?: StorageId
+
+  /** Indicates whether other peers should persist the sync state of the sender peer.
+   * Sync state is only persisted for non-ephemeral peers */
+  isEphemeral: boolean
+
   /** Arrive messages don't have a targetId */
   targetId: never
 }
@@ -120,6 +141,13 @@ type WelcomeMessage = {
   /** The peer ID of the recipient sender this message */
   senderId: PeerId
 
+  /** Unique ID of the storage that the sender peer is using, is persistent across sessions */
+  storageId?: StorageId
+
+  /** Indicates whether other peers should persist the sync state of the sender peer.
+   * Sync state is only persisted for non-ephemeral peers */
+  isEphemeral: boolean
+
   /** The peer ID of the recipient of this message */
   targetId: PeerId
 }

package/test/index.test.ts

@@ -18,11 +18,11 @@ 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" })
+    const a = new BroadcastChannelNetworkAdapter()
+    const b = new BroadcastChannelNetworkAdapter()
 
     // this adapter should never connect
-    const c = new BroadcastChannelNetworkAdapter()
+    const c = new BroadcastChannelNetworkAdapter({ channelName: "other" })
 
     const aConnect = new Promise<void>(resolve => {
       a.once("peer-candidate", () => resolve())
@@ -38,6 +38,7 @@ describe("BroadcastChannel", () => {
 
     a.connect("a" as PeerId)
     b.connect("b" as PeerId)
+    c.connect("c" as PeerId)
 
     return Promise.all([aConnect, cShouldNotConnect])
   })