@automerge/automerge-repo-network-websocket 1.0.2 → 1.0.4

package/dist/index.d.ts

@@ -1,3 +1,19 @@
+/**
+ * A `NetworkAdapter` which connects to a remote host via WebSockets
+ *
+ * The websocket protocol requires a server to be listening and a client to
+ * connect to the server. To that end the {@link NodeWSServerAdapter} does not
+ * make outbound connections and instead listens on the provided socket for
+ * new connections whilst the {@link BrowserWebSocketClientAdapter} makes an
+ * outbound connection to the provided socket.
+ *
+ * Note that the "browser" and "node" naming is a bit misleading, both
+ * implementations work in both the browser and on node via `isomorphic-ws`.
+ *
+ * @module
+ * */
 export { BrowserWebSocketClientAdapter } from "./BrowserWebSocketClientAdapter.js";
 export { NodeWSServerAdapter } from "./NodeWSServerAdapter.js";
+export type { FromClientMessage, FromServerMessage, JoinMessage, LeaveMessage, ErrorMessage, PeerMessage } from "./messages.js";
+export type { ProtocolVersion, ProtocolV1 } from "./protocolVersion.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAA;AAClF,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;KAaK;AACL,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAA;AAClF,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC9D,YAAY,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,WAAW,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC/H,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA"}

package/dist/index.js

@@ -1,2 +1,16 @@
+/**
+ * A `NetworkAdapter` which connects to a remote host via WebSockets
+ *
+ * The websocket protocol requires a server to be listening and a client to
+ * connect to the server. To that end the {@link NodeWSServerAdapter} does not
+ * make outbound connections and instead listens on the provided socket for
+ * new connections whilst the {@link BrowserWebSocketClientAdapter} makes an
+ * outbound connection to the provided socket.
+ *
+ * Note that the "browser" and "node" naming is a bit misleading, both
+ * implementations work in both the browser and on node via `isomorphic-ws`.
+ *
+ * @module
+ * */
 export { BrowserWebSocketClientAdapter } from "./BrowserWebSocketClientAdapter.js";
 export { NodeWSServerAdapter } from "./NodeWSServerAdapter.js";

package/dist/messages.d.ts

@@ -1,26 +1,40 @@
 import { type Message, type PeerId } from "@automerge/automerge-repo";
 import { ProtocolVersion } from "./protocolVersion.js";
+/** The sender is disconnecting */
 export type LeaveMessage = {
     type: "leave";
     senderId: PeerId;
 };
+/** Sent by the client to the server to tell the server the clients PeerID */
 export type JoinMessage = {
     type: "join";
+    /** The PeerID of the client */
     senderId: PeerId;
+    /** The protocol version the client supports */
     supportedProtocolVersions: ProtocolVersion[];
 };
+/** Sent by the server in response to a "join" message to advertise the servers PeerID */
 export type PeerMessage = {
     type: "peer";
+    /** The PeerID of the server */
     senderId: PeerId;
+    /** The protocol version the server selected for this connection */
     selectedProtocolVersion: ProtocolVersion;
+    /** The PeerID of the client */
     targetId: PeerId;
 };
+/** An error occurred. The other end will terminate the connection after sending this message */
 export type ErrorMessage = {
     type: "error";
+    /** The peer sending the message */
     senderId: PeerId;
+    /** A description of the error*/
     message: string;
+    /** The PeerID of the client */
     targetId: PeerId;
 };
+/** A message from the client to the server */
 export type FromClientMessage = JoinMessage | LeaveMessage | Message;
+/** A message from the server to the client */
 export type FromServerMessage = PeerMessage | ErrorMessage | Message;
 //# sourceMappingURL=messages.d.ts.map

package/dist/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,yBAAyB,EAAE,eAAe,EAAE,CAAA;CAC7C,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,uBAAuB,EAAE,eAAe,CAAA;IACxC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAGD,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CAAA;AACpE,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CAAA"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD,kCAAkC;AAClC,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,6EAA6E;AAC7E,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,+CAA+C;IAC/C,yBAAyB,EAAE,eAAe,EAAE,CAAA;CAC7C,CAAA;AAED,yFAAyF;AACzF,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,mEAAmE;IACnE,uBAAuB,EAAE,eAAe,CAAA;IACxC,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,gGAAgG;AAChG,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,CAAA;IACb,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAGD,8CAA8C;AAC9C,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CAAA;AACpE,8CAA8C;AAC9C,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CAAA"}

package/dist/protocolVersion.d.ts

@@ -1,3 +1,4 @@
 export declare const ProtocolV1 = "1";
+/** The versions of the websocket protocol */
 export type ProtocolVersion = typeof ProtocolV1;
 //# sourceMappingURL=protocolVersion.d.ts.map

package/dist/protocolVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"protocolVersion.d.ts","sourceRoot":"","sources":["../src/protocolVersion.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU,MAAM,CAAA;AAC7B,MAAM,MAAM,eAAe,GAAG,OAAO,UAAU,CAAA"}
+{"version":3,"file":"protocolVersion.d.ts","sourceRoot":"","sources":["../src/protocolVersion.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU,MAAM,CAAA;AAC7B,6CAA6C;AAC7C,MAAM,MAAM,eAAe,GAAG,OAAO,UAAU,CAAA"}

package/package.json

@@ -1,14 +1,13 @@
 {
   "name": "@automerge/automerge-repo-network-websocket",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "isomorphic node/browser Websocket network adapter for Automerge Repo",
   "peerDependencies": {
     "@automerge/automerge": "^2.1.0"
   },
-  "repository": "https://github.com/automerge/automerge-repo",
+  "repository": "https://github.com/automerge/automerge-repo/tree/master/packages/automerge-repo-network-websocket",
   "author": "Peter van Hardenberg <pvh@pvh.ca>",
   "license": "MIT",
-  "private": false,
   "type": "module",
   "main": "dist/index.js",
   "scripts": {
@@ -17,9 +16,9 @@
     "test": "mocha --no-warnings --experimental-specifier-resolution=node --exit"
   },
   "dependencies": {
-    "@automerge/automerge-repo": "^1.0.2",
+    "@automerge/automerge-repo": "^1.0.4",
     "cbor-x": "^1.3.0",
-    "eventemitter3": "^4.0.7",
+    "eventemitter3": "^5.0.1",
     "isomorphic-ws": "^5.0.0",
     "ws": "^8.7.0"
   },
@@ -34,5 +33,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c72b9ec33c3a1f7f39ad20cb4fa0d766afe42158"
+  "devDependencies": {
+    "@automerge/automerge": "^2.1.0"
+  },
+  "gitHead": "17fd5260f9af3e65da636fef084e8c04d6c4bed0"
 }

package/src/index.ts

@@ -1,2 +1,18 @@
+/**
+ * A `NetworkAdapter` which connects to a remote host via WebSockets
+ *
+ * The websocket protocol requires a server to be listening and a client to 
+ * connect to the server. To that end the {@link NodeWSServerAdapter} does not
+ * make outbound connections and instead listens on the provided socket for 
+ * new connections whilst the {@link BrowserWebSocketClientAdapter} makes an
+ * outbound connection to the provided socket.
+ *
+ * Note that the "browser" and "node" naming is a bit misleading, both
+ * implementations work in both the browser and on node via `isomorphic-ws`.
+ *
+ * @module
+ * */
 export { BrowserWebSocketClientAdapter } from "./BrowserWebSocketClientAdapter.js"
 export { NodeWSServerAdapter } from "./NodeWSServerAdapter.js"
+export type { FromClientMessage, FromServerMessage, JoinMessage, LeaveMessage, ErrorMessage, PeerMessage } from "./messages.js"
+export type { ProtocolVersion, ProtocolV1 } from "./protocolVersion.js"

package/src/messages.ts

@@ -1,31 +1,45 @@
 import { type Message, type PeerId } from "@automerge/automerge-repo"
 import { ProtocolVersion } from "./protocolVersion.js"
 
+/** The sender is disconnecting */
 export type LeaveMessage = {
   type: "leave"
   senderId: PeerId
 }
 
+/** Sent by the client to the server to tell the server the clients PeerID */
 export type JoinMessage = {
   type: "join"
+  /** The PeerID of the client */
   senderId: PeerId
+  /** The protocol version the client supports */
   supportedProtocolVersions: ProtocolVersion[]
 }
 
+/** Sent by the server in response to a "join" message to advertise the servers PeerID */
 export type PeerMessage = {
   type: "peer"
+  /** The PeerID of the server */
   senderId: PeerId
+  /** The protocol version the server selected for this connection */
   selectedProtocolVersion: ProtocolVersion
+  /** The PeerID of the client */
   targetId: PeerId
 }
 
+/** An error occurred. The other end will terminate the connection after sending this message */
 export type ErrorMessage = {
   type: "error"
+  /** The peer sending the message */
   senderId: PeerId
+  /** A description of the error*/
   message: string
+  /** The PeerID of the client */
   targetId: PeerId
 }
 
 // This adapter doesn't use NetworkAdapterMessage, it has its own idea of how to handle join/leave
+/** A message from the client to the server */
 export type FromClientMessage = JoinMessage | LeaveMessage | Message
+/** A message from the server to the client */
 export type FromServerMessage = PeerMessage | ErrorMessage | Message

package/src/protocolVersion.ts

@@ -1,2 +1,3 @@
 export const ProtocolV1 = "1"
+/** The versions of the websocket protocol */
 export type ProtocolVersion = typeof ProtocolV1

package/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "extends": "../../typedoc.base.json",
+    "entryPoints": ["src/index.ts"],
+    "readme": "none"
+}