@automerge/automerge-repo 1.0.0-alpha.4 → 1.0.0

package/src/Repo.ts

@@ -1,18 +1,26 @@
 import debug from "debug"
-import { DocCollection } from "./DocCollection.js"
 import { NetworkAdapter } from "./network/NetworkAdapter.js"
 import { NetworkSubsystem } from "./network/NetworkSubsystem.js"
 import { StorageAdapter } from "./storage/StorageAdapter.js"
 import { StorageSubsystem } from "./storage/StorageSubsystem.js"
 import { CollectionSynchronizer } from "./synchronizer/CollectionSynchronizer.js"
-import { DocumentId, PeerId } from "./types.js"
+import { type AutomergeUrl, DocumentId, PeerId } from "./types.js"
+import { v4 as uuid } from "uuid"
+import { parseAutomergeUrl, generateAutomergeUrl, isValidAutomergeUrl } from "./DocUrl.js"
 
-/** A Repo is a DocCollection with networking, syncing, and storage capabilities. */
-export class Repo extends DocCollection {
+import { DocHandle } from "./DocHandle.js"
+import { EventEmitter } from "eventemitter3"
+
+/** A Repo is a collection of documents with networking, syncing, and storage capabilities. */
+export class Repo extends EventEmitter<DocCollectionEvents> {
   #log: debug.Debugger
 
   networkSubsystem: NetworkSubsystem
   storageSubsystem?: StorageSubsystem
+  #handleCache: Record<DocumentId, DocHandle<any>> = {}
+
+  /** By default, we share generously with all peers. */
+  sharePolicy: SharePolicy = async () => true
 
   constructor({ storage, network, peerId, sharePolicy }: RepoConfig) {
     super()
@@ -111,6 +119,108 @@ export class Repo extends DocCollection {
       await synchronizer.receiveMessage(msg)
     })
   }
+
+    /** Returns an existing handle if we have it; creates one otherwise. */
+  #getHandle<T>(
+    /** The documentId of the handle to look up or create */
+    documentId: DocumentId,
+
+    /** If we know we're creating a new document, specify this so we can have access to it immediately */
+    isNew: boolean
+  ) {
+    // If we have the handle cached, return it
+    if (this.#handleCache[documentId]) return this.#handleCache[documentId]
+
+    // If not, create a new handle, cache it, and return it
+    if (!documentId) throw new Error(`Invalid documentId ${documentId}`)
+    const handle = new DocHandle<T>(documentId, { isNew })
+    this.#handleCache[documentId] = handle
+    return handle
+  }
+
+  /** Returns all the handles we have cached. */
+  get handles() {
+    return this.#handleCache
+  }
+
+  /**
+   * 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
+   * to advertise interest in the document.
+   */
+  create<T>(): DocHandle<T> {
+    // TODO:
+    // either
+    // - pass an initial value and do something like this to ensure that you get a valid initial value
+
+    // const myInitialValue = {
+    //   tasks: [],
+    //   filter: "all",
+    //
+    // const guaranteeInitialValue = (doc: any) => {
+    // if (!doc.tasks) doc.tasks = []
+    // if (!doc.filter) doc.filter = "all"
+
+    //   return { ...myInitialValue, ...doc }
+    // }
+
+    // or
+    // - pass a "reify" function that takes a `<any>` and returns `<T>`
+
+    // Generate a new UUID and store it in the buffer
+    const { documentId } = parseAutomergeUrl(generateAutomergeUrl())
+    const handle = this.#getHandle<T>(documentId, true) as DocHandle<T>
+    this.emit("document", { handle, isNew: true })
+    return handle
+  }
+
+  /**
+   * Retrieves a document by id. It gets data from the local system, but also emits a `document`
+   * event to advertise interest in the document.
+   */
+  find<T>(
+    /** The documentId of the handle to retrieve */
+    automergeUrl: AutomergeUrl
+  ): DocHandle<T> {
+    if (!isValidAutomergeUrl(automergeUrl)) {
+      throw new Error(`Invalid AutomergeUrl: '${automergeUrl}'`)
+    }
+
+    const { documentId } = parseAutomergeUrl(automergeUrl)
+    // If we have the handle cached, return it
+    if (this.#handleCache[documentId]) {
+      if (this.#handleCache[documentId].isUnavailable()) {
+        // this ensures that the event fires after the handle has been returned
+        setTimeout(() => {
+          this.#handleCache[documentId].emit("unavailable", {
+            handle: this.#handleCache[documentId],
+          })
+        })
+      }
+      return this.#handleCache[documentId]
+    }
+
+    const handle = this.#getHandle<T>(documentId, false) as DocHandle<T>
+    this.emit("document", { handle, isNew: false })
+    return handle
+  }
+
+  delete(
+    /** The documentId of the handle to delete */
+    id: DocumentId | AutomergeUrl
+  ) {
+    if (isValidAutomergeUrl(id)) {
+      ;({ documentId: id } = parseAutomergeUrl(id))
+    }
+
+    const handle = this.#getHandle(id, false)
+    handle.delete()
+
+    delete this.#handleCache[id]
+    this.emit("delete-document", {
+      documentId: id,
+    })
+  }
 }
 
 export interface RepoConfig {
@@ -134,3 +244,19 @@ export type SharePolicy = (
   peerId: PeerId,
   documentId?: DocumentId
 ) => Promise<boolean>
+
+// events & payloads
+interface DocCollectionEvents {
+  document: (arg: DocumentPayload) => void
+  "delete-document": (arg: DeleteDocumentPayload) => void
+  "unavailable-document": (arg: DeleteDocumentPayload) => void
+}
+
+interface DocumentPayload {
+  handle: DocHandle<any>
+  isNew: boolean
+}
+
+interface DeleteDocumentPayload {
+  documentId: DocumentId
+}

package/src/index.ts

@@ -1,4 +1,3 @@
-export { DocCollection } from "./DocCollection.js"
 export { DocHandle, HandleState } from "./DocHandle.js"
 export type { DocHandleChangePayload } from "./DocHandle.js"
 export { NetworkAdapter } from "./network/NetworkAdapter.js"

package/src/network/NetworkAdapter.ts

@@ -5,13 +5,11 @@ import { Message } from "./messages.js"
 export abstract class NetworkAdapter extends EventEmitter<NetworkAdapterEvents> {
   peerId?: PeerId // hmmm, maybe not
 
-  abstract connect(url?: string): void
+  abstract connect(peerId: PeerId): void
 
   abstract send(message: Message): void
 
-  abstract join(): void
-
-  abstract leave(): void
+  abstract disconnect(): void
 }
 
 // events & payloads

package/src/network/NetworkSubsystem.ts

@@ -25,13 +25,10 @@ export class NetworkSubsystem extends EventEmitter<NetworkSubsystemEvents> {
   #count = 0
   #sessionId: SessionId = Math.random().toString(36).slice(2) as SessionId
   #ephemeralSessionCounts: Record<EphemeralMessageSource, number> = {}
-  #readyAdapterCount = 0 
+  #readyAdapterCount = 0
   #adapters: NetworkAdapter[] = []
 
-  constructor(
-    adapters: NetworkAdapter[],
-    public peerId = randomPeerId()
-  ) {
+  constructor(adapters: NetworkAdapter[], public peerId = randomPeerId()) {
     super()
     this.#log = debug(`automerge-repo:network:${this.peerId}`)
     adapters.forEach(a => this.addNetworkAdapter(a))
@@ -41,7 +38,12 @@ export class NetworkSubsystem extends EventEmitter<NetworkSubsystemEvents> {
     this.#adapters.push(networkAdapter)
     networkAdapter.once("ready", () => {
       this.#readyAdapterCount++
-      this.#log("Adapters ready: ", this.#readyAdapterCount, "/", this.#adapters.length)
+      this.#log(
+        "Adapters ready: ",
+        this.#readyAdapterCount,
+        "/",
+        this.#adapters.length
+      )
       if (this.#readyAdapterCount === this.#adapters.length) {
         this.emit("ready")
       }
@@ -100,7 +102,6 @@ export class NetworkSubsystem extends EventEmitter<NetworkSubsystemEvents> {
     })
 
     networkAdapter.connect(this.peerId)
-    networkAdapter.join()
   }
 
   send(message: MessageContents) {
@@ -116,11 +117,11 @@ export class NetworkSubsystem extends EventEmitter<NetworkSubsystemEvents> {
         "count" in message
           ? message
           : {
-              ...message,
-              count: ++this.#count,
-              sessionId: this.#sessionId,
-              senderId: this.peerId,
-            }
+            ...message,
+            count: ++this.#count,
+            sessionId: this.#sessionId,
+            senderId: this.peerId,
+          }
       this.#log("Ephemeral message", outbound)
       peer.send(outbound)
     } else {
@@ -130,16 +131,6 @@ export class NetworkSubsystem extends EventEmitter<NetworkSubsystemEvents> {
     }
   }
 
-  join() {
-    this.#log(`Joining network`)
-    this.#adapters.forEach(a => a.join())
-  }
-
-  leave() {
-    this.#log(`Leaving network`)
-    this.#adapters.forEach(a => a.leave())
-  }
-
   isReady = () => {
     return this.#readyAdapterCount === this.#adapters.length
   }
@@ -167,7 +158,7 @@ export interface NetworkSubsystemEvents {
   peer: (payload: PeerPayload) => void
   "peer-disconnected": (payload: PeerDisconnectedPayload) => void
   message: (payload: Message) => void
-  "ready": () => void
+  ready: () => void
 }
 
 export interface PeerPayload {

package/src/storage/StorageSubsystem.ts

@@ -35,6 +35,8 @@ export class StorageSubsystem {
   #storedHeads: Map<DocumentId, A.Heads> = new Map()
   #log = debug(`automerge-repo:storage-subsystem`)
 
+  #snapshotting = false
+
   constructor(storageAdapter: StorageAdapter) {
     this.#storageAdapter = storageAdapter
   }
@@ -67,6 +69,7 @@ export class StorageSubsystem {
     doc: A.Doc<unknown>,
     sourceChunks: StorageChunkInfo[]
   ): Promise<void> {
+    this.#snapshotting = true
     const binary = A.save(doc)
     const snapshotHash = headsHash(A.getHeads(doc))
     const key = [documentId, "snapshot", snapshotHash]
@@ -86,6 +89,7 @@ export class StorageSubsystem {
       this.#chunkInfos.get(documentId)?.filter(c => !oldKeys.has(c.key)) ?? []
     newChunkInfos.push({ key, type: "snapshot", size: binary.length })
     this.#chunkInfos.set(documentId, newChunkInfos)
+    this.#snapshotting = false
   }
 
   async loadDoc(documentId: DocumentId): Promise<A.Doc<unknown> | null> {
@@ -128,7 +132,7 @@ export class StorageSubsystem {
   }
 
   async remove(documentId: DocumentId) {
-    this.#storageAdapter.remove([documentId, "snapshot"])
+    this.#storageAdapter.removeRange([documentId, "snapshot"])
     this.#storageAdapter.removeRange([documentId, "incremental"])
   }
 
@@ -147,6 +151,9 @@ export class StorageSubsystem {
   }
 
   #shouldCompact(sourceChunks: StorageChunkInfo[]) {
+    if (this.#snapshotting) {
+      return false
+    }
     // compact if the incremental size is greater than the snapshot size
     let snapshotSize = 0
     let incrementalSize = 0
@@ -157,7 +164,7 @@ export class StorageSubsystem {
         incrementalSize += chunk.size
       }
     }
-    return incrementalSize > snapshotSize
+    return incrementalSize >= snapshotSize
   }
 }
 

package/src/synchronizer/CollectionSynchronizer.ts

@@ -1,4 +1,4 @@
-import { DocCollection } from "../DocCollection.js"
+import { Repo } from "../Repo.js"
 import { DocHandle } from "../DocHandle.js"
 import {
   documentIdToBinary,
@@ -29,7 +29,7 @@ export class CollectionSynchronizer extends Synchronizer {
   /** Used to determine if the document is know to the Collection and a synchronizer exists or is being set up */
   #docSetUp: Record<DocumentId, boolean> = {}
 
-  constructor(private repo: DocCollection) {
+  constructor(private repo: Repo) {
     super()
   }
 

package/test/CollectionSynchronizer.test.ts

@@ -1,15 +1,17 @@
 import assert from "assert"
 import { beforeEach } from "mocha"
-import { DocCollection, PeerId } from "../src/index.js"
+import { PeerId, Repo } from "../src/index.js"
 import { CollectionSynchronizer } from "../src/synchronizer/CollectionSynchronizer.js"
 
 describe("CollectionSynchronizer", () => {
-  let collection: DocCollection
+  let repo: Repo
   let synchronizer: CollectionSynchronizer
 
   beforeEach(() => {
-    collection = new DocCollection()
-    synchronizer = new CollectionSynchronizer(collection)
+    repo = new Repo({
+      network: [],
+    })
+    synchronizer = new CollectionSynchronizer(repo)
   })
 
   it("is not null", async () => {
@@ -17,7 +19,7 @@ describe("CollectionSynchronizer", () => {
   })
 
   it("starts synchronizing a document to peers when added", done => {
-    const handle = collection.create()
+    const handle = repo.create()
     synchronizer.addPeer("peer1" as PeerId)
 
     synchronizer.once("message", event => {
@@ -30,7 +32,7 @@ describe("CollectionSynchronizer", () => {
   })
 
   it("starts synchronizing existing documents when a peer is added", done => {
-    const handle = collection.create()
+    const handle = repo.create()
     synchronizer.addDocument(handle.documentId)
     synchronizer.once("message", event => {
       assert(event.targetId === "peer1")
@@ -41,9 +43,9 @@ describe("CollectionSynchronizer", () => {
   })
 
   it("should not synchronize to a peer which is excluded from the share policy", done => {
-    const handle = collection.create()
+    const handle = repo.create()
 
-    collection.sharePolicy = async (peerId: PeerId) => peerId !== "peer1"
+    repo.sharePolicy = async (peerId: PeerId) => peerId !== "peer1"
 
     synchronizer.addDocument(handle.documentId)
     synchronizer.once("message", () => {
@@ -55,9 +57,8 @@ describe("CollectionSynchronizer", () => {
   })
 
   it("should not synchronize a document which is excluded from the share policy", done => {
-    const handle = collection.create()
-    collection.sharePolicy = async (_, documentId) =>
-      documentId !== handle.documentId
+    const handle = repo.create()
+    repo.sharePolicy = async (_, documentId) => documentId !== handle.documentId
 
     synchronizer.addPeer("peer2" as PeerId)
 

package/test/DocHandle.test.ts

@@ -295,10 +295,11 @@ describe("DocHandle", () => {
     })
 
     let wasBar = false
-    handle.changeAt(headsBefore, doc => {
+    let newHeads = handle.changeAt(headsBefore, doc => {
       wasBar = doc.foo === "bar"
       doc.foo = "baz"
     })
+    assert(newHeads && newHeads.length > 0, "should have new heads")
 
     assert(wasBar, "foo should have been bar as we changed at the old heads")
   })

package/test/Repo.test.ts

@@ -18,6 +18,10 @@ import { getRandomItem } from "./helpers/getRandomItem.js"
 import { TestDoc } from "./types.js"
 import { generateAutomergeUrl, stringifyAutomergeUrl } from "../src/DocUrl.js"
 import { READY, AWAITING_NETWORK } from "../src/DocHandle.js"
+import {
+  generateLargeObject,
+  LargeObject,
+} from "./helpers/generate-large-object.js"
 
 describe("Repo", () => {
   describe("single repo", () => {
@@ -43,6 +47,7 @@ describe("Repo", () => {
       const { repo } = setup()
       const handle = repo.create()
       assert.notEqual(handle.documentId, null)
+      assert.equal(handle.isReady(), true)
     })
 
     it("can change a document", async () => {
@@ -98,7 +103,6 @@ describe("Repo", () => {
 
       networkAdapter.emit("ready", { network: networkAdapter })
       await eventPromise(handle, "unavailable")
-
     })
 
     it("can find a created document", async () => {
@@ -130,7 +134,6 @@ describe("Repo", () => {
       const bobHandle = repo2.find<TestDoc>(handle.url)
       await bobHandle.whenReady()
       assert.equal(bobHandle.isReady(), true)
-
     })
 
     it("saves the document when changed and can find it again", async () => {
@@ -162,6 +165,7 @@ describe("Repo", () => {
       handle.change(d => {
         d.foo = "bar"
       })
+      // we now have a snapshot and an incremental change in storage
       assert.equal(handle.isReady(), true)
       await handle.doc()
       repo.delete(handle.documentId)
@@ -274,6 +278,21 @@ describe("Repo", () => {
         assert(storage.keys().length !== 0)
       }
     })
+
+    it("doesn't create multiple snapshots in storage when a series of large changes are made in succession", async () => {
+      const { repo, storageAdapter } = setup()
+      const handle = repo.create<{ objects: LargeObject[] }>()
+
+      for (let i = 0; i < 5; i++) {
+        handle.change(d => {
+          d.objects = []
+          d.objects.push(generateLargeObject(100))
+        })
+      }
+
+      const storageKeyTypes = storageAdapter.keys().map(k => k.split(".")[1])
+      assert(storageKeyTypes.filter(k => k === "snapshot").length === 1)
+    })
   })
 
   describe("sync", async () => {
@@ -331,7 +350,9 @@ describe("Repo", () => {
       }
 
       function doConnectAlice() {
-        aliceRepo.networkSubsystem.addNetworkAdapter(new MessageChannelNetworkAdapter(aliceToBob))
+        aliceRepo.networkSubsystem.addNetworkAdapter(
+          new MessageChannelNetworkAdapter(aliceToBob)
+        )
         //bobRepo.networkSubsystem.addNetworkAdapter(new MessageChannelNetworkAdapter(bobToAlice))
       }
 
@@ -580,9 +601,9 @@ describe("Repo", () => {
         const doc =
           Math.random() < 0.5
             ? // heads, create a new doc
-            repo.create<TestDoc>()
+              repo.create<TestDoc>()
             : // tails, pick a random doc
-            (getRandomItem(docs) as DocHandle<TestDoc>)
+              (getRandomItem(docs) as DocHandle<TestDoc>)
 
         // make sure the doc is ready
         if (!doc.isReady()) {

package/test/helpers/DummyNetworkAdapter.ts

@@ -6,12 +6,11 @@ export class DummyNetworkAdapter extends NetworkAdapter {
     super()
     this.#startReady = startReady
   }
-  send() {}
+  send() { }
   connect(_: string) {
     if (this.#startReady) {
       this.emit("ready", { network: this })
     }
   }
-  join() {}
-  leave() {}
+  disconnect() { }
 }

package/test/helpers/generate-large-object.ts

@@ -0,0 +1,13 @@
+export type LargeObject = { [key: string]: number }
+
+export function generateLargeObject(size: number): LargeObject {
+  const largeObject: LargeObject = {}
+
+  for (let i = 0; i < size; i++) {
+    const key = `key${i}`
+    const value = Math.random()
+    largeObject[key] = value
+  }
+
+  return largeObject
+}

package/dist/DocCollection.d.ts

@@ -1,46 +0,0 @@
-import { EventEmitter } from "eventemitter3";
-import { DocHandle } from "./DocHandle.js";
-import { DocumentId, AutomergeUrl } from "./types.js";
-import { type SharePolicy } from "./Repo.js";
-/**
- * A DocCollection is a collection of DocHandles. It supports creating new documents and finding
- * documents by ID.
- * */
-export declare class DocCollection extends EventEmitter<DocCollectionEvents> {
-    #private;
-    /** By default, we share generously with all peers. */
-    sharePolicy: SharePolicy;
-    constructor();
-    /** Returns all the handles we have cached. */
-    get handles(): Record<DocumentId, DocHandle<any>>;
-    /**
-     * 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
-     * to advertise interest in the document.
-     */
-    create<T>(): DocHandle<T>;
-    /**
-     * Retrieves a document by id. It gets data from the local system, but also emits a `document`
-     * event to advertise interest in the document.
-     */
-    find<T>(
-    /** The documentId of the handle to retrieve */
-    automergeUrl: AutomergeUrl): DocHandle<T>;
-    delete(
-    /** The documentId of the handle to delete */
-    id: DocumentId | AutomergeUrl): void;
-}
-interface DocCollectionEvents {
-    document: (arg: DocumentPayload) => void;
-    "delete-document": (arg: DeleteDocumentPayload) => void;
-    "unavailable-document": (arg: DeleteDocumentPayload) => void;
-}
-interface DocumentPayload {
-    handle: DocHandle<any>;
-    isNew: boolean;
-}
-interface DeleteDocumentPayload {
-    documentId: DocumentId;
-}
-export {};
-//# sourceMappingURL=DocCollection.d.ts.map

package/dist/DocCollection.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"DocCollection.d.ts","sourceRoot":"","sources":["../src/DocCollection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAyB,YAAY,EAAE,MAAM,YAAY,CAAA;AAC5E,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,WAAW,CAAA;AAS5C;;;KAGK;AACL,qBAAa,aAAc,SAAQ,YAAY,CAAC,mBAAmB,CAAC;;IAGlE,sDAAsD;IACtD,WAAW,EAAE,WAAW,CAAmB;;IAwB3C,8CAA8C;IAC9C,IAAI,OAAO,uCAEV;IAED;;;;OAIG;IACH,MAAM,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC;IA0BzB;;;OAGG;IACH,IAAI,CAAC,CAAC;IACJ,+CAA+C;IAC/C,YAAY,EAAE,YAAY,GACzB,SAAS,CAAC,CAAC,CAAC;IAwBf,MAAM;IACJ,6CAA6C;IAC7C,EAAE,EAAE,UAAU,GAAG,YAAY;CAchC;AAGD,UAAU,mBAAmB;IAC3B,QAAQ,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,iBAAiB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IACvD,sBAAsB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;CAC7D;AAED,UAAU,eAAe;IACvB,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;IACtB,KAAK,EAAE,OAAO,CAAA;CACf;AAED,UAAU,qBAAqB;IAC7B,UAAU,EAAE,UAAU,CAAA;CACvB"}

package/dist/DocCollection.js

@@ -1,102 +0,0 @@
-import { EventEmitter } from "eventemitter3";
-import { DocHandle } from "./DocHandle.js";
-import { generateAutomergeUrl, isValidAutomergeUrl, parseAutomergeUrl, } from "./DocUrl.js";
-/**
- * A DocCollection is a collection of DocHandles. It supports creating new documents and finding
- * documents by ID.
- * */
-export class DocCollection extends EventEmitter {
-    #handleCache = {};
-    /** By default, we share generously with all peers. */
-    sharePolicy = async () => true;
-    constructor() {
-        super();
-    }
-    /** Returns an existing handle if we have it; creates one otherwise. */
-    #getHandle(
-    /** The documentId of the handle to look up or create */
-    documentId, 
-    /** If we know we're creating a new document, specify this so we can have access to it immediately */
-    isNew) {
-        // If we have the handle cached, return it
-        if (this.#handleCache[documentId])
-            return this.#handleCache[documentId];
-        // If not, create a new handle, cache it, and return it
-        if (!documentId)
-            throw new Error(`Invalid documentId ${documentId}`);
-        const handle = new DocHandle(documentId, { isNew });
-        this.#handleCache[documentId] = handle;
-        return handle;
-    }
-    /** Returns all the handles we have cached. */
-    get handles() {
-        return this.#handleCache;
-    }
-    /**
-     * 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
-     * to advertise interest in the document.
-     */
-    create() {
-        // TODO:
-        // either
-        // - pass an initial value and do something like this to ensure that you get a valid initial value
-        // const myInitialValue = {
-        //   tasks: [],
-        //   filter: "all",
-        //
-        // const guaranteeInitialValue = (doc: any) => {
-        // if (!doc.tasks) doc.tasks = []
-        // if (!doc.filter) doc.filter = "all"
-        //   return { ...myInitialValue, ...doc }
-        // }
-        // or
-        // - pass a "reify" function that takes a `<any>` and returns `<T>`
-        // Generate a new UUID and store it in the buffer
-        const { documentId } = parseAutomergeUrl(generateAutomergeUrl());
-        const handle = this.#getHandle(documentId, true);
-        this.emit("document", { handle, isNew: true });
-        return handle;
-    }
-    /**
-     * Retrieves a document by id. It gets data from the local system, but also emits a `document`
-     * event to advertise interest in the document.
-     */
-    find(
-    /** The documentId of the handle to retrieve */
-    automergeUrl) {
-        if (!isValidAutomergeUrl(automergeUrl)) {
-            throw new Error(`Invalid AutomergeUrl: '${automergeUrl}'`);
-        }
-        const { documentId } = parseAutomergeUrl(automergeUrl);
-        // If we have the handle cached, return it
-        if (this.#handleCache[documentId]) {
-            if (this.#handleCache[documentId].isUnavailable()) {
-                // this ensures that the event fires after the handle has been returned
-                setTimeout(() => {
-                    this.#handleCache[documentId].emit("unavailable", {
-                        handle: this.#handleCache[documentId],
-                    });
-                });
-            }
-            return this.#handleCache[documentId];
-        }
-        const handle = this.#getHandle(documentId, false);
-        this.emit("document", { handle, isNew: false });
-        return handle;
-    }
-    delete(
-    /** The documentId of the handle to delete */
-    id) {
-        if (isValidAutomergeUrl(id)) {
-            ;
-            ({ documentId: id } = parseAutomergeUrl(id));
-        }
-        const handle = this.#getHandle(id, false);
-        handle.delete();
-        delete this.#handleCache[id];
-        this.emit("delete-document", {
-            documentId: id,
-        });
-    }
-}