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

package/dist/index.d.ts

@@ -5,7 +5,7 @@
  *
  * @module
  */
-import { type RepoMessage, NetworkAdapter, type PeerId } from "@automerge/automerge-repo";
+import { type RepoMessage, NetworkAdapter, type PeerId, type StorageId } from "@automerge/automerge-repo";
 import { MessagePortRef } from "./MessagePortRef.js";
 export declare class MessageChannelNetworkAdapter extends NetworkAdapter {
     #private;
@@ -13,9 +13,9 @@ export declare class MessageChannelNetworkAdapter extends NetworkAdapter {
     /** @hidden */
     messagePortRef: MessagePortRef;
     constructor(messagePort: MessagePort, config?: MessageChannelNetworkAdapterConfig);
-    connect(peerId: PeerId): void;
+    connect(peerId: PeerId, storageId: StorageId | undefined, isEphemeral: boolean): void;
     send(message: RepoMessage): void;
-    announceConnection(peerId: PeerId): void;
+    announceConnection(peerId: PeerId, storageId: StorageId | undefined, isEphemeral: boolean): void;
     disconnect(): void;
 }
 export interface MessageChannelNetworkAdapterConfig {

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EACL,KAAK,WAAW,EAChB,cAAc,EACd,KAAK,MAAM,EAEZ,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAOpD,qBAAa,4BAA6B,SAAQ,cAAc;;IAC9D,QAAQ,KAAK;IACb,cAAc;IACd,cAAc,EAAE,cAAc,CAAA;gBAI5B,WAAW,EAAE,WAAW,EACxB,MAAM,GAAE,kCAAuC;IAWjD,OAAO,CAAC,MAAM,EAAE,MAAM;IAgEtB,IAAI,CAAC,OAAO,EAAE,WAAW;IAmBzB,kBAAkB,CAAC,MAAM,EAAE,MAAM;IAQjC,UAAU;CAIX;AAED,MAAM,WAAW,kCAAkC;IACjD;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EACL,KAAK,WAAW,EAChB,cAAc,EACd,KAAK,MAAM,EAEX,KAAK,SAAS,EACf,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAOpD,qBAAa,4BAA6B,SAAQ,cAAc;;IAC9D,QAAQ,KAAK;IACb,cAAc;IACd,cAAc,EAAE,cAAc,CAAA;gBAI5B,WAAW,EAAE,WAAW,EACxB,MAAM,GAAE,kCAAuC;IAWjD,OAAO,CACL,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,SAAS,GAAG,SAAS,EAChC,WAAW,EAAE,OAAO;IA2EtB,IAAI,CAAC,OAAO,EAAE,WAAW;IAmBzB,kBAAkB,CAChB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,SAAS,GAAG,SAAS,EAChC,WAAW,EAAE,OAAO;IAStB,UAAU;CAIX;AAED,MAAM,WAAW,kCAAkC;IACjD;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB"}

package/dist/index.js

@@ -22,9 +22,11 @@ export class MessageChannelNetworkAdapter extends NetworkAdapter {
             ? new WeakMessagePortRef(messagePort)
             : new StrongMessagePortRef(messagePort);
     }
-    connect(peerId) {
+    connect(peerId, storageId, isEphemeral) {
         log("messageport connecting");
         this.peerId = peerId;
+        this.storageId = storageId;
+        this.isEphemeral = isEphemeral;
         this.messagePortRef.start();
         this.messagePortRef.addListener("message", (e) => {
             log("message port received", e.data);
@@ -35,15 +37,23 @@ export class MessageChannelNetworkAdapter extends NetworkAdapter {
             const { senderId, type } = message;
             switch (type) {
                 case "arrive":
-                    this.messagePortRef.postMessage({
-                        senderId: this.peerId,
-                        targetId: senderId,
-                        type: "welcome",
-                    });
-                    this.announceConnection(senderId);
+                    {
+                        const { storageId, isEphemeral } = message;
+                        this.messagePortRef.postMessage({
+                            senderId: this.peerId,
+                            storageId: this.storageId,
+                            isEphemeral: this.isEphemeral,
+                            targetId: senderId,
+                            type: "welcome",
+                        });
+                        this.announceConnection(senderId, storageId, isEphemeral);
+                    }
                     break;
                 case "welcome":
-                    this.announceConnection(senderId);
+                    {
+                        const { storageId, isEphemeral } = message;
+                        this.announceConnection(senderId, storageId, isEphemeral);
+                    }
                     break;
                 default:
                     if (!("data" in message)) {
@@ -87,12 +97,12 @@ export class MessageChannelNetworkAdapter extends NetworkAdapter {
             this.messagePortRef.postMessage(message);
         }
     }
-    announceConnection(peerId) {
+    announceConnection(peerId, storageId, isEphemeral) {
         if (!this.#startupComplete) {
             this.#startupComplete = true;
             this.emit("ready", { network: this });
         }
-        this.emit("peer-candidate", { peerId });
+        this.emit("peer-candidate", { peerId, storageId, isEphemeral });
     }
     disconnect() {
         // TODO

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo-network-messagechannel",
-  "version": "1.0.18",
+  "version": "1.1.0-alpha.1",
   "description": "MessageChannel network adapter for Automerge Repo",
   "repository": "https://github.com/automerge/automerge-repo/tree/master/packages/automerge-repo-network-messagechannel",
   "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

@@ -10,6 +10,7 @@ import {
   NetworkAdapter,
   type PeerId,
   type Message,
+  type StorageId,
 } from "@automerge/automerge-repo"
 import { MessagePortRef } from "./MessagePortRef.js"
 import { StrongMessagePortRef } from "./StrongMessagePortRef.js"
@@ -37,9 +38,15 @@ export class MessageChannelNetworkAdapter extends NetworkAdapter {
       : new StrongMessagePortRef(messagePort)
   }
 
-  connect(peerId: PeerId) {
+  connect(
+    peerId: PeerId,
+    storageId: StorageId | undefined,
+    isEphemeral: boolean
+  ) {
     log("messageport connecting")
     this.peerId = peerId
+    this.storageId = storageId
+    this.isEphemeral = isEphemeral
     this.messagePortRef.start()
     this.messagePortRef.addListener(
       "message",
@@ -57,15 +64,23 @@ export class MessageChannelNetworkAdapter extends NetworkAdapter {
 
         switch (type) {
           case "arrive":
-            this.messagePortRef.postMessage({
-              senderId: this.peerId,
-              targetId: senderId,
-              type: "welcome",
-            })
-            this.announceConnection(senderId)
+            {
+              const { storageId, isEphemeral } = message
+              this.messagePortRef.postMessage({
+                senderId: this.peerId,
+                storageId: this.storageId,
+                isEphemeral: this.isEphemeral,
+                targetId: senderId,
+                type: "welcome",
+              })
+              this.announceConnection(senderId, storageId, isEphemeral)
+            }
             break
           case "welcome":
-            this.announceConnection(senderId)
+            {
+              const { storageId, isEphemeral } = message
+              this.announceConnection(senderId, storageId, isEphemeral)
+            }
             break
           default:
             if (!("data" in message)) {
@@ -120,12 +135,16 @@ export class MessageChannelNetworkAdapter extends NetworkAdapter {
     }
   }
 
-  announceConnection(peerId: PeerId) {
+  announceConnection(
+    peerId: PeerId,
+    storageId: StorageId | undefined,
+    isEphemeral: boolean
+  ) {
     if (!this.#startupComplete) {
       this.#startupComplete = true
       this.emit("ready", { network: this })
     }
-    this.emit("peer-candidate", { peerId })
+    this.emit("peer-candidate", { peerId, storageId, isEphemeral })
   }
 
   disconnect() {
@@ -153,6 +172,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
 }
@@ -164,6 +190,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
 }