@webext-core/messaging 3.0.1 → 3.0.3

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.d.mts ADDED
@@ -0,0 +1,91 @@
1
+ import { c as NamespaceMessagingConfig, t as GenericMessenger } from "./generic-B-kFbyP9.mjs";
2
+
3
+ //#region src/window.d.ts
4
+ /** Configuration passed into `defineWindowMessaging`. */
5
+ interface WindowMessagingConfig extends NamespaceMessagingConfig {}
6
+ /**
7
+ * For a `WindowMessenger`, `sendMessage` requires an additional argument, the `targetOrigin`. It
8
+ * defines which frames inside the page should receive the message.
9
+ *
10
+ * > See
11
+ * > [https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage#targetorigin](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage#targetorigin)
12
+ * > for more details.
13
+ *
14
+ * Message is posted on window which can as per your need like:
15
+ *
16
+ * - Parent window in iframe -> window.parent
17
+ * - Iframe content window -> iframe.contentWindow
18
+ * - Opener original window -> window.opener
19
+ * - By default global window is used to send message
20
+ */
21
+ type WindowSendMessageArgs = [targetOrigin?: string, targetWindow?: Window];
22
+ type WindowMessenger<TProtocolMap extends Record<string, any>> = GenericMessenger<TProtocolMap, {}, WindowSendMessageArgs>;
23
+ /**
24
+ * Returns a `WindowMessenger`. It is backed by the `window.postMessage` API. It can be used to
25
+ * communicate between:
26
+ *
27
+ * - Content script and website
28
+ * - Content script and injected script
29
+ *
30
+ * @example
31
+ * interface WebsiteMessengerSchema {
32
+ * initInjectedScript(data: ...): void;
33
+ * }
34
+ *
35
+ * export const websiteMessenger = defineWindowMessaging<initInjectedScript>();
36
+ *
37
+ * // Content script
38
+ * websiteMessenger.sendMessage("initInjectedScript", ...);
39
+ *
40
+ * // Injected script
41
+ * websiteMessenger.onMessage("initInjectedScript", (...) => {
42
+ * // ...
43
+ * })
44
+ *
45
+ * @link Spec diagrams
46
+ * 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
47
+ */
48
+ declare function defineWindowMessaging<TProtocolMap extends Record<string, any> = Record<string, any>>(config: WindowMessagingConfig): WindowMessenger<TProtocolMap>;
49
+ //#endregion
50
+ //#region src/custom-event.d.ts
51
+ /** Configuration passed into `defineCustomEventMessaging`. */
52
+ interface CustomEventMessagingConfig extends NamespaceMessagingConfig {}
53
+ /** Additional fields available on the `Message` from a `CustomEventMessenger`. */
54
+ interface CustomEventMessage {
55
+ /** The event that was fired, resulting in the message being passed. */
56
+ event: CustomEvent;
57
+ }
58
+ /** Messenger returned by `defineCustomEventMessenger`. */
59
+ type CustomEventMessenger<TProtocolMap extends Record<string, any>> = GenericMessenger<TProtocolMap, CustomEventMessage, []>;
60
+ /**
61
+ * Creates a `CustomEventMessenger`. This messenger is backed by the `CustomEvent` APIs. It can be
62
+ * used to communicate between:
63
+ *
64
+ * - Content script and website
65
+ * - Content script and injected script
66
+ *
67
+ * `sendMessage` does not accept any additional arguments..
68
+ *
69
+ * @example
70
+ * interface WebsiteMessengerSchema {
71
+ * initInjectedScript(data: ...): void;
72
+ * }
73
+ *
74
+ * export const websiteMessenger = defineCustomEventMessenger<initInjectedScript>();
75
+ *
76
+ * // Content script
77
+ * websiteMessenger.sendMessage("initInjectedScript", ...);
78
+ *
79
+ * // Injected script
80
+ * websiteMessenger.onMessage("initInjectedScript", (...) => {
81
+ * // ...
82
+ * })
83
+ *
84
+ * *
85
+ *
86
+ * @link Spec diagrams
87
+ * 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
88
+ */
89
+ declare function defineCustomEventMessaging<TProtocolMap extends Record<string, any> = Record<string, any>>(config: CustomEventMessagingConfig): CustomEventMessenger<TProtocolMap>;
90
+ //#endregion
91
+ export { CustomEventMessage, CustomEventMessagingConfig, CustomEventMessenger, WindowMessagingConfig, WindowMessenger, WindowSendMessageArgs, defineCustomEventMessaging, defineWindowMessaging };
@@ -1,335 +1 @@
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 __async = (__this, __arguments, generator) => {
50
- return new Promise((resolve, reject) => {
51
- var fulfilled = (value) => {
52
- try {
53
- step(generator.next(value));
54
- } catch (e2) {
55
- reject(e2);
56
- }
57
- };
58
- var rejected = (value) => {
59
- try {
60
- step(generator.throw(value));
61
- } catch (e2) {
62
- reject(e2);
63
- }
64
- };
65
- var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
66
- step((generator = generator.apply(__this, __arguments)).next());
67
- });
68
- };
69
-
70
- // src/page.ts
71
- var page_exports = {};
72
- __export(page_exports, {
73
- defineCustomEventMessaging: () => defineCustomEventMessaging,
74
- defineWindowMessaging: () => defineWindowMessaging
75
- });
76
-
77
- // ../../node_modules/@aklinker1/zero-serialize-error/dist/index.mjs
78
- var e = `string`;
79
- var t = `object`;
80
- function n(n2) {
81
- return n2 != null && typeof n2 === t && typeof n2.name === e && typeof n2.message === e && typeof n2.stack === e;
82
- }
83
- function r(e2) {
84
- var _a;
85
- if (typeof e2 !== t || e2 == null)
86
- return e2;
87
- if (e2 instanceof Error)
88
- return __spreadValues(__spreadValues({ name: e2.name, message: e2.message, stack: (_a = e2.stack) != null ? _a : `` }, e2.cause ? { cause: r(e2.cause) } : {}), r(__spreadValues({}, e2)));
89
- if (Array.isArray(e2)) {
90
- let t2 = [];
91
- for (let n3 of e2)
92
- t2.push(r(n3));
93
- return t2;
94
- }
95
- let n2 = /* @__PURE__ */ Object.create(null);
96
- for (let [t2, i2] of Object.entries(e2))
97
- n2[t2] = r(i2);
98
- return n2;
99
- }
100
- function i(e2) {
101
- if (n(e2)) {
102
- let t2 = Error(e2.message, e2.cause ? { cause: i(e2.cause) } : void 0);
103
- t2.name = e2.name, t2.stack = e2.stack;
104
- for (let [n2, r3] of Object.entries(e2))
105
- n2 !== `name` && n2 !== `message` && n2 !== `stack` && n2 !== `cause` && (t2[n2] = r3);
106
- return t2;
107
- }
108
- if (e2 == null || typeof e2 !== t)
109
- return e2;
110
- if (Array.isArray(e2)) {
111
- let t2 = [];
112
- for (let n2 of e2)
113
- t2.push(i(n2));
114
- return t2;
115
- }
116
- let r2 = /* @__PURE__ */ Object.create(null);
117
- for (let [t2, n2] of Object.entries(e2))
118
- r2[t2] = i(n2);
119
- return r2;
120
- }
121
-
122
- // src/generic.ts
123
- function defineGenericMessanging(config) {
124
- let removeRootListener;
125
- let perTypeListeners = {};
126
- function cleanupRootListener() {
127
- if (Object.entries(perTypeListeners).length === 0) {
128
- removeRootListener == null ? void 0 : removeRootListener();
129
- removeRootListener = void 0;
130
- }
131
- }
132
- let idSeq = Math.floor(Math.random() * 1e4);
133
- function getNextId() {
134
- return idSeq++;
135
- }
136
- return {
137
- sendMessage(type, data, ...args) {
138
- return __async(this, null, function* () {
139
- var _a2, _b, _c, _d;
140
- const _message = {
141
- id: getNextId(),
142
- type,
143
- data,
144
- timestamp: Date.now()
145
- };
146
- const message = (_b = yield (_a2 = config.verifyMessageData) == null ? void 0 : _a2.call(config, _message)) != null ? _b : _message;
147
- (_c = config.logger) == null ? void 0 : _c.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message, ...args);
148
- const response = yield config.sendMessage(message, ...args);
149
- const { res, err } = response != null ? response : { err: new Error("No response") };
150
- (_d = config.logger) == null ? void 0 : _d.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
151
- if (err != null)
152
- throw i(err);
153
- return res;
154
- });
155
- },
156
- onMessage(type, onReceived) {
157
- var _a2, _b, _c;
158
- if (removeRootListener == null) {
159
- (_a2 = config.logger) == null ? void 0 : _a2.debug(
160
- `[messaging] "${type}" initialized the message listener for this context`
161
- );
162
- removeRootListener = config.addRootListener((message) => {
163
- var _a3, _b2;
164
- if (typeof message.type != "string" || typeof message.timestamp !== "number") {
165
- if (config.throwOnUnknownMessageFormat) {
166
- const err = Error(
167
- `[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(
168
- message
169
- )}`
170
- );
171
- (_a3 = config.logger) == null ? void 0 : _a3.error(err);
172
- throw err;
173
- } else {
174
- return;
175
- }
176
- }
177
- (_b2 = config == null ? void 0 : config.logger) == null ? void 0 : _b2.debug("[messaging] Received message", message);
178
- const listener = perTypeListeners[message.type];
179
- if (listener == null)
180
- return;
181
- const res = listener(message);
182
- return Promise.resolve(res).then((res2) => {
183
- var _a4, _b3;
184
- return (_b3 = (_a4 = config.verifyMessageData) == null ? void 0 : _a4.call(config, res2)) != null ? _b3 : res2;
185
- }).then((res2) => {
186
- var _a4;
187
- (_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
188
- return { res: res2 };
189
- }).catch((err) => {
190
- var _a4;
191
- (_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { err });
192
- return { err: r(err) };
193
- });
194
- });
195
- }
196
- if (perTypeListeners[type] != null) {
197
- const err = Error(
198
- `[messaging] In this JS context, only one listener can be setup for ${type}`
199
- );
200
- (_b = config.logger) == null ? void 0 : _b.error(err);
201
- throw err;
202
- }
203
- perTypeListeners[type] = onReceived;
204
- (_c = config.logger) == null ? void 0 : _c.log(`[messaging] Added listener for ${type}`);
205
- return () => {
206
- delete perTypeListeners[type];
207
- cleanupRootListener();
208
- };
209
- },
210
- removeAllListeners() {
211
- Object.keys(perTypeListeners).forEach((type) => {
212
- delete perTypeListeners[type];
213
- });
214
- cleanupRootListener();
215
- }
216
- };
217
- }
218
-
219
- // src/utils.ts
220
- function prepareCustomEventDict(data, options = { targetScope: window != null ? window : void 0 }) {
221
- return typeof cloneInto !== "undefined" ? cloneInto(data, options.targetScope) : data;
222
- }
223
- function createId() {
224
- return Math.random().toString(36).substring(2, 10);
225
- }
226
-
227
- // src/window.ts
228
- var REQUEST_TYPE = "@webext-core/messaging/window";
229
- var RESPONSE_TYPE = "@webext-core/messaging/window/response";
230
- function defineWindowMessaging(config) {
231
- const namespace = config.namespace;
232
- const instanceId = createId();
233
- let removeAdditionalListeners = [];
234
- const sendWindowMessage = (message, targetOrigin, targetWindow) => new Promise((res) => {
235
- const responseListener = (event) => {
236
- if (event.data.type === RESPONSE_TYPE && event.data.namespace === namespace && event.data.instanceId !== instanceId && event.data.message.type === message.type && event.data.message.id === message.id) {
237
- res(event.data.response);
238
- removeResponseListener();
239
- }
240
- };
241
- const removeResponseListener = () => window.removeEventListener("message", responseListener);
242
- removeAdditionalListeners.push(removeResponseListener);
243
- window.addEventListener("message", responseListener);
244
- (targetWindow != null ? targetWindow : window).postMessage(
245
- { type: REQUEST_TYPE, message, senderOrigin: location.origin, namespace, instanceId },
246
- targetOrigin != null ? targetOrigin : "*"
247
- );
248
- });
249
- const messenger = defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
250
- sendMessage(message, targetOrigin, targetWindow) {
251
- return sendWindowMessage(message, targetOrigin, targetWindow);
252
- },
253
- addRootListener(processMessage) {
254
- const listener = (event) => __async(this, null, function* () {
255
- if (event.data.type !== REQUEST_TYPE || event.data.namespace !== namespace || event.data.instanceId === instanceId)
256
- return;
257
- const response = yield processMessage(event.data.message);
258
- window.postMessage(
259
- { type: RESPONSE_TYPE, response, instanceId, message: event.data.message, namespace },
260
- event.data.senderOrigin
261
- );
262
- });
263
- window.addEventListener("message", listener);
264
- return () => window.removeEventListener("message", listener);
265
- },
266
- verifyMessageData(data) {
267
- return structuredClone(data);
268
- }
269
- }));
270
- return __spreadProps(__spreadValues({}, messenger), {
271
- removeAllListeners() {
272
- messenger.removeAllListeners();
273
- removeAdditionalListeners.forEach((removeListener) => removeListener());
274
- removeAdditionalListeners = [];
275
- }
276
- });
277
- }
278
-
279
- // src/custom-event.ts
280
- var REQUEST_EVENT = "@webext-core/messaging/custom-events";
281
- var RESPONSE_EVENT = "@webext-core/messaging/custom-events/response";
282
- function defineCustomEventMessaging(config) {
283
- const namespace = config.namespace;
284
- const instanceId = createId();
285
- const removeAdditionalListeners = [];
286
- const sendCustomMessage = (requestEvent) => new Promise((res) => {
287
- const responseListener = (e2) => {
288
- const { detail } = e2;
289
- if (detail.namespace === namespace && detail.instanceId !== instanceId && detail.message.type === requestEvent.detail.message.type && detail.message.id === requestEvent.detail.message.id) {
290
- res(detail.response);
291
- }
292
- };
293
- removeAdditionalListeners.push(
294
- () => window.removeEventListener(RESPONSE_EVENT, responseListener)
295
- );
296
- window.addEventListener(RESPONSE_EVENT, responseListener);
297
- window.dispatchEvent(requestEvent);
298
- });
299
- const messenger = defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
300
- sendMessage(message) {
301
- const reqDetail = { message, namespace, instanceId };
302
- const requestEvent = new CustomEvent(REQUEST_EVENT, {
303
- detail: prepareCustomEventDict(reqDetail)
304
- });
305
- return sendCustomMessage(requestEvent);
306
- },
307
- addRootListener(processMessage) {
308
- const requestListener = (e2) => __async(this, null, function* () {
309
- const _a = e2, { detail } = _a, event = __objRest(_a, ["detail"]);
310
- if (detail.namespace !== namespace || detail.instanceId === instanceId)
311
- return;
312
- const message = __spreadProps(__spreadValues({}, detail.message), { event });
313
- const response = yield processMessage(message);
314
- const resDetail = { response, message, instanceId, namespace };
315
- const responseEvent = new CustomEvent(RESPONSE_EVENT, {
316
- detail: prepareCustomEventDict(resDetail)
317
- });
318
- window.dispatchEvent(responseEvent);
319
- });
320
- window.addEventListener(REQUEST_EVENT, requestListener);
321
- return () => window.removeEventListener(REQUEST_EVENT, requestListener);
322
- },
323
- verifyMessageData(data) {
324
- return structuredClone(data);
325
- }
326
- }));
327
- return __spreadProps(__spreadValues({}, messenger), {
328
- removeAllListeners() {
329
- messenger.removeAllListeners();
330
- removeAdditionalListeners.forEach((removeListener) => removeListener());
331
- }
332
- });
333
- }
334
- return __toCommonJS(page_exports);
335
- })();
1
+ var webExtCorePageMessaging=(function(e){Object.defineProperty(e,Symbol.toStringTag,{value:`Module`});let t=`string`,n=`object`;function r(e){return e!=null&&typeof e==n&&typeof e.name==t&&typeof e.message==t&&typeof e.stack==t}function i(e){if(typeof e!=n||e==null)return e;if(e instanceof Error)return{name:e.name,message:e.message,stack:e.stack??``,...e.cause?{cause:i(e.cause)}:{},...i({...e})};if(Array.isArray(e)){let t=[];for(let n of e)t.push(i(n));return t}let t=Object.create(null);for(let[n,r]of Object.entries(e))t[n]=i(r);return t}function a(e){if(r(e)){let t=Error(e.message,e.cause?{cause:a(e.cause)}:void 0);t.name=e.name,t.stack=e.stack;for(let[n,r]of Object.entries(e))n!==`name`&&n!==`message`&&n!==`stack`&&n!==`cause`&&(t[n]=r);return t}if(e==null||typeof e!=n)return e;if(Array.isArray(e)){let t=[];for(let n of e)t.push(a(n));return t}let t=Object.create(null);for(let[n,r]of Object.entries(e))t[n]=a(r);return t}function o(e){let t,n={};function r(){Object.entries(n).length===0&&(t?.(),t=void 0)}let o=Math.floor(Math.random()*1e4);function s(){return o++}return{async sendMessage(t,n,...r){let i={id:s(),type:t,data:n,timestamp:Date.now()},o=await e.verifyMessageData?.(i)??i;e.logger?.debug(`[messaging] sendMessage {id=${o.id}} ─ᐅ`,o,...r);let{res:c,err:l}=await e.sendMessage(o,...r)??{err:Error(`No response`)};if(e.logger?.debug(`[messaging] sendMessage {id=${o.id}} ᐊ─`,{res:c,err:l}),l!=null)throw a(l);return c},onMessage(a,o){if(t??=(e.logger?.debug(`[messaging] "${a}" initialized the message listener for this context`),e.addRootListener(t=>{if(typeof t.type!=`string`||typeof t.timestamp!=`number`)if(e.throwOnUnknownMessageFormat){let n=Error(`[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(t)}`);throw e.logger?.error(n),n}else return;e?.logger?.debug(`[messaging] Received message`,t);let r=n[t.type];if(r==null)return;let a=r(t);return Promise.resolve(a).then(t=>e.verifyMessageData?.(t)??t).then(n=>(e?.logger?.debug(`[messaging] onMessage {id=${t.id}} ─ᐅ`,{res:n}),{res:n})).catch(n=>(e?.logger?.debug(`[messaging] onMessage {id=${t.id}} ─ᐅ`,{err:n}),{err:i(n)}))})),n[a]!=null){let t=Error(`[messaging] In this JS context, only one listener can be setup for ${a}`);throw e.logger?.error(t),t}return n[a]=o,e.logger?.log(`[messaging] Added listener for ${a}`),()=>{delete n[a],r()}},removeAllListeners(){Object.keys(n).forEach(e=>{delete n[e]}),r()}}}function s(e,t={targetScope:window??void 0}){return typeof cloneInto<`u`?cloneInto(e,t.targetScope):e}function c(){return Math.random().toString(36).substring(2,10)}let l=`@webext-core/messaging/window`,u=`@webext-core/messaging/window/response`;function d(e){let t=e.namespace,n=c(),r=[],i=(e,i,a)=>new Promise(o=>{let s=r=>{r.data.type===u&&r.data.namespace===t&&r.data.instanceId!==n&&r.data.message.type===e.type&&r.data.message.id===e.id&&(o(r.data.response),c())},c=()=>window.removeEventListener(`message`,s);r.push(c),window.addEventListener(`message`,s),(a??window).postMessage({type:l,message:e,senderOrigin:location.origin,namespace:t,instanceId:n},i??`*`)}),a=o({...e,sendMessage(e,t,n){return i(e,t,n)},addRootListener(e){let r=async r=>{if(r.data.type!==l||r.data.namespace!==t||r.data.instanceId===n)return;let i=await e(r.data.message);window.postMessage({type:u,response:i,instanceId:n,message:r.data.message,namespace:t},r.data.senderOrigin)};return window.addEventListener(`message`,r),()=>window.removeEventListener(`message`,r)},verifyMessageData(e){return structuredClone(e)}});return{...a,removeAllListeners(){a.removeAllListeners(),r.forEach(e=>e()),r=[]}}}let f=`@webext-core/messaging/custom-events`,p=`@webext-core/messaging/custom-events/response`;function m(e){let t=e.namespace,n=c(),r=[],i=e=>new Promise(i=>{let a=()=>{window.removeEventListener(p,o);let e=r.indexOf(a);e!==-1&&r.splice(e,1)},o=r=>{let{detail:o}=r;o.namespace===t&&o.instanceId!==n&&o.message.type===e.detail.message.type&&o.message.id===e.detail.message.id&&(i(o.response),a())};r.push(a),window.addEventListener(p,o),window.dispatchEvent(e)}),a=o({...e,sendMessage(e){return i(new CustomEvent(f,{detail:s({message:e,namespace:t,instanceId:n})}))},addRootListener(e){let r=async r=>{let{detail:i,...a}=r;if(i.namespace!==t||i.instanceId===n)return;let o={...i.message,event:a},c={response:await e(o),message:o,instanceId:n,namespace:t},l=new CustomEvent(p,{detail:s(c)});window.dispatchEvent(l)};return window.addEventListener(f,r),()=>window.removeEventListener(f,r)},verifyMessageData(e){return structuredClone(e)}});return{...a,removeAllListeners(){a.removeAllListeners(),r.forEach(e=>e())}}}return e.defineCustomEventMessaging=m,e.defineWindowMessaging=d,e})({});
package/lib/page.mjs ADDED
@@ -0,0 +1,194 @@
1
+ import { t as defineGenericMessanging } from "./generic-429riQla.mjs";
2
+ //#region src/utils.ts
3
+ /**
4
+ * In firefox, when dispatching events externally from web-extension, it's necessary to clone all
5
+ * properties of the dictionary. ref:
6
+ * https://github.com/aklinker1/webext-core/pull/70#discussion_r1775031410
7
+ */
8
+ function prepareCustomEventDict(data, options = { targetScope: window ?? void 0 }) {
9
+ return typeof cloneInto !== "undefined" ? cloneInto(data, options.targetScope) : data;
10
+ }
11
+ function createId() {
12
+ return Math.random().toString(36).substring(2, 10);
13
+ }
14
+ //#endregion
15
+ //#region src/window.ts
16
+ const REQUEST_TYPE = "@webext-core/messaging/window";
17
+ const RESPONSE_TYPE = "@webext-core/messaging/window/response";
18
+ /**
19
+ * Returns a `WindowMessenger`. It is backed by the `window.postMessage` API. It can be used to
20
+ * communicate between:
21
+ *
22
+ * - Content script and website
23
+ * - Content script and injected script
24
+ *
25
+ * @example
26
+ * interface WebsiteMessengerSchema {
27
+ * initInjectedScript(data: ...): void;
28
+ * }
29
+ *
30
+ * export const websiteMessenger = defineWindowMessaging<initInjectedScript>();
31
+ *
32
+ * // Content script
33
+ * websiteMessenger.sendMessage("initInjectedScript", ...);
34
+ *
35
+ * // Injected script
36
+ * websiteMessenger.onMessage("initInjectedScript", (...) => {
37
+ * // ...
38
+ * })
39
+ *
40
+ * @link Spec diagrams
41
+ * 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
42
+ */
43
+ function defineWindowMessaging(config) {
44
+ const namespace = config.namespace;
45
+ const instanceId = createId();
46
+ let removeAdditionalListeners = [];
47
+ const sendWindowMessage = (message, targetOrigin, targetWindow) => new Promise((res) => {
48
+ const responseListener = (event) => {
49
+ if (event.data.type === RESPONSE_TYPE && event.data.namespace === namespace && event.data.instanceId !== instanceId && event.data.message.type === message.type && event.data.message.id === message.id) {
50
+ res(event.data.response);
51
+ removeResponseListener();
52
+ }
53
+ };
54
+ const removeResponseListener = () => window.removeEventListener("message", responseListener);
55
+ removeAdditionalListeners.push(removeResponseListener);
56
+ window.addEventListener("message", responseListener);
57
+ (targetWindow ?? window).postMessage({
58
+ type: REQUEST_TYPE,
59
+ message,
60
+ senderOrigin: location.origin,
61
+ namespace,
62
+ instanceId
63
+ }, targetOrigin ?? "*");
64
+ });
65
+ const messenger = defineGenericMessanging({
66
+ ...config,
67
+ sendMessage(message, targetOrigin, targetWindow) {
68
+ return sendWindowMessage(message, targetOrigin, targetWindow);
69
+ },
70
+ addRootListener(processMessage) {
71
+ const listener = async (event) => {
72
+ if (event.data.type !== REQUEST_TYPE || event.data.namespace !== namespace || event.data.instanceId === instanceId) return;
73
+ const response = await processMessage(event.data.message);
74
+ window.postMessage({
75
+ type: RESPONSE_TYPE,
76
+ response,
77
+ instanceId,
78
+ message: event.data.message,
79
+ namespace
80
+ }, event.data.senderOrigin);
81
+ };
82
+ window.addEventListener("message", listener);
83
+ return () => window.removeEventListener("message", listener);
84
+ },
85
+ verifyMessageData(data) {
86
+ return structuredClone(data);
87
+ }
88
+ });
89
+ return {
90
+ ...messenger,
91
+ removeAllListeners() {
92
+ messenger.removeAllListeners();
93
+ removeAdditionalListeners.forEach((removeListener) => removeListener());
94
+ removeAdditionalListeners = [];
95
+ }
96
+ };
97
+ }
98
+ //#endregion
99
+ //#region src/custom-event.ts
100
+ const REQUEST_EVENT = "@webext-core/messaging/custom-events";
101
+ const RESPONSE_EVENT = "@webext-core/messaging/custom-events/response";
102
+ /**
103
+ * Creates a `CustomEventMessenger`. This messenger is backed by the `CustomEvent` APIs. It can be
104
+ * used to communicate between:
105
+ *
106
+ * - Content script and website
107
+ * - Content script and injected script
108
+ *
109
+ * `sendMessage` does not accept any additional arguments..
110
+ *
111
+ * @example
112
+ * interface WebsiteMessengerSchema {
113
+ * initInjectedScript(data: ...): void;
114
+ * }
115
+ *
116
+ * export const websiteMessenger = defineCustomEventMessenger<initInjectedScript>();
117
+ *
118
+ * // Content script
119
+ * websiteMessenger.sendMessage("initInjectedScript", ...);
120
+ *
121
+ * // Injected script
122
+ * websiteMessenger.onMessage("initInjectedScript", (...) => {
123
+ * // ...
124
+ * })
125
+ *
126
+ * *
127
+ *
128
+ * @link Spec diagrams
129
+ * 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
130
+ */
131
+ function defineCustomEventMessaging(config) {
132
+ const namespace = config.namespace;
133
+ const instanceId = createId();
134
+ const removeAdditionalListeners = [];
135
+ const sendCustomMessage = (requestEvent) => new Promise((res) => {
136
+ const cleanup = () => {
137
+ window.removeEventListener(RESPONSE_EVENT, responseListener);
138
+ const index = removeAdditionalListeners.indexOf(cleanup);
139
+ if (index !== -1) removeAdditionalListeners.splice(index, 1);
140
+ };
141
+ const responseListener = (e) => {
142
+ const { detail } = e;
143
+ if (detail.namespace === namespace && detail.instanceId !== instanceId && detail.message.type === requestEvent.detail.message.type && detail.message.id === requestEvent.detail.message.id) {
144
+ res(detail.response);
145
+ cleanup();
146
+ }
147
+ };
148
+ removeAdditionalListeners.push(cleanup);
149
+ window.addEventListener(RESPONSE_EVENT, responseListener);
150
+ window.dispatchEvent(requestEvent);
151
+ });
152
+ const messenger = defineGenericMessanging({
153
+ ...config,
154
+ sendMessage(message) {
155
+ return sendCustomMessage(new CustomEvent(REQUEST_EVENT, { detail: prepareCustomEventDict({
156
+ message,
157
+ namespace,
158
+ instanceId
159
+ }) }));
160
+ },
161
+ addRootListener(processMessage) {
162
+ const requestListener = async (e) => {
163
+ const { detail, ...event } = e;
164
+ if (detail.namespace !== namespace || detail.instanceId === instanceId) return;
165
+ const message = {
166
+ ...detail.message,
167
+ event
168
+ };
169
+ const resDetail = {
170
+ response: await processMessage(message),
171
+ message,
172
+ instanceId,
173
+ namespace
174
+ };
175
+ const responseEvent = new CustomEvent(RESPONSE_EVENT, { detail: prepareCustomEventDict(resDetail) });
176
+ window.dispatchEvent(responseEvent);
177
+ };
178
+ window.addEventListener(REQUEST_EVENT, requestListener);
179
+ return () => window.removeEventListener(REQUEST_EVENT, requestListener);
180
+ },
181
+ verifyMessageData(data) {
182
+ return structuredClone(data);
183
+ }
184
+ });
185
+ return {
186
+ ...messenger,
187
+ removeAllListeners() {
188
+ messenger.removeAllListeners();
189
+ removeAdditionalListeners.forEach((removeListener) => removeListener());
190
+ }
191
+ };
192
+ }
193
+ //#endregion
194
+ export { defineCustomEventMessaging, defineWindowMessaging };