@webext-core/messaging 3.0.2 → 4.0.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/generic-429riQla.mjs → dist/generic-67DrFc4U.mjs} +11 -10
- package/{lib → dist}/index.d.mts +1 -3
- package/dist/index.iife.js +1 -0
- package/dist/index.mjs +38 -0
- package/{lib → dist}/page.d.mts +0 -1
- package/dist/page.iife.js +1 -0
- package/{lib → dist}/page.mjs +14 -5
- package/package.json +18 -27
- package/lib/generic-B-kFbyP9.d.cts +0 -122
- package/lib/generic-CSGM8pRq.cjs +0 -84
- package/lib/index.cjs +0 -56
- package/lib/index.d.cts +0 -42
- package/lib/index.global.js +0 -1
- package/lib/index.mjs +0 -32
- package/lib/page.cjs +0 -188
- package/lib/page.d.cts +0 -91
- package/lib/page.global.js +0 -1
- /package/{lib → dist}/generic-B-kFbyP9.d.mts +0 -0
|
@@ -43,16 +43,17 @@ function defineGenericMessanging(config) {
|
|
|
43
43
|
config?.logger?.debug("[messaging] Received message", message);
|
|
44
44
|
const listener = perTypeListeners[message.type];
|
|
45
45
|
if (listener == null) return;
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
46
|
+
return (async () => {
|
|
47
|
+
try {
|
|
48
|
+
const raw = await listener(message);
|
|
49
|
+
const res = config.verifyMessageData?.(raw) ?? raw;
|
|
50
|
+
config?.logger?.debug(`[messaging] onMessage {id=${message.id}} ─ᐅ`, { res });
|
|
51
|
+
return { res };
|
|
52
|
+
} catch (err) {
|
|
53
|
+
config?.logger?.debug(`[messaging] onMessage {id=${message.id}} ─ᐅ`, { err });
|
|
54
|
+
return { err: serializeError(err) };
|
|
55
|
+
}
|
|
56
|
+
})();
|
|
56
57
|
});
|
|
57
58
|
}
|
|
58
59
|
if (perTypeListeners[type] != null) {
|
package/{lib → dist}/index.d.mts
RENAMED
|
@@ -1,6 +1,4 @@
|
|
|
1
1
|
import { a as Logger, c as NamespaceMessagingConfig, i as GetReturnType, l as ProtocolWithReturn, n as BaseMessagingConfig, o as MaybePromise, r as GetDataType, s as Message, t as GenericMessenger, u as RemoveListenerCallback } from "./generic-B-kFbyP9.mjs";
|
|
2
|
-
import { Runtime } from "webextension-polyfill";
|
|
3
|
-
|
|
4
2
|
//#region src/extension.d.ts
|
|
5
3
|
/** Configuration passed into `defineExtensionMessaging`. */
|
|
6
4
|
interface ExtensionMessagingConfig extends BaseMessagingConfig {}
|
|
@@ -10,7 +8,7 @@ interface ExtensionMessage {
|
|
|
10
8
|
* Information about where the message came from. See
|
|
11
9
|
* [`Runtime.MessageSender`](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/MessageSender).
|
|
12
10
|
*/
|
|
13
|
-
sender:
|
|
11
|
+
sender: chrome.runtime.MessageSender;
|
|
14
12
|
}
|
|
15
13
|
/** Options for sending a message to a specific tab/frame */
|
|
16
14
|
interface SendMessageOptions {
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
var webExtCoreMessaging=(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(async()=>{try{let n=await r(t),i=e.verifyMessageData?.(n)??n;return e?.logger?.debug(`[messaging] onMessage {id=${t.id}} ─ᐅ`,{res:i}),{res:i}}catch(n){return 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){return o({...e,sendMessage(e,t){if(t==null)return new Promise((t,n)=>chrome.runtime.sendMessage(e,e=>{chrome.runtime.lastError?n(Error(chrome.runtime.lastError.message)):t(e)}));let n=typeof t==`number`?{tabId:t}:t;return new Promise(t=>chrome.tabs.sendMessage(n.tabId,e,n.frameId==null?void 0:{frameId:n.frameId},t))},addRootListener(e){let t=(t,n,r)=>{let i=e(typeof t==`object`?{...t,sender:n}:t);return i instanceof Promise?(i.then(r),!0):!1};return chrome.runtime.onMessage.addListener(t),()=>chrome.runtime.onMessage.removeListener(t)}})}return e.defineExtensionMessaging=s,e})({});
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { t as defineGenericMessanging } from "./generic-67DrFc4U.mjs";
|
|
2
|
+
//#region src/extension.ts
|
|
3
|
+
/**
|
|
4
|
+
* Returns an `ExtensionMessenger` that is backed by the `browser.runtime.sendMessage` and
|
|
5
|
+
* `browser.tabs.sendMessage` APIs.
|
|
6
|
+
*
|
|
7
|
+
* It can be used to send messages to and from the background page/service worker.
|
|
8
|
+
*/
|
|
9
|
+
function defineExtensionMessaging(config) {
|
|
10
|
+
return defineGenericMessanging({
|
|
11
|
+
...config,
|
|
12
|
+
sendMessage(message, arg) {
|
|
13
|
+
if (arg == null) return new Promise((resolve, reject) => chrome.runtime.sendMessage(message, (response) => {
|
|
14
|
+
if (chrome.runtime.lastError) reject(new Error(chrome.runtime.lastError.message));
|
|
15
|
+
else resolve(response);
|
|
16
|
+
}));
|
|
17
|
+
const options = typeof arg === "number" ? { tabId: arg } : arg;
|
|
18
|
+
return new Promise((res) => chrome.tabs.sendMessage(options.tabId, message, options.frameId != null ? { frameId: options.frameId } : void 0, res));
|
|
19
|
+
},
|
|
20
|
+
addRootListener(processMessage) {
|
|
21
|
+
const listener = (message, sender, sendResponse) => {
|
|
22
|
+
const res = processMessage(typeof message === "object" ? {
|
|
23
|
+
...message,
|
|
24
|
+
sender
|
|
25
|
+
} : message);
|
|
26
|
+
if (res instanceof Promise) {
|
|
27
|
+
res.then(sendResponse);
|
|
28
|
+
return true;
|
|
29
|
+
}
|
|
30
|
+
return false;
|
|
31
|
+
};
|
|
32
|
+
chrome.runtime.onMessage.addListener(listener);
|
|
33
|
+
return () => chrome.runtime.onMessage.removeListener(listener);
|
|
34
|
+
}
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
//#endregion
|
|
38
|
+
export { defineExtensionMessaging };
|
package/{lib → dist}/page.d.mts
RENAMED
|
@@ -0,0 +1 @@
|
|
|
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(async()=>{try{let n=await r(t),i=e.verifyMessageData?.(n)??n;return e?.logger?.debug(`[messaging] onMessage {id=${t.id}} ─ᐅ`,{res:i}),{res:i}}catch(n){return 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){let r=new CustomEvent(f,{detail:s({message:e,namespace:t,instanceId:n})});return i(r)},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 → dist}/page.mjs
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { t as defineGenericMessanging } from "./generic-
|
|
1
|
+
import { t as defineGenericMessanging } from "./generic-67DrFc4U.mjs";
|
|
2
2
|
//#region src/utils.ts
|
|
3
3
|
/**
|
|
4
4
|
* In firefox, when dispatching events externally from web-extension, it's necessary to clone all
|
|
@@ -133,22 +133,31 @@ function defineCustomEventMessaging(config) {
|
|
|
133
133
|
const instanceId = createId();
|
|
134
134
|
const removeAdditionalListeners = [];
|
|
135
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
|
+
};
|
|
136
141
|
const responseListener = (e) => {
|
|
137
142
|
const { detail } = e;
|
|
138
|
-
if (detail.namespace === namespace && detail.instanceId !== instanceId && detail.message.type === requestEvent.detail.message.type && detail.message.id === requestEvent.detail.message.id)
|
|
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
|
+
}
|
|
139
147
|
};
|
|
140
|
-
removeAdditionalListeners.push(
|
|
148
|
+
removeAdditionalListeners.push(cleanup);
|
|
141
149
|
window.addEventListener(RESPONSE_EVENT, responseListener);
|
|
142
150
|
window.dispatchEvent(requestEvent);
|
|
143
151
|
});
|
|
144
152
|
const messenger = defineGenericMessanging({
|
|
145
153
|
...config,
|
|
146
154
|
sendMessage(message) {
|
|
147
|
-
|
|
155
|
+
const requestEvent = new CustomEvent(REQUEST_EVENT, { detail: prepareCustomEventDict({
|
|
148
156
|
message,
|
|
149
157
|
namespace,
|
|
150
158
|
instanceId
|
|
151
|
-
}) })
|
|
159
|
+
}) });
|
|
160
|
+
return sendCustomMessage(requestEvent);
|
|
152
161
|
},
|
|
153
162
|
addRootListener(processMessage) {
|
|
154
163
|
const requestListener = async (e) => {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@webext-core/messaging",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "4.0.0",
|
|
4
4
|
"description": "Light weight, type-safe wrapper around the web extension messaging APIs. Supports all browsers (Chrome, Firefox, Safari)",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"browser",
|
|
@@ -24,33 +24,20 @@
|
|
|
24
24
|
"directory": "packages/messaging"
|
|
25
25
|
},
|
|
26
26
|
"files": [
|
|
27
|
-
"
|
|
27
|
+
"dist"
|
|
28
28
|
],
|
|
29
29
|
"type": "module",
|
|
30
30
|
"sideEffects": false,
|
|
31
|
-
"
|
|
32
|
-
"
|
|
33
|
-
"types": "./lib/index.d.mts",
|
|
31
|
+
"module": "./dist/index.mjs",
|
|
32
|
+
"types": "./dist/index.d.mts",
|
|
34
33
|
"exports": {
|
|
35
34
|
".": {
|
|
36
|
-
"
|
|
37
|
-
|
|
38
|
-
"default": "./lib/index.mjs"
|
|
39
|
-
},
|
|
40
|
-
"require": {
|
|
41
|
-
"types": "./lib/index.d.cts",
|
|
42
|
-
"default": "./lib/index.cjs"
|
|
43
|
-
}
|
|
35
|
+
"types": "./dist/index.d.mts",
|
|
36
|
+
"default": "./dist/index.mjs"
|
|
44
37
|
},
|
|
45
38
|
"./page": {
|
|
46
|
-
"
|
|
47
|
-
|
|
48
|
-
"default": "./lib/page.mjs"
|
|
49
|
-
},
|
|
50
|
-
"require": {
|
|
51
|
-
"types": "./lib/page.d.cts",
|
|
52
|
-
"default": "./lib/page.cjs"
|
|
53
|
-
}
|
|
39
|
+
"types": "./dist/page.d.mts",
|
|
40
|
+
"default": "./dist/page.mjs"
|
|
54
41
|
}
|
|
55
42
|
},
|
|
56
43
|
"publishConfig": {
|
|
@@ -64,21 +51,25 @@
|
|
|
64
51
|
"prepack": "bun run build"
|
|
65
52
|
},
|
|
66
53
|
"dependencies": {
|
|
67
|
-
"@aklinker1/zero-serialize-error": "^1.0.2"
|
|
68
|
-
"webextension-polyfill": ">=0.10.0"
|
|
54
|
+
"@aklinker1/zero-serialize-error": "^1.0.2"
|
|
69
55
|
},
|
|
70
56
|
"devDependencies": {
|
|
71
|
-
"@types/
|
|
57
|
+
"@types/chrome": "catalog:",
|
|
72
58
|
"@webext-core/fake-browser": "workspace:*",
|
|
73
59
|
"publint": "^0.2.11",
|
|
74
60
|
"tsconfig": "workspace:*",
|
|
75
61
|
"tsdown": "catalog:",
|
|
76
62
|
"typescript": "catalog:"
|
|
77
63
|
},
|
|
64
|
+
"peerDependencies": {
|
|
65
|
+
"@types/chrome": "*"
|
|
66
|
+
},
|
|
67
|
+
"peerDependenciesMeta": {
|
|
68
|
+
"@types/chrome": {
|
|
69
|
+
"optional": true
|
|
70
|
+
}
|
|
71
|
+
},
|
|
78
72
|
"engines": {
|
|
79
73
|
"node": "*"
|
|
80
|
-
},
|
|
81
|
-
"buildc": {
|
|
82
|
-
"outDir": "lib"
|
|
83
74
|
}
|
|
84
75
|
}
|
|
@@ -1,122 +0,0 @@
|
|
|
1
|
-
//#region src/types.d.ts
|
|
2
|
-
/** Interface used to log text to the console when sending and receiving messages. */
|
|
3
|
-
interface Logger {
|
|
4
|
-
debug(...args: any[]): void;
|
|
5
|
-
log(...args: any[]): void;
|
|
6
|
-
warn(...args: any[]): void;
|
|
7
|
-
error(...args: any[]): void;
|
|
8
|
-
}
|
|
9
|
-
/**
|
|
10
|
-
* Either a Promise of a type, or that type directly. Used to indicate that a method can by sync or
|
|
11
|
-
* async.
|
|
12
|
-
*/
|
|
13
|
-
type MaybePromise<T> = Promise<T> | T;
|
|
14
|
-
/**
|
|
15
|
-
* Used to add a return type to a message in the protocol map.
|
|
16
|
-
*
|
|
17
|
-
* > Internally, this is just an object with random keys for the data and return types.
|
|
18
|
-
*
|
|
19
|
-
* @deprecated Use the function syntax instead:
|
|
20
|
-
* [https://webext-core.aklinker1.io/messaging/protocol-maps.html#syntax](https://webext-core.aklinker1.io/messaging/protocol-maps.html#syntax)
|
|
21
|
-
* @example
|
|
22
|
-
* interface ProtocolMap {
|
|
23
|
-
* // data is a string, returns undefined
|
|
24
|
-
* type1: string;
|
|
25
|
-
* // data is a string, returns a number
|
|
26
|
-
* type2: ProtocolWithReturn<string, number>;
|
|
27
|
-
* }
|
|
28
|
-
*/
|
|
29
|
-
interface ProtocolWithReturn<TData, TReturn> {
|
|
30
|
-
/** Stores the data type. Randomly named so that it isn't accidentally implemented. */
|
|
31
|
-
BtVgCTPYZu: TData;
|
|
32
|
-
/** Stores the return type. Randomly named so that it isn't accidentally implemented. */
|
|
33
|
-
RrhVseLgZW: TReturn;
|
|
34
|
-
}
|
|
35
|
-
/** Given a function declaration, `ProtocolWithReturn`, or a value, return the message's data type. */
|
|
36
|
-
type GetDataType<T> = T extends ((...args: infer Args) => any) ? Args['length'] extends 0 | 1 ? Args[0] : never : T extends ProtocolWithReturn<any, any> ? T['BtVgCTPYZu'] : T;
|
|
37
|
-
/** Given a function declaration, `ProtocolWithReturn`, or a value, return the message's return type. */
|
|
38
|
-
type GetReturnType<T> = T extends ((...args: any[]) => infer R) ? R : T extends ProtocolWithReturn<any, any> ? T['RrhVseLgZW'] : void;
|
|
39
|
-
/**
|
|
40
|
-
* Call to ensure an active listener has been removed.
|
|
41
|
-
*
|
|
42
|
-
* If the listener has already been removed with `Messenger.removeAllListeners`, this is a noop.
|
|
43
|
-
*/
|
|
44
|
-
type RemoveListenerCallback = () => void;
|
|
45
|
-
/** Shared configuration between all the different messengers. */
|
|
46
|
-
interface BaseMessagingConfig {
|
|
47
|
-
/**
|
|
48
|
-
* The logger to use when logging messages. Set to `null` to disable logging.
|
|
49
|
-
*
|
|
50
|
-
* @default console
|
|
51
|
-
*/
|
|
52
|
-
logger?: Logger;
|
|
53
|
-
/**
|
|
54
|
-
* When a message is received that doesn't follow `@webext-core/messaging`'s format, it is
|
|
55
|
-
* ignored.
|
|
56
|
-
*
|
|
57
|
-
* Set this value to true to throw an error instead of ignoring it.
|
|
58
|
-
*
|
|
59
|
-
* @default false
|
|
60
|
-
*/
|
|
61
|
-
throwOnUnknownMessageFormat?: boolean;
|
|
62
|
-
}
|
|
63
|
-
interface NamespaceMessagingConfig extends BaseMessagingConfig {
|
|
64
|
-
/**
|
|
65
|
-
* A string used to ensure the messenger only sends messages to and listens for messages from
|
|
66
|
-
* other messengers of the same type, with the same namespace.
|
|
67
|
-
*/
|
|
68
|
-
namespace: string;
|
|
69
|
-
}
|
|
70
|
-
/** Contains information about the message received. */
|
|
71
|
-
interface Message<TProtocolMap extends Record<string, any>, TType extends keyof TProtocolMap> {
|
|
72
|
-
/** A semi-unique, auto-incrementing number used to trace messages being sent. */
|
|
73
|
-
id: number;
|
|
74
|
-
/** The data that was passed into `sendMessage` */
|
|
75
|
-
data: GetDataType<TProtocolMap[TType]>;
|
|
76
|
-
type: TType;
|
|
77
|
-
/** The timestamp the message was sent in MS since epoch. */
|
|
78
|
-
timestamp: number;
|
|
79
|
-
}
|
|
80
|
-
//#endregion
|
|
81
|
-
//#region src/generic.d.ts
|
|
82
|
-
/**
|
|
83
|
-
* Messaging interface shared by all messengers.
|
|
84
|
-
*
|
|
85
|
-
* Type parameters accept:
|
|
86
|
-
*
|
|
87
|
-
* - `TProtocolMap` to define the data and return types of messages.
|
|
88
|
-
* - `TMessageExtension` to define additional fields that are available on a message inside
|
|
89
|
-
* `onMessage`'s callback
|
|
90
|
-
* - `TSendMessageArgs` to define a list of additional arguments for `sendMessage`
|
|
91
|
-
*/
|
|
92
|
-
interface GenericMessenger<TProtocolMap extends Record<string, any>, TMessageExtension, TSendMessageArgs extends any[]> {
|
|
93
|
-
/**
|
|
94
|
-
* Send a message to the background or a specific tab if `tabId` is passed. You can call this
|
|
95
|
-
* function anywhere in your extension.
|
|
96
|
-
*
|
|
97
|
-
* If you haven't setup a listener for the sent `type`, an error will be thrown.
|
|
98
|
-
*
|
|
99
|
-
* @param type The message type being sent. Call `onMessage` with the same type to listen for that
|
|
100
|
-
* message.
|
|
101
|
-
* @param data The data to send with the message.
|
|
102
|
-
* @param args Different messengers will have additional arguments to configure how a message gets
|
|
103
|
-
* sent.
|
|
104
|
-
*/
|
|
105
|
-
sendMessage<TType extends keyof TProtocolMap>(this: void, type: TType, ...args: GetDataType<TProtocolMap[TType]> extends undefined ? [data?: undefined, ...args: TSendMessageArgs] : never): Promise<GetReturnType<TProtocolMap[TType]>>;
|
|
106
|
-
sendMessage<TType extends keyof TProtocolMap>(this: void, type: TType, data: GetDataType<TProtocolMap[TType]>, ...args: TSendMessageArgs): Promise<GetReturnType<TProtocolMap[TType]>>;
|
|
107
|
-
/**
|
|
108
|
-
* Trigger a callback when a message of the requested type is received. You cannot setup multiple
|
|
109
|
-
* listeners for the same message type in the same JS context.
|
|
110
|
-
*
|
|
111
|
-
* To remove the listener, call the returned message.
|
|
112
|
-
*
|
|
113
|
-
* @param type The message type to listen for. Call `sendMessage` with the same type to trigger
|
|
114
|
-
* this listener.
|
|
115
|
-
* @param onReceived The callback executed when a message is received.
|
|
116
|
-
*/
|
|
117
|
-
onMessage<TType extends keyof TProtocolMap>(this: void, type: TType, onReceived: (message: Message<TProtocolMap, TType> & TMessageExtension) => void | MaybePromise<GetReturnType<TProtocolMap[TType]>>): RemoveListenerCallback;
|
|
118
|
-
/** Removes all listeners. */
|
|
119
|
-
removeAllListeners(this: void): void;
|
|
120
|
-
}
|
|
121
|
-
//#endregion
|
|
122
|
-
export { Logger as a, NamespaceMessagingConfig as c, GetReturnType as i, ProtocolWithReturn as l, BaseMessagingConfig as n, MaybePromise as o, GetDataType as r, Message as s, GenericMessenger as t, RemoveListenerCallback as u };
|
package/lib/generic-CSGM8pRq.cjs
DELETED
|
@@ -1,84 +0,0 @@
|
|
|
1
|
-
let _aklinker1_zero_serialize_error = require("@aklinker1/zero-serialize-error");
|
|
2
|
-
//#region src/generic.ts
|
|
3
|
-
function defineGenericMessanging(config) {
|
|
4
|
-
let removeRootListener;
|
|
5
|
-
let perTypeListeners = {};
|
|
6
|
-
function cleanupRootListener() {
|
|
7
|
-
if (Object.entries(perTypeListeners).length === 0) {
|
|
8
|
-
removeRootListener?.();
|
|
9
|
-
removeRootListener = void 0;
|
|
10
|
-
}
|
|
11
|
-
}
|
|
12
|
-
let idSeq = Math.floor(Math.random() * 1e4);
|
|
13
|
-
function getNextId() {
|
|
14
|
-
return idSeq++;
|
|
15
|
-
}
|
|
16
|
-
return {
|
|
17
|
-
async sendMessage(type, data, ...args) {
|
|
18
|
-
const _message = {
|
|
19
|
-
id: getNextId(),
|
|
20
|
-
type,
|
|
21
|
-
data,
|
|
22
|
-
timestamp: Date.now()
|
|
23
|
-
};
|
|
24
|
-
const message = await config.verifyMessageData?.(_message) ?? _message;
|
|
25
|
-
config.logger?.debug(`[messaging] sendMessage {id=${message.id}} ─ᐅ`, message, ...args);
|
|
26
|
-
const { res, err } = await config.sendMessage(message, ...args) ?? { err: /* @__PURE__ */ new Error("No response") };
|
|
27
|
-
config.logger?.debug(`[messaging] sendMessage {id=${message.id}} ᐊ─`, {
|
|
28
|
-
res,
|
|
29
|
-
err
|
|
30
|
-
});
|
|
31
|
-
if (err != null) throw (0, _aklinker1_zero_serialize_error.deserializeError)(err);
|
|
32
|
-
return res;
|
|
33
|
-
},
|
|
34
|
-
onMessage(type, onReceived) {
|
|
35
|
-
if (removeRootListener == null) {
|
|
36
|
-
config.logger?.debug(`[messaging] "${type}" initialized the message listener for this context`);
|
|
37
|
-
removeRootListener = config.addRootListener((message) => {
|
|
38
|
-
if (typeof message.type != "string" || typeof message.timestamp !== "number") if (config.throwOnUnknownMessageFormat) {
|
|
39
|
-
const err = Error(`[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(message)}`);
|
|
40
|
-
config.logger?.error(err);
|
|
41
|
-
throw err;
|
|
42
|
-
} else return;
|
|
43
|
-
config?.logger?.debug("[messaging] Received message", message);
|
|
44
|
-
const listener = perTypeListeners[message.type];
|
|
45
|
-
if (listener == null) return;
|
|
46
|
-
const res = listener(message);
|
|
47
|
-
return Promise.resolve(res).then((res) => {
|
|
48
|
-
return config.verifyMessageData?.(res) ?? res;
|
|
49
|
-
}).then((res) => {
|
|
50
|
-
config?.logger?.debug(`[messaging] onMessage {id=${message.id}} ─ᐅ`, { res });
|
|
51
|
-
return { res };
|
|
52
|
-
}).catch((err) => {
|
|
53
|
-
config?.logger?.debug(`[messaging] onMessage {id=${message.id}} ─ᐅ`, { err });
|
|
54
|
-
return { err: (0, _aklinker1_zero_serialize_error.serializeError)(err) };
|
|
55
|
-
});
|
|
56
|
-
});
|
|
57
|
-
}
|
|
58
|
-
if (perTypeListeners[type] != null) {
|
|
59
|
-
const err = Error(`[messaging] In this JS context, only one listener can be setup for ${type}`);
|
|
60
|
-
config.logger?.error(err);
|
|
61
|
-
throw err;
|
|
62
|
-
}
|
|
63
|
-
perTypeListeners[type] = onReceived;
|
|
64
|
-
config.logger?.log(`[messaging] Added listener for ${type}`);
|
|
65
|
-
return () => {
|
|
66
|
-
delete perTypeListeners[type];
|
|
67
|
-
cleanupRootListener();
|
|
68
|
-
};
|
|
69
|
-
},
|
|
70
|
-
removeAllListeners() {
|
|
71
|
-
Object.keys(perTypeListeners).forEach((type) => {
|
|
72
|
-
delete perTypeListeners[type];
|
|
73
|
-
});
|
|
74
|
-
cleanupRootListener();
|
|
75
|
-
}
|
|
76
|
-
};
|
|
77
|
-
}
|
|
78
|
-
//#endregion
|
|
79
|
-
Object.defineProperty(exports, "defineGenericMessanging", {
|
|
80
|
-
enumerable: true,
|
|
81
|
-
get: function() {
|
|
82
|
-
return defineGenericMessanging;
|
|
83
|
-
}
|
|
84
|
-
});
|
package/lib/index.cjs
DELETED
|
@@ -1,56 +0,0 @@
|
|
|
1
|
-
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
-
//#region \0rolldown/runtime.js
|
|
3
|
-
var __create = Object.create;
|
|
4
|
-
var __defProp = Object.defineProperty;
|
|
5
|
-
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
6
|
-
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
7
|
-
var __getProtoOf = Object.getPrototypeOf;
|
|
8
|
-
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
9
|
-
var __copyProps = (to, from, except, desc) => {
|
|
10
|
-
if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
|
|
11
|
-
key = keys[i];
|
|
12
|
-
if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
|
|
13
|
-
get: ((k) => from[k]).bind(null, key),
|
|
14
|
-
enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
|
|
15
|
-
});
|
|
16
|
-
}
|
|
17
|
-
return to;
|
|
18
|
-
};
|
|
19
|
-
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
|
|
20
|
-
value: mod,
|
|
21
|
-
enumerable: true
|
|
22
|
-
}) : target, mod));
|
|
23
|
-
//#endregion
|
|
24
|
-
const require_generic = require("./generic-CSGM8pRq.cjs");
|
|
25
|
-
let webextension_polyfill = require("webextension-polyfill");
|
|
26
|
-
webextension_polyfill = __toESM(webextension_polyfill, 1);
|
|
27
|
-
//#region src/extension.ts
|
|
28
|
-
/**
|
|
29
|
-
* Returns an `ExtensionMessenger` that is backed by the `browser.runtime.sendMessage` and
|
|
30
|
-
* `browser.tabs.sendMessage` APIs.
|
|
31
|
-
*
|
|
32
|
-
* It can be used to send messages to and from the background page/service worker.
|
|
33
|
-
*/
|
|
34
|
-
function defineExtensionMessaging(config) {
|
|
35
|
-
return require_generic.defineGenericMessanging({
|
|
36
|
-
...config,
|
|
37
|
-
sendMessage(message, arg) {
|
|
38
|
-
if (arg == null) return webextension_polyfill.default.runtime.sendMessage(message);
|
|
39
|
-
const options = typeof arg === "number" ? { tabId: arg } : arg;
|
|
40
|
-
return webextension_polyfill.default.tabs.sendMessage(options.tabId, message, options.frameId != null ? { frameId: options.frameId } : void 0);
|
|
41
|
-
},
|
|
42
|
-
addRootListener(processMessage) {
|
|
43
|
-
const listener = (message, sender) => {
|
|
44
|
-
if (typeof message === "object") return processMessage({
|
|
45
|
-
...message,
|
|
46
|
-
sender
|
|
47
|
-
});
|
|
48
|
-
else return processMessage(message);
|
|
49
|
-
};
|
|
50
|
-
webextension_polyfill.default.runtime.onMessage.addListener(listener);
|
|
51
|
-
return () => webextension_polyfill.default.runtime.onMessage.removeListener(listener);
|
|
52
|
-
}
|
|
53
|
-
});
|
|
54
|
-
}
|
|
55
|
-
//#endregion
|
|
56
|
-
exports.defineExtensionMessaging = defineExtensionMessaging;
|
package/lib/index.d.cts
DELETED
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
import { a as Logger, c as NamespaceMessagingConfig, i as GetReturnType, l as ProtocolWithReturn, n as BaseMessagingConfig, o as MaybePromise, r as GetDataType, s as Message, t as GenericMessenger, u as RemoveListenerCallback } from "./generic-B-kFbyP9.cjs";
|
|
2
|
-
import { Runtime } from "webextension-polyfill";
|
|
3
|
-
|
|
4
|
-
//#region src/extension.d.ts
|
|
5
|
-
/** Configuration passed into `defineExtensionMessaging`. */
|
|
6
|
-
interface ExtensionMessagingConfig extends BaseMessagingConfig {}
|
|
7
|
-
/** Additional fields available on the `Message` from an `ExtensionMessenger`. */
|
|
8
|
-
interface ExtensionMessage {
|
|
9
|
-
/**
|
|
10
|
-
* Information about where the message came from. See
|
|
11
|
-
* [`Runtime.MessageSender`](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/MessageSender).
|
|
12
|
-
*/
|
|
13
|
-
sender: Runtime.MessageSender;
|
|
14
|
-
}
|
|
15
|
-
/** Options for sending a message to a specific tab/frame */
|
|
16
|
-
interface SendMessageOptions {
|
|
17
|
-
/** The tab to send a message to */
|
|
18
|
-
tabId: number;
|
|
19
|
-
/** The frame to send a message to. 0 represents the main frame. */
|
|
20
|
-
frameId?: number;
|
|
21
|
-
}
|
|
22
|
-
/**
|
|
23
|
-
* Send message accepts either:
|
|
24
|
-
*
|
|
25
|
-
* - No arguments to send to background
|
|
26
|
-
* - A tabId number to send to a specific tab
|
|
27
|
-
* - A SendMessageOptions object to target a specific tab and frame
|
|
28
|
-
*
|
|
29
|
-
* You cannot message between tabs directly. It must go through the background script.
|
|
30
|
-
*/
|
|
31
|
-
type ExtensionSendMessageArgs = [arg?: number | SendMessageOptions];
|
|
32
|
-
/** Messenger returned by `defineExtensionMessaging`. */
|
|
33
|
-
type ExtensionMessenger<TProtocolMap extends Record<string, any>> = GenericMessenger<TProtocolMap, ExtensionMessage, ExtensionSendMessageArgs>;
|
|
34
|
-
/**
|
|
35
|
-
* Returns an `ExtensionMessenger` that is backed by the `browser.runtime.sendMessage` and
|
|
36
|
-
* `browser.tabs.sendMessage` APIs.
|
|
37
|
-
*
|
|
38
|
-
* It can be used to send messages to and from the background page/service worker.
|
|
39
|
-
*/
|
|
40
|
-
declare function defineExtensionMessaging<TProtocolMap extends Record<string, any> = Record<string, any>>(config?: ExtensionMessagingConfig): ExtensionMessenger<TProtocolMap>;
|
|
41
|
-
//#endregion
|
|
42
|
-
export { BaseMessagingConfig, ExtensionMessage, ExtensionMessagingConfig, ExtensionMessenger, ExtensionSendMessageArgs, GetDataType, GetReturnType, Logger, MaybePromise, Message, NamespaceMessagingConfig, ProtocolWithReturn, RemoveListenerCallback, SendMessageOptions, defineExtensionMessaging };
|
package/lib/index.global.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
var webExtCoreMessaging=(function(e){Object.defineProperty(e,Symbol.toStringTag,{value:`Module`});var t=Object.create,n=Object.defineProperty,r=Object.getOwnPropertyDescriptor,i=Object.getOwnPropertyNames,a=Object.getPrototypeOf,o=Object.prototype.hasOwnProperty,s=(e,t)=>()=>(t||(e((t={exports:{}}).exports,t),e=null),t.exports),c=(e,t,a,s)=>{if(t&&typeof t==`object`||typeof t==`function`)for(var c=i(t),l=0,u=c.length,d;l<u;l++)d=c[l],!o.call(e,d)&&d!==a&&n(e,d,{get:(e=>t[e]).bind(null,d),enumerable:!(s=r(t,d))||s.enumerable});return e},l=((e,r,i)=>(i=e==null?{}:t(a(e)),c(r||!e||!e.__esModule?n(i,`default`,{value:e,enumerable:!0}):i,e)))(s(((e,t)=>{(function(n,r){if(typeof define==`function`&&define.amd)define(`webextension-polyfill`,[`module`],r);else if(e!==void 0)r(t);else{var i={exports:{}};r(i),n.browser=i.exports}})(typeof globalThis<`u`?globalThis:typeof self<`u`?self:e,function(e){"use strict";if(!(globalThis.chrome&&globalThis.chrome.runtime&&globalThis.chrome.runtime.id))throw Error(`This script should only be loaded in a browser extension.`);globalThis.browser&&globalThis.browser.runtime&&globalThis.browser.runtime.id?e.exports=globalThis.browser:e.exports=(e=>{let t={alarms:{clear:{minArgs:0,maxArgs:1},clearAll:{minArgs:0,maxArgs:0},get:{minArgs:0,maxArgs:1},getAll:{minArgs:0,maxArgs:0}},bookmarks:{create:{minArgs:1,maxArgs:1},get:{minArgs:1,maxArgs:1},getChildren:{minArgs:1,maxArgs:1},getRecent:{minArgs:1,maxArgs:1},getSubTree:{minArgs:1,maxArgs:1},getTree:{minArgs:0,maxArgs:0},move:{minArgs:2,maxArgs:2},remove:{minArgs:1,maxArgs:1},removeTree:{minArgs:1,maxArgs:1},search:{minArgs:1,maxArgs:1},update:{minArgs:2,maxArgs:2}},browserAction:{disable:{minArgs:0,maxArgs:1,fallbackToNoCallback:!0},enable:{minArgs:0,maxArgs:1,fallbackToNoCallback:!0},getBadgeBackgroundColor:{minArgs:1,maxArgs:1},getBadgeText:{minArgs:1,maxArgs:1},getPopup:{minArgs:1,maxArgs:1},getTitle:{minArgs:1,maxArgs:1},openPopup:{minArgs:0,maxArgs:0},setBadgeBackgroundColor:{minArgs:1,maxArgs:1,fallbackToNoCallback:!0},setBadgeText:{minArgs:1,maxArgs:1,fallbackToNoCallback:!0},setIcon:{minArgs:1,maxArgs:1},setPopup:{minArgs:1,maxArgs:1,fallbackToNoCallback:!0},setTitle:{minArgs:1,maxArgs:1,fallbackToNoCallback:!0}},browsingData:{remove:{minArgs:2,maxArgs:2},removeCache:{minArgs:1,maxArgs:1},removeCookies:{minArgs:1,maxArgs:1},removeDownloads:{minArgs:1,maxArgs:1},removeFormData:{minArgs:1,maxArgs:1},removeHistory:{minArgs:1,maxArgs:1},removeLocalStorage:{minArgs:1,maxArgs:1},removePasswords:{minArgs:1,maxArgs:1},removePluginData:{minArgs:1,maxArgs:1},settings:{minArgs:0,maxArgs:0}},commands:{getAll:{minArgs:0,maxArgs:0}},contextMenus:{remove:{minArgs:1,maxArgs:1},removeAll:{minArgs:0,maxArgs:0},update:{minArgs:2,maxArgs:2}},cookies:{get:{minArgs:1,maxArgs:1},getAll:{minArgs:1,maxArgs:1},getAllCookieStores:{minArgs:0,maxArgs:0},remove:{minArgs:1,maxArgs:1},set:{minArgs:1,maxArgs:1}},devtools:{inspectedWindow:{eval:{minArgs:1,maxArgs:2,singleCallbackArg:!1}},panels:{create:{minArgs:3,maxArgs:3,singleCallbackArg:!0},elements:{createSidebarPane:{minArgs:1,maxArgs:1}}}},downloads:{cancel:{minArgs:1,maxArgs:1},download:{minArgs:1,maxArgs:1},erase:{minArgs:1,maxArgs:1},getFileIcon:{minArgs:1,maxArgs:2},open:{minArgs:1,maxArgs:1,fallbackToNoCallback:!0},pause:{minArgs:1,maxArgs:1},removeFile:{minArgs:1,maxArgs:1},resume:{minArgs:1,maxArgs:1},search:{minArgs:1,maxArgs:1},show:{minArgs:1,maxArgs:1,fallbackToNoCallback:!0}},extension:{isAllowedFileSchemeAccess:{minArgs:0,maxArgs:0},isAllowedIncognitoAccess:{minArgs:0,maxArgs:0}},history:{addUrl:{minArgs:1,maxArgs:1},deleteAll:{minArgs:0,maxArgs:0},deleteRange:{minArgs:1,maxArgs:1},deleteUrl:{minArgs:1,maxArgs:1},getVisits:{minArgs:1,maxArgs:1},search:{minArgs:1,maxArgs:1}},i18n:{detectLanguage:{minArgs:1,maxArgs:1},getAcceptLanguages:{minArgs:0,maxArgs:0}},identity:{launchWebAuthFlow:{minArgs:1,maxArgs:1}},idle:{queryState:{minArgs:1,maxArgs:1}},management:{get:{minArgs:1,maxArgs:1},getAll:{minArgs:0,maxArgs:0},getSelf:{minArgs:0,maxArgs:0},setEnabled:{minArgs:2,maxArgs:2},uninstallSelf:{minArgs:0,maxArgs:1}},notifications:{clear:{minArgs:1,maxArgs:1},create:{minArgs:1,maxArgs:2},getAll:{minArgs:0,maxArgs:0},getPermissionLevel:{minArgs:0,maxArgs:0},update:{minArgs:2,maxArgs:2}},pageAction:{getPopup:{minArgs:1,maxArgs:1},getTitle:{minArgs:1,maxArgs:1},hide:{minArgs:1,maxArgs:1,fallbackToNoCallback:!0},setIcon:{minArgs:1,maxArgs:1},setPopup:{minArgs:1,maxArgs:1,fallbackToNoCallback:!0},setTitle:{minArgs:1,maxArgs:1,fallbackToNoCallback:!0},show:{minArgs:1,maxArgs:1,fallbackToNoCallback:!0}},permissions:{contains:{minArgs:1,maxArgs:1},getAll:{minArgs:0,maxArgs:0},remove:{minArgs:1,maxArgs:1},request:{minArgs:1,maxArgs:1}},runtime:{getBackgroundPage:{minArgs:0,maxArgs:0},getPlatformInfo:{minArgs:0,maxArgs:0},openOptionsPage:{minArgs:0,maxArgs:0},requestUpdateCheck:{minArgs:0,maxArgs:0},sendMessage:{minArgs:1,maxArgs:3},sendNativeMessage:{minArgs:2,maxArgs:2},setUninstallURL:{minArgs:1,maxArgs:1}},sessions:{getDevices:{minArgs:0,maxArgs:1},getRecentlyClosed:{minArgs:0,maxArgs:1},restore:{minArgs:0,maxArgs:1}},storage:{local:{clear:{minArgs:0,maxArgs:0},get:{minArgs:0,maxArgs:1},getBytesInUse:{minArgs:0,maxArgs:1},remove:{minArgs:1,maxArgs:1},set:{minArgs:1,maxArgs:1}},managed:{get:{minArgs:0,maxArgs:1},getBytesInUse:{minArgs:0,maxArgs:1}},sync:{clear:{minArgs:0,maxArgs:0},get:{minArgs:0,maxArgs:1},getBytesInUse:{minArgs:0,maxArgs:1},remove:{minArgs:1,maxArgs:1},set:{minArgs:1,maxArgs:1}}},tabs:{captureVisibleTab:{minArgs:0,maxArgs:2},create:{minArgs:1,maxArgs:1},detectLanguage:{minArgs:0,maxArgs:1},discard:{minArgs:0,maxArgs:1},duplicate:{minArgs:1,maxArgs:1},executeScript:{minArgs:1,maxArgs:2},get:{minArgs:1,maxArgs:1},getCurrent:{minArgs:0,maxArgs:0},getZoom:{minArgs:0,maxArgs:1},getZoomSettings:{minArgs:0,maxArgs:1},goBack:{minArgs:0,maxArgs:1},goForward:{minArgs:0,maxArgs:1},highlight:{minArgs:1,maxArgs:1},insertCSS:{minArgs:1,maxArgs:2},move:{minArgs:2,maxArgs:2},query:{minArgs:1,maxArgs:1},reload:{minArgs:0,maxArgs:2},remove:{minArgs:1,maxArgs:1},removeCSS:{minArgs:1,maxArgs:2},sendMessage:{minArgs:2,maxArgs:3},setZoom:{minArgs:1,maxArgs:2},setZoomSettings:{minArgs:1,maxArgs:2},update:{minArgs:1,maxArgs:2}},topSites:{get:{minArgs:0,maxArgs:0}},webNavigation:{getAllFrames:{minArgs:1,maxArgs:1},getFrame:{minArgs:1,maxArgs:1}},webRequest:{handlerBehaviorChanged:{minArgs:0,maxArgs:0}},windows:{create:{minArgs:0,maxArgs:1},get:{minArgs:1,maxArgs:2},getAll:{minArgs:0,maxArgs:1},getCurrent:{minArgs:0,maxArgs:1},getLastFocused:{minArgs:0,maxArgs:1},remove:{minArgs:1,maxArgs:1},update:{minArgs:2,maxArgs:2}}};if(Object.keys(t).length===0)throw Error(`api-metadata.json has not been included in browser-polyfill`);class n extends WeakMap{constructor(e,t=void 0){super(t),this.createItem=e}get(e){return this.has(e)||this.set(e,this.createItem(e)),super.get(e)}}let r=e=>e&&typeof e==`object`&&typeof e.then==`function`,i=(t,n)=>(...r)=>{e.runtime.lastError?t.reject(Error(e.runtime.lastError.message)):n.singleCallbackArg||r.length<=1&&n.singleCallbackArg!==!1?t.resolve(r[0]):t.resolve(r)},a=e=>e==1?`argument`:`arguments`,o=(e,t)=>function(n,...r){if(r.length<t.minArgs)throw Error(`Expected at least ${t.minArgs} ${a(t.minArgs)} for ${e}(), got ${r.length}`);if(r.length>t.maxArgs)throw Error(`Expected at most ${t.maxArgs} ${a(t.maxArgs)} for ${e}(), got ${r.length}`);return new Promise((a,o)=>{if(t.fallbackToNoCallback)try{n[e](...r,i({resolve:a,reject:o},t))}catch(i){console.warn(`${e} API method doesn't seem to support the callback parameter, falling back to call it without a callback: `,i),n[e](...r),t.fallbackToNoCallback=!1,t.noCallback=!0,a()}else t.noCallback?(n[e](...r),a()):n[e](...r,i({resolve:a,reject:o},t))})},s=(e,t,n)=>new Proxy(t,{apply(t,r,i){return n.call(r,e,...i)}}),c=Function.call.bind(Object.prototype.hasOwnProperty),l=(e,t={},n={})=>{let r=Object.create(null);return new Proxy(Object.create(e),{has(t,n){return n in e||n in r},get(i,a,u){if(a in r)return r[a];if(!(a in e))return;let d=e[a];if(typeof d==`function`)if(typeof t[a]==`function`)d=s(e,e[a],t[a]);else if(c(n,a)){let t=o(a,n[a]);d=s(e,e[a],t)}else d=d.bind(e);else if(typeof d==`object`&&d&&(c(t,a)||c(n,a)))d=l(d,t[a],n[a]);else if(c(n,`*`))d=l(d,t[a],n[`*`]);else return Object.defineProperty(r,a,{configurable:!0,enumerable:!0,get(){return e[a]},set(t){e[a]=t}}),d;return r[a]=d,d},set(t,n,i,a){return n in r?r[n]=i:e[n]=i,!0},defineProperty(e,t,n){return Reflect.defineProperty(r,t,n)},deleteProperty(e,t){return Reflect.deleteProperty(r,t)}})},u=e=>({addListener(t,n,...r){t.addListener(e.get(n),...r)},hasListener(t,n){return t.hasListener(e.get(n))},removeListener(t,n){t.removeListener(e.get(n))}}),d=new n(e=>typeof e==`function`?function(t){e(l(t,{},{getContent:{minArgs:0,maxArgs:0}}))}:e),f=new n(e=>typeof e==`function`?function(t,n,i){let a=!1,o,s=new Promise(e=>{o=function(t){a=!0,e(t)}}),c;try{c=e(t,n,o)}catch(e){c=Promise.reject(e)}let l=c!==!0&&r(c);return c!==!0&&!l&&!a?!1:((e=>{e.then(e=>{i(e)},e=>{let t;t=e&&(e instanceof Error||typeof e.message==`string`)?e.message:`An unexpected error occurred`,i({__mozWebExtensionPolyfillReject__:!0,message:t})}).catch(e=>{console.error(`Failed to send onMessage rejected reply`,e)})})(l?c:s),!0)}:e),p=({reject:t,resolve:n},r)=>{e.runtime.lastError?e.runtime.lastError.message===`The message port closed before a response was received.`?n():t(Error(e.runtime.lastError.message)):r&&r.__mozWebExtensionPolyfillReject__?t(Error(r.message)):n(r)},m=(e,t,n,...r)=>{if(r.length<t.minArgs)throw Error(`Expected at least ${t.minArgs} ${a(t.minArgs)} for ${e}(), got ${r.length}`);if(r.length>t.maxArgs)throw Error(`Expected at most ${t.maxArgs} ${a(t.maxArgs)} for ${e}(), got ${r.length}`);return new Promise((e,t)=>{let i=p.bind(null,{resolve:e,reject:t});r.push(i),n.sendMessage(...r)})},h={devtools:{network:{onRequestFinished:u(d)}},runtime:{onMessage:u(f),onMessageExternal:u(f),sendMessage:m.bind(null,`sendMessage`,{minArgs:1,maxArgs:3})},tabs:{sendMessage:m.bind(null,`sendMessage`,{minArgs:2,maxArgs:3})}},g={clear:{minArgs:1,maxArgs:1},get:{minArgs:1,maxArgs:1},set:{minArgs:1,maxArgs:1}};return t.privacy={network:{"*":g},services:{"*":g},websites:{"*":g}},l(e,h,t)})(chrome)})}))(),1);let u=`string`,d=`object`;function f(e){return e!=null&&typeof e==d&&typeof e.name==u&&typeof e.message==u&&typeof e.stack==u}function p(e){if(typeof e!=d||e==null)return e;if(e instanceof Error)return{name:e.name,message:e.message,stack:e.stack??``,...e.cause?{cause:p(e.cause)}:{},...p({...e})};if(Array.isArray(e)){let t=[];for(let n of e)t.push(p(n));return t}let t=Object.create(null);for(let[n,r]of Object.entries(e))t[n]=p(r);return t}function m(e){if(f(e)){let t=Error(e.message,e.cause?{cause:m(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!=d)return e;if(Array.isArray(e)){let t=[];for(let n of e)t.push(m(n));return t}let t=Object.create(null);for(let[n,r]of Object.entries(e))t[n]=m(r);return t}function h(e){let t,n={};function r(){Object.entries(n).length===0&&(t?.(),t=void 0)}let i=Math.floor(Math.random()*1e4);function a(){return i++}return{async sendMessage(t,n,...r){let i={id:a(),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:s,err:c}=await e.sendMessage(o,...r)??{err:Error(`No response`)};if(e.logger?.debug(`[messaging] sendMessage {id=${o.id}} ᐊ─`,{res:s,err:c}),c!=null)throw m(c);return s},onMessage(i,a){if(t??=(e.logger?.debug(`[messaging] "${i}" 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 i=r(t);return Promise.resolve(i).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:p(n)}))})),n[i]!=null){let t=Error(`[messaging] In this JS context, only one listener can be setup for ${i}`);throw e.logger?.error(t),t}return n[i]=a,e.logger?.log(`[messaging] Added listener for ${i}`),()=>{delete n[i],r()}},removeAllListeners(){Object.keys(n).forEach(e=>{delete n[e]}),r()}}}function g(e){return h({...e,sendMessage(e,t){if(t==null)return l.default.runtime.sendMessage(e);let n=typeof t==`number`?{tabId:t}:t;return l.default.tabs.sendMessage(n.tabId,e,n.frameId==null?void 0:{frameId:n.frameId})},addRootListener(e){let t=(t,n)=>e(typeof t==`object`?{...t,sender:n}:t);return l.default.runtime.onMessage.addListener(t),()=>l.default.runtime.onMessage.removeListener(t)}})}return e.defineExtensionMessaging=g,e})({});
|
package/lib/index.mjs
DELETED
|
@@ -1,32 +0,0 @@
|
|
|
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
DELETED
|
@@ -1,188 +0,0 @@
|
|
|
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;
|
|
11
|
-
}
|
|
12
|
-
function createId() {
|
|
13
|
-
return Math.random().toString(36).substring(2, 10);
|
|
14
|
-
}
|
|
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
|
-
*/
|
|
44
|
-
function defineWindowMessaging(config) {
|
|
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
|
-
};
|
|
98
|
-
}
|
|
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
|
-
*/
|
|
132
|
-
function defineCustomEventMessaging(config) {
|
|
133
|
-
const namespace = config.namespace;
|
|
134
|
-
const instanceId = createId();
|
|
135
|
-
const removeAdditionalListeners = [];
|
|
136
|
-
const sendCustomMessage = (requestEvent) => new Promise((res) => {
|
|
137
|
-
const responseListener = (e) => {
|
|
138
|
-
const { detail } = e;
|
|
139
|
-
if (detail.namespace === namespace && detail.instanceId !== instanceId && detail.message.type === requestEvent.detail.message.type && detail.message.id === requestEvent.detail.message.id) res(detail.response);
|
|
140
|
-
};
|
|
141
|
-
removeAdditionalListeners.push(() => window.removeEventListener(RESPONSE_EVENT, responseListener));
|
|
142
|
-
window.addEventListener(RESPONSE_EVENT, responseListener);
|
|
143
|
-
window.dispatchEvent(requestEvent);
|
|
144
|
-
});
|
|
145
|
-
const messenger = require_generic.defineGenericMessanging({
|
|
146
|
-
...config,
|
|
147
|
-
sendMessage(message) {
|
|
148
|
-
return sendCustomMessage(new CustomEvent(REQUEST_EVENT, { detail: prepareCustomEventDict({
|
|
149
|
-
message,
|
|
150
|
-
namespace,
|
|
151
|
-
instanceId
|
|
152
|
-
}) }));
|
|
153
|
-
},
|
|
154
|
-
addRootListener(processMessage) {
|
|
155
|
-
const requestListener = async (e) => {
|
|
156
|
-
const { detail, ...event } = e;
|
|
157
|
-
if (detail.namespace !== namespace || detail.instanceId === instanceId) return;
|
|
158
|
-
const message = {
|
|
159
|
-
...detail.message,
|
|
160
|
-
event
|
|
161
|
-
};
|
|
162
|
-
const resDetail = {
|
|
163
|
-
response: await processMessage(message),
|
|
164
|
-
message,
|
|
165
|
-
instanceId,
|
|
166
|
-
namespace
|
|
167
|
-
};
|
|
168
|
-
const responseEvent = new CustomEvent(RESPONSE_EVENT, { detail: prepareCustomEventDict(resDetail) });
|
|
169
|
-
window.dispatchEvent(responseEvent);
|
|
170
|
-
};
|
|
171
|
-
window.addEventListener(REQUEST_EVENT, requestListener);
|
|
172
|
-
return () => window.removeEventListener(REQUEST_EVENT, requestListener);
|
|
173
|
-
},
|
|
174
|
-
verifyMessageData(data) {
|
|
175
|
-
return structuredClone(data);
|
|
176
|
-
}
|
|
177
|
-
});
|
|
178
|
-
return {
|
|
179
|
-
...messenger,
|
|
180
|
-
removeAllListeners() {
|
|
181
|
-
messenger.removeAllListeners();
|
|
182
|
-
removeAdditionalListeners.forEach((removeListener) => removeListener());
|
|
183
|
-
}
|
|
184
|
-
};
|
|
185
|
-
}
|
|
186
|
-
//#endregion
|
|
187
|
-
exports.defineCustomEventMessaging = defineCustomEventMessaging;
|
|
188
|
-
exports.defineWindowMessaging = defineWindowMessaging;
|
package/lib/page.d.cts
DELETED
|
@@ -1,91 +0,0 @@
|
|
|
1
|
-
import { c as NamespaceMessagingConfig, t as GenericMessenger } from "./generic-B-kFbyP9.cjs";
|
|
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 };
|
package/lib/page.global.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
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=r=>{let{detail:a}=r;a.namespace===t&&a.instanceId!==n&&a.message.type===e.detail.message.type&&a.message.id===e.detail.message.id&&i(a.response)};r.push(()=>window.removeEventListener(p,a)),window.addEventListener(p,a),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})({});
|
|
File without changes
|