@automerge/automerge-repo 1.0.6 → 1.0.7

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.js

@@ -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 { DocumentId, PeerId } from "../types.js";
 import { Synchronizer } from "./Synchronizer.js";
-import { SynchronizerMessage } from "../network/messages.js";
+import { RepoMessage } 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":"AAEA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAGhD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAGpD,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,4 +1,4 @@
-import { stringifyAutomergeUrl, } from "../DocUrl.js";
+import { stringifyAutomergeUrl } from "../DocUrl.js";
 import { DocSynchronizer } from "./DocSynchronizer.js";
 import { Synchronizer } from "./Synchronizer.js";
 import debug from "debug";
@@ -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,13 @@ type PeerDocumentStatus = "unknown" | "has" | "unavailable" | "wants";
 export declare class DocSynchronizer extends Synchronizer {
     #private;
     private handle;
-    constructor(handle: DocHandle<any>);
+    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,EAChB,WAAW,EAEX,cAAc,EACd,WAAW,EAEZ,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEhD,KAAK,kBAAkB,GAAG,SAAS,GAAG,KAAK,GAAG,aAAa,GAAG,OAAO,CAAA;AAErE;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,YAAY;;IAiBnC,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC;IAoB9C,IAAI,UAAU,uCAEb;IAED,IAAI,UAAU,qCAEb;IA8FD,OAAO,CAAC,MAAM,EAAE,MAAM;IAItB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE;IAmC3B,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,9 @@
 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";
 /**
  * DocSynchronizer takes a handle to an Automerge document, and receives & dispatches sync messages
  * to bring it inline with all other peers' versions.
@@ -49,18 +49,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 +86,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 +109,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 +136,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 +173,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 +226,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 { RepoMessage, MessageContents } 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,WAAW,EAAE,eAAe,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "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": "71060981f168e511a99ab85b155a54a13fd04bcc"
 }

package/src/DocHandle.ts

@@ -290,14 +290,12 @@ export class DocHandle<T> //
   async doc(
     awaitStates: HandleState[] = [READY, UNAVAILABLE]
   ): Promise<A.Doc<T> | undefined> {
-    await pause() // yield one tick because reasons
     try {
       // wait for the document to enter one of the desired states
       await this.#statePromise(awaitStates)
     } catch (error) {
-      if (error instanceof TimeoutError)
-        throw new Error(`DocHandle: timed out loading ${this.documentId}`)
-      else throw error
+      // if we timed out (or the load has already failed), return undefined
+      return undefined
     }
     // Return the document
     return !this.isUnavailable() ? this.#doc : undefined
@@ -431,7 +429,7 @@ export class DocHandle<T> //
    * a user could have multiple tabs open and would appear as multiple PeerIds.
    * every message source must have a unique PeerId.
    */
-  broadcast(message: any) {
+  broadcast(message: unknown) {
     this.emit("ephemeral-message-outbound", {
       handle: this,
       data: encode(message),
@@ -474,14 +472,14 @@ export interface DocHandleChangePayload<T> {
   patchInfo: A.PatchInfo<T>
 }
 
-export interface DocHandleEphemeralMessagePayload {
-  handle: DocHandle<any>
+export interface DocHandleEphemeralMessagePayload<T> {
+  handle: DocHandle<T>
   senderId: PeerId
   message: unknown
 }
 
-export interface DocHandleOutboundEphemeralMessagePayload {
-  handle: DocHandle<any>
+export interface DocHandleOutboundEphemeralMessagePayload<T> {
+  handle: DocHandle<T>
   data: Uint8Array
 }
 
@@ -490,9 +488,9 @@ export interface DocHandleEvents<T> {
   change: (payload: DocHandleChangePayload<T>) => void
   delete: (payload: DocHandleDeletePayload<T>) => void
   unavailable: (payload: DocHandleDeletePayload<T>) => void
-  "ephemeral-message": (payload: DocHandleEphemeralMessagePayload) => void
+  "ephemeral-message": (payload: DocHandleEphemeralMessagePayload<T>) => void
   "ephemeral-message-outbound": (
-    payload: DocHandleOutboundEphemeralMessagePayload
+    payload: DocHandleOutboundEphemeralMessagePayload<T>
   ) => void
 }
 

package/src/EphemeralData.ts

@@ -1,5 +1,5 @@
 import { DocumentId, PeerId } from "./index.js"
-import { EphemeralMessageContents } from "./network/messages.js"
+import { EphemeralMessage, MessageContents } from "./network/messages.js"
 
 // types
 /** A randomly generated string created when the {@link Repo} starts up */
@@ -12,6 +12,6 @@ export interface EphemeralDataPayload {
 }
 
 export type EphemeralDataMessageEvents = {
-  message: (event: EphemeralMessageContents) => void
+  message: (event: MessageContents<EphemeralMessage>) => void
   data: (event: EphemeralDataPayload) => void
 }

package/src/Repo.ts

@@ -5,7 +5,7 @@ import { StorageAdapter } from "./storage/StorageAdapter.js"
 import { StorageSubsystem } from "./storage/StorageSubsystem.js"
 import { CollectionSynchronizer } from "./synchronizer/CollectionSynchronizer.js"
 import { type AutomergeUrl, DocumentId, PeerId } from "./types.js"
-import { v4 as uuid } from "uuid"
+
 import {
   parseAutomergeUrl,
   generateAutomergeUrl,
@@ -106,9 +106,9 @@ export class Repo extends EventEmitter<RepoEvents> {
     // The synchronizer uses the network subsystem to keep documents in sync with peers.
     const synchronizer = new CollectionSynchronizer(this)
 
-    // When the synchronizer emits sync messages, send them to peers
+    // When the synchronizer emits messages, send them to peers
     synchronizer.on("message", message => {
-      this.#log(`sending sync message to ${message.targetId}`)
+      this.#log(`sending ${message.type} message to ${message.targetId}`)
       networkSubsystem.send(message)
     })
 
@@ -198,9 +198,9 @@ export class Repo extends EventEmitter<RepoEvents> {
    * @param clonedHandle - The handle to clone
    *
    * @remarks This is a wrapper around the `clone` function in the Automerge library.
-   * The new `DocHandle` will have a new URL but will share history with the original, 
-   * which means that changes made to the cloned handle can be sensibly merged back 
-   * into the original. 
+   * The new `DocHandle` will have a new URL but will share history with the original,
+   * which means that changes made to the cloned handle can be sensibly merged back
+   * into the original.
    *
    * Any peers this `Repo` is connected to for whom `sharePolicy` returns `true` will
    * be notified of the newly created DocHandle.
@@ -223,7 +223,7 @@ export class Repo extends EventEmitter<RepoEvents> {
 
     const handle = this.create<T>()
 
-    handle.update((doc: Automerge.Doc<T>) => {
+    handle.update(() => {
       // we replace the document with the new cloned one
       return Automerge.clone(sourceDoc)
     })
@@ -240,7 +240,7 @@ export class Repo extends EventEmitter<RepoEvents> {
     automergeUrl: AutomergeUrl
   ): DocHandle<T> {
     if (!isValidAutomergeUrl(automergeUrl)) {
-      let maybeAutomergeUrl = parseLegacyUUID(automergeUrl)
+      const maybeAutomergeUrl = parseLegacyUUID(automergeUrl)
       if (maybeAutomergeUrl) {
         console.warn(
           "Legacy UUID document ID detected, converting to AutomergeUrl. This will be removed in a future version."
@@ -274,17 +274,13 @@ export class Repo extends EventEmitter<RepoEvents> {
     /** The documentId of the handle to delete */
     id: DocumentId | AutomergeUrl
   ) {
-    if (isValidAutomergeUrl(id)) {
-      ;({ documentId: id } = parseAutomergeUrl(id))
-    }
+    if (isValidAutomergeUrl(id)) id = parseAutomergeUrl(id).documentId
 
     const handle = this.#getHandle(id, false)
     handle.delete()
 
     delete this.#handleCache[id]
-    this.emit("delete-document", {
-      documentId: id,
-    })
+    this.emit("delete-document", { documentId: id })
   }
 }
 

package/src/helpers/cbor.ts

@@ -1,10 +1,10 @@
-import { Encoder, decode as cborXdecode } from "cbor-x";
+import { Encoder, decode as cborXdecode } from "cbor-x"
 
-export function encode(obj: any): Buffer {
-  let encoder = new Encoder({tagUint8Array: false})
+export function encode(obj: unknown): Buffer {
+  const encoder = new Encoder({ tagUint8Array: false })
   return encoder.encode(obj)
 }
 
-export function decode(buf: Buffer | Uint8Array): any {
+export function decode<T = unknown>(buf: Buffer | Uint8Array): T {
   return cborXdecode(buf)
 }

package/src/helpers/pause.ts

@@ -1,9 +1,14 @@
 export const pause = (t = 0) =>
   new Promise<void>(resolve => setTimeout(() => resolve(), t))
 
-export function rejectOnTimeout<T>(promise: Promise<T>, millis: number): Promise<T> {
+export function rejectOnTimeout<T>(
+  promise: Promise<T>,
+  millis: number
+): Promise<T> {
   return Promise.race([
     promise,
-    pause(millis).then(() => { throw new Error("timeout exceeded") }),
+    pause(millis).then(() => {
+      throw new Error("timeout exceeded")
+    }),
   ])
 }

package/src/helpers/tests/network-adapter-tests.ts

@@ -1,7 +1,7 @@
-import { PeerId, Repo, type NetworkAdapter, DocumentId } from "../../index.js"
+import assert from "assert"
+import { describe, it } from "vitest"
+import { PeerId, Repo, type NetworkAdapter } from "../../index.js"
 import { eventPromise, eventPromises } from "../eventPromise.js"
-import { assert } from "chai"
-import { describe, it } from "mocha"
 import { pause } from "../pause.js"
 
 /**

package/src/helpers/withTimeout.ts

@@ -6,7 +6,7 @@ export const withTimeout = async <T>(
   promise: Promise<T>,
   t: number
 ): Promise<T> => {
-  let timeoutId: ReturnType<typeof setTimeout>
+  let timeoutId: ReturnType<typeof setTimeout> | undefined
   const timeoutPromise = new Promise<never>((_, reject) => {
     timeoutId = setTimeout(
       () => reject(new TimeoutError(`withTimeout: timed out after ${t}ms`)),
@@ -16,7 +16,7 @@ export const withTimeout = async <T>(
   try {
     return await Promise.race([promise, timeoutPromise])
   } finally {
-    clearTimeout(timeoutId!)
+    clearTimeout(timeoutId)
   }
 }
 

package/src/index.ts

@@ -16,9 +16,9 @@
  *
  * ```typescript
  * import { Repo } from "@automerge/automerge-repo";
- * 
+ *
  * const repo = new Repo({
- *   storage: <storage adapter>, 
+ *   storage: <storage adapter>,
  *   network: [<network adapter>, <network adapter>]
  * })
  *
@@ -26,47 +26,54 @@
  * ```
  */
 
-export { DocHandle, type HandleState, type DocHandleOptions, type DocHandleEvents } from "./DocHandle.js"
-export type { 
+export { Repo } from "./Repo.js"
+export { DocHandle } from "./DocHandle.js"
+export { NetworkAdapter } from "./network/NetworkAdapter.js"
+export { StorageAdapter } from "./storage/StorageAdapter.js"
+export {
+  isValidAutomergeUrl,
+  parseAutomergeUrl,
+  stringifyAutomergeUrl,
+} from "./DocUrl.js"
+export { isValidRepoMessage } from "./network/messages.js"
+
+/** @hidden **/
+export * as cbor from "./helpers/cbor.js"
+
+// types
+
+export type {
   DocHandleChangePayload,
   DocHandleDeletePayload,
+  DocHandleEncodedChangePayload,
   DocHandleEphemeralMessagePayload,
+  DocHandleEvents,
+  DocHandleOptions,
   DocHandleOutboundEphemeralMessagePayload,
-  DocHandleEncodedChangePayload,
+  HandleState,
 } from "./DocHandle.js"
-export { NetworkAdapter } from "./network/NetworkAdapter.js"
 export type {
+  DeleteDocumentPayload,
+  DocumentPayload,
+  RepoConfig,
+  RepoEvents,
+  SharePolicy,
+} from "./Repo.js"
+export type {
+  NetworkAdapterEvents,
   OpenPayload,
   PeerCandidatePayload,
   PeerDisconnectedPayload,
-  NetworkAdapterEvents,
 } from "./network/NetworkAdapter.js"
-
-// This is a bit confusing right now, but:
-// Message is the type for messages used outside of the network adapters
-// there are some extra internal network adapter-only messages on NetworkAdapterMessage
-// and Message is (as of this writing) a union type for EphmeralMessage and SyncMessage
 export type {
-  Message,
   ArriveMessage,
-  WelcomeMessage,
-  NetworkAdapterMessage,
+  DocumentUnavailableMessage,
   EphemeralMessage,
+  Message,
+  RepoMessage,
   RequestMessage,
-  DocumentUnavailableMessage,
   SyncMessage,
-  SessionId,
+  WelcomeMessage,
 } from "./network/messages.js"
-export { isValidMessage } from "./network/messages.js"
-
-export { Repo, type SharePolicy, type RepoConfig, type RepoEvents, type DeleteDocumentPayload, type DocumentPayload } from "./Repo.js"
-export { StorageAdapter, type StorageKey } from "./storage/StorageAdapter.js"
-export {
-  parseAutomergeUrl,
-  isValidAutomergeUrl,
-  stringifyAutomergeUrl as generateAutomergeUrl,
-} from "./DocUrl.js"
+export type { StorageKey } from "./storage/StorageAdapter.js"
 export * from "./types.js"
-
-/** @hidden **/
-export * as cbor from "./helpers/cbor.js"