@webext-core/messaging 2.2.0 → 3.0.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.
@@ -1,495 +0,0 @@
1
- "use strict";
2
- var webExtCoreMessaging = (() => {
3
- var __defProp = Object.defineProperty;
4
- var __defProps = Object.defineProperties;
5
- var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
6
- var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
7
- var __getOwnPropNames = Object.getOwnPropertyNames;
8
- var __getOwnPropSymbols = Object.getOwnPropertySymbols;
9
- var __hasOwnProp = Object.prototype.hasOwnProperty;
10
- var __propIsEnum = Object.prototype.propertyIsEnumerable;
11
- var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
12
- var __spreadValues = (a, b) => {
13
- for (var prop in b || (b = {}))
14
- if (__hasOwnProp.call(b, prop))
15
- __defNormalProp(a, prop, b[prop]);
16
- if (__getOwnPropSymbols)
17
- for (var prop of __getOwnPropSymbols(b)) {
18
- if (__propIsEnum.call(b, prop))
19
- __defNormalProp(a, prop, b[prop]);
20
- }
21
- return a;
22
- };
23
- var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
24
- var __objRest = (source, exclude) => {
25
- var target = {};
26
- for (var prop in source)
27
- if (__hasOwnProp.call(source, prop) && exclude.indexOf(prop) < 0)
28
- target[prop] = source[prop];
29
- if (source != null && __getOwnPropSymbols)
30
- for (var prop of __getOwnPropSymbols(source)) {
31
- if (exclude.indexOf(prop) < 0 && __propIsEnum.call(source, prop))
32
- target[prop] = source[prop];
33
- }
34
- return target;
35
- };
36
- var __export = (target, all) => {
37
- for (var name in all)
38
- __defProp(target, name, { get: all[name], enumerable: true });
39
- };
40
- var __copyProps = (to, from, except, desc) => {
41
- if (from && typeof from === "object" || typeof from === "function") {
42
- for (let key of __getOwnPropNames(from))
43
- if (!__hasOwnProp.call(to, key) && key !== except)
44
- __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
45
- }
46
- return to;
47
- };
48
- var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
49
- var __publicField = (obj, key, value) => {
50
- __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
51
- return value;
52
- };
53
- var __async = (__this, __arguments, generator) => {
54
- return new Promise((resolve, reject) => {
55
- var fulfilled = (value) => {
56
- try {
57
- step(generator.next(value));
58
- } catch (e) {
59
- reject(e);
60
- }
61
- };
62
- var rejected = (value) => {
63
- try {
64
- step(generator.throw(value));
65
- } catch (e) {
66
- reject(e);
67
- }
68
- };
69
- var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
70
- step((generator = generator.apply(__this, __arguments)).next());
71
- });
72
- };
73
-
74
- // src/page.ts
75
- var page_exports = {};
76
- __export(page_exports, {
77
- defineCustomEventMessaging: () => defineCustomEventMessaging,
78
- defineWindowMessaging: () => defineWindowMessaging
79
- });
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
-
98
- // ../../node_modules/serialize-error/error-constructors.js
99
- var list = [
100
- // Native ES errors https://262.ecma-international.org/12.0/#sec-well-known-intrinsic-objects
101
- EvalError,
102
- RangeError,
103
- ReferenceError,
104
- SyntaxError,
105
- TypeError,
106
- URIError,
107
- // Built-in errors
108
- globalThis.DOMException,
109
- // Node-specific errors
110
- // https://nodejs.org/api/errors.html
111
- globalThis.AssertionError,
112
- globalThis.SystemError
113
- ].filter(Boolean).map(
114
- (constructor) => [constructor.name, constructor]
115
- );
116
- var errorConstructors = new Map(list);
117
- var error_constructors_default = errorConstructors;
118
-
119
- // ../../node_modules/serialize-error/index.js
120
- var NonError = class extends Error {
121
- constructor(message) {
122
- super(NonError._prepareSuperMessage(message));
123
- __publicField(this, "name", "NonError");
124
- }
125
- static _prepareSuperMessage(message) {
126
- try {
127
- return JSON.stringify(message);
128
- } catch (e) {
129
- return String(message);
130
- }
131
- }
132
- };
133
- var commonProperties = [
134
- {
135
- property: "name",
136
- enumerable: false
137
- },
138
- {
139
- property: "message",
140
- enumerable: false
141
- },
142
- {
143
- property: "stack",
144
- enumerable: false
145
- },
146
- {
147
- property: "code",
148
- enumerable: true
149
- },
150
- {
151
- property: "cause",
152
- enumerable: false
153
- }
154
- ];
155
- var toJsonWasCalled = /* @__PURE__ */ new WeakSet();
156
- var toJSON = (from) => {
157
- toJsonWasCalled.add(from);
158
- const json = from.toJSON();
159
- toJsonWasCalled.delete(from);
160
- return json;
161
- };
162
- var getErrorConstructor = (name) => {
163
- var _a;
164
- return (_a = error_constructors_default.get(name)) != null ? _a : Error;
165
- };
166
- var destroyCircular = ({
167
- from,
168
- seen,
169
- to,
170
- forceEnumerable,
171
- maxDepth,
172
- depth,
173
- useToJSON,
174
- serialize
175
- }) => {
176
- if (!to) {
177
- if (Array.isArray(from)) {
178
- to = [];
179
- } else if (!serialize && isErrorLike(from)) {
180
- const Error2 = getErrorConstructor(from.name);
181
- to = new Error2();
182
- } else {
183
- to = {};
184
- }
185
- }
186
- seen.push(from);
187
- if (depth >= maxDepth) {
188
- return to;
189
- }
190
- if (useToJSON && typeof from.toJSON === "function" && !toJsonWasCalled.has(from)) {
191
- return toJSON(from);
192
- }
193
- const continueDestroyCircular = (value) => destroyCircular({
194
- from: value,
195
- seen: [...seen],
196
- forceEnumerable,
197
- maxDepth,
198
- depth,
199
- useToJSON,
200
- serialize
201
- });
202
- for (const [key, value] of Object.entries(from)) {
203
- if (value && value instanceof Uint8Array && value.constructor.name === "Buffer") {
204
- to[key] = "[object Buffer]";
205
- continue;
206
- }
207
- if (value !== null && typeof value === "object" && typeof value.pipe === "function") {
208
- to[key] = "[object Stream]";
209
- continue;
210
- }
211
- if (typeof value === "function") {
212
- continue;
213
- }
214
- if (!value || typeof value !== "object") {
215
- try {
216
- to[key] = value;
217
- } catch (e) {
218
- }
219
- continue;
220
- }
221
- if (!seen.includes(from[key])) {
222
- depth++;
223
- to[key] = continueDestroyCircular(from[key]);
224
- continue;
225
- }
226
- to[key] = "[Circular]";
227
- }
228
- for (const { property, enumerable } of commonProperties) {
229
- if (typeof from[property] !== "undefined" && from[property] !== null) {
230
- Object.defineProperty(to, property, {
231
- value: isErrorLike(from[property]) ? continueDestroyCircular(from[property]) : from[property],
232
- enumerable: forceEnumerable ? true : enumerable,
233
- configurable: true,
234
- writable: true
235
- });
236
- }
237
- }
238
- return to;
239
- };
240
- function serializeError(value, options = {}) {
241
- const {
242
- maxDepth = Number.POSITIVE_INFINITY,
243
- useToJSON = true
244
- } = options;
245
- if (typeof value === "object" && value !== null) {
246
- return destroyCircular({
247
- from: value,
248
- seen: [],
249
- forceEnumerable: true,
250
- maxDepth,
251
- depth: 0,
252
- useToJSON,
253
- serialize: true
254
- });
255
- }
256
- if (typeof value === "function") {
257
- return `[Function: ${value.name || "anonymous"}]`;
258
- }
259
- return value;
260
- }
261
- function deserializeError(value, options = {}) {
262
- const { maxDepth = Number.POSITIVE_INFINITY } = options;
263
- if (value instanceof Error) {
264
- return value;
265
- }
266
- if (isMinimumViableSerializedError(value)) {
267
- const Error2 = getErrorConstructor(value.name);
268
- return destroyCircular({
269
- from: value,
270
- seen: [],
271
- to: new Error2(),
272
- maxDepth,
273
- depth: 0,
274
- serialize: false
275
- });
276
- }
277
- return new NonError(value);
278
- }
279
- function isErrorLike(value) {
280
- return Boolean(value) && typeof value === "object" && "name" in value && "message" in value && "stack" in value;
281
- }
282
- function isMinimumViableSerializedError(value) {
283
- return Boolean(value) && typeof value === "object" && "message" in value && !Array.isArray(value);
284
- }
285
-
286
- // src/generic.ts
287
- function defineGenericMessanging(config) {
288
- let removeRootListener;
289
- let perTypeListeners = {};
290
- function cleanupRootListener() {
291
- if (Object.entries(perTypeListeners).length === 0) {
292
- removeRootListener == null ? void 0 : removeRootListener();
293
- removeRootListener = void 0;
294
- }
295
- }
296
- let idSeq = Math.floor(Math.random() * 1e4);
297
- function getNextId() {
298
- return idSeq++;
299
- }
300
- return {
301
- sendMessage(type, data, ...args) {
302
- return __async(this, null, function* () {
303
- var _a2, _b, _c, _d;
304
- const _message = {
305
- id: getNextId(),
306
- type,
307
- data,
308
- timestamp: Date.now()
309
- };
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);
312
- const response = yield config.sendMessage(message, ...args);
313
- const { res, err } = response != null ? response : { err: new Error("No response") };
314
- (_d = config.logger) == null ? void 0 : _d.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
315
- if (err != null)
316
- throw deserializeError(err);
317
- return res;
318
- });
319
- },
320
- onMessage(type, onReceived) {
321
- var _a2, _b, _c;
322
- if (removeRootListener == null) {
323
- (_a2 = config.logger) == null ? void 0 : _a2.debug(
324
- `[messaging] "${type}" initialized the message listener for this context`
325
- );
326
- removeRootListener = config.addRootListener((message) => {
327
- var _a3, _b2;
328
- if (typeof message.type != "string" || typeof message.timestamp !== "number") {
329
- if (config.breakError) {
330
- return;
331
- }
332
- const err = Error(
333
- `[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(
334
- message
335
- )}`
336
- );
337
- (_a3 = config.logger) == null ? void 0 : _a3.error(err);
338
- throw err;
339
- }
340
- (_b2 = config == null ? void 0 : config.logger) == null ? void 0 : _b2.debug("[messaging] Received message", message);
341
- const listener = perTypeListeners[message.type];
342
- if (listener == null)
343
- return;
344
- const res = listener(message);
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) => {
349
- var _a4;
350
- (_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
351
- return { res: res2 };
352
- }).catch((err) => {
353
- var _a4;
354
- (_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { err });
355
- return { err: serializeError(err) };
356
- });
357
- });
358
- }
359
- if (perTypeListeners[type] != null) {
360
- const err = Error(
361
- `[messaging] In this JS context, only one listener can be setup for ${type}`
362
- );
363
- (_b = config.logger) == null ? void 0 : _b.error(err);
364
- throw err;
365
- }
366
- perTypeListeners[type] = onReceived;
367
- (_c = config.logger) == null ? void 0 : _c.log(`[messaging] Added listener for ${type}`);
368
- return () => {
369
- delete perTypeListeners[type];
370
- cleanupRootListener();
371
- };
372
- },
373
- removeAllListeners() {
374
- Object.keys(perTypeListeners).forEach((type) => {
375
- delete perTypeListeners[type];
376
- });
377
- cleanupRootListener();
378
- }
379
- };
380
- }
381
-
382
- // src/window.ts
383
- var REQUEST_TYPE = "@webext-core/messaging/window";
384
- var RESPONSE_TYPE = "@webext-core/messaging/window/response";
385
- function defineWindowMessaging(config) {
386
- const namespace = config.namespace;
387
- const instanceId = uid();
388
- let removeAdditionalListeners = [];
389
- const sendWindowMessage = (message, targetOrigin) => new Promise((res) => {
390
- const responseListener = (event) => {
391
- if (event.data.type === RESPONSE_TYPE && event.data.namespace === namespace && event.data.instanceId !== instanceId && event.data.message.type === message.type) {
392
- res(event.data.response);
393
- removeResponseListener();
394
- }
395
- };
396
- const removeResponseListener = () => window.removeEventListener("message", responseListener);
397
- removeAdditionalListeners.push(removeResponseListener);
398
- window.addEventListener("message", responseListener);
399
- window.postMessage(
400
- { type: REQUEST_TYPE, message, senderOrigin: location.origin, namespace, instanceId },
401
- targetOrigin != null ? targetOrigin : "*"
402
- );
403
- });
404
- const messenger = defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
405
- sendMessage(message, targetOrigin) {
406
- return sendWindowMessage(message, targetOrigin);
407
- },
408
- addRootListener(processMessage) {
409
- const listener = (event) => __async(this, null, function* () {
410
- if (event.data.type !== REQUEST_TYPE || event.data.namespace !== namespace || event.data.instanceId === instanceId)
411
- return;
412
- const response = yield processMessage(event.data.message);
413
- window.postMessage(
414
- { type: RESPONSE_TYPE, response, instanceId, message: event.data.message, namespace },
415
- event.data.senderOrigin
416
- );
417
- });
418
- window.addEventListener("message", listener);
419
- return () => window.removeEventListener("message", listener);
420
- },
421
- verifyMessageData(data) {
422
- return structuredClone(data);
423
- }
424
- }));
425
- return __spreadProps(__spreadValues({}, messenger), {
426
- removeAllListeners() {
427
- messenger.removeAllListeners();
428
- removeAdditionalListeners.forEach((removeListener) => removeListener());
429
- removeAdditionalListeners = [];
430
- }
431
- });
432
- }
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
-
439
- // src/custom-event.ts
440
- var REQUEST_EVENT = "@webext-core/messaging/custom-events";
441
- var RESPONSE_EVENT = "@webext-core/messaging/custom-events/response";
442
- function defineCustomEventMessaging(config) {
443
- const namespace = config.namespace;
444
- const instanceId = uid();
445
- const removeAdditionalListeners = [];
446
- const sendCustomMessage = (requestEvent) => new Promise((res) => {
447
- const responseListener = (e) => {
448
- const { detail } = e;
449
- if (detail.namespace === namespace && detail.instanceId !== instanceId && detail.message.type === requestEvent.detail.message.type) {
450
- res(detail.response);
451
- }
452
- };
453
- removeAdditionalListeners.push(
454
- () => window.removeEventListener(RESPONSE_EVENT, responseListener)
455
- );
456
- window.addEventListener(RESPONSE_EVENT, responseListener);
457
- window.dispatchEvent(requestEvent);
458
- });
459
- const messenger = defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
460
- sendMessage(message) {
461
- const reqDetail = { message, namespace, instanceId };
462
- const requestEvent = new CustomEvent(REQUEST_EVENT, {
463
- detail: prepareCustomEventDict(reqDetail)
464
- });
465
- return sendCustomMessage(requestEvent);
466
- },
467
- addRootListener(processMessage) {
468
- const requestListener = (e) => __async(this, null, function* () {
469
- const _a = e, { detail } = _a, event = __objRest(_a, ["detail"]);
470
- if (detail.namespace !== namespace || detail.instanceId === instanceId)
471
- return;
472
- const message = __spreadProps(__spreadValues({}, detail.message), { event });
473
- const response = yield processMessage(message);
474
- const resDetail = { response, message, instanceId, namespace };
475
- const responseEvent = new CustomEvent(RESPONSE_EVENT, {
476
- detail: prepareCustomEventDict(resDetail)
477
- });
478
- window.dispatchEvent(responseEvent);
479
- });
480
- window.addEventListener(REQUEST_EVENT, requestListener);
481
- return () => window.removeEventListener(REQUEST_EVENT, requestListener);
482
- },
483
- verifyMessageData(data) {
484
- return structuredClone(data);
485
- }
486
- }));
487
- return __spreadProps(__spreadValues({}, messenger), {
488
- removeAllListeners() {
489
- messenger.removeAllListeners();
490
- removeAdditionalListeners.forEach((removeListener) => removeListener());
491
- }
492
- });
493
- }
494
- return __toCommonJS(page_exports);
495
- })();
package/lib/page.js DELETED
@@ -1,128 +0,0 @@
1
- import {
2
- __async,
3
- __objRest,
4
- __spreadProps,
5
- __spreadValues,
6
- defineGenericMessanging
7
- } from "./chunk-BQLFSFFZ.js";
8
-
9
- // src/window.ts
10
- import { uid } from "uid";
11
- var REQUEST_TYPE = "@webext-core/messaging/window";
12
- var RESPONSE_TYPE = "@webext-core/messaging/window/response";
13
- function defineWindowMessaging(config) {
14
- const namespace = config.namespace;
15
- const instanceId = uid();
16
- let removeAdditionalListeners = [];
17
- const sendWindowMessage = (message, targetOrigin) => new Promise((res) => {
18
- const responseListener = (event) => {
19
- if (event.data.type === RESPONSE_TYPE && event.data.namespace === namespace && event.data.instanceId !== instanceId && event.data.message.type === message.type) {
20
- res(event.data.response);
21
- removeResponseListener();
22
- }
23
- };
24
- const removeResponseListener = () => window.removeEventListener("message", responseListener);
25
- removeAdditionalListeners.push(removeResponseListener);
26
- window.addEventListener("message", responseListener);
27
- window.postMessage(
28
- { type: REQUEST_TYPE, message, senderOrigin: location.origin, namespace, instanceId },
29
- targetOrigin != null ? targetOrigin : "*"
30
- );
31
- });
32
- const messenger = defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
33
- sendMessage(message, targetOrigin) {
34
- return sendWindowMessage(message, targetOrigin);
35
- },
36
- addRootListener(processMessage) {
37
- const listener = (event) => __async(this, null, function* () {
38
- if (event.data.type !== REQUEST_TYPE || event.data.namespace !== namespace || event.data.instanceId === instanceId)
39
- return;
40
- const response = yield processMessage(event.data.message);
41
- window.postMessage(
42
- { type: RESPONSE_TYPE, response, instanceId, message: event.data.message, namespace },
43
- event.data.senderOrigin
44
- );
45
- });
46
- window.addEventListener("message", listener);
47
- return () => window.removeEventListener("message", listener);
48
- },
49
- verifyMessageData(data) {
50
- return structuredClone(data);
51
- }
52
- }));
53
- return __spreadProps(__spreadValues({}, messenger), {
54
- removeAllListeners() {
55
- messenger.removeAllListeners();
56
- removeAdditionalListeners.forEach((removeListener) => removeListener());
57
- removeAdditionalListeners = [];
58
- }
59
- });
60
- }
61
-
62
- // src/custom-event.ts
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
71
- var REQUEST_EVENT = "@webext-core/messaging/custom-events";
72
- var RESPONSE_EVENT = "@webext-core/messaging/custom-events/response";
73
- function defineCustomEventMessaging(config) {
74
- const namespace = config.namespace;
75
- const instanceId = uid2();
76
- const removeAdditionalListeners = [];
77
- const sendCustomMessage = (requestEvent) => new Promise((res) => {
78
- const responseListener = (e) => {
79
- const { detail } = e;
80
- if (detail.namespace === namespace && detail.instanceId !== instanceId && detail.message.type === requestEvent.detail.message.type) {
81
- res(detail.response);
82
- }
83
- };
84
- removeAdditionalListeners.push(
85
- () => window.removeEventListener(RESPONSE_EVENT, responseListener)
86
- );
87
- window.addEventListener(RESPONSE_EVENT, responseListener);
88
- window.dispatchEvent(requestEvent);
89
- });
90
- const messenger = defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
91
- sendMessage(message) {
92
- const reqDetail = { message, namespace, instanceId };
93
- const requestEvent = new CustomEvent(REQUEST_EVENT, {
94
- detail: prepareCustomEventDict(reqDetail)
95
- });
96
- return sendCustomMessage(requestEvent);
97
- },
98
- addRootListener(processMessage) {
99
- const requestListener = (e) => __async(this, null, function* () {
100
- const _a = e, { detail } = _a, event = __objRest(_a, ["detail"]);
101
- if (detail.namespace !== namespace || detail.instanceId === instanceId)
102
- return;
103
- const message = __spreadProps(__spreadValues({}, detail.message), { event });
104
- const response = yield processMessage(message);
105
- const resDetail = { response, message, instanceId, namespace };
106
- const responseEvent = new CustomEvent(RESPONSE_EVENT, {
107
- detail: prepareCustomEventDict(resDetail)
108
- });
109
- window.dispatchEvent(responseEvent);
110
- });
111
- window.addEventListener(REQUEST_EVENT, requestListener);
112
- return () => window.removeEventListener(REQUEST_EVENT, requestListener);
113
- },
114
- verifyMessageData(data) {
115
- return structuredClone(data);
116
- }
117
- }));
118
- return __spreadProps(__spreadValues({}, messenger), {
119
- removeAllListeners() {
120
- messenger.removeAllListeners();
121
- removeAdditionalListeners.forEach((removeListener) => removeListener());
122
- }
123
- });
124
- }
125
- export {
126
- defineCustomEventMessaging,
127
- defineWindowMessaging
128
- };