@webext-core/messaging 1.3.0 → 1.4.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.
package/lib/page.cjs ADDED
@@ -0,0 +1,259 @@
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_serialize_error = require("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;
96
+ const message = {
97
+ id: getNextId(),
98
+ type,
99
+ data,
100
+ timestamp: Date.now()
101
+ };
102
+ (_a2 = config.logger) == null ? void 0 : _a2.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message, ...args);
103
+ const response = yield config.sendMessage(message, ...args);
104
+ 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
+ if (err != null)
107
+ throw (0, import_serialize_error.deserializeError)(err);
108
+ return res;
109
+ });
110
+ },
111
+ onMessage(type, onReceived) {
112
+ var _a2, _b, _c;
113
+ if (removeRootListener == null) {
114
+ (_a2 = config.logger) == null ? void 0 : _a2.debug(
115
+ `[messaging] "${type}" initialized the message listener for this context`
116
+ );
117
+ removeRootListener = config.addRootListener((message) => {
118
+ var _a3, _b2;
119
+ if (typeof message.type != "string" || typeof message.timestamp !== "number") {
120
+ const err = Error(
121
+ `[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(
122
+ message
123
+ )}`
124
+ );
125
+ (_a3 = config.logger) == null ? void 0 : _a3.error(err);
126
+ throw err;
127
+ }
128
+ (_b2 = config == null ? void 0 : config.logger) == null ? void 0 : _b2.debug("[messaging] Received message", message);
129
+ const listener = perTypeListeners[message.type];
130
+ if (listener == null)
131
+ return;
132
+ const res = listener(message);
133
+ return Promise.resolve(res).then((res2) => {
134
+ var _a4;
135
+ (_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
136
+ return { res: res2 };
137
+ }).catch((err) => {
138
+ var _a4;
139
+ (_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { err });
140
+ return { err: (0, import_serialize_error.serializeError)(err) };
141
+ });
142
+ });
143
+ }
144
+ if (perTypeListeners[type] != null) {
145
+ const err = Error(
146
+ `[messaging] In this JS context, only one listener can be setup for ${type}`
147
+ );
148
+ (_b = config.logger) == null ? void 0 : _b.error(err);
149
+ throw err;
150
+ }
151
+ perTypeListeners[type] = onReceived;
152
+ (_c = config.logger) == null ? void 0 : _c.log(`[messaging] Added listener for ${type}`);
153
+ return () => {
154
+ delete perTypeListeners[type];
155
+ cleanupRootListener();
156
+ };
157
+ },
158
+ removeAllListeners() {
159
+ Object.keys(perTypeListeners).forEach((type) => {
160
+ delete perTypeListeners[type];
161
+ });
162
+ cleanupRootListener();
163
+ }
164
+ };
165
+ }
166
+
167
+ // src/window.ts
168
+ var REQUEST_TYPE = "@webext-core/messaging/window";
169
+ var RESPONSE_TYPE = "@webext-core/messaging/window/response";
170
+ function defineWindowMessaging(config) {
171
+ const namespace = config.namespace;
172
+ let removeAdditionalListeners = [];
173
+ const sendWindowMessage = (message, targetOrigin) => new Promise((res) => {
174
+ const responseListener = (event) => {
175
+ if (event.data.type === RESPONSE_TYPE) {
176
+ res(event.data.response);
177
+ removeResponseListener();
178
+ }
179
+ };
180
+ const removeResponseListener = () => window.removeEventListener("message", responseListener);
181
+ removeAdditionalListeners.push(removeResponseListener);
182
+ window.addEventListener("message", responseListener);
183
+ window.postMessage(
184
+ { type: REQUEST_TYPE, message, senderOrigin: location.origin, namespace },
185
+ targetOrigin != null ? targetOrigin : "*"
186
+ );
187
+ });
188
+ const messenger = defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
189
+ sendMessage(message, targetOrigin) {
190
+ return sendWindowMessage(message, targetOrigin);
191
+ },
192
+ addRootListener(processMessage) {
193
+ const listener = (event) => __async(this, null, function* () {
194
+ if (event.data.type !== REQUEST_TYPE || event.data.namespace !== namespace)
195
+ return;
196
+ const response = yield processMessage(event.data.message);
197
+ window.postMessage({ type: RESPONSE_TYPE, response }, event.data.senderOrigin);
198
+ });
199
+ window.addEventListener("message", listener);
200
+ return () => window.removeEventListener("message", listener);
201
+ }
202
+ }));
203
+ return __spreadProps(__spreadValues({}, messenger), {
204
+ removeAllListeners() {
205
+ messenger.removeAllListeners();
206
+ removeAdditionalListeners.forEach((removeListener) => removeListener());
207
+ removeAdditionalListeners = [];
208
+ }
209
+ });
210
+ }
211
+
212
+ // src/custom-event.ts
213
+ var REQUEST_EVENT = "@webext-core/messaging/custom-events";
214
+ var RESPONSE_EVENT = "@webext-core/messaging/custom-events/response";
215
+ function defineCustomEventMessaging(config) {
216
+ const namespace = config.namespace;
217
+ const removeAdditionalListeners = [];
218
+ const sendCustomMessage = (event) => new Promise((res) => {
219
+ const responseListener = (e) => {
220
+ const { detail } = e;
221
+ res(detail);
222
+ };
223
+ removeAdditionalListeners.push(
224
+ () => window.removeEventListener(RESPONSE_EVENT, responseListener)
225
+ );
226
+ window.addEventListener(RESPONSE_EVENT, responseListener, { once: true });
227
+ window.dispatchEvent(event);
228
+ });
229
+ const messenger = defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
230
+ sendMessage(message) {
231
+ const event = new CustomEvent(REQUEST_EVENT, { detail: { message, namespace } });
232
+ return sendCustomMessage(event);
233
+ },
234
+ addRootListener(processMessage) {
235
+ const listener = (e) => __async(this, null, function* () {
236
+ const _a = e, { detail } = _a, event = __objRest(_a, ["detail"]);
237
+ if (detail.namespace !== namespace)
238
+ return;
239
+ const message = __spreadProps(__spreadValues({}, detail.message), { event });
240
+ const response = yield processMessage(message);
241
+ const responseEvent = new CustomEvent(RESPONSE_EVENT, { detail: response });
242
+ window.dispatchEvent(responseEvent);
243
+ });
244
+ window.addEventListener(REQUEST_EVENT, listener);
245
+ return () => window.removeEventListener(REQUEST_EVENT, listener);
246
+ }
247
+ }));
248
+ return __spreadProps(__spreadValues({}, messenger), {
249
+ removeAllListeners() {
250
+ messenger.removeAllListeners();
251
+ removeAdditionalListeners.forEach((removeListener) => removeListener());
252
+ }
253
+ });
254
+ }
255
+ // Annotate the CommonJS export names for ESM import in node:
256
+ 0 && (module.exports = {
257
+ defineCustomEventMessaging,
258
+ defineWindowMessaging
259
+ });
package/lib/page.d.ts ADDED
@@ -0,0 +1,86 @@
1
+ import { N as NamespaceMessagingConfig, G as GenericMessenger } from './generic-e806d3a5.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
+ declare type WindowSendMessageArgs = [targetOrigin?: string];
16
+ declare type WindowMessenger<TProtocolMap extends Record<string, any>> = GenericMessenger<TProtocolMap, {}, WindowSendMessageArgs>;
17
+ /**
18
+ * Returns a `WindowMessenger`. It is backed by the `window.postMessage` API. It can be used to
19
+ * communicate between:
20
+ *
21
+ * - Content script and website
22
+ * - Content script and injected script
23
+ *
24
+ * @example
25
+ * interface WebsiteMessengerSchema {
26
+ * initInjectedScript(data: ...): void;
27
+ * }
28
+ *
29
+ * export const websiteMessenger = defineWindowMessaging<initInjectedScript>();
30
+ *
31
+ * // Content script
32
+ * websiteMessenger.sendMessage("initInjectedScript", ...);
33
+ *
34
+ * // Injected script
35
+ * websiteMessenger.onMessage("initInjectedScript", (...) => {
36
+ * // ...
37
+ * })
38
+ */
39
+ declare function defineWindowMessaging<TProtocolMap extends Record<string, any> = Record<string, any>>(config: WindowMessagingConfig): WindowMessenger<TProtocolMap>;
40
+
41
+ /**
42
+ * Configuration passed into `defineCustomEventMessaging`.
43
+ */
44
+ interface CustomEventMessagingConfig extends NamespaceMessagingConfig {
45
+ }
46
+ /**
47
+ * Additional fields available on the `Message` from a `CustomEventMessenger`.
48
+ */
49
+ interface CustomEventMessage {
50
+ /**
51
+ * The event that was fired, resulting in the message being passed.
52
+ */
53
+ event: CustomEvent;
54
+ }
55
+ /**
56
+ * Messenger returned by `defineCustomEventMessenger`.
57
+ */
58
+ declare type CustomEventMessenger<TProtocolMap extends Record<string, any>> = GenericMessenger<TProtocolMap, CustomEventMessage, [
59
+ ]>;
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
+ declare function defineCustomEventMessaging<TProtocolMap extends Record<string, any> = Record<string, any>>(config: CustomEventMessagingConfig): CustomEventMessenger<TProtocolMap>;
85
+
86
+ export { CustomEventMessage, CustomEventMessagingConfig, CustomEventMessenger, WindowMessagingConfig, WindowMessenger, WindowSendMessageArgs, defineCustomEventMessaging, defineWindowMessaging };