@automerge/automerge-repo 2.0.0-alpha.14 → 2.0.0-alpha.16

package/dist/AutomergeUrl.d.ts

@@ -1,17 +1,29 @@
 import type { LegacyDocumentId, AutomergeUrl, BinaryDocumentId, DocumentId, AnyDocumentId } from "./types.js";
+import type { Heads as AutomergeHeads } from "@automerge/automerge/slim";
 export declare const urlPrefix = "automerge:";
-/** Given an Automerge URL, returns the DocumentId in both base58check-encoded form and binary form */
-export declare const parseAutomergeUrl: (url: AutomergeUrl) => {
+export type UrlHeads = string[] & {
+    __automergeUrlHeadsBrand: unknown;
+};
+interface ParsedAutomergeUrl {
     /** unencoded DocumentId */
     binaryDocumentId: BinaryDocumentId;
-    /** encoded DocumentId */
+    /** bs58 encoded DocumentId */
     documentId: DocumentId;
-};
+    /** Optional array of heads, if specified in URL */
+    heads?: UrlHeads;
+    /** Optional hex array of heads, in Automerge core format */
+    hexHeads?: string[];
+}
+/** Given an Automerge URL, returns the DocumentId in both base58check-encoded form and binary form */
+export declare const parseAutomergeUrl: (url: AutomergeUrl) => ParsedAutomergeUrl;
 /**
  * Given a documentId in either binary or base58check-encoded form, returns an Automerge URL.
  * Throws on invalid input.
  */
 export declare const stringifyAutomergeUrl: (arg: UrlOptions | DocumentId | BinaryDocumentId) => AutomergeUrl;
+/** Helper to extract just the heads from a URL if they exist */
+export declare const getHeadsFromUrl: (url: AutomergeUrl) => string[] | undefined;
+export declare const anyDocumentIdToAutomergeUrl: (id: AnyDocumentId) => AutomergeUrl | undefined;
 /**
  * Given a string, returns true if it is a valid Automerge URL. This function also acts as a type
  * discriminator in Typescript.
@@ -25,6 +37,8 @@ export declare const isValidUuid: (str: unknown) => str is LegacyDocumentId;
 export declare const generateAutomergeUrl: () => AutomergeUrl;
 export declare const documentIdToBinary: (docId: DocumentId) => BinaryDocumentId | undefined;
 export declare const binaryToDocumentId: (docId: BinaryDocumentId) => DocumentId;
+export declare const encodeHeads: (heads: AutomergeHeads) => UrlHeads;
+export declare const decodeHeads: (heads: UrlHeads) => AutomergeHeads;
 export declare const parseLegacyUUID: (str: string) => AutomergeUrl | undefined;
 /**
  * Given any valid expression of a document ID, returns a DocumentId in base58check-encoded form.
@@ -40,6 +54,7 @@ export declare const parseLegacyUUID: (str: string) => AutomergeUrl | undefined;
 export declare const interpretAsDocumentId: (id: AnyDocumentId) => DocumentId;
 type UrlOptions = {
     documentId: DocumentId | BinaryDocumentId;
+    heads?: UrlHeads;
 };
 export {};
 //# sourceMappingURL=AutomergeUrl.d.ts.map

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,EACd,MAAM,YAAY,CAAA;AAInB,eAAO,MAAM,SAAS,eAAe,CAAA;AAErC,sGAAsG;AACtG,eAAO,MAAM,iBAAiB,QAAS,YAAY;IAQ/C,2BAA2B;;IAE3B,yBAAyB;;CAG5B,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,QAC3B,UAAU,GAAG,UAAU,GAAG,gBAAgB,KAmBL,YAC3C,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,QAAS,OAAO,KAAG,GAAG,IAAI,YAUzD,CAAA;AAED,eAAO,MAAM,iBAAiB,QAAS,OAAO,KAAG,GAAG,IAAI,UASvD,CAAA;AAED,eAAO,MAAM,WAAW,QAAS,OAAO,KAAG,GAAG,IAAI,gBACH,CAAA;AAE/C;;GAEG;AACH,eAAO,MAAM,oBAAoB,QAAO,YAGvC,CAAA;AAED,eAAO,MAAM,kBAAkB,UAAW,UAAU,KACjB,gBAAgB,GAAG,SAAS,CAAA;AAE/D,eAAO,MAAM,kBAAkB,UAAW,gBAAgB,KAC7B,UAAU,CAAA;AAEvC,eAAO,MAAM,eAAe,QAAS,MAAM,6BAI1C,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,OAAQ,aAAa,eAqBtD,CAAA;AAID,KAAK,UAAU,GAAG;IAChB,UAAU,EAAE,UAAU,GAAG,gBAAgB,CAAA;CAC1C,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,EACd,MAAM,YAAY,CAAA;AASnB,OAAO,KAAK,EAAE,KAAK,IAAI,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAExE,eAAO,MAAM,SAAS,eAAe,CAAA;AAGrC,MAAM,MAAM,QAAQ,GAAG,MAAM,EAAE,GAAG;IAAE,wBAAwB,EAAE,OAAO,CAAA;CAAE,CAAA;AAEvE,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,QAAS,YAAY,KAAG,kBAsBrD,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,QAC3B,UAAU,GAAG,UAAU,GAAG,gBAAgB,KAC9C,YAgCF,CAAA;AAED,gEAAgE;AAChE,eAAO,MAAM,eAAe,QAAS,YAAY,KAAG,MAAM,EAAE,GAAG,SAG9D,CAAA;AAED,eAAO,MAAM,2BAA2B,OAAQ,aAAa,6BAO9C,CAAA;AAEf;;;GAGG;AACH,eAAO,MAAM,mBAAmB,QAAS,OAAO,KAAG,GAAG,IAAI,YAsBzD,CAAA;AAED,eAAO,MAAM,iBAAiB,QAAS,OAAO,KAAG,GAAG,IAAI,UASvD,CAAA;AAED,eAAO,MAAM,WAAW,QAAS,OAAO,KAAG,GAAG,IAAI,gBACH,CAAA;AAE/C;;GAEG;AACH,eAAO,MAAM,oBAAoB,QAAO,YAGvC,CAAA;AAED,eAAO,MAAM,kBAAkB,UAAW,UAAU,KACjB,gBAAgB,GAAG,SAAS,CAAA;AAE/D,eAAO,MAAM,kBAAkB,UAAW,gBAAgB,KAC7B,UAAU,CAAA;AAEvC,eAAO,MAAM,WAAW,UAAW,cAAc,KAAG,QACsB,CAAA;AAE1E,eAAO,MAAM,WAAW,UAAW,QAAQ,KAAG,cACgC,CAAA;AAE9E,eAAO,MAAM,eAAe,QAAS,MAAM,6BAI1C,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,OAAQ,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

@@ -1,53 +1,98 @@
 import * as Uuid from "uuid";
 import bs58check from "bs58check";
+import { uint8ArrayFromHexString, uint8ArrayToHexString, } from "./helpers/bufferFromHex.js";
 export const urlPrefix = "automerge:";
 /** Given an Automerge URL, returns the DocumentId in both base58check-encoded form and binary form */
 export const parseAutomergeUrl = (url) => {
+    const [baseUrl, headsSection, ...rest] = url.split("#");
+    if (rest.length > 0) {
+        throw new Error("Invalid URL: contains multiple heads sections");
+    }
     const regex = new RegExp(`^${urlPrefix}(\\w+)$`);
-    const [, docMatch] = url.match(regex) || [];
+    const [, docMatch] = baseUrl.match(regex) || [];
     const documentId = docMatch;
     const binaryDocumentId = documentIdToBinary(documentId);
     if (!binaryDocumentId)
         throw new Error("Invalid document URL: " + url);
-    return {
-        /** unencoded DocumentId */
-        binaryDocumentId,
-        /** encoded DocumentId */
-        documentId,
-    };
+    if (headsSection === undefined)
+        return { binaryDocumentId, documentId };
+    const heads = (headsSection === "" ? [] : headsSection.split("|"));
+    const hexHeads = heads.map(head => {
+        try {
+            return uint8ArrayToHexString(bs58check.decode(head));
+        }
+        catch (e) {
+            throw new Error(`Invalid head in URL: ${head}`);
+        }
+    });
+    return { binaryDocumentId, hexHeads, documentId, heads };
 };
 /**
  * Given a documentId in either binary or base58check-encoded form, returns an Automerge URL.
  * Throws on invalid input.
  */
 export const stringifyAutomergeUrl = (arg) => {
-    const documentId = arg instanceof Uint8Array || typeof arg === "string"
-        ? arg
-        : "documentId" in arg
-            ? arg.documentId
-            : undefined;
+    if (arg instanceof Uint8Array || typeof arg === "string") {
+        return (urlPrefix +
+            (arg instanceof Uint8Array
+                ? binaryToDocumentId(arg)
+                : arg));
+    }
+    const { documentId, heads = undefined } = arg;
+    if (documentId === undefined)
+        throw new Error("Invalid documentId: " + documentId);
     const encodedDocumentId = documentId instanceof Uint8Array
         ? binaryToDocumentId(documentId)
-        : typeof documentId === "string"
-            ? documentId
-            : undefined;
-    if (encodedDocumentId === undefined)
-        throw new Error("Invalid documentId: " + documentId);
-    return (urlPrefix + encodedDocumentId);
+        : documentId;
+    let url = `${urlPrefix}${encodedDocumentId}`;
+    if (heads !== undefined) {
+        heads.forEach(head => {
+            try {
+                bs58check.decode(head);
+            }
+            catch (e) {
+                throw new Error(`Invalid head: ${head}`);
+            }
+        });
+        url += "#" + heads.join("|");
+    }
+    return url;
+};
+/** Helper to extract just the heads from a URL if they exist */
+export const getHeadsFromUrl = (url) => {
+    const { heads } = parseAutomergeUrl(url);
+    return heads;
 };
+export const anyDocumentIdToAutomergeUrl = (id) => isValidAutomergeUrl(id)
+    ? id
+    : isValidDocumentId(id)
+        ? stringifyAutomergeUrl({ documentId: id })
+        : isValidUuid(id)
+            ? parseLegacyUUID(id)
+            : undefined;
 /**
  * Given a string, returns true if it is a valid Automerge URL. This function also acts as a type
  * discriminator in Typescript.
  */
 export const isValidAutomergeUrl = (str) => {
-    if (typeof str !== "string")
-        return false;
-    if (!str || !str.startsWith(urlPrefix))
+    if (typeof str !== "string" || !str || !str.startsWith(urlPrefix))
         return false;
-    const automergeUrl = str;
     try {
-        const { documentId } = parseAutomergeUrl(automergeUrl);
-        return isValidDocumentId(documentId);
+        const { documentId, heads } = parseAutomergeUrl(str);
+        if (!isValidDocumentId(documentId))
+            return false;
+        if (heads &&
+            !heads.every(head => {
+                try {
+                    bs58check.decode(head);
+                    return true;
+                }
+                catch {
+                    return false;
+                }
+            }))
+            return false;
+        return true;
     }
     catch {
         return false;
@@ -74,6 +119,8 @@ export const generateAutomergeUrl = () => {
 };
 export const documentIdToBinary = (docId) => bs58check.decodeUnsafe(docId);
 export const binaryToDocumentId = (docId) => bs58check.encode(docId);
+export const encodeHeads = (heads) => heads.map(h => bs58check.encode(uint8ArrayFromHexString(h)));
+export const decodeHeads = (heads) => heads.map(h => uint8ArrayToHexString(bs58check.decode(h)));
 export const parseLegacyUUID = (str) => {
     if (!Uuid.validate(str))
         return undefined;

package/dist/DocHandle.d.ts

@@ -1,5 +1,6 @@
 import * as A from "@automerge/automerge/slim/next";
 import { EventEmitter } from "eventemitter3";
+import { UrlHeads } from "./AutomergeUrl.js";
 import type { AutomergeUrl, DocumentId, PeerId } from "./types.js";
 import { StorageId } from "./storage/types.js";
 /**
@@ -92,12 +93,10 @@ export declare class DocHandle<T> extends EventEmitter<DocHandleEvents<T>> {
      * This precisely defines the state of a document.
      * @returns the current document's heads, or undefined if the document is not ready
      */
-    heads(): A.Heads | undefined;
+    heads(): UrlHeads | undefined;
     begin(): void;
     /**
-     * Creates a fixed "view" of an automerge document at the given point in time represented
-     * by the `heads` passed in. The return value is the same type as docSync() and will return
-     * undefined if the object hasn't finished loading.
+     * Returns an array of all past "heads" for the document in topological order.
      *
      * @remarks
      * A point-in-time in an automerge document is an *array* of heads since there may be
@@ -106,11 +105,11 @@ export declare class DocHandle<T> extends EventEmitter<DocHandleEvents<T>> {
      * history views would be quite large under concurrency (every thing in each branch against each other).
      * There might be a clever way to think about this, but we haven't found it yet, so for now at least
      * we present a single traversable view which excludes concurrency.
-     * @returns The individual heads for every change in the document.
+     * @returns UrlHeads[] - The individual heads for every change in the document. Each item is a tagged string[1].
      */
-    history(): A.Heads[] | undefined;
+    history(): UrlHeads[] | undefined;
     /**
-     * Creates a fixed "view" of an automerge document at the given point in time represented
+     * Creates a new DocHandle with a fixed "view" at the given point in time represented
      * by the `heads` passed in. The return value is the same type as docSync() and will return
      * undefined if the object hasn't finished loading.
      *
@@ -119,20 +118,24 @@ export declare class DocHandle<T> extends EventEmitter<DocHandleEvents<T>> {
      * of Automerge doesn't check types at runtime, so if you go back to an old set of heads
      * that doesn't match the heads here, Typescript will not save you.
      *
-     * @returns An Automerge.Doc<T> at the point in time.
+     * @argument heads - The heads to view the document at. See history().
+     * @returns DocHandle<T> at the time of `heads`
      */
-    view(heads: A.Heads): A.Doc<T> | undefined;
+    view(heads: UrlHeads): DocHandle<T>;
     /**
      * Returns a set of Patch operations that will move a materialized document from one state to another
      * if applied.
      *
      * @remarks
-     * We allow specifying both a from/to heads or just a single comparison point, in which case
-     * the base will be the current document heads.
+     * We allow specifying either:
+     * - Two sets of heads to compare directly
+     * - A single set of heads to compare against our current heads
+     * - Another DocHandle to compare against (which must share history with this document)
      *
-     * @returns Automerge patches that go from one document state to the other. Use view() to get the full state.
+     * @throws Error if the documents don't share history or if either document is not ready
+     * @returns Automerge patches that go from one document state to the other
      */
-    diff(first: A.Heads, second?: A.Heads): A.Patch[] | undefined;
+    diff(first: UrlHeads | DocHandle<T>, second?: UrlHeads): A.Patch[];
     /**
      * `metadata(head?)` allows you to look at the metadata for a change
      * this can be used to build history graphs to find commit messages and edit times.
@@ -162,9 +165,9 @@ export declare class DocHandle<T> extends EventEmitter<DocHandleEvents<T>> {
      * Called by the repo either when a doc handle changes or we receive new remote heads.
      * @hidden
      */
-    setRemoteHeads(storageId: StorageId, heads: A.Heads): void;
+    setRemoteHeads(storageId: StorageId, heads: UrlHeads): void;
     /** Returns the heads of the storageId. */
-    getRemoteHeads(storageId: StorageId): A.Heads | undefined;
+    getRemoteHeads(storageId: StorageId): UrlHeads | undefined;
     /**
      * All changes to an Automerge document should be made through this method.
      * Inside the callback, the document should be treated as mutable: all edits will be recorded
@@ -186,7 +189,7 @@ export declare class DocHandle<T> extends EventEmitter<DocHandleEvents<T>> {
      *
      * @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;
+    changeAt(heads: UrlHeads, callback: A.ChangeFn<T>, options?: A.ChangeOptions<T>): UrlHeads[] | undefined;
     /**
      * Merges another document into this document. Any peers we are sharing changes with will be
      * notified of the changes resulting from the merge.
@@ -234,6 +237,7 @@ export type DocHandleOptions<T> = {
     initialValue?: T;
 } | {
     isNew?: false;
+    heads?: UrlHeads;
     /** The number of milliseconds before we mark this document as unavailable if we don't have it and nobody shares it with us. */
     timeoutDelay?: number;
 };
@@ -285,7 +289,7 @@ export interface DocHandleOutboundEphemeralMessagePayload<T> {
 /** Emitted when we have new remote heads for this document */
 export interface DocHandleRemoteHeadsPayload {
     storageId: StorageId;
-    heads: A.Heads;
+    heads: UrlHeads;
 }
 /**
  * Possible internal states for a DocHandle

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,gCAAgC,CAAA;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAM5C,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9C;;;;;;;;;;;;GAYG;AACH,qBAAa,SAAS,CAAC,CAAC,CAAE,SAAQ,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;;IAkBvD,UAAU,EAAE,UAAU;IAF/B,cAAc;gBAEL,UAAU,EAAE,UAAU,EAC7B,OAAO,GAAE,gBAAgB,CAAC,CAAC,CAAM;IA8JnC;OACG;IACH,IAAI,GAAG,IAAI,YAAY,CAEtB;IAED;;;;;OAKG;IACH,OAAO,gBAAgC;IAEvC;;;;;OAKG;IACH,UAAU,gBAAmC;IAE7C;;;;;OAKG;IACH,SAAS,gBAAkC;IAE3C;;;;OAIG;IACH,aAAa,gBAAsC;IAEnD;;OAEG;IACH,OAAO,WAAY,WAAW,EAAE,aAC0B;IAE1D,cAAc;IACd,IAAI,KAAK,yFAER;IAED;;;;;;OAMG;IACG,SAAS,CAAC,WAAW,GAAE,WAAW,EAAc;IAItD;;;;;OAKG;IACG,GAAG;IACP,sEAAsE;IACtE,WAAW,GAAE,WAAW,EAA6B;IAavD;;;;;;;;;;;;OAYG;IACH,OAAO;IAKP;;;;OAIG;IACH,KAAK,IAAI,CAAC,CAAC,KAAK,GAAG,SAAS;IAO5B,KAAK;IAIL;;;;;;;;;;;;;OAaG;IACH,OAAO,IAAI,CAAC,CAAC,KAAK,EAAE,GAAG,SAAS;IAShC;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS;IAO1C;;;;;;;;;OASG;IACH,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,EAAE,GAAG,SAAS;IAU7D;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,aAAa,GAAG,SAAS;IAWtD;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAI5C;;;;OAIG;IACH,WAAW;IAIX;;;OAGG;IACH,cAAc,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK;IAKnD,0CAA0C;IAC1C,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,CAAC,CAAC,KAAK,GAAG,SAAS;IAIzD;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,GAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAM;IAWhE;;;;OAIG;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;IAsBvB;;;;;;;OAOG;IACH,KAAK;IACH,wDAAwD;IACxD,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;IAe3B;;;OAGG;IACH,WAAW;IAIX;;SAEK;IACL,OAAO;IAIP,8DAA8D;IAC9D,MAAM;IAIN,sDAAsD;IACtD,MAAM;IAIN,uDAAuD;IACvD,MAAM;IAIN;;;;;;OAMG;IACH,SAAS,CAAC,OAAO,EAAE,OAAO;IAO1B,OAAO,IAAI;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE;CAGlD;AAID,cAAc;AACd,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAE1B;IACE,gGAAgG;IAChG,KAAK,EAAE,IAAI,CAAA;IAEX,yCAAyC;IACzC,YAAY,CAAC,EAAE,CAAC,CAAA;CACjB,GAED;IACE,KAAK,CAAC,EAAE,KAAK,CAAA;IAEb,+HAA+H;IAC/H,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAIL,2EAA2E;AAC3E,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,2BAA2B,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IAC9D,mBAAmB,EAAE,CAAC,OAAO,EAAE,gCAAgC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IAC3E,4BAA4B,EAAE,CAC5B,OAAO,EAAE,wCAAwC,CAAC,CAAC,CAAC,KACjD,IAAI,CAAA;IACT,cAAc,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,IAAI,CAAA;CAC/D;AAED,sDAAsD;AACtD,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,6CAA6C;AAC7C,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,8BAA8B;IAC9B,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACpB,iDAAiD;IACjD,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACb,wDAAwD;IACxD,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,CAAA;IAClB,mCAAmC;IACnC,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;CAC1B;AAED,4CAA4C;AAC5C,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;CACrB;AAED,6DAA6D;AAC7D,MAAM,WAAW,2BAA2B,CAAC,CAAC;IAC5C,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;CACrB;AAED,qEAAqE;AACrE,MAAM,WAAW,gCAAgC,CAAC,CAAC;IACjD,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,kEAAkE;AAClE,MAAM,WAAW,wCAAwC,CAAC,CAAC;IACzD,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACpB,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,8DAA8D;AAC9D,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,SAAS,CAAA;IACpB,KAAK,EAAE,CAAC,CAAC,KAAK,CAAA;CACf;AAMD;;GAEG;AACH,eAAO,MAAM,WAAW;IACtB,kEAAkE;;IAElE,mDAAmD;;IAEnD,6EAA6E;;IAE7E,gCAAgC;;IAEhC,2EAA2E;;IAE3E,kDAAkD;;IAElD,4EAA4E;;CAEpE,CAAA;AACV,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAA;AAExE,eAAO,MACL,IAAI,UACJ,OAAO,aACP,UAAU,gBACV,KAAK,WACL,QAAQ,cACR,OAAO,aACP,WAAW,eACE,CAAA"}
+{"version":3,"file":"DocHandle.d.ts","sourceRoot":"","sources":["../src/DocHandle.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,gCAAgC,CAAA;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE5C,OAAO,EAIL,QAAQ,EACT,MAAM,mBAAmB,CAAA;AAI1B,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9C;;;;;;;;;;;;GAYG;AACH,qBAAa,SAAS,CAAC,CAAC,CAAE,SAAQ,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;;IAqBvD,UAAU,EAAE,UAAU;IAF/B,cAAc;gBAEL,UAAU,EAAE,UAAU,EAC7B,OAAO,GAAE,gBAAgB,CAAC,CAAC,CAAM;IAqKnC;OACG;IACH,IAAI,GAAG,IAAI,YAAY,CAKtB;IAED;;;;;OAKG;IACH,OAAO,gBAAgC;IAEvC;;;;;OAKG;IACH,UAAU,gBAAmC;IAE7C;;;;;OAKG;IACH,SAAS,gBAAkC;IAE3C;;;;OAIG;IACH,aAAa,gBAAsC;IAEnD;;OAEG;IACH,OAAO,WAAY,WAAW,EAAE,aAC0B;IAE1D,cAAc;IACd,IAAI,KAAK,yFAER;IAED;;;;;;OAMG;IACG,SAAS,CAAC,WAAW,GAAE,WAAW,EAAc;IAItD;;;;;OAKG;IACG,GAAG;IACP,sEAAsE;IACtE,WAAW,GAAE,WAAW,EAA6B;IAmBvD;;;;;;;;;;;;OAYG;IACH,OAAO;IASP;;;;OAIG;IACH,KAAK,IAAI,QAAQ,GAAG,SAAS;IAQ7B,KAAK;IAIL;;;;;;;;;;;OAWG;IACH,OAAO,IAAI,QAAQ,EAAE,GAAG,SAAS;IAWjC;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,KAAK,EAAE,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC;IAiBnC;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,KAAK,EAAE,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,CAAC,CAAC,KAAK,EAAE;IAkClE;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,aAAa,GAAG,SAAS;IAetD;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAI5C;;;;OAIG;IACH,WAAW;IAIX;;;OAGG;IACH,cAAc,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ;IAKpD,0CAA0C;IAC1C,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS;IAI1D;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,GAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAM;IAkBhE;;;;OAIG;IACH,QAAQ,CACN,KAAK,EAAE,QAAQ,EACf,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EACvB,OAAO,GAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAM,GAC/B,QAAQ,EAAE,GAAG,SAAS;IA6BzB;;;;;;;OAOG;IACH,KAAK;IACH,wDAAwD;IACxD,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;IAoB3B;;;OAGG;IACH,WAAW;IAIX;;SAEK;IACL,OAAO;IAIP,8DAA8D;IAC9D,MAAM;IAIN,sDAAsD;IACtD,MAAM;IAIN,uDAAuD;IACvD,MAAM;IAIN;;;;;;OAMG;IACH,SAAS,CAAC,OAAO,EAAE,OAAO;IAO1B,OAAO,IAAI;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE;CAGlD;AAID,cAAc;AACd,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAE1B;IACE,gGAAgG;IAChG,KAAK,EAAE,IAAI,CAAA;IAEX,yCAAyC;IACzC,YAAY,CAAC,EAAE,CAAC,CAAA;CACjB,GAED;IACE,KAAK,CAAC,EAAE,KAAK,CAAA;IAGb,KAAK,CAAC,EAAE,QAAQ,CAAA;IAEhB,+HAA+H;IAC/H,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAIL,2EAA2E;AAC3E,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,2BAA2B,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IAC9D,mBAAmB,EAAE,CAAC,OAAO,EAAE,gCAAgC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IAC3E,4BAA4B,EAAE,CAC5B,OAAO,EAAE,wCAAwC,CAAC,CAAC,CAAC,KACjD,IAAI,CAAA;IACT,cAAc,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,IAAI,CAAA;CAC/D;AAED,sDAAsD;AACtD,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,6CAA6C;AAC7C,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,8BAA8B;IAC9B,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACpB,iDAAiD;IACjD,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACb,wDAAwD;IACxD,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,CAAA;IAClB,mCAAmC;IACnC,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;CAC1B;AAED,4CAA4C;AAC5C,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;CACrB;AAED,6DAA6D;AAC7D,MAAM,WAAW,2BAA2B,CAAC,CAAC;IAC5C,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;CACrB;AAED,qEAAqE;AACrE,MAAM,WAAW,gCAAgC,CAAC,CAAC;IACjD,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,kEAAkE;AAClE,MAAM,WAAW,wCAAwC,CAAC,CAAC;IACzD,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACpB,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,8DAA8D;AAC9D,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,SAAS,CAAA;IACpB,KAAK,EAAE,QAAQ,CAAA;CAChB;AAMD;;GAEG;AACH,eAAO,MAAM,WAAW;IACtB,kEAAkE;;IAElE,mDAAmD;;IAEnD,6EAA6E;;IAE7E,gCAAgC;;IAEhC,2EAA2E;;IAE3E,kDAAkD;;IAElD,4EAA4E;;CAEpE,CAAA;AACV,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAA;AAExE,eAAO,MACL,IAAI,UACJ,OAAO,aACP,UAAU,gBACV,KAAK,WACL,QAAQ,cACR,OAAO,aACP,WAAW,eACE,CAAA"}

package/dist/DocHandle.js

@@ -2,7 +2,7 @@ import * as A from "@automerge/automerge/slim/next";
 import debug from "debug";
 import { EventEmitter } from "eventemitter3";
 import { assertEvent, assign, createActor, setup, waitFor } from "xstate";
-import { stringifyAutomergeUrl } from "./AutomergeUrl.js";
+import { decodeHeads, encodeHeads, stringifyAutomergeUrl, } from "./AutomergeUrl.js";
 import { encode } from "./helpers/cbor.js";
 import { headsAreSame } from "./helpers/headsAreSame.js";
 import { withTimeout } from "./helpers/withTimeout.js";
@@ -24,6 +24,8 @@ export class DocHandle extends EventEmitter {
     #log;
     /** The XState actor running our state machine.  */
     #machine;
+    /** If set, this handle will only show the document at these heads */
+    #fixedHeads;
     /** The last known state of our document. */
     #prevDocState = A.init();
     /** How long to wait before giving up on a document. (Note that a document will be marked
@@ -38,6 +40,9 @@ export class DocHandle extends EventEmitter {
         if ("timeoutDelay" in options && options.timeoutDelay) {
             this.#timeoutDelay = options.timeoutDelay;
         }
+        if ("heads" in options) {
+            this.#fixedHeads = options.heads;
+        }
         const doc = A.init();
         this.#log = debug(`automerge-repo:dochandle:${this.documentId.slice(0, 5)}`);
         const delay = this.#timeoutDelay;
@@ -150,7 +155,7 @@ export class DocHandle extends EventEmitter {
     #checkForChanges(before, after) {
         const beforeHeads = A.getHeads(before);
         const afterHeads = A.getHeads(after);
-        const docChanged = !headsAreSame(afterHeads, beforeHeads);
+        const docChanged = !headsAreSame(encodeHeads(afterHeads), encodeHeads(beforeHeads));
         if (docChanged) {
             this.emit("heads-changed", { handle: this, doc: after });
             const patches = A.diff(after, beforeHeads, afterHeads);
@@ -173,7 +178,10 @@ export class DocHandle extends EventEmitter {
     /** Our documentId in Automerge URL form.
      */
     get url() {
-        return stringifyAutomergeUrl({ documentId: this.documentId });
+        return stringifyAutomergeUrl({
+            documentId: this.documentId,
+            heads: this.#fixedHeads,
+        });
     }
     /**
      * @returns true if the document is ready for accessing or changes.
@@ -237,6 +245,13 @@ export class DocHandle extends EventEmitter {
             // if we timed out, return undefined
             return undefined;
         }
+        // If we have fixed heads, return a view at those heads
+        if (this.#fixedHeads) {
+            const doc = this.#doc;
+            if (!doc || this.isUnavailable())
+                return undefined;
+            return A.view(doc, decodeHeads(this.#fixedHeads));
+        }
         // Return the document
         return !this.isUnavailable() ? this.#doc : undefined;
     }
@@ -256,8 +271,11 @@ export class DocHandle extends EventEmitter {
     docSync() {
         if (!this.isReady())
             return undefined;
-        else
-            return this.#doc;
+        if (this.#fixedHeads) {
+            const doc = this.#doc;
+            return doc ? A.view(doc, decodeHeads(this.#fixedHeads)) : undefined;
+        }
+        return this.#doc;
     }
     /**
      * Returns the current "heads" of the document, akin to a git commit.
@@ -265,18 +283,18 @@ export class DocHandle extends EventEmitter {
      * @returns the current document's heads, or undefined if the document is not ready
      */
     heads() {
-        if (!this.isReady()) {
+        if (!this.isReady())
             return undefined;
+        if (this.#fixedHeads) {
+            return this.#fixedHeads;
         }
-        return A.getHeads(this.#doc);
+        return encodeHeads(A.getHeads(this.#doc));
     }
     begin() {
         this.#machine.send({ type: BEGIN });
     }
     /**
-     * Creates a fixed "view" of an automerge document at the given point in time represented
-     * by the `heads` passed in. The return value is the same type as docSync() and will return
-     * undefined if the object hasn't finished loading.
+     * Returns an array of all past "heads" for the document in topological order.
      *
      * @remarks
      * A point-in-time in an automerge document is an *array* of heads since there may be
@@ -285,17 +303,17 @@ export class DocHandle extends EventEmitter {
      * history views would be quite large under concurrency (every thing in each branch against each other).
      * There might be a clever way to think about this, but we haven't found it yet, so for now at least
      * we present a single traversable view which excludes concurrency.
-     * @returns The individual heads for every change in the document.
+     * @returns UrlHeads[] - The individual heads for every change in the document. Each item is a tagged string[1].
      */
     history() {
         if (!this.isReady()) {
             return undefined;
         }
         // This just returns all the heads as individual strings.
-        return A.topoHistoryTraversal(this.#doc).map(h => [h]);
+        return A.topoHistoryTraversal(this.#doc).map(h => encodeHeads([h]));
     }
     /**
-     * Creates a fixed "view" of an automerge document at the given point in time represented
+     * Creates a new DocHandle with a fixed "view" at the given point in time represented
      * by the `heads` passed in. The return value is the same type as docSync() and will return
      * undefined if the object hasn't finished loading.
      *
@@ -304,32 +322,59 @@ export class DocHandle extends EventEmitter {
      * of Automerge doesn't check types at runtime, so if you go back to an old set of heads
      * that doesn't match the heads here, Typescript will not save you.
      *
-     * @returns An Automerge.Doc<T> at the point in time.
+     * @argument heads - The heads to view the document at. See history().
+     * @returns DocHandle<T> at the time of `heads`
      */
     view(heads) {
         if (!this.isReady()) {
-            return undefined;
+            throw new Error(`DocHandle#${this.documentId} is not ready. Check \`handle.isReady()\` before calling view().`);
         }
-        return A.view(this.#doc, heads);
+        // Create a new handle with the same documentId but fixed heads
+        const handle = new DocHandle(this.documentId, {
+            heads,
+            timeoutDelay: this.#timeoutDelay,
+        });
+        handle.update(() => A.clone(this.#doc));
+        handle.doneLoading();
+        return handle;
     }
     /**
      * Returns a set of Patch operations that will move a materialized document from one state to another
      * if applied.
      *
      * @remarks
-     * We allow specifying both a from/to heads or just a single comparison point, in which case
-     * the base will be the current document heads.
+     * We allow specifying either:
+     * - Two sets of heads to compare directly
+     * - A single set of heads to compare against our current heads
+     * - Another DocHandle to compare against (which must share history with this document)
      *
-     * @returns Automerge patches that go from one document state to the other. Use view() to get the full state.
+     * @throws Error if the documents don't share history or if either document is not ready
+     * @returns Automerge patches that go from one document state to the other
      */
     diff(first, second) {
         if (!this.isReady()) {
-            return undefined;
+            throw new Error(`DocHandle#${this.documentId} is not ready. Check \`handle.isReady()\` before calling diff().`);
+        }
+        const doc = this.#doc;
+        if (!doc)
+            throw new Error("Document not available");
+        // If first argument is a DocHandle
+        if (first instanceof DocHandle) {
+            if (!first.isReady()) {
+                throw new Error("Cannot diff against a handle that isn't ready");
+            }
+            const otherHeads = first.heads();
+            if (!otherHeads)
+                throw new Error("Other document's heads not available");
+            // Create a temporary merged doc to verify shared history and compute diff
+            const mergedDoc = A.merge(A.clone(doc), first.docSync());
+            // Use the merged doc to compute the diff
+            return A.diff(mergedDoc, decodeHeads(this.heads()), decodeHeads(otherHeads));
         }
-        // We allow only one set of heads to be specified, in which case we use the doc's heads
-        const from = second ? first : this.heads() || []; // because we guard above this should always have useful data
+        // Otherwise treat as heads
+        const from = second ? first : (this.heads() || []);
         const to = second ? second : first;
-        return A.diff(this.#doc, from, to);
+        return A.diff(doc, decodeHeads(from), decodeHeads(to));
     }
     /**
      * `metadata(head?)` allows you to look at the metadata for a change
@@ -350,7 +395,8 @@ export class DocHandle extends EventEmitter {
             change = this.heads()[0];
         }
         // we return undefined instead of null by convention in this API
-        return A.inspectChange(this.#doc, change) || undefined;
+        return (A.inspectChange(this.#doc, decodeHeads([change])[0]) ||
+            undefined);
     }
     /**
      * `update` is called any time we have a new document state; could be
@@ -400,6 +446,9 @@ export class DocHandle extends EventEmitter {
         if (!this.isReady()) {
             throw new Error(`DocHandle#${this.documentId} is in ${this.state} and not ready. Check \`handle.isReady()\` before accessing the document.`);
         }
+        if (this.#fixedHeads) {
+            throw new Error(`DocHandle#${this.documentId} is in view-only mode at specific heads. Use clone() to create a new document from this state.`);
+        }
         this.#machine.send({
             type: UPDATE,
             payload: { callback: doc => A.change(doc, options, callback) },
@@ -414,13 +463,18 @@ export class DocHandle extends EventEmitter {
         if (!this.isReady()) {
             throw new Error(`DocHandle#${this.documentId} is not ready. Check \`handle.isReady()\` before accessing the document.`);
         }
+        if (this.#fixedHeads) {
+            throw new Error(`DocHandle#${this.documentId} is in view-only mode at specific heads. Use clone() to create a new document from this state.`);
+        }
         let resultHeads = undefined;
         this.#machine.send({
             type: UPDATE,
             payload: {
                 callback: doc => {
-                    const result = A.changeAt(doc, heads, options, callback);
-                    resultHeads = result.newHeads || undefined;
+                    const result = A.changeAt(doc, decodeHeads(heads), options, callback);
+                    resultHeads = result.newHeads
+                        ? encodeHeads(result.newHeads)
+                        : undefined;
                     return result.newDoc;
                 },
             },
@@ -442,6 +496,9 @@ export class DocHandle extends EventEmitter {
         if (!this.isReady() || !otherHandle.isReady()) {
             throw new Error("Both handles must be ready to merge");
         }
+        if (this.#fixedHeads) {
+            throw new Error(`DocHandle#${this.documentId} is in view-only mode at specific heads. Use clone() to create a new document from this state.`);
+        }
         const mergingDoc = otherHandle.docSync();
         if (!mergingDoc) {
             throw new Error("The document to be merged in is falsy, aborting.");

package/dist/RemoteHeadsSubscriptions.d.ts

@@ -1,19 +1,19 @@
-import { next as A } from "@automerge/automerge/slim";
 import { EventEmitter } from "eventemitter3";
 import { DocumentId, PeerId } from "./types.js";
 import { RemoteHeadsChanged, RemoteSubscriptionControlMessage } from "./network/messages.js";
 import { StorageId } from "./index.js";
+import { UrlHeads } from "./AutomergeUrl.js";
 export type RemoteHeadsSubscriptionEventPayload = {
     documentId: DocumentId;
     storageId: StorageId;
-    remoteHeads: A.Heads;
+    remoteHeads: UrlHeads;
     timestamp: number;
 };
 export type NotifyRemoteHeadsPayload = {
     targetId: PeerId;
     documentId: DocumentId;
     storageId: StorageId;
-    heads: A.Heads;
+    heads: UrlHeads;
     timestamp: number;
 };
 type RemoteHeadsSubscriptionEvents = {
@@ -33,7 +33,7 @@ export declare class RemoteHeadsSubscriptions extends EventEmitter<RemoteHeadsSu
     /** A peer we are not directly connected to has changed their heads */
     handleRemoteHeads(msg: RemoteHeadsChanged): void;
     /** A peer we are directly connected to has updated their heads */
-    handleImmediateRemoteHeadsChanged(documentId: DocumentId, storageId: StorageId, heads: A.Heads): void;
+    handleImmediateRemoteHeadsChanged(documentId: DocumentId, storageId: StorageId, heads: UrlHeads): void;
     addGenerousPeer(peerId: PeerId): void;
     removePeer(peerId: PeerId): void;
     subscribePeerToDoc(peerId: PeerId, documentId: DocumentId): void;

package/dist/RemoteHeadsSubscriptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RemoteHeadsSubscriptions.d.ts","sourceRoot":"","sources":["../src/RemoteHeadsSubscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,CAAC,EAAE,MAAM,2BAA2B,CAAA;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAC/C,OAAO,EACL,kBAAkB,EAClB,gCAAgC,EACjC,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAItC,MAAM,MAAM,mCAAmC,GAAG;IAChD,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,SAAS,CAAA;IACpB,WAAW,EAAE,CAAC,CAAC,KAAK,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAGD,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,SAAS,CAAA;IACpB,KAAK,EAAE,CAAC,CAAC,KAAK,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,KAAK,6BAA6B,GAAG;IACnC,sBAAsB,EAAE,CAAC,OAAO,EAAE,mCAAmC,KAAK,IAAI,CAAA;IAC9E,oBAAoB,EAAE,CAAC,OAAO,EAAE;QAC9B,KAAK,EAAE,MAAM,EAAE,CAAA;QACf,GAAG,CAAC,EAAE,SAAS,EAAE,CAAA;QACjB,MAAM,CAAC,EAAE,SAAS,EAAE,CAAA;KACrB,KAAK,IAAI,CAAA;IACV,qBAAqB,EAAE,CAAC,OAAO,EAAE,wBAAwB,KAAK,IAAI,CAAA;CACnE,CAAA;AAED,qBAAa,wBAAyB,SAAQ,YAAY,CAAC,6BAA6B,CAAC;;IAcvF,kBAAkB,CAAC,OAAO,EAAE,SAAS,EAAE;IAkBvC,sBAAsB,CAAC,OAAO,EAAE,SAAS,EAAE;IAsB3C,oBAAoB,CAAC,OAAO,EAAE,gCAAgC;IA0E9D,sEAAsE;IACtE,iBAAiB,CAAC,GAAG,EAAE,kBAAkB;IAgDzC,kEAAkE;IAClE,iCAAiC,CAC/B,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,CAAC,CAAC,KAAK;IAgChB,eAAe,CAAC,MAAM,EAAE,MAAM;IAwB9B,UAAU,CAAC,MAAM,EAAE,MAAM;IA2BzB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU;CAoE1D"}
+{"version":3,"file":"RemoteHeadsSubscriptions.d.ts","sourceRoot":"","sources":["../src/RemoteHeadsSubscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAC/C,OAAO,EACL,kBAAkB,EAClB,gCAAgC,EACjC,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEtC,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAG5C,MAAM,MAAM,mCAAmC,GAAG;IAChD,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,SAAS,CAAA;IACpB,WAAW,EAAE,QAAQ,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAGD,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,SAAS,CAAA;IACpB,KAAK,EAAE,QAAQ,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,KAAK,6BAA6B,GAAG;IACnC,sBAAsB,EAAE,CAAC,OAAO,EAAE,mCAAmC,KAAK,IAAI,CAAA;IAC9E,oBAAoB,EAAE,CAAC,OAAO,EAAE;QAC9B,KAAK,EAAE,MAAM,EAAE,CAAA;QACf,GAAG,CAAC,EAAE,SAAS,EAAE,CAAA;QACjB,MAAM,CAAC,EAAE,SAAS,EAAE,CAAA;KACrB,KAAK,IAAI,CAAA;IACV,qBAAqB,EAAE,CAAC,OAAO,EAAE,wBAAwB,KAAK,IAAI,CAAA;CACnE,CAAA;AAED,qBAAa,wBAAyB,SAAQ,YAAY,CAAC,6BAA6B,CAAC;;IAcvF,kBAAkB,CAAC,OAAO,EAAE,SAAS,EAAE;IAkBvC,sBAAsB,CAAC,OAAO,EAAE,SAAS,EAAE;IAsB3C,oBAAoB,CAAC,OAAO,EAAE,gCAAgC;IA0E9D,sEAAsE;IACtE,iBAAiB,CAAC,GAAG,EAAE,kBAAkB;IAgDzC,kEAAkE;IAClE,iCAAiC,CAC/B,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,QAAQ;IAgCjB,eAAe,CAAC,MAAM,EAAE,MAAM;IAwB9B,UAAU,CAAC,MAAM,EAAE,MAAM;IA2BzB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU;CAuE1D"}

package/dist/RemoteHeadsSubscriptions.js

@@ -270,7 +270,10 @@ export class RemoteHeadsSubscriptions extends EventEmitter {
                 continue;
             }
             else {
-                remote.set(storageId, { timestamp, heads });
+                remote.set(storageId, {
+                    timestamp,
+                    heads: heads,
+                });
                 changedHeads.push({
                     documentId,
                     storageId: storageId,

package/dist/Repo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Repo.d.ts","sourceRoot":"","sources":["../src/Repo.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAM5C,OAAO,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;AAMnB,8FAA8F;AAC9F;;;;;;GAMG;AACH,qBAAa,IAAK,SAAQ,YAAY,CAAC,UAAU,CAAC;;IAGhD,cAAc;IACd,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,cAAc;IACd,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IAEnC,mDAAmD;IACnD,cAAc;IACd,gBAAgB,SAAM;IAItB,cAAc;IACd,YAAY,EAAE,sBAAsB,CAAA;IAEpC,sDAAsD;IACtD,cAAc;IACd,WAAW,EAAE,WAAW,CAAmB;IAE3C,8GAA8G;IAC9G,cAAc;IACd,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAK;gBAK3C,EACV,OAAO,EACP,OAAY,EACZ,MAAuB,EACvB,WAAW,EACX,WAAmC,EACnC,0BAAkC,EAClC,QAAa,GACd,GAAE,UAAe;IAgQlB,8CAA8C;IAC9C,IAAI,OAAO,uCAEV;IAED,+CAA+C;IAC/C,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAIzD;;;;OAIG;IACH,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAuBzC;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAuBnC;;;OAGG;IACH,IAAI,CAAC,CAAC;IACJ,sDAAsD;IACtD,EAAE,EAAE,aAAa,GAChB,SAAS,CAAC,CAAC,CAAC;IA+Cf,MAAM;IACJ,oDAAoD;IACpD,EAAE,EAAE,aAAa;IAWnB;;;;;;OAMG;IACG,MAAM,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAShE;;;OAGG;IACH,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU;IAY5B,kBAAkB,YAAa,SAAS,EAAE,UASzC;IAED,SAAS,QAAa,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAMnD;IAED;;;;;OAKG;IACG,KAAK,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBpD;;;;;OAKG;IACG,eAAe,CAAC,UAAU,EAAE,UAAU;IA2B5C,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;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAA;IAEpC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;CAC1B;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,KACpB,OAAO,CAAC,OAAO,CAAC,CAAA;AAGrB,MAAM,WAAW,UAAU;IACzB,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,6BAA6B;IAC7B,iBAAiB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IACvD,4FAA4F;IAC5F,sBAAsB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IAC5D,aAAa,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,IAAI,CAAA;CACzC;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":"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;AAMnB,8FAA8F;AAC9F;;;;;;GAMG;AACH,qBAAa,IAAK,SAAQ,YAAY,CAAC,UAAU,CAAC;;IAGhD,cAAc;IACd,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,cAAc;IACd,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IAEnC,mDAAmD;IACnD,cAAc;IACd,gBAAgB,SAAM;IAItB,cAAc;IACd,YAAY,EAAE,sBAAsB,CAAA;IAEpC,sDAAsD;IACtD,cAAc;IACd,WAAW,EAAE,WAAW,CAAmB;IAE3C,8GAA8G;IAC9G,cAAc;IACd,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAK;gBAK3C,EACV,OAAO,EACP,OAAY,EACZ,MAAuB,EACvB,WAAW,EACX,WAAmC,EACnC,0BAAkC,EAClC,QAAa,GACd,GAAE,UAAe;IAoQlB,8CAA8C;IAC9C,IAAI,OAAO,uCAEV;IAED,+CAA+C;IAC/C,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAIzD;;;;OAIG;IACH,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAuBzC;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAuBnC;;;OAGG;IACH,IAAI,CAAC,CAAC;IACJ,sDAAsD;IACtD,EAAE,EAAE,aAAa,GAChB,SAAS,CAAC,CAAC,CAAC;IAoDf,MAAM;IACJ,oDAAoD;IACpD,EAAE,EAAE,aAAa;IAWnB;;;;;;OAMG;IACG,MAAM,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAShE;;;OAGG;IACH,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU;IAY5B,kBAAkB,YAAa,SAAS,EAAE,UASzC;IAED,SAAS,QAAa,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAMnD;IAED;;;;;OAKG;IACG,KAAK,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBpD;;;;;OAKG;IACG,eAAe,CAAC,UAAU,EAAE,UAAU;IA2B5C,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;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAA;IAEpC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;CAC1B;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,KACpB,OAAO,CAAC,OAAO,CAAC,CAAA;AAGrB,MAAM,WAAW,UAAU;IACzB,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,6BAA6B;IAC7B,iBAAiB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IACvD,4FAA4F;IAC5F,sBAAsB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IAC5D,aAAa,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,IAAI,CAAA;CACzC;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"}