@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.
@@ -0,0 +1,335 @@
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
+ })();
package/lib/page.js ADDED
@@ -0,0 +1,127 @@
1
+ import {
2
+ __async,
3
+ __objRest,
4
+ __spreadProps,
5
+ __spreadValues,
6
+ defineGenericMessanging
7
+ } from "./chunk-GMKXECDR.js";
8
+
9
+ // src/utils.ts
10
+ function prepareCustomEventDict(data, options = { targetScope: window != null ? window : void 0 }) {
11
+ return typeof cloneInto !== "undefined" ? cloneInto(data, options.targetScope) : data;
12
+ }
13
+ function createId() {
14
+ return Math.random().toString(36).substring(2, 10);
15
+ }
16
+
17
+ // src/window.ts
18
+ var REQUEST_TYPE = "@webext-core/messaging/window";
19
+ var RESPONSE_TYPE = "@webext-core/messaging/window/response";
20
+ function defineWindowMessaging(config) {
21
+ const namespace = config.namespace;
22
+ const instanceId = createId();
23
+ let removeAdditionalListeners = [];
24
+ const sendWindowMessage = (message, targetOrigin, targetWindow) => new Promise((res) => {
25
+ const responseListener = (event) => {
26
+ 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) {
27
+ res(event.data.response);
28
+ removeResponseListener();
29
+ }
30
+ };
31
+ const removeResponseListener = () => window.removeEventListener("message", responseListener);
32
+ removeAdditionalListeners.push(removeResponseListener);
33
+ window.addEventListener("message", responseListener);
34
+ (targetWindow != null ? targetWindow : window).postMessage(
35
+ { type: REQUEST_TYPE, message, senderOrigin: location.origin, namespace, instanceId },
36
+ targetOrigin != null ? targetOrigin : "*"
37
+ );
38
+ });
39
+ const messenger = defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
40
+ sendMessage(message, targetOrigin, targetWindow) {
41
+ return sendWindowMessage(message, targetOrigin, targetWindow);
42
+ },
43
+ addRootListener(processMessage) {
44
+ const listener = (event) => __async(this, null, function* () {
45
+ if (event.data.type !== REQUEST_TYPE || event.data.namespace !== namespace || event.data.instanceId === instanceId)
46
+ return;
47
+ const response = yield processMessage(event.data.message);
48
+ window.postMessage(
49
+ { type: RESPONSE_TYPE, response, instanceId, message: event.data.message, namespace },
50
+ event.data.senderOrigin
51
+ );
52
+ });
53
+ window.addEventListener("message", listener);
54
+ return () => window.removeEventListener("message", listener);
55
+ },
56
+ verifyMessageData(data) {
57
+ return structuredClone(data);
58
+ }
59
+ }));
60
+ return __spreadProps(__spreadValues({}, messenger), {
61
+ removeAllListeners() {
62
+ messenger.removeAllListeners();
63
+ removeAdditionalListeners.forEach((removeListener) => removeListener());
64
+ removeAdditionalListeners = [];
65
+ }
66
+ });
67
+ }
68
+
69
+ // src/custom-event.ts
70
+ var REQUEST_EVENT = "@webext-core/messaging/custom-events";
71
+ var RESPONSE_EVENT = "@webext-core/messaging/custom-events/response";
72
+ function defineCustomEventMessaging(config) {
73
+ const namespace = config.namespace;
74
+ const instanceId = createId();
75
+ const removeAdditionalListeners = [];
76
+ const sendCustomMessage = (requestEvent) => new Promise((res) => {
77
+ const responseListener = (e) => {
78
+ const { detail } = e;
79
+ if (detail.namespace === namespace && detail.instanceId !== instanceId && detail.message.type === requestEvent.detail.message.type && detail.message.id === requestEvent.detail.message.id) {
80
+ res(detail.response);
81
+ }
82
+ };
83
+ removeAdditionalListeners.push(
84
+ () => window.removeEventListener(RESPONSE_EVENT, responseListener)
85
+ );
86
+ window.addEventListener(RESPONSE_EVENT, responseListener);
87
+ window.dispatchEvent(requestEvent);
88
+ });
89
+ const messenger = defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
90
+ sendMessage(message) {
91
+ const reqDetail = { message, namespace, instanceId };
92
+ const requestEvent = new CustomEvent(REQUEST_EVENT, {
93
+ detail: prepareCustomEventDict(reqDetail)
94
+ });
95
+ return sendCustomMessage(requestEvent);
96
+ },
97
+ addRootListener(processMessage) {
98
+ const requestListener = (e) => __async(this, null, function* () {
99
+ const _a = e, { detail } = _a, event = __objRest(_a, ["detail"]);
100
+ if (detail.namespace !== namespace || detail.instanceId === instanceId)
101
+ return;
102
+ const message = __spreadProps(__spreadValues({}, detail.message), { event });
103
+ const response = yield processMessage(message);
104
+ const resDetail = { response, message, instanceId, namespace };
105
+ const responseEvent = new CustomEvent(RESPONSE_EVENT, {
106
+ detail: prepareCustomEventDict(resDetail)
107
+ });
108
+ window.dispatchEvent(responseEvent);
109
+ });
110
+ window.addEventListener(REQUEST_EVENT, requestListener);
111
+ return () => window.removeEventListener(REQUEST_EVENT, requestListener);
112
+ },
113
+ verifyMessageData(data) {
114
+ return structuredClone(data);
115
+ }
116
+ }));
117
+ return __spreadProps(__spreadValues({}, messenger), {
118
+ removeAllListeners() {
119
+ messenger.removeAllListeners();
120
+ removeAdditionalListeners.forEach((removeListener) => removeListener());
121
+ }
122
+ });
123
+ }
124
+ export {
125
+ defineCustomEventMessaging,
126
+ defineWindowMessaging
127
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@webext-core/messaging",
3
- "version": "3.0.0",
3
+ "version": "3.0.1",
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": [
@@ -61,7 +61,8 @@
61
61
  "test:node": "buildc --deps-only -- vitest -r src --config ../vitest.config.node.ts",
62
62
  "test:browser": "buildc --deps-only -- vitest -r src --config ../vitest.config.browser.ts",
63
63
  "test:coverage": "buildc --deps-only -- bun run test:node --coverage && bun run test:browser --coverage",
64
- "check": "buildc --deps-only -- tsc --noEmit"
64
+ "check": "buildc --deps-only -- tsc --noEmit",
65
+ "prepack": "bun run build"
65
66
  },
66
67
  "dependencies": {
67
68
  "@aklinker1/zero-serialize-error": "^1.0.2",