@automerge/automerge-repo-network-websocket 1.0.19 → 1.1.0-alpha.2

package/dist/BrowserWebSocketClientAdapter.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="ws" />
-import { NetworkAdapter, PeerId } from "@automerge/automerge-repo";
+import { NetworkAdapter, type PeerId, type PeerMetadata } from "@automerge/automerge-repo";
 import WebSocket from "isomorphic-ws";
 import { FromClientMessage } from "./messages.js";
 declare abstract class WebSocketNetworkAdapter extends NetworkAdapter {
@@ -11,14 +11,14 @@ export declare class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapt
     remotePeerId?: PeerId;
     url: string;
     constructor(url: string);
-    connect(peerId: PeerId): void;
+    connect(peerId: PeerId, peerMetadata: PeerMetadata): void;
     onOpen: () => void;
     onClose: () => void;
     onMessage: (event: WebSocket.MessageEvent) => void;
     join(): void;
     disconnect(): void;
     send(message: FromClientMessage): void;
-    announceConnection(peerId: PeerId): void;
+    announceConnection(peerId: PeerId, peerMetadata: PeerMetadata): void;
     receiveMessage(message: Uint8Array): void;
 }
 export {};

package/dist/BrowserWebSocketClientAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserWebSocketClientAdapter.d.ts","sourceRoot":"","sources":["../src/BrowserWebSocketClientAdapter.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAQ,MAAM,2BAA2B,CAAA;AACxE,OAAO,SAAS,MAAM,eAAe,CAAA;AAIrC,OAAO,EACL,iBAAiB,EAGlB,MAAM,eAAe,CAAA;AAKtB,uBAAe,uBAAwB,SAAQ,cAAc;IAC3D,MAAM,CAAC,EAAE,SAAS,CAAA;CACnB;AAED,qBAAa,6BAA8B,SAAQ,uBAAuB;;IAGxE,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA;IACvC,YAAY,CAAC,EAAE,MAAM,CAAA;IAGrB,GAAG,EAAE,MAAM,CAAA;gBAEC,GAAG,EAAE,MAAM;IAKvB,OAAO,CAAC,MAAM,EAAE,MAAM;IAkCtB,MAAM,aAKL;IAGD,OAAO,aAYN;IAED,SAAS,UAAW,sBAAsB,UAEzC;IAED,IAAI;IAWJ,UAAU;IAOV,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAwB/B,kBAAkB,CAAC,MAAM,EAAE,MAAM;IAcjC,cAAc,CAAC,OAAO,EAAE,UAAU;CA0BnC"}
+{"version":3,"file":"BrowserWebSocketClientAdapter.d.ts","sourceRoot":"","sources":["../src/BrowserWebSocketClientAdapter.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,cAAc,EACd,KAAK,MAAM,EACX,KAAK,YAAY,EAElB,MAAM,2BAA2B,CAAA;AAClC,OAAO,SAAS,MAAM,eAAe,CAAA;AAIrC,OAAO,EACL,iBAAiB,EAIlB,MAAM,eAAe,CAAA;AAKtB,uBAAe,uBAAwB,SAAQ,cAAc;IAC3D,MAAM,CAAC,EAAE,SAAS,CAAA;CACnB;AAED,qBAAa,6BAA8B,SAAQ,uBAAuB;;IAGxE,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA;IACvC,YAAY,CAAC,EAAE,MAAM,CAAA;IAGrB,GAAG,EAAE,MAAM,CAAA;gBAEC,GAAG,EAAE,MAAM;IAKvB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY;IAmClD,MAAM,aAKL;IAGD,OAAO,aAYN;IAED,SAAS,UAAW,sBAAsB,UAEzC;IAED,IAAI;IAWJ,UAAU;IAOV,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAwB/B,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY;IAc7D,cAAc,CAAC,OAAO,EAAE,UAAU;CA4BnC"}

package/dist/BrowserWebSocketClientAdapter.js

@@ -1,4 +1,4 @@
-import { NetworkAdapter, cbor } from "@automerge/automerge-repo";
+import { NetworkAdapter, cbor, } from "@automerge/automerge-repo";
 import WebSocket from "isomorphic-ws";
 import debug from "debug";
 import { ProtocolV1 } from "./protocolVersion.js";
@@ -17,7 +17,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         super();
         this.url = url;
     }
-    connect(peerId) {
+    connect(peerId, peerMetadata) {
         // If we're reconnecting  make sure we remove the old event listeners
         // before creating a new connection.
         if (this.socket) {
@@ -26,9 +26,10 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
             this.socket.removeEventListener("message", this.onMessage);
         }
         if (!this.timerId) {
-            this.timerId = setInterval(() => this.connect(peerId), 5000);
+            this.timerId = setInterval(() => this.connect(peerId, peerMetadata), 5000);
         }
         this.peerId = peerId;
+        this.peerMetadata = peerMetadata;
         this.socket = new WebSocket(this.url);
         this.socket.binaryType = "arraybuffer";
         this.socket.addEventListener("open", this.onOpen);
@@ -49,7 +50,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         log(`@ ${this.url}: open`);
         clearInterval(this.timerId);
         this.timerId = undefined;
-        this.send(joinMessage(this.peerId));
+        this.send(joinMessage(this.peerId, this.peerMetadata));
     };
     // When a socket closes, or disconnects, remove it from the array.
     onClose = () => {
@@ -59,7 +60,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         }
         if (!this.timerId) {
             if (this.peerId) {
-                this.connect(this.peerId);
+                this.connect(this.peerId, this.peerMetadata);
             }
         }
     };
@@ -71,7 +72,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
             throw new Error("WTF, get a socket");
         }
         if (this.socket.readyState === WebSocket.OPEN) {
-            this.send(joinMessage(this.peerId));
+            this.send(joinMessage(this.peerId, this.peerMetadata));
         }
         else {
             // The onOpen handler automatically sends a join message
@@ -99,7 +100,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         const arrayBuf = encoded.buffer.slice(encoded.byteOffset, encoded.byteOffset + encoded.byteLength);
         this.socket?.send(arrayBuf);
     }
-    announceConnection(peerId) {
+    announceConnection(peerId, peerMetadata) {
         // return a peer object
         const myPeerId = this.peerId;
         if (!myPeerId) {
@@ -110,7 +111,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
             this.emit("ready", { network: this });
         }
         this.remotePeerId = peerId;
-        this.emit("peer-candidate", { peerId });
+        this.emit("peer-candidate", { peerId, peerMetadata });
     }
     receiveMessage(message) {
         const decoded = cbor.decode(new Uint8Array(message));
@@ -123,10 +124,12 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
             throw new Error("received a zero-length message");
         }
         switch (type) {
-            case "peer":
+            case "peer": {
+                const { peerMetadata } = decoded;
                 log(`peer: ${senderId}`);
-                this.announceConnection(senderId);
+                this.announceConnection(senderId, peerMetadata);
                 break;
+            }
             case "error":
                 log(`error: ${decoded.message}`);
                 break;
@@ -135,10 +138,11 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
         }
     }
 }
-function joinMessage(senderId) {
+function joinMessage(senderId, peerMetadata) {
     return {
         type: "join",
         senderId,
+        peerMetadata,
         supportedProtocolVersions: [ProtocolV1],
     };
 }

package/dist/NodeWSServerAdapter.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="ws" />
 import WebSocket from "isomorphic-ws";
 import { type WebSocketServer } from "isomorphic-ws";
-import { NetworkAdapter, type PeerId } from "@automerge/automerge-repo";
+import { NetworkAdapter, type PeerMetadata, type PeerId } from "@automerge/automerge-repo";
 import { FromServerMessage } from "./messages.js";
 export declare class NodeWSServerAdapter extends NetworkAdapter {
     server: WebSocketServer;
@@ -9,7 +9,7 @@ export declare class NodeWSServerAdapter extends NetworkAdapter {
         [peerId: PeerId]: WebSocket;
     };
     constructor(server: WebSocketServer);
-    connect(peerId: PeerId): void;
+    connect(peerId: PeerId, peerMetadata: PeerMetadata): void;
     disconnect(): void;
     send(message: FromServerMessage): void;
     receiveMessage(message: Uint8Array, socket: WebSocket): void;

package/dist/NodeWSServerAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NodeWSServerAdapter.d.ts","sourceRoot":"","sources":["../src/NodeWSServerAdapter.ts"],"names":[],"mappings":";AAAA,OAAO,SAAS,MAAM,eAAe,CAAA;AACrC,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAA;AAKpD,OAAO,EAEL,cAAc,EACd,KAAK,MAAM,EACZ,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAqB,iBAAiB,EAAE,MAAM,eAAe,CAAA;AASpE,qBAAa,mBAAoB,SAAQ,cAAc;IACrD,MAAM,EAAE,eAAe,CAAA;IACvB,OAAO,EAAE;QAAE,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAK;gBAEjC,MAAM,EAAE,eAAe;IAKnC,OAAO,CAAC,MAAM,EAAE,MAAM;IAoDtB,UAAU;IAIV,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAyB/B,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS;CA+DtD"}
+{"version":3,"file":"NodeWSServerAdapter.d.ts","sourceRoot":"","sources":["../src/NodeWSServerAdapter.ts"],"names":[],"mappings":";AAAA,OAAO,SAAS,MAAM,eAAe,CAAA;AACrC,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAA;AAKpD,OAAO,EAEL,cAAc,EACd,KAAK,YAAY,EACjB,KAAK,MAAM,EACZ,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAqB,iBAAiB,EAAE,MAAM,eAAe,CAAA;AASpE,qBAAa,mBAAoB,SAAQ,cAAc;IACrD,MAAM,EAAE,eAAe,CAAA;IACvB,OAAO,EAAE;QAAE,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAK;gBAEjC,MAAM,EAAE,eAAe;IAKnC,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY;IAqDlD,UAAU;IAIV,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAyB/B,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS;CAsEtD"}

package/dist/NodeWSServerAdapter.js

@@ -11,8 +11,9 @@ export class NodeWSServerAdapter extends NetworkAdapter {
         super();
         this.server = server;
     }
-    connect(peerId) {
+    connect(peerId, peerMetadata) {
         this.peerId = peerId;
+        this.peerMetadata = peerMetadata;
         this.server.on("close", function close() {
             clearInterval(interval);
         });
@@ -84,36 +85,43 @@ export class NodeWSServerAdapter extends NetworkAdapter {
         log(`[${senderId}->${myPeerId}${"documentId" in cbor ? "@" + cbor.documentId : ""}] ${type} | ${message.byteLength} bytes`);
         switch (type) {
             case "join":
-                const existingSocket = this.sockets[senderId];
-                if (existingSocket) {
-                    if (existingSocket.readyState === WebSocket.OPEN) {
-                        existingSocket.close();
+                {
+                    const existingSocket = this.sockets[senderId];
+                    if (existingSocket) {
+                        if (existingSocket.readyState === WebSocket.OPEN) {
+                            existingSocket.close();
+                        }
+                        this.emit("peer-disconnected", { peerId: senderId });
                     }
-                    this.emit("peer-disconnected", { peerId: senderId });
-                }
-                // Let the rest of the system know that we have a new connection.
-                this.emit("peer-candidate", { peerId: senderId });
-                this.sockets[senderId] = socket;
-                // In this client-server connection, there's only ever one peer: us!
-                // (and we pretend to be joined to every channel)
-                const selectedProtocolVersion = selectProtocol(cbor.supportedProtocolVersions);
-                if (selectedProtocolVersion === null) {
-                    this.send({
-                        type: "error",
-                        senderId: this.peerId,
-                        message: "unsupported protocol version",
-                        targetId: senderId,
-                    });
-                    this.sockets[senderId].close();
-                    delete this.sockets[senderId];
-                }
-                else {
-                    this.send({
-                        type: "peer",
-                        senderId: this.peerId,
-                        selectedProtocolVersion: ProtocolV1,
-                        targetId: senderId,
+                    const { peerMetadata } = cbor;
+                    // Let the rest of the system know that we have a new connection.
+                    this.emit("peer-candidate", {
+                        peerId: senderId,
+                        peerMetadata,
                     });
+                    this.sockets[senderId] = socket;
+                    // In this client-server connection, there's only ever one peer: us!
+                    // (and we pretend to be joined to every channel)
+                    const selectedProtocolVersion = selectProtocol(cbor.supportedProtocolVersions);
+                    if (selectedProtocolVersion === null) {
+                        this.send({
+                            type: "error",
+                            senderId: this.peerId,
+                            message: "unsupported protocol version",
+                            targetId: senderId,
+                        });
+                        this.sockets[senderId].close();
+                        delete this.sockets[senderId];
+                    }
+                    else {
+                        this.send({
+                            type: "peer",
+                            senderId: this.peerId,
+                            peerMetadata: this.peerMetadata,
+                            selectedProtocolVersion: ProtocolV1,
+                            targetId: senderId,
+                        });
+                    }
                 }
                 break;
             case "leave":

package/dist/messages.d.ts

@@ -1,4 +1,4 @@
-import type { Message, PeerId } from "@automerge/automerge-repo";
+import type { Message, PeerId, PeerMetadata } from "@automerge/automerge-repo";
 import type { ProtocolVersion } from "./protocolVersion.js";
 /** The sender is disconnecting */
 export type LeaveMessage = {
@@ -10,6 +10,8 @@ export type JoinMessage = {
     type: "join";
     /** The PeerID of the client */
     senderId: PeerId;
+    /** Metadata presented by the peer  */
+    peerMetadata: PeerMetadata;
     /** The protocol version the client supports */
     supportedProtocolVersions: ProtocolVersion[];
 };
@@ -18,6 +20,8 @@ export type PeerMessage = {
     type: "peer";
     /** The PeerID of the server */
     senderId: PeerId;
+    /** Metadata presented by the peer  */
+    peerMetadata: PeerMetadata;
     /** The protocol version the server selected for this connection */
     selectedProtocolVersion: ProtocolVersion;
     /** The PeerID of the client */

package/dist/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAE3D,kCAAkC;AAClC,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,6EAA6E;AAC7E,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,+CAA+C;IAC/C,yBAAyB,EAAE,eAAe,EAAE,CAAA;CAC7C,CAAA;AAED,yFAAyF;AACzF,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,mEAAmE;IACnE,uBAAuB,EAAE,eAAe,CAAA;IACxC,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,gGAAgG;AAChG,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,CAAA;IACb,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAKD,8CAA8C;AAC9C,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CAAA;AAEpE,8CAA8C;AAC9C,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CAAA"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC9E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAE3D,kCAAkC;AAClC,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,6EAA6E;AAC7E,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAEhB,sCAAsC;IACtC,YAAY,EAAE,YAAY,CAAA;IAE1B,+CAA+C;IAC/C,yBAAyB,EAAE,eAAe,EAAE,CAAA;CAC7C,CAAA;AAED,yFAAyF;AACzF,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAEhB,sCAAsC;IACtC,YAAY,EAAE,YAAY,CAAA;IAE1B,mEAAmE;IACnE,uBAAuB,EAAE,eAAe,CAAA;IACxC,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,gGAAgG;AAChG,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,CAAA;IACb,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAKD,8CAA8C;AAC9C,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CAAA;AAEpE,8CAA8C;AAC9C,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo-network-websocket",
-  "version": "1.0.19",
+  "version": "1.1.0-alpha.2",
   "description": "isomorphic node/browser Websocket network adapter for Automerge Repo",
   "repository": "https://github.com/automerge/automerge-repo/tree/master/packages/automerge-repo-network-websocket",
   "author": "Peter van Hardenberg <pvh@pvh.ca>",
@@ -13,7 +13,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@automerge/automerge-repo": "^1.0.19",
+    "@automerge/automerge-repo": "^1.1.0-alpha.2",
     "cbor-x": "^1.3.0",
     "eventemitter3": "^5.0.1",
     "isomorphic-ws": "^5.0.0",
@@ -30,5 +30,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7d28ca50dfa437ac6f7b1722b89b3f6844b90de7"
+  "gitHead": "d73e71588c3835a172fdf4d19e56a1f946c041ed"
 }

package/src/BrowserWebSocketClientAdapter.ts

@@ -1,4 +1,9 @@
-import { NetworkAdapter, PeerId, cbor } from "@automerge/automerge-repo"
+import {
+  NetworkAdapter,
+  type PeerId,
+  type PeerMetadata,
+  cbor,
+} from "@automerge/automerge-repo"
 import WebSocket from "isomorphic-ws"
 
 import debug from "debug"
@@ -7,6 +12,7 @@ import {
   FromClientMessage,
   FromServerMessage,
   JoinMessage,
+  PeerMessage,
 } from "./messages.js"
 import { ProtocolV1 } from "./protocolVersion.js"
 
@@ -30,7 +36,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     this.url = url
   }
 
-  connect(peerId: PeerId) {
+  connect(peerId: PeerId, peerMetadata: PeerMetadata) {
     // If we're reconnecting  make sure we remove the old event listeners
     // before creating a new connection.
     if (this.socket) {
@@ -40,10 +46,11 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     }
 
     if (!this.timerId) {
-      this.timerId = setInterval(() => this.connect(peerId), 5000)
+      this.timerId = setInterval(() => this.connect(peerId, peerMetadata), 5000)
     }
 
     this.peerId = peerId
+    this.peerMetadata = peerMetadata
     this.socket = new WebSocket(this.url)
     this.socket.binaryType = "arraybuffer"
 
@@ -68,7 +75,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     log(`@ ${this.url}: open`)
     clearInterval(this.timerId)
     this.timerId = undefined
-    this.send(joinMessage(this.peerId!))
+    this.send(joinMessage(this.peerId!, this.peerMetadata!))
   }
 
   // When a socket closes, or disconnects, remove it from the array.
@@ -81,7 +88,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
 
     if (!this.timerId) {
       if (this.peerId) {
-        this.connect(this.peerId)
+        this.connect(this.peerId, this.peerMetadata!)
       }
     }
   }
@@ -95,7 +102,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
       throw new Error("WTF, get a socket")
     }
     if (this.socket.readyState === WebSocket.OPEN) {
-      this.send(joinMessage(this.peerId!))
+      this.send(joinMessage(this.peerId!, this.peerMetadata!))
     } else {
       // The onOpen handler automatically sends a join message
     }
@@ -132,7 +139,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     this.socket?.send(arrayBuf)
   }
 
-  announceConnection(peerId: PeerId) {
+  announceConnection(peerId: PeerId, peerMetadata: PeerMetadata) {
     // return a peer object
     const myPeerId = this.peerId
     if (!myPeerId) {
@@ -143,7 +150,7 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
       this.emit("ready", { network: this })
     }
     this.remotePeerId = peerId
-    this.emit("peer-candidate", { peerId })
+    this.emit("peer-candidate", { peerId, peerMetadata })
   }
 
   receiveMessage(message: Uint8Array) {
@@ -161,10 +168,12 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     }
 
     switch (type) {
-      case "peer":
+      case "peer": {
+        const { peerMetadata } = decoded
         log(`peer: ${senderId}`)
-        this.announceConnection(senderId)
+        this.announceConnection(senderId, peerMetadata)
         break
+      }
       case "error":
         log(`error: ${decoded.message}`)
         break
@@ -174,10 +183,14 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
   }
 }
 
-function joinMessage(senderId: PeerId): JoinMessage {
+function joinMessage(
+  senderId: PeerId,
+  peerMetadata: PeerMetadata
+): JoinMessage {
   return {
     type: "join",
     senderId,
+    peerMetadata,
     supportedProtocolVersions: [ProtocolV1],
   }
 }

package/src/NodeWSServerAdapter.ts

@@ -7,6 +7,7 @@ const log = debug("WebsocketServer")
 import {
   cbor as cborHelpers,
   NetworkAdapter,
+  type PeerMetadata,
   type PeerId,
 } from "@automerge/automerge-repo"
 import { FromClientMessage, FromServerMessage } from "./messages.js"
@@ -27,8 +28,9 @@ export class NodeWSServerAdapter extends NetworkAdapter {
     this.server = server
   }
 
-  connect(peerId: PeerId) {
+  connect(peerId: PeerId, peerMetadata: PeerMetadata) {
     this.peerId = peerId
+    this.peerMetadata = peerMetadata
 
     this.server.on("close", function close() {
       clearInterval(interval)
@@ -124,39 +126,46 @@ export class NodeWSServerAdapter extends NetworkAdapter {
     )
     switch (type) {
       case "join":
-        const existingSocket = this.sockets[senderId]
-        if (existingSocket) {
-          if (existingSocket.readyState === WebSocket.OPEN) {
-            existingSocket.close()
+        {
+          const existingSocket = this.sockets[senderId]
+          if (existingSocket) {
+            if (existingSocket.readyState === WebSocket.OPEN) {
+              existingSocket.close()
+            }
+            this.emit("peer-disconnected", { peerId: senderId })
           }
-          this.emit("peer-disconnected", {peerId: senderId})
-        }
 
-        // Let the rest of the system know that we have a new connection.
-        this.emit("peer-candidate", { peerId: senderId })
-        this.sockets[senderId] = socket
-
-        // In this client-server connection, there's only ever one peer: us!
-        // (and we pretend to be joined to every channel)
-        const selectedProtocolVersion = selectProtocol(
-          cbor.supportedProtocolVersions
-        )
-        if (selectedProtocolVersion === null) {
-          this.send({
-            type: "error",
-            senderId: this.peerId!,
-            message: "unsupported protocol version",
-            targetId: senderId,
-          })
-          this.sockets[senderId].close()
-          delete this.sockets[senderId]
-        } else {
-          this.send({
-            type: "peer",
-            senderId: this.peerId!,
-            selectedProtocolVersion: ProtocolV1,
-            targetId: senderId,
+          const { peerMetadata } = cbor
+          // Let the rest of the system know that we have a new connection.
+          this.emit("peer-candidate", {
+            peerId: senderId,
+            peerMetadata,
           })
+          this.sockets[senderId] = socket
+
+          // In this client-server connection, there's only ever one peer: us!
+          // (and we pretend to be joined to every channel)
+          const selectedProtocolVersion = selectProtocol(
+            cbor.supportedProtocolVersions
+          )
+          if (selectedProtocolVersion === null) {
+            this.send({
+              type: "error",
+              senderId: this.peerId!,
+              message: "unsupported protocol version",
+              targetId: senderId,
+            })
+            this.sockets[senderId].close()
+            delete this.sockets[senderId]
+          } else {
+            this.send({
+              type: "peer",
+              senderId: this.peerId!,
+              peerMetadata: this.peerMetadata!,
+              selectedProtocolVersion: ProtocolV1,
+              targetId: senderId,
+            })
+          }
         }
         break
       case "leave":

package/src/messages.ts

@@ -1,4 +1,4 @@
-import type { Message, PeerId } from "@automerge/automerge-repo"
+import type { Message, PeerId, PeerMetadata } from "@automerge/automerge-repo"
 import type { ProtocolVersion } from "./protocolVersion.js"
 
 /** The sender is disconnecting */
@@ -12,6 +12,10 @@ export type JoinMessage = {
   type: "join"
   /** The PeerID of the client */
   senderId: PeerId
+
+  /** Metadata presented by the peer  */
+  peerMetadata: PeerMetadata
+
   /** The protocol version the client supports */
   supportedProtocolVersions: ProtocolVersion[]
 }
@@ -21,6 +25,10 @@ export type PeerMessage = {
   type: "peer"
   /** The PeerID of the server */
   senderId: PeerId
+
+  /** Metadata presented by the peer  */
+  peerMetadata: PeerMetadata
+
   /** The protocol version the server selected for this connection */
   selectedProtocolVersion: ProtocolVersion
   /** The PeerID of the client */

package/test/Websocket.test.ts

@@ -1,5 +1,12 @@
 import { next as A } from "@automerge/automerge"
-import { AutomergeUrl, DocumentId, PeerId, Repo, SyncMessage, parseAutomergeUrl } from "@automerge/automerge-repo"
+import {
+  AutomergeUrl,
+  DocumentId,
+  PeerId,
+  Repo,
+  SyncMessage,
+  parseAutomergeUrl,
+} from "@automerge/automerge-repo"
 import assert from "assert"
 import * as CBOR from "cbor-x"
 import { once } from "events"
@@ -10,7 +17,7 @@ import { runAdapterTests } from "../../automerge-repo/src/helpers/tests/network-
 import { DummyStorageAdapter } from "../../automerge-repo/test/helpers/DummyStorageAdapter.js"
 import { BrowserWebSocketClientAdapter } from "../src/BrowserWebSocketClientAdapter.js"
 import { NodeWSServerAdapter } from "../src/NodeWSServerAdapter.js"
-import {headsAreSame} from "@automerge/automerge-repo/src/helpers/headsAreSame.js"
+import { headsAreSame } from "@automerge/automerge-repo/src/helpers/headsAreSame.js"
 
 describe("Websocket adapters", () => {
   const setup = async (clientCount = 1) => {
@@ -73,6 +80,7 @@ describe("Websocket adapters", () => {
       assert.deepEqual(message, {
         type: "join",
         senderId: "browser",
+        peerMetadata: { storageId: undefined, isEphemeral: true },
         supportedProtocolVersions: ["1"],
       })
     })
@@ -122,12 +130,12 @@ describe("Websocket adapters", () => {
       } = await setup()
 
       const peerId = "testclient" as PeerId
-      browser.connect(peerId)
+      browser.connect(peerId, undefined, true)
 
       // simulate the reconnect timer firing before the other end has responded
       // (which works here because we haven't yielded to the event loop yet so
       // the server, which is on the same event loop as us, can't respond)
-      browser.connect(peerId)
+      browser.connect(peerId, undefined, true)
 
       // Now yield, so the server responds on the first socket, if the listeners
       // are cleaned up correctly we shouldn't throw
@@ -156,11 +164,11 @@ describe("Websocket adapters", () => {
     }
 
     async function recvOrTimeout(socket: WebSocket): Promise<Buffer | null> {
-      return new Promise((resolve) => {
+      return new Promise(resolve => {
         const timer = setTimeout(() => {
           resolve(null)
         }, 1000)
-        socket.once("message", (msg) => {
+        socket.once("message", msg => {
           clearTimeout(timer)
           resolve(msg as Buffer)
         })
@@ -176,6 +184,7 @@ describe("Websocket adapters", () => {
       assert.deepEqual(response, {
         type: "peer",
         senderId: "server",
+        peerMetadata: { storageId: undefined, isEphemeral: true },
         targetId: "browser",
         selectedProtocolVersion: "1",
       })
@@ -203,26 +212,29 @@ describe("Websocket adapters", () => {
       assert.deepEqual(response, {
         type: "peer",
         senderId: "server",
+        peerMetadata: { storageId: undefined, isEphemeral: true },
         targetId: "browser",
         selectedProtocolVersion: "1",
       })
     })
 
-    /** 
+    /**
      *  Create a new document, initialized with the given contents and return a
      *  storage containign that document as well as the URL and a fork of the
      *  document
      *
      *  @param contents - The contents to initialize the document with
      */
-    async function initDocAndStorage<T extends Record<string, unknown>>(contents: T): Promise<{
-          storage: DummyStorageAdapter,
-          url: AutomergeUrl,
-          doc: A.Doc<T>,
-          documentId: DocumentId
-        }> {
+    async function initDocAndStorage<T extends Record<string, unknown>>(
+      contents: T
+    ): Promise<{
+      storage: DummyStorageAdapter
+      url: AutomergeUrl
+      doc: A.Doc<T>
+      documentId: DocumentId
+    }> {
       const storage = new DummyStorageAdapter()
-      const silentRepo = new Repo({storage, network: []})
+      const silentRepo = new Repo({ storage, network: [] })
       const doc = A.from<T>(contents)
       const handle = silentRepo.create()
       handle.update(() => A.clone(doc))
@@ -246,7 +258,10 @@ describe("Websocket adapters", () => {
       }
     }
 
-    function assertIsSyncMessage(forDocument: DocumentId, msg: Buffer | null): SyncMessage {
+    function assertIsSyncMessage(
+      forDocument: DocumentId,
+      msg: Buffer | null
+    ): SyncMessage {
       if (msg == null) {
         throw new Error("expected a peer message, got null")
       }
@@ -255,13 +270,15 @@ describe("Websocket adapters", () => {
         throw new Error(`expected a peer message, got type: ${decoded.type}`)
       }
       if (decoded.documentId !== forDocument) {
-        throw new Error(`expected a sync message for ${forDocument}, not for ${decoded.documentId}`)
+        throw new Error(
+          `expected a sync message for ${forDocument}, not for ${decoded.documentId}`
+        )
       }
       return decoded
     }
 
     it("should disconnect existing peers on reconnect before announcing them", async () => {
-      // This test exercises a sync loop which is exposed in the following 
+      // This test exercises a sync loop which is exposed in the following
       // sequence of events:
       //
       // 1. A document exists on both the server and the client with divergent
@@ -276,27 +293,33 @@ describe("Websocket adapters", () => {
       //    asks for them
       // 7. The server responds with an empty sync message because it thinks it
       //    has already sent the changes
-      // 
+      //
       // 6 and 7 continue in an infinite loop. The root cause is the servers
       // failure to clear the sync state associated with the given peer when
       // it receives a new connection from the same peer ID.
       const { socket, serverUrl } = await setup(0)
 
       // Create a doc, populate a DummyStorageAdapter with that doc
-      const {storage, url, doc, documentId} = await initDocAndStorage({foo: "bar"})
+      const { storage, url, doc, documentId } = await initDocAndStorage({
+        foo: "bar",
+      })
 
       // Create a copy of the document to represent the client state
-      let clientDoc = A.clone<{foo: string}>(doc)
-      clientDoc = A.change(clientDoc, d => d.foo = "qux")
+      let clientDoc = A.clone<{ foo: string }>(doc)
+      clientDoc = A.change(clientDoc, d => (d.foo = "qux"))
 
       // Now create a websocket sync server with the original document in it's storage
       const adapter = new NodeWSServerAdapter(socket)
-      const repo = new Repo({ network: [adapter], storage, peerId: "server" as PeerId })
+      const repo = new Repo({
+        network: [adapter],
+        storage,
+        peerId: "server" as PeerId,
+      })
 
       // make a change to the handle on the sync server
-      const handle = repo.find<{foo: string}>(url)
+      const handle = repo.find<{ foo: string }>(url)
       await handle.whenReady()
-      handle.change(d => d.foo = "baz")
+      handle.change(d => (d.foo = "baz"))
 
       // Okay, so now there is a document on both the client and the server
       // which has concurrent changes on each peer.
@@ -306,11 +329,13 @@ describe("Websocket adapters", () => {
       await once(clientSocket, "open")
 
       // Run through the client/server hello
-      clientSocket.send(CBOR.encode({
-        type: "join",
-        senderId: "client",
-        supportedProtocolVersions: ["1"],
-      }))
+      clientSocket.send(
+        CBOR.encode({
+          type: "join",
+          senderId: "client",
+          supportedProtocolVersions: ["1"],
+        })
+      )
 
       let response = await recvOrTimeout(clientSocket)
       assertIsPeerMessage(response)
@@ -318,24 +343,29 @@ describe("Websocket adapters", () => {
       // Okay now we start syncing
 
       let clientState = A.initSyncState()
-      let [newSyncState, message] = A.generateSyncMessage(clientDoc, clientState)
+      let [newSyncState, message] = A.generateSyncMessage(
+        clientDoc,
+        clientState
+      )
       clientState = newSyncState
 
       // Send the initial sync state
-      clientSocket.send(CBOR.encode({
-        type: "request",
-        documentId,
-        targetId: "server",
-        senderId: "client",
-        data: message
-      }))
+      clientSocket.send(
+        CBOR.encode({
+          type: "request",
+          documentId,
+          targetId: "server",
+          senderId: "client",
+          data: message,
+        })
+      )
 
       response = await recvOrTimeout(clientSocket)
       assertIsSyncMessage(documentId, response)
 
-      // Now, assume either the network or the server is going slow, so the 
+      // Now, assume either the network or the server is going slow, so the
       // server thinks it has sent the response above, but for whatever reason
-      // it never gets to the client. In that case the reconnect timer in the 
+      // it never gets to the client. In that case the reconnect timer in the
       // BrowserWebSocketClientAdapter will fire and we'll create a new
       // websocket and connect it. To simulate this we drop the above response
       // on the floor and start connecting again.
@@ -344,34 +374,42 @@ describe("Websocket adapters", () => {
       await once(clientSocket, "open")
 
       // and we also make a change to the client doc
-      clientDoc = A.change(clientDoc, d => d.foo = "quoxen")
+      clientDoc = A.change(clientDoc, d => (d.foo = "quoxen"))
 
       // Run through the whole client/server hello dance again
-      clientSocket.send(CBOR.encode({
-        type: "join",
-        senderId: "client",
-        supportedProtocolVersions: ["1"],
-      }))
+      clientSocket.send(
+        CBOR.encode({
+          type: "join",
+          senderId: "client",
+          supportedProtocolVersions: ["1"],
+        })
+      )
 
       response = await recvOrTimeout(clientSocket)
       assertIsPeerMessage(response)
 
       // Now, we start syncing. If we're not buggy, this loop should terminate.
-      while(true) {
+      while (true) {
         ;[clientState, message] = A.generateSyncMessage(clientDoc, clientState)
         if (message) {
-          clientSocket.send(CBOR.encode({
-            type: "sync",
-            documentId,
-            targetId: "server",
-            senderId: "client",
-            data: message
-          }))
+          clientSocket.send(
+            CBOR.encode({
+              type: "sync",
+              documentId,
+              targetId: "server",
+              senderId: "client",
+              data: message,
+            })
+          )
         }
         const response = await recvOrTimeout(clientSocket)
         if (response) {
           const decoded = assertIsSyncMessage(documentId, response)
-          ;[clientDoc, clientState] = A.receiveSyncMessage(clientDoc, clientState, decoded.data)
+          ;[clientDoc, clientState] = A.receiveSyncMessage(
+            clientDoc,
+            clientState,
+            decoded.data
+          )
         }
         if (response == null && message == null) {
           break