@webext-core/messaging 2.0.0 → 2.0.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/lib/page.cjs CHANGED
@@ -74,6 +74,9 @@ __export(page_exports, {
74
74
  });
75
75
  module.exports = __toCommonJS(page_exports);
76
76
 
77
+ // src/window.ts
78
+ var import_uid = require("uid");
79
+
77
80
  // src/generic.ts
78
81
  var import_serialize_error = require("serialize-error");
79
82
  function defineGenericMessanging(config) {
@@ -169,10 +172,11 @@ var REQUEST_TYPE = "@webext-core/messaging/window";
169
172
  var RESPONSE_TYPE = "@webext-core/messaging/window/response";
170
173
  function defineWindowMessaging(config) {
171
174
  const namespace = config.namespace;
175
+ const instanceId = (0, import_uid.uid)();
172
176
  let removeAdditionalListeners = [];
173
177
  const sendWindowMessage = (message, targetOrigin) => new Promise((res) => {
174
178
  const responseListener = (event) => {
175
- if (event.data.type === RESPONSE_TYPE) {
179
+ if (event.data.type === RESPONSE_TYPE && event.data.namespace === namespace && event.data.instanceId !== instanceId && event.data.message.type === message.type) {
176
180
  res(event.data.response);
177
181
  removeResponseListener();
178
182
  }
@@ -181,7 +185,7 @@ function defineWindowMessaging(config) {
181
185
  removeAdditionalListeners.push(removeResponseListener);
182
186
  window.addEventListener("message", responseListener);
183
187
  window.postMessage(
184
- { type: REQUEST_TYPE, message, senderOrigin: location.origin, namespace },
188
+ { type: REQUEST_TYPE, message, senderOrigin: location.origin, namespace, instanceId },
185
189
  targetOrigin != null ? targetOrigin : "*"
186
190
  );
187
191
  });
@@ -191,10 +195,13 @@ function defineWindowMessaging(config) {
191
195
  },
192
196
  addRootListener(processMessage) {
193
197
  const listener = (event) => __async(this, null, function* () {
194
- if (event.data.type !== REQUEST_TYPE || event.data.namespace !== namespace)
198
+ if (event.data.type !== REQUEST_TYPE || event.data.namespace !== namespace || event.data.instanceId === instanceId)
195
199
  return;
196
200
  const response = yield processMessage(event.data.message);
197
- window.postMessage({ type: RESPONSE_TYPE, response }, event.data.senderOrigin);
201
+ window.postMessage(
202
+ { type: RESPONSE_TYPE, response, instanceId, message: event.data.message, namespace },
203
+ event.data.senderOrigin
204
+ );
198
205
  });
199
206
  window.addEventListener("message", listener);
200
207
  return () => window.removeEventListener("message", listener);
@@ -210,39 +217,51 @@ function defineWindowMessaging(config) {
210
217
  }
211
218
 
212
219
  // src/custom-event.ts
220
+ var import_uid2 = require("uid");
213
221
  var REQUEST_EVENT = "@webext-core/messaging/custom-events";
214
222
  var RESPONSE_EVENT = "@webext-core/messaging/custom-events/response";
215
223
  function defineCustomEventMessaging(config) {
216
224
  const namespace = config.namespace;
225
+ const instanceId = (0, import_uid2.uid)();
217
226
  const removeAdditionalListeners = [];
218
- const sendCustomMessage = (event) => new Promise((res) => {
227
+ const sendCustomMessage = (requestEvent) => new Promise((res) => {
219
228
  const responseListener = (e) => {
220
229
  const { detail } = e;
221
- res(detail);
230
+ if (detail.namespace === namespace && detail.instanceId !== instanceId && detail.message.type === requestEvent.detail.message.type) {
231
+ res(detail.response);
232
+ }
222
233
  };
223
234
  removeAdditionalListeners.push(
224
235
  () => window.removeEventListener(RESPONSE_EVENT, responseListener)
225
236
  );
226
- window.addEventListener(RESPONSE_EVENT, responseListener, { once: true });
227
- window.dispatchEvent(event);
237
+ window.addEventListener(RESPONSE_EVENT, responseListener);
238
+ window.dispatchEvent(requestEvent);
228
239
  });
229
240
  const messenger = defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
230
241
  sendMessage(message) {
231
- const event = new CustomEvent(REQUEST_EVENT, { detail: { message, namespace } });
232
- return sendCustomMessage(event);
242
+ const reqDetail = { message, namespace, instanceId };
243
+ const requestEvent = new CustomEvent(REQUEST_EVENT, {
244
+ // @ts-expect-error not exist cloneInto types because implemented only in Firefox.
245
+ detail: typeof cloneInto !== "undefined" ? cloneInto(reqDetail, window) : reqDetail
246
+ });
247
+ return sendCustomMessage(requestEvent);
233
248
  },
234
249
  addRootListener(processMessage) {
235
- const listener = (e) => __async(this, null, function* () {
250
+ const requestListener = (e) => __async(this, null, function* () {
236
251
  const _a = e, { detail } = _a, event = __objRest(_a, ["detail"]);
237
- if (detail.namespace !== namespace)
252
+ if (detail.namespace !== namespace || detail.instanceId === instanceId)
238
253
  return;
239
254
  const message = __spreadProps(__spreadValues({}, detail.message), { event });
240
255
  const response = yield processMessage(message);
241
- const responseEvent = new CustomEvent(RESPONSE_EVENT, { detail: response });
256
+ const resDetail = { response, message, instanceId, namespace };
257
+ const responseEvent = new CustomEvent(RESPONSE_EVENT, {
258
+ // @ts-expect-error not exist cloneInto types because implemented only in Firefox.
259
+ detail: typeof cloneInto !== "undefined" ? cloneInto(resDetail, window) : resDetail
260
+ });
242
261
  window.dispatchEvent(responseEvent);
243
262
  });
244
- window.addEventListener(REQUEST_EVENT, listener);
245
- return () => window.removeEventListener(REQUEST_EVENT, listener);
263
+ window.addEventListener(REQUEST_EVENT, requestListener);
264
+ return () => window.removeEventListener(REQUEST_EVENT, requestListener);
246
265
  }
247
266
  }));
248
267
  return __spreadProps(__spreadValues({}, messenger), {
package/lib/page.d.ts CHANGED
@@ -35,6 +35,9 @@ type WindowMessenger<TProtocolMap extends Record<string, any>> = GenericMessenge
35
35
  * websiteMessenger.onMessage("initInjectedScript", (...) => {
36
36
  * // ...
37
37
  * })
38
+ *
39
+ * @link Spec diagrams
40
+ * https://mermaid.live/edit#pako:eNqVlG9v2jAQxr-KZamvGv7YyYBYVSTGWgmpwAs6VZqQJpMc1BOxM8fZoIjvPieBACUVLC8SO3ru7vc4l9viUEWAGU7hdwYyhG-CLzWPZxLZa67WaKCkAWka01CLxDzMdSsobkKmhtsAUuy2SPIY0oSHwNBCKbQrMyRcGxGKhEuDbAT5qSTiKVJyBGnKl_CJKgUZ5br8eaa0-yPaUP6C0EDUeoX5VBi4hKP_A0dvgqM3wvWlMm-gi-Nb15ybe4k25_oTNPcmNPcKWrm8uzvWRF_Ld2NlAKk_oA_FnCodQ4PJaPR9PBz0X4aTMXp6nrwW6NP-6BH1p-j58enlkNsCoXKVX9WnbATB_f6AWcHWMpsE2AwnQi7JDNeFNNb7fmFILKXSlu-vLILP1HnOUkv3uCdqDemlOAgaVRWWS2phqjoXluipJVJriX6wRE8s0auWSGWJXLdEjpZovSV6ZqlcHjtBoVDFcSZFyG0LrIQ85D9rCfqhJcbnYUIWHRGJxQK0HRbHBrPJsINj0DEXkR0z2zz5DNs_I4YZZnYZwYJnK5ND7qyUZ0ZNNzLEzOgMHKxVtnzDbMFXqd1lSWTr7WdU9db2P2ZbvMasQYjX9AnteaRN3HbP7XgO3mBG3U6z533p-W637bue5-4c_K6UTUGbpOtT36edLvXaLu06GCJhlB6Vc7EYj0WJH4U-p9r9Aynbsqc
38
41
  */
39
42
  declare function defineWindowMessaging<TProtocolMap extends Record<string, any> = Record<string, any>>(config: WindowMessagingConfig): WindowMessenger<TProtocolMap>;
40
43
 
@@ -80,6 +83,9 @@ type CustomEventMessenger<TProtocolMap extends Record<string, any>> = GenericMes
80
83
  * websiteMessenger.onMessage("initInjectedScript", (...) => {
81
84
  * // ...
82
85
  * })
86
+ *
87
+ * * @link Spec diagrams
88
+ * https://mermaid.live/edit#pako:eNqVlG9v2jAQxr-KZamvGv7YyYBYVSTGWgmpwAs6VZqQJpMc1BOxM8fZoIjvPieBACUVLC8SO3ru7vc4l9viUEWAGU7hdwYyhG-CLzWPZxLZa67WaKCkAWka01CLxDzMdSsobkKmhtsAUuy2SPIY0oSHwNBCKbQrMyRcGxGKhEuDbAT5qSTiKVJyBGnKl_CJKgUZ5br8eaa0-yPaUP6C0EDUeoX5VBi4hKP_A0dvgqM3wvWlMm-gi-Nb15ybe4k25_oTNPcmNPcKWrm8uzvWRF_Ld2NlAKk_oA_FnCodQ4PJaPR9PBz0X4aTMXp6nrwW6NP-6BH1p-j58enlkNsCoXKVX9WnbATB_f6AWcHWMpsE2AwnQi7JDNeFNNb7fmFILKXSlu-vLILP1HnOUkv3uCdqDemlOAgaVRWWS2phqjoXluipJVJriX6wRE8s0auWSGWJXLdEjpZovSV6ZqlcHjtBoVDFcSZFyG0LrIQ85D9rCfqhJcbnYUIWHRGJxQK0HRbHBrPJsINj0DEXkR0z2zz5DNs_I4YZZnYZwYJnK5ND7qyUZ0ZNNzLEzOgMHKxVtnzDbMFXqd1lSWTr7WdU9db2P2ZbvMasQYjX9AnteaRN3HbP7XgO3mBG3U6z533p-W637bue5-4c_K6UTUGbpOtT36edLvXaLu06GCJhlB6Vc7EYj0WJH4U-p9r9Aynbsqc
83
89
  */
84
90
  declare function defineCustomEventMessaging<TProtocolMap extends Record<string, any> = Record<string, any>>(config: CustomEventMessagingConfig): CustomEventMessenger<TProtocolMap>;
85
91
 
@@ -78,6 +78,23 @@ var webExtCoreMessaging = (() => {
78
78
  defineWindowMessaging: () => defineWindowMessaging
79
79
  });
80
80
 
81
+ // ../../node_modules/uid/dist/index.mjs
82
+ var IDX = 256;
83
+ var HEX = [];
84
+ var SIZE = 256;
85
+ var BUFFER;
86
+ while (IDX--)
87
+ HEX[IDX] = (IDX + 256).toString(16).substring(1);
88
+ function uid(len) {
89
+ var i = 0, tmp = len || 11;
90
+ if (!BUFFER || IDX + tmp > SIZE * 2) {
91
+ for (BUFFER = "", IDX = 0; i < SIZE; i++) {
92
+ BUFFER += HEX[Math.random() * 256 | 0];
93
+ }
94
+ }
95
+ return BUFFER.substring(IDX, IDX++ + tmp);
96
+ }
97
+
81
98
  // ../../node_modules/serialize-error/error-constructors.js
82
99
  var list = [
83
100
  // Native ES errors https://262.ecma-international.org/12.0/#sec-well-known-intrinsic-objects
@@ -360,10 +377,11 @@ var webExtCoreMessaging = (() => {
360
377
  var RESPONSE_TYPE = "@webext-core/messaging/window/response";
361
378
  function defineWindowMessaging(config) {
362
379
  const namespace = config.namespace;
380
+ const instanceId = uid();
363
381
  let removeAdditionalListeners = [];
364
382
  const sendWindowMessage = (message, targetOrigin) => new Promise((res) => {
365
383
  const responseListener = (event) => {
366
- if (event.data.type === RESPONSE_TYPE) {
384
+ if (event.data.type === RESPONSE_TYPE && event.data.namespace === namespace && event.data.instanceId !== instanceId && event.data.message.type === message.type) {
367
385
  res(event.data.response);
368
386
  removeResponseListener();
369
387
  }
@@ -372,7 +390,7 @@ var webExtCoreMessaging = (() => {
372
390
  removeAdditionalListeners.push(removeResponseListener);
373
391
  window.addEventListener("message", responseListener);
374
392
  window.postMessage(
375
- { type: REQUEST_TYPE, message, senderOrigin: location.origin, namespace },
393
+ { type: REQUEST_TYPE, message, senderOrigin: location.origin, namespace, instanceId },
376
394
  targetOrigin != null ? targetOrigin : "*"
377
395
  );
378
396
  });
@@ -382,10 +400,13 @@ var webExtCoreMessaging = (() => {
382
400
  },
383
401
  addRootListener(processMessage) {
384
402
  const listener = (event) => __async(this, null, function* () {
385
- if (event.data.type !== REQUEST_TYPE || event.data.namespace !== namespace)
403
+ if (event.data.type !== REQUEST_TYPE || event.data.namespace !== namespace || event.data.instanceId === instanceId)
386
404
  return;
387
405
  const response = yield processMessage(event.data.message);
388
- window.postMessage({ type: RESPONSE_TYPE, response }, event.data.senderOrigin);
406
+ window.postMessage(
407
+ { type: RESPONSE_TYPE, response, instanceId, message: event.data.message, namespace },
408
+ event.data.senderOrigin
409
+ );
389
410
  });
390
411
  window.addEventListener("message", listener);
391
412
  return () => window.removeEventListener("message", listener);
@@ -405,35 +426,46 @@ var webExtCoreMessaging = (() => {
405
426
  var RESPONSE_EVENT = "@webext-core/messaging/custom-events/response";
406
427
  function defineCustomEventMessaging(config) {
407
428
  const namespace = config.namespace;
429
+ const instanceId = uid();
408
430
  const removeAdditionalListeners = [];
409
- const sendCustomMessage = (event) => new Promise((res) => {
431
+ const sendCustomMessage = (requestEvent) => new Promise((res) => {
410
432
  const responseListener = (e) => {
411
433
  const { detail } = e;
412
- res(detail);
434
+ if (detail.namespace === namespace && detail.instanceId !== instanceId && detail.message.type === requestEvent.detail.message.type) {
435
+ res(detail.response);
436
+ }
413
437
  };
414
438
  removeAdditionalListeners.push(
415
439
  () => window.removeEventListener(RESPONSE_EVENT, responseListener)
416
440
  );
417
- window.addEventListener(RESPONSE_EVENT, responseListener, { once: true });
418
- window.dispatchEvent(event);
441
+ window.addEventListener(RESPONSE_EVENT, responseListener);
442
+ window.dispatchEvent(requestEvent);
419
443
  });
420
444
  const messenger = defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
421
445
  sendMessage(message) {
422
- const event = new CustomEvent(REQUEST_EVENT, { detail: { message, namespace } });
423
- return sendCustomMessage(event);
446
+ const reqDetail = { message, namespace, instanceId };
447
+ const requestEvent = new CustomEvent(REQUEST_EVENT, {
448
+ // @ts-expect-error not exist cloneInto types because implemented only in Firefox.
449
+ detail: typeof cloneInto !== "undefined" ? cloneInto(reqDetail, window) : reqDetail
450
+ });
451
+ return sendCustomMessage(requestEvent);
424
452
  },
425
453
  addRootListener(processMessage) {
426
- const listener = (e) => __async(this, null, function* () {
454
+ const requestListener = (e) => __async(this, null, function* () {
427
455
  const _a = e, { detail } = _a, event = __objRest(_a, ["detail"]);
428
- if (detail.namespace !== namespace)
456
+ if (detail.namespace !== namespace || detail.instanceId === instanceId)
429
457
  return;
430
458
  const message = __spreadProps(__spreadValues({}, detail.message), { event });
431
459
  const response = yield processMessage(message);
432
- const responseEvent = new CustomEvent(RESPONSE_EVENT, { detail: response });
460
+ const resDetail = { response, message, instanceId, namespace };
461
+ const responseEvent = new CustomEvent(RESPONSE_EVENT, {
462
+ // @ts-expect-error not exist cloneInto types because implemented only in Firefox.
463
+ detail: typeof cloneInto !== "undefined" ? cloneInto(resDetail, window) : resDetail
464
+ });
433
465
  window.dispatchEvent(responseEvent);
434
466
  });
435
- window.addEventListener(REQUEST_EVENT, listener);
436
- return () => window.removeEventListener(REQUEST_EVENT, listener);
467
+ window.addEventListener(REQUEST_EVENT, requestListener);
468
+ return () => window.removeEventListener(REQUEST_EVENT, requestListener);
437
469
  }
438
470
  }));
439
471
  return __spreadProps(__spreadValues({}, messenger), {
package/lib/page.js CHANGED
@@ -7,14 +7,16 @@ import {
7
7
  } from "./chunk-ALTBYIMW.js";
8
8
 
9
9
  // src/window.ts
10
+ import { uid } from "uid";
10
11
  var REQUEST_TYPE = "@webext-core/messaging/window";
11
12
  var RESPONSE_TYPE = "@webext-core/messaging/window/response";
12
13
  function defineWindowMessaging(config) {
13
14
  const namespace = config.namespace;
15
+ const instanceId = uid();
14
16
  let removeAdditionalListeners = [];
15
17
  const sendWindowMessage = (message, targetOrigin) => new Promise((res) => {
16
18
  const responseListener = (event) => {
17
- if (event.data.type === RESPONSE_TYPE) {
19
+ if (event.data.type === RESPONSE_TYPE && event.data.namespace === namespace && event.data.instanceId !== instanceId && event.data.message.type === message.type) {
18
20
  res(event.data.response);
19
21
  removeResponseListener();
20
22
  }
@@ -23,7 +25,7 @@ function defineWindowMessaging(config) {
23
25
  removeAdditionalListeners.push(removeResponseListener);
24
26
  window.addEventListener("message", responseListener);
25
27
  window.postMessage(
26
- { type: REQUEST_TYPE, message, senderOrigin: location.origin, namespace },
28
+ { type: REQUEST_TYPE, message, senderOrigin: location.origin, namespace, instanceId },
27
29
  targetOrigin != null ? targetOrigin : "*"
28
30
  );
29
31
  });
@@ -33,10 +35,13 @@ function defineWindowMessaging(config) {
33
35
  },
34
36
  addRootListener(processMessage) {
35
37
  const listener = (event) => __async(this, null, function* () {
36
- if (event.data.type !== REQUEST_TYPE || event.data.namespace !== namespace)
38
+ if (event.data.type !== REQUEST_TYPE || event.data.namespace !== namespace || event.data.instanceId === instanceId)
37
39
  return;
38
40
  const response = yield processMessage(event.data.message);
39
- window.postMessage({ type: RESPONSE_TYPE, response }, event.data.senderOrigin);
41
+ window.postMessage(
42
+ { type: RESPONSE_TYPE, response, instanceId, message: event.data.message, namespace },
43
+ event.data.senderOrigin
44
+ );
40
45
  });
41
46
  window.addEventListener("message", listener);
42
47
  return () => window.removeEventListener("message", listener);
@@ -52,39 +57,51 @@ function defineWindowMessaging(config) {
52
57
  }
53
58
 
54
59
  // src/custom-event.ts
60
+ import { uid as uid2 } from "uid";
55
61
  var REQUEST_EVENT = "@webext-core/messaging/custom-events";
56
62
  var RESPONSE_EVENT = "@webext-core/messaging/custom-events/response";
57
63
  function defineCustomEventMessaging(config) {
58
64
  const namespace = config.namespace;
65
+ const instanceId = uid2();
59
66
  const removeAdditionalListeners = [];
60
- const sendCustomMessage = (event) => new Promise((res) => {
67
+ const sendCustomMessage = (requestEvent) => new Promise((res) => {
61
68
  const responseListener = (e) => {
62
69
  const { detail } = e;
63
- res(detail);
70
+ if (detail.namespace === namespace && detail.instanceId !== instanceId && detail.message.type === requestEvent.detail.message.type) {
71
+ res(detail.response);
72
+ }
64
73
  };
65
74
  removeAdditionalListeners.push(
66
75
  () => window.removeEventListener(RESPONSE_EVENT, responseListener)
67
76
  );
68
- window.addEventListener(RESPONSE_EVENT, responseListener, { once: true });
69
- window.dispatchEvent(event);
77
+ window.addEventListener(RESPONSE_EVENT, responseListener);
78
+ window.dispatchEvent(requestEvent);
70
79
  });
71
80
  const messenger = defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
72
81
  sendMessage(message) {
73
- const event = new CustomEvent(REQUEST_EVENT, { detail: { message, namespace } });
74
- return sendCustomMessage(event);
82
+ const reqDetail = { message, namespace, instanceId };
83
+ const requestEvent = new CustomEvent(REQUEST_EVENT, {
84
+ // @ts-expect-error not exist cloneInto types because implemented only in Firefox.
85
+ detail: typeof cloneInto !== "undefined" ? cloneInto(reqDetail, window) : reqDetail
86
+ });
87
+ return sendCustomMessage(requestEvent);
75
88
  },
76
89
  addRootListener(processMessage) {
77
- const listener = (e) => __async(this, null, function* () {
90
+ const requestListener = (e) => __async(this, null, function* () {
78
91
  const _a = e, { detail } = _a, event = __objRest(_a, ["detail"]);
79
- if (detail.namespace !== namespace)
92
+ if (detail.namespace !== namespace || detail.instanceId === instanceId)
80
93
  return;
81
94
  const message = __spreadProps(__spreadValues({}, detail.message), { event });
82
95
  const response = yield processMessage(message);
83
- const responseEvent = new CustomEvent(RESPONSE_EVENT, { detail: response });
96
+ const resDetail = { response, message, instanceId, namespace };
97
+ const responseEvent = new CustomEvent(RESPONSE_EVENT, {
98
+ // @ts-expect-error not exist cloneInto types because implemented only in Firefox.
99
+ detail: typeof cloneInto !== "undefined" ? cloneInto(resDetail, window) : resDetail
100
+ });
84
101
  window.dispatchEvent(responseEvent);
85
102
  });
86
- window.addEventListener(REQUEST_EVENT, listener);
87
- return () => window.removeEventListener(REQUEST_EVENT, listener);
103
+ window.addEventListener(REQUEST_EVENT, requestListener);
104
+ return () => window.removeEventListener(REQUEST_EVENT, requestListener);
88
105
  }
89
106
  }));
90
107
  return __spreadProps(__spreadValues({}, messenger), {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@webext-core/messaging",
3
- "version": "2.0.0",
3
+ "version": "2.0.1",
4
4
  "description": "Light weight, type-safe wrapper around the web extension messaging APIs. Supports all browsers (Chrome, Firefox, Safari)",
5
5
  "license": "MIT",
6
6
  "keywords": [
@@ -60,8 +60,8 @@
60
60
  },
61
61
  "devDependencies": {
62
62
  "@types/webextension-polyfill": "^0.9.1",
63
- "@webext-core/fake-browser": "workspace:*",
64
- "tsconfig": "workspace:*"
63
+ "@webext-core/fake-browser": "1.3.1",
64
+ "tsconfig": "0.0.0"
65
65
  },
66
66
  "buildc": {
67
67
  "outDir": "lib"