@automerge/automerge-repo 1.0.19 → 1.1.0-alpha.13

package/dist/Repo.js

@@ -3,6 +3,8 @@ import debug from "debug";
 import { EventEmitter } from "eventemitter3";
 import { generateAutomergeUrl, interpretAsDocumentId, parseAutomergeUrl, } from "./AutomergeUrl.js";
 import { DocHandle } from "./DocHandle.js";
+import { RemoteHeadsSubscriptions } from "./RemoteHeadsSubscriptions.js";
+import { headsAreSame } from "./helpers/headsAreSame.js";
 import { throttle } from "./helpers/throttle.js";
 import { NetworkSubsystem } from "./network/NetworkSubsystem.js";
 import { StorageSubsystem } from "./storage/StorageSubsystem.js";
@@ -29,8 +31,14 @@ export class Repo extends EventEmitter {
     /** By default, we share generously with all peers. */
     /** @hidden */
     sharePolicy = async () => true;
-    constructor({ storage, network, peerId, sharePolicy }) {
+    /** maps peer id to to persistence information (storageId, isEphemeral), access by collection synchronizer  */
+    /** @hidden */
+    peerMetadataByPeerId = {};
+    #remoteHeadsSubscriptions = new RemoteHeadsSubscriptions();
+    #remoteHeadsGossipingEnabled = false;
+    constructor({ storage, network, peerId, sharePolicy, isEphemeral = storage === undefined, enableRemoteHeadsGossiping = false, }) {
         super();
+        this.#remoteHeadsGossipingEnabled = enableRemoteHeadsGossiping;
         this.#log = debug(`automerge-repo:repo`);
         this.sharePolicy = sharePolicy ?? this.sharePolicy;
         // DOC COLLECTION
@@ -42,7 +50,7 @@ export class Repo extends EventEmitter {
                 const saveFn = ({ handle, doc, }) => {
                     void storageSubsystem.saveDoc(handle.documentId, doc);
                 };
-                const debouncedSaveFn = handle.on("heads-changed", throttle(saveFn, this.saveDebounceRate));
+                handle.on("heads-changed", throttle(saveFn, this.saveDebounceRate));
                 if (isNew) {
                     // this is a new document, immediately save it
                     await storageSubsystem.saveDoc(handle.documentId, handle.docSync());
@@ -95,33 +103,137 @@ export class Repo extends EventEmitter {
             this.#log(`sending ${message.type} message to ${message.targetId}`);
             networkSubsystem.send(message);
         });
+        if (this.#remoteHeadsGossipingEnabled) {
+            this.#synchronizer.on("open-doc", ({ peerId, documentId }) => {
+                this.#remoteHeadsSubscriptions.subscribePeerToDoc(peerId, documentId);
+            });
+        }
         // STORAGE
         // The storage subsystem has access to some form of persistence, and deals with save and loading documents.
         const storageSubsystem = storage ? new StorageSubsystem(storage) : undefined;
         this.storageSubsystem = storageSubsystem;
         // NETWORK
         // The network subsystem deals with sending and receiving messages to and from peers.
-        const networkSubsystem = new NetworkSubsystem(network, peerId);
+        const myPeerMetadata = new Promise(
+        // eslint-disable-next-line no-async-promise-executor -- TODO: fix
+        async (resolve) => resolve({
+            storageId: await storageSubsystem?.id(),
+            isEphemeral,
+        }));
+        const networkSubsystem = new NetworkSubsystem(network, peerId, myPeerMetadata);
         this.networkSubsystem = networkSubsystem;
         // When we get a new peer, register it with the synchronizer
-        networkSubsystem.on("peer", async ({ peerId }) => {
+        networkSubsystem.on("peer", async ({ peerId, peerMetadata }) => {
             this.#log("peer connected", { peerId });
+            if (peerMetadata) {
+                this.peerMetadataByPeerId[peerId] = { ...peerMetadata };
+            }
+            this.sharePolicy(peerId)
+                .then(shouldShare => {
+                if (shouldShare && this.#remoteHeadsGossipingEnabled) {
+                    this.#remoteHeadsSubscriptions.addGenerousPeer(peerId);
+                }
+            })
+                .catch(err => {
+                console.log("error in share policy", { err });
+            });
             this.#synchronizer.addPeer(peerId);
         });
         // When a peer disconnects, remove it from the synchronizer
         networkSubsystem.on("peer-disconnected", ({ peerId }) => {
             this.#synchronizer.removePeer(peerId);
+            this.#remoteHeadsSubscriptions.removePeer(peerId);
         });
         // Handle incoming messages
         networkSubsystem.on("message", async (msg) => {
-            await this.#synchronizer.receiveMessage(msg);
+            this.#receiveMessage(msg);
         });
-        if (storageSubsystem) {
-            const debouncedSaveSyncState = throttle(({ documentId, peerId, syncState }) => {
-                storageSubsystem.saveSyncState(documentId, peerId, syncState);
+        this.#synchronizer.on("sync-state", message => {
+            this.#saveSyncState(message);
+            const handle = this.#handleCache[message.documentId];
+            const { storageId } = this.peerMetadataByPeerId[message.peerId] || {};
+            if (!storageId) {
+                return;
+            }
+            const heads = handle.getRemoteHeads(storageId);
+            const haveHeadsChanged = message.syncState.theirHeads &&
+                (!heads || !headsAreSame(heads, message.syncState.theirHeads));
+            if (haveHeadsChanged) {
+                handle.setRemoteHeads(storageId, message.syncState.theirHeads);
+                if (storageId && this.#remoteHeadsGossipingEnabled) {
+                    this.#remoteHeadsSubscriptions.handleImmediateRemoteHeadsChanged(message.documentId, storageId, message.syncState.theirHeads);
+                }
+            }
+        });
+        if (this.#remoteHeadsGossipingEnabled) {
+            this.#remoteHeadsSubscriptions.on("notify-remote-heads", message => {
+                this.networkSubsystem.send({
+                    type: "remote-heads-changed",
+                    targetId: message.targetId,
+                    documentId: message.documentId,
+                    newHeads: {
+                        [message.storageId]: {
+                            heads: message.heads,
+                            timestamp: message.timestamp,
+                        },
+                    },
+                });
+            });
+            this.#remoteHeadsSubscriptions.on("change-remote-subs", message => {
+                this.#log("change-remote-subs", message);
+                for (const peer of message.peers) {
+                    this.networkSubsystem.send({
+                        type: "remote-subscription-change",
+                        targetId: peer,
+                        add: message.add,
+                        remove: message.remove,
+                    });
+                }
+            });
+            this.#remoteHeadsSubscriptions.on("remote-heads-changed", message => {
+                const handle = this.#handleCache[message.documentId];
+                handle.setRemoteHeads(message.storageId, message.remoteHeads);
+            });
+        }
+    }
+    #receiveMessage(message) {
+        switch (message.type) {
+            case "remote-subscription-change":
+                if (this.#remoteHeadsGossipingEnabled) {
+                    this.#remoteHeadsSubscriptions.handleControlMessage(message);
+                }
+                break;
+            case "remote-heads-changed":
+                if (this.#remoteHeadsGossipingEnabled) {
+                    this.#remoteHeadsSubscriptions.handleRemoteHeads(message);
+                }
+                break;
+            case "sync":
+            case "request":
+            case "ephemeral":
+            case "doc-unavailable":
+                this.#synchronizer.receiveMessage(message).catch(err => {
+                    console.log("error receiving message", { err });
+                });
+        }
+    }
+    #throttledSaveSyncStateHandlers = {};
+    /** saves sync state throttled per storage id, if a peer doesn't have a storage id it's sync state is not persisted */
+    #saveSyncState(payload) {
+        if (!this.storageSubsystem) {
+            return;
+        }
+        const { storageId, isEphemeral } = this.peerMetadataByPeerId[payload.peerId] || {};
+        if (!storageId || isEphemeral) {
+            return;
+        }
+        let handler = this.#throttledSaveSyncStateHandlers[storageId];
+        if (!handler) {
+            handler = this.#throttledSaveSyncStateHandlers[storageId] = throttle(({ documentId, syncState }) => {
+                void this.storageSubsystem.saveSyncState(documentId, storageId, syncState);
             }, this.saveDebounceRate);
-            this.#synchronizer.on("sync-state", debouncedSaveSyncState);
         }
+        handler(payload);
     }
     /** Returns an existing handle if we have it; creates one otherwise. */
     #getHandle(
@@ -147,6 +259,9 @@ export class Repo extends EventEmitter {
     get peers() {
         return this.#synchronizer.peers;
     }
+    getStorageIdOfPeer(peerId) {
+        return this.peerMetadataByPeerId[peerId]?.storageId;
+    }
     /**
      * Creates a new document and returns a handle to it. The initial value of the document is
      * an empty object `{}`. Its documentId is generated by the system. we emit a `document` event
@@ -237,4 +352,48 @@ export class Repo extends EventEmitter {
         delete this.#handleCache[documentId];
         this.emit("delete-document", { documentId });
     }
+    /**
+     * Exports a document to a binary format.
+     * @param id - The url or documentId of the handle to export
+     *
+     * @returns Promise<Uint8Array | undefined> - A Promise containing the binary document,
+     * or undefined if the document is unavailable.
+     */
+    async export(id) {
+        const documentId = interpretAsDocumentId(id);
+        const handle = this.#getHandle(documentId, false);
+        const doc = await handle.doc();
+        if (!doc)
+            return undefined;
+        return Automerge.save(doc);
+    }
+    /**
+     * Imports document binary into the repo.
+     * @param binary - The binary to import
+     */
+    import(binary) {
+        const doc = Automerge.load(binary);
+        const handle = this.create();
+        handle.update(() => {
+            return Automerge.clone(doc);
+        });
+        return handle;
+    }
+    subscribeToRemotes = (remotes) => {
+        if (this.#remoteHeadsGossipingEnabled) {
+            this.#log("subscribeToRemotes", { remotes });
+            this.#remoteHeadsSubscriptions.subscribeToRemotes(remotes);
+        }
+        else {
+            this.#log("WARN: subscribeToRemotes called but remote heads gossiping is not enabled");
+        }
+    };
+    storageId = async () => {
+        if (!this.storageSubsystem) {
+            return undefined;
+        }
+        else {
+            return this.storageSubsystem.id();
+        }
+    };
 }

package/dist/helpers/debounce.js

@@ -15,7 +15,7 @@ export const throttle = (fn, rate) => {
     return function (...args) {
         clearTimeout(timeout);
         timeout = setTimeout(() => {
-            fn.apply(null, args);
+            fn(...args);
         }, rate);
     };
 };

package/dist/helpers/pause.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pause.d.ts","sourceRoot":"","sources":["../../src/helpers/pause.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,KAAK,+BAC4C,CAAA;AAE9D,wBAAgB,eAAe,CAAC,CAAC,EAC/B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,CAAC,CAAC,CAOZ"}
+{"version":3,"file":"pause.d.ts","sourceRoot":"","sources":["../../src/helpers/pause.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,KAAK,+BAC4C,CAAA;AAE9D,wBAAgB,eAAe,CAAC,CAAC,EAC/B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,CAAC,CAAC,CAOZ"}

package/dist/helpers/pause.js

@@ -1,3 +1,4 @@
+/* c8 ignore start */
 export const pause = (t = 0) => new Promise(resolve => setTimeout(() => resolve(), t));
 export function rejectOnTimeout(promise, millis) {
     return Promise.race([
@@ -7,3 +8,4 @@ export function rejectOnTimeout(promise, millis) {
         }),
     ]);
 }
+/* c8 ignore end */

package/dist/helpers/throttle.js

@@ -32,7 +32,7 @@ export const throttle = (fn, delay) => {
         wait = lastCall + delay - Date.now();
         clearTimeout(timeout);
         timeout = setTimeout(() => {
-            fn.apply(null, args);
+            fn(...args);
             lastCall = Date.now();
         }, wait);
     };

package/dist/helpers/withTimeout.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"withTimeout.d.ts","sourceRoot":"","sources":["../../src/helpers/withTimeout.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,WAAW,8BAEnB,MAAM,eAcV,CAAA;AAED,qBAAa,YAAa,SAAQ,KAAK;gBACzB,OAAO,EAAE,MAAM;CAI5B"}
+{"version":3,"file":"withTimeout.d.ts","sourceRoot":"","sources":["../../src/helpers/withTimeout.ts"],"names":[],"mappings":"AACA;;;GAGG;AACH,eAAO,MAAM,WAAW,8BAEnB,MAAM,eAcV,CAAA;AAED,qBAAa,YAAa,SAAQ,KAAK;gBACzB,OAAO,EAAE,MAAM;CAI5B"}

package/dist/helpers/withTimeout.js

@@ -1,3 +1,4 @@
+/* c8 ignore start */
 /**
  * If `promise` is resolved before `t` ms elapse, the timeout is cleared and the result of the
  * promise is returned. If the timeout ends first, a `TimeoutError` is thrown.
@@ -20,3 +21,4 @@ export class TimeoutError extends Error {
         this.name = "TimeoutError";
     }
 }
+/* c8 ignore end */

package/dist/index.d.ts

@@ -29,14 +29,14 @@ export { DocHandle } from "./DocHandle.js";
 export { isValidAutomergeUrl, parseAutomergeUrl, stringifyAutomergeUrl, } from "./AutomergeUrl.js";
 export { Repo } from "./Repo.js";
 export { NetworkAdapter } from "./network/NetworkAdapter.js";
-export { isValidRepoMessage } from "./network/messages.js";
+export { isRepoMessage } from "./network/messages.js";
 export { StorageAdapter } from "./storage/StorageAdapter.js";
 /** @hidden **/
 export * as cbor from "./helpers/cbor.js";
 export type { DocHandleChangePayload, DocHandleDeletePayload, DocHandleEncodedChangePayload, DocHandleEphemeralMessagePayload, DocHandleRemoteHeadsPayload, DocHandleEvents, DocHandleOptions, DocHandleOutboundEphemeralMessagePayload, HandleState, } from "./DocHandle.js";
 export type { DeleteDocumentPayload, DocumentPayload, RepoConfig, RepoEvents, SharePolicy, } from "./Repo.js";
-export type { NetworkAdapterEvents, OpenPayload, PeerCandidatePayload, PeerDisconnectedPayload, } from "./network/NetworkAdapter.js";
+export type { NetworkAdapterEvents, OpenPayload, PeerCandidatePayload, PeerDisconnectedPayload, PeerMetadata, } from "./network/NetworkAdapter.js";
 export type { DocumentUnavailableMessage, EphemeralMessage, Message, RepoMessage, RequestMessage, SyncMessage, } from "./network/messages.js";
-export type { Chunk, ChunkInfo, ChunkType, StorageKey, } from "./storage/types.js";
+export type { Chunk, ChunkInfo, ChunkType, StorageKey, StorageId, } from "./storage/types.js";
 export * from "./types.js";
 //# 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;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAE5D,eAAe;AACf,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAA;AAIzC,YAAY,EACV,sBAAsB,EACtB,sBAAsB,EACtB,6BAA6B,EAC7B,gCAAgC,EAChC,2BAA2B,EAC3B,eAAe,EACf,gBAAgB,EAChB,wCAAwC,EACxC,WAAW,GACZ,MAAM,gBAAgB,CAAA;AAEvB,YAAY,EACV,qBAAqB,EACrB,eAAe,EACf,UAAU,EACV,UAAU,EACV,WAAW,GACZ,MAAM,WAAW,CAAA;AAElB,YAAY,EACV,oBAAoB,EACpB,WAAW,EACX,oBAAoB,EACpB,uBAAuB,GACxB,MAAM,6BAA6B,CAAA;AAEpC,YAAY,EACV,0BAA0B,EAC1B,gBAAgB,EAChB,OAAO,EACP,WAAW,EACX,cAAc,EACd,WAAW,GACZ,MAAM,uBAAuB,CAAA;AAE9B,YAAY,EACV,KAAK,EACL,SAAS,EACT,SAAS,EACT,UAAU,GACX,MAAM,oBAAoB,CAAA;AAE3B,cAAc,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAE5D,eAAe;AACf,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAA;AAIzC,YAAY,EACV,sBAAsB,EACtB,sBAAsB,EACtB,6BAA6B,EAC7B,gCAAgC,EAChC,2BAA2B,EAC3B,eAAe,EACf,gBAAgB,EAChB,wCAAwC,EACxC,WAAW,GACZ,MAAM,gBAAgB,CAAA;AAEvB,YAAY,EACV,qBAAqB,EACrB,eAAe,EACf,UAAU,EACV,UAAU,EACV,WAAW,GACZ,MAAM,WAAW,CAAA;AAElB,YAAY,EACV,oBAAoB,EACpB,WAAW,EACX,oBAAoB,EACpB,uBAAuB,EACvB,YAAY,GACb,MAAM,6BAA6B,CAAA;AAEpC,YAAY,EACV,0BAA0B,EAC1B,gBAAgB,EAChB,OAAO,EACP,WAAW,EACX,cAAc,EACd,WAAW,GACZ,MAAM,uBAAuB,CAAA;AAE9B,YAAY,EACV,KAAK,EACL,SAAS,EACT,SAAS,EACT,UAAU,EACV,SAAS,GACV,MAAM,oBAAoB,CAAA;AAE3B,cAAc,YAAY,CAAA"}

package/dist/index.js

@@ -29,7 +29,7 @@ export { DocHandle } from "./DocHandle.js";
 export { isValidAutomergeUrl, parseAutomergeUrl, stringifyAutomergeUrl, } from "./AutomergeUrl.js";
 export { Repo } from "./Repo.js";
 export { NetworkAdapter } from "./network/NetworkAdapter.js";
-export { isValidRepoMessage } from "./network/messages.js";
+export { isRepoMessage } from "./network/messages.js";
 export { StorageAdapter } from "./storage/StorageAdapter.js";
 /** @hidden **/
 export * as cbor from "./helpers/cbor.js";

package/dist/network/NetworkAdapter.d.ts

@@ -1,6 +1,17 @@
 import { EventEmitter } from "eventemitter3";
 import { PeerId } from "../types.js";
 import { Message } from "./messages.js";
+import { StorageId } from "../storage/types.js";
+/**
+ * Describes a peer intent to the system
+ * storageId: the key for syncState to decide what the other peer already has
+ * isEphemeral: to decide if we bother recording this peer's sync state
+ *
+ */
+export interface PeerMetadata {
+    storageId?: StorageId;
+    isEphemeral?: boolean;
+}
 /** An interface representing some way to connect to other peers
  *
  * @remarks
@@ -10,11 +21,13 @@ import { Message } from "./messages.js";
  */
 export declare abstract class NetworkAdapter extends EventEmitter<NetworkAdapterEvents> {
     peerId?: PeerId;
+    peerMetadata?: PeerMetadata;
     /** Called by the {@link Repo} to start the connection process
      *
      * @argument peerId - the peerId of this repo
+     * @argument peerMetadata - how this adapter should present itself to other peers
      */
-    abstract connect(peerId: PeerId): void;
+    abstract connect(peerId: PeerId, peerMetadata?: PeerMetadata): void;
     /** Called by the {@link Repo} to send a message to a peer
      *
      * @argument message - the message to send
@@ -40,6 +53,7 @@ export interface OpenPayload {
 }
 export interface PeerCandidatePayload {
     peerId: PeerId;
+    peerMetadata: PeerMetadata;
 }
 export interface PeerDisconnectedPayload {
     peerId: PeerId;

package/dist/network/NetworkAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NetworkAdapter.d.ts","sourceRoot":"","sources":["../../src/network/NetworkAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAEvC;;;;;;GAMG;AACH,8BAAsB,cAAe,SAAQ,YAAY,CAAC,oBAAoB,CAAC;IAC7E,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAEtC;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAErC,gEAAgE;IAChE,QAAQ,CAAC,UAAU,IAAI,IAAI;CAC5B;AAID,MAAM,WAAW,oBAAoB;IACnC,mDAAmD;IACnD,KAAK,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAA;IAErC,yCAAyC;IACzC,KAAK,EAAE,MAAM,IAAI,CAAA;IAEjB,+DAA+D;IAC/D,gBAAgB,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAEzD,2EAA2E;IAC3E,mBAAmB,EAAE,CAAC,OAAO,EAAE,uBAAuB,KAAK,IAAI,CAAA;IAE/D,sEAAsE;IACtE,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;CACpC;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,cAAc,CAAA;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAA;CACf"}
+{"version":3,"file":"NetworkAdapter.d.ts","sourceRoot":"","sources":["../../src/network/NetworkAdapter.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAE/C;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB;AAED;;;;;;GAMG;AACH,8BAAsB,cAAe,SAAQ,YAAY,CAAC,oBAAoB,CAAC;IAC7E,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,IAAI;IAEnE;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAErC,gEAAgE;IAChE,QAAQ,CAAC,UAAU,IAAI,IAAI;CAC5B;AAID,MAAM,WAAW,oBAAoB;IACnC,mDAAmD;IACnD,KAAK,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAA;IAErC,yCAAyC;IACzC,KAAK,EAAE,MAAM,IAAI,CAAA;IAEjB,+DAA+D;IAC/D,gBAAgB,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAEzD,2EAA2E;IAC3E,mBAAmB,EAAE,CAAC,OAAO,EAAE,uBAAuB,KAAK,IAAI,CAAA;IAE/D,sEAAsE;IACtE,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;CACpC;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,cAAc,CAAA;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,YAAY,CAAA;CAC3B;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAA;CACf"}

package/dist/network/NetworkAdapter.js

@@ -1,3 +1,4 @@
+/* c8 ignore start */
 import { EventEmitter } from "eventemitter3";
 /** An interface representing some way to connect to other peers
  *
@@ -7,5 +8,6 @@ import { EventEmitter } from "eventemitter3";
  * until the adapter emits a `ready` event before it starts trying to use it
  */
 export class NetworkAdapter extends EventEmitter {
-    peerId; // hmmm, maybe not
+    peerId;
+    peerMetadata;
 }

package/dist/network/NetworkSubsystem.d.ts

@@ -1,11 +1,12 @@
 import { EventEmitter } from "eventemitter3";
 import { PeerId } from "../types.js";
-import { NetworkAdapter, PeerDisconnectedPayload } from "./NetworkAdapter.js";
+import type { NetworkAdapter, PeerDisconnectedPayload, PeerMetadata } from "./NetworkAdapter.js";
 import { MessageContents, RepoMessage } from "./messages.js";
 export declare class NetworkSubsystem extends EventEmitter<NetworkSubsystemEvents> {
     #private;
     peerId: PeerId;
-    constructor(adapters: NetworkAdapter[], peerId?: PeerId);
+    private peerMetadata;
+    constructor(adapters: NetworkAdapter[], peerId: PeerId, peerMetadata: Promise<PeerMetadata>);
     addNetworkAdapter(networkAdapter: NetworkAdapter): void;
     send(message: MessageContents): void;
     isReady: () => boolean;
@@ -19,5 +20,6 @@ export interface NetworkSubsystemEvents {
 }
 export interface PeerPayload {
     peerId: PeerId;
+    peerMetadata: PeerMetadata;
 }
 //# sourceMappingURL=NetworkSubsystem.d.ts.map

package/dist/network/NetworkSubsystem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NetworkSubsystem.d.ts","sourceRoot":"","sources":["../../src/network/NetworkSubsystem.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,MAAM,EAAa,MAAM,aAAa,CAAA;AAC/C,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAA;AAC7E,OAAO,EAEL,eAAe,EACf,WAAW,EAGZ,MAAM,eAAe,CAAA;AAOtB,qBAAa,gBAAiB,SAAQ,YAAY,CAAC,sBAAsB,CAAC;;IAUzB,MAAM;gBAAzC,QAAQ,EAAE,cAAc,EAAE,EAAS,MAAM,SAAiB;IAMtE,iBAAiB,CAAC,cAAc,EAAE,cAAc;IAsEhD,IAAI,CAAC,OAAO,EAAE,eAAe;IAsC7B,OAAO,gBAEN;IAED,SAAS,sBAUR;CACF;AAQD,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAA;IACpC,mBAAmB,EAAE,CAAC,OAAO,EAAE,uBAAuB,KAAK,IAAI,CAAA;IAC/D,OAAO,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAA;IACvC,KAAK,EAAE,MAAM,IAAI,CAAA;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;CACf"}
+{"version":3,"file":"NetworkSubsystem.d.ts","sourceRoot":"","sources":["../../src/network/NetworkSubsystem.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,MAAM,EAAa,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EACV,cAAc,EACd,uBAAuB,EACvB,YAAY,EACb,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAEL,eAAe,EACf,WAAW,EAGZ,MAAM,eAAe,CAAA;AAOtB,qBAAa,gBAAiB,SAAQ,YAAY,CAAC,sBAAsB,CAAC;;IAY/D,MAAM;IACb,OAAO,CAAC,YAAY;gBAFpB,QAAQ,EAAE,cAAc,EAAE,EACnB,MAAM,QAAiB,EACtB,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;IAO7C,iBAAiB,CAAC,cAAc,EAAE,cAAc;IAyEhD,IAAI,CAAC,OAAO,EAAE,eAAe;IAsC7B,OAAO,gBAEN;IAED,SAAS,sBAUR;CACF;AAQD,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAA;IACpC,mBAAmB,EAAE,CAAC,OAAO,EAAE,uBAAuB,KAAK,IAAI,CAAA;IAC/D,OAAO,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAA;IACvC,KAAK,EAAE,MAAM,IAAI,CAAA;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,YAAY,CAAA;CAC3B"}

package/dist/network/NetworkSubsystem.js

@@ -1,9 +1,10 @@
 import debug from "debug";
 import { EventEmitter } from "eventemitter3";
-import { isEphemeralMessage, isValidRepoMessage, } from "./messages.js";
+import { isEphemeralMessage, isRepoMessage, } from "./messages.js";
 const getEphemeralMessageSource = (message) => `${message.senderId}:${message.sessionId}`;
 export class NetworkSubsystem extends EventEmitter {
     peerId;
+    peerMetadata;
     #log;
     #adaptersByPeer = {};
     #count = 0;
@@ -11,9 +12,10 @@ export class NetworkSubsystem extends EventEmitter {
     #ephemeralSessionCounts = {};
     #readyAdapterCount = 0;
     #adapters = [];
-    constructor(adapters, peerId = randomPeerId()) {
+    constructor(adapters, peerId = randomPeerId(), peerMetadata) {
         super();
         this.peerId = peerId;
+        this.peerMetadata = peerMetadata;
         this.#log = debug(`automerge-repo:network:${this.peerId}`);
         adapters.forEach(a => this.addNetworkAdapter(a));
     }
@@ -26,14 +28,14 @@ export class NetworkSubsystem extends EventEmitter {
                 this.emit("ready");
             }
         });
-        networkAdapter.on("peer-candidate", ({ peerId }) => {
+        networkAdapter.on("peer-candidate", ({ peerId, peerMetadata }) => {
             this.#log(`peer candidate: ${peerId} `);
             // TODO: This is where authentication would happen
             if (!this.#adaptersByPeer[peerId]) {
                 // TODO: handle losing a server here
                 this.#adaptersByPeer[peerId] = networkAdapter;
             }
-            this.emit("peer", { peerId });
+            this.emit("peer", { peerId, peerMetadata });
         });
         networkAdapter.on("peer-disconnected", ({ peerId }) => {
             this.#log(`peer disconnected: ${peerId} `);
@@ -41,7 +43,7 @@ export class NetworkSubsystem extends EventEmitter {
             this.emit("peer-disconnected", { peerId });
         });
         networkAdapter.on("message", msg => {
-            if (!isValidRepoMessage(msg)) {
+            if (!isRepoMessage(msg)) {
                 this.#log(`invalid message: ${JSON.stringify(msg)}`);
                 return;
             }
@@ -65,7 +67,11 @@ export class NetworkSubsystem extends EventEmitter {
                 }
             });
         });
-        networkAdapter.connect(this.peerId);
+        this.peerMetadata.then(peerMetadata => {
+            networkAdapter.connect(this.peerId, peerMetadata);
+        }).catch(err => {
+            this.#log("error connecting to network", err);
+        });
     }
     send(message) {
         const peer = this.#adaptersByPeer[message.targetId];
@@ -101,7 +107,7 @@ export class NetworkSubsystem extends EventEmitter {
             }
         };
         const outbound = prepareMessage(message);
-        this.#log("sending message", outbound);
+        this.#log("sending message %o", outbound);
         peer.send(outbound);
     }
     isReady = () => {