@webext-core/messaging 2.0.2 → 2.1.0

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.
@@ -68,17 +68,18 @@ function defineGenericMessanging(config) {
68
68
  return {
69
69
  sendMessage(type, data, ...args) {
70
70
  return __async(this, null, function* () {
71
- var _a2, _b;
72
- const message = {
71
+ var _a2, _b, _c, _d;
72
+ const _message = {
73
73
  id: getNextId(),
74
74
  type,
75
75
  data,
76
76
  timestamp: Date.now()
77
77
  };
78
- (_a2 = config.logger) == null ? void 0 : _a2.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message, ...args);
78
+ const message = (_b = yield (_a2 = config.verifyMessageData) == null ? void 0 : _a2.call(config, _message)) != null ? _b : _message;
79
+ (_c = config.logger) == null ? void 0 : _c.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message, ...args);
79
80
  const response = yield config.sendMessage(message, ...args);
80
81
  const { res, err } = response != null ? response : { err: new Error("No response") };
81
- (_b = config.logger) == null ? void 0 : _b.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
82
+ (_d = config.logger) == null ? void 0 : _d.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
82
83
  if (err != null)
83
84
  throw deserializeError(err);
84
85
  return res;
@@ -93,6 +94,9 @@ function defineGenericMessanging(config) {
93
94
  removeRootListener = config.addRootListener((message) => {
94
95
  var _a3, _b2;
95
96
  if (typeof message.type != "string" || typeof message.timestamp !== "number") {
97
+ if (config.breakError) {
98
+ return;
99
+ }
96
100
  const err = Error(
97
101
  `[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(
98
102
  message
@@ -107,6 +111,9 @@ function defineGenericMessanging(config) {
107
111
  return;
108
112
  const res = listener(message);
109
113
  return Promise.resolve(res).then((res2) => {
114
+ var _a4, _b3;
115
+ return (_b3 = (_a4 = config.verifyMessageData) == null ? void 0 : _a4.call(config, res2)) != null ? _b3 : res2;
116
+ }).then((res2) => {
110
117
  var _a4;
111
118
  (_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
112
119
  return { res: res2 };
@@ -61,6 +61,12 @@ interface BaseMessagingConfig {
61
61
  * @default console
62
62
  */
63
63
  logger?: Logger;
64
+ /**
65
+ * Whether to break an error when an invalid message is received.
66
+ *
67
+ * @default undefined
68
+ */
69
+ breakError?: boolean;
64
70
  }
65
71
  interface NamespaceMessagingConfig extends BaseMessagingConfig {
66
72
  /**
package/lib/index.cjs CHANGED
@@ -92,17 +92,18 @@ function defineGenericMessanging(config) {
92
92
  return {
93
93
  sendMessage(type, data, ...args) {
94
94
  return __async(this, null, function* () {
95
- var _a2, _b;
96
- const message = {
95
+ var _a2, _b, _c, _d;
96
+ const _message = {
97
97
  id: getNextId(),
98
98
  type,
99
99
  data,
100
100
  timestamp: Date.now()
101
101
  };
102
- (_a2 = config.logger) == null ? void 0 : _a2.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message, ...args);
102
+ const message = (_b = yield (_a2 = config.verifyMessageData) == null ? void 0 : _a2.call(config, _message)) != null ? _b : _message;
103
+ (_c = config.logger) == null ? void 0 : _c.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message, ...args);
103
104
  const response = yield config.sendMessage(message, ...args);
104
105
  const { res, err } = response != null ? response : { err: new Error("No response") };
105
- (_b = config.logger) == null ? void 0 : _b.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
106
+ (_d = config.logger) == null ? void 0 : _d.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
106
107
  if (err != null)
107
108
  throw (0, import_serialize_error.deserializeError)(err);
108
109
  return res;
@@ -117,6 +118,9 @@ function defineGenericMessanging(config) {
117
118
  removeRootListener = config.addRootListener((message) => {
118
119
  var _a3, _b2;
119
120
  if (typeof message.type != "string" || typeof message.timestamp !== "number") {
121
+ if (config.breakError) {
122
+ return;
123
+ }
120
124
  const err = Error(
121
125
  `[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(
122
126
  message
@@ -131,6 +135,9 @@ function defineGenericMessanging(config) {
131
135
  return;
132
136
  const res = listener(message);
133
137
  return Promise.resolve(res).then((res2) => {
138
+ var _a4, _b3;
139
+ return (_b3 = (_a4 = config.verifyMessageData) == null ? void 0 : _a4.call(config, res2)) != null ? _b3 : res2;
140
+ }).then((res2) => {
134
141
  var _a4;
135
142
  (_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
136
143
  return { res: res2 };
package/lib/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { B as BaseMessagingConfig, G as GenericMessenger } from './generic-77a327a6.js';
2
- export { a as GetDataType, b as GetReturnType, L as Logger, M as MaybePromise, c as Message, N as NamespaceMessagingConfig, P as ProtocolWithReturn, R as RemoveListenerCallback } from './generic-77a327a6.js';
1
+ import { B as BaseMessagingConfig, G as GenericMessenger } from './generic-ad5087a0.js';
2
+ export { a as GetDataType, b as GetReturnType, L as Logger, M as MaybePromise, c as Message, N as NamespaceMessagingConfig, P as ProtocolWithReturn, R as RemoveListenerCallback } from './generic-ad5087a0.js';
3
3
  import { Runtime } from 'webextension-polyfill';
4
4
 
5
5
  /**
@@ -1281,17 +1281,18 @@ var webExtCoreMessaging = (() => {
1281
1281
  return {
1282
1282
  sendMessage(type, data, ...args) {
1283
1283
  return __async(this, null, function* () {
1284
- var _a2, _b;
1285
- const message = {
1284
+ var _a2, _b, _c, _d;
1285
+ const _message = {
1286
1286
  id: getNextId(),
1287
1287
  type,
1288
1288
  data,
1289
1289
  timestamp: Date.now()
1290
1290
  };
1291
- (_a2 = config.logger) == null ? void 0 : _a2.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message, ...args);
1291
+ const message = (_b = yield (_a2 = config.verifyMessageData) == null ? void 0 : _a2.call(config, _message)) != null ? _b : _message;
1292
+ (_c = config.logger) == null ? void 0 : _c.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message, ...args);
1292
1293
  const response = yield config.sendMessage(message, ...args);
1293
1294
  const { res, err } = response != null ? response : { err: new Error("No response") };
1294
- (_b = config.logger) == null ? void 0 : _b.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
1295
+ (_d = config.logger) == null ? void 0 : _d.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
1295
1296
  if (err != null)
1296
1297
  throw deserializeError(err);
1297
1298
  return res;
@@ -1306,6 +1307,9 @@ var webExtCoreMessaging = (() => {
1306
1307
  removeRootListener = config.addRootListener((message) => {
1307
1308
  var _a3, _b2;
1308
1309
  if (typeof message.type != "string" || typeof message.timestamp !== "number") {
1310
+ if (config.breakError) {
1311
+ return;
1312
+ }
1309
1313
  const err = Error(
1310
1314
  `[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(
1311
1315
  message
@@ -1320,6 +1324,9 @@ var webExtCoreMessaging = (() => {
1320
1324
  return;
1321
1325
  const res = listener(message);
1322
1326
  return Promise.resolve(res).then((res2) => {
1327
+ var _a4, _b3;
1328
+ return (_b3 = (_a4 = config.verifyMessageData) == null ? void 0 : _a4.call(config, res2)) != null ? _b3 : res2;
1329
+ }).then((res2) => {
1323
1330
  var _a4;
1324
1331
  (_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
1325
1332
  return { res: res2 };
package/lib/index.js CHANGED
@@ -2,7 +2,7 @@ import {
2
2
  __spreadProps,
3
3
  __spreadValues,
4
4
  defineGenericMessanging
5
- } from "./chunk-ALTBYIMW.js";
5
+ } from "./chunk-BQLFSFFZ.js";
6
6
 
7
7
  // src/extension.ts
8
8
  import Browser from "webextension-polyfill";
package/lib/page.cjs CHANGED
@@ -95,17 +95,18 @@ function defineGenericMessanging(config) {
95
95
  return {
96
96
  sendMessage(type, data, ...args) {
97
97
  return __async(this, null, function* () {
98
- var _a2, _b;
99
- const message = {
98
+ var _a2, _b, _c, _d;
99
+ const _message = {
100
100
  id: getNextId(),
101
101
  type,
102
102
  data,
103
103
  timestamp: Date.now()
104
104
  };
105
- (_a2 = config.logger) == null ? void 0 : _a2.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message, ...args);
105
+ const message = (_b = yield (_a2 = config.verifyMessageData) == null ? void 0 : _a2.call(config, _message)) != null ? _b : _message;
106
+ (_c = config.logger) == null ? void 0 : _c.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message, ...args);
106
107
  const response = yield config.sendMessage(message, ...args);
107
108
  const { res, err } = response != null ? response : { err: new Error("No response") };
108
- (_b = config.logger) == null ? void 0 : _b.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
109
+ (_d = config.logger) == null ? void 0 : _d.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
109
110
  if (err != null)
110
111
  throw (0, import_serialize_error.deserializeError)(err);
111
112
  return res;
@@ -120,6 +121,9 @@ function defineGenericMessanging(config) {
120
121
  removeRootListener = config.addRootListener((message) => {
121
122
  var _a3, _b2;
122
123
  if (typeof message.type != "string" || typeof message.timestamp !== "number") {
124
+ if (config.breakError) {
125
+ return;
126
+ }
123
127
  const err = Error(
124
128
  `[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(
125
129
  message
@@ -134,6 +138,9 @@ function defineGenericMessanging(config) {
134
138
  return;
135
139
  const res = listener(message);
136
140
  return Promise.resolve(res).then((res2) => {
141
+ var _a4, _b3;
142
+ return (_b3 = (_a4 = config.verifyMessageData) == null ? void 0 : _a4.call(config, res2)) != null ? _b3 : res2;
143
+ }).then((res2) => {
137
144
  var _a4;
138
145
  (_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
139
146
  return { res: res2 };
@@ -205,6 +212,9 @@ function defineWindowMessaging(config) {
205
212
  });
206
213
  window.addEventListener("message", listener);
207
214
  return () => window.removeEventListener("message", listener);
215
+ },
216
+ verifyMessageData(data) {
217
+ return structuredClone(data);
208
218
  }
209
219
  }));
210
220
  return __spreadProps(__spreadValues({}, messenger), {
@@ -218,6 +228,13 @@ function defineWindowMessaging(config) {
218
228
 
219
229
  // src/custom-event.ts
220
230
  var import_uid2 = require("uid");
231
+
232
+ // src/utils.ts
233
+ function prepareCustomEventDict(data, options = { targetScope: window != null ? window : void 0 }) {
234
+ return typeof cloneInto !== "undefined" ? cloneInto(data, options.targetScope) : data;
235
+ }
236
+
237
+ // src/custom-event.ts
221
238
  var REQUEST_EVENT = "@webext-core/messaging/custom-events";
222
239
  var RESPONSE_EVENT = "@webext-core/messaging/custom-events/response";
223
240
  function defineCustomEventMessaging(config) {
@@ -241,8 +258,7 @@ function defineCustomEventMessaging(config) {
241
258
  sendMessage(message) {
242
259
  const reqDetail = { message, namespace, instanceId };
243
260
  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
261
+ detail: prepareCustomEventDict(reqDetail)
246
262
  });
247
263
  return sendCustomMessage(requestEvent);
248
264
  },
@@ -255,13 +271,15 @@ function defineCustomEventMessaging(config) {
255
271
  const response = yield processMessage(message);
256
272
  const resDetail = { response, message, instanceId, namespace };
257
273
  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
274
+ detail: prepareCustomEventDict(resDetail)
260
275
  });
261
276
  window.dispatchEvent(responseEvent);
262
277
  });
263
278
  window.addEventListener(REQUEST_EVENT, requestListener);
264
279
  return () => window.removeEventListener(REQUEST_EVENT, requestListener);
280
+ },
281
+ verifyMessageData(data) {
282
+ return structuredClone(data);
265
283
  }
266
284
  }));
267
285
  return __spreadProps(__spreadValues({}, messenger), {
package/lib/page.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { N as NamespaceMessagingConfig, G as GenericMessenger } from './generic-77a327a6.js';
1
+ import { N as NamespaceMessagingConfig, G as GenericMessenger } from './generic-ad5087a0.js';
2
2
 
3
3
  /**
4
4
  * Configuration passed into `defineWindowMessaging`.
@@ -300,17 +300,18 @@ var webExtCoreMessaging = (() => {
300
300
  return {
301
301
  sendMessage(type, data, ...args) {
302
302
  return __async(this, null, function* () {
303
- var _a2, _b;
304
- const message = {
303
+ var _a2, _b, _c, _d;
304
+ const _message = {
305
305
  id: getNextId(),
306
306
  type,
307
307
  data,
308
308
  timestamp: Date.now()
309
309
  };
310
- (_a2 = config.logger) == null ? void 0 : _a2.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message, ...args);
310
+ const message = (_b = yield (_a2 = config.verifyMessageData) == null ? void 0 : _a2.call(config, _message)) != null ? _b : _message;
311
+ (_c = config.logger) == null ? void 0 : _c.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message, ...args);
311
312
  const response = yield config.sendMessage(message, ...args);
312
313
  const { res, err } = response != null ? response : { err: new Error("No response") };
313
- (_b = config.logger) == null ? void 0 : _b.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
314
+ (_d = config.logger) == null ? void 0 : _d.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
314
315
  if (err != null)
315
316
  throw deserializeError(err);
316
317
  return res;
@@ -325,6 +326,9 @@ var webExtCoreMessaging = (() => {
325
326
  removeRootListener = config.addRootListener((message) => {
326
327
  var _a3, _b2;
327
328
  if (typeof message.type != "string" || typeof message.timestamp !== "number") {
329
+ if (config.breakError) {
330
+ return;
331
+ }
328
332
  const err = Error(
329
333
  `[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(
330
334
  message
@@ -339,6 +343,9 @@ var webExtCoreMessaging = (() => {
339
343
  return;
340
344
  const res = listener(message);
341
345
  return Promise.resolve(res).then((res2) => {
346
+ var _a4, _b3;
347
+ return (_b3 = (_a4 = config.verifyMessageData) == null ? void 0 : _a4.call(config, res2)) != null ? _b3 : res2;
348
+ }).then((res2) => {
342
349
  var _a4;
343
350
  (_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
344
351
  return { res: res2 };
@@ -410,6 +417,9 @@ var webExtCoreMessaging = (() => {
410
417
  });
411
418
  window.addEventListener("message", listener);
412
419
  return () => window.removeEventListener("message", listener);
420
+ },
421
+ verifyMessageData(data) {
422
+ return structuredClone(data);
413
423
  }
414
424
  }));
415
425
  return __spreadProps(__spreadValues({}, messenger), {
@@ -421,6 +431,11 @@ var webExtCoreMessaging = (() => {
421
431
  });
422
432
  }
423
433
 
434
+ // src/utils.ts
435
+ function prepareCustomEventDict(data, options = { targetScope: window != null ? window : void 0 }) {
436
+ return typeof cloneInto !== "undefined" ? cloneInto(data, options.targetScope) : data;
437
+ }
438
+
424
439
  // src/custom-event.ts
425
440
  var REQUEST_EVENT = "@webext-core/messaging/custom-events";
426
441
  var RESPONSE_EVENT = "@webext-core/messaging/custom-events/response";
@@ -445,8 +460,7 @@ var webExtCoreMessaging = (() => {
445
460
  sendMessage(message) {
446
461
  const reqDetail = { message, namespace, instanceId };
447
462
  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
463
+ detail: prepareCustomEventDict(reqDetail)
450
464
  });
451
465
  return sendCustomMessage(requestEvent);
452
466
  },
@@ -459,13 +473,15 @@ var webExtCoreMessaging = (() => {
459
473
  const response = yield processMessage(message);
460
474
  const resDetail = { response, message, instanceId, namespace };
461
475
  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
476
+ detail: prepareCustomEventDict(resDetail)
464
477
  });
465
478
  window.dispatchEvent(responseEvent);
466
479
  });
467
480
  window.addEventListener(REQUEST_EVENT, requestListener);
468
481
  return () => window.removeEventListener(REQUEST_EVENT, requestListener);
482
+ },
483
+ verifyMessageData(data) {
484
+ return structuredClone(data);
469
485
  }
470
486
  }));
471
487
  return __spreadProps(__spreadValues({}, messenger), {
package/lib/page.js CHANGED
@@ -4,7 +4,7 @@ import {
4
4
  __spreadProps,
5
5
  __spreadValues,
6
6
  defineGenericMessanging
7
- } from "./chunk-ALTBYIMW.js";
7
+ } from "./chunk-BQLFSFFZ.js";
8
8
 
9
9
  // src/window.ts
10
10
  import { uid } from "uid";
@@ -45,6 +45,9 @@ function defineWindowMessaging(config) {
45
45
  });
46
46
  window.addEventListener("message", listener);
47
47
  return () => window.removeEventListener("message", listener);
48
+ },
49
+ verifyMessageData(data) {
50
+ return structuredClone(data);
48
51
  }
49
52
  }));
50
53
  return __spreadProps(__spreadValues({}, messenger), {
@@ -58,6 +61,13 @@ function defineWindowMessaging(config) {
58
61
 
59
62
  // src/custom-event.ts
60
63
  import { uid as uid2 } from "uid";
64
+
65
+ // src/utils.ts
66
+ function prepareCustomEventDict(data, options = { targetScope: window != null ? window : void 0 }) {
67
+ return typeof cloneInto !== "undefined" ? cloneInto(data, options.targetScope) : data;
68
+ }
69
+
70
+ // src/custom-event.ts
61
71
  var REQUEST_EVENT = "@webext-core/messaging/custom-events";
62
72
  var RESPONSE_EVENT = "@webext-core/messaging/custom-events/response";
63
73
  function defineCustomEventMessaging(config) {
@@ -81,8 +91,7 @@ function defineCustomEventMessaging(config) {
81
91
  sendMessage(message) {
82
92
  const reqDetail = { message, namespace, instanceId };
83
93
  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
94
+ detail: prepareCustomEventDict(reqDetail)
86
95
  });
87
96
  return sendCustomMessage(requestEvent);
88
97
  },
@@ -95,13 +104,15 @@ function defineCustomEventMessaging(config) {
95
104
  const response = yield processMessage(message);
96
105
  const resDetail = { response, message, instanceId, namespace };
97
106
  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
107
+ detail: prepareCustomEventDict(resDetail)
100
108
  });
101
109
  window.dispatchEvent(responseEvent);
102
110
  });
103
111
  window.addEventListener(REQUEST_EVENT, requestListener);
104
112
  return () => window.removeEventListener(REQUEST_EVENT, requestListener);
113
+ },
114
+ verifyMessageData(data) {
115
+ return structuredClone(data);
105
116
  }
106
117
  }));
107
118
  return __spreadProps(__spreadValues({}, messenger), {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@webext-core/messaging",
3
- "version": "2.0.2",
3
+ "version": "2.1.0",
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": [