@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/README.md +1 -1
- package/lib/generic-429riQla.mjs +79 -0
- package/lib/generic-B-kFbyP9.d.cts +122 -0
- package/lib/generic-B-kFbyP9.d.mts +122 -0
- package/lib/generic-CSGM8pRq.cjs +84 -0
- package/lib/index.cjs +46 -195
- package/lib/index.d.cts +42 -0
- package/lib/index.d.mts +42 -0
- package/lib/index.global.js +1 -1245
- package/lib/index.mjs +32 -0
- package/lib/page.cjs +189 -287
- package/lib/{page.d.ts → page.d.cts} +44 -51
- package/lib/page.d.mts +91 -0
- package/lib/page.global.js +1 -335
- package/lib/page.mjs +194 -0
- package/package.json +34 -30
- package/lib/chunk-GMKXECDR.js +0 -157
- package/lib/generic-c22f9780.d.ts +0 -137
- package/lib/index.d.ts +0 -54
- package/lib/index.js +0 -37
- package/lib/page.js +0 -127
package/lib/index.mjs
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { t as defineGenericMessanging } from "./generic-429riQla.mjs";
|
|
2
|
+
import Browser from "webextension-polyfill";
|
|
3
|
+
//#region src/extension.ts
|
|
4
|
+
/**
|
|
5
|
+
* Returns an `ExtensionMessenger` that is backed by the `browser.runtime.sendMessage` and
|
|
6
|
+
* `browser.tabs.sendMessage` APIs.
|
|
7
|
+
*
|
|
8
|
+
* It can be used to send messages to and from the background page/service worker.
|
|
9
|
+
*/
|
|
10
|
+
function defineExtensionMessaging(config) {
|
|
11
|
+
return defineGenericMessanging({
|
|
12
|
+
...config,
|
|
13
|
+
sendMessage(message, arg) {
|
|
14
|
+
if (arg == null) return Browser.runtime.sendMessage(message);
|
|
15
|
+
const options = typeof arg === "number" ? { tabId: arg } : arg;
|
|
16
|
+
return Browser.tabs.sendMessage(options.tabId, message, options.frameId != null ? { frameId: options.frameId } : void 0);
|
|
17
|
+
},
|
|
18
|
+
addRootListener(processMessage) {
|
|
19
|
+
const listener = (message, sender) => {
|
|
20
|
+
if (typeof message === "object") return processMessage({
|
|
21
|
+
...message,
|
|
22
|
+
sender
|
|
23
|
+
});
|
|
24
|
+
else return processMessage(message);
|
|
25
|
+
};
|
|
26
|
+
Browser.runtime.onMessage.addListener(listener);
|
|
27
|
+
return () => Browser.runtime.onMessage.removeListener(listener);
|
|
28
|
+
}
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
//#endregion
|
|
32
|
+
export { defineExtensionMessaging };
|
package/lib/page.cjs
CHANGED
|
@@ -1,294 +1,196 @@
|
|
|
1
|
-
"
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
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;
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
+
const require_generic = require("./generic-CSGM8pRq.cjs");
|
|
3
|
+
//#region src/utils.ts
|
|
4
|
+
/**
|
|
5
|
+
* In firefox, when dispatching events externally from web-extension, it's necessary to clone all
|
|
6
|
+
* properties of the dictionary. ref:
|
|
7
|
+
* https://github.com/aklinker1/webext-core/pull/70#discussion_r1775031410
|
|
8
|
+
*/
|
|
9
|
+
function prepareCustomEventDict(data, options = { targetScope: window ?? void 0 }) {
|
|
10
|
+
return typeof cloneInto !== "undefined" ? cloneInto(data, options.targetScope) : data;
|
|
178
11
|
}
|
|
179
12
|
function createId() {
|
|
180
|
-
|
|
13
|
+
return Math.random().toString(36).substring(2, 10);
|
|
181
14
|
}
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
15
|
+
//#endregion
|
|
16
|
+
//#region src/window.ts
|
|
17
|
+
const REQUEST_TYPE = "@webext-core/messaging/window";
|
|
18
|
+
const RESPONSE_TYPE = "@webext-core/messaging/window/response";
|
|
19
|
+
/**
|
|
20
|
+
* Returns a `WindowMessenger`. It is backed by the `window.postMessage` API. It can be used to
|
|
21
|
+
* communicate between:
|
|
22
|
+
*
|
|
23
|
+
* - Content script and website
|
|
24
|
+
* - Content script and injected script
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* interface WebsiteMessengerSchema {
|
|
28
|
+
* initInjectedScript(data: ...): void;
|
|
29
|
+
* }
|
|
30
|
+
*
|
|
31
|
+
* export const websiteMessenger = defineWindowMessaging<initInjectedScript>();
|
|
32
|
+
*
|
|
33
|
+
* // Content script
|
|
34
|
+
* websiteMessenger.sendMessage("initInjectedScript", ...);
|
|
35
|
+
*
|
|
36
|
+
* // Injected script
|
|
37
|
+
* websiteMessenger.onMessage("initInjectedScript", (...) => {
|
|
38
|
+
* // ...
|
|
39
|
+
* })
|
|
40
|
+
*
|
|
41
|
+
* @link Spec diagrams
|
|
42
|
+
* 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
|
|
43
|
+
*/
|
|
186
44
|
function defineWindowMessaging(config) {
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
45
|
+
const namespace = config.namespace;
|
|
46
|
+
const instanceId = createId();
|
|
47
|
+
let removeAdditionalListeners = [];
|
|
48
|
+
const sendWindowMessage = (message, targetOrigin, targetWindow) => new Promise((res) => {
|
|
49
|
+
const responseListener = (event) => {
|
|
50
|
+
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) {
|
|
51
|
+
res(event.data.response);
|
|
52
|
+
removeResponseListener();
|
|
53
|
+
}
|
|
54
|
+
};
|
|
55
|
+
const removeResponseListener = () => window.removeEventListener("message", responseListener);
|
|
56
|
+
removeAdditionalListeners.push(removeResponseListener);
|
|
57
|
+
window.addEventListener("message", responseListener);
|
|
58
|
+
(targetWindow ?? window).postMessage({
|
|
59
|
+
type: REQUEST_TYPE,
|
|
60
|
+
message,
|
|
61
|
+
senderOrigin: location.origin,
|
|
62
|
+
namespace,
|
|
63
|
+
instanceId
|
|
64
|
+
}, targetOrigin ?? "*");
|
|
65
|
+
});
|
|
66
|
+
const messenger = require_generic.defineGenericMessanging({
|
|
67
|
+
...config,
|
|
68
|
+
sendMessage(message, targetOrigin, targetWindow) {
|
|
69
|
+
return sendWindowMessage(message, targetOrigin, targetWindow);
|
|
70
|
+
},
|
|
71
|
+
addRootListener(processMessage) {
|
|
72
|
+
const listener = async (event) => {
|
|
73
|
+
if (event.data.type !== REQUEST_TYPE || event.data.namespace !== namespace || event.data.instanceId === instanceId) return;
|
|
74
|
+
const response = await processMessage(event.data.message);
|
|
75
|
+
window.postMessage({
|
|
76
|
+
type: RESPONSE_TYPE,
|
|
77
|
+
response,
|
|
78
|
+
instanceId,
|
|
79
|
+
message: event.data.message,
|
|
80
|
+
namespace
|
|
81
|
+
}, event.data.senderOrigin);
|
|
82
|
+
};
|
|
83
|
+
window.addEventListener("message", listener);
|
|
84
|
+
return () => window.removeEventListener("message", listener);
|
|
85
|
+
},
|
|
86
|
+
verifyMessageData(data) {
|
|
87
|
+
return structuredClone(data);
|
|
88
|
+
}
|
|
89
|
+
});
|
|
90
|
+
return {
|
|
91
|
+
...messenger,
|
|
92
|
+
removeAllListeners() {
|
|
93
|
+
messenger.removeAllListeners();
|
|
94
|
+
removeAdditionalListeners.forEach((removeListener) => removeListener());
|
|
95
|
+
removeAdditionalListeners = [];
|
|
96
|
+
}
|
|
97
|
+
};
|
|
233
98
|
}
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
99
|
+
//#endregion
|
|
100
|
+
//#region src/custom-event.ts
|
|
101
|
+
const REQUEST_EVENT = "@webext-core/messaging/custom-events";
|
|
102
|
+
const RESPONSE_EVENT = "@webext-core/messaging/custom-events/response";
|
|
103
|
+
/**
|
|
104
|
+
* Creates a `CustomEventMessenger`. This messenger is backed by the `CustomEvent` APIs. It can be
|
|
105
|
+
* used to communicate between:
|
|
106
|
+
*
|
|
107
|
+
* - Content script and website
|
|
108
|
+
* - Content script and injected script
|
|
109
|
+
*
|
|
110
|
+
* `sendMessage` does not accept any additional arguments..
|
|
111
|
+
*
|
|
112
|
+
* @example
|
|
113
|
+
* interface WebsiteMessengerSchema {
|
|
114
|
+
* initInjectedScript(data: ...): void;
|
|
115
|
+
* }
|
|
116
|
+
*
|
|
117
|
+
* export const websiteMessenger = defineCustomEventMessenger<initInjectedScript>();
|
|
118
|
+
*
|
|
119
|
+
* // Content script
|
|
120
|
+
* websiteMessenger.sendMessage("initInjectedScript", ...);
|
|
121
|
+
*
|
|
122
|
+
* // Injected script
|
|
123
|
+
* websiteMessenger.onMessage("initInjectedScript", (...) => {
|
|
124
|
+
* // ...
|
|
125
|
+
* })
|
|
126
|
+
*
|
|
127
|
+
* *
|
|
128
|
+
*
|
|
129
|
+
* @link Spec diagrams
|
|
130
|
+
* 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
|
|
131
|
+
*/
|
|
238
132
|
function defineCustomEventMessaging(config) {
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
133
|
+
const namespace = config.namespace;
|
|
134
|
+
const instanceId = createId();
|
|
135
|
+
const removeAdditionalListeners = [];
|
|
136
|
+
const sendCustomMessage = (requestEvent) => new Promise((res) => {
|
|
137
|
+
const cleanup = () => {
|
|
138
|
+
window.removeEventListener(RESPONSE_EVENT, responseListener);
|
|
139
|
+
const index = removeAdditionalListeners.indexOf(cleanup);
|
|
140
|
+
if (index !== -1) removeAdditionalListeners.splice(index, 1);
|
|
141
|
+
};
|
|
142
|
+
const responseListener = (e) => {
|
|
143
|
+
const { detail } = e;
|
|
144
|
+
if (detail.namespace === namespace && detail.instanceId !== instanceId && detail.message.type === requestEvent.detail.message.type && detail.message.id === requestEvent.detail.message.id) {
|
|
145
|
+
res(detail.response);
|
|
146
|
+
cleanup();
|
|
147
|
+
}
|
|
148
|
+
};
|
|
149
|
+
removeAdditionalListeners.push(cleanup);
|
|
150
|
+
window.addEventListener(RESPONSE_EVENT, responseListener);
|
|
151
|
+
window.dispatchEvent(requestEvent);
|
|
152
|
+
});
|
|
153
|
+
const messenger = require_generic.defineGenericMessanging({
|
|
154
|
+
...config,
|
|
155
|
+
sendMessage(message) {
|
|
156
|
+
return sendCustomMessage(new CustomEvent(REQUEST_EVENT, { detail: prepareCustomEventDict({
|
|
157
|
+
message,
|
|
158
|
+
namespace,
|
|
159
|
+
instanceId
|
|
160
|
+
}) }));
|
|
161
|
+
},
|
|
162
|
+
addRootListener(processMessage) {
|
|
163
|
+
const requestListener = async (e) => {
|
|
164
|
+
const { detail, ...event } = e;
|
|
165
|
+
if (detail.namespace !== namespace || detail.instanceId === instanceId) return;
|
|
166
|
+
const message = {
|
|
167
|
+
...detail.message,
|
|
168
|
+
event
|
|
169
|
+
};
|
|
170
|
+
const resDetail = {
|
|
171
|
+
response: await processMessage(message),
|
|
172
|
+
message,
|
|
173
|
+
instanceId,
|
|
174
|
+
namespace
|
|
175
|
+
};
|
|
176
|
+
const responseEvent = new CustomEvent(RESPONSE_EVENT, { detail: prepareCustomEventDict(resDetail) });
|
|
177
|
+
window.dispatchEvent(responseEvent);
|
|
178
|
+
};
|
|
179
|
+
window.addEventListener(REQUEST_EVENT, requestListener);
|
|
180
|
+
return () => window.removeEventListener(REQUEST_EVENT, requestListener);
|
|
181
|
+
},
|
|
182
|
+
verifyMessageData(data) {
|
|
183
|
+
return structuredClone(data);
|
|
184
|
+
}
|
|
185
|
+
});
|
|
186
|
+
return {
|
|
187
|
+
...messenger,
|
|
188
|
+
removeAllListeners() {
|
|
189
|
+
messenger.removeAllListeners();
|
|
190
|
+
removeAdditionalListeners.forEach((removeListener) => removeListener());
|
|
191
|
+
}
|
|
192
|
+
};
|
|
289
193
|
}
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
defineWindowMessaging
|
|
294
|
-
});
|
|
194
|
+
//#endregion
|
|
195
|
+
exports.defineCustomEventMessaging = defineCustomEventMessaging;
|
|
196
|
+
exports.defineWindowMessaging = defineWindowMessaging;
|
|
@@ -1,71 +1,62 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { c as NamespaceMessagingConfig, t as GenericMessenger } from "./generic-B-kFbyP9.cjs";
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
interface WindowMessagingConfig extends NamespaceMessagingConfig {
|
|
7
|
-
}
|
|
3
|
+
//#region src/window.d.ts
|
|
4
|
+
/** Configuration passed into `defineWindowMessaging`. */
|
|
5
|
+
interface WindowMessagingConfig extends NamespaceMessagingConfig {}
|
|
8
6
|
/**
|
|
9
7
|
* For a `WindowMessenger`, `sendMessage` requires an additional argument, the `targetOrigin`. It
|
|
10
8
|
* defines which frames inside the page should receive the message.
|
|
11
9
|
*
|
|
12
|
-
* > See
|
|
13
|
-
*
|
|
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:
|
|
14
15
|
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
* by default global window is used to send mesage
|
|
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
20
|
*/
|
|
21
21
|
type WindowSendMessageArgs = [targetOrigin?: string, targetWindow?: Window];
|
|
22
22
|
type WindowMessenger<TProtocolMap extends Record<string, any>> = GenericMessenger<TProtocolMap, {}, WindowSendMessageArgs>;
|
|
23
23
|
/**
|
|
24
|
-
* Returns a `WindowMessenger`. It is backed by the `window.postMessage` API.
|
|
24
|
+
* Returns a `WindowMessenger`. It is backed by the `window.postMessage` API. It can be used to
|
|
25
25
|
* communicate between:
|
|
26
26
|
*
|
|
27
27
|
* - Content script and website
|
|
28
28
|
* - Content script and injected script
|
|
29
29
|
*
|
|
30
30
|
* @example
|
|
31
|
-
*
|
|
31
|
+
* interface WebsiteMessengerSchema {
|
|
32
32
|
* initInjectedScript(data: ...): void;
|
|
33
|
-
*
|
|
33
|
+
* }
|
|
34
34
|
*
|
|
35
|
-
*
|
|
35
|
+
* export const websiteMessenger = defineWindowMessaging<initInjectedScript>();
|
|
36
36
|
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
37
|
+
* // Content script
|
|
38
|
+
* websiteMessenger.sendMessage("initInjectedScript", ...);
|
|
39
39
|
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
40
|
+
* // Injected script
|
|
41
|
+
* websiteMessenger.onMessage("initInjectedScript", (...) => {
|
|
42
42
|
* // ...
|
|
43
|
-
*
|
|
43
|
+
* })
|
|
44
44
|
*
|
|
45
45
|
* @link Spec diagrams
|
|
46
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
47
|
*/
|
|
48
48
|
declare function defineWindowMessaging<TProtocolMap extends Record<string, any> = Record<string, any>>(config: WindowMessagingConfig): WindowMessenger<TProtocolMap>;
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
}
|
|
55
|
-
/**
|
|
56
|
-
* Additional fields available on the `Message` from a `CustomEventMessenger`.
|
|
57
|
-
*/
|
|
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`. */
|
|
58
54
|
interface CustomEventMessage {
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
*/
|
|
62
|
-
event: CustomEvent;
|
|
55
|
+
/** The event that was fired, resulting in the message being passed. */
|
|
56
|
+
event: CustomEvent;
|
|
63
57
|
}
|
|
64
|
-
/**
|
|
65
|
-
|
|
66
|
-
*/
|
|
67
|
-
type CustomEventMessenger<TProtocolMap extends Record<string, any>> = GenericMessenger<TProtocolMap, CustomEventMessage, [
|
|
68
|
-
]>;
|
|
58
|
+
/** Messenger returned by `defineCustomEventMessenger`. */
|
|
59
|
+
type CustomEventMessenger<TProtocolMap extends Record<string, any>> = GenericMessenger<TProtocolMap, CustomEventMessage, []>;
|
|
69
60
|
/**
|
|
70
61
|
* Creates a `CustomEventMessenger`. This messenger is backed by the `CustomEvent` APIs. It can be
|
|
71
62
|
* used to communicate between:
|
|
@@ -76,23 +67,25 @@ type CustomEventMessenger<TProtocolMap extends Record<string, any>> = GenericMes
|
|
|
76
67
|
* `sendMessage` does not accept any additional arguments..
|
|
77
68
|
*
|
|
78
69
|
* @example
|
|
79
|
-
*
|
|
70
|
+
* interface WebsiteMessengerSchema {
|
|
80
71
|
* initInjectedScript(data: ...): void;
|
|
81
|
-
*
|
|
72
|
+
* }
|
|
82
73
|
*
|
|
83
|
-
*
|
|
74
|
+
* export const websiteMessenger = defineCustomEventMessenger<initInjectedScript>();
|
|
84
75
|
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
76
|
+
* // Content script
|
|
77
|
+
* websiteMessenger.sendMessage("initInjectedScript", ...);
|
|
87
78
|
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
79
|
+
* // Injected script
|
|
80
|
+
* websiteMessenger.onMessage("initInjectedScript", (...) => {
|
|
90
81
|
* // ...
|
|
91
|
-
*
|
|
82
|
+
* })
|
|
92
83
|
*
|
|
93
|
-
*
|
|
84
|
+
* *
|
|
85
|
+
*
|
|
86
|
+
* @link Spec diagrams
|
|
94
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
|
|
95
88
|
*/
|
|
96
89
|
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 };
|
|
90
|
+
//#endregion
|
|
91
|
+
export { CustomEventMessage, CustomEventMessagingConfig, CustomEventMessenger, WindowMessagingConfig, WindowMessenger, WindowSendMessageArgs, defineCustomEventMessaging, defineWindowMessaging };
|