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

package/.eslintrc

@@ -8,7 +8,7 @@
     "plugin:@typescript-eslint/eslint-recommended",
     "plugin:@typescript-eslint/recommended"
   ],
-  "ignorePatterns": ["dist/**"],
+  "ignorePatterns": ["dist/**", "test/**", "node_modules/**"],
   "parser": "@typescript-eslint/parser",
   "plugins": ["@typescript-eslint", "mocha"],
   "parserOptions": {
@@ -21,7 +21,7 @@
     "import/extensions": 0,
     "lines-between-class-members": 0,
     "@typescript-eslint/no-floating-promises": "error",
-    "@typescript-eslint/no-empty-function": ["warn", { "allow": ["methods"]}],
+    "@typescript-eslint/no-empty-function": ["warn", { "allow": ["methods"] }],
     "no-param-reassign": 0,
     "no-use-before-define": 0
   }

package/dist/DocHandle.d.ts

@@ -55,7 +55,11 @@ export declare class DocHandle<T>//
     update(callback: (doc: A.Doc<T>) => A.Doc<T>): void;
     /** `change` is called by the repo when the document is changed locally  */
     change(callback: A.ChangeFn<T>, options?: A.ChangeOptions<T>): void;
-    changeAt(heads: A.Heads, callback: A.ChangeFn<T>, options?: A.ChangeOptions<T>): void;
+    /** Make a change as if the document were at `heads`
+     *
+     * @returns A set of heads representing the concurrent change that was made.
+     */
+    changeAt(heads: A.Heads, callback: A.ChangeFn<T>, options?: A.ChangeOptions<T>): string[] | undefined;
     unavailable(): void;
     /** `request` is called by the repo when the document is not found in storage */
     request(): void;

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;AAKf,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAIlE,iGAAiG;AACjG,qBAAa,SAAS,CAAC,CAAC,CAAE,EAAE;AAC1B,SAAQ,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;;IAY/B,UAAU,EAAE,UAAU;IAL/B,IAAI,GAAG,IAAI,YAAY,CAEtB;gBAGQ,UAAU,EAAE,UAAU,EAC7B,EAAE,KAAa,EAAE,YAAqB,EAAE,GAAE,gBAAqB;IAmMjE;;;;OAIG;IACH,OAAO,gBAA0C;IACjD;;;;;OAKG;IACH,SAAS,gBAA4C;IACrD,aAAa,gBAAgD;IAC7D,OAAO,WAAY,WAAW,EAAE,aACmB;IAEnD,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;IAchC;;;;;;;;;OASG;IACH,OAAO,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS;IAQ/B,8EAA8E;IAC9E,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAM5C,2EAA2E;IAC3E,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,GAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAM;IAehE,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;IAgBlC,WAAW;IAIX,gFAAgF;IAChF,OAAO;IAIP,YAAY;IAIZ,YAAY;IAIZ,kEAAkE;IAClE,MAAM;IAIN;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,GAAG;CAMvB;AAID,UAAU,gBAAgB;IACxB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,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,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACpB,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACb,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,CAAA;IAClB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;CAC1B;AAED,MAAM,WAAW,gCAAgC;IAC/C,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,wCAAwC;IACvD,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;IACtB,IAAI,EAAE,UAAU,CAAA;CACjB;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,KAAK,IAAI,CAAA;IACxE,4BAA4B,EAAE,CAC5B,OAAO,EAAE,wCAAwC,KAC9C,IAAI,CAAA;CACV;AAMD,eAAO,MAAM,WAAW;;;;;;;;;CASd,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,MAAM,YACN,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;AAKf,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAIlE,iGAAiG;AACjG,qBAAa,SAAS,CAAC,CAAC,CAAE,EAAE;AAC1B,SAAQ,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;;IAY/B,UAAU,EAAE,UAAU;IAL/B,IAAI,GAAG,IAAI,YAAY,CAEtB;gBAGQ,UAAU,EAAE,UAAU,EAC7B,EAAE,KAAa,EAAE,YAAqB,EAAE,GAAE,gBAAqB;IAmMjE;;;;OAIG;IACH,OAAO,gBAA0C;IACjD;;;;;OAKG;IACH,SAAS,gBAA4C;IACrD,aAAa,gBAAgD;IAC7D,OAAO,WAAY,WAAW,EAAE,aACmB;IAEnD,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;IAchC;;;;;;;;;OASG;IACH,OAAO,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS;IAQ/B,8EAA8E;IAC9E,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAM5C,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,WAAW;IAIX,gFAAgF;IAChF,OAAO;IAIP,YAAY;IAIZ,YAAY;IAIZ,kEAAkE;IAClE,MAAM;IAIN;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,GAAG;CAMvB;AAID,UAAU,gBAAgB;IACxB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,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,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACpB,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACb,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,CAAA;IAClB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;CAC1B;AAED,MAAM,WAAW,gCAAgC;IAC/C,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,wCAAwC;IACvD,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;IACtB,IAAI,EAAE,UAAU,CAAA;CACjB;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,KAAK,IAAI,CAAA;IACxE,4BAA4B,EAAE,CAC5B,OAAO,EAAE,wCAAwC,KAC9C,IAAI,CAAA;CACV;AAMD,eAAO,MAAM,WAAW;;;;;;;;;CASd,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,MAAM,YACN,OAAO,aACP,WAAW,eACE,CAAA"}

package/dist/DocHandle.js

@@ -269,17 +269,25 @@ export class DocHandle//
             },
         });
     }
+    /** Make a change as if the document were at `heads`
+     *
+     * @returns A set of heads representing the concurrent change that was made.
+     */
     changeAt(heads, callback, options = {}) {
         if (!this.isReady()) {
             throw new Error(`DocHandle#${this.documentId} is not ready. Check \`handle.isReady()\` before accessing the document.`);
         }
+        let resultHeads = undefined;
         this.#machine.send(UPDATE, {
             payload: {
                 callback: (doc) => {
-                    return A.changeAt(doc, heads, options, callback).newDoc;
+                    const result = A.changeAt(doc, heads, options, callback);
+                    resultHeads = result.newHeads;
+                    return result.newDoc;
                 },
             },
         });
+        return resultHeads;
     }
     unavailable() {
         this.#machine.send(MARK_UNAVAILABLE);

package/dist/Repo.d.ts

@@ -1,15 +1,36 @@
-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 { DocumentId, PeerId } from "./types.js";
-/** A Repo is a DocCollection with networking, syncing, and storage capabilities. */
-export declare class Repo extends DocCollection {
+import { type AutomergeUrl, DocumentId, PeerId } from "./types.js";
+import { DocHandle } from "./DocHandle.js";
+import { EventEmitter } from "eventemitter3";
+/** A Repo is a collection of documents with networking, syncing, and storage capabilities. */
+export declare class Repo extends EventEmitter<DocCollectionEvents> {
     #private;
     networkSubsystem: NetworkSubsystem;
     storageSubsystem?: StorageSubsystem;
+    /** By default, we share generously with all peers. */
+    sharePolicy: SharePolicy;
     constructor({ storage, network, peerId, sharePolicy }: RepoConfig);
+    /** 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;
 }
 export interface RepoConfig {
     /** Our unique identifier */
@@ -25,4 +46,17 @@ export interface RepoConfig {
     sharePolicy?: SharePolicy;
 }
 export type SharePolicy = (peerId: PeerId, documentId?: DocumentId) => Promise<boolean>;
+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=Repo.d.ts.map

package/dist/Repo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Repo.d.ts","sourceRoot":"","sources":["../src/Repo.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAEhE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAE/C,oFAAoF;AACpF,qBAAa,IAAK,SAAQ,aAAa;;IAGrC,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;gBAEvB,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,UAAU;CAiGlE;AAED,MAAM,WAAW,UAAU;IACzB,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,gDAAgD;IAChD,OAAO,CAAC,EAAE,cAAc,CAAA;IAExB,oDAAoD;IACpD,OAAO,EAAE,cAAc,EAAE,CAAA;IAEzB;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B;AAED,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,KACpB,OAAO,CAAC,OAAO,CAAC,CAAA"}
+{"version":3,"file":"Repo.d.ts","sourceRoot":"","sources":["../src/Repo.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAEhE,OAAO,EAAE,KAAK,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAIlE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE5C,8FAA8F;AAC9F,qBAAa,IAAK,SAAQ,YAAY,CAAC,mBAAmB,CAAC;;IAGzD,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IAGnC,sDAAsD;IACtD,WAAW,EAAE,WAAW,CAAmB;gBAE/B,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,UAAU;IAoHjE,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;AAED,MAAM,WAAW,UAAU;IACzB,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,gDAAgD;IAChD,OAAO,CAAC,EAAE,cAAc,CAAA;IAExB,oDAAoD;IACpD,OAAO,EAAE,cAAc,EAAE,CAAA;IAEzB;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B;AAED,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,KACpB,OAAO,CAAC,OAAO,CAAC,CAAA;AAGrB,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/Repo.js

@@ -1,13 +1,18 @@
 import debug from "debug";
-import { DocCollection } from "./DocCollection.js";
 import { NetworkSubsystem } from "./network/NetworkSubsystem.js";
 import { StorageSubsystem } from "./storage/StorageSubsystem.js";
 import { CollectionSynchronizer } from "./synchronizer/CollectionSynchronizer.js";
-/** A Repo is a DocCollection with networking, syncing, and storage capabilities. */
-export class Repo extends DocCollection {
+import { parseAutomergeUrl, generateAutomergeUrl, isValidAutomergeUrl } from "./DocUrl.js";
+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 {
     #log;
     networkSubsystem;
     storageSubsystem;
+    #handleCache = {};
+    /** By default, we share generously with all peers. */
+    sharePolicy = async () => true;
     constructor({ storage, network, peerId, sharePolicy }) {
         super();
         this.#log = debug(`automerge-repo:repo`);
@@ -92,4 +97,91 @@ export class Repo extends DocCollection {
             await synchronizer.receiveMessage(msg);
         });
     }
+    /** 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,
+        });
+    }
 }

package/dist/index.d.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/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACvD,YAAY,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAA;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,YAAY,EACV,WAAW,EACX,oBAAoB,EACpB,uBAAuB,GACxB,MAAM,6BAA6B,CAAA;AAMpC,YAAY,EACV,OAAO,EACP,qBAAqB,EACrB,gBAAgB,EAChB,WAAW,GACZ,MAAM,uBAAuB,CAAA;AAE9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,IAAI,EAAE,KAAK,WAAW,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,EAAE,cAAc,EAAE,KAAK,UAAU,EAAE,MAAM,6BAA6B,CAAA;AAC7E,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAA;AACjF,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,IAAI,oBAAoB,GAC9C,MAAM,aAAa,CAAA;AACpB,cAAc,YAAY,CAAA;AAE1B,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACvD,YAAY,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAA;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,YAAY,EACV,WAAW,EACX,oBAAoB,EACpB,uBAAuB,GACxB,MAAM,6BAA6B,CAAA;AAMpC,YAAY,EACV,OAAO,EACP,qBAAqB,EACrB,gBAAgB,EAChB,WAAW,GACZ,MAAM,uBAAuB,CAAA;AAE9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,IAAI,EAAE,KAAK,WAAW,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,EAAE,cAAc,EAAE,KAAK,UAAU,EAAE,MAAM,6BAA6B,CAAA;AAC7E,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAA;AACjF,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,IAAI,oBAAoB,GAC9C,MAAM,aAAa,CAAA;AACpB,cAAc,YAAY,CAAA;AAE1B,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAA"}

package/dist/index.js

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

package/dist/synchronizer/CollectionSynchronizer.d.ts

@@ -1,4 +1,4 @@
-import { DocCollection } from "../DocCollection.js";
+import { Repo } from "../Repo.js";
 import { PeerId, DocumentId } from "../types.js";
 import { Synchronizer } from "./Synchronizer.js";
 import { SynchronizerMessage } from "../network/messages.js";
@@ -6,7 +6,7 @@ import { SynchronizerMessage } from "../network/messages.js";
 export declare class CollectionSynchronizer extends Synchronizer {
     #private;
     private repo;
-    constructor(repo: DocCollection);
+    constructor(repo: Repo);
     /**
      * When we receive a sync message for a document we haven't got in memory, we
      * register it with the repo and start synchronizing

package/dist/synchronizer/CollectionSynchronizer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CollectionSynchronizer.d.ts","sourceRoot":"","sources":["../../src/synchronizer/CollectionSynchronizer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAOnD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAGhD,OAAO,EAGL,mBAAmB,EAEpB,MAAM,wBAAwB,CAAA;AAG/B,4FAA4F;AAC5F,qBAAa,sBAAuB,SAAQ,YAAY;;IAU1C,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,aAAa;IAiCvC;;;OAGG;IACG,cAAc,CAAC,OAAO,EAAE,mBAAmB;IAyBjD;;OAEG;IACH,WAAW,CAAC,UAAU,EAAE,UAAU;IAYlC,cAAc,CAAC,UAAU,EAAE,UAAU;IAIrC,2DAA2D;IAC3D,OAAO,CAAC,MAAM,EAAE,MAAM;IAgBtB,uDAAuD;IACvD,UAAU,CAAC,MAAM,EAAE,MAAM;CAQ1B"}
+{"version":3,"file":"CollectionSynchronizer.d.ts","sourceRoot":"","sources":["../../src/synchronizer/CollectionSynchronizer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AAOjC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAGhD,OAAO,EAGL,mBAAmB,EAEpB,MAAM,wBAAwB,CAAA;AAG/B,4FAA4F;AAC5F,qBAAa,sBAAuB,SAAQ,YAAY;;IAU1C,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,IAAI;IAiC9B;;;OAGG;IACG,cAAc,CAAC,OAAO,EAAE,mBAAmB;IAyBjD;;OAEG;IACH,WAAW,CAAC,UAAU,EAAE,UAAU;IAYlC,cAAc,CAAC,UAAU,EAAE,UAAU;IAIrC,2DAA2D;IAC3D,OAAO,CAAC,MAAM,EAAE,MAAM;IAgBtB,uDAAuD;IACvD,UAAU,CAAC,MAAM,EAAE,MAAM;CAQ1B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo",
-  "version": "1.0.0-alpha.5",
+  "version": "1.0.0",
   "description": "A repository object to manage a collection of automerge documents",
   "repository": "https://github.com/automerge/automerge-repo",
   "author": "Peter van Hardenberg <pvh@pvh.ca>",
@@ -31,7 +31,7 @@
     "typescript": "^5.1.6"
   },
   "peerDependencies": {
-    "@automerge/automerge": "^2.1.0-alpha.13"
+    "@automerge/automerge": "^2.1.0"
   },
   "dependencies": {
     "bs58check": "^3.0.1",
@@ -65,5 +65,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9cd9be160ebda37c8f0d70f2d5cadea5b951a3c3"
+  "gitHead": "89c6ee2714d43dbebd69c7a62f148d17869608d6"
 }

package/src/DocHandle.ts

@@ -326,23 +326,31 @@ export class DocHandle<T> //
     })
   }
 
+  /** Make a change as if the document were at `heads`
+   *
+   * @returns A set of heads representing the concurrent change that was made.
+   */
   changeAt(
     heads: A.Heads,
     callback: A.ChangeFn<T>,
     options: A.ChangeOptions<T> = {}
-  ) {
+  ): string[] | undefined {
     if (!this.isReady()) {
       throw new Error(
         `DocHandle#${this.documentId} is not ready. Check \`handle.isReady()\` before accessing the document.`
       )
     }
+    let resultHeads: string[] | undefined = undefined
     this.#machine.send(UPDATE, {
       payload: {
         callback: (doc: A.Doc<T>) => {
-          return A.changeAt(doc, heads, options, callback).newDoc
+          const result = A.changeAt(doc, heads, options, callback)
+          resultHeads = result.newHeads
+          return result.newDoc
         },
       },
     })
+    return resultHeads
   }
 
   unavailable() {

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

@@ -47,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 () => {

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,
-        });
-    }
-}

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)
-  })
-})