@design.estate/dees-comms 1.0.32 → 1.1.1
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.
- package/dist_bundle/bundle.js +9 -9
- package/dist_bundle/bundle.js.map +1 -1
- package/dist_bundle/bundle.js.third-party-notices.json +408 -0
- package/dist_bundle/bundle.js.third-party-notices.txt +968 -0
- package/dist_ts/00_commitinfo_data.js +2 -2
- package/dist_ts/dees-comms.classes.deescomms.d.ts +62 -2
- package/dist_ts/dees-comms.classes.deescomms.js +210 -20
- package/package.json +6 -6
- package/readme.md +71 -70
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/dees-comms.classes.deescomms.ts +305 -19
- package/readme.hints.md +0 -1
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@design.estate/dees-comms',
|
|
6
|
-
version: '1.
|
|
6
|
+
version: '1.1.1',
|
|
7
7
|
description: 'A communications module for enabling DOM-based messaging and synchronization across browser tabs and workers.'
|
|
8
8
|
};
|
|
9
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
9
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSwyQkFBMkI7SUFDakMsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLCtHQUErRztDQUM3SCxDQUFBIn0=
|
|
@@ -1,12 +1,43 @@
|
|
|
1
1
|
import * as plugins from './dees-comms.plugins.js';
|
|
2
|
+
export interface IDeesCommsOptions {
|
|
3
|
+
/**
|
|
4
|
+
* The channel this instance talks on. Instances hear each other only when
|
|
5
|
+
* they use the same name, in any tab, frame or worker of the same origin.
|
|
6
|
+
* Defaults to `DeesComms.defaultChannelName`, the channel every instance
|
|
7
|
+
* used before names existed.
|
|
8
|
+
*/
|
|
9
|
+
channelName?: string;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Receives the payload of one typed event, and the event itself.
|
|
13
|
+
*/
|
|
14
|
+
export type TDeesCommsEventHandler<T extends plugins.typedrequestInterfaces.ITypedEvent<unknown>> = (payloadArg: T['payload'], eventArg: T) => void | Promise<void>;
|
|
15
|
+
export interface IDeesCommsSubscription {
|
|
16
|
+
/**
|
|
17
|
+
* Stops this subscription. An event that is being delivered right now does
|
|
18
|
+
* not reach it any more; calling it again does nothing.
|
|
19
|
+
*/
|
|
20
|
+
unsubscribe(): void;
|
|
21
|
+
}
|
|
2
22
|
/**
|
|
3
23
|
* a comm class for client side communication between workers and tabs.
|
|
4
24
|
*/
|
|
5
25
|
export declare class DeesComms {
|
|
6
|
-
|
|
26
|
+
/**
|
|
27
|
+
* The channel of every instance that is not given a name. Code that talks
|
|
28
|
+
* to other code on it, like a service worker and its pages, keeps working
|
|
29
|
+
* unchanged; an application gives its own messages a name of its own.
|
|
30
|
+
*/
|
|
31
|
+
static readonly defaultChannelName = "dees-comms";
|
|
32
|
+
readonly channelName: string;
|
|
33
|
+
private readonly channel;
|
|
34
|
+
private readonly eventHandlers;
|
|
35
|
+
private hasTypedHandlers;
|
|
36
|
+
private closed;
|
|
37
|
+
private closing;
|
|
7
38
|
typedrouter: plugins.typedrequest.TypedRouter<plugins.typedrequestInterfaces.ITypedRequest>;
|
|
8
39
|
typedtarget: plugins.typedrequest.TypedTarget;
|
|
9
|
-
constructor();
|
|
40
|
+
constructor(optionsArg?: IDeesCommsOptions);
|
|
10
41
|
/**
|
|
11
42
|
* creates a typedrequest with this classes postMessage as postMethod
|
|
12
43
|
*/
|
|
@@ -19,4 +50,33 @@ export declare class DeesComms {
|
|
|
19
50
|
* subscribe to messages
|
|
20
51
|
*/
|
|
21
52
|
createTypedHandler<T extends plugins.typedrequestInterfaces.ITypedRequest>(methodArg: T['method'], handlerFunction: plugins.typedrequest.THandlerFunction<T>): Promise<void>;
|
|
53
|
+
/**
|
|
54
|
+
* Sends a typed event to every other instance on this channel and expects
|
|
55
|
+
* no answer. The instance that sends it does not receive it; any other
|
|
56
|
+
* instance on the same channel does, in this context or another one.
|
|
57
|
+
*/
|
|
58
|
+
broadcast<T extends plugins.typedrequestInterfaces.ITypedEvent<unknown>>(nameArg: T['name'], payloadArg: T['payload']): Promise<void>;
|
|
59
|
+
/**
|
|
60
|
+
* Calls the handler for every typed event of that name another instance
|
|
61
|
+
* broadcasts on this channel. Handlers run in the order they subscribed; one
|
|
62
|
+
* that throws or rejects is reported and does not keep the others from
|
|
63
|
+
* running.
|
|
64
|
+
*/
|
|
65
|
+
subscribe<T extends plugins.typedrequestInterfaces.ITypedEvent<unknown>>(nameArg: T['name'], handlerArg: TDeesCommsEventHandler<T>): IDeesCommsSubscription;
|
|
66
|
+
/**
|
|
67
|
+
* Closes the channel. Nothing is received from then on, every subscription
|
|
68
|
+
* ends, and sending, broadcasting or subscribing throws. A typed request
|
|
69
|
+
* still waiting for its response when the channel closes cannot receive it
|
|
70
|
+
* and ends with its own timeout. Closing again does nothing.
|
|
71
|
+
*/
|
|
72
|
+
close(): Promise<void>;
|
|
73
|
+
/**
|
|
74
|
+
* In Node.js an instance keeps its process alive while something listens on
|
|
75
|
+
* it, as a MessagePort with a message listener does: a subscription, or a
|
|
76
|
+
* typed handler it created. One nobody listens on lets the process end.
|
|
77
|
+
*/
|
|
78
|
+
private holdProcessWhileListened;
|
|
79
|
+
private assertOpen;
|
|
80
|
+
private receive;
|
|
81
|
+
private dispatch;
|
|
22
82
|
}
|
|
@@ -1,34 +1,103 @@
|
|
|
1
1
|
import * as plugins from './dees-comms.plugins.js';
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
const isProcessHolding = (channelArg) => 'ref' in channelArg &&
|
|
3
|
+
typeof channelArg.ref === 'function' &&
|
|
4
|
+
'unref' in channelArg &&
|
|
5
|
+
typeof channelArg.unref === 'function';
|
|
6
|
+
/**
|
|
7
|
+
* Opens a channel that hands every message it receives to `receiveArg` as the
|
|
8
|
+
* message itself: the platform's BroadcastChannel delivers a MessageEvent, the
|
|
9
|
+
* polyfill delivers the message.
|
|
10
|
+
*/
|
|
11
|
+
const openChannel = (nameArg, receiveArg) => {
|
|
12
|
+
if (typeof globalThis.BroadcastChannel === 'function') {
|
|
13
|
+
const channel = new globalThis.BroadcastChannel(nameArg);
|
|
14
|
+
channel.onmessage = (eventArg) => {
|
|
15
|
+
receiveArg(eventArg.data);
|
|
16
|
+
};
|
|
17
|
+
const processHolding = isProcessHolding(channel) ? channel : null;
|
|
18
|
+
// an open channel alone does not keep a Node.js process running
|
|
19
|
+
processHolding?.unref();
|
|
20
|
+
return {
|
|
21
|
+
post: async (messageArg) => {
|
|
22
|
+
channel.postMessage(messageArg);
|
|
23
|
+
},
|
|
24
|
+
close: async () => {
|
|
25
|
+
channel.close();
|
|
26
|
+
},
|
|
27
|
+
holdProcess: (holdArg) => {
|
|
28
|
+
if (holdArg) {
|
|
29
|
+
processHolding?.ref();
|
|
30
|
+
}
|
|
31
|
+
else {
|
|
32
|
+
processHolding?.unref();
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
const channel = new plugins.BroadCastChannelPolyfill(nameArg);
|
|
38
|
+
channel.onmessage = (messageArg) => {
|
|
39
|
+
receiveArg(messageArg);
|
|
40
|
+
};
|
|
41
|
+
return {
|
|
42
|
+
post: (messageArg) => channel.postMessage(messageArg),
|
|
43
|
+
close: () => channel.close(),
|
|
44
|
+
// the polyfill stands in only where the platform has no channel, which
|
|
45
|
+
// Node.js always has
|
|
46
|
+
holdProcess: () => undefined,
|
|
47
|
+
};
|
|
48
|
+
};
|
|
49
|
+
const isObject = (valueArg) => typeof valueArg === 'object' && valueArg !== null;
|
|
50
|
+
// `Object.hasOwn` is younger than some of the browsers the polyfill serves
|
|
51
|
+
const hasOwn = (objectArg, keyArg) => Object.prototype.hasOwnProperty.call(objectArg, keyArg);
|
|
52
|
+
/**
|
|
53
|
+
* The event a received message carries: `null` for a message that is no
|
|
54
|
+
* event, `'malformed'` for an envelope without a well-formed event in it.
|
|
55
|
+
*/
|
|
56
|
+
const eventOf = (messageArg) => {
|
|
57
|
+
if (!isObject(messageArg) || !hasOwn(messageArg, 'deesCommsEvent')) {
|
|
58
|
+
return null;
|
|
59
|
+
}
|
|
60
|
+
const event = messageArg.deesCommsEvent;
|
|
61
|
+
if (!isObject(event) ||
|
|
62
|
+
typeof event.name !== 'string' ||
|
|
63
|
+
typeof event.uniqueEventId !== 'string' ||
|
|
64
|
+
!hasOwn(event, 'payload')) {
|
|
65
|
+
return 'malformed';
|
|
66
|
+
}
|
|
67
|
+
return { name: event.name, uniqueEventId: event.uniqueEventId, payload: event.payload };
|
|
68
|
+
};
|
|
69
|
+
const createEventId = () => {
|
|
70
|
+
const bytes = globalThis.crypto.getRandomValues(new Uint8Array(16));
|
|
71
|
+
return Array.from(bytes, (byteArg) => byteArg.toString(16).padStart(2, '0')).join('');
|
|
72
|
+
};
|
|
6
73
|
/**
|
|
7
74
|
* a comm class for client side communication between workers and tabs.
|
|
8
75
|
*/
|
|
9
76
|
export class DeesComms {
|
|
77
|
+
/**
|
|
78
|
+
* The channel of every instance that is not given a name. Code that talks
|
|
79
|
+
* to other code on it, like a service worker and its pages, keeps working
|
|
80
|
+
* unchanged; an application gives its own messages a name of its own.
|
|
81
|
+
*/
|
|
82
|
+
static { this.defaultChannelName = 'dees-comms'; }
|
|
10
83
|
// receiving messages
|
|
11
|
-
constructor() {
|
|
12
|
-
this.
|
|
84
|
+
constructor(optionsArg = {}) {
|
|
85
|
+
this.eventHandlers = new Map();
|
|
86
|
+
this.hasTypedHandlers = false;
|
|
87
|
+
this.closed = false;
|
|
88
|
+
this.closing = null;
|
|
13
89
|
// sending messages
|
|
14
90
|
this.typedrouter = new plugins.typedrequest.TypedRouter();
|
|
15
91
|
this.typedtarget = new plugins.typedrequest.TypedTarget({
|
|
16
92
|
postMethodWithTypedRouter: async (messageArg) => {
|
|
17
|
-
this.postMessage(messageArg);
|
|
93
|
+
await this.postMessage(messageArg);
|
|
18
94
|
},
|
|
19
95
|
typedRouterRef: this.typedrouter,
|
|
20
96
|
});
|
|
21
|
-
this.
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
const response = await this.typedrouter.routeAndAddResponse(message, {
|
|
26
|
-
skipHooks: true,
|
|
27
|
-
});
|
|
28
|
-
if (response && !response.error) {
|
|
29
|
-
this.postMessage(response);
|
|
30
|
-
}
|
|
31
|
-
};
|
|
97
|
+
this.channelName = optionsArg.channelName ?? DeesComms.defaultChannelName;
|
|
98
|
+
this.channel = openChannel(this.channelName, (messageArg) => {
|
|
99
|
+
void this.receive(messageArg);
|
|
100
|
+
});
|
|
32
101
|
}
|
|
33
102
|
/**
|
|
34
103
|
* creates a typedrequest with this classes postMessage as postMethod
|
|
@@ -41,13 +110,134 @@ export class DeesComms {
|
|
|
41
110
|
* posts a typedrequestmessage
|
|
42
111
|
*/
|
|
43
112
|
async postMessage(messageArg) {
|
|
44
|
-
this.
|
|
113
|
+
this.assertOpen();
|
|
114
|
+
await this.channel.post(messageArg);
|
|
45
115
|
}
|
|
46
116
|
/**
|
|
47
117
|
* subscribe to messages
|
|
48
118
|
*/
|
|
49
119
|
async createTypedHandler(methodArg, handlerFunction) {
|
|
50
120
|
this.typedrouter.addTypedHandler(new plugins.typedrequest.TypedHandler(methodArg, handlerFunction));
|
|
121
|
+
this.hasTypedHandlers = true;
|
|
122
|
+
this.holdProcessWhileListened();
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Sends a typed event to every other instance on this channel and expects
|
|
126
|
+
* no answer. The instance that sends it does not receive it; any other
|
|
127
|
+
* instance on the same channel does, in this context or another one.
|
|
128
|
+
*/
|
|
129
|
+
async broadcast(nameArg, payloadArg) {
|
|
130
|
+
const message = {
|
|
131
|
+
deesCommsEvent: {
|
|
132
|
+
name: nameArg,
|
|
133
|
+
uniqueEventId: createEventId(),
|
|
134
|
+
payload: payloadArg,
|
|
135
|
+
},
|
|
136
|
+
};
|
|
137
|
+
await this.postMessage(message);
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* Calls the handler for every typed event of that name another instance
|
|
141
|
+
* broadcasts on this channel. Handlers run in the order they subscribed; one
|
|
142
|
+
* that throws or rejects is reported and does not keep the others from
|
|
143
|
+
* running.
|
|
144
|
+
*/
|
|
145
|
+
subscribe(nameArg, handlerArg) {
|
|
146
|
+
this.assertOpen();
|
|
147
|
+
// the name is the contract: what arrives under it is taken as its type,
|
|
148
|
+
// as a typed handler takes the request of its method
|
|
149
|
+
const handler = (payloadArg, eventArg) => handlerArg(payloadArg, eventArg);
|
|
150
|
+
let handlers = this.eventHandlers.get(nameArg);
|
|
151
|
+
if (!handlers) {
|
|
152
|
+
handlers = new Set();
|
|
153
|
+
this.eventHandlers.set(nameArg, handlers);
|
|
154
|
+
}
|
|
155
|
+
handlers.add(handler);
|
|
156
|
+
this.holdProcessWhileListened();
|
|
157
|
+
return {
|
|
158
|
+
unsubscribe: () => {
|
|
159
|
+
const current = this.eventHandlers.get(nameArg);
|
|
160
|
+
if (!current) {
|
|
161
|
+
return;
|
|
162
|
+
}
|
|
163
|
+
current.delete(handler);
|
|
164
|
+
if (current.size === 0) {
|
|
165
|
+
this.eventHandlers.delete(nameArg);
|
|
166
|
+
this.holdProcessWhileListened();
|
|
167
|
+
}
|
|
168
|
+
},
|
|
169
|
+
};
|
|
170
|
+
}
|
|
171
|
+
/**
|
|
172
|
+
* Closes the channel. Nothing is received from then on, every subscription
|
|
173
|
+
* ends, and sending, broadcasting or subscribing throws. A typed request
|
|
174
|
+
* still waiting for its response when the channel closes cannot receive it
|
|
175
|
+
* and ends with its own timeout. Closing again does nothing.
|
|
176
|
+
*/
|
|
177
|
+
async close() {
|
|
178
|
+
if (!this.closing) {
|
|
179
|
+
this.closed = true;
|
|
180
|
+
this.eventHandlers.clear();
|
|
181
|
+
this.closing = this.channel.close();
|
|
182
|
+
}
|
|
183
|
+
await this.closing;
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* In Node.js an instance keeps its process alive while something listens on
|
|
187
|
+
* it, as a MessagePort with a message listener does: a subscription, or a
|
|
188
|
+
* typed handler it created. One nobody listens on lets the process end.
|
|
189
|
+
*/
|
|
190
|
+
holdProcessWhileListened() {
|
|
191
|
+
if (this.closed) {
|
|
192
|
+
return;
|
|
193
|
+
}
|
|
194
|
+
this.channel.holdProcess(this.hasTypedHandlers || this.eventHandlers.size > 0);
|
|
195
|
+
}
|
|
196
|
+
assertOpen() {
|
|
197
|
+
if (this.closed) {
|
|
198
|
+
throw new Error(`DeesComms channel "${this.channelName}" is closed`);
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
async receive(messageArg) {
|
|
202
|
+
if (this.closed) {
|
|
203
|
+
return;
|
|
204
|
+
}
|
|
205
|
+
const event = eventOf(messageArg);
|
|
206
|
+
if (event === 'malformed') {
|
|
207
|
+
console.log('DeesComms received a malformed event');
|
|
208
|
+
return;
|
|
209
|
+
}
|
|
210
|
+
if (event) {
|
|
211
|
+
this.dispatch(event);
|
|
212
|
+
return;
|
|
213
|
+
}
|
|
214
|
+
// Skip hooks for broadcast-received messages to prevent infinite loops
|
|
215
|
+
// when traffic logging hooks are set up globally. The router validates
|
|
216
|
+
// the shape of what it is given.
|
|
217
|
+
const response = await this.typedrouter.routeAndAddResponse(messageArg, { skipHooks: true });
|
|
218
|
+
if (response && !response.error && !this.closed) {
|
|
219
|
+
await this.postMessage(response);
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
dispatch(eventArg) {
|
|
223
|
+
const handlers = this.eventHandlers.get(eventArg.name);
|
|
224
|
+
if (!handlers) {
|
|
225
|
+
return;
|
|
226
|
+
}
|
|
227
|
+
for (const handler of [...handlers]) {
|
|
228
|
+
// a handler that closed the channel ends the delivery, and one an
|
|
229
|
+
// earlier handler unsubscribed is not called any more
|
|
230
|
+
if (this.closed) {
|
|
231
|
+
return;
|
|
232
|
+
}
|
|
233
|
+
if (!handlers.has(handler)) {
|
|
234
|
+
continue;
|
|
235
|
+
}
|
|
236
|
+
void (async () => handler(eventArg.payload, eventArg))().catch((errorArg) => {
|
|
237
|
+
// the event's name and the failure, never its payload
|
|
238
|
+
console.error(`DeesComms: a handler of the event "${eventArg.name}" failed`, errorArg);
|
|
239
|
+
});
|
|
240
|
+
}
|
|
51
241
|
}
|
|
52
242
|
}
|
|
53
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
243
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"dees-comms.classes.deescomms.js","sourceRoot":"","sources":["../ts/dees-comms.classes.deescomms.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAgEnD,MAAM,gBAAgB,GAAG,CAAC,UAAkB,EAAwC,EAAE,CACpF,KAAK,IAAI,UAAU;IACnB,OAAO,UAAU,CAAC,GAAG,KAAK,UAAU;IACpC,OAAO,IAAI,UAAU;IACrB,OAAO,UAAU,CAAC,KAAK,KAAK,UAAU,CAAC;AAEzC;;;;GAIG;AACH,MAAM,WAAW,GAAG,CAClB,OAAe,EACf,UAAyC,EACtB,EAAE;IACrB,IAAI,OAAO,UAAU,CAAC,gBAAgB,KAAK,UAAU,EAAE,CAAC;QACtD,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACzD,OAAO,CAAC,SAAS,GAAG,CAAC,QAA+B,EAAE,EAAE;YACtD,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC;QACF,MAAM,cAAc,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;QAClE,gEAAgE;QAChE,cAAc,EAAE,KAAK,EAAE,CAAC;QACxB,OAAO;YACL,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBACzB,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;YAClC,CAAC;YACD,KAAK,EAAE,KAAK,IAAI,EAAE;gBAChB,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,CAAC;YACD,WAAW,EAAE,CAAC,OAAO,EAAE,EAAE;gBACvB,IAAI,OAAO,EAAE,CAAC;oBACZ,cAAc,EAAE,GAAG,EAAE,CAAC;gBACxB,CAAC;qBAAM,CAAC;oBACN,cAAc,EAAE,KAAK,EAAE,CAAC;gBAC1B,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,wBAAwB,CAAU,OAAO,CAAC,CAAC;IACvE,OAAO,CAAC,SAAS,GAAG,CAAC,UAAmB,EAAE,EAAE;QAC1C,UAAU,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC,CAAC;IACF,OAAO;QACL,IAAI,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC;QACrD,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE;QAC5B,uEAAuE;QACvE,qBAAqB;QACrB,WAAW,EAAE,GAAG,EAAE,CAAC,SAAS;KAC7B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,QAAiB,EAAuC,EAAE,CAC1E,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,CAAC;AAEpD,2EAA2E;AAC3E,MAAM,MAAM,GAAG,CAAC,SAAkC,EAAE,MAAc,EAAW,EAAE,CAC7E,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;AAE1D;;;GAGG;AACH,MAAM,OAAO,GAAG,CACd,UAAmB,EACuD,EAAE;IAC5E,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,gBAAgB,CAAC,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,KAAK,GAAG,UAAU,CAAC,cAAc,CAAC;IACxC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC;QAChB,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;QAC9B,OAAO,KAAK,CAAC,aAAa,KAAK,QAAQ;QACvC,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,EACzB,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;AAC1F,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,GAAW,EAAE;IACjC,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;IACpE,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACxF,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,SAAS;IACpB;;;;OAIG;aACoB,uBAAkB,GAAG,YAAY,AAAf,CAAgB;IAkBzD,qBAAqB;IACrB,YAAY,aAAgC,EAAE;QAf7B,kBAAa,GAAG,IAAI,GAAG,EAAoC,CAAC;QACrE,qBAAgB,GAAG,KAAK,CAAC;QACzB,WAAM,GAAG,KAAK,CAAC;QACf,YAAO,GAAyB,IAAI,CAAC;QAE7C,mBAAmB;QACZ,gBAAW,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;QACrD,gBAAW,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC;YACxD,yBAAyB,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC9C,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;YACrC,CAAC;YACD,cAAc,EAAE,IAAI,CAAC,WAAW;SACjC,CAAC,CAAC;QAID,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,IAAI,SAAS,CAAC,kBAAkB,CAAC;QAC1E,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,EAAE;YAC1D,KAAK,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,kBAAkB,CACvB,UAAuB;QAEvB,MAAM,YAAY,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QACzF,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,WAAW,CACtB,UAAa;QAEb,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,kBAAkB,CAC7B,SAAsB,EACtB,eAAyD;QAEzD,IAAI,CAAC,WAAW,CAAC,eAAe,CAC9B,IAAI,OAAO,CAAC,YAAY,CAAC,YAAY,CAAI,SAAS,EAAE,eAAe,CAAC,CACrE,CAAC;QACF,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC7B,IAAI,CAAC,wBAAwB,EAAE,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACpB,OAAkB,EAClB,UAAwB;QAExB,MAAM,OAAO,GAA2B;YACtC,cAAc,EAAE;gBACd,IAAI,EAAE,OAAO;gBACb,aAAa,EAAE,aAAa,EAAE;gBAC9B,OAAO,EAAE,UAAU;aACpB;SACF,CAAC;QACF,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACI,SAAS,CACd,OAAkB,EAClB,UAAqC;QAErC,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,wEAAwE;QACxE,qDAAqD;QACrD,MAAM,OAAO,GAAwB,CAAC,UAAU,EAAE,QAAQ,EAAE,EAAE,CAC5D,UAAU,CAAC,UAA0B,EAAE,QAAa,CAAC,CAAC;QACxD,IAAI,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC/C,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;YACrB,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC5C,CAAC;QACD,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACtB,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAChC,OAAO;YACL,WAAW,EAAE,GAAG,EAAE;gBAChB,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAChD,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,OAAO;gBACT,CAAC;gBACD,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBACxB,IAAI,OAAO,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;oBACvB,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;oBACnC,IAAI,CAAC,wBAAwB,EAAE,CAAC;gBAClC,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK;QAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;YACnB,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACtC,CAAC;QACD,MAAM,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACK,wBAAwB;QAC9B,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;IACjF,CAAC;IAEO,UAAU;QAChB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,CAAC,WAAW,aAAa,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,UAAmB;QACvC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;QAClC,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;YAC1B,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;YACpD,OAAO;QACT,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACrB,OAAO;QACT,CAAC;QACD,uEAAuE;QACvE,uEAAuE;QACvE,iCAAiC;QACjC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,mBAAmB,CACzD,UAA0D,EAC1D,EAAE,SAAS,EAAE,IAAI,EAAE,CACpB,CAAC;QACF,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAChD,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAEO,QAAQ,CAAC,QAA6D;QAC5E,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO;QACT,CAAC;QACD,KAAK,MAAM,OAAO,IAAI,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC;YACpC,kEAAkE;YAClE,sDAAsD;YACtD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAChB,OAAO;YACT,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC3B,SAAS;YACX,CAAC;YACD,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,QAAiB,EAAE,EAAE;gBACnF,sDAAsD;gBACtD,OAAO,CAAC,KAAK,CAAC,sCAAsC,QAAQ,CAAC,IAAI,UAAU,EAAE,QAAQ,CAAC,CAAC;YACzF,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@design.estate/dees-comms",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "A communications module for enabling DOM-based messaging and synchronization across browser tabs and workers.",
|
|
6
6
|
"main": "dist_ts/index.js",
|
|
@@ -9,11 +9,11 @@
|
|
|
9
9
|
"author": "Lossless GmbH",
|
|
10
10
|
"license": "MIT",
|
|
11
11
|
"devDependencies": {
|
|
12
|
-
"@git.zone/tsbuild": "^
|
|
13
|
-
"@git.zone/tsbundle": "^
|
|
14
|
-
"@git.zone/tsrun": "^
|
|
15
|
-
"@git.zone/tstest": "^3.
|
|
16
|
-
"@types/node": "^26.
|
|
12
|
+
"@git.zone/tsbuild": "^5.0.0",
|
|
13
|
+
"@git.zone/tsbundle": "^3.0.0",
|
|
14
|
+
"@git.zone/tsrun": "^3.0.1",
|
|
15
|
+
"@git.zone/tstest": "^6.3.2",
|
|
16
|
+
"@types/node": "^26.6.2"
|
|
17
17
|
},
|
|
18
18
|
"dependencies": {
|
|
19
19
|
"@api.global/typedrequest": "^8.0.3",
|
package/readme.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @design.estate/dees-comms
|
|
2
2
|
|
|
3
|
-
a
|
|
3
|
+
Typed messaging between the tabs, frames and workers of one origin over a BroadcastChannel: typed requests that expect an answer, and typed events that do not.
|
|
4
4
|
|
|
5
5
|
## Issue Reporting and Security
|
|
6
6
|
|
|
@@ -8,113 +8,114 @@ For reporting bugs, issues, or security vulnerabilities, please visit [community
|
|
|
8
8
|
|
|
9
9
|
## Install
|
|
10
10
|
|
|
11
|
-
To integrate `@design.estate/dees-comms` into your project, run the following command in your terminal:
|
|
12
|
-
|
|
13
11
|
```bash
|
|
14
12
|
pnpm add @design.estate/dees-comms
|
|
15
13
|
```
|
|
16
14
|
|
|
17
|
-
This will add the package to your project dependencies.
|
|
18
|
-
|
|
19
15
|
## Usage
|
|
20
16
|
|
|
21
|
-
|
|
17
|
+
### Channels
|
|
18
|
+
|
|
19
|
+
Every `DeesComms` instance talks on one BroadcastChannel. Instances hear each other only when they use the same channel name, in any tab, frame or worker of the same origin.
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { DeesComms } from '@design.estate/dees-comms';
|
|
23
|
+
|
|
24
|
+
// the default channel, 'dees-comms'
|
|
25
|
+
const comms = new DeesComms();
|
|
26
|
+
|
|
27
|
+
// a channel of this application's own
|
|
28
|
+
const appComms = new DeesComms({ channelName: 'my-app' });
|
|
29
|
+
|
|
30
|
+
console.log(DeesComms.defaultChannelName); // 'dees-comms'
|
|
31
|
+
console.log(appComms.channelName); // 'my-app'
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
An instance created without a name uses `DeesComms.defaultChannelName`, the channel every instance used before names existed. Other packages talk on it: `DomTools` of `@design.estate/dees-domtools` opens an instance on it, and the service worker of `@api.global/typedserver` exchanges its messages with its pages there. Give your application's messages a channel of their own, so that they neither reach nor disturb that traffic.
|
|
35
|
+
|
|
36
|
+
The platform's `BroadcastChannel` is used wherever there is one (browsers, workers, Node.js); elsewhere the [`broadcast-channel`](https://www.npmjs.com/package/broadcast-channel) package stands in for it.
|
|
22
37
|
|
|
23
|
-
###
|
|
38
|
+
### Typed requests
|
|
24
39
|
|
|
25
|
-
|
|
40
|
+
A typed request goes to every other instance on the channel; an instance with a handler for its method answers it.
|
|
26
41
|
|
|
27
42
|
```typescript
|
|
28
43
|
import { DeesComms } from '@design.estate/dees-comms';
|
|
44
|
+
import type { ITypedRequest } from '@api.global/typedrequest-interfaces';
|
|
29
45
|
|
|
30
|
-
interface
|
|
31
|
-
method: '
|
|
46
|
+
interface IGreetRequest extends ITypedRequest {
|
|
47
|
+
method: 'greet';
|
|
32
48
|
request: {
|
|
33
|
-
|
|
49
|
+
name: string;
|
|
34
50
|
};
|
|
35
51
|
response: {
|
|
36
52
|
reply: string;
|
|
37
53
|
};
|
|
38
54
|
}
|
|
39
|
-
```
|
|
40
55
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
56
|
+
// in one tab or worker
|
|
57
|
+
const answering = new DeesComms({ channelName: 'my-app' });
|
|
58
|
+
answering.createTypedHandler<IGreetRequest>('greet', async (request) => {
|
|
59
|
+
return { reply: `Hello ${request.name}, nice to meet you!` };
|
|
60
|
+
});
|
|
44
61
|
|
|
45
|
-
|
|
46
|
-
const
|
|
62
|
+
// in another one
|
|
63
|
+
const asking = new DeesComms({ channelName: 'my-app' });
|
|
64
|
+
const response = await asking.createTypedRequest<IGreetRequest>('greet').fire({ name: 'Alice' });
|
|
65
|
+
console.log(response.reply); // 'Hello Alice, nice to meet you!'
|
|
47
66
|
```
|
|
48
67
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
To send messages, you'll need to create a typed request. Let's assume we are sending a message that requires a response:
|
|
68
|
+
`postMessage()` posts a typed request object as it is; `typedrouter` and `typedtarget` are the `@api.global/typedrequest` router and target the instance routes with.
|
|
52
69
|
|
|
53
|
-
|
|
54
|
-
// Creating a typed request
|
|
55
|
-
const myTypedRequest = myDeesComms.createTypedRequest<IMyMessage>('myMethod');
|
|
70
|
+
### Typed events
|
|
56
71
|
|
|
57
|
-
|
|
58
|
-
const response = await myTypedRequest.fire({
|
|
59
|
-
someData: 'Hello, World!',
|
|
60
|
-
});
|
|
61
|
-
console.log('Received response:', response.reply);
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
### Receiving and Handling Messages
|
|
65
|
-
|
|
66
|
-
To handle incoming messages, you need to define handlers for the types of messages you expect to receive.
|
|
72
|
+
A typed event is sent to every other instance on the channel and expects no answer. It is declared as an `ITypedEvent` of `@api.global/typedrequest-interfaces`: its `name` is the contract, its `payload` is what travels.
|
|
67
73
|
|
|
68
74
|
```typescript
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
reply: 'Message received loud and clear!'
|
|
75
|
+
import { DeesComms } from '@design.estate/dees-comms';
|
|
76
|
+
import type { ITypedEvent } from '@api.global/typedrequest-interfaces';
|
|
77
|
+
|
|
78
|
+
interface ISettingsChangedEvent extends ITypedEvent<{ section: string }> {
|
|
79
|
+
name: 'settingsChanged';
|
|
80
|
+
uniqueEventId: string;
|
|
81
|
+
payload: {
|
|
82
|
+
section: string;
|
|
78
83
|
};
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
// in every tab that has to follow
|
|
87
|
+
const listening = new DeesComms({ channelName: 'my-app' });
|
|
88
|
+
const subscription = listening.subscribe<ISettingsChangedEvent>('settingsChanged', (payload, event) => {
|
|
89
|
+
console.log(`settings changed in ${payload.section}`, event.uniqueEventId);
|
|
79
90
|
});
|
|
80
|
-
```
|
|
81
91
|
|
|
82
|
-
|
|
92
|
+
// in the tab where it happened
|
|
93
|
+
const telling = new DeesComms({ channelName: 'my-app' });
|
|
94
|
+
await telling.broadcast<ISettingsChangedEvent>('settingsChanged', { section: 'profile' });
|
|
83
95
|
|
|
84
|
-
|
|
96
|
+
// later
|
|
97
|
+
subscription.unsubscribe();
|
|
98
|
+
```
|
|
85
99
|
|
|
86
|
-
|
|
100
|
+
- The instance that broadcasts an event does not receive it; every other instance on the channel does, in the same context or another one.
|
|
101
|
+
- `broadcast()` gives every event a new `uniqueEventId`.
|
|
102
|
+
- Handlers of one name run in the order they subscribed. A handler that throws or rejects is reported with `console.error`, naming the event and the error but never the payload, and does not keep the others from running. A handler that an earlier one unsubscribes during the same event is not called for it.
|
|
103
|
+
- Events and typed requests stay apart: an event never reaches a typed handler, and a typed request never reaches a subscription, whatever their names.
|
|
104
|
+
- An instance of 1.0.32 routes every message it receives as a typed request; on the platform's own BroadcastChannel, `@api.global/typedrequest` 8 then logs `TypedRouter received a malformed request DTO` for every event. That is one more reason to broadcast on a channel of your application's own.
|
|
87
105
|
|
|
88
|
-
|
|
106
|
+
### Closing
|
|
89
107
|
|
|
90
108
|
```typescript
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
interface IGreetRequest {
|
|
94
|
-
method: 'greet';
|
|
95
|
-
request: {
|
|
96
|
-
name: string;
|
|
97
|
-
};
|
|
98
|
-
response: {
|
|
99
|
-
reply: string;
|
|
100
|
-
};
|
|
101
|
-
}
|
|
109
|
+
await comms.close();
|
|
110
|
+
```
|
|
102
111
|
|
|
103
|
-
|
|
112
|
+
A closed instance receives nothing: its subscriptions end and its typed handlers are no longer asked. `postMessage()`, `broadcast()` and the typed requests it fires reject, and `subscribe()` throws. A typed request that is still waiting for its response when the channel closes cannot receive it and ends with its own timeout. Closing again does nothing.
|
|
104
113
|
|
|
105
|
-
|
|
106
|
-
appDeesComms.createTypedHandler<IGreetRequest>('greet', async (request) => {
|
|
107
|
-
console.log(`Greetings received from ${request.name}`);
|
|
108
|
-
return { reply: `Hello ${request.name}, nice to meet you!` };
|
|
109
|
-
});
|
|
114
|
+
In Node.js an instance keeps the process alive only while something listens on it, as a `MessagePort` with a message listener does: while it has a subscription, or once it has created a typed handler. An instance nobody listens on, such as the one `@design.estate/dees-domtools` opens on import, lets the process end. An unsubscribed or closed instance lets it end too, so close every instance with a typed handler that a test or a script opens. In browsers and workers nothing changes.
|
|
110
115
|
|
|
111
|
-
|
|
112
|
-
const greetRequest = appDeesComms.createTypedRequest<IGreetRequest>('greet');
|
|
113
|
-
const response = await greetRequest.fire({ name: 'Alice' });
|
|
114
|
-
console.log(response.reply); // Expected output: "Hello Alice, nice to meet you!"
|
|
115
|
-
```
|
|
116
|
+
### What travels
|
|
116
117
|
|
|
117
|
-
|
|
118
|
+
Requests, responses and events are copied with the structured clone algorithm, so they carry data, not functions or class instances. A BroadcastChannel is confined to its origin, but every script of that origin can listen on a channel whose name it knows: send no secrets, and nothing that identifies a person, on it.
|
|
118
119
|
|
|
119
120
|
## License and Legal Information
|
|
120
121
|
|
package/ts/00_commitinfo_data.ts
CHANGED