@webext-core/messaging 3.0.0 → 3.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/index.js ADDED
@@ -0,0 +1,37 @@
1
+ import {
2
+ __spreadProps,
3
+ __spreadValues,
4
+ defineGenericMessanging
5
+ } from "./chunk-GMKXECDR.js";
6
+
7
+ // src/extension.ts
8
+ import Browser from "webextension-polyfill";
9
+ function defineExtensionMessaging(config) {
10
+ return defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
11
+ sendMessage(message, arg) {
12
+ if (arg == null) {
13
+ return Browser.runtime.sendMessage(message);
14
+ }
15
+ const options = typeof arg === "number" ? { tabId: arg } : arg;
16
+ return Browser.tabs.sendMessage(
17
+ options.tabId,
18
+ message,
19
+ // Pass frameId if specified
20
+ options.frameId != null ? { frameId: options.frameId } : void 0
21
+ );
22
+ },
23
+ addRootListener(processMessage) {
24
+ const listener = (message, sender) => {
25
+ if (typeof message === "object")
26
+ return processMessage(__spreadProps(__spreadValues({}, message), { sender }));
27
+ else
28
+ return processMessage(message);
29
+ };
30
+ Browser.runtime.onMessage.addListener(listener);
31
+ return () => Browser.runtime.onMessage.removeListener(listener);
32
+ }
33
+ }));
34
+ }
35
+ export {
36
+ defineExtensionMessaging
37
+ };
package/lib/page.cjs ADDED
@@ -0,0 +1,294 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __defProps = Object.defineProperties;
4
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
+ var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
6
+ var __getOwnPropNames = Object.getOwnPropertyNames;
7
+ var __getOwnPropSymbols = Object.getOwnPropertySymbols;
8
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
9
+ var __propIsEnum = Object.prototype.propertyIsEnumerable;
10
+ var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
11
+ var __spreadValues = (a, b) => {
12
+ for (var prop in b || (b = {}))
13
+ if (__hasOwnProp.call(b, prop))
14
+ __defNormalProp(a, prop, b[prop]);
15
+ if (__getOwnPropSymbols)
16
+ for (var prop of __getOwnPropSymbols(b)) {
17
+ if (__propIsEnum.call(b, prop))
18
+ __defNormalProp(a, prop, b[prop]);
19
+ }
20
+ return a;
21
+ };
22
+ var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
23
+ var __objRest = (source, exclude) => {
24
+ var target = {};
25
+ for (var prop in source)
26
+ if (__hasOwnProp.call(source, prop) && exclude.indexOf(prop) < 0)
27
+ target[prop] = source[prop];
28
+ if (source != null && __getOwnPropSymbols)
29
+ for (var prop of __getOwnPropSymbols(source)) {
30
+ if (exclude.indexOf(prop) < 0 && __propIsEnum.call(source, prop))
31
+ target[prop] = source[prop];
32
+ }
33
+ return target;
34
+ };
35
+ var __export = (target, all) => {
36
+ for (var name in all)
37
+ __defProp(target, name, { get: all[name], enumerable: true });
38
+ };
39
+ var __copyProps = (to, from, except, desc) => {
40
+ if (from && typeof from === "object" || typeof from === "function") {
41
+ for (let key of __getOwnPropNames(from))
42
+ if (!__hasOwnProp.call(to, key) && key !== except)
43
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
44
+ }
45
+ return to;
46
+ };
47
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
48
+ var __async = (__this, __arguments, generator) => {
49
+ return new Promise((resolve, reject) => {
50
+ var fulfilled = (value) => {
51
+ try {
52
+ step(generator.next(value));
53
+ } catch (e) {
54
+ reject(e);
55
+ }
56
+ };
57
+ var rejected = (value) => {
58
+ try {
59
+ step(generator.throw(value));
60
+ } catch (e) {
61
+ reject(e);
62
+ }
63
+ };
64
+ var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
65
+ step((generator = generator.apply(__this, __arguments)).next());
66
+ });
67
+ };
68
+
69
+ // src/page.ts
70
+ var page_exports = {};
71
+ __export(page_exports, {
72
+ defineCustomEventMessaging: () => defineCustomEventMessaging,
73
+ defineWindowMessaging: () => defineWindowMessaging
74
+ });
75
+ module.exports = __toCommonJS(page_exports);
76
+
77
+ // src/generic.ts
78
+ var import_zero_serialize_error = require("@aklinker1/zero-serialize-error");
79
+ function defineGenericMessanging(config) {
80
+ let removeRootListener;
81
+ let perTypeListeners = {};
82
+ function cleanupRootListener() {
83
+ if (Object.entries(perTypeListeners).length === 0) {
84
+ removeRootListener == null ? void 0 : removeRootListener();
85
+ removeRootListener = void 0;
86
+ }
87
+ }
88
+ let idSeq = Math.floor(Math.random() * 1e4);
89
+ function getNextId() {
90
+ return idSeq++;
91
+ }
92
+ return {
93
+ sendMessage(type, data, ...args) {
94
+ return __async(this, null, function* () {
95
+ var _a2, _b, _c, _d;
96
+ const _message = {
97
+ id: getNextId(),
98
+ type,
99
+ data,
100
+ timestamp: Date.now()
101
+ };
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);
104
+ const response = yield config.sendMessage(message, ...args);
105
+ const { res, err } = response != null ? response : { err: new Error("No response") };
106
+ (_d = config.logger) == null ? void 0 : _d.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
107
+ if (err != null)
108
+ throw (0, import_zero_serialize_error.deserializeError)(err);
109
+ return res;
110
+ });
111
+ },
112
+ onMessage(type, onReceived) {
113
+ var _a2, _b, _c;
114
+ if (removeRootListener == null) {
115
+ (_a2 = config.logger) == null ? void 0 : _a2.debug(
116
+ `[messaging] "${type}" initialized the message listener for this context`
117
+ );
118
+ removeRootListener = config.addRootListener((message) => {
119
+ var _a3, _b2;
120
+ if (typeof message.type != "string" || typeof message.timestamp !== "number") {
121
+ if (config.throwOnUnknownMessageFormat) {
122
+ const err = Error(
123
+ `[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(
124
+ message
125
+ )}`
126
+ );
127
+ (_a3 = config.logger) == null ? void 0 : _a3.error(err);
128
+ throw err;
129
+ } else {
130
+ return;
131
+ }
132
+ }
133
+ (_b2 = config == null ? void 0 : config.logger) == null ? void 0 : _b2.debug("[messaging] Received message", message);
134
+ const listener = perTypeListeners[message.type];
135
+ if (listener == null)
136
+ return;
137
+ const res = listener(message);
138
+ return Promise.resolve(res).then((res2) => {
139
+ var _a4, _b3;
140
+ return (_b3 = (_a4 = config.verifyMessageData) == null ? void 0 : _a4.call(config, res2)) != null ? _b3 : res2;
141
+ }).then((res2) => {
142
+ var _a4;
143
+ (_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
144
+ return { res: res2 };
145
+ }).catch((err) => {
146
+ var _a4;
147
+ (_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { err });
148
+ return { err: (0, import_zero_serialize_error.serializeError)(err) };
149
+ });
150
+ });
151
+ }
152
+ if (perTypeListeners[type] != null) {
153
+ const err = Error(
154
+ `[messaging] In this JS context, only one listener can be setup for ${type}`
155
+ );
156
+ (_b = config.logger) == null ? void 0 : _b.error(err);
157
+ throw err;
158
+ }
159
+ perTypeListeners[type] = onReceived;
160
+ (_c = config.logger) == null ? void 0 : _c.log(`[messaging] Added listener for ${type}`);
161
+ return () => {
162
+ delete perTypeListeners[type];
163
+ cleanupRootListener();
164
+ };
165
+ },
166
+ removeAllListeners() {
167
+ Object.keys(perTypeListeners).forEach((type) => {
168
+ delete perTypeListeners[type];
169
+ });
170
+ cleanupRootListener();
171
+ }
172
+ };
173
+ }
174
+
175
+ // src/utils.ts
176
+ function prepareCustomEventDict(data, options = { targetScope: window != null ? window : void 0 }) {
177
+ return typeof cloneInto !== "undefined" ? cloneInto(data, options.targetScope) : data;
178
+ }
179
+ function createId() {
180
+ return Math.random().toString(36).substring(2, 10);
181
+ }
182
+
183
+ // src/window.ts
184
+ var REQUEST_TYPE = "@webext-core/messaging/window";
185
+ var RESPONSE_TYPE = "@webext-core/messaging/window/response";
186
+ function defineWindowMessaging(config) {
187
+ const namespace = config.namespace;
188
+ const instanceId = createId();
189
+ let removeAdditionalListeners = [];
190
+ const sendWindowMessage = (message, targetOrigin, targetWindow) => new Promise((res) => {
191
+ const responseListener = (event) => {
192
+ 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) {
193
+ res(event.data.response);
194
+ removeResponseListener();
195
+ }
196
+ };
197
+ const removeResponseListener = () => window.removeEventListener("message", responseListener);
198
+ removeAdditionalListeners.push(removeResponseListener);
199
+ window.addEventListener("message", responseListener);
200
+ (targetWindow != null ? targetWindow : window).postMessage(
201
+ { type: REQUEST_TYPE, message, senderOrigin: location.origin, namespace, instanceId },
202
+ targetOrigin != null ? targetOrigin : "*"
203
+ );
204
+ });
205
+ const messenger = defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
206
+ sendMessage(message, targetOrigin, targetWindow) {
207
+ return sendWindowMessage(message, targetOrigin, targetWindow);
208
+ },
209
+ addRootListener(processMessage) {
210
+ const listener = (event) => __async(this, null, function* () {
211
+ if (event.data.type !== REQUEST_TYPE || event.data.namespace !== namespace || event.data.instanceId === instanceId)
212
+ return;
213
+ const response = yield processMessage(event.data.message);
214
+ window.postMessage(
215
+ { type: RESPONSE_TYPE, response, instanceId, message: event.data.message, namespace },
216
+ event.data.senderOrigin
217
+ );
218
+ });
219
+ window.addEventListener("message", listener);
220
+ return () => window.removeEventListener("message", listener);
221
+ },
222
+ verifyMessageData(data) {
223
+ return structuredClone(data);
224
+ }
225
+ }));
226
+ return __spreadProps(__spreadValues({}, messenger), {
227
+ removeAllListeners() {
228
+ messenger.removeAllListeners();
229
+ removeAdditionalListeners.forEach((removeListener) => removeListener());
230
+ removeAdditionalListeners = [];
231
+ }
232
+ });
233
+ }
234
+
235
+ // src/custom-event.ts
236
+ var REQUEST_EVENT = "@webext-core/messaging/custom-events";
237
+ var RESPONSE_EVENT = "@webext-core/messaging/custom-events/response";
238
+ function defineCustomEventMessaging(config) {
239
+ const namespace = config.namespace;
240
+ const instanceId = createId();
241
+ const removeAdditionalListeners = [];
242
+ const sendCustomMessage = (requestEvent) => new Promise((res) => {
243
+ const responseListener = (e) => {
244
+ const { detail } = e;
245
+ if (detail.namespace === namespace && detail.instanceId !== instanceId && detail.message.type === requestEvent.detail.message.type && detail.message.id === requestEvent.detail.message.id) {
246
+ res(detail.response);
247
+ }
248
+ };
249
+ removeAdditionalListeners.push(
250
+ () => window.removeEventListener(RESPONSE_EVENT, responseListener)
251
+ );
252
+ window.addEventListener(RESPONSE_EVENT, responseListener);
253
+ window.dispatchEvent(requestEvent);
254
+ });
255
+ const messenger = defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
256
+ sendMessage(message) {
257
+ const reqDetail = { message, namespace, instanceId };
258
+ const requestEvent = new CustomEvent(REQUEST_EVENT, {
259
+ detail: prepareCustomEventDict(reqDetail)
260
+ });
261
+ return sendCustomMessage(requestEvent);
262
+ },
263
+ addRootListener(processMessage) {
264
+ const requestListener = (e) => __async(this, null, function* () {
265
+ const _a = e, { detail } = _a, event = __objRest(_a, ["detail"]);
266
+ if (detail.namespace !== namespace || detail.instanceId === instanceId)
267
+ return;
268
+ const message = __spreadProps(__spreadValues({}, detail.message), { event });
269
+ const response = yield processMessage(message);
270
+ const resDetail = { response, message, instanceId, namespace };
271
+ const responseEvent = new CustomEvent(RESPONSE_EVENT, {
272
+ detail: prepareCustomEventDict(resDetail)
273
+ });
274
+ window.dispatchEvent(responseEvent);
275
+ });
276
+ window.addEventListener(REQUEST_EVENT, requestListener);
277
+ return () => window.removeEventListener(REQUEST_EVENT, requestListener);
278
+ },
279
+ verifyMessageData(data) {
280
+ return structuredClone(data);
281
+ }
282
+ }));
283
+ return __spreadProps(__spreadValues({}, messenger), {
284
+ removeAllListeners() {
285
+ messenger.removeAllListeners();
286
+ removeAdditionalListeners.forEach((removeListener) => removeListener());
287
+ }
288
+ });
289
+ }
290
+ // Annotate the CommonJS export names for ESM import in node:
291
+ 0 && (module.exports = {
292
+ defineCustomEventMessaging,
293
+ defineWindowMessaging
294
+ });
package/lib/page.d.ts ADDED
@@ -0,0 +1,98 @@
1
+ import { N as NamespaceMessagingConfig, G as GenericMessenger } from './generic-c22f9780.js';
2
+
3
+ /**
4
+ * Configuration passed into `defineWindowMessaging`.
5
+ */
6
+ interface WindowMessagingConfig extends NamespaceMessagingConfig {
7
+ }
8
+ /**
9
+ * For a `WindowMessenger`, `sendMessage` requires an additional argument, the `targetOrigin`. It
10
+ * defines which frames inside the page should receive the message.
11
+ *
12
+ * > See <https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage#targetorigin> for more
13
+ * details.
14
+ *
15
+ * message is posted on window which can as per your need like
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 mesage
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
+
50
+ /**
51
+ * Configuration passed into `defineCustomEventMessaging`.
52
+ */
53
+ interface CustomEventMessagingConfig extends NamespaceMessagingConfig {
54
+ }
55
+ /**
56
+ * Additional fields available on the `Message` from a `CustomEventMessenger`.
57
+ */
58
+ interface CustomEventMessage {
59
+ /**
60
+ * The event that was fired, resulting in the message being passed.
61
+ */
62
+ event: CustomEvent;
63
+ }
64
+ /**
65
+ * Messenger returned by `defineCustomEventMessenger`.
66
+ */
67
+ type CustomEventMessenger<TProtocolMap extends Record<string, any>> = GenericMessenger<TProtocolMap, CustomEventMessage, [
68
+ ]>;
69
+ /**
70
+ * Creates a `CustomEventMessenger`. This messenger is backed by the `CustomEvent` APIs. It can be
71
+ * used to communicate between:
72
+ *
73
+ * - Content script and website
74
+ * - Content script and injected script
75
+ *
76
+ * `sendMessage` does not accept any additional arguments..
77
+ *
78
+ * @example
79
+ * interface WebsiteMessengerSchema {
80
+ * initInjectedScript(data: ...): void;
81
+ * }
82
+ *
83
+ * export const websiteMessenger = defineCustomEventMessenger<initInjectedScript>();
84
+ *
85
+ * // Content script
86
+ * websiteMessenger.sendMessage("initInjectedScript", ...);
87
+ *
88
+ * // Injected script
89
+ * websiteMessenger.onMessage("initInjectedScript", (...) => {
90
+ * // ...
91
+ * })
92
+ *
93
+ * * @link Spec diagrams
94
+ * 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
95
+ */
96
+ declare function defineCustomEventMessaging<TProtocolMap extends Record<string, any> = Record<string, any>>(config: CustomEventMessagingConfig): CustomEventMessenger<TProtocolMap>;
97
+
98
+ export { CustomEventMessage, CustomEventMessagingConfig, CustomEventMessenger, WindowMessagingConfig, WindowMessenger, WindowSendMessageArgs, defineCustomEventMessaging, defineWindowMessaging };