@automerge/automerge-repo-network-websocket 1.1.2 → 1.1.4

package/README.md

@@ -106,7 +106,7 @@ document_id = str
 ; Metadata sent in either the join or peer message types
 peer_metadata = {
     ; The storage ID of this peer
-    ? storageId: storage_id, 
+    ? storageId: storage_id,
     ; Whether the sender expects to connect again with this storage ID
     isEphemeral: bool
 }
@@ -140,11 +140,22 @@ Sent by the receiving peer in response to the join message in the
 }
 ```
 
+#### Leave
+
+An advisory message sent by a peer when they are planning to disconnect.
+
+```cddl
+{
+    type: "leave",
+    senderId: peer_id,
+}
+```
+
 #### Request
 
-Sent when the `senderId` is asking to begin sync for the given `documentid`. 
+Sent when the `senderId` is asking to begin sync for the given `documentid`.
 Identical to [sync](#sync) but indicates that the `senderId` would like an
-[unavailable](#unavailable) message if the `targetId` does not have the 
+[unavailable](#unavailable) message if the `targetId` does not have the
 document.
 
 ```cddl
@@ -200,7 +211,7 @@ Sent when a peer wants to send an ephemeral message to another peer
   type: "ephemeral",
   ; The peer who sent this message
   senderId: peer_id,
-  ; The target of this message 
+  ; The target of this message
   targetId: peer_id,
   ; The sequence number of this message within its session
   count: uint,
@@ -257,9 +268,9 @@ Sent when the sender wishes to inform the receiver that a peer with a storage ID
   documentId: document_id
 
   ; A map from storage ID to the heads advertised for a given storage ID
-  newHeads: { 
+  newHeads: {
     * storage_id => {
-      ; The heads of the new document for the given storage ID as 
+      ; The heads of the new document for the given storage ID as
       ; a list of base64 encoded SHA2 hashes
       heads: [* string]
       ; The local time on the node which initially sent the remote-heads-changed

package/dist/BrowserWebSocketClientAdapter.d.ts

@@ -15,7 +15,8 @@ export declare class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapt
     onOpen: () => void;
     onClose: () => void;
     onMessage: (event: WebSocket.MessageEvent) => void;
-    onError: (event: WebSocket.ErrorEvent) => void;
+    /** The websocket error handler signature is different on node and the browser.  */
+    onError: (event: Event | WebSocket.ErrorEvent) => void;
     join(): void;
     disconnect(): void;
     send(message: FromClientMessage): void;

package/dist/BrowserWebSocketClientAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserWebSocketClientAdapter.d.ts","sourceRoot":"","sources":["../src/BrowserWebSocketClientAdapter.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,cAAc,EACd,MAAM,EACN,YAAY,EAEb,MAAM,2BAA2B,CAAA;AAClC,OAAO,SAAS,MAAM,eAAe,CAAA;AAIrC,OAAO,EACL,iBAAiB,EAKlB,MAAM,eAAe,CAAA;AAKtB,uBAAe,uBAAwB,SAAQ,cAAc;IAC3D,MAAM,CAAC,EAAE,SAAS,CAAA;CACnB;AAED,qBAAa,6BAA8B,SAAQ,uBAAuB;;aAQtD,GAAG,EAAE,MAAM;aACX,aAAa;IAJ/B,YAAY,CAAC,EAAE,MAAM,CAAA;gBAGH,GAAG,EAAE,MAAM,EACX,aAAa,SAAO;IAMtC,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY;IAqCnD,MAAM,aAKL;IAGD,OAAO,aAWN;IAED,SAAS,UAAW,sBAAsB,UAEzC;IAED,OAAO,UAAW,oBAAoB,UAQrC;IAQD,IAAI;IAUJ,UAAU;IAMV,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAY/B,aAAa,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY;IAU9D,cAAc,CAAC,YAAY,EAAE,UAAU;CAiBxC"}
+{"version":3,"file":"BrowserWebSocketClientAdapter.d.ts","sourceRoot":"","sources":["../src/BrowserWebSocketClientAdapter.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,cAAc,EACd,MAAM,EACN,YAAY,EAEb,MAAM,2BAA2B,CAAA;AAClC,OAAO,SAAS,MAAM,eAAe,CAAA;AAIrC,OAAO,EACL,iBAAiB,EAKlB,MAAM,eAAe,CAAA;AAKtB,uBAAe,uBAAwB,SAAQ,cAAc;IAC3D,MAAM,CAAC,EAAE,SAAS,CAAA;CACnB;AAED,qBAAa,6BAA8B,SAAQ,uBAAuB;;aAQtD,GAAG,EAAE,MAAM;aACX,aAAa;IAJ/B,YAAY,CAAC,EAAE,MAAM,CAAA;gBAGH,GAAG,EAAE,MAAM,EACX,aAAa,SAAO;IAMtC,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY;IAqCnD,MAAM,aAKL;IAGD,OAAO,aAWN;IAED,SAAS,UAAW,sBAAsB,UAEzC;IAED,mFAAmF;IACnF,OAAO,UAED,KAAK,GACL,oBAAoB,UAezB;IAQD,IAAI;IAUJ,UAAU;IAMV,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAY/B,aAAa,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY;IAU9D,cAAc,CAAC,YAAY,EAAE,UAAU;CAiBxC"}

package/dist/BrowserWebSocketClientAdapter.js

@@ -75,15 +75,23 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     onMessage = (event) => {
         this.receiveMessage(event.data);
     };
-    onError = (event) => {
-        const { code } = event.error;
-        if (code === "ECONNREFUSED") {
-            this.#log("Connection refused, retrying...");
+    /** The websocket error handler signature is different on node and the browser.  */
+    onError = (event // node
+    ) => {
+        if ("error" in event) {
+            // (node)
+            if (event.error.code !== "ECONNREFUSED") {
+                /* c8 ignore next */
+                throw event.error;
+            }
         }
         else {
-            /* c8 ignore next */
-            throw event.error;
+            // (browser) We get no information about errors. https://stackoverflow.com/a/31003057/239663
+            // There will be an error logged in the console (`WebSocket connection to 'wss://foo.com/'
+            // failed`), but by design the error is unavailable to scripts. We'll just assume this is a
+            // failed connection.
         }
+        this.#log("Connection failed, retrying...");
     };
     #ready() {
         if (this.#isReady)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo-network-websocket",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "isomorphic node/browser Websocket network adapter for Automerge Repo",
   "repository": "https://github.com/automerge/automerge-repo/tree/master/packages/automerge-repo-network-websocket",
   "author": "Peter van Hardenberg <pvh@pvh.ca>",
@@ -9,11 +9,11 @@
   "main": "dist/index.js",
   "scripts": {
     "build": "tsc",
-    "watch": "npm-watch",
+    "watch": "npm-watch build",
     "test": "vitest"
   },
   "dependencies": {
-    "@automerge/automerge-repo": "1.1.2",
+    "@automerge/automerge-repo": "1.1.4",
     "cbor-x": "^1.3.0",
     "debug": "^4.3.4",
     "eventemitter3": "^5.0.1",
@@ -31,5 +31,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8bcba031ae952b1f3302cd41d1066cd2db5b677f"
+  "gitHead": "e819a7ed6302ce34f372b119ea3e8bab052e3af6"
 }

package/src/BrowserWebSocketClientAdapter.ts

@@ -100,14 +100,25 @@ export class BrowserWebSocketClientAdapter extends WebSocketNetworkAdapter {
     this.receiveMessage(event.data as Uint8Array)
   }
 
-  onError = (event: WebSocket.ErrorEvent) => {
-    const { code } = event.error
-    if (code === "ECONNREFUSED") {
-      this.#log("Connection refused, retrying...")
+  /** The websocket error handler signature is different on node and the browser.  */
+  onError = (
+    event:
+      | Event // browser
+      | WebSocket.ErrorEvent // node
+  ) => {
+    if ("error" in event) {
+      // (node)
+      if (event.error.code !== "ECONNREFUSED") {
+        /* c8 ignore next */
+        throw event.error
+      }
     } else {
-      /* c8 ignore next */
-      throw event.error
+      // (browser) We get no information about errors. https://stackoverflow.com/a/31003057/239663
+      // There will be an error logged in the console (`WebSocket connection to 'wss://foo.com/'
+      // failed`), but by design the error is unavailable to scripts. We'll just assume this is a
+      // failed connection.
     }
+    this.#log("Connection failed, retrying...")
   }
 
   #ready() {