@automerge/automerge-repo-network-messagechannel 1.0.19 → 1.1.0-alpha.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- import type { EventEmitter } from "eventemitter3";
1
+ import { EventEmitter } from "eventemitter3";
2
2
  export interface PortRefEvents {
3
3
  message: (event: MessageEvent) => void;
4
4
  close: () => void;
@@ -1 +1 @@
1
- {"version":3,"file":"MessagePortRef.d.ts","sourceRoot":"","sources":["../src/MessagePortRef.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAEjD,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAA;IACtC,KAAK,EAAE,MAAM,IAAI,CAAA;CAClB;AAED,MAAM,WAAW,cAAe,SAAQ,YAAY,CAAC,aAAa,CAAC;IACjE,KAAK,IAAI,IAAI,CAAA;IACb,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,YAAY,CAAC,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;IAC9D,OAAO,IAAI,OAAO,CAAA;CACnB"}
1
+ {"version":3,"file":"MessagePortRef.d.ts","sourceRoot":"","sources":["../src/MessagePortRef.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE5C,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAA;IACtC,KAAK,EAAE,MAAM,IAAI,CAAA;CAClB;AAED,MAAM,WAAW,cAAe,SAAQ,YAAY,CAAC,aAAa,CAAC;IACjE,KAAK,IAAI,IAAI,CAAA;IACb,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,YAAY,CAAC,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;IAC9D,OAAO,IAAI,OAAO,CAAA;CACnB"}
@@ -1 +1 @@
1
- {"version":3,"file":"StrongMessagePortRef.d.ts","sourceRoot":"","sources":["../src/StrongMessagePortRef.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEnE,qBAAa,oBACX,SAAQ,YAAY,CAAC,aAAa,CAClC,YAAW,cAAc;IAEb,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,WAAW;IAQrC,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,IAAI;IAIzD,KAAK,IAAI,IAAI;IAIb,OAAO,IAAI,OAAO;CAGnB"}
1
+ {"version":3,"file":"StrongMessagePortRef.d.ts","sourceRoot":"","sources":["../src/StrongMessagePortRef.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEnE,qBAAa,oBACX,SAAQ,YAAY,CAAC,aAAa,CAClC,YAAW,cAAc;IAEb,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,WAAW;IAQrC,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,IAAI;IAIzD,KAAK,IAAI,IAAI;IAIb,OAAO,IAAI,OAAO;CAInB"}
@@ -15,6 +15,7 @@ export class StrongMessagePortRef extends EventEmitter {
15
15
  this.port.start();
16
16
  }
17
17
  isAlive() {
18
+ /* c8 ignore next */
18
19
  return true;
19
20
  }
20
21
  }
@@ -1 +1 @@
1
- {"version":3,"file":"WeakMessagePortRef.d.ts","sourceRoot":"","sources":["../src/WeakMessagePortRef.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEnE,qBAAa,kBACX,SAAQ,YAAY,CAAC,aAAa,CAClC,YAAW,cAAc;IAEzB,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,cAAc,CAAQ;gBAElB,IAAI,EAAE,WAAW;IAU7B,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,IAAI;IAezD,KAAK,IAAI,IAAI;IAeb,OAAO,CAAC,WAAW;IAOnB,OAAO,IAAI,OAAO;CAYnB"}
1
+ {"version":3,"file":"WeakMessagePortRef.d.ts","sourceRoot":"","sources":["../src/WeakMessagePortRef.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEnE,qBAAa,kBACX,SAAQ,YAAY,CAAC,aAAa,CAClC,YAAW,cAAc;IAEzB,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,cAAc,CAAQ;gBAElB,IAAI,EAAE,WAAW;IAU7B,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,IAAI;IAezD,KAAK,IAAI,IAAI;IAeb,OAAO,CAAC,WAAW;IAOnB,OAAO,IAAI,OAAO;CAYnB"}
@@ -1,3 +1,4 @@
1
+ /* c8 ignore start */
1
2
  import { EventEmitter } from "eventemitter3";
2
3
  export class WeakMessagePortRef extends EventEmitter {
3
4
  weakRef;
@@ -52,3 +53,4 @@ export class WeakMessagePortRef extends EventEmitter {
52
53
  return true;
53
54
  }
54
55
  }
56
+ /* c8 ignore end */
package/dist/index.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
  *
6
6
  * @module
7
7
  */
8
- import { type RepoMessage, NetworkAdapter, type PeerId } from "@automerge/automerge-repo";
8
+ import { type RepoMessage, NetworkAdapter, type PeerId, PeerMetadata } from "@automerge/automerge-repo";
9
9
  import { MessagePortRef } from "./MessagePortRef.js";
10
10
  export declare class MessageChannelNetworkAdapter extends NetworkAdapter {
11
11
  #private;
@@ -13,9 +13,9 @@ export declare class MessageChannelNetworkAdapter extends NetworkAdapter {
13
13
  /** @hidden */
14
14
  messagePortRef: MessagePortRef;
15
15
  constructor(messagePort: MessagePort, config?: MessageChannelNetworkAdapterConfig);
16
- connect(peerId: PeerId): void;
16
+ connect(peerId: PeerId, peerMetadata: PeerMetadata): void;
17
17
  send(message: RepoMessage): void;
18
- announceConnection(peerId: PeerId): void;
18
+ announceConnection(peerId: PeerId, peerMetadata: PeerMetadata): void;
19
19
  disconnect(): void;
20
20
  }
21
21
  export interface MessageChannelNetworkAdapterConfig {
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EACL,KAAK,WAAW,EAChB,cAAc,EACd,KAAK,MAAM,EAEZ,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAOpD,qBAAa,4BAA6B,SAAQ,cAAc;;IAC9D,QAAQ,KAAK;IACb,cAAc;IACd,cAAc,EAAE,cAAc,CAAA;gBAI5B,WAAW,EAAE,WAAW,EACxB,MAAM,GAAE,kCAAuC;IAWjD,OAAO,CAAC,MAAM,EAAE,MAAM;IAgEtB,IAAI,CAAC,OAAO,EAAE,WAAW;IAmBzB,kBAAkB,CAAC,MAAM,EAAE,MAAM;IAQjC,UAAU;CAIX;AAED,MAAM,WAAW,kCAAkC;IACjD;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EACL,KAAK,WAAW,EAChB,cAAc,EACd,KAAK,MAAM,EAEX,YAAY,EACb,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAOpD,qBAAa,4BAA6B,SAAQ,cAAc;;IAC9D,QAAQ,KAAK;IACb,cAAc;IACd,cAAc,EAAE,cAAc,CAAA;gBAI5B,WAAW,EAAE,WAAW,EACxB,MAAM,GAAE,kCAAuC;IAWjD,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY;IAwElD,IAAI,CAAC,OAAO,EAAE,WAAW;IAmBzB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY;IAQ7D,UAAU;CAIX;AAED,MAAM,WAAW,kCAAkC;IACjD;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB"}
package/dist/index.js CHANGED
@@ -22,12 +22,13 @@ export class MessageChannelNetworkAdapter extends NetworkAdapter {
22
22
  ? new WeakMessagePortRef(messagePort)
23
23
  : new StrongMessagePortRef(messagePort);
24
24
  }
25
- connect(peerId) {
25
+ connect(peerId, peerMetadata) {
26
26
  log("messageport connecting");
27
27
  this.peerId = peerId;
28
+ this.peerMetadata = peerMetadata;
28
29
  this.messagePortRef.start();
29
30
  this.messagePortRef.addListener("message", (e) => {
30
- log("message port received", e.data);
31
+ log("message port received %o", e.data);
31
32
  const message = e.data;
32
33
  if ("targetId" in message && message.targetId !== this.peerId) {
33
34
  throw new Error("MessagePortNetwork should never receive messages for a different peer.");
@@ -35,15 +36,22 @@ export class MessageChannelNetworkAdapter extends NetworkAdapter {
35
36
  const { senderId, type } = message;
36
37
  switch (type) {
37
38
  case "arrive":
38
- this.messagePortRef.postMessage({
39
- senderId: this.peerId,
40
- targetId: senderId,
41
- type: "welcome",
42
- });
43
- this.announceConnection(senderId);
39
+ {
40
+ const { peerMetadata } = message;
41
+ this.messagePortRef.postMessage({
42
+ type: "welcome",
43
+ senderId: this.peerId,
44
+ peerMetadata: this.peerMetadata,
45
+ targetId: senderId,
46
+ });
47
+ this.announceConnection(senderId, peerMetadata);
48
+ }
44
49
  break;
45
50
  case "welcome":
46
- this.announceConnection(senderId);
51
+ {
52
+ const { peerMetadata } = message;
53
+ this.announceConnection(senderId, peerMetadata);
54
+ }
47
55
  break;
48
56
  default:
49
57
  if (!("data" in message)) {
@@ -87,12 +95,12 @@ export class MessageChannelNetworkAdapter extends NetworkAdapter {
87
95
  this.messagePortRef.postMessage(message);
88
96
  }
89
97
  }
90
- announceConnection(peerId) {
98
+ announceConnection(peerId, peerMetadata) {
91
99
  if (!this.#startupComplete) {
92
100
  this.#startupComplete = true;
93
101
  this.emit("ready", { network: this });
94
102
  }
95
- this.emit("peer-candidate", { peerId });
103
+ this.emit("peer-candidate", { peerId, peerMetadata });
96
104
  }
97
105
  disconnect() {
98
106
  // TODO
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@automerge/automerge-repo-network-messagechannel",
3
- "version": "1.0.19",
3
+ "version": "1.1.0-alpha.13",
4
4
  "description": "MessageChannel network adapter for Automerge Repo",
5
5
  "repository": "https://github.com/automerge/automerge-repo/tree/master/packages/automerge-repo-network-messagechannel",
6
6
  "author": "Peter van Hardenberg <pvh@pvh.ca>",
@@ -13,7 +13,9 @@
13
13
  "test": "vitest"
14
14
  },
15
15
  "dependencies": {
16
- "@automerge/automerge-repo": "^1.0.19"
16
+ "@automerge/automerge-repo": "1.1.0-alpha.13",
17
+ "debug": "^4.3.4",
18
+ "eventemitter3": "^5.0.1"
17
19
  },
18
20
  "watch": {
19
21
  "build": {
@@ -26,5 +28,5 @@
26
28
  "publishConfig": {
27
29
  "access": "public"
28
30
  },
29
- "gitHead": "7d28ca50dfa437ac6f7b1722b89b3f6844b90de7"
31
+ "gitHead": "f4ce1376d900ad98f00a638626be9611077460b5"
30
32
  }
@@ -1,4 +1,4 @@
1
- import type { EventEmitter } from "eventemitter3"
1
+ import { EventEmitter } from "eventemitter3"
2
2
 
3
3
  export interface PortRefEvents {
4
4
  message: (event: MessageEvent) => void
@@ -22,6 +22,7 @@ export class StrongMessagePortRef
22
22
  }
23
23
 
24
24
  isAlive(): boolean {
25
+ /* c8 ignore next */
25
26
  return true
26
27
  }
27
28
  }
@@ -1,3 +1,4 @@
1
+ /* c8 ignore start */
1
2
  import { EventEmitter } from "eventemitter3"
2
3
  import { PortRefEvents, MessagePortRef } from "./MessagePortRef.js"
3
4
 
@@ -68,3 +69,5 @@ export class WeakMessagePortRef
68
69
  return true
69
70
  }
70
71
  }
72
+
73
+ /* c8 ignore end */
package/src/index.ts CHANGED
@@ -10,6 +10,7 @@ import {
10
10
  NetworkAdapter,
11
11
  type PeerId,
12
12
  type Message,
13
+ PeerMetadata,
13
14
  } from "@automerge/automerge-repo"
14
15
  import { MessagePortRef } from "./MessagePortRef.js"
15
16
  import { StrongMessagePortRef } from "./StrongMessagePortRef.js"
@@ -37,14 +38,15 @@ export class MessageChannelNetworkAdapter extends NetworkAdapter {
37
38
  : new StrongMessagePortRef(messagePort)
38
39
  }
39
40
 
40
- connect(peerId: PeerId) {
41
+ connect(peerId: PeerId, peerMetadata: PeerMetadata) {
41
42
  log("messageport connecting")
42
43
  this.peerId = peerId
44
+ this.peerMetadata = peerMetadata
43
45
  this.messagePortRef.start()
44
46
  this.messagePortRef.addListener(
45
47
  "message",
46
48
  (e: { data: MessageChannelMessage }) => {
47
- log("message port received", e.data)
49
+ log("message port received %o", e.data)
48
50
 
49
51
  const message = e.data
50
52
  if ("targetId" in message && message.targetId !== this.peerId) {
@@ -57,15 +59,22 @@ export class MessageChannelNetworkAdapter extends NetworkAdapter {
57
59
 
58
60
  switch (type) {
59
61
  case "arrive":
60
- this.messagePortRef.postMessage({
61
- senderId: this.peerId,
62
- targetId: senderId,
63
- type: "welcome",
64
- })
65
- this.announceConnection(senderId)
62
+ {
63
+ const { peerMetadata } = message as ArriveMessage
64
+ this.messagePortRef.postMessage({
65
+ type: "welcome",
66
+ senderId: this.peerId,
67
+ peerMetadata: this.peerMetadata,
68
+ targetId: senderId,
69
+ })
70
+ this.announceConnection(senderId, peerMetadata)
71
+ }
66
72
  break
67
73
  case "welcome":
68
- this.announceConnection(senderId)
74
+ {
75
+ const { peerMetadata } = message as WelcomeMessage
76
+ this.announceConnection(senderId, peerMetadata)
77
+ }
69
78
  break
70
79
  default:
71
80
  if (!("data" in message)) {
@@ -120,12 +129,12 @@ export class MessageChannelNetworkAdapter extends NetworkAdapter {
120
129
  }
121
130
  }
122
131
 
123
- announceConnection(peerId: PeerId) {
132
+ announceConnection(peerId: PeerId, peerMetadata: PeerMetadata) {
124
133
  if (!this.#startupComplete) {
125
134
  this.#startupComplete = true
126
135
  this.emit("ready", { network: this })
127
136
  }
128
- this.emit("peer-candidate", { peerId })
137
+ this.emit("peer-candidate", { peerId, peerMetadata })
129
138
  }
130
139
 
131
140
  disconnect() {
@@ -153,6 +162,9 @@ type ArriveMessage = {
153
162
  /** The peer ID of the sender of this message */
154
163
  senderId: PeerId
155
164
 
165
+ /** The peer metadata of the sender of this message */
166
+ peerMetadata: PeerMetadata
167
+
156
168
  /** Arrive messages don't have a targetId */
157
169
  targetId: never
158
170
  }
@@ -164,6 +176,9 @@ type WelcomeMessage = {
164
176
  /** The peer ID of the recipient sender this message */
165
177
  senderId: PeerId
166
178
 
179
+ /** The peer metadata of the sender of this message */
180
+ peerMetadata: PeerMetadata
181
+
167
182
  /** The peer ID of the recipient of this message */
168
183
  targetId: PeerId
169
184
  }