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

package/src/DocCollection.ts

@@ -1,144 +0,0 @@
-import { EventEmitter } from "eventemitter3"
-import { DocHandle } from "./DocHandle.js"
-import { DocumentId, type BinaryDocumentId, AutomergeUrl } from "./types.js"
-import { type SharePolicy } from "./Repo.js"
-import {
-  documentIdToBinary,
-  binaryToDocumentId,
-  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<DocCollectionEvents> {
-  #handleCache: Record<DocumentId, DocHandle<any>> = {}
-
-  /** By default, we share generously with all peers. */
-  sharePolicy: SharePolicy = async () => true
-
-  constructor() {
-    super()
-  }
-
-  /** 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,
-    })
-  }
-}
-
-// 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/test/DocCollection.test.ts

@@ -1,20 +0,0 @@
-import assert from "assert"
-import { DocCollection, BinaryDocumentId } from "../src/index.js"
-import { TestDoc } from "./types.js"
-import { generateAutomergeUrl, stringifyAutomergeUrl } from "../src/DocUrl.js"
-
-const MISSING_DOCID = generateAutomergeUrl()
-
-describe("DocCollection", () => {
-  it("can create documents which are ready to go", async () => {
-    const collection = new DocCollection()
-    const handle = collection.create<TestDoc>()
-    assert(handle.isReady() === true)
-  })
-
-  it("can start finding documents and they shouldn't be ready", () => {
-    const collection = new DocCollection()
-    const handle = collection.find<TestDoc>(MISSING_DOCID)
-    assert(handle.isReady() === false)
-  })
-})