@automerge/automerge-repo 1.1.0 → 1.1.1

package/README.md

@@ -38,8 +38,8 @@ This library provides two main components: the `Repo` itself, and the `DocHandle
 
 A `Repo` exposes these methods:
 
-- `create<T>()`  
-  Creates a new, empty `Automerge.Doc` and returns a `DocHandle` for it.
+- `create<T>(initialValue: T?)`
+  Creates a new `Automerge.Doc` and returns a `DocHandle` for it. Accepts an optional initial value for the document. Produces an empty document (potentially violating the type!) otherwise.
 - `find<T>(docId: DocumentId)`  
   Looks up a given document either on the local machine or (if necessary) over any configured
   networks.

package/dist/DocHandle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DocHandle.d.ts","sourceRoot":"","sources":["../src/DocHandle.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,2BAA2B,CAAA;AAE9C,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EASL,UAAU,EAEX,MAAM,QAAQ,CAAA;AAMf,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9C;;;;;;;;;;;KAWK;AACL,qBAAa,SAAS,CAAC,CAAC,CAAE,EAAE;AAC1B,SAAQ,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;;IAmB/B,UAAU,EAAE,UAAU;IAX/B;;;;OAIG;IACH,IAAI,GAAG,IAAI,YAAY,CAEtB;IAED,cAAc;gBAEL,UAAU,EAAE,UAAU,EAC7B,OAAO,GAAE,gBAAgB,CAAC,CAAC,CAAM;IA0MnC;;;;OAIG;IACH,OAAO,gBAA0C;IACjD;;;;;OAKG;IACH,SAAS,gBAA4C;IACrD,aAAa,gBAAgD;IAC7D,OAAO,WAAY,WAAW,EAAE,aACmB;IAEnD,cAAc;IACd,IAAI,KAAK,eAER;IAED;;;;;OAKG;IACG,SAAS,CAAC,WAAW,GAAE,WAAW,EAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpE;;;;;;OAMG;IACG,GAAG,CACP,WAAW,GAAE,WAAW,EAAyB,GAChD,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAYhC;;;;;;;;;OASG;IACH,OAAO,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS;IAQ/B;;SAEK;IACL,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAM5C;;OAEG;IACH,cAAc,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK;IAKnD,yCAAyC;IACzC,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,CAAC,CAAC,KAAK,GAAG,SAAS;IAIzD,2EAA2E;IAC3E,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,GAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAM;IAehE;;;OAGG;IACH,QAAQ,CACN,KAAK,EAAE,CAAC,CAAC,KAAK,EACd,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EACvB,OAAO,GAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAM,GAC/B,MAAM,EAAE,GAAG,SAAS;IAmBvB;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;IAc/B,WAAW;IAIX;;SAEK;IACL,OAAO;IAIP,cAAc;IACd,YAAY;IAIZ,cAAc;IACd,YAAY;IAIZ,kEAAkE;IAClE,MAAM;IAIN;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,OAAO;CAM3B;AAID,cAAc;AACd,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAE1B;IACE,gGAAgG;IAChG,KAAK,EAAE,IAAI,CAAA;IAEX,yCAAyC;IACzC,YAAY,CAAC,EAAE,CAAC,CAAA;CACjB,GAED;IACE,KAAK,CAAC,EAAE,KAAK,CAAA;IAEb,+HAA+H;IAC/H,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAEL,MAAM,WAAW,uBAAuB;IACtC,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,UAAU,CAAA;IACtB,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,MAAM,WAAW,6BAA6B,CAAC,CAAC;IAC9C,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACpB,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;CACd;AAED,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;CACrB;AAED,0CAA0C;AAC1C,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,8BAA8B;IAC9B,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACpB,iDAAiD;IACjD,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACb,wDAAwD;IACxD,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,CAAA;IAClB,mCAAmC;IACnC,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;CAC1B;AAED,MAAM,WAAW,gCAAgC,CAAC,CAAC;IACjD,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,wCAAwC,CAAC,CAAC;IACzD,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACpB,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,SAAS,CAAA;IACpB,KAAK,EAAE,CAAC,CAAC,KAAK,CAAA;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,CAAC,CAAC,SAAS,CAAA;CACvB;AAED,MAAM,WAAW,eAAe,CAAC,CAAC;IAChC,eAAe,EAAE,CAAC,OAAO,EAAE,6BAA6B,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IACpE,MAAM,EAAE,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IACpD,MAAM,EAAE,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IACpD,WAAW,EAAE,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IACzD,mBAAmB,EAAE,CAAC,OAAO,EAAE,gCAAgC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IAC3E,4BAA4B,EAAE,CAC5B,OAAO,EAAE,wCAAwC,CAAC,CAAC,CAAC,KACjD,IAAI,CAAA;IACT,cAAc,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,IAAI,CAAA;CAC/D;AAMD;;;;GAIG;AACH,eAAO,MAAM,WAAW;IACtB,kEAAkE;;IAElE,mDAAmD;;IAEnD,sDAAsD;;IAEtD,6EAA6E;;IAE7E,gCAAgC;;IAEhC,kDAAkD;;IAElD,4EAA4E;;CAEpE,CAAA;AACV,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAA;AAkBxE,eAAO,MAAM,KAAK;;;;;;;;;;;CAWR,CAAA;AA8CV,eAAO,MACL,IAAI,UACJ,OAAO,aACP,gBAAgB,qBAChB,UAAU,gBACV,KAAK,WACL,OAAO,aACP,WAAW,eACE,CAAA"}
+{"version":3,"file":"DocHandle.d.ts","sourceRoot":"","sources":["../src/DocHandle.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,2BAA2B,CAAA;AAE9C,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EASL,UAAU,EAEX,MAAM,QAAQ,CAAA;AAMf,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9C;;;;;;;;;;;KAWK;AACL,qBAAa,SAAS,CAAC,CAAC,CAAE,EAAE;AAC1B,SAAQ,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;;IAmB/B,UAAU,EAAE,UAAU;IAX/B;;;;OAIG;IACH,IAAI,GAAG,IAAI,YAAY,CAEtB;IAED,cAAc;gBAEL,UAAU,EAAE,UAAU,EAC7B,OAAO,GAAE,gBAAgB,CAAC,CAAC,CAAM;IAyMnC;;;;OAIG;IACH,OAAO,gBAA0C;IACjD;;;;;OAKG;IACH,SAAS,gBAA4C;IACrD,aAAa,gBAAgD;IAC7D,OAAO,WAAY,WAAW,EAAE,aACmB;IAEnD,cAAc;IACd,IAAI,KAAK,eAER;IAED;;;;;OAKG;IACG,SAAS,CAAC,WAAW,GAAE,WAAW,EAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpE;;;;;;OAMG;IACG,GAAG,CACP,WAAW,GAAE,WAAW,EAAyB,GAChD,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAYhC;;;;;;;;;OASG;IACH,OAAO,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS;IAQ/B;;SAEK;IACL,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAM5C;;OAEG;IACH,cAAc,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK;IAKnD,yCAAyC;IACzC,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,CAAC,CAAC,KAAK,GAAG,SAAS;IAIzD,2EAA2E;IAC3E,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,GAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAM;IAehE;;;OAGG;IACH,QAAQ,CACN,KAAK,EAAE,CAAC,CAAC,KAAK,EACd,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EACvB,OAAO,GAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAM,GAC/B,MAAM,EAAE,GAAG,SAAS;IAmBvB;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;IAc/B,WAAW;IAIX;;SAEK;IACL,OAAO;IAIP,cAAc;IACd,YAAY;IAIZ,cAAc;IACd,YAAY;IAIZ,kEAAkE;IAClE,MAAM;IAIN;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,OAAO;CAM3B;AAID,cAAc;AACd,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAE1B;IACE,gGAAgG;IAChG,KAAK,EAAE,IAAI,CAAA;IAEX,yCAAyC;IACzC,YAAY,CAAC,EAAE,CAAC,CAAA;CACjB,GAED;IACE,KAAK,CAAC,EAAE,KAAK,CAAA;IAEb,+HAA+H;IAC/H,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAEL,MAAM,WAAW,uBAAuB;IACtC,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,UAAU,CAAA;IACtB,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,MAAM,WAAW,6BAA6B,CAAC,CAAC;IAC9C,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACpB,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;CACd;AAED,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;CACrB;AAED,0CAA0C;AAC1C,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,8BAA8B;IAC9B,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACpB,iDAAiD;IACjD,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACb,wDAAwD;IACxD,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,CAAA;IAClB,mCAAmC;IACnC,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;CAC1B;AAED,MAAM,WAAW,gCAAgC,CAAC,CAAC;IACjD,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,wCAAwC,CAAC,CAAC;IACzD,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACpB,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,SAAS,CAAA;IACpB,KAAK,EAAE,CAAC,CAAC,KAAK,CAAA;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,CAAC,CAAC,SAAS,CAAA;CACvB;AAED,MAAM,WAAW,eAAe,CAAC,CAAC;IAChC,eAAe,EAAE,CAAC,OAAO,EAAE,6BAA6B,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IACpE,MAAM,EAAE,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IACpD,MAAM,EAAE,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IACpD,WAAW,EAAE,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IACzD,mBAAmB,EAAE,CAAC,OAAO,EAAE,gCAAgC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IAC3E,4BAA4B,EAAE,CAC5B,OAAO,EAAE,wCAAwC,CAAC,CAAC,CAAC,KACjD,IAAI,CAAA;IACT,cAAc,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,IAAI,CAAA;CAC/D;AAMD;;;;GAIG;AACH,eAAO,MAAM,WAAW;IACtB,kEAAkE;;IAElE,mDAAmD;;IAEnD,sDAAsD;;IAEtD,6EAA6E;;IAE7E,gCAAgC;;IAEhC,kDAAkD;;IAElD,4EAA4E;;CAEpE,CAAA;AACV,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAA;AAkBxE,eAAO,MAAM,KAAK;;;;;;;;;;;CAWR,CAAA;AA8CV,eAAO,MACL,IAAI,UACJ,OAAO,aACP,gBAAgB,qBAChB,UAAU,gBACV,KAAK,WACL,OAAO,aACP,WAAW,eACE,CAAA"}

package/dist/DocHandle.js

@@ -201,11 +201,10 @@ export class DocHandle//
     }
     /** Returns a promise that resolves when the docHandle is in one of the given states */
     #statePromise(awaitStates) {
-        if (!Array.isArray(awaitStates))
-            awaitStates = [awaitStates];
-        return Promise.any(awaitStates.map(state => waitFor(this.#machine, s => s.matches(state), {
-            timeout: this.#timeoutDelay * 2, // use a longer delay here so as not to race with other delays
-        })));
+        const awaitStatesArray = Array.isArray(awaitStates) ? awaitStates : [awaitStates];
+        return waitFor(this.#machine, s => awaitStatesArray.some((state) => s.matches(state)), 
+        // use a longer delay here so as not to race with other delays
+        { timeout: this.#timeoutDelay * 2 });
     }
     // PUBLIC
     /**

package/dist/Repo.d.ts

@@ -1,8 +1,8 @@
 import { EventEmitter } from "eventemitter3";
 import { DocHandle } from "./DocHandle.js";
-import { NetworkAdapter, type PeerMetadata } from "./network/NetworkAdapter.js";
+import { NetworkAdapterInterface, type PeerMetadata } from "./network/NetworkAdapterInterface.js";
 import { NetworkSubsystem } from "./network/NetworkSubsystem.js";
-import { StorageAdapter } from "./storage/StorageAdapter.js";
+import { StorageAdapterInterface } from "./storage/StorageAdapterInterface.js";
 import { StorageSubsystem } from "./storage/StorageSubsystem.js";
 import { StorageId } from "./storage/types.js";
 import type { AnyDocumentId, DocumentId, PeerId } from "./types.js";
@@ -90,9 +90,9 @@ export interface RepoConfig {
      * Sync state is only persisted for non-ephemeral peers */
     isEphemeral?: boolean;
     /** A storage adapter can be provided, or not */
-    storage?: StorageAdapter;
+    storage?: StorageAdapterInterface;
     /** One or more network adapters must be provided */
-    network: NetworkAdapter[];
+    network: NetworkAdapterInterface[];
     /**
      * Normal peers typically share generously with everyone (meaning we sync all our documents with
      * all peers). A server only syncs documents that a peer explicitly requests by ID.

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;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;IAyRb,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,EAAE,YAAY,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAYzC;;;;;;;;;;;;;;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;IAwBf,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"}
+{"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,uBAAuB,EAAE,KAAK,YAAY,EAAE,MAAM,sCAAsC,CAAA;AACjG,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAEhE,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAA;AAC9E,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;IAqRb,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,EAAE,YAAY,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAYzC;;;;;;;;;;;;;;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;IAwBf,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,uBAAuB,CAAA;IAEjC,oDAAoD;IACpD,OAAO,EAAE,uBAAuB,EAAE,CAAA;IAElC;;;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

@@ -114,12 +114,10 @@ export class Repo extends EventEmitter {
         this.storageSubsystem = storageSubsystem;
         // NETWORK
         // The network subsystem deals with sending and receiving messages to and from peers.
-        const myPeerMetadata = new Promise(
-        // eslint-disable-next-line no-async-promise-executor -- TODO: fix
-        async (resolve) => resolve({
+        const myPeerMetadata = (async () => ({
             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

package/dist/helpers/tests/network-adapter-tests.d.ts

@@ -1,4 +1,4 @@
-import { type NetworkAdapter } from "../../index.js";
+import type { NetworkAdapterInterface } from "../../network/NetworkAdapterInterface.js";
 /**
  * Runs a series of tests against a set of three peers, each represented by one or more instantiated
  * network adapters.
@@ -12,7 +12,7 @@ import { type NetworkAdapter } from "../../index.js";
  *   to clean up any resources that were created during the test.
  */
 export declare function runAdapterTests(_setup: SetupFn, title?: string): void;
-type Network = NetworkAdapter | NetworkAdapter[];
+type Network = NetworkAdapterInterface | NetworkAdapterInterface[];
 export type SetupFn = () => Promise<{
     adapters: [Network, Network, Network];
     teardown?: () => void;

package/dist/helpers/tests/network-adapter-tests.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"network-adapter-tests.d.ts","sourceRoot":"","sources":["../../../src/helpers/tests/network-adapter-tests.ts"],"names":[],"mappings":"AAEA,OAAO,EAAgB,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAIlE;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CA8HrE;AAID,KAAK,OAAO,GAAG,cAAc,GAAG,cAAc,EAAE,CAAA;AAEhD,MAAM,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC;IAClC,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;IACrC,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAA;CACtB,CAAC,CAAA"}
+{"version":3,"file":"network-adapter-tests.d.ts","sourceRoot":"","sources":["../../../src/helpers/tests/network-adapter-tests.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAA;AAIvF;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAuJrE;AAID,KAAK,OAAO,GAAG,uBAAuB,GAAG,uBAAuB,EAAE,CAAA;AAElE,MAAM,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC;IAClC,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;IACrC,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAA;CACtB,CAAC,CAAA"}

package/dist/helpers/tests/network-adapter-tests.js

@@ -1,5 +1,5 @@
 import assert from "assert";
-import { describe, it } from "vitest";
+import { describe, expect, it } from "vitest";
 import { Repo } from "../../index.js";
 import { eventPromise, eventPromises } from "../eventPromise.js";
 import { pause } from "../pause.js";
@@ -110,6 +110,21 @@ export function runAdapterTests(_setup, title) {
             assert.deepStrictEqual(message, alicePresenceData);
             teardown();
         });
+        it("emits a peer-candidate event with proper peer metadata when a peer connects", async () => {
+            const { adapters, teardown } = await setup();
+            const a = adapters[0][0];
+            const b = adapters[1][0];
+            const bPromise = eventPromise(b, "peer-candidate");
+            const aPeerMetadata = { storageId: "a" };
+            b.connect("b", { storageId: "b" });
+            a.connect("a", aPeerMetadata);
+            const peerCandidate = await bPromise;
+            expect(peerCandidate).toMatchObject({
+                peerId: "a",
+                peerMetadata: aPeerMetadata,
+            });
+            teardown();
+        });
     });
 }
 const NO_OP = () => { };

package/dist/index.d.ts

@@ -29,13 +29,15 @@ export { DocHandle } from "./DocHandle.js";
 export { isValidAutomergeUrl, parseAutomergeUrl, stringifyAutomergeUrl, } from "./AutomergeUrl.js";
 export { Repo } from "./Repo.js";
 export { NetworkAdapter } from "./network/NetworkAdapter.js";
+export type { NetworkAdapterInterface } from "./network/NetworkAdapterInterface.js";
 export { isRepoMessage } from "./network/messages.js";
 export { StorageAdapter } from "./storage/StorageAdapter.js";
+export type { StorageAdapterInterface } from "./storage/StorageAdapterInterface.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, PeerMetadata, } from "./network/NetworkAdapter.js";
+export type { NetworkAdapterEvents, OpenPayload, PeerCandidatePayload, PeerDisconnectedPayload, PeerMetadata, } from "./network/NetworkAdapterInterface.js";
 export type { DocumentUnavailableMessage, EphemeralMessage, Message, RepoMessage, RequestMessage, SyncMessage, } from "./network/messages.js";
 export type { Chunk, ChunkInfo, ChunkType, StorageKey, StorageId, } from "./storage/types.js";
 export * from "./types.js";

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,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"}
+{"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,YAAY,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAA;AACnF,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,YAAY,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAA;AAEnF,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,sCAAsC,CAAA;AAE7C,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/network/NetworkAdapter.d.ts

@@ -1,25 +1,17 @@
 import { EventEmitter } from "eventemitter3";
+import { NetworkAdapterEvents, PeerMetadata } from "../index.js";
 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;
-}
+import { NetworkAdapterInterface } from "./NetworkAdapterInterface.js";
 /** An interface representing some way to connect to other peers
+ * @deprecated use {@link NetworkAdapterInterface}
  *
  * @remarks
  * The {@link Repo} uses one or more `NetworkAdapter`s to connect to other peers.
  * Because the network may take some time to be ready the {@link Repo} will wait
  * until the adapter emits a `ready` event before it starts trying to use it
  */
-export declare abstract class NetworkAdapter extends EventEmitter<NetworkAdapterEvents> {
+export declare abstract class NetworkAdapter extends EventEmitter<NetworkAdapterEvents> implements NetworkAdapterInterface {
     peerId?: PeerId;
     peerMetadata?: PeerMetadata;
     /** Called by the {@link Repo} to start the connection process
@@ -36,26 +28,4 @@ export declare abstract class NetworkAdapter extends EventEmitter<NetworkAdapter
     /** Called by the {@link Repo} to disconnect from the network */
     abstract disconnect(): void;
 }
-export interface NetworkAdapterEvents {
-    /** Emitted when the network is ready to be used */
-    ready: (payload: OpenPayload) => void;
-    /** Emitted when the network is closed */
-    close: () => void;
-    /** Emitted when the network adapter learns about a new peer */
-    "peer-candidate": (payload: PeerCandidatePayload) => void;
-    /** Emitted when the network adapter learns that a peer has disconnected */
-    "peer-disconnected": (payload: PeerDisconnectedPayload) => void;
-    /** Emitted when the network adapter receives a message from a peer */
-    message: (payload: Message) => void;
-}
-export interface OpenPayload {
-    network: NetworkAdapter;
-}
-export interface PeerCandidatePayload {
-    peerId: PeerId;
-    peerMetadata: PeerMetadata;
-}
-export interface PeerDisconnectedPayload {
-    peerId: PeerId;
-}
 //# sourceMappingURL=NetworkAdapter.d.ts.map

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

@@ -1 +1 @@
-{"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"}
+{"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,oBAAoB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAChE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AACvC,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AAEtE;;;;;;;GAOG;AACH,8BAAsB,cACpB,SAAQ,YAAY,CAAC,oBAAoB,CACzC,YAAW,uBAAuB;IAElC,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"}

package/dist/network/NetworkAdapter.js

@@ -1,6 +1,7 @@
 /* c8 ignore start */
 import { EventEmitter } from "eventemitter3";
 /** An interface representing some way to connect to other peers
+ * @deprecated use {@link NetworkAdapterInterface}
  *
  * @remarks
  * The {@link Repo} uses one or more `NetworkAdapter`s to connect to other peers.

package/dist/network/NetworkAdapterInterface.d.ts

@@ -0,0 +1,61 @@
+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
+ * The {@link Repo} uses one or more `NetworkAdapter`s to connect to other peers.
+ * Because the network may take some time to be ready the {@link Repo} will wait
+ * until the adapter emits a `ready` event before it starts trying to use it
+ */
+export interface NetworkAdapterInterface 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
+     */
+    connect(peerId: PeerId, peerMetadata?: PeerMetadata): void;
+    /** Called by the {@link Repo} to send a message to a peer
+     *
+     * @argument message - the message to send
+     */
+    send(message: Message): void;
+    /** Called by the {@link Repo} to disconnect from the network */
+    disconnect(): void;
+}
+export interface NetworkAdapterEvents {
+    /** Emitted when the network is ready to be used */
+    ready: (payload: OpenPayload) => void;
+    /** Emitted when the network is closed */
+    close: () => void;
+    /** Emitted when the network adapter learns about a new peer */
+    "peer-candidate": (payload: PeerCandidatePayload) => void;
+    /** Emitted when the network adapter learns that a peer has disconnected */
+    "peer-disconnected": (payload: PeerDisconnectedPayload) => void;
+    /** Emitted when the network adapter receives a message from a peer */
+    message: (payload: Message) => void;
+}
+export interface OpenPayload {
+    network: NetworkAdapterInterface;
+}
+export interface PeerCandidatePayload {
+    peerId: PeerId;
+    peerMetadata: PeerMetadata;
+}
+export interface PeerDisconnectedPayload {
+    peerId: PeerId;
+}
+//# sourceMappingURL=NetworkAdapterInterface.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkAdapterInterface.d.ts","sourceRoot":"","sources":["../../src/network/NetworkAdapterInterface.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,MAAM,WAAW,uBAAwB,SAAQ,YAAY,CAAC,oBAAoB,CAAC;IACjF,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,IAAI,CAAA;IAE1D;;;OAGG;IACH,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;IAE5B,gEAAgE;IAChE,UAAU,IAAI,IAAI,CAAA;CACnB;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,uBAAuB,CAAA;CACjC;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/NetworkAdapterInterface.js

@@ -0,0 +1,2 @@
+/* c8 ignore start */
+export {};

package/dist/network/NetworkSubsystem.d.ts

@@ -1,13 +1,13 @@
 import { EventEmitter } from "eventemitter3";
 import { PeerId } from "../types.js";
-import type { NetworkAdapter, PeerDisconnectedPayload, PeerMetadata } from "./NetworkAdapter.js";
+import type { NetworkAdapterInterface, PeerDisconnectedPayload, PeerMetadata } from "./NetworkAdapterInterface.js";
 import { MessageContents, RepoMessage } from "./messages.js";
 export declare class NetworkSubsystem extends EventEmitter<NetworkSubsystemEvents> {
     #private;
     peerId: PeerId;
     private peerMetadata;
-    constructor(adapters: NetworkAdapter[], peerId: PeerId, peerMetadata: Promise<PeerMetadata>);
-    addNetworkAdapter(networkAdapter: NetworkAdapter): void;
+    constructor(adapters: NetworkAdapterInterface[], peerId: PeerId, peerMetadata: Promise<PeerMetadata>);
+    addNetworkAdapter(networkAdapter: NetworkAdapterInterface): void;
     send(message: MessageContents): void;
     isReady: () => boolean;
     whenReady: () => Promise<void>;

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,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"}
+{"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,uBAAuB,EACvB,uBAAuB,EACvB,YAAY,EACb,MAAM,8BAA8B,CAAA;AACrC,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,uBAAuB,EAAE,EAC5B,MAAM,QAAiB,EACtB,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;IAO7C,iBAAiB,CAAC,cAAc,EAAE,uBAAuB;IA2EzD,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

@@ -67,9 +67,11 @@ export class NetworkSubsystem extends EventEmitter {
                 }
             });
         });
-        this.peerMetadata.then(peerMetadata => {
+        this.peerMetadata
+            .then(peerMetadata => {
             networkAdapter.connect(this.peerId, peerMetadata);
-        }).catch(err => {
+        })
+            .catch(err => {
             this.#log("error connecting to network", err);
         });
     }

package/dist/storage/StorageAdapter.d.ts

@@ -1,11 +1,13 @@
+import { StorageAdapterInterface } from "./StorageAdapterInterface.js";
 import { StorageKey, Chunk } from "./types.js";
 /** A storage adapter represents some way of storing binary data for a {@link Repo}
+ * @deprecated use {@link StorageAdapterInterface}
  *
  * @remarks
  * `StorageAdapter`s provide a key/value storage interface. The keys are arrays of strings
  * ({@link StorageKey}) and the values are binary blobs.
  */
-export declare abstract class StorageAdapter {
+export declare abstract class StorageAdapter implements StorageAdapterInterface {
     /** Load the single value corresponding to `key` */
     abstract load(key: StorageKey): Promise<Uint8Array | undefined>;
     /** Save the value `data` to the key `key` */

package/dist/storage/StorageAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StorageAdapter.d.ts","sourceRoot":"","sources":["../../src/storage/StorageAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAE9C;;;;;GAKG;AACH,8BAAsB,cAAc;IAClC,mDAAmD;IACnD,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAE/D,6CAA6C;IAC7C,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/D,8CAA8C;IAC9C,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,SAAS,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAE3D,8DAA8D;IAC9D,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAC3D"}
+{"version":3,"file":"StorageAdapter.d.ts","sourceRoot":"","sources":["../../src/storage/StorageAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AACtE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAE9C;;;;;;GAMG;AACH,8BAAsB,cAAe,YAAW,uBAAuB;IACrE,mDAAmD;IACnD,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAE/D,6CAA6C;IAC7C,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/D,8CAA8C;IAC9C,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,SAAS,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAE3D,8DAA8D;IAC9D,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAC3D"}

package/dist/storage/StorageAdapter.js

@@ -1,4 +1,5 @@
 /** A storage adapter represents some way of storing binary data for a {@link Repo}
+ * @deprecated use {@link StorageAdapterInterface}
  *
  * @remarks
  * `StorageAdapter`s provide a key/value storage interface. The keys are arrays of strings

package/dist/storage/StorageAdapterInterface.d.ts

@@ -0,0 +1,30 @@
+import { StorageKey, Chunk } from "./types.js";
+/** A storage adapter represents some way of storing binary data for a {@link Repo}
+ *
+ * @remarks
+ * `StorageAdapter`s provide a key/value storage interface. The keys are arrays of strings
+ * ({@link StorageKey}) and the values are binary blobs.
+ */
+export interface StorageAdapterInterface {
+    /** Load the single value corresponding to `key` */
+    load(key: StorageKey): Promise<Uint8Array | undefined>;
+    /** Save the value `data` to the key `key` */
+    save(key: StorageKey, data: Uint8Array): Promise<void>;
+    /** Remove the value corresponding to `key` */
+    remove(key: StorageKey): Promise<void>;
+    /**
+     * Load all values with keys that start with `keyPrefix`.
+     *
+     * @remarks
+     * The `keyprefix` will match any key that starts with the given array. For example:
+     * - `[documentId, "incremental"]` will match all incremental saves
+     * - `[documentId]` will match all data for a given document.
+     *
+     * Be careful! `[documentId]` would also match something like `[documentId, "syncState"]`! We
+     * aren't using this yet but keep it in mind.)
+     */
+    loadRange(keyPrefix: StorageKey): Promise<Chunk[]>;
+    /** Remove all values with keys that start with `keyPrefix` */
+    removeRange(keyPrefix: StorageKey): Promise<void>;
+}
+//# sourceMappingURL=StorageAdapterInterface.d.ts.map

package/dist/storage/StorageAdapterInterface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageAdapterInterface.d.ts","sourceRoot":"","sources":["../../src/storage/StorageAdapterInterface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,mDAAmD;IACnD,IAAI,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAA;IAEtD,6CAA6C;IAC7C,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtD,8CAA8C;IAC9C,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAA;IAElD,8DAA8D;IAC9D,WAAW,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAClD"}

package/dist/storage/StorageAdapterInterface.js

@@ -0,0 +1 @@
+export {};

package/dist/storage/StorageSubsystem.d.ts

@@ -1,6 +1,6 @@
 import * as A from "@automerge/automerge/next";
 import { type DocumentId } from "../types.js";
-import { StorageAdapter } from "./StorageAdapter.js";
+import { StorageAdapterInterface } from "./StorageAdapterInterface.js";
 import { StorageId } from "./types.js";
 /**
  * The storage subsystem is responsible for saving and loading Automerge documents to and from
@@ -8,7 +8,7 @@ import { StorageId } from "./types.js";
  */
 export declare class StorageSubsystem {
     #private;
-    constructor(storageAdapter: StorageAdapter);
+    constructor(storageAdapter: StorageAdapterInterface);
     id(): Promise<StorageId>;
     /** Loads a value from storage. */
     load(

package/dist/storage/StorageSubsystem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StorageSubsystem.d.ts","sourceRoot":"","sources":["../../src/storage/StorageSubsystem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,2BAA2B,CAAA;AAI9C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAyB,SAAS,EAAE,MAAM,YAAY,CAAA;AAK7D;;;GAGG;AACH,qBAAa,gBAAgB;;gBAef,cAAc,EAAE,cAAc;IAIpC,EAAE,IAAI,OAAO,CAAC,SAAS,CAAC;IA2B9B,kCAAkC;IAC5B,IAAI;IACR,iFAAiF;IACjF,SAAS,EAAE,MAAM;IAEjB,yFAAyF;IACzF,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAKlC,gCAAgC;IAC1B,IAAI;IACR,iFAAiF;IACjF,SAAS,EAAE,MAAM;IAEjB,yFAAyF;IACzF,GAAG,EAAE,MAAM;IAEX,sCAAsC;IACtC,IAAI,EAAE,UAAU,GACf,OAAO,CAAC,IAAI,CAAC;IAKhB,oCAAoC;IAC9B,MAAM;IACV,iFAAiF;IACjF,SAAS,EAAE,MAAM;IAEjB,2FAA2F;IAC3F,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,IAAI,CAAC;IAOhB;;OAEG;IACG,OAAO,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAmClE;;;;;;OAMG;IACG,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAazE;;OAEG;IACG,SAAS,CAAC,UAAU,EAAE,UAAU;IAkEhC,aAAa,CACjB,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,SAAS,GACnB,OAAO,CAAC,CAAC,CAAC,SAAS,GAAG,SAAS,CAAC;IAM7B,aAAa,CACjB,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,CAAC,CAAC,SAAS,GACrB,OAAO,CAAC,IAAI,CAAC;CA8CjB"}
+{"version":3,"file":"StorageSubsystem.d.ts","sourceRoot":"","sources":["../../src/storage/StorageSubsystem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,2BAA2B,CAAA;AAI9C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AACtE,OAAO,EAAyB,SAAS,EAAE,MAAM,YAAY,CAAA;AAK7D;;;GAGG;AACH,qBAAa,gBAAgB;;gBAef,cAAc,EAAE,uBAAuB;IAI7C,EAAE,IAAI,OAAO,CAAC,SAAS,CAAC;IA2B9B,kCAAkC;IAC5B,IAAI;IACR,iFAAiF;IACjF,SAAS,EAAE,MAAM;IAEjB,yFAAyF;IACzF,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAKlC,gCAAgC;IAC1B,IAAI;IACR,iFAAiF;IACjF,SAAS,EAAE,MAAM;IAEjB,yFAAyF;IACzF,GAAG,EAAE,MAAM;IAEX,sCAAsC;IACtC,IAAI,EAAE,UAAU,GACf,OAAO,CAAC,IAAI,CAAC;IAKhB,oCAAoC;IAC9B,MAAM;IACV,iFAAiF;IACjF,SAAS,EAAE,MAAM;IAEjB,2FAA2F;IAC3F,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,IAAI,CAAC;IAOhB;;OAEG;IACG,OAAO,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAmClE;;;;;;OAMG;IACG,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAazE;;OAEG;IACG,SAAS,CAAC,UAAU,EAAE,UAAU;IAkEhC,aAAa,CACjB,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,SAAS,GACnB,OAAO,CAAC,CAAC,CAAC,SAAS,GAAG,SAAS,CAAC;IAM7B,aAAa,CACjB,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,CAAC,CAAC,SAAS,GACrB,OAAO,CAAC,IAAI,CAAC;CA8CjB"}

package/dist/synchronizer/DocSynchronizer.js

@@ -152,7 +152,7 @@ export class DocSynchronizer extends Synchronizer {
         return this.#peers.includes(peerId);
     }
     beginSync(peerIds) {
-        const newPeers = new Set(peerIds.filter(peerId => !this.#peers.includes(peerId)));
+        const noPeersWithDocument = peerIds.every((peerId) => this.#peerDocumentStatuses[peerId] in ["unavailable", "wants"]);
         // At this point if we don't have anything in our storage, we need to use an empty doc to sync
         // with; but we don't want to surface that state to the front end
         const docPromise = this.#handle
@@ -162,7 +162,7 @@ export class DocSynchronizer extends Synchronizer {
             this.#syncStarted = true;
             this.#checkDocUnavailable();
             const wasUnavailable = doc === undefined;
-            if (wasUnavailable && newPeers.size == 0) {
+            if (wasUnavailable && noPeersWithDocument) {
                 return;
             }
             // If the doc is unavailable we still need a blank document to generate

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "A repository object to manage a collection of automerge documents",
   "repository": "https://github.com/automerge/automerge-repo/tree/master/packages/automerge-repo",
   "author": "Peter van Hardenberg <pvh@pvh.ca>",
@@ -55,5 +55,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e9e7d3f27ec2ac8a2e9d122ece80598918940067"
+  "gitHead": "7e0681014b8c5f672e2abc2a653a954ccb6d7aba"
 }

package/src/DocHandle.ts

@@ -39,7 +39,7 @@ export class DocHandle<T> //
   #log: debug.Debugger
 
   #machine: DocHandleXstateMachine<T>
-  #timeoutDelay: number = 60_000
+  #timeoutDelay = 60_000
   #remoteHeads: Record<StorageId, A.Heads> = {}
 
   /** The URL of this document
@@ -244,13 +244,12 @@ export class DocHandle<T> //
 
   /** Returns a promise that resolves when the docHandle is in one of the given states */
   #statePromise(awaitStates: HandleState | HandleState[]) {
-    if (!Array.isArray(awaitStates)) awaitStates = [awaitStates]
-    return Promise.any(
-      awaitStates.map(state =>
-        waitFor(this.#machine, s => s.matches(state), {
-          timeout: this.#timeoutDelay * 2, // use a longer delay here so as not to race with other delays
-        })
-      )
+    const awaitStatesArray = Array.isArray(awaitStates) ? awaitStates : [awaitStates]
+    return waitFor(
+      this.#machine,
+      s => awaitStatesArray.some((state) => s.matches(state)),
+      // use a longer delay here so as not to race with other delays
+      {timeout: this.#timeoutDelay * 2}
     )
   }
 

package/src/Repo.ts

@@ -2,18 +2,18 @@ import { next as Automerge } from "@automerge/automerge"
 import debug from "debug"
 import { EventEmitter } from "eventemitter3"
 import {
-  generateAutomergeUrl,
-  interpretAsDocumentId,
-  parseAutomergeUrl,
+    generateAutomergeUrl,
+    interpretAsDocumentId,
+    parseAutomergeUrl,
 } from "./AutomergeUrl.js"
 import { DocHandle, DocHandleEncodedChangePayload } from "./DocHandle.js"
 import { RemoteHeadsSubscriptions } from "./RemoteHeadsSubscriptions.js"
 import { headsAreSame } from "./helpers/headsAreSame.js"
 import { throttle } from "./helpers/throttle.js"
-import { NetworkAdapter, type PeerMetadata } from "./network/NetworkAdapter.js"
+import { NetworkAdapterInterface, type PeerMetadata } from "./network/NetworkAdapterInterface.js"
 import { NetworkSubsystem } from "./network/NetworkSubsystem.js"
 import { RepoMessage } from "./network/messages.js"
-import { StorageAdapter } from "./storage/StorageAdapter.js"
+import { StorageAdapterInterface } from "./storage/StorageAdapterInterface.js"
 import { StorageSubsystem } from "./storage/StorageSubsystem.js"
 import { StorageId } from "./storage/types.js"
 import { CollectionSynchronizer } from "./synchronizer/CollectionSynchronizer.js"
@@ -155,14 +155,10 @@ export class Repo extends EventEmitter<RepoEvents> {
     // NETWORK
     // The network subsystem deals with sending and receiving messages to and from peers.
 
-    const myPeerMetadata: Promise<PeerMetadata> = new Promise(
-      // eslint-disable-next-line no-async-promise-executor -- TODO: fix
-      async resolve =>
-        resolve({
-          storageId: await storageSubsystem?.id(),
-          isEphemeral,
-        } as PeerMetadata)
-    )
+    const myPeerMetadata: Promise<PeerMetadata> = (async () => ({
+      storageId: await storageSubsystem?.id(),
+      isEphemeral,
+    }))()
 
     const networkSubsystem = new NetworkSubsystem(
       network,
@@ -517,10 +513,10 @@ export interface RepoConfig {
   isEphemeral?: boolean
 
   /** A storage adapter can be provided, or not */
-  storage?: StorageAdapter
+  storage?: StorageAdapterInterface
 
   /** One or more network adapters must be provided */
-  network: NetworkAdapter[]
+  network: NetworkAdapterInterface[]
 
   /**
    * Normal peers typically share generously with everyone (meaning we sync all our documents with

package/src/helpers/tests/network-adapter-tests.ts

@@ -1,6 +1,7 @@
 import assert from "assert"
-import { describe, it } from "vitest"
-import { PeerId, Repo, type NetworkAdapter } from "../../index.js"
+import { describe, expect, it } from "vitest"
+import { PeerId, PeerMetadata, Repo, StorageId } from "../../index.js"
+import type { NetworkAdapterInterface } from "../../network/NetworkAdapterInterface.js"
 import { eventPromise, eventPromises } from "../eventPromise.js"
 import { pause } from "../pause.js"
 
@@ -29,7 +30,10 @@ export function runAdapterTests(_setup: SetupFn, title?: string): void {
 
   describe(`Adapter acceptance tests ${title ? `(${title})` : ""}`, () => {
     it("can sync 2 repos", async () => {
-      const doTest = async (a: NetworkAdapter[], b: NetworkAdapter[]) => {
+      const doTest = async (
+        a: NetworkAdapterInterface[],
+        b: NetworkAdapterInterface[]
+      ) => {
         const aliceRepo = new Repo({ network: a, peerId: alice })
         const bobRepo = new Repo({ network: b, peerId: bob })
 
@@ -141,12 +145,34 @@ export function runAdapterTests(_setup: SetupFn, title?: string): void {
       assert.deepStrictEqual(message, alicePresenceData)
       teardown()
     })
+
+    it("emits a peer-candidate event with proper peer metadata when a peer connects", async () => {
+      const { adapters, teardown } = await setup()
+      const a = adapters[0][0]
+      const b = adapters[1][0]
+
+      const bPromise = eventPromise(b, "peer-candidate")
+
+      const aPeerMetadata: PeerMetadata = { storageId: "a" as StorageId }
+
+      b.connect("b" as PeerId, { storageId: "b" as StorageId })
+      a.connect("a" as PeerId, aPeerMetadata)
+
+      const peerCandidate = await bPromise
+
+      expect(peerCandidate).toMatchObject({
+        peerId: "a",
+        peerMetadata: aPeerMetadata,
+      })
+
+      teardown()
+    })
   })
 }
 
 const NO_OP = () => {}
 
-type Network = NetworkAdapter | NetworkAdapter[]
+type Network = NetworkAdapterInterface | NetworkAdapterInterface[]
 
 export type SetupFn = () => Promise<{
   adapters: [Network, Network, Network]

package/src/index.ts

@@ -34,8 +34,10 @@ export {
 } from "./AutomergeUrl.js"
 export { Repo } from "./Repo.js"
 export { NetworkAdapter } from "./network/NetworkAdapter.js"
+export type { NetworkAdapterInterface } from "./network/NetworkAdapterInterface.js"
 export { isRepoMessage } from "./network/messages.js"
 export { StorageAdapter } from "./storage/StorageAdapter.js"
+export type { StorageAdapterInterface } from "./storage/StorageAdapterInterface.js"
 
 /** @hidden **/
 export * as cbor from "./helpers/cbor.js"
@@ -68,7 +70,7 @@ export type {
   PeerCandidatePayload,
   PeerDisconnectedPayload,
   PeerMetadata,
-} from "./network/NetworkAdapter.js"
+} from "./network/NetworkAdapterInterface.js"
 
 export type {
   DocumentUnavailableMessage,

package/src/network/NetworkAdapter.ts

@@ -1,29 +1,23 @@
 /* c8 ignore start */
 
 import { EventEmitter } from "eventemitter3"
+import { NetworkAdapterEvents, PeerMetadata } from "../index.js"
 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
-}
+import { NetworkAdapterInterface } from "./NetworkAdapterInterface.js"
 
 /** An interface representing some way to connect to other peers
+ * @deprecated use {@link NetworkAdapterInterface}
  *
  * @remarks
  * The {@link Repo} uses one or more `NetworkAdapter`s to connect to other peers.
  * Because the network may take some time to be ready the {@link Repo} will wait
  * until the adapter emits a `ready` event before it starts trying to use it
  */
-export abstract class NetworkAdapter extends EventEmitter<NetworkAdapterEvents> {
+export abstract class NetworkAdapter
+  extends EventEmitter<NetworkAdapterEvents>
+  implements NetworkAdapterInterface
+{
   peerId?: PeerId
   peerMetadata?: PeerMetadata
 
@@ -43,35 +37,3 @@ export abstract class NetworkAdapter extends EventEmitter<NetworkAdapterEvents>
   /** Called by the {@link Repo} to disconnect from the network */
   abstract disconnect(): void
 }
-
-// events & payloads
-
-export interface NetworkAdapterEvents {
-  /** Emitted when the network is ready to be used */
-  ready: (payload: OpenPayload) => void
-
-  /** Emitted when the network is closed */
-  close: () => void
-
-  /** Emitted when the network adapter learns about a new peer */
-  "peer-candidate": (payload: PeerCandidatePayload) => void
-
-  /** Emitted when the network adapter learns that a peer has disconnected */
-  "peer-disconnected": (payload: PeerDisconnectedPayload) => void
-
-  /** Emitted when the network adapter receives a message from a peer */
-  message: (payload: Message) => void
-}
-
-export interface OpenPayload {
-  network: NetworkAdapter
-}
-
-export interface PeerCandidatePayload {
-  peerId: PeerId
-  peerMetadata: PeerMetadata
-}
-
-export interface PeerDisconnectedPayload {
-  peerId: PeerId
-}

package/src/network/NetworkAdapterInterface.ts

@@ -0,0 +1,77 @@
+/* c8 ignore start */
+
+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
+ * The {@link Repo} uses one or more `NetworkAdapter`s to connect to other peers.
+ * Because the network may take some time to be ready the {@link Repo} will wait
+ * until the adapter emits a `ready` event before it starts trying to use it
+ */
+export interface NetworkAdapterInterface 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
+   */
+  connect(peerId: PeerId, peerMetadata?: PeerMetadata): void
+
+  /** Called by the {@link Repo} to send a message to a peer
+   *
+   * @argument message - the message to send
+   */
+  send(message: Message): void
+
+  /** Called by the {@link Repo} to disconnect from the network */
+  disconnect(): void
+}
+
+// events & payloads
+
+export interface NetworkAdapterEvents {
+  /** Emitted when the network is ready to be used */
+  ready: (payload: OpenPayload) => void
+
+  /** Emitted when the network is closed */
+  close: () => void
+
+  /** Emitted when the network adapter learns about a new peer */
+  "peer-candidate": (payload: PeerCandidatePayload) => void
+
+  /** Emitted when the network adapter learns that a peer has disconnected */
+  "peer-disconnected": (payload: PeerDisconnectedPayload) => void
+
+  /** Emitted when the network adapter receives a message from a peer */
+  message: (payload: Message) => void
+}
+
+export interface OpenPayload {
+  network: NetworkAdapterInterface
+}
+
+export interface PeerCandidatePayload {
+  peerId: PeerId
+  peerMetadata: PeerMetadata
+}
+
+export interface PeerDisconnectedPayload {
+  peerId: PeerId
+}

package/src/network/NetworkSubsystem.ts

@@ -2,10 +2,10 @@ import debug from "debug"
 import { EventEmitter } from "eventemitter3"
 import { PeerId, SessionId } from "../types.js"
 import type {
-  NetworkAdapter,
+  NetworkAdapterInterface,
   PeerDisconnectedPayload,
   PeerMetadata,
-} from "./NetworkAdapter.js"
+} from "./NetworkAdapterInterface.js"
 import {
   EphemeralMessage,
   MessageContents,
@@ -21,16 +21,16 @@ const getEphemeralMessageSource = (message: EphemeralMessage) =>
 
 export class NetworkSubsystem extends EventEmitter<NetworkSubsystemEvents> {
   #log: debug.Debugger
-  #adaptersByPeer: Record<PeerId, NetworkAdapter> = {}
+  #adaptersByPeer: Record<PeerId, NetworkAdapterInterface> = {}
 
   #count = 0
   #sessionId: SessionId = Math.random().toString(36).slice(2) as SessionId
   #ephemeralSessionCounts: Record<EphemeralMessageSource, number> = {}
   #readyAdapterCount = 0
-  #adapters: NetworkAdapter[] = []
+  #adapters: NetworkAdapterInterface[] = []
 
   constructor(
-    adapters: NetworkAdapter[],
+    adapters: NetworkAdapterInterface[],
     public peerId = randomPeerId(),
     private peerMetadata: Promise<PeerMetadata>
   ) {
@@ -39,7 +39,7 @@ export class NetworkSubsystem extends EventEmitter<NetworkSubsystemEvents> {
     adapters.forEach(a => this.addNetworkAdapter(a))
   }
 
-  addNetworkAdapter(networkAdapter: NetworkAdapter) {
+  addNetworkAdapter(networkAdapter: NetworkAdapterInterface) {
     this.#adapters.push(networkAdapter)
     networkAdapter.once("ready", () => {
       this.#readyAdapterCount++
@@ -105,11 +105,13 @@ export class NetworkSubsystem extends EventEmitter<NetworkSubsystemEvents> {
       })
     })
 
-    this.peerMetadata.then(peerMetadata => {
-      networkAdapter.connect(this.peerId, peerMetadata)
-    }).catch(err => {
-      this.#log("error connecting to network", err)
-    })
+    this.peerMetadata
+      .then(peerMetadata => {
+        networkAdapter.connect(this.peerId, peerMetadata)
+      })
+      .catch(err => {
+        this.#log("error connecting to network", err)
+      })
   }
 
   send(message: MessageContents) {

package/src/storage/StorageAdapter.ts

@@ -1,12 +1,14 @@
+import { StorageAdapterInterface } from "./StorageAdapterInterface.js"
 import { StorageKey, Chunk } from "./types.js"
 
 /** A storage adapter represents some way of storing binary data for a {@link Repo}
+ * @deprecated use {@link StorageAdapterInterface}
  *
  * @remarks
  * `StorageAdapter`s provide a key/value storage interface. The keys are arrays of strings
  * ({@link StorageKey}) and the values are binary blobs.
  */
-export abstract class StorageAdapter {
+export abstract class StorageAdapter implements StorageAdapterInterface {
   /** Load the single value corresponding to `key` */
   abstract load(key: StorageKey): Promise<Uint8Array | undefined>
 

package/src/storage/StorageAdapterInterface.ts

@@ -0,0 +1,34 @@
+import { StorageKey, Chunk } from "./types.js"
+
+/** A storage adapter represents some way of storing binary data for a {@link Repo}
+ *
+ * @remarks
+ * `StorageAdapter`s provide a key/value storage interface. The keys are arrays of strings
+ * ({@link StorageKey}) and the values are binary blobs.
+ */
+export interface StorageAdapterInterface {
+  /** Load the single value corresponding to `key` */
+  load(key: StorageKey): Promise<Uint8Array | undefined>
+
+  /** Save the value `data` to the key `key` */
+  save(key: StorageKey, data: Uint8Array): Promise<void>
+
+  /** Remove the value corresponding to `key` */
+  remove(key: StorageKey): Promise<void>
+
+  /**
+   * Load all values with keys that start with `keyPrefix`.
+   *
+   * @remarks
+   * The `keyprefix` will match any key that starts with the given array. For example:
+   * - `[documentId, "incremental"]` will match all incremental saves
+   * - `[documentId]` will match all data for a given document.
+   *
+   * Be careful! `[documentId]` would also match something like `[documentId, "syncState"]`! We
+   * aren't using this yet but keep it in mind.)
+   */
+  loadRange(keyPrefix: StorageKey): Promise<Chunk[]>
+
+  /** Remove all values with keys that start with `keyPrefix` */
+  removeRange(keyPrefix: StorageKey): Promise<void>
+}

package/src/storage/StorageSubsystem.ts

@@ -3,7 +3,7 @@ import debug from "debug"
 import { headsAreSame } from "../helpers/headsAreSame.js"
 import { mergeArrays } from "../helpers/mergeArrays.js"
 import { type DocumentId } from "../types.js"
-import { StorageAdapter } from "./StorageAdapter.js"
+import { StorageAdapterInterface } from "./StorageAdapterInterface.js"
 import { ChunkInfo, StorageKey, StorageId } from "./types.js"
 import { keyHash, headsHash } from "./keyHash.js"
 import { chunkTypeFromKey } from "./chunkTypeFromKey.js"
@@ -15,7 +15,7 @@ import * as Uuid from "uuid"
  */
 export class StorageSubsystem {
   /** The storage adapter to use for saving and loading documents */
-  #storageAdapter: StorageAdapter
+  #storageAdapter: StorageAdapterInterface
 
   /** Record of the latest heads we've loaded or saved for each document  */
   #storedHeads: Map<DocumentId, A.Heads> = new Map()
@@ -28,7 +28,7 @@ export class StorageSubsystem {
 
   #log = debug(`automerge-repo:storage-subsystem`)
 
-  constructor(storageAdapter: StorageAdapter) {
+  constructor(storageAdapter: StorageAdapterInterface) {
     this.#storageAdapter = storageAdapter
   }
 

package/src/synchronizer/DocSynchronizer.ts

@@ -227,8 +227,8 @@ export class DocSynchronizer extends Synchronizer {
   }
 
   beginSync(peerIds: PeerId[]) {
-    const newPeers = new Set(
-      peerIds.filter(peerId => !this.#peers.includes(peerId))
+    const noPeersWithDocument = peerIds.every(
+      (peerId) => this.#peerDocumentStatuses[peerId] in ["unavailable", "wants"]
     )
 
     // At this point if we don't have anything in our storage, we need to use an empty doc to sync
@@ -242,7 +242,7 @@ export class DocSynchronizer extends Synchronizer {
         this.#checkDocUnavailable()
 
         const wasUnavailable = doc === undefined
-        if (wasUnavailable && newPeers.size == 0) {
+        if (wasUnavailable && noPeersWithDocument) {
           return
         }
 

package/test/DocHandle.test.ts

@@ -1,7 +1,7 @@
 import * as A from "@automerge/automerge/next"
 import assert from "assert"
 import { decode } from "cbor-x"
-import { describe, it } from "vitest"
+import { describe, it, vi } from "vitest"
 import { generateAutomergeUrl, parseAutomergeUrl } from "../src/AutomergeUrl.js"
 import { eventPromise } from "../src/helpers/eventPromise.js"
 import { pause } from "../src/helpers/pause.js"
@@ -72,6 +72,29 @@ describe("DocHandle", () => {
     assert.equal(doc?.foo, "bar")
   })
 
+  /**
+   * Once there's a Repo#stop API this case should be covered in accompanying
+   * tests and the following test removed.
+   */
+  it("no pending timers after a document is loaded", async () => {
+    vi.useFakeTimers()
+    const timerCount = vi.getTimerCount()
+
+    const handle = new DocHandle<TestDoc>(TEST_ID)
+    assert.equal(handle.isReady(), false)
+
+    handle.doc()
+
+    assert(vi.getTimerCount() > timerCount)
+
+    // simulate loading from storage
+    handle.update(doc => docFromMockStorage(doc))
+
+    assert.equal(handle.isReady(), true)
+    assert.equal(vi.getTimerCount(), timerCount)
+    vi.useRealTimers()
+  })
+
   it("should block changes until ready()", async () => {
     const handle = new DocHandle<TestDoc>(TEST_ID)
 

package/test/Repo.test.ts

@@ -3,7 +3,7 @@ import { MessageChannelNetworkAdapter } from "../../automerge-repo-network-messa
 import assert from "assert"
 import * as Uuid from "uuid"
 import { describe, expect, it } from "vitest"
-import { READY } from "../src/DocHandle.js"
+import { HandleState, READY } from "../src/DocHandle.js"
 import { parseAutomergeUrl } from "../src/AutomergeUrl.js"
 import {
   generateAutomergeUrl,
@@ -1023,6 +1023,37 @@ describe("Repo", () => {
     })
   })
 
+
+  it('peer receives a document when connection is recovered', async () => {
+    const alice = "alice" as PeerId;
+    const bob = "bob" as PeerId;
+    const [aliceAdapter, bobAdapter] = DummyNetworkAdapter.createConnectedPair();
+    const aliceRepo = new Repo({
+      network: [aliceAdapter],
+      peerId: alice
+    })
+    const bobRepo = new Repo({
+      network: [bobAdapter],
+      peerId: bob
+    })
+
+    const aliceDoc = aliceRepo.create();
+    aliceDoc.change((doc: any) => doc.text = 'Hello world');
+
+    const bobDoc = bobRepo.find(aliceDoc.url);
+    bobDoc.unavailable()
+    await bobDoc.whenReady([HandleState.UNAVAILABLE]);
+
+    aliceAdapter.peerCandidate(bob);
+    // Bob isn't yet connected to Alice and can't respond to her sync message
+    await pause(100);
+    bobAdapter.peerCandidate(alice);
+
+    await bobDoc.whenReady([HandleState.READY]);
+
+    assert.equal(bobDoc.isReady(), true);
+  });
+
   describe("with peers (mesh network)", () => {
     const setup = async () => {
       // Set up three repos; connect Alice to Bob, Bob to Charlie, and Alice to Charlie

package/test/helpers/DummyNetworkAdapter.ts

@@ -1,21 +1,53 @@
-import { NetworkAdapter } from "../../src/index.js"
+import { pause } from "../../src/helpers/pause.js";
+import { Message, NetworkAdapter, PeerId } from "../../src/index.js"
 
 export class DummyNetworkAdapter extends NetworkAdapter {
   #startReady: boolean
+  #sendMessage?: SendMessageFn;
 
-  constructor({ startReady = true }: Options = {}) {
+  constructor(opts: Options = {startReady: true}) {
     super()
-    this.#startReady = startReady
+    this.#startReady = opts.startReady;
+    this.#sendMessage = opts.sendMessage;
   }
-  send() {}
+
   connect(_: string) {
     if (this.#startReady) {
       this.emit("ready", { network: this })
     }
   }
+
   disconnect() {}
+
+  peerCandidate(peerId: PeerId) {
+    this.emit('peer-candidate', { peerId, peerMetadata: {} });
+  }
+
+  override send(message: Message) {
+    this.#sendMessage?.(message);
+  }
+
+  receive(message: Message) {
+    this.emit('message', message);
+  }
+
+  static createConnectedPair() {
+    const adapter1: DummyNetworkAdapter = new DummyNetworkAdapter({
+      startReady: true,
+      sendMessage: (message: Message) => pause(10).then(() => adapter2.receive(message)),
+    });
+    const adapter2: DummyNetworkAdapter = new DummyNetworkAdapter({
+      startReady: true,
+      sendMessage: (message: Message) => pause(10).then(() => adapter1.receive(message)),
+    });
+
+    return [adapter1, adapter2];
+  }
 }
 
+type SendMessageFn = (message: Message) => void;
+
 type Options = {
-  startReady?: boolean
+  startReady?: boolean;
+  sendMessage?: SendMessageFn;
 }