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

package/README.md

@@ -45,6 +45,10 @@ A `Repo` exposes these methods:
   networks.
 - `delete(docId: DocumentId)`  
   Deletes the local copy of a document from the local cache and local storage. _This does not currently delete the document from any other peers_.
+- `import(binary: Uint8Array)`  
+  Imports a document binary (from `export()` or `Automerge.save(doc)`) into the repo, returning a new handle
+- `export(docId: DocumentId)`  
+  Exports the document. Returns a Promise containing either the Uint8Array of the document or undefined if the document is currently unavailable. See the [Automerge binary format spec](https://automerge.org/automerge-binary-format-spec/) for more details on the shape of the Uint8Array.
 - `.on("document", ({handle: DocHandle}) => void)`  
   Registers a callback to be fired each time a new document is loaded or created.
 - `.on("delete-document", ({handle: DocHandle}) => void)`  
@@ -64,7 +68,7 @@ the document.
 
 A `DocHandle` also emits these events:
 
-- `change({handle: DocHandle, patches: Patch[], patchInfo: PatchInfo})` 
+- `change({handle: DocHandle, patches: Patch[], patchInfo: PatchInfo})`
   Called whenever the document changes, the handle's .doc
 - `delete`  
   Called when the document is deleted locally.
@@ -85,11 +89,12 @@ network adapter:
 const repo = new Repo({
   network: [new BroadcastChannelNetworkAdapter()],
   storage: new IndexedDBStorageAdapter(),
-  sharePolicy: async (peerId: PeerId, documentId: DocumentId) => true // this is the default
+  sharePolicy: async (peerId: PeerId, documentId: DocumentId) => true, // this is the default
 })
 ```
 
 ### Share Policy
+
 The share policy is used to determine which document in your repo should be _automatically_ shared with other peers. **The default setting is to share all documents with all peers.**
 
 > **Warning**
@@ -99,7 +104,6 @@ You can override this by providing a custom share policy. The function should re
 
 The share policy will not stop a document being _requested_ by another peer by its `DocumentId`.
 
-```ts
 ## Starting the demo app
 
 ```bash
@@ -272,7 +276,8 @@ you'll need to manually copy the `rootDocId` value between the browsers.)
 Originally authored by Peter van Hardenberg.
 
 With gratitude for contributions by:
- - Herb Caudill
- - Jeremy Rose
- - Alex Currie-Clark
- - Dylan Mackenzie
+
+- Herb Caudill
+- Jeremy Rose
+- Alex Currie-Clark
+- Dylan Mackenzie

package/dist/AutomergeUrl.js

@@ -4,7 +4,7 @@ export const urlPrefix = "automerge:";
 /** Given an Automerge URL, returns the DocumentId in both base58check-encoded form and binary form */
 export const parseAutomergeUrl = (url) => {
     const regex = new RegExp(`^${urlPrefix}(\\w+)$`);
-    const [_, docMatch] = url.match(regex) || [];
+    const [, docMatch] = url.match(regex) || [];
     const documentId = docMatch;
     const binaryDocumentId = documentIdToBinary(documentId);
     if (!binaryDocumentId)
@@ -21,7 +21,7 @@ export const parseAutomergeUrl = (url) => {
  * Throws on invalid input.
  */
 export const stringifyAutomergeUrl = (arg) => {
-    let documentId = arg instanceof Uint8Array || typeof arg === "string"
+    const documentId = arg instanceof Uint8Array || typeof arg === "string"
         ? arg
         : "documentId" in arg
             ? arg.documentId

package/dist/RemoteHeadsSubscriptions.d.ts

@@ -36,6 +36,7 @@ export declare class RemoteHeadsSubscriptions extends EventEmitter<RemoteHeadsSu
     handleImmediateRemoteHeadsChanged(documentId: DocumentId, storageId: StorageId, heads: A.Heads): void;
     addGenerousPeer(peerId: PeerId): void;
     removePeer(peerId: PeerId): void;
+    subscribePeerToDoc(peerId: PeerId, documentId: DocumentId): void;
 }
 export {};
 //# sourceMappingURL=RemoteHeadsSubscriptions.d.ts.map

package/dist/RemoteHeadsSubscriptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RemoteHeadsSubscriptions.d.ts","sourceRoot":"","sources":["../src/RemoteHeadsSubscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,CAAC,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAC/C,OAAO,EACL,kBAAkB,EAClB,gCAAgC,EACjC,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAItC,MAAM,MAAM,mCAAmC,GAAG;IAChD,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,SAAS,CAAA;IACpB,WAAW,EAAE,CAAC,CAAC,KAAK,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAGD,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,SAAS,CAAA;IACpB,KAAK,EAAE,CAAC,CAAC,KAAK,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,KAAK,6BAA6B,GAAG;IACnC,sBAAsB,EAAE,CAAC,OAAO,EAAE,mCAAmC,KAAK,IAAI,CAAA;IAC9E,oBAAoB,EAAE,CAAC,OAAO,EAAE;QAC9B,KAAK,EAAE,MAAM,EAAE,CAAA;QACf,GAAG,CAAC,EAAE,SAAS,EAAE,CAAA;QACjB,MAAM,CAAC,EAAE,SAAS,EAAE,CAAA;KACrB,KAAK,IAAI,CAAA;IACV,qBAAqB,EAAE,CAAC,OAAO,EAAE,wBAAwB,KAAK,IAAI,CAAA;CACnE,CAAA;AAED,qBAAa,wBAAyB,SAAQ,YAAY,CAAC,6BAA6B,CAAC;;IAWvF,kBAAkB,CAAC,OAAO,EAAE,SAAS,EAAE;IAkBvC,sBAAsB,CAAC,OAAO,EAAE,SAAS,EAAE;IAsB3C,oBAAoB,CAAC,OAAO,EAAE,gCAAgC;IA4C9D,sEAAsE;IACtE,iBAAiB,CAAC,GAAG,EAAE,kBAAkB;IA8CzC,kEAAkE;IAClE,iCAAiC,CAC/B,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,CAAC,CAAC,KAAK;IA8BhB,eAAe,CAAC,MAAM,EAAE,MAAM;IAwB9B,UAAU,CAAC,MAAM,EAAE,MAAM;CA+D1B"}
+{"version":3,"file":"RemoteHeadsSubscriptions.d.ts","sourceRoot":"","sources":["../src/RemoteHeadsSubscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,CAAC,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAC/C,OAAO,EACL,kBAAkB,EAClB,gCAAgC,EACjC,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAItC,MAAM,MAAM,mCAAmC,GAAG;IAChD,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,SAAS,CAAA;IACpB,WAAW,EAAE,CAAC,CAAC,KAAK,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAGD,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,SAAS,CAAA;IACpB,KAAK,EAAE,CAAC,CAAC,KAAK,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,KAAK,6BAA6B,GAAG;IACnC,sBAAsB,EAAE,CAAC,OAAO,EAAE,mCAAmC,KAAK,IAAI,CAAA;IAC9E,oBAAoB,EAAE,CAAC,OAAO,EAAE;QAC9B,KAAK,EAAE,MAAM,EAAE,CAAA;QACf,GAAG,CAAC,EAAE,SAAS,EAAE,CAAA;QACjB,MAAM,CAAC,EAAE,SAAS,EAAE,CAAA;KACrB,KAAK,IAAI,CAAA;IACV,qBAAqB,EAAE,CAAC,OAAO,EAAE,wBAAwB,KAAK,IAAI,CAAA;CACnE,CAAA;AAED,qBAAa,wBAAyB,SAAQ,YAAY,CAAC,6BAA6B,CAAC;;IAcvF,kBAAkB,CAAC,OAAO,EAAE,SAAS,EAAE;IAkBvC,sBAAsB,CAAC,OAAO,EAAE,SAAS,EAAE;IAsB3C,oBAAoB,CAAC,OAAO,EAAE,gCAAgC;IA0E9D,sEAAsE;IACtE,iBAAiB,CAAC,GAAG,EAAE,kBAAkB;IAgDzC,kEAAkE;IAClE,iCAAiC,CAC/B,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,CAAC,CAAC,KAAK;IAgChB,eAAe,CAAC,MAAM,EAAE,MAAM;IAwB9B,UAAU,CAAC,MAAM,EAAE,MAAM;IA2BzB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU;CAoE1D"}

package/dist/RemoteHeadsSubscriptions.js

@@ -9,6 +9,8 @@ export class RemoteHeadsSubscriptions extends EventEmitter {
     #theirSubscriptions = new Map();
     // Peers we will always share remote heads with even if they are not subscribed
     #generousPeers = new Set();
+    // Documents each peer has open, we need this information so we only send remote heads of documents that the peer knows
+    #subscribedDocsByPeer = new Map();
     #log = debug("automerge-repo:remote-heads-subscriptions");
     subscribeToRemotes(remotes) {
         this.#log("subscribeToRemotes", remotes);
@@ -47,10 +49,14 @@ export class RemoteHeadsSubscriptions extends EventEmitter {
     handleControlMessage(control) {
         const remotesToAdd = [];
         const remotesToRemove = [];
+        const addedRemotesWeKnow = [];
         this.#log("handleControlMessage", control);
         if (control.add) {
             for (const remote of control.add) {
                 let theirSubs = this.#theirSubscriptions.get(remote);
+                if (this.#ourSubscriptions.has(remote) || theirSubs) {
+                    addedRemotesWeKnow.push(remote);
+                }
                 if (!theirSubs) {
                     theirSubs = new Set();
                     this.#theirSubscriptions.set(remote, theirSubs);
@@ -80,6 +86,28 @@ export class RemoteHeadsSubscriptions extends EventEmitter {
                 remove: remotesToRemove,
             });
         }
+        // send all our stored heads of documents the peer knows for the remotes they've added
+        for (const remote of addedRemotesWeKnow) {
+            const subscribedDocs = this.#subscribedDocsByPeer.get(control.senderId);
+            if (subscribedDocs) {
+                for (const documentId of subscribedDocs) {
+                    const knownHeads = this.#knownHeads.get(documentId);
+                    if (!knownHeads) {
+                        continue;
+                    }
+                    const lastHeads = knownHeads.get(remote);
+                    if (lastHeads) {
+                        this.emit("notify-remote-heads", {
+                            targetId: control.senderId,
+                            documentId,
+                            heads: lastHeads.heads,
+                            timestamp: lastHeads.timestamp,
+                            storageId: remote,
+                        });
+                    }
+                }
+            }
+        }
     }
     /** A peer we are not directly connected to has changed their heads */
     handleRemoteHeads(msg) {
@@ -112,13 +140,15 @@ export class RemoteHeadsSubscriptions extends EventEmitter {
             const theirSubs = this.#theirSubscriptions.get(event.storageId);
             if (theirSubs) {
                 for (const peerId of theirSubs) {
-                    this.emit("notify-remote-heads", {
-                        targetId: peerId,
-                        documentId: event.documentId,
-                        heads: event.remoteHeads,
-                        timestamp: event.timestamp,
-                        storageId: event.storageId,
-                    });
+                    if (this.#isPeerSubscribedToDoc(peerId, event.documentId)) {
+                        this.emit("notify-remote-heads", {
+                            targetId: peerId,
+                            documentId: event.documentId,
+                            heads: event.remoteHeads,
+                            timestamp: event.timestamp,
+                            storageId: event.storageId,
+                        });
+                    }
                 }
             }
         }
@@ -140,13 +170,15 @@ export class RemoteHeadsSubscriptions extends EventEmitter {
         const theirSubs = this.#theirSubscriptions.get(storageId);
         if (theirSubs) {
             for (const peerId of theirSubs) {
-                this.emit("notify-remote-heads", {
-                    targetId: peerId,
-                    documentId: documentId,
-                    heads: heads,
-                    timestamp: timestamp,
-                    storageId: storageId,
-                });
+                if (this.#isPeerSubscribedToDoc(peerId, documentId)) {
+                    this.emit("notify-remote-heads", {
+                        targetId: peerId,
+                        documentId: documentId,
+                        heads: heads,
+                        timestamp: timestamp,
+                        storageId: storageId,
+                    });
+                }
             }
         }
     }
@@ -175,6 +207,7 @@ export class RemoteHeadsSubscriptions extends EventEmitter {
         this.#log("removePeer", peerId);
         const remotesToRemove = [];
         this.#generousPeers.delete(peerId);
+        this.#subscribedDocsByPeer.delete(peerId);
         for (const [storageId, peerIds] of this.#theirSubscriptions) {
             if (peerIds.has(peerId)) {
                 peerIds.delete(peerId);
@@ -191,6 +224,33 @@ export class RemoteHeadsSubscriptions extends EventEmitter {
             });
         }
     }
+    subscribePeerToDoc(peerId, documentId) {
+        let subscribedDocs = this.#subscribedDocsByPeer.get(peerId);
+        if (!subscribedDocs) {
+            subscribedDocs = new Set();
+            this.#subscribedDocsByPeer.set(peerId, subscribedDocs);
+        }
+        subscribedDocs.add(documentId);
+        const remoteHeads = this.#knownHeads.get(documentId);
+        if (remoteHeads) {
+            for (const [storageId, lastHeads] of remoteHeads) {
+                const subscribedPeers = this.#theirSubscriptions.get(storageId);
+                if (subscribedPeers && subscribedPeers.has(peerId)) {
+                    this.emit("notify-remote-heads", {
+                        targetId: peerId,
+                        documentId,
+                        heads: lastHeads.heads,
+                        timestamp: lastHeads.timestamp,
+                        storageId,
+                    });
+                }
+            }
+        }
+    }
+    #isPeerSubscribedToDoc(peerId, documentId) {
+        const subscribedDocs = this.#subscribedDocsByPeer.get(peerId);
+        return subscribedDocs && subscribedDocs.has(documentId);
+    }
     /** Returns the (document, storageId) pairs which have changed after processing msg */
     #changedHeads(msg) {
         const changedHeads = [];
@@ -202,11 +262,11 @@ export class RemoteHeadsSubscriptions extends EventEmitter {
             }
             let remote = this.#knownHeads.get(documentId);
             if (!remote) {
-                remote = new Map([[storageId, { heads, timestamp }]]);
+                remote = new Map();
                 this.#knownHeads.set(documentId, remote);
             }
             const docRemote = remote.get(storageId);
-            if (docRemote && docRemote.timestamp > timestamp) {
+            if (docRemote && docRemote.timestamp >= timestamp) {
                 continue;
             }
             else {

package/dist/Repo.d.ts

@@ -1,11 +1,11 @@
 import { EventEmitter } from "eventemitter3";
 import { DocHandle } from "./DocHandle.js";
-import { NetworkAdapter } from "./network/NetworkAdapter.js";
+import { NetworkAdapter, type PeerMetadata } from "./network/NetworkAdapter.js";
 import { NetworkSubsystem } from "./network/NetworkSubsystem.js";
 import { StorageAdapter } from "./storage/StorageAdapter.js";
 import { StorageSubsystem } from "./storage/StorageSubsystem.js";
-import type { AnyDocumentId, DocumentId, PeerId } from "./types.js";
 import { StorageId } from "./storage/types.js";
+import type { AnyDocumentId, DocumentId, PeerId } from "./types.js";
 /** A Repo is a collection of documents with networking, syncing, and storage capabilities. */
 /** The `Repo` is the main entry point of this library
  *
@@ -26,14 +26,15 @@ export declare class Repo extends EventEmitter<RepoEvents> {
     /** By default, we share generously with all peers. */
     /** @hidden */
     sharePolicy: SharePolicy;
-    /** maps peer id to to persistance information (storageId, isEphemeral), access by collection synchronizer  */
+    /** maps peer id to to persistence information (storageId, isEphemeral), access by collection synchronizer  */
     /** @hidden */
-    persistanceInfoByPeerId: Record<PeerId, PersistanceInfo>;
-    constructor({ storage, network, peerId, sharePolicy, isEphemeral, }: RepoConfig);
+    peerMetadataByPeerId: Record<PeerId, PeerMetadata>;
+    constructor({ storage, network, peerId, sharePolicy, isEphemeral, enableRemoteHeadsGossiping, }: RepoConfig);
     /** Returns all the handles we have cached. */
     get handles(): Record<DocumentId, DocHandle<any>>;
     /** Returns a list of all connected peer ids */
     get peers(): PeerId[];
+    getStorageIdOfPeer(peerId: PeerId): StorageId | undefined;
     /**
      * 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
@@ -66,13 +67,22 @@ export declare class Repo extends EventEmitter<RepoEvents> {
     delete(
     /** The url or documentId of the handle to delete */
     id: AnyDocumentId): void;
+    /**
+     * 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.
+     */
+    export(id: AnyDocumentId): Promise<Uint8Array | undefined>;
+    /**
+     * Imports document binary into the repo.
+     * @param binary - The binary to import
+     */
+    import<T>(binary: Uint8Array): DocHandle<T>;
     subscribeToRemotes: (remotes: StorageId[]) => void;
     storageId: () => Promise<StorageId | undefined>;
 }
-interface PersistanceInfo {
-    storageId: StorageId;
-    isEphemeral: boolean;
-}
 export interface RepoConfig {
     /** Our unique identifier */
     peerId?: PeerId;
@@ -88,6 +98,10 @@ export interface RepoConfig {
      * all peers). A server only syncs documents that a peer explicitly requests by ID.
      */
     sharePolicy?: SharePolicy;
+    /**
+     * Whether to enable the experimental remote heads gossiping feature
+     */
+    enableRemoteHeadsGossiping?: boolean;
 }
 /** A function that determines whether we should share a document with a peer
  *
@@ -113,5 +127,4 @@ export interface DocumentPayload {
 export interface DeleteDocumentPayload {
     documentId: DocumentId;
 }
-export {};
 //# sourceMappingURL=Repo.d.ts.map

package/dist/Repo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Repo.d.ts","sourceRoot":"","sources":["../src/Repo.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAM5C,OAAO,EAAE,SAAS,EAAiC,MAAM,gBAAgB,CAAA;AAEzE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAEhE,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAEnE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAI9C,8FAA8F;AAC9F;;;;;;GAMG;AACH,qBAAa,IAAK,SAAQ,YAAY,CAAC,UAAU,CAAC;;IAGhD,cAAc;IACd,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,cAAc;IACd,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IAEnC,mDAAmD;IACnD,cAAc;IACd,gBAAgB,SAAM;IAMtB,sDAAsD;IACtD,cAAc;IACd,WAAW,EAAE,WAAW,CAAmB;IAE3C,8GAA8G;IAC9G,cAAc;IACd,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAK;gBAIjD,EACV,OAAO,EACP,OAAO,EACP,MAAM,EACN,WAAW,EACX,WAAmC,GACpC,EAAE,UAAU;IAoQb,8CAA8C;IAC9C,IAAI,OAAO,uCAEV;IAED,+CAA+C;IAC/C,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED;;;;OAIG;IACH,MAAM,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC;IA0BzB;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAuBnC;;;OAGG;IACH,IAAI,CAAC,CAAC;IACJ,sDAAsD;IACtD,EAAE,EAAE,aAAa,GAChB,SAAS,CAAC,CAAC,CAAC;IAqBf,MAAM;IACJ,oDAAoD;IACpD,EAAE,EAAE,aAAa;IAWnB,kBAAkB,YAAa,SAAS,EAAE,UAGzC;IAED,SAAS,QAAa,QAAQ,SAAS,GAAG,SAAS,CAAC,CAMnD;CACF;AAED,UAAU,eAAe;IACvB,SAAS,EAAE,SAAS,CAAA;IACpB,WAAW,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,WAAW,UAAU;IACzB,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;8DAC0D;IAC1D,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB,gDAAgD;IAChD,OAAO,CAAC,EAAE,cAAc,CAAA;IAExB,oDAAoD;IACpD,OAAO,EAAE,cAAc,EAAE,CAAA;IAEzB;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,KACpB,OAAO,CAAC,OAAO,CAAC,CAAA;AAGrB,MAAM,WAAW,UAAU;IACzB,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,6BAA6B;IAC7B,iBAAiB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IACvD,4FAA4F;IAC5F,sBAAsB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;CAC7D;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;IACtB,KAAK,EAAE,OAAO,CAAA;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,UAAU,CAAA;CACvB"}
+{"version":3,"file":"Repo.d.ts","sourceRoot":"","sources":["../src/Repo.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAM5C,OAAO,EAAE,SAAS,EAAiC,MAAM,gBAAgB,CAAA;AAIzE,OAAO,EAAE,cAAc,EAAE,KAAK,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAEhE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAG9C,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAEnE,8FAA8F;AAC9F;;;;;;GAMG;AACH,qBAAa,IAAK,SAAQ,YAAY,CAAC,UAAU,CAAC;;IAGhD,cAAc;IACd,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,cAAc;IACd,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IAEnC,mDAAmD;IACnD,cAAc;IACd,gBAAgB,SAAM;IAMtB,sDAAsD;IACtD,cAAc;IACd,WAAW,EAAE,WAAW,CAAmB;IAE3C,8GAA8G;IAC9G,cAAc;IACd,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAK;gBAK3C,EACV,OAAO,EACP,OAAO,EACP,MAAM,EACN,WAAW,EACX,WAAmC,EACnC,0BAAkC,GACnC,EAAE,UAAU;IAsRb,8CAA8C;IAC9C,IAAI,OAAO,uCAEV;IAED,+CAA+C;IAC/C,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAIzD;;;;OAIG;IACH,MAAM,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC;IA0BzB;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAuBnC;;;OAGG;IACH,IAAI,CAAC,CAAC;IACJ,sDAAsD;IACtD,EAAE,EAAE,aAAa,GAChB,SAAS,CAAC,CAAC,CAAC;IAqBf,MAAM;IACJ,oDAAoD;IACpD,EAAE,EAAE,aAAa;IAWnB;;;;;;OAMG;IACG,MAAM,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAShE;;;OAGG;IACH,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU;IAY5B,kBAAkB,YAAa,SAAS,EAAE,UASzC;IAED,SAAS,QAAa,QAAQ,SAAS,GAAG,SAAS,CAAC,CAMnD;CACF;AAED,MAAM,WAAW,UAAU;IACzB,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;8DAC0D;IAC1D,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB,gDAAgD;IAChD,OAAO,CAAC,EAAE,cAAc,CAAA;IAExB,oDAAoD;IACpD,OAAO,EAAE,cAAc,EAAE,CAAA;IAEzB;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IAEzB;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAA;CACrC;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,KACpB,OAAO,CAAC,OAAO,CAAC,CAAA;AAGrB,MAAM,WAAW,UAAU;IACzB,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,6BAA6B;IAC7B,iBAAiB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IACvD,4FAA4F;IAC5F,sBAAsB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;CAC7D;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;IACtB,KAAK,EAAE,OAAO,CAAA;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,UAAU,CAAA;CACvB"}

package/dist/Repo.js

@@ -3,12 +3,12 @@ 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";
 import { CollectionSynchronizer } from "./synchronizer/CollectionSynchronizer.js";
-import { RemoteHeadsSubscriptions } from "./RemoteHeadsSubscriptions.js";
-import { headsAreSame } from "./helpers/headsAreSame.js";
 /** A Repo is a collection of documents with networking, syncing, and storage capabilities. */
 /** The `Repo` is the main entry point of this library
  *
@@ -31,12 +31,14 @@ export class Repo extends EventEmitter {
     /** By default, we share generously with all peers. */
     /** @hidden */
     sharePolicy = async () => true;
-    /** maps peer id to to persistance information (storageId, isEphemeral), access by collection synchronizer  */
+    /** maps peer id to to persistence information (storageId, isEphemeral), access by collection synchronizer  */
     /** @hidden */
-    persistanceInfoByPeerId = {};
+    peerMetadataByPeerId = {};
     #remoteHeadsSubscriptions = new RemoteHeadsSubscriptions();
-    constructor({ storage, network, peerId, sharePolicy, isEphemeral = storage === undefined, }) {
+    #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
@@ -48,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());
@@ -101,26 +103,34 @@ 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, storageSubsystem?.id() ?? Promise.resolve(undefined), isEphemeral);
+        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, storageId, isEphemeral }) => {
+        networkSubsystem.on("peer", async ({ peerId, peerMetadata }) => {
             this.#log("peer connected", { peerId });
-            if (storageId) {
-                this.persistanceInfoByPeerId[peerId] = {
-                    storageId,
-                    isEphemeral,
-                };
+            if (peerMetadata) {
+                this.peerMetadataByPeerId[peerId] = { ...peerMetadata };
             }
             this.sharePolicy(peerId)
                 .then(shouldShare => {
-                if (shouldShare) {
+                if (shouldShare && this.#remoteHeadsGossipingEnabled) {
                     this.#remoteHeadsSubscriptions.addGenerousPeer(peerId);
                 }
             })
@@ -141,57 +151,62 @@ export class Repo extends EventEmitter {
         this.#synchronizer.on("sync-state", message => {
             this.#saveSyncState(message);
             const handle = this.#handleCache[message.documentId];
-            const info = this.persistanceInfoByPeerId[message.peerId];
-            if (!info) {
+            const { storageId } = this.peerMetadataByPeerId[message.peerId] || {};
+            if (!storageId) {
                 return;
             }
-            const { storageId } = info;
             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) {
+                if (storageId && this.#remoteHeadsGossipingEnabled) {
                     this.#remoteHeadsSubscriptions.handleImmediateRemoteHeadsChanged(message.documentId, storageId, message.syncState.theirHeads);
                 }
             }
         });
-        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) {
+        if (this.#remoteHeadsGossipingEnabled) {
+            this.#remoteHeadsSubscriptions.on("notify-remote-heads", message => {
                 this.networkSubsystem.send({
-                    type: "remote-subscription-change",
-                    targetId: peer,
-                    add: message.add,
-                    remove: message.remove,
+                    type: "remote-heads-changed",
+                    targetId: message.targetId,
+                    documentId: message.documentId,
+                    newHeads: {
+                        [message.storageId]: {
+                            heads: message.heads,
+                            timestamp: message.timestamp,
+                        },
+                    },
                 });
-            }
-        });
-        this.#remoteHeadsSubscriptions.on("remote-heads-changed", message => {
-            const handle = this.#handleCache[message.documentId];
-            handle.setRemoteHeads(message.storageId, message.remoteHeads);
-        });
+            });
+            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":
-                this.#remoteHeadsSubscriptions.handleControlMessage(message);
+                if (this.#remoteHeadsGossipingEnabled) {
+                    this.#remoteHeadsSubscriptions.handleControlMessage(message);
+                }
                 break;
             case "remote-heads-changed":
-                this.#remoteHeadsSubscriptions.handleRemoteHeads(message);
+                if (this.#remoteHeadsGossipingEnabled) {
+                    this.#remoteHeadsSubscriptions.handleRemoteHeads(message);
+                }
                 break;
             case "sync":
             case "request":
@@ -204,22 +219,21 @@ export class Repo extends EventEmitter {
     }
     #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(message) {
+    #saveSyncState(payload) {
         if (!this.storageSubsystem) {
             return;
         }
-        const persistanceInfo = this.persistanceInfoByPeerId[message.peerId];
-        if (!persistanceInfo || persistanceInfo.isEphemeral) {
+        const { storageId, isEphemeral } = this.peerMetadataByPeerId[payload.peerId] || {};
+        if (!storageId || isEphemeral) {
             return;
         }
-        const { storageId } = persistanceInfo;
         let handler = this.#throttledSaveSyncStateHandlers[storageId];
         if (!handler) {
             handler = this.#throttledSaveSyncStateHandlers[storageId] = throttle(({ documentId, syncState }) => {
-                this.storageSubsystem.saveSyncState(documentId, storageId, syncState);
+                void this.storageSubsystem.saveSyncState(documentId, storageId, syncState);
             }, this.saveDebounceRate);
         }
-        handler(message);
+        handler(payload);
     }
     /** Returns an existing handle if we have it; creates one otherwise. */
     #getHandle(
@@ -245,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
@@ -335,9 +352,41 @@ 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) => {
-        this.#log("subscribeToRemotes", { remotes });
-        this.#remoteHeadsSubscriptions.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) {

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 */