@automerge/automerge-repo 1.1.2 → 1.1.4

package/README.md

@@ -52,7 +52,7 @@ A `Repo` exposes these methods:
 - `.on("document", ({handle: DocHandle}) => void)`  
   Registers a callback to be fired each time a new document is loaded or created.
 - `.on("delete-document", ({handle: DocHandle}) => void)`  
-  Registers a callback to be fired each time a new document is loaded or created.
+  Registers a callback to be fired each time a new document is deleted.
 
 A `DocHandle` is a wrapper around an `Automerge.Doc`. Its primary function is to dispatch changes to
 the document.

package/dist/DocHandle.js

@@ -315,7 +315,7 @@ export class DocHandle//
             payload: {
                 callback: (doc) => {
                     const result = A.changeAt(doc, heads, options, callback);
-                    resultHeads = result.newHeads;
+                    resultHeads = result.newHeads || undefined;
                     return result.newDoc;
                 },
             },

package/dist/Repo.js

@@ -156,7 +156,7 @@ export class Repo extends EventEmitter {
             const heads = handle.getRemoteHeads(storageId);
             const haveHeadsChanged = message.syncState.theirHeads &&
                 (!heads || !headsAreSame(heads, message.syncState.theirHeads));
-            if (haveHeadsChanged) {
+            if (haveHeadsChanged && message.syncState.theirHeads) {
                 handle.setRemoteHeads(storageId, message.syncState.theirHeads);
                 if (storageId && this.#remoteHeadsGossipingEnabled) {
                     this.#remoteHeadsSubscriptions.handleImmediateRemoteHeadsChanged(message.documentId, storageId, message.syncState.theirHeads);

package/dist/helpers/headsAreSame.d.ts

@@ -1,2 +1,3 @@
+import { Heads } from "@automerge/automerge/next";
 export declare const headsAreSame: (a: Heads, b: Heads) => boolean;
 //# sourceMappingURL=headsAreSame.d.ts.map

package/dist/helpers/headsAreSame.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"headsAreSame.d.ts","sourceRoot":"","sources":["../../src/helpers/headsAreSame.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,YAAY,iCAExB,CAAA"}
+{"version":3,"file":"headsAreSame.d.ts","sourceRoot":"","sources":["../../src/helpers/headsAreSame.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAA;AAGjD,eAAO,MAAM,YAAY,iCAExB,CAAA"}

package/dist/network/NetworkAdapter.d.ts

@@ -4,12 +4,14 @@ import { PeerId } from "../types.js";
 import { Message } from "./messages.js";
 import { NetworkAdapterInterface } from "./NetworkAdapterInterface.js";
 /** An interface representing some way to connect to other peers
- * @deprecated use {@link NetworkAdapterInterface}
  *
  * @remarks
  * The {@link Repo} uses one or more `NetworkAdapter`s to connect to other peers.
  * Because the network may take some time to be ready the {@link Repo} will wait
  * until the adapter emits a `ready` event before it starts trying to use it
+ *
+ * This utility class can be used as a base to build a custom network adapter. It
+ * is most useful as a simple way to add the necessary event emitter functionality
  */
 export declare abstract class NetworkAdapter extends EventEmitter<NetworkAdapterEvents> implements NetworkAdapterInterface {
     peerId?: PeerId;

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

@@ -1 +1 @@
-{"version":3,"file":"NetworkAdapter.d.ts","sourceRoot":"","sources":["../../src/network/NetworkAdapter.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAChE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AACvC,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AAEtE;;;;;;;GAOG;AACH,8BAAsB,cACpB,SAAQ,YAAY,CAAC,oBAAoB,CACzC,YAAW,uBAAuB;IAElC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,IAAI;IAEnE;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAErC,gEAAgE;IAChE,QAAQ,CAAC,UAAU,IAAI,IAAI;CAC5B"}
+{"version":3,"file":"NetworkAdapter.d.ts","sourceRoot":"","sources":["../../src/network/NetworkAdapter.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAChE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AACvC,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AAEtE;;;;;;;;;GASG;AACH,8BAAsB,cACpB,SAAQ,YAAY,CAAC,oBAAoB,CACzC,YAAW,uBAAuB;IAElC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,IAAI;IAEnE;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAErC,gEAAgE;IAChE,QAAQ,CAAC,UAAU,IAAI,IAAI;CAC5B"}

package/dist/network/NetworkAdapter.js

@@ -1,12 +1,14 @@
 /* c8 ignore start */
 import { EventEmitter } from "eventemitter3";
 /** An interface representing some way to connect to other peers
- * @deprecated use {@link NetworkAdapterInterface}
  *
  * @remarks
  * The {@link Repo} uses one or more `NetworkAdapter`s to connect to other peers.
  * Because the network may take some time to be ready the {@link Repo} will wait
  * until the adapter emits a `ready` event before it starts trying to use it
+ *
+ * This utility class can be used as a base to build a custom network adapter. It
+ * is most useful as a simple way to add the necessary event emitter functionality
  */
 export class NetworkAdapter extends EventEmitter {
     peerId;

package/dist/network/NetworkAdapterInterface.d.ts

@@ -18,6 +18,10 @@ export interface PeerMetadata {
  * The {@link Repo} uses one or more `NetworkAdapter`s to connect to other peers.
  * Because the network may take some time to be ready the {@link Repo} will wait
  * until the adapter emits a `ready` event before it starts trying to use it
+ *
+ * The {@link NetworkAdapter} is an abstract class that can be used as a base to build a
+ * custom network adapter. It is most useful as a simple way to add the necessary event
+ * emitter functionality
  */
 export interface NetworkAdapterInterface extends EventEmitter<NetworkAdapterEvents> {
     peerId?: PeerId;

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

@@ -1 +1 @@
-{"version":3,"file":"NetworkAdapterInterface.d.ts","sourceRoot":"","sources":["../../src/network/NetworkAdapterInterface.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAE/C;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,uBAAwB,SAAQ,YAAY,CAAC,oBAAoB,CAAC;IACjF,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,IAAI,CAAA;IAE1D;;;OAGG;IACH,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;IAE5B,gEAAgE;IAChE,UAAU,IAAI,IAAI,CAAA;CACnB;AAID,MAAM,WAAW,oBAAoB;IACnC,mDAAmD;IACnD,KAAK,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAA;IAErC,yCAAyC;IACzC,KAAK,EAAE,MAAM,IAAI,CAAA;IAEjB,+DAA+D;IAC/D,gBAAgB,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAEzD,2EAA2E;IAC3E,mBAAmB,EAAE,CAAC,OAAO,EAAE,uBAAuB,KAAK,IAAI,CAAA;IAE/D,sEAAsE;IACtE,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;CACpC;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,uBAAuB,CAAA;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,YAAY,CAAA;CAC3B;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAA;CACf"}
+{"version":3,"file":"NetworkAdapterInterface.d.ts","sourceRoot":"","sources":["../../src/network/NetworkAdapterInterface.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAE/C;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,uBACf,SAAQ,YAAY,CAAC,oBAAoB,CAAC;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,IAAI,CAAA;IAE1D;;;OAGG;IACH,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;IAE5B,gEAAgE;IAChE,UAAU,IAAI,IAAI,CAAA;CACnB;AAID,MAAM,WAAW,oBAAoB;IACnC,mDAAmD;IACnD,KAAK,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAA;IAErC,yCAAyC;IACzC,KAAK,EAAE,MAAM,IAAI,CAAA;IAEjB,+DAA+D;IAC/D,gBAAgB,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAEzD,2EAA2E;IAC3E,mBAAmB,EAAE,CAAC,OAAO,EAAE,uBAAuB,KAAK,IAAI,CAAA;IAE/D,sEAAsE;IACtE,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;CACpC;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,uBAAuB,CAAA;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,YAAY,CAAA;CAC3B;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAA;CACf"}

package/dist/synchronizer/DocSynchronizer.d.ts

@@ -6,7 +6,7 @@ import { Synchronizer } from "./Synchronizer.js";
 type PeerDocumentStatus = "unknown" | "has" | "unavailable" | "wants";
 interface DocSynchronizerConfig {
     handle: DocHandle<unknown>;
-    onLoadSyncState?: (peerId: PeerId) => A.SyncState | undefined;
+    onLoadSyncState?: (peerId: PeerId) => Promise<A.SyncState | undefined>;
 }
 /**
  * DocSynchronizer takes a handle to an Automerge document, and receives & dispatches sync messages

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

@@ -1 +1 @@
-{"version":3,"file":"DocSynchronizer.d.ts","sourceRoot":"","sources":["../../src/synchronizer/DocSynchronizer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,2BAA2B,CAAA;AAG9C,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;AAOrE,UAAU,qBAAqB;IAC7B,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IAC1B,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,CAAC,SAAS,GAAG,SAAS,CAAA;CAC9D;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,YAAY;;IAE/C,gBAAgB,SAAM;gBAsBV,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,qBAAqB;IAyB9D,IAAI,UAAU,uCAEb;IAED,IAAI,UAAU,qCAEb;IAkID,OAAO,CAAC,MAAM,EAAE,MAAM;IAItB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE;IAmD3B,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;CA8EzD"}
+{"version":3,"file":"DocSynchronizer.d.ts","sourceRoot":"","sources":["../../src/synchronizer/DocSynchronizer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,2BAA2B,CAAA;AAG9C,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;AAOrE,UAAU,qBAAqB;IAC7B,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IAC1B,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,GAAG,SAAS,CAAC,CAAA;CACvE;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,YAAY;;IAE/C,gBAAgB,SAAM;gBAsBV,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,qBAAqB;IAyB9D,IAAI,UAAU,uCAEb;IAED,IAAI,UAAU,qCAEb;IAkID,OAAO,CAAC,MAAM,EAAE,MAAM;IAItB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE;IAmD3B,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;CA8EzD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "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>",
@@ -55,5 +55,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8bcba031ae952b1f3302cd41d1066cd2db5b677f"
+  "gitHead": "e819a7ed6302ce34f372b119ea3e8bab052e3af6"
 }

package/src/DocHandle.ts

@@ -383,7 +383,7 @@ export class DocHandle<T> //
       payload: {
         callback: (doc: A.Doc<T>) => {
           const result = A.changeAt(doc, heads, options, callback)
-          resultHeads = result.newHeads
+          resultHeads = result.newHeads || undefined
           return result.newDoc
         },
       },

package/src/Repo.ts

@@ -214,7 +214,7 @@ export class Repo extends EventEmitter<RepoEvents> {
         message.syncState.theirHeads &&
         (!heads || !headsAreSame(heads, message.syncState.theirHeads))
 
-      if (haveHeadsChanged) {
+      if (haveHeadsChanged && message.syncState.theirHeads) {
         handle.setRemoteHeads(storageId, message.syncState.theirHeads)
 
         if (storageId && this.#remoteHeadsGossipingEnabled) {

package/src/network/NetworkAdapter.ts

@@ -7,12 +7,14 @@ import { Message } from "./messages.js"
 import { NetworkAdapterInterface } from "./NetworkAdapterInterface.js"
 
 /** An interface representing some way to connect to other peers
- * @deprecated use {@link NetworkAdapterInterface}
  *
  * @remarks
  * The {@link Repo} uses one or more `NetworkAdapter`s to connect to other peers.
  * Because the network may take some time to be ready the {@link Repo} will wait
  * until the adapter emits a `ready` event before it starts trying to use it
+ *
+ * This utility class can be used as a base to build a custom network adapter. It
+ * is most useful as a simple way to add the necessary event emitter functionality
  */
 export abstract class NetworkAdapter
   extends EventEmitter<NetworkAdapterEvents>

package/src/network/NetworkAdapterInterface.ts

@@ -22,8 +22,13 @@ export interface PeerMetadata {
  * The {@link Repo} uses one or more `NetworkAdapter`s to connect to other peers.
  * Because the network may take some time to be ready the {@link Repo} will wait
  * until the adapter emits a `ready` event before it starts trying to use it
+ *
+ * The {@link NetworkAdapter} is an abstract class that can be used as a base to build a
+ * custom network adapter. It is most useful as a simple way to add the necessary event
+ * emitter functionality
  */
-export interface NetworkAdapterInterface extends EventEmitter<NetworkAdapterEvents> {
+export interface NetworkAdapterInterface
+  extends EventEmitter<NetworkAdapterEvents> {
   peerId?: PeerId
   peerMetadata?: PeerMetadata
 

package/src/synchronizer/DocSynchronizer.ts

@@ -30,7 +30,7 @@ type PendingMessage = {
 
 interface DocSynchronizerConfig {
   handle: DocHandle<unknown>
-  onLoadSyncState?: (peerId: PeerId) => A.SyncState | undefined
+  onLoadSyncState?: (peerId: PeerId) => Promise<A.SyncState | undefined>
 }
 
 /**

package/test/helpers/DummyStorageAdapter.ts

@@ -1,6 +1,6 @@
-import { Chunk, StorageAdapter, type StorageKey } from "../../src/index.js"
+import { Chunk, StorageAdapterInterface, type StorageKey } from "../../src/index.js"
 
-export class DummyStorageAdapter implements StorageAdapter {
+export class DummyStorageAdapter implements StorageAdapterInterface {
   #data: Record<string, Uint8Array> = {}
 
   #keyToString(key: string[]): string {