@automerge/automerge-repo 2.4.0-alpha.0 → 2.4.0-alpha.2

package/dist/AutomergeUrl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AutomergeUrl.d.ts","sourceRoot":"","sources":["../src/AutomergeUrl.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,EAChB,UAAU,EACV,aAAa,EACb,QAAQ,EACT,MAAM,YAAY,CAAA;AASnB,OAAO,KAAK,EAAE,KAAK,IAAI,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAExE,eAAO,MAAM,SAAS,eAAe,CAAA;AAErC,UAAU,kBAAkB;IAC1B,2BAA2B;IAC3B,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,8BAA8B;IAC9B,UAAU,EAAE,UAAU,CAAA;IACtB,mDAAmD;IACnD,KAAK,CAAC,EAAE,QAAQ,CAAA;IAChB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB;AAED,sGAAsG;AACtG,eAAO,MAAM,iBAAiB,GAAI,KAAK,YAAY,KAAG,kBAsBrD,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,GAChC,KAAK,UAAU,GAAG,UAAU,GAAG,gBAAgB,KAC9C,YAgCF,CAAA;AAED,gEAAgE;AAChE,eAAO,MAAM,eAAe,GAAI,KAAK,YAAY,KAAG,MAAM,EAAE,GAAG,SAG9D,CAAA;AAED,eAAO,MAAM,2BAA2B,GAAI,IAAI,aAAa,6BAO9C,CAAA;AAEf;;;GAGG;AACH,eAAO,MAAM,mBAAmB,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,YAsBzD,CAAA;AAED,eAAO,MAAM,iBAAiB,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,UASvD,CAAA;AAED,eAAO,MAAM,WAAW,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,gBACH,CAAA;AAE/C;;GAEG;AACH,eAAO,MAAM,oBAAoB,QAAO,YAGvC,CAAA;AAED,eAAO,MAAM,kBAAkB,GAAI,OAAO,UAAU,KACjB,gBAAgB,GAAG,SAAS,CAAA;AAE/D,eAAO,MAAM,kBAAkB,GAAI,OAAO,gBAAgB,KAC7B,UAAU,CAAA;AAEvC,eAAO,MAAM,WAAW,GAAI,OAAO,cAAc,KAAG,QACsB,CAAA;AAE1E,eAAO,MAAM,WAAW,GAAI,OAAO,QAAQ,KAAG,cACgC,CAAA;AAE9E,eAAO,MAAM,eAAe,GAAI,KAAK,MAAM,6BAI1C,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,GAAI,IAAI,aAAa,eAqBtD,CAAA;AAID,KAAK,UAAU,GAAG;IAChB,UAAU,EAAE,UAAU,GAAG,gBAAgB,CAAA;IACzC,KAAK,CAAC,EAAE,QAAQ,CAAA;CACjB,CAAA"}
+{"version":3,"file":"AutomergeUrl.d.ts","sourceRoot":"","sources":["../src/AutomergeUrl.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,EAChB,UAAU,EACV,aAAa,EACb,QAAQ,EACT,MAAM,YAAY,CAAA;AASnB,OAAO,KAAK,EAAE,KAAK,IAAI,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAExE,eAAO,MAAM,SAAS,eAAe,CAAA;AAErC,UAAU,kBAAkB;IAC1B,2BAA2B;IAC3B,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,8BAA8B;IAC9B,UAAU,EAAE,UAAU,CAAA;IACtB,mDAAmD;IACnD,KAAK,CAAC,EAAE,QAAQ,CAAA;IAChB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB;AAED,sGAAsG;AACtG,eAAO,MAAM,iBAAiB,GAAI,KAAK,YAAY,KAAG,kBAsBrD,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,GAChC,KAAK,UAAU,GAAG,UAAU,GAAG,gBAAgB,KAC9C,YAgCF,CAAA;AAED,gEAAgE;AAChE,eAAO,MAAM,eAAe,GAAI,KAAK,YAAY,KAAG,MAAM,EAAE,GAAG,SAG9D,CAAA;AAED,eAAO,MAAM,2BAA2B,GAAI,IAAI,aAAa,6BAO9C,CAAA;AAEf;;;GAGG;AACH,eAAO,MAAM,mBAAmB,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,YAsBzD,CAAA;AAED,eAAO,MAAM,iBAAiB,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,UAKvD,CAAA;AAED,eAAO,MAAM,WAAW,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,gBACH,CAAA;AAE/C;;GAEG;AACH,eAAO,MAAM,oBAAoB,QAAO,YAGvC,CAAA;AAED,eAAO,MAAM,kBAAkB,GAAI,OAAO,UAAU,KACjB,gBAAgB,GAAG,SAAS,CAAA;AAE/D,eAAO,MAAM,kBAAkB,GAAI,OAAO,gBAAgB,KAC7B,UAAU,CAAA;AAEvC,eAAO,MAAM,WAAW,GAAI,OAAO,cAAc,KAAG,QACsB,CAAA;AAE1E,eAAO,MAAM,WAAW,GAAI,OAAO,QAAQ,KAAG,cACgC,CAAA;AAE9E,eAAO,MAAM,eAAe,GAAI,KAAK,MAAM,6BAI1C,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,GAAI,IAAI,aAAa,eAqBtD,CAAA;AAID,KAAK,UAAU,GAAG;IAChB,UAAU,EAAE,UAAU,GAAG,gBAAgB,CAAA;IACzC,KAAK,CAAC,EAAE,QAAQ,CAAA;CACjB,CAAA"}

package/dist/AutomergeUrl.js

@@ -103,11 +103,7 @@ export const isValidDocumentId = (str) => {
         return false;
     // try to decode from base58
     const binaryDocumentID = documentIdToBinary(str);
-    if (binaryDocumentID === undefined)
-        return false; // invalid base58check encoding
-    // confirm that the document ID is a valid UUID
-    const documentId = Uuid.stringify(binaryDocumentID);
-    return Uuid.validate(documentId);
+    return binaryDocumentID !== undefined;
 };
 export const isValidUuid = (str) => typeof str === "string" && Uuid.validate(str);
 /**

package/dist/Repo.d.ts

@@ -1,3 +1,4 @@
+import { Heads } from "@automerge/automerge/slim";
 import { EventEmitter } from "eventemitter3";
 import { DocHandle } from "./DocHandle.js";
 import { NetworkAdapterInterface, type PeerMetadata } from "./network/NetworkAdapterInterface.js";
@@ -39,7 +40,7 @@ export declare class Repo extends EventEmitter<RepoEvents> {
     /** maps peer id to to persistence information (storageId, isEphemeral), access by collection synchronizer  */
     /** @hidden */
     peerMetadataByPeerId: Record<PeerId, PeerMetadata>;
-    constructor({ storage, network, peerId, sharePolicy, shareConfig, isEphemeral, enableRemoteHeadsGossiping, denylist, saveDebounceRate, }?: RepoConfig);
+    constructor({ storage, network, peerId, sharePolicy, shareConfig, isEphemeral, enableRemoteHeadsGossiping, denylist, saveDebounceRate, idFactory, }?: RepoConfig);
     /** Returns all the handles we have cached. */
     get handles(): Record<DocumentId, DocHandle<any>>;
     /** Returns a list of all connected peer ids */
@@ -60,6 +61,18 @@ export declare class Repo extends EventEmitter<RepoEvents> {
      * system. we emit a `document` event to advertise interest in the document.
      */
     create<T>(initialValue?: T): DocHandle<T>;
+    /**
+     * Creates a new document and returns a handle to it. The initial value of the
+     * document is an empty object `{}` unless an initial value is provided. The
+     * main difference between this and Repo.create is that if an `idGenerator`
+     * was provided at repo construction, that idGenerator will be used to
+     * generate the document ID of the document returned by this method.
+     *
+     * This is a hidden, experimental API which is subject to change or removal without notice.
+     * @hidden
+     * @experimental
+     */
+    create2<T>(initialValue?: T): Promise<DocHandle<T>>;
     /** Create a new DocHandle by cloning the history of an existing DocHandle.
      *
      * @param clonedHandle - The handle to clone
@@ -149,13 +162,16 @@ export interface RepoConfig {
     /**
      * 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.
-     * @deprecated Use `shareConfig` instead
      */
     sharePolicy?: SharePolicy;
     /**
      * Whether to share documents with other peers. By default we announce new
      * documents to everyone and allow everyone access to documents, see the
      * documentation for {@link ShareConfig} to override this
+     *
+     * Note that this is currently an experimental API and will very likely change
+     * without a major release.
+     * @experimental
      */
     shareConfig?: ShareConfig;
     /**
@@ -172,6 +188,10 @@ export interface RepoConfig {
      * The debounce rate in milliseconds for saving documents. Defaults to 100ms.
      */
     saveDebounceRate?: number;
+    /**
+     * @hidden
+     */
+    idFactory?: (initialHeads: Heads) => Promise<Uint8Array>;
 }
 /** A function that determines whether we should share a document with a peer
  *

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;AAQ5C,OAAO,EAEL,SAAS,EAKV,MAAM,gBAAgB,CAAA;AAIvB,OAAO,EACL,uBAAuB,EACvB,KAAK,YAAY,EAClB,MAAM,sCAAsC,CAAA;AAC7C,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;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAA;AACjF,OAAO,EACL,cAAc,EAEf,MAAM,gCAAgC,CAAA;AACvC,OAAO,KAAK,EACV,aAAa,EACb,YAAY,EACZ,UAAU,EACV,MAAM,EACP,MAAM,YAAY,CAAA;AACnB,OAAO,EAAa,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEhD,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,GAAG;IACzD,UAAU,EAAE,CAAC,eAAe,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;IAChE,IAAI,EAAE,MAAM,YAAY,CAAC,CAAC,CAAC,CAAA;IAC3B,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,MAAM,IAAI,CAAA;CACzE,CAAA;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;IAC9B,IAAI,EAAE,MAAM,YAAY,CAAC,CAAC,CAAC,CAAA;IAC3B,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,MAAM,IAAI,CAAA;IACxE,UAAU,EAAE,CAAC,eAAe,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;CACjE,CAAA;AAMD,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;IAUnC,cAAc;IACd,YAAY,EAAE,sBAAsB,CAAA;IAOpC,8GAA8G;IAC9G,cAAc;IACd,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAK;gBAU3C,EACV,OAAO,EACP,OAAY,EACZ,MAAuB,EACvB,WAAW,EACX,WAAW,EACX,WAAmC,EACnC,0BAAkC,EAClC,QAAa,EACb,gBAAsB,GACvB,GAAE,UAAe;IAkSlB,8CAA8C;IAC9C,IAAI,OAAO,uCAEV;IAED,+CAA+C;IAC/C,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,cAAc;IACd,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,cAAc;IACd,IAAI,WAAW,CAAC,MAAM,EAAE,WAAW,EAElC;IAED,cAAc;IACd,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,cAAc;IACd,IAAI,WAAW,CAAC,MAAM,EAAE,WAAW,EAElC;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;IAuBzC;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAmBnC,gBAAgB,CAAC,CAAC,EAChB,EAAE,EAAE,aAAa,EACjB,OAAO,GAAE,YAAiB,GACzB,uBAAuB,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;IAgKzC,IAAI,CAAC,CAAC,EACV,EAAE,EAAE,aAAa,EACjB,OAAO,GAAE,eAAe,GAAG,YAAiB,GAC3C,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IA0ExB;;;OAGG;IACG,WAAW,CAAC,CAAC;IACjB,sDAAsD;IACtD,EAAE,EAAE,aAAa,EACjB,OAAO,GAAE,eAAe,GAAG,YAAiB,GAC3C,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAmBxB,MAAM;IACJ,oDAAoD;IACpD,EAAE,EAAE,aAAa;IAanB;;;;;;OAMG;IACG,MAAM,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAQhE;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,UAAU,CAAA;KAAE,GAAG,SAAS,CAAC,CAAC,CAAC;IAoB1E,kBAAkB,GAAI,SAAS,SAAS,EAAE,UASzC;IAED,SAAS,QAAa,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAMnD;IAED;;;;;OAKG;IACG,KAAK,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAcpD;;;;;OAKG;IACG,eAAe,CAAC,UAAU,EAAE,UAAU;IA8B5C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAOzB,OAAO,IAAI;QAAE,SAAS,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE,CAAA;KAAE;CAGjD;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,iEAAiE;IACjE,OAAO,CAAC,EAAE,uBAAuB,EAAE,CAAA;IAEnC;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IAEzB;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IAEzB;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAA;IAEpC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,KACpB,OAAO,CAAC,OAAO,CAAC,CAAA;AAErB;;KAEK;AACL,MAAM,MAAM,WAAW,GAAG;IACxB;;;;;;;;;OASG;IACH,QAAQ,EAAE,WAAW,CAAA;IACrB;;OAEG;IACH,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;CAC5D,CAAA;AAGD,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;IAC5D,aAAa,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,IAAI,CAAA;CACzC;AAED,MAAM,WAAW,eAAe;IAC9B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;CAC3B;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,MAAM,MAAM,UAAU,GAClB,cAAc,GACd;IACE,IAAI,EAAE,YAAY,CAAA;IAClB,UAAU,EAAE,UAAU,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;CACnB,GACD;IACE,IAAI,EAAE,YAAY,CAAA;IAClB,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA"}
+{"version":3,"file":"Repo.d.ts","sourceRoot":"","sources":["../src/Repo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,EAAE,MAAM,2BAA2B,CAAA;AAEpE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAS5C,OAAO,EAEL,SAAS,EAKV,MAAM,gBAAgB,CAAA;AAIvB,OAAO,EACL,uBAAuB,EACvB,KAAK,YAAY,EAClB,MAAM,sCAAsC,CAAA;AAC7C,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;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAA;AACjF,OAAO,EACL,cAAc,EAEf,MAAM,gCAAgC,CAAA;AACvC,OAAO,KAAK,EACV,aAAa,EACb,YAAY,EAEZ,UAAU,EACV,MAAM,EACP,MAAM,YAAY,CAAA;AACnB,OAAO,EAAa,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEhD,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,GAAG;IACzD,UAAU,EAAE,CAAC,eAAe,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;IAChE,IAAI,EAAE,MAAM,YAAY,CAAC,CAAC,CAAC,CAAA;IAC3B,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,MAAM,IAAI,CAAA;CACzE,CAAA;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;IAC9B,IAAI,EAAE,MAAM,YAAY,CAAC,CAAC,CAAC,CAAA;IAC3B,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,MAAM,IAAI,CAAA;IACxE,UAAU,EAAE,CAAC,eAAe,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;CACjE,CAAA;AAMD,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;IAUnC,cAAc;IACd,YAAY,EAAE,sBAAsB,CAAA;IAOpC,8GAA8G;IAC9G,cAAc;IACd,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAK;gBAW3C,EACV,OAAO,EACP,OAAY,EACZ,MAAuB,EACvB,WAAW,EACX,WAAW,EACX,WAAmC,EACnC,0BAAkC,EAClC,QAAa,EACb,gBAAsB,EACtB,SAAS,GACV,GAAE,UAAe;IAmSlB,8CAA8C;IAC9C,IAAI,OAAO,uCAEV;IAED,+CAA+C;IAC/C,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,cAAc;IACd,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,cAAc;IACd,IAAI,WAAW,CAAC,MAAM,EAAE,WAAW,EAElC;IAED,cAAc;IACd,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,cAAc;IACd,IAAI,WAAW,CAAC,MAAM,EAAE,WAAW,EAElC;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;IAwBzC;;;;;;;;;;OAUG;IACG,OAAO,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IA8BzD;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAmBnC,gBAAgB,CAAC,CAAC,EAChB,EAAE,EAAE,aAAa,EACjB,OAAO,GAAE,YAAiB,GACzB,uBAAuB,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;IAgKzC,IAAI,CAAC,CAAC,EACV,EAAE,EAAE,aAAa,EACjB,OAAO,GAAE,eAAe,GAAG,YAAiB,GAC3C,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IA0ExB;;;OAGG;IACG,WAAW,CAAC,CAAC;IACjB,sDAAsD;IACtD,EAAE,EAAE,aAAa,EACjB,OAAO,GAAE,eAAe,GAAG,YAAiB,GAC3C,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAmBxB,MAAM;IACJ,oDAAoD;IACpD,EAAE,EAAE,aAAa;IAanB;;;;;;OAMG;IACG,MAAM,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAQhE;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,UAAU,CAAA;KAAE,GAAG,SAAS,CAAC,CAAC,CAAC;IAoB1E,kBAAkB,GAAI,SAAS,SAAS,EAAE,UASzC;IAED,SAAS,QAAa,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAMnD;IAED;;;;;OAKG;IACG,KAAK,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAcpD;;;;;OAKG;IACG,eAAe,CAAC,UAAU,EAAE,UAAU;IA8B5C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAOzB,OAAO,IAAI;QAAE,SAAS,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE,CAAA;KAAE;CAGjD;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,iEAAiE;IACjE,OAAO,CAAC,EAAE,uBAAuB,EAAE,CAAA;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IAEzB;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IAEzB;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAA;IAEpC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAIzB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,YAAY,EAAE,KAAK,KAAK,OAAO,CAAC,UAAU,CAAC,CAAA;CACzD;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,KACpB,OAAO,CAAC,OAAO,CAAC,CAAA;AAErB;;KAEK;AACL,MAAM,MAAM,WAAW,GAAG;IACxB;;;;;;;;;OASG;IACH,QAAQ,EAAE,WAAW,CAAA;IACrB;;OAEG;IACH,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;CAC5D,CAAA;AAGD,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;IAC5D,aAAa,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,IAAI,CAAA;CACzC;AAED,MAAM,WAAW,eAAe;IAC9B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;CAC3B;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,MAAM,MAAM,UAAU,GAClB,cAAc,GACd;IACE,IAAI,EAAE,YAAY,CAAA;IAClB,UAAU,EAAE,UAAU,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;CACnB,GACD;IACE,IAAI,EAAE,YAAY,CAAA;IAClB,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA"}

package/dist/Repo.js

@@ -1,7 +1,7 @@
 import { next as Automerge } from "@automerge/automerge/slim";
 import debug from "debug";
 import { EventEmitter } from "eventemitter3";
-import { encodeHeads, generateAutomergeUrl, interpretAsDocumentId, isValidAutomergeUrl, parseAutomergeUrl, } from "./AutomergeUrl.js";
+import { binaryToDocumentId, encodeHeads, generateAutomergeUrl, interpretAsDocumentId, isValidAutomergeUrl, parseAutomergeUrl, } from "./AutomergeUrl.js";
 import { DELETED, DocHandle, READY, UNAVAILABLE, UNLOADED, } from "./DocHandle.js";
 import { RemoteHeadsSubscriptions } from "./RemoteHeadsSubscriptions.js";
 import { headsAreSame } from "./helpers/headsAreSame.js";
@@ -45,10 +45,12 @@ export class Repo extends EventEmitter {
     #remoteHeadsGossipingEnabled = false;
     #progressCache = {};
     #saveFns = {};
-    constructor({ storage, network = [], peerId = randomPeerId(), sharePolicy, shareConfig, isEphemeral = storage === undefined, enableRemoteHeadsGossiping = false, denylist = [], saveDebounceRate = 100, } = {}) {
+    #idFactory;
+    constructor({ storage, network = [], peerId = randomPeerId(), sharePolicy, shareConfig, isEphemeral = storage === undefined, enableRemoteHeadsGossiping = false, denylist = [], saveDebounceRate = 100, idFactory, } = {}) {
         super();
         this.#remoteHeadsGossipingEnabled = enableRemoteHeadsGossiping;
         this.#log = debug(`automerge-repo:repo`);
+        this.#idFactory = idFactory || null;
         // Handle legacy sharePolicy
         if (sharePolicy != null && shareConfig != null) {
             throw new Error("cannot provide both sharePolicy and shareConfig at once");
@@ -300,6 +302,13 @@ export class Repo extends EventEmitter {
      * system. we emit a `document` event to advertise interest in the document.
      */
     create(initialValue) {
+        let initialDoc;
+        if (initialValue) {
+            initialDoc = Automerge.from(initialValue);
+        }
+        else {
+            initialDoc = Automerge.emptyChange(Automerge.init());
+        }
         // Generate a new UUID and store it in the buffer
         const { documentId } = parseAutomergeUrl(generateAutomergeUrl());
         const handle = this.#getHandle({
@@ -307,14 +316,45 @@ export class Repo extends EventEmitter {
         });
         this.#registerHandleWithSubsystems(handle);
         handle.update(() => {
-            let nextDoc;
-            if (initialValue) {
-                nextDoc = Automerge.from(initialValue);
-            }
-            else {
-                nextDoc = Automerge.emptyChange(Automerge.init());
-            }
-            return nextDoc;
+            return initialDoc;
+        });
+        handle.doneLoading();
+        return handle;
+    }
+    /**
+     * Creates a new document and returns a handle to it. The initial value of the
+     * document is an empty object `{}` unless an initial value is provided. The
+     * main difference between this and Repo.create is that if an `idGenerator`
+     * was provided at repo construction, that idGenerator will be used to
+     * generate the document ID of the document returned by this method.
+     *
+     * This is a hidden, experimental API which is subject to change or removal without notice.
+     * @hidden
+     * @experimental
+     */
+    async create2(initialValue) {
+        // Note that the reason this method is hidden and experimental is because it is async,
+        // and it is async because we want to be able to call the #idGenerator, which is async.
+        // This is all really in service of wiring up keyhive and we probably need to find a
+        // nicer way to achieve this.
+        let initialDoc;
+        if (initialValue) {
+            initialDoc = Automerge.from(initialValue);
+        }
+        else {
+            initialDoc = Automerge.emptyChange(Automerge.init());
+        }
+        let { documentId } = parseAutomergeUrl(generateAutomergeUrl());
+        if (this.#idFactory) {
+            const rawDocId = await this.#idFactory(Automerge.getHeads(initialDoc));
+            documentId = binaryToDocumentId(rawDocId);
+        }
+        const handle = this.#getHandle({
+            documentId,
+        });
+        this.#registerHandleWithSubsystems(handle);
+        handle.update(() => {
+            return initialDoc;
         });
         handle.doneLoading();
         return handle;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo",
-  "version": "2.4.0-alpha.0",
+  "version": "2.4.0-alpha.2",
   "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>",
@@ -59,5 +59,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d6d7dfd5c4af335ff3db876db053733efada83df"
+  "gitHead": "f963f3a1a36292ac0ea417c1c17d180fd8e78ac5"
 }

package/src/AutomergeUrl.ts

@@ -141,11 +141,7 @@ export const isValidDocumentId = (str: unknown): str is DocumentId => {
   if (typeof str !== "string") return false
   // try to decode from base58
   const binaryDocumentID = documentIdToBinary(str as DocumentId)
-  if (binaryDocumentID === undefined) return false // invalid base58check encoding
-
-  // confirm that the document ID is a valid UUID
-  const documentId = Uuid.stringify(binaryDocumentID)
-  return Uuid.validate(documentId)
+  return binaryDocumentID !== undefined
 }
 
 export const isValidUuid = (str: unknown): str is LegacyDocumentId =>

package/src/Repo.ts

@@ -1,7 +1,8 @@
-import { next as Automerge } from "@automerge/automerge/slim"
+import { next as Automerge, Heads } from "@automerge/automerge/slim"
 import debug from "debug"
 import { EventEmitter } from "eventemitter3"
 import {
+  binaryToDocumentId,
   encodeHeads,
   generateAutomergeUrl,
   interpretAsDocumentId,
@@ -36,6 +37,7 @@ import {
 import type {
   AnyDocumentId,
   AutomergeUrl,
+  BinaryDocumentId,
   DocumentId,
   PeerId,
 } from "./types.js"
@@ -101,6 +103,7 @@ export class Repo extends EventEmitter<RepoEvents> {
     DocumentId,
     (payload: DocHandleEncodedChangePayload<any>) => void
   > = {}
+  #idFactory: ((initialHeads: Heads) => Promise<Uint8Array>) | null
 
   constructor({
     storage,
@@ -112,11 +115,13 @@ export class Repo extends EventEmitter<RepoEvents> {
     enableRemoteHeadsGossiping = false,
     denylist = [],
     saveDebounceRate = 100,
+    idFactory,
   }: RepoConfig = {}) {
     super()
     this.#remoteHeadsGossipingEnabled = enableRemoteHeadsGossiping
     this.#log = debug(`automerge-repo:repo`)
 
+    this.#idFactory = idFactory || null
     // Handle legacy sharePolicy
     if (sharePolicy != null && shareConfig != null) {
       throw new Error("cannot provide both sharePolicy and shareConfig at once")
@@ -446,6 +451,13 @@ export class Repo extends EventEmitter<RepoEvents> {
    * system. we emit a `document` event to advertise interest in the document.
    */
   create<T>(initialValue?: T): DocHandle<T> {
+    let initialDoc: Automerge.Doc<T>
+    if (initialValue) {
+      initialDoc = Automerge.from(initialValue)
+    } else {
+      initialDoc = Automerge.emptyChange(Automerge.init())
+    }
+
     // Generate a new UUID and store it in the buffer
     const { documentId } = parseAutomergeUrl(generateAutomergeUrl())
     const handle = this.#getHandle<T>({
@@ -455,19 +467,54 @@ export class Repo extends EventEmitter<RepoEvents> {
     this.#registerHandleWithSubsystems(handle)
 
     handle.update(() => {
-      let nextDoc: Automerge.Doc<T>
-      if (initialValue) {
-        nextDoc = Automerge.from(initialValue)
-      } else {
-        nextDoc = Automerge.emptyChange(Automerge.init())
-      }
-      return nextDoc
+      return initialDoc
     })
 
     handle.doneLoading()
     return handle
   }
 
+  /**
+   * Creates a new document and returns a handle to it. The initial value of the
+   * document is an empty object `{}` unless an initial value is provided. The
+   * main difference between this and Repo.create is that if an `idGenerator`
+   * was provided at repo construction, that idGenerator will be used to
+   * generate the document ID of the document returned by this method.
+   *
+   * This is a hidden, experimental API which is subject to change or removal without notice.
+   * @hidden
+   * @experimental
+   */
+  async create2<T>(initialValue?: T): Promise<DocHandle<T>> {
+    // Note that the reason this method is hidden and experimental is because it is async,
+    // and it is async because we want to be able to call the #idGenerator, which is async.
+    // This is all really in service of wiring up keyhive and we probably need to find a
+    // nicer way to achieve this.
+    let initialDoc: Automerge.Doc<T>
+    if (initialValue) {
+      initialDoc = Automerge.from(initialValue)
+    } else {
+      initialDoc = Automerge.emptyChange(Automerge.init())
+    }
+
+    let { documentId } = parseAutomergeUrl(generateAutomergeUrl())
+    if (this.#idFactory) {
+      const rawDocId = await this.#idFactory(Automerge.getHeads(initialDoc))
+      documentId = binaryToDocumentId(rawDocId as BinaryDocumentId)
+    }
+    const handle = this.#getHandle<T>({
+      documentId,
+    }) as DocHandle<T>
+
+    this.#registerHandleWithSubsystems(handle)
+
+    handle.update(() => {
+      return initialDoc
+    })
+
+    handle.doneLoading()
+    return handle
+  }
   /** Create a new DocHandle by cloning the history of an existing DocHandle.
    *
    * @param clonedHandle - The handle to clone
@@ -937,7 +984,6 @@ export interface RepoConfig {
   /**
    * 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.
-   * @deprecated Use `shareConfig` instead
    */
   sharePolicy?: SharePolicy
 
@@ -945,6 +991,10 @@ export interface RepoConfig {
    * Whether to share documents with other peers. By default we announce new
    * documents to everyone and allow everyone access to documents, see the
    * documentation for {@link ShareConfig} to override this
+   *
+   * Note that this is currently an experimental API and will very likely change
+   * without a major release.
+   * @experimental
    */
   shareConfig?: ShareConfig
 
@@ -964,6 +1014,13 @@ export interface RepoConfig {
    * The debounce rate in milliseconds for saving documents. Defaults to 100ms.
    */
   saveDebounceRate?: number
+
+  // This is hidden for now because it's an experimental API, mostly here in order
+  // for keyhive to be able to control the ID generation
+  /**
+   * @hidden
+   */
+  idFactory?: (initialHeads: Heads) => Promise<Uint8Array>
 }
 
 /** A function that determines whether we should share a document with a peer

package/test/AutomergeUrl.test.ts

@@ -2,6 +2,7 @@ import assert from "assert"
 import bs58check from "bs58check"
 import { describe, it } from "vitest"
 import {
+  binaryToDocumentId,
   generateAutomergeUrl,
   getHeadsFromUrl,
   isValidAutomergeUrl,
@@ -14,6 +15,7 @@ import type {
   BinaryDocumentId,
   DocumentId,
 } from "../src/types.js"
+import { interpretAsDocumentId } from "../src/AutomergeUrl.js"
 
 const goodUrl = "automerge:4NMNnkMhL8jXrdJ9jamS58PAVdXu" as AutomergeUrl
 const badChecksumUrl = "automerge:badbadbad" as AutomergeUrl
@@ -94,15 +96,18 @@ describe("AutomergeUrl", () => {
       assert(isValidAutomergeUrl(url) === false)
     })
 
-    it("should return false for a documentId that is not a valid UUID ", () => {
-      const url = stringifyAutomergeUrl({ documentId: badUuidDocumentId })
-      assert(isValidAutomergeUrl(url) === false)
-    })
-
     it("should return false for a documentId that is just some random type", () => {
       assert(isValidAutomergeUrl({ foo: "bar" } as unknown) === false)
     })
   })
+
+  it("should allow arbitrary uint8array ids", () => {
+    const raw = new Uint8Array("custom-id".split("").map(c => c.charCodeAt(0)))
+    const documentId = binaryToDocumentId(raw as BinaryDocumentId)
+    const url = stringifyAutomergeUrl({ documentId })
+    const interpreted = interpretAsDocumentId(url)
+    assert.deepStrictEqual(interpreted, documentId)
+  })
 })
 
 describe("AutomergeUrl with heads", () => {

package/test/Repo.test.ts

@@ -1,4 +1,4 @@
-import { next as A } from "@automerge/automerge"
+import { next as A, Heads } from "@automerge/automerge"
 import { MessageChannelNetworkAdapter } from "../../automerge-repo-network-messagechannel/src/index.js"
 import assert from "assert"
 import * as Uuid from "uuid"
@@ -2027,6 +2027,50 @@ describe("Repo.find() abort behavior", () => {
     controller.abort()
     expect(handle.url).toBe(url)
   })
+
+  describe("creating a document with a custom ID factory", () => {
+    it("creates a document with the custom ID", async () => {
+      const id = new Uint8Array("custom-id".split("").map(c => c.charCodeAt(0)))
+      const repo = new Repo({
+        idFactory: () => id,
+      })
+      const handle = await repo.create2()
+      expect(handle.documentId).toBe("9HUp4wuzRMx9MRvN4x")
+    })
+
+    it("passes the heads of the document to the callback", async () => {
+      const id = new Uint8Array("custom-id".split("").map(c => c.charCodeAt(0)))
+      let calledHeads: Heads | null = null
+      const repo = new Repo({
+        idFactory: (heads: Heads) => {
+          calledHeads = heads
+          return id
+        },
+      })
+      const handle = await repo.create2()
+      const actualHeads = A.getHeads(handle.doc())
+      assert.deepStrictEqual(actualHeads, calledHeads)
+    })
+
+    it("allows syncing documents with a custom ID", async () => {
+      const [aliceToBob, bobToAlice] = DummyNetworkAdapter.createConnectedPair()
+      const alice = new Repo({
+        peerId: "alice" as PeerId,
+        idFactory: () =>
+          new Uint8Array("custom-id".split("").map(c => c.charCodeAt(0))),
+        network: [aliceToBob],
+      })
+      const bob = new Repo({ peerId: "bob" as PeerId, network: [bobToAlice] })
+      aliceToBob.peerCandidate("bob" as PeerId)
+      bobToAlice.peerCandidate("alice" as PeerId)
+
+      await pause(50)
+
+      const handle = await alice.create2({ foo: "bar" })
+      const bobHandle = await bob.find(handle.url)
+      assert.deepStrictEqual(bobHandle.doc(), { foo: "bar" })
+    })
+  })
 })
 
 const warn = console.warn