@automerge/automerge-repo 1.0.6 → 1.0.8

package/dist/network/messages.d.ts

@@ -1,45 +1,18 @@
-import { SessionId } from "../EphemeralData.js";
-export { type SessionId } from "../EphemeralData.js";
-import { DocumentId, PeerId } from "../types.js";
-export declare function isValidMessage(message: NetworkAdapterMessage): message is SyncMessage | EphemeralMessage | RequestMessage | DocumentUnavailableMessage;
-export declare function isDocumentUnavailableMessage(message: NetworkAdapterMessage): message is DocumentUnavailableMessage;
-export declare function isRequestMessage(message: NetworkAdapterMessage): message is RequestMessage;
-export declare function isSyncMessage(message: NetworkAdapterMessage): message is SyncMessage;
-export declare function isEphemeralMessage(message: NetworkAdapterMessage | MessageContents): message is EphemeralMessage | EphemeralMessageContents;
-export interface SyncMessageEnvelope {
-    senderId: PeerId;
-}
-export interface SyncMessageContents {
-    type: "sync";
-    data: Uint8Array;
-    targetId: PeerId;
-    documentId: DocumentId;
-}
+import { DocumentId, PeerId, SessionId } from "../types.js";
 /**
  * A sync message for a particular document
  */
 export type SyncMessage = {
+    type: "sync";
     /** The peer ID of the sender of this message */
     senderId: PeerId;
-    type: "sync";
-    /** The automerge sync message */
-    data: Uint8Array;
     /** The peer ID of the recipient of this message */
     targetId: PeerId;
+    /** The automerge sync message */
+    data: Uint8Array;
     /** The document ID of the document this message is for */
     documentId: DocumentId;
 };
-export interface EphemeralMessageEnvelope {
-    senderId: PeerId;
-    count: number;
-    sessionId: SessionId;
-}
-export interface EphemeralMessageContents {
-    type: "ephemeral";
-    targetId: PeerId;
-    documentId: DocumentId;
-    data: Uint8Array;
-}
 /** An ephemeral message
  *
  * @remarks
@@ -51,41 +24,30 @@ export interface EphemeralMessageContents {
  * we have already seen.
  * */
 export type EphemeralMessage = {
-    /** The ID of the peer who sent this message */
+    type: "ephemeral";
+    /** The peer ID of the sender of this message */
     senderId: PeerId;
+    /** The peer ID of the recipient of this message */
+    targetId: PeerId;
     /** A sequence number which must be incremented for each message sent by this peer */
     count: number;
     /** The ID of the session this message is part of. The sequence number for a given session always increases */
     sessionId: SessionId;
-    type: "ephemeral";
-    /** The peer this message is for */
-    targetId: PeerId;
     /** The document ID this message pertains to */
     documentId: DocumentId;
     /** The actual data of the message */
     data: Uint8Array;
 };
-export interface DocumentUnavailableMessageContents {
-    type: "doc-unavailable";
-    documentId: DocumentId;
-    targetId: PeerId;
-}
 /** Sent by a {@link Repo} to indicate that it does not have the document and none of it's connected peers do either */
 export type DocumentUnavailableMessage = {
-    /** The peer who sent this message */
-    senderId: PeerId;
     type: "doc-unavailable";
+    /** The peer ID of the sender of this message */
+    senderId: PeerId;
+    /** The peer ID of the recipient of this message */
+    targetId: PeerId;
     /** The document which the peer claims it doesn't have */
     documentId: DocumentId;
-    /** The peer this message is for */
-    targetId: PeerId;
 };
-export interface RequestMessageContents {
-    type: "request";
-    data: Uint8Array;
-    targetId: PeerId;
-    documentId: DocumentId;
-}
 /** Sent by a {@link Repo} to request a document from a peer
  *
  * @remarks
@@ -93,40 +55,48 @@ export interface RequestMessageContents {
  * as the initial sync message when asking the other peer if it has the document.
  * */
 export type RequestMessage = {
-    /** The peer who sent this message */
-    senderId: PeerId;
     type: "request";
+    /** The peer ID of the sender of this message */
+    senderId: PeerId;
+    /** The peer ID of the recipient of this message */
+    targetId: PeerId;
     /** The initial automerge sync message */
     data: Uint8Array;
-    /** The peer this message is for */
-    targetId: PeerId;
     /** The document ID this message requests */
     documentId: DocumentId;
 };
-export type MessageContents = SyncMessageContents | EphemeralMessageContents | RequestMessageContents | DocumentUnavailableMessageContents;
-/** The type of messages that {@link Repo} sends and receive to {@link NetworkAdapter}s */
-export type Message = SyncMessage | EphemeralMessage | RequestMessage | DocumentUnavailableMessage;
-export type SynchronizerMessage = SyncMessage | RequestMessage | DocumentUnavailableMessage | EphemeralMessage;
 /** Notify the network that we have arrived so everyone knows our peer ID */
 export type ArriveMessage = {
-    /** Our peer ID */
-    senderId: PeerId;
     type: "arrive";
+    /** The peer ID of the sender of this message */
+    senderId: PeerId;
+    /** Arrive messages don't have a targetId */
+    targetId: never;
 };
 /** Respond to an arriving peer with our peer ID */
 export type WelcomeMessage = {
-    /** Our peer ID */
+    type: "welcome";
+    /** The peer ID of the recipient sender this message */
     senderId: PeerId;
-    /** The ID of the peer who sent the {@link ArriveMessage} we are responding to */
+    /** The peer ID of the recipient of this message */
     targetId: PeerId;
-    type: "welcome";
 };
-/** The type of messages that {@link NetworkAdapter}s send and receive to each other
+/** These are message types that a {@link NetworkAdapter} surfaces to a {@link Repo}. */
+export type RepoMessage = SyncMessage | EphemeralMessage | RequestMessage | DocumentUnavailableMessage;
+/** These are all the message types that a {@link NetworkAdapter} might see.
  *
  * @remarks
- * It is not _required_ that a {@link NetworkAdapter} use this message type.
- * NetworkAdapters are free to use whatever message type makes sense for their
- * transport. However, this type is a useful default.
+ * It is not _required_ that a {@link NetworkAdapter} use these types: They are free to use
+ * whatever message type makes sense for their transport. However, this type is a useful default.
  * */
-export type NetworkAdapterMessage = ArriveMessage | WelcomeMessage | Message;
+export type Message = RepoMessage | ArriveMessage | WelcomeMessage;
+/**
+ * The contents of a message, without the sender ID or other properties added by the {@link NetworkSubsystem})
+ */
+export type MessageContents<T extends Message = Message> = T extends EphemeralMessage ? Omit<T, "senderId" | "count" | "sessionId"> : Omit<T, "senderId">;
+export declare const isValidRepoMessage: (message: Message) => message is RepoMessage;
+export declare const isDocumentUnavailableMessage: (msg: Message) => msg is DocumentUnavailableMessage;
+export declare const isRequestMessage: (msg: Message) => msg is RequestMessage;
+export declare const isSyncMessage: (msg: Message) => msg is SyncMessage;
+export declare const isEphemeralMessage: (msg: Message) => msg is EphemeralMessage;
 //# sourceMappingURL=messages.d.ts.map

package/dist/network/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/network/messages.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAC/C,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEhD,wBAAgB,cAAc,CAC5B,OAAO,EAAE,qBAAqB,GAC7B,OAAO,IACN,WAAW,GACX,gBAAgB,GAChB,cAAc,GACd,0BAA0B,CAU7B;AAED,wBAAgB,4BAA4B,CAC1C,OAAO,EAAE,qBAAqB,GAC7B,OAAO,IAAI,0BAA0B,CAEvC;AAED,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,qBAAqB,GAC7B,OAAO,IAAI,cAAc,CAE3B;AAED,wBAAgB,aAAa,CAC3B,OAAO,EAAE,qBAAqB,GAC7B,OAAO,IAAI,WAAW,CAExB;AAED,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,qBAAqB,GAAG,eAAe,GAC/C,OAAO,IAAI,gBAAgB,GAAG,wBAAwB,CAExD;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,UAAU,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,UAAU,CAAA;CACvB;AASD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,iCAAiC;IACjC,IAAI,EAAE,UAAU,CAAA;IAChB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;IAChB,0DAA0D;IAC1D,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAGD,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,SAAS,CAAA;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,WAAW,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,UAAU,CAAA;IACtB,IAAI,EAAE,UAAU,CAAA;CACjB;AAMD;;;;;;;;;KASK;AACL,MAAM,MAAM,gBAAgB,GAAG;IAC7B,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAA;IAChB,qFAAqF;IACrF,KAAK,EAAE,MAAM,CAAA;IACb,8GAA8G;IAC9G,SAAS,EAAE,SAAS,CAAA;IACpB,IAAI,EAAE,WAAW,CAAA;IACjB,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,+CAA+C;IAC/C,UAAU,EAAE,UAAU,CAAA;IACtB,qCAAqC;IACrC,IAAI,EAAE,UAAU,CAAA;CACjB,CAAA;AAED,MAAM,WAAW,kCAAkC;IACjD,IAAI,EAAE,iBAAiB,CAAA;IACvB,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAMD,uHAAuH;AACvH,MAAM,MAAM,0BAA0B,GAAG;IACvC,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,iBAAiB,CAAA;IACvB,yDAAyD;IACzD,UAAU,EAAE,UAAU,CAAA;IACtB,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,UAAU,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,UAAU,CAAA;CACvB;AAQD;;;;;KAKK;AACL,MAAM,MAAM,cAAc,GAAG;IAC3B,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,SAAS,CAAA;IACf,yCAAyC;IACzC,IAAI,EAAE,UAAU,CAAA;IAChB,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,4CAA4C;IAC5C,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,eAAe,GACvB,mBAAmB,GACnB,wBAAwB,GACxB,sBAAsB,GACtB,kCAAkC,CAAA;AAEtC,0FAA0F;AAC1F,MAAM,MAAM,OAAO,GACf,WAAW,GACX,gBAAgB,GAChB,cAAc,GACd,0BAA0B,CAAA;AAE9B,MAAM,MAAM,mBAAmB,GAC3B,WAAW,GACX,cAAc,GACd,0BAA0B,GAC1B,gBAAgB,CAAA;AAGpB,4EAA4E;AAC5E,MAAM,MAAM,aAAa,GAAG;IAC1B,kBAAkB;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,QAAQ,CAAA;CACf,CAAA;AAED,mDAAmD;AACnD,MAAM,MAAM,cAAc,GAAG;IAC3B,kBAAkB;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,iFAAiF;IACjF,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA;AAED;;;;;;KAMK;AACL,MAAM,MAAM,qBAAqB,GAAG,aAAa,GAAG,cAAc,GAAG,OAAO,CAAA"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/network/messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAE3D;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IAEZ,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAEhB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;IAEhB,iCAAiC;IACjC,IAAI,EAAE,UAAU,CAAA;IAEhB,0DAA0D;IAC1D,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAED;;;;;;;;;KASK;AACL,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,WAAW,CAAA;IAEjB,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAEhB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;IAEhB,qFAAqF;IACrF,KAAK,EAAE,MAAM,CAAA;IAEb,8GAA8G;IAC9G,SAAS,EAAE,SAAS,CAAA;IAEpB,+CAA+C;IAC/C,UAAU,EAAE,UAAU,CAAA;IAEtB,qCAAqC;IACrC,IAAI,EAAE,UAAU,CAAA;CACjB,CAAA;AAED,uHAAuH;AACvH,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,iBAAiB,CAAA;IAEvB,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAEhB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;IAEhB,yDAAyD;IACzD,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAED;;;;;KAKK;AACL,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,SAAS,CAAA;IAEf,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAEhB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;IAEhB,yCAAyC;IACzC,IAAI,EAAE,UAAU,CAAA;IAEhB,4CAA4C;IAC5C,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAED,4EAA4E;AAC5E,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,QAAQ,CAAA;IAEd,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAEhB,4CAA4C;IAC5C,QAAQ,EAAE,KAAK,CAAA;CAChB,CAAA;AAED,mDAAmD;AACnD,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,SAAS,CAAA;IAEf,uDAAuD;IACvD,QAAQ,EAAE,MAAM,CAAA;IAEhB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,wFAAwF;AACxF,MAAM,MAAM,WAAW,GACnB,WAAW,GACX,gBAAgB,GAChB,cAAc,GACd,0BAA0B,CAAA;AAE9B;;;;;KAKK;AACL,MAAM,MAAM,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,CAAA;AAElE;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IACrD,CAAC,SAAS,gBAAgB,GACtB,IAAI,CAAC,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,WAAW,CAAC,GAC3C,IAAI,CAAC,CAAC,EAAE,UAAU,CAAC,CAAA;AAIzB,eAAO,MAAM,kBAAkB,YAAa,OAAO,2BAOT,CAAA;AAG1C,eAAO,MAAM,4BAA4B,QAAS,OAAO,sCACzB,CAAA;AAEhC,eAAO,MAAM,gBAAgB,QAAS,OAAO,0BACrB,CAAA;AAExB,eAAO,MAAM,aAAa,QAAS,OAAO,uBACrB,CAAA;AAErB,eAAO,MAAM,kBAAkB,QAAS,OAAO,4BACrB,CAAA"}

package/dist/network/messages.js

@@ -1,21 +1,13 @@
-export function isValidMessage(message) {
-    return (typeof message === "object" &&
-        typeof message.type === "string" &&
-        typeof message.senderId === "string" &&
-        (isSyncMessage(message) ||
-            isEphemeralMessage(message) ||
-            isRequestMessage(message) ||
-            isDocumentUnavailableMessage(message)));
-}
-export function isDocumentUnavailableMessage(message) {
-    return message.type === "doc-unavailable";
-}
-export function isRequestMessage(message) {
-    return message.type === "request";
-}
-export function isSyncMessage(message) {
-    return message.type === "sync";
-}
-export function isEphemeralMessage(message) {
-    return message.type === "ephemeral";
-}
+// TYPE GUARDS
+export const isValidRepoMessage = (message) => typeof message === "object" &&
+    typeof message.type === "string" &&
+    typeof message.senderId === "string" &&
+    (isSyncMessage(message) ||
+        isEphemeralMessage(message) ||
+        isRequestMessage(message) ||
+        isDocumentUnavailableMessage(message));
+// prettier-ignore
+export const isDocumentUnavailableMessage = (msg) => msg.type === "doc-unavailable";
+export const isRequestMessage = (msg) => msg.type === "request";
+export const isSyncMessage = (msg) => msg.type === "sync";
+export const isEphemeralMessage = (msg) => msg.type === "ephemeral";

package/dist/storage/StorageSubsystem.d.ts

@@ -1,6 +1,6 @@
 import * as A from "@automerge/automerge/next";
-import { StorageAdapter } from "./StorageAdapter.js";
 import { type DocumentId } from "../types.js";
+import { StorageAdapter } from "./StorageAdapter.js";
 export type ChunkType = "snapshot" | "incremental";
 export declare class StorageSubsystem {
     #private;

package/dist/storage/StorageSubsystem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StorageSubsystem.d.ts","sourceRoot":"","sources":["../../src/storage/StorageSubsystem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,2BAA2B,CAAA;AAC9C,OAAO,EAAE,cAAc,EAAc,MAAM,qBAAqB,CAAA;AAEhE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,aAAa,CAAA;AAa7C,MAAM,MAAM,SAAS,GAAG,UAAU,GAAG,aAAa,CAAA;AAelD,qBAAa,gBAAgB;;gBAQf,cAAc,EAAE,cAAc;IAuDpC,OAAO,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IA0B/D,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAanE,MAAM,CAAC,UAAU,EAAE,UAAU;CAmCpC"}
+{"version":3,"file":"StorageSubsystem.d.ts","sourceRoot":"","sources":["../../src/storage/StorageSubsystem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,2BAA2B,CAAA;AAK9C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAc,MAAM,qBAAqB,CAAA;AAUhE,MAAM,MAAM,SAAS,GAAG,UAAU,GAAG,aAAa,CAAA;AAelD,qBAAa,gBAAgB;;gBAQf,cAAc,EAAE,cAAc;IAuDpC,OAAO,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IA0B/D,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAanE,MAAM,CAAC,UAAU,EAAE,UAAU;CAmCpC"}

package/dist/storage/StorageSubsystem.js

@@ -1,8 +1,8 @@
 import * as A from "@automerge/automerge/next";
-import * as sha256 from "fast-sha256";
-import { mergeArrays } from "../helpers/mergeArrays.js";
 import debug from "debug";
+import * as sha256 from "fast-sha256";
 import { headsAreSame } from "../helpers/headsAreSame.js";
+import { mergeArrays } from "../helpers/mergeArrays.js";
 function keyHash(binary) {
     const hash = sha256.hash(binary);
     const hashArray = Array.from(new Uint8Array(hash)); // convert buffer to byte array
@@ -10,8 +10,8 @@ function keyHash(binary) {
     return hashHex;
 }
 function headsHash(heads) {
-    let encoder = new TextEncoder();
-    let headsbinary = mergeArrays(heads.map((h) => encoder.encode(h)));
+    const encoder = new TextEncoder();
+    const headsbinary = mergeArrays(heads.map((h) => encoder.encode(h)));
     return keyHash(headsbinary);
 }
 export class StorageSubsystem {
@@ -89,18 +89,18 @@ export class StorageSubsystem {
         if (!this.#shouldSave(documentId, doc)) {
             return;
         }
-        let sourceChunks = this.#chunkInfos.get(documentId) ?? [];
+        const sourceChunks = this.#chunkInfos.get(documentId) ?? [];
         if (this.#shouldCompact(sourceChunks)) {
-            this.#saveTotal(documentId, doc, sourceChunks);
+            void this.#saveTotal(documentId, doc, sourceChunks);
         }
         else {
-            this.#saveIncremental(documentId, doc);
+            void this.#saveIncremental(documentId, doc);
         }
         this.#storedHeads.set(documentId, A.getHeads(doc));
     }
     async remove(documentId) {
-        this.#storageAdapter.removeRange([documentId, "snapshot"]);
-        this.#storageAdapter.removeRange([documentId, "incremental"]);
+        void this.#storageAdapter.removeRange([documentId, "snapshot"]);
+        void this.#storageAdapter.removeRange([documentId, "incremental"]);
     }
     #shouldSave(documentId, doc) {
         const oldHeads = this.#storedHeads.get(documentId);

package/dist/synchronizer/CollectionSynchronizer.d.ts

@@ -1,7 +1,7 @@
 import { Repo } from "../Repo.js";
-import { PeerId, DocumentId } from "../types.js";
+import { RepoMessage } from "../network/messages.js";
+import { DocumentId, PeerId } from "../types.js";
 import { Synchronizer } from "./Synchronizer.js";
-import { SynchronizerMessage } from "../network/messages.js";
 /** A CollectionSynchronizer is responsible for synchronizing a DocCollection with peers. */
 export declare class CollectionSynchronizer extends Synchronizer {
     #private;
@@ -11,7 +11,7 @@ export declare class CollectionSynchronizer extends Synchronizer {
      * When we receive a sync message for a document we haven't got in memory, we
      * register it with the repo and start synchronizing
      */
-    receiveMessage(message: SynchronizerMessage): Promise<void>;
+    receiveMessage(message: RepoMessage): Promise<void>;
     /**
      * Starts synchronizing the given document with all peers that we share it generously with.
      */

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,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"}
+{"version":3,"file":"CollectionSynchronizer.d.ts","sourceRoot":"","sources":["../../src/synchronizer/CollectionSynchronizer.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAIhD,4FAA4F;AAC5F,qBAAa,sBAAuB,SAAQ,YAAY;;IAU1C,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,IAAI;IAiC9B;;;OAGG;IACG,cAAc,CAAC,OAAO,EAAE,WAAW;IAyBzC;;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/dist/synchronizer/CollectionSynchronizer.js

@@ -1,7 +1,7 @@
-import { stringifyAutomergeUrl, } from "../DocUrl.js";
+import debug from "debug";
+import { stringifyAutomergeUrl } from "../DocUrl.js";
 import { DocSynchronizer } from "./DocSynchronizer.js";
 import { Synchronizer } from "./Synchronizer.js";
-import debug from "debug";
 const log = debug("automerge-repo:collectionsync");
 /** A CollectionSynchronizer is responsible for synchronizing a DocCollection with peers. */
 export class CollectionSynchronizer extends Synchronizer {
@@ -85,7 +85,7 @@ export class CollectionSynchronizer extends Synchronizer {
         this.#peers.add(peerId);
         for (const docSynchronizer of Object.values(this.#docSynchronizers)) {
             const { documentId } = docSynchronizer;
-            this.repo.sharePolicy(peerId, documentId).then(okToShare => {
+            void this.repo.sharePolicy(peerId, documentId).then(okToShare => {
                 if (okToShare)
                     docSynchronizer.beginSync([peerId]);
             });

package/dist/synchronizer/DocSynchronizer.d.ts

@@ -1,7 +1,7 @@
 import { DocHandle } from "../DocHandle.js";
+import { EphemeralMessage, RepoMessage, RequestMessage, SyncMessage } from "../network/messages.js";
 import { PeerId } from "../types.js";
 import { Synchronizer } from "./Synchronizer.js";
-import { EphemeralMessage, RequestMessage, SynchronizerMessage, SyncMessage } from "../network/messages.js";
 type PeerDocumentStatus = "unknown" | "has" | "unavailable" | "wants";
 /**
  * DocSynchronizer takes a handle to an Automerge document, and receives & dispatches sync messages
@@ -10,13 +10,14 @@ type PeerDocumentStatus = "unknown" | "has" | "unavailable" | "wants";
 export declare class DocSynchronizer extends Synchronizer {
     #private;
     private handle;
-    constructor(handle: DocHandle<any>);
+    syncDebounceRate: number;
+    constructor(handle: DocHandle<unknown>);
     get peerStates(): Record<PeerId, PeerDocumentStatus>;
     get documentId(): import("../types.js").DocumentId;
     hasPeer(peerId: PeerId): boolean;
     beginSync(peerIds: PeerId[]): void;
     endSync(peerId: PeerId): void;
-    receiveMessage(message: SynchronizerMessage): void;
+    receiveMessage(message: RepoMessage): void;
     receiveEphemeralMessage(message: EphemeralMessage): void;
     receiveSyncMessage(message: SyncMessage | RequestMessage): void;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"DocSynchronizer.d.ts","sourceRoot":"","sources":["../../src/synchronizer/DocSynchronizer.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,SAAS,EAKV,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAGhD,OAAO,EACL,gBAAgB,EAIhB,cAAc,EACd,mBAAmB,EACnB,WAAW,EACZ,MAAM,wBAAwB,CAAA;AAE/B,KAAK,kBAAkB,GAAG,SAAS,GAAG,KAAK,GAAG,aAAa,GAAG,OAAO,CAAA;AAGrE;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,YAAY;;IAiBnC,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC;IAoB1C,IAAI,UAAU,uCAEb;IAED,IAAI,UAAU,qCAEb;IAiHD,OAAO,CAAC,MAAM,EAAE,MAAM;IAItB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE;IA6B3B,OAAO,CAAC,MAAM,EAAE,MAAM;IAKtB,cAAc,CAAC,OAAO,EAAE,mBAAmB;IAkB3C,uBAAuB,CAAC,OAAO,EAAE,gBAAgB;IAuBjD,kBAAkB,CAAC,OAAO,EAAE,WAAW,GAAG,cAAc;CA2EzD"}
+{"version":3,"file":"DocSynchronizer.d.ts","sourceRoot":"","sources":["../../src/synchronizer/DocSynchronizer.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,SAAS,EAKV,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAEL,gBAAgB,EAEhB,WAAW,EACX,cAAc,EACd,WAAW,EAEZ,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAGhD,KAAK,kBAAkB,GAAG,SAAS,GAAG,KAAK,GAAG,aAAa,GAAG,OAAO,CAAA;AAErE;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,YAAY;;IAgBnC,OAAO,CAAC,MAAM;IAd1B,gBAAgB,SAAM;gBAcF,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC;IAqB9C,IAAI,UAAU,uCAEb;IAED,IAAI,UAAU,qCAEb;IA8FD,OAAO,CAAC,MAAM,EAAE,MAAM;IAItB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE;IAqC3B,OAAO,CAAC,MAAM,EAAE,MAAM;IAKtB,cAAc,CAAC,OAAO,EAAE,WAAW;IAkBnC,uBAAuB,CAAC,OAAO,EAAE,gBAAgB;IAuBjD,kBAAkB,CAAC,OAAO,EAAE,WAAW,GAAG,cAAc;CA4EzD"}

package/dist/synchronizer/DocSynchronizer.js

@@ -1,9 +1,10 @@
 import * as A from "@automerge/automerge/next";
-import { READY, REQUESTING, UNAVAILABLE, } from "../DocHandle.js";
-import { Synchronizer } from "./Synchronizer.js";
+import { decode } from "cbor-x";
 import debug from "debug";
+import { READY, REQUESTING, UNAVAILABLE, } from "../DocHandle.js";
 import { isRequestMessage, } from "../network/messages.js";
-import { decode } from "cbor-x";
+import { Synchronizer } from "./Synchronizer.js";
+import { throttle } from "../helpers/throttle.js";
 /**
  * DocSynchronizer takes a handle to an Automerge document, and receives & dispatches sync messages
  * to bring it inline with all other peers' versions.
@@ -11,8 +12,7 @@ import { decode } from "cbor-x";
 export class DocSynchronizer extends Synchronizer {
     handle;
     #log;
-    #conciseLog;
-    #opsLog;
+    syncDebounceRate = 100;
     /** Active peers */
     #peers = [];
     #peerDocumentStatuses = {};
@@ -24,10 +24,8 @@ export class DocSynchronizer extends Synchronizer {
         super();
         this.handle = handle;
         const docId = handle.documentId.slice(0, 5);
-        this.#conciseLog = debug(`automerge-repo:concise:docsync:${docId}`); // Only logs one line per receive/send
         this.#log = debug(`automerge-repo:docsync:${docId}`);
-        this.#opsLog = debug(`automerge-repo:ops:docsync:${docId}`); // Log list of ops of each message
-        handle.on("change", () => this.#syncWithPeers());
+        handle.on("change", throttle(() => this.#syncWithPeers(), this.syncDebounceRate));
         handle.on("ephemeral-message-outbound", payload => this.#broadcastToPeers(payload));
         // Process pending sync messages immediately after the handle becomes ready.
         void (async () => {
@@ -49,18 +47,19 @@ export class DocSynchronizer extends Synchronizer {
             return;
         this.#peers.forEach(peerId => this.#sendSyncMessage(peerId, doc));
     }
-    async #broadcastToPeers({ data }) {
+    async #broadcastToPeers({ data, }) {
         this.#log(`broadcastToPeers`, this.#peers);
         this.#peers.forEach(peerId => this.#sendEphemeralMessage(peerId, data));
     }
     #sendEphemeralMessage(peerId, data) {
         this.#log(`sendEphemeralMessage ->${peerId}`);
-        this.emit("message", {
+        const message = {
             type: "ephemeral",
             targetId: peerId,
             documentId: this.handle.documentId,
             data,
-        });
+        };
+        this.emit("message", message);
     }
     #getSyncState(peerId) {
         if (!this.#peers.includes(peerId)) {
@@ -85,10 +84,9 @@ export class DocSynchronizer extends Synchronizer {
         const [newSyncState, message] = A.generateSyncMessage(doc, syncState);
         this.#setSyncState(peerId, newSyncState);
         if (message) {
-            this.#logMessage(`sendSyncMessage 🡒 ${peerId}`, message);
-            const decoded = A.decodeSyncMessage(message);
+            const isNew = A.getHeads(doc).length === 0;
             if (!this.handle.isReady() &&
-                decoded.heads.length === 0 &&
+                isNew &&
                 newSyncState.sharedHeads.length === 0 &&
                 !Object.values(this.#peerDocumentStatuses).includes("has") &&
                 this.#peerDocumentStatuses[peerId] === "unknown") {
@@ -109,30 +107,17 @@ export class DocSynchronizer extends Synchronizer {
                 });
             }
             // if we have sent heads, then the peer now has or will have the document
-            if (decoded.heads.length > 0) {
+            if (!isNew) {
                 this.#peerDocumentStatuses[peerId] = "has";
             }
         }
     }
-    #logMessage = (label, message) => {
-        // This is real expensive...
-        return;
-        const size = message.byteLength;
-        const logText = `${label} ${size}b`;
-        const decoded = A.decodeSyncMessage(message);
-        this.#conciseLog(logText);
-        this.#log(logText, decoded);
-        // expanding is expensive, so only do it if we're logging at this level
-        const expanded = this.#opsLog.enabled
-            ? decoded.changes.flatMap((change) => A.decodeChange(change).ops.map((op) => JSON.stringify(op)))
-            : null;
-        this.#opsLog(logText, expanded);
-    };
     /// PUBLIC
     hasPeer(peerId) {
         return this.#peers.includes(peerId);
     }
     beginSync(peerIds) {
+        const newPeers = new Set(peerIds.filter(peerId => !this.#peers.includes(peerId)));
         this.#log(`beginSync: ${peerIds.join(", ")}`);
         // HACK: if we have a sync state already, we round-trip it through the encoding system to make
         // sure state is preserved. This prevents an infinite loop caused by failed attempts to send
@@ -149,10 +134,15 @@ export class DocSynchronizer extends Synchronizer {
             // we register out peers first, then say that sync has started
             this.#syncStarted = true;
             this.#checkDocUnavailable();
-            if (doc === undefined)
+            const wasUnavailable = doc === undefined;
+            if (wasUnavailable && newPeers.size == 0) {
                 return;
+            }
+            // If the doc is unavailable we still need a blank document to generate
+            // the sync message from
+            const theDoc = doc ?? A.init();
             peerIds.forEach(peerId => {
-                this.#sendSyncMessage(peerId, doc);
+                this.#sendSyncMessage(peerId, theDoc);
             });
         });
     }
@@ -181,7 +171,7 @@ export class DocSynchronizer extends Synchronizer {
         if (message.documentId !== this.handle.documentId)
             throw new Error(`channelId doesn't match documentId`);
         const { senderId, data } = message;
-        const contents = decode(data);
+        const contents = decode(new Uint8Array(data));
         this.handle.emit("ephemeral-message", {
             handle: this.handle,
             senderId,
@@ -234,11 +224,12 @@ export class DocSynchronizer extends Synchronizer {
             this.#peers
                 .filter(peerId => this.#peerDocumentStatuses[peerId] === "wants")
                 .forEach(peerId => {
-                this.emit("message", {
+                const message = {
                     type: "doc-unavailable",
                     documentId: this.handle.documentId,
                     targetId: peerId,
-                });
+                };
+                this.emit("message", message);
             });
             this.handle.unavailable();
         }

package/dist/synchronizer/Synchronizer.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from "eventemitter3";
-import { Message, MessageContents } from "../network/messages.js";
+import { MessageContents, RepoMessage } from "../network/messages.js";
 export declare abstract class Synchronizer extends EventEmitter<SynchronizerEvents> {
-    abstract receiveMessage(message: Message): void;
+    abstract receiveMessage(message: RepoMessage): void;
 }
 export interface SynchronizerEvents {
     message: (arg: MessageContents) => void;

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

@@ -1 +1 @@
-{"version":3,"file":"Synchronizer.d.ts","sourceRoot":"","sources":["../../src/synchronizer/Synchronizer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAEjE,8BAAsB,YAAa,SAAQ,YAAY,CAAC,kBAAkB,CAAC;IACzE,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;CAChD;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAA;CACxC"}
+{"version":3,"file":"Synchronizer.d.ts","sourceRoot":"","sources":["../../src/synchronizer/Synchronizer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAErE,8BAAsB,YAAa,SAAQ,YAAY,CAAC,kBAAkB,CAAC;IACzE,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;CACpD;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAA;CACxC"}

package/dist/types.d.ts

@@ -20,6 +20,10 @@ export type BinaryDocumentId = Uint8Array & {
 };
 /** A branded type for peer IDs */
 export type PeerId = string & {
-    __peerId: false;
+    __peerId: true;
+};
+/** A randomly generated string created when the {@link Repo} starts up */
+export type SessionId = string & {
+    __SessionId: true;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;GACG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG;IAAE,YAAY,EAAE,IAAI,CAAA;CAAE,CAAA;AACxD;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG;IAAE,aAAa,EAAE,IAAI,CAAA;CAAE,CAAA;AAC3D;GACG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG;IAAE,kBAAkB,EAAE,IAAI,CAAA;CAAE,CAAA;AAExE,kCAAkC;AAClC,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG;IAAE,QAAQ,EAAE,KAAK,CAAA;CAAE,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;GACG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG;IAAE,YAAY,EAAE,IAAI,CAAA;CAAE,CAAA;AAExD;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG;IAAE,aAAa,EAAE,IAAI,CAAA;CAAE,CAAA;AAE3D;GACG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG;IAAE,kBAAkB,EAAE,IAAI,CAAA;CAAE,CAAA;AAExE,kCAAkC;AAClC,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,CAAA;AAEhD,0EAA0E;AAC1E,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAAE,WAAW,EAAE,IAAI,CAAA;CAAE,CAAA"}

package/fuzz/fuzz.ts

@@ -1,13 +1,15 @@
-import assert from "assert"
 import { MessageChannelNetworkAdapter } from "@automerge/automerge-repo-network-messagechannel"
 import * as Automerge from "@automerge/automerge/next"
-
-import { DocHandle, DocumentId, PeerId, SharePolicy } from "../src"
+import assert from "assert"
 import { eventPromise } from "../src/helpers/eventPromise.js"
 import { pause } from "../src/helpers/pause.js"
-import { Repo } from "../src/Repo.js"
-import { DummyNetworkAdapter } from "../test/helpers/DummyNetworkAdapter.js"
-import { DummyStorageAdapter } from "../test/helpers/DummyStorageAdapter.js"
+import {
+  DocHandle,
+  DocumentId,
+  PeerId,
+  Repo,
+  SharePolicy,
+} from "../src/index.js"
 import { getRandomItem } from "../test/helpers/getRandomItem.js"
 
 interface TestDoc {

package/fuzz/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "Node16",
+    "noEmit": true
+  },
+  "include": ["**/*.ts"]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "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>",
@@ -11,7 +11,7 @@
     "build": "tsc",
     "watch": "npm-watch build",
     "test:coverage": "c8 --reporter=lcov --reporter=html --reporter=text yarn test",
-    "test": "mocha --no-warnings --experimental-specifier-resolution=node --exit",
+    "test": "vitest",
     "test:watch": "npm-watch test",
     "test:log": "cross-env DEBUG='automerge-repo:*' yarn test",
     "fuzz": "ts-node --esm --experimentalSpecifierResolution=node fuzz/fuzz.ts"
@@ -20,18 +20,10 @@
     "crypto": false
   },
   "devDependencies": {
-    "@automerge/automerge": "^2.1.0",
-    "@types/debug": "^4.1.7",
-    "@types/node": "^20.4.8",
-    "@types/uuid": "^8.3.4",
-    "@types/ws": "^8.5.3",
-    "@typescript-eslint/eslint-plugin": "^5.33.0",
-    "@typescript-eslint/parser": "^5.33.0",
-    "http-server": "^14.1.0",
-    "typescript": "^5.1.6"
+    "http-server": "^14.1.0"
   },
   "peerDependencies": {
-    "@automerge/automerge": "^2.1.0"
+    "@automerge/automerge": "^2.1.5"
   },
   "dependencies": {
     "bs58check": "^3.0.1",
@@ -65,5 +57,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "088696831fed48c7a8a88109acd0465222dc8522"
+  "gitHead": "d244a36aebab52a86f91b5427bbe8ab2800bf2f4"
 }