@webext-core/messaging 2.2.0 → 3.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/README.md +4 -2
- package/package.json +2 -3
- package/lib/chunk-BQLFSFFZ.js +0 -156
- package/lib/generic-ad5087a0.d.ts +0 -134
- package/lib/index.cjs +0 -204
- package/lib/index.d.ts +0 -54
- package/lib/index.global.js +0 -1391
- package/lib/index.js +0 -37
- package/lib/page.cjs +0 -296
- package/lib/page.d.ts +0 -92
- package/lib/page.global.js +0 -495
- package/lib/page.js +0 -128
package/README.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# `@webext-core/messaging`
|
|
2
2
|
|
|
3
|
-
A light-weight, type-safe wrapper around the `browser.runtime` messaging APIs.
|
|
3
|
+
A light-weight, type-safe wrapper around the `browser.runtime` messaging APIs.
|
|
4
|
+
Supports all browsers (Chrome, Firefox, Safari).
|
|
4
5
|
|
|
5
6
|
```ts
|
|
6
7
|
// ./messaging.ts
|
|
@@ -33,4 +34,5 @@ console.log(length); // 11
|
|
|
33
34
|
|
|
34
35
|
## Get Started
|
|
35
36
|
|
|
36
|
-
See [documentation](https://webext-core.aklinker1.io/
|
|
37
|
+
See [documentation](https://webext-core.aklinker1.io/messaging/installation) to
|
|
38
|
+
get started!
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@webext-core/messaging",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "3.0.0",
|
|
4
4
|
"description": "Light weight, type-safe wrapper around the web extension messaging APIs. Supports all browsers (Chrome, Firefox, Safari)",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"keywords": [
|
|
@@ -64,8 +64,7 @@
|
|
|
64
64
|
"check": "buildc --deps-only -- tsc --noEmit"
|
|
65
65
|
},
|
|
66
66
|
"dependencies": {
|
|
67
|
-
"serialize-error": "^
|
|
68
|
-
"uid": "^2.0.2",
|
|
67
|
+
"@aklinker1/zero-serialize-error": "^1.0.2",
|
|
69
68
|
"webextension-polyfill": "^0.10.0"
|
|
70
69
|
},
|
|
71
70
|
"devDependencies": {
|
package/lib/chunk-BQLFSFFZ.js
DELETED
|
@@ -1,156 +0,0 @@
|
|
|
1
|
-
var __defProp = Object.defineProperty;
|
|
2
|
-
var __defProps = Object.defineProperties;
|
|
3
|
-
var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
|
|
4
|
-
var __getOwnPropSymbols = Object.getOwnPropertySymbols;
|
|
5
|
-
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
-
var __propIsEnum = Object.prototype.propertyIsEnumerable;
|
|
7
|
-
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
8
|
-
var __spreadValues = (a, b) => {
|
|
9
|
-
for (var prop in b || (b = {}))
|
|
10
|
-
if (__hasOwnProp.call(b, prop))
|
|
11
|
-
__defNormalProp(a, prop, b[prop]);
|
|
12
|
-
if (__getOwnPropSymbols)
|
|
13
|
-
for (var prop of __getOwnPropSymbols(b)) {
|
|
14
|
-
if (__propIsEnum.call(b, prop))
|
|
15
|
-
__defNormalProp(a, prop, b[prop]);
|
|
16
|
-
}
|
|
17
|
-
return a;
|
|
18
|
-
};
|
|
19
|
-
var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
|
|
20
|
-
var __objRest = (source, exclude) => {
|
|
21
|
-
var target = {};
|
|
22
|
-
for (var prop in source)
|
|
23
|
-
if (__hasOwnProp.call(source, prop) && exclude.indexOf(prop) < 0)
|
|
24
|
-
target[prop] = source[prop];
|
|
25
|
-
if (source != null && __getOwnPropSymbols)
|
|
26
|
-
for (var prop of __getOwnPropSymbols(source)) {
|
|
27
|
-
if (exclude.indexOf(prop) < 0 && __propIsEnum.call(source, prop))
|
|
28
|
-
target[prop] = source[prop];
|
|
29
|
-
}
|
|
30
|
-
return target;
|
|
31
|
-
};
|
|
32
|
-
var __async = (__this, __arguments, generator) => {
|
|
33
|
-
return new Promise((resolve, reject) => {
|
|
34
|
-
var fulfilled = (value) => {
|
|
35
|
-
try {
|
|
36
|
-
step(generator.next(value));
|
|
37
|
-
} catch (e) {
|
|
38
|
-
reject(e);
|
|
39
|
-
}
|
|
40
|
-
};
|
|
41
|
-
var rejected = (value) => {
|
|
42
|
-
try {
|
|
43
|
-
step(generator.throw(value));
|
|
44
|
-
} catch (e) {
|
|
45
|
-
reject(e);
|
|
46
|
-
}
|
|
47
|
-
};
|
|
48
|
-
var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
|
|
49
|
-
step((generator = generator.apply(__this, __arguments)).next());
|
|
50
|
-
});
|
|
51
|
-
};
|
|
52
|
-
|
|
53
|
-
// src/generic.ts
|
|
54
|
-
import { serializeError, deserializeError } from "serialize-error";
|
|
55
|
-
function defineGenericMessanging(config) {
|
|
56
|
-
let removeRootListener;
|
|
57
|
-
let perTypeListeners = {};
|
|
58
|
-
function cleanupRootListener() {
|
|
59
|
-
if (Object.entries(perTypeListeners).length === 0) {
|
|
60
|
-
removeRootListener == null ? void 0 : removeRootListener();
|
|
61
|
-
removeRootListener = void 0;
|
|
62
|
-
}
|
|
63
|
-
}
|
|
64
|
-
let idSeq = Math.floor(Math.random() * 1e4);
|
|
65
|
-
function getNextId() {
|
|
66
|
-
return idSeq++;
|
|
67
|
-
}
|
|
68
|
-
return {
|
|
69
|
-
sendMessage(type, data, ...args) {
|
|
70
|
-
return __async(this, null, function* () {
|
|
71
|
-
var _a2, _b, _c, _d;
|
|
72
|
-
const _message = {
|
|
73
|
-
id: getNextId(),
|
|
74
|
-
type,
|
|
75
|
-
data,
|
|
76
|
-
timestamp: Date.now()
|
|
77
|
-
};
|
|
78
|
-
const message = (_b = yield (_a2 = config.verifyMessageData) == null ? void 0 : _a2.call(config, _message)) != null ? _b : _message;
|
|
79
|
-
(_c = config.logger) == null ? void 0 : _c.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message, ...args);
|
|
80
|
-
const response = yield config.sendMessage(message, ...args);
|
|
81
|
-
const { res, err } = response != null ? response : { err: new Error("No response") };
|
|
82
|
-
(_d = config.logger) == null ? void 0 : _d.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
|
|
83
|
-
if (err != null)
|
|
84
|
-
throw deserializeError(err);
|
|
85
|
-
return res;
|
|
86
|
-
});
|
|
87
|
-
},
|
|
88
|
-
onMessage(type, onReceived) {
|
|
89
|
-
var _a2, _b, _c;
|
|
90
|
-
if (removeRootListener == null) {
|
|
91
|
-
(_a2 = config.logger) == null ? void 0 : _a2.debug(
|
|
92
|
-
`[messaging] "${type}" initialized the message listener for this context`
|
|
93
|
-
);
|
|
94
|
-
removeRootListener = config.addRootListener((message) => {
|
|
95
|
-
var _a3, _b2;
|
|
96
|
-
if (typeof message.type != "string" || typeof message.timestamp !== "number") {
|
|
97
|
-
if (config.breakError) {
|
|
98
|
-
return;
|
|
99
|
-
}
|
|
100
|
-
const err = Error(
|
|
101
|
-
`[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(
|
|
102
|
-
message
|
|
103
|
-
)}`
|
|
104
|
-
);
|
|
105
|
-
(_a3 = config.logger) == null ? void 0 : _a3.error(err);
|
|
106
|
-
throw err;
|
|
107
|
-
}
|
|
108
|
-
(_b2 = config == null ? void 0 : config.logger) == null ? void 0 : _b2.debug("[messaging] Received message", message);
|
|
109
|
-
const listener = perTypeListeners[message.type];
|
|
110
|
-
if (listener == null)
|
|
111
|
-
return;
|
|
112
|
-
const res = listener(message);
|
|
113
|
-
return Promise.resolve(res).then((res2) => {
|
|
114
|
-
var _a4, _b3;
|
|
115
|
-
return (_b3 = (_a4 = config.verifyMessageData) == null ? void 0 : _a4.call(config, res2)) != null ? _b3 : res2;
|
|
116
|
-
}).then((res2) => {
|
|
117
|
-
var _a4;
|
|
118
|
-
(_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
|
|
119
|
-
return { res: res2 };
|
|
120
|
-
}).catch((err) => {
|
|
121
|
-
var _a4;
|
|
122
|
-
(_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { err });
|
|
123
|
-
return { err: serializeError(err) };
|
|
124
|
-
});
|
|
125
|
-
});
|
|
126
|
-
}
|
|
127
|
-
if (perTypeListeners[type] != null) {
|
|
128
|
-
const err = Error(
|
|
129
|
-
`[messaging] In this JS context, only one listener can be setup for ${type}`
|
|
130
|
-
);
|
|
131
|
-
(_b = config.logger) == null ? void 0 : _b.error(err);
|
|
132
|
-
throw err;
|
|
133
|
-
}
|
|
134
|
-
perTypeListeners[type] = onReceived;
|
|
135
|
-
(_c = config.logger) == null ? void 0 : _c.log(`[messaging] Added listener for ${type}`);
|
|
136
|
-
return () => {
|
|
137
|
-
delete perTypeListeners[type];
|
|
138
|
-
cleanupRootListener();
|
|
139
|
-
};
|
|
140
|
-
},
|
|
141
|
-
removeAllListeners() {
|
|
142
|
-
Object.keys(perTypeListeners).forEach((type) => {
|
|
143
|
-
delete perTypeListeners[type];
|
|
144
|
-
});
|
|
145
|
-
cleanupRootListener();
|
|
146
|
-
}
|
|
147
|
-
};
|
|
148
|
-
}
|
|
149
|
-
|
|
150
|
-
export {
|
|
151
|
-
__spreadValues,
|
|
152
|
-
__spreadProps,
|
|
153
|
-
__objRest,
|
|
154
|
-
__async,
|
|
155
|
-
defineGenericMessanging
|
|
156
|
-
};
|
|
@@ -1,134 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Interface used to log text to the console when sending and recieving messages.
|
|
3
|
-
*/
|
|
4
|
-
interface Logger {
|
|
5
|
-
debug(...args: any[]): void;
|
|
6
|
-
log(...args: any[]): void;
|
|
7
|
-
warn(...args: any[]): void;
|
|
8
|
-
error(...args: any[]): void;
|
|
9
|
-
}
|
|
10
|
-
/**
|
|
11
|
-
* Either a Promise of a type, or that type directly. Used to indicate that a method can by sync or
|
|
12
|
-
* async.
|
|
13
|
-
*/
|
|
14
|
-
type MaybePromise<T> = Promise<T> | T;
|
|
15
|
-
/**
|
|
16
|
-
* Used to add a return type to a message in the protocol map.
|
|
17
|
-
*
|
|
18
|
-
* > Internally, this is just an object with random keys for the data and return types.
|
|
19
|
-
*
|
|
20
|
-
* @deprecated Use the function syntax instead: <https://webext-core.aklinker1.io/guide/messaging/protocol-maps.html#syntax>
|
|
21
|
-
*
|
|
22
|
-
* @example
|
|
23
|
-
* interface ProtocolMap {
|
|
24
|
-
* // data is a string, returns undefined
|
|
25
|
-
* type1: string;
|
|
26
|
-
* // data is a string, returns a number
|
|
27
|
-
* type2: ProtocolWithReturn<string, number>;
|
|
28
|
-
* }
|
|
29
|
-
*/
|
|
30
|
-
interface ProtocolWithReturn<TData, TReturn> {
|
|
31
|
-
/**
|
|
32
|
-
* Stores the data type. Randomly named so that it isn't accidentally implemented.
|
|
33
|
-
*/
|
|
34
|
-
BtVgCTPYZu: TData;
|
|
35
|
-
/**
|
|
36
|
-
* Stores the return type. Randomly named so that it isn't accidentally implemented.
|
|
37
|
-
*/
|
|
38
|
-
RrhVseLgZW: TReturn;
|
|
39
|
-
}
|
|
40
|
-
/**
|
|
41
|
-
* Given a function declaration, `ProtocolWithReturn`, or a value, return the message's data type.
|
|
42
|
-
*/
|
|
43
|
-
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;
|
|
44
|
-
/**
|
|
45
|
-
* Given a function declaration, `ProtocolWithReturn`, or a value, return the message's return type.
|
|
46
|
-
*/
|
|
47
|
-
type GetReturnType<T> = T extends (...args: any[]) => infer R ? R : T extends ProtocolWithReturn<any, any> ? T['RrhVseLgZW'] : void;
|
|
48
|
-
/**
|
|
49
|
-
* Call to ensure an active listener has been removed.
|
|
50
|
-
*
|
|
51
|
-
* If the listener has already been removed with `Messenger.removeAllListeners`, this is a noop.
|
|
52
|
-
*/
|
|
53
|
-
type RemoveListenerCallback = () => void;
|
|
54
|
-
/**
|
|
55
|
-
* Shared configuration between all the different messengers.
|
|
56
|
-
*/
|
|
57
|
-
interface BaseMessagingConfig {
|
|
58
|
-
/**
|
|
59
|
-
* The logger to use when logging messages. Set to `null` to disable logging.
|
|
60
|
-
*
|
|
61
|
-
* @default console
|
|
62
|
-
*/
|
|
63
|
-
logger?: Logger;
|
|
64
|
-
/**
|
|
65
|
-
* Whether to break an error when an invalid message is received.
|
|
66
|
-
*
|
|
67
|
-
* @default undefined
|
|
68
|
-
*/
|
|
69
|
-
breakError?: boolean;
|
|
70
|
-
}
|
|
71
|
-
interface NamespaceMessagingConfig extends BaseMessagingConfig {
|
|
72
|
-
/**
|
|
73
|
-
* A string used to ensure the messenger only sends messages to and listens for messages from
|
|
74
|
-
* other messengers of the same type, with the same namespace.
|
|
75
|
-
*/
|
|
76
|
-
namespace: string;
|
|
77
|
-
}
|
|
78
|
-
/**
|
|
79
|
-
* Contains information about the message recieved.
|
|
80
|
-
*/
|
|
81
|
-
interface Message<TProtocolMap extends Record<string, any>, TType extends keyof TProtocolMap> {
|
|
82
|
-
/**
|
|
83
|
-
* A semi-unique, auto-incrementing number used to trace messages being sent.
|
|
84
|
-
*/
|
|
85
|
-
id: number;
|
|
86
|
-
/**
|
|
87
|
-
* The data that was passed into `sendMessage`
|
|
88
|
-
*/
|
|
89
|
-
data: GetDataType<TProtocolMap[TType]>;
|
|
90
|
-
type: TType;
|
|
91
|
-
/**
|
|
92
|
-
* The timestamp the message was sent in MS since epoch.
|
|
93
|
-
*/
|
|
94
|
-
timestamp: number;
|
|
95
|
-
}
|
|
96
|
-
|
|
97
|
-
/**
|
|
98
|
-
* Messaging interface shared by all messengers.
|
|
99
|
-
*
|
|
100
|
-
* Type parameters accept:
|
|
101
|
-
* - `TProtocolMap` to define the data and return types of messages.
|
|
102
|
-
* - `TMessageExtension` to define additional fields that are available on a message inside
|
|
103
|
-
* `onMessage`'s callback
|
|
104
|
-
* - `TSendMessageArgs` to define a list of additional arguments for `sendMessage`
|
|
105
|
-
*/
|
|
106
|
-
interface GenericMessenger<TProtocolMap extends Record<string, any>, TMessageExtension, TSendMessageArgs extends any[]> {
|
|
107
|
-
/**
|
|
108
|
-
* Send a message to the background or a specific tab if `tabId` is passed. You can call this
|
|
109
|
-
* function anywhere in your extension.
|
|
110
|
-
*
|
|
111
|
-
* If you haven't setup a listener for the sent `type`, an error will be thrown.
|
|
112
|
-
*
|
|
113
|
-
* @param type The message type being sent. Call `onMessage` with the same type to listen for that message.
|
|
114
|
-
* @param data The data to send with the message.
|
|
115
|
-
* @param args Different messengers will have additional arguments to configure how a message gets sent.
|
|
116
|
-
*/
|
|
117
|
-
sendMessage<TType extends keyof TProtocolMap>(type: TType, data: GetDataType<TProtocolMap[TType]>, ...args: TSendMessageArgs): Promise<GetReturnType<TProtocolMap[TType]>>;
|
|
118
|
-
/**
|
|
119
|
-
* Trigger a callback when a message of the requested type is recieved. You cannot setup multiple
|
|
120
|
-
* listeners for the same message type in the same JS context.
|
|
121
|
-
*
|
|
122
|
-
* To remove the listener, call the returned message.
|
|
123
|
-
*
|
|
124
|
-
* @param type The message type to listen for. Call `sendMessage` with the same type to triggern this listener.
|
|
125
|
-
* @param onReceived The callback executed when a message is recieved.
|
|
126
|
-
*/
|
|
127
|
-
onMessage<TType extends keyof TProtocolMap>(type: TType, onReceived: (message: Message<TProtocolMap, TType> & TMessageExtension) => void | MaybePromise<GetReturnType<TProtocolMap[TType]>>): RemoveListenerCallback;
|
|
128
|
-
/**
|
|
129
|
-
* Removes all listeners.
|
|
130
|
-
*/
|
|
131
|
-
removeAllListeners(): void;
|
|
132
|
-
}
|
|
133
|
-
|
|
134
|
-
export { BaseMessagingConfig as B, GenericMessenger as G, Logger as L, MaybePromise as M, NamespaceMessagingConfig as N, ProtocolWithReturn as P, RemoveListenerCallback as R, GetDataType as a, GetReturnType as b, Message as c };
|
package/lib/index.cjs
DELETED
|
@@ -1,204 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __create = Object.create;
|
|
3
|
-
var __defProp = Object.defineProperty;
|
|
4
|
-
var __defProps = Object.defineProperties;
|
|
5
|
-
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
6
|
-
var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
|
|
7
|
-
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
8
|
-
var __getOwnPropSymbols = Object.getOwnPropertySymbols;
|
|
9
|
-
var __getProtoOf = Object.getPrototypeOf;
|
|
10
|
-
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
11
|
-
var __propIsEnum = Object.prototype.propertyIsEnumerable;
|
|
12
|
-
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
13
|
-
var __spreadValues = (a, b) => {
|
|
14
|
-
for (var prop in b || (b = {}))
|
|
15
|
-
if (__hasOwnProp.call(b, prop))
|
|
16
|
-
__defNormalProp(a, prop, b[prop]);
|
|
17
|
-
if (__getOwnPropSymbols)
|
|
18
|
-
for (var prop of __getOwnPropSymbols(b)) {
|
|
19
|
-
if (__propIsEnum.call(b, prop))
|
|
20
|
-
__defNormalProp(a, prop, b[prop]);
|
|
21
|
-
}
|
|
22
|
-
return a;
|
|
23
|
-
};
|
|
24
|
-
var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
|
|
25
|
-
var __export = (target, all) => {
|
|
26
|
-
for (var name in all)
|
|
27
|
-
__defProp(target, name, { get: all[name], enumerable: true });
|
|
28
|
-
};
|
|
29
|
-
var __copyProps = (to, from, except, desc) => {
|
|
30
|
-
if (from && typeof from === "object" || typeof from === "function") {
|
|
31
|
-
for (let key of __getOwnPropNames(from))
|
|
32
|
-
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
33
|
-
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
34
|
-
}
|
|
35
|
-
return to;
|
|
36
|
-
};
|
|
37
|
-
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
|
|
38
|
-
// If the importer is in node compatibility mode or this is not an ESM
|
|
39
|
-
// file that has been converted to a CommonJS file using a Babel-
|
|
40
|
-
// compatible transform (i.e. "__esModule" has not been set), then set
|
|
41
|
-
// "default" to the CommonJS "module.exports" for node compatibility.
|
|
42
|
-
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
|
|
43
|
-
mod
|
|
44
|
-
));
|
|
45
|
-
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
46
|
-
var __async = (__this, __arguments, generator) => {
|
|
47
|
-
return new Promise((resolve, reject) => {
|
|
48
|
-
var fulfilled = (value) => {
|
|
49
|
-
try {
|
|
50
|
-
step(generator.next(value));
|
|
51
|
-
} catch (e) {
|
|
52
|
-
reject(e);
|
|
53
|
-
}
|
|
54
|
-
};
|
|
55
|
-
var rejected = (value) => {
|
|
56
|
-
try {
|
|
57
|
-
step(generator.throw(value));
|
|
58
|
-
} catch (e) {
|
|
59
|
-
reject(e);
|
|
60
|
-
}
|
|
61
|
-
};
|
|
62
|
-
var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
|
|
63
|
-
step((generator = generator.apply(__this, __arguments)).next());
|
|
64
|
-
});
|
|
65
|
-
};
|
|
66
|
-
|
|
67
|
-
// src/index.ts
|
|
68
|
-
var src_exports = {};
|
|
69
|
-
__export(src_exports, {
|
|
70
|
-
defineExtensionMessaging: () => defineExtensionMessaging
|
|
71
|
-
});
|
|
72
|
-
module.exports = __toCommonJS(src_exports);
|
|
73
|
-
|
|
74
|
-
// src/extension.ts
|
|
75
|
-
var import_webextension_polyfill = __toESM(require("webextension-polyfill"), 1);
|
|
76
|
-
|
|
77
|
-
// src/generic.ts
|
|
78
|
-
var import_serialize_error = require("serialize-error");
|
|
79
|
-
function defineGenericMessanging(config) {
|
|
80
|
-
let removeRootListener;
|
|
81
|
-
let perTypeListeners = {};
|
|
82
|
-
function cleanupRootListener() {
|
|
83
|
-
if (Object.entries(perTypeListeners).length === 0) {
|
|
84
|
-
removeRootListener == null ? void 0 : removeRootListener();
|
|
85
|
-
removeRootListener = void 0;
|
|
86
|
-
}
|
|
87
|
-
}
|
|
88
|
-
let idSeq = Math.floor(Math.random() * 1e4);
|
|
89
|
-
function getNextId() {
|
|
90
|
-
return idSeq++;
|
|
91
|
-
}
|
|
92
|
-
return {
|
|
93
|
-
sendMessage(type, data, ...args) {
|
|
94
|
-
return __async(this, null, function* () {
|
|
95
|
-
var _a2, _b, _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_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.breakError) {
|
|
122
|
-
return;
|
|
123
|
-
}
|
|
124
|
-
const err = Error(
|
|
125
|
-
`[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(
|
|
126
|
-
message
|
|
127
|
-
)}`
|
|
128
|
-
);
|
|
129
|
-
(_a3 = config.logger) == null ? void 0 : _a3.error(err);
|
|
130
|
-
throw err;
|
|
131
|
-
}
|
|
132
|
-
(_b2 = config == null ? void 0 : config.logger) == null ? void 0 : _b2.debug("[messaging] Received message", message);
|
|
133
|
-
const listener = perTypeListeners[message.type];
|
|
134
|
-
if (listener == null)
|
|
135
|
-
return;
|
|
136
|
-
const res = listener(message);
|
|
137
|
-
return Promise.resolve(res).then((res2) => {
|
|
138
|
-
var _a4, _b3;
|
|
139
|
-
return (_b3 = (_a4 = config.verifyMessageData) == null ? void 0 : _a4.call(config, res2)) != null ? _b3 : res2;
|
|
140
|
-
}).then((res2) => {
|
|
141
|
-
var _a4;
|
|
142
|
-
(_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
|
|
143
|
-
return { res: res2 };
|
|
144
|
-
}).catch((err) => {
|
|
145
|
-
var _a4;
|
|
146
|
-
(_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { err });
|
|
147
|
-
return { err: (0, import_serialize_error.serializeError)(err) };
|
|
148
|
-
});
|
|
149
|
-
});
|
|
150
|
-
}
|
|
151
|
-
if (perTypeListeners[type] != null) {
|
|
152
|
-
const err = Error(
|
|
153
|
-
`[messaging] In this JS context, only one listener can be setup for ${type}`
|
|
154
|
-
);
|
|
155
|
-
(_b = config.logger) == null ? void 0 : _b.error(err);
|
|
156
|
-
throw err;
|
|
157
|
-
}
|
|
158
|
-
perTypeListeners[type] = onReceived;
|
|
159
|
-
(_c = config.logger) == null ? void 0 : _c.log(`[messaging] Added listener for ${type}`);
|
|
160
|
-
return () => {
|
|
161
|
-
delete perTypeListeners[type];
|
|
162
|
-
cleanupRootListener();
|
|
163
|
-
};
|
|
164
|
-
},
|
|
165
|
-
removeAllListeners() {
|
|
166
|
-
Object.keys(perTypeListeners).forEach((type) => {
|
|
167
|
-
delete perTypeListeners[type];
|
|
168
|
-
});
|
|
169
|
-
cleanupRootListener();
|
|
170
|
-
}
|
|
171
|
-
};
|
|
172
|
-
}
|
|
173
|
-
|
|
174
|
-
// src/extension.ts
|
|
175
|
-
function defineExtensionMessaging(config) {
|
|
176
|
-
return defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
|
|
177
|
-
sendMessage(message, arg) {
|
|
178
|
-
if (arg == null) {
|
|
179
|
-
return import_webextension_polyfill.default.runtime.sendMessage(message);
|
|
180
|
-
}
|
|
181
|
-
const options = typeof arg === "number" ? { tabId: arg } : arg;
|
|
182
|
-
return import_webextension_polyfill.default.tabs.sendMessage(
|
|
183
|
-
options.tabId,
|
|
184
|
-
message,
|
|
185
|
-
// Pass frameId if specified
|
|
186
|
-
options.frameId != null ? { frameId: options.frameId } : void 0
|
|
187
|
-
);
|
|
188
|
-
},
|
|
189
|
-
addRootListener(processMessage) {
|
|
190
|
-
const listener = (message, sender) => {
|
|
191
|
-
if (typeof message === "object")
|
|
192
|
-
return processMessage(__spreadProps(__spreadValues({}, message), { sender }));
|
|
193
|
-
else
|
|
194
|
-
return processMessage(message);
|
|
195
|
-
};
|
|
196
|
-
import_webextension_polyfill.default.runtime.onMessage.addListener(listener);
|
|
197
|
-
return () => import_webextension_polyfill.default.runtime.onMessage.removeListener(listener);
|
|
198
|
-
}
|
|
199
|
-
}));
|
|
200
|
-
}
|
|
201
|
-
// Annotate the CommonJS export names for ESM import in node:
|
|
202
|
-
0 && (module.exports = {
|
|
203
|
-
defineExtensionMessaging
|
|
204
|
-
});
|
package/lib/index.d.ts
DELETED
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
import { B as BaseMessagingConfig, G as GenericMessenger } from './generic-ad5087a0.js';
|
|
2
|
-
export { a as GetDataType, b as GetReturnType, L as Logger, M as MaybePromise, c as Message, N as NamespaceMessagingConfig, P as ProtocolWithReturn, R as RemoveListenerCallback } from './generic-ad5087a0.js';
|
|
3
|
-
import { Runtime } from 'webextension-polyfill';
|
|
4
|
-
|
|
5
|
-
/**
|
|
6
|
-
* Configuration passed into `defineExtensionMessaging`.
|
|
7
|
-
*/
|
|
8
|
-
interface ExtensionMessagingConfig extends BaseMessagingConfig {
|
|
9
|
-
}
|
|
10
|
-
/**
|
|
11
|
-
* Additional fields available on the `Message` from an `ExtensionMessenger`.
|
|
12
|
-
*/
|
|
13
|
-
interface ExtensionMessage {
|
|
14
|
-
/**
|
|
15
|
-
* Information about where the message came from. See
|
|
16
|
-
* [`Runtime.MessageSender`](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/MessageSender).
|
|
17
|
-
*/
|
|
18
|
-
sender: Runtime.MessageSender;
|
|
19
|
-
}
|
|
20
|
-
/**
|
|
21
|
-
* Options for sending a message to a specific tab/frame
|
|
22
|
-
*/
|
|
23
|
-
interface SendMessageOptions {
|
|
24
|
-
/**
|
|
25
|
-
* The tab to send a message to
|
|
26
|
-
*/
|
|
27
|
-
tabId: number;
|
|
28
|
-
/**
|
|
29
|
-
* The frame to send a message to. 0 represents the main frame.
|
|
30
|
-
*/
|
|
31
|
-
frameId?: number;
|
|
32
|
-
}
|
|
33
|
-
/**
|
|
34
|
-
* Send message accepts either:
|
|
35
|
-
* - No arguments to send to background
|
|
36
|
-
* - A tabId number to send to a specific tab
|
|
37
|
-
* - A SendMessageOptions object to target a specific tab and frame
|
|
38
|
-
*
|
|
39
|
-
* You cannot message between tabs directly. It must go through the background script.
|
|
40
|
-
*/
|
|
41
|
-
type ExtensionSendMessageArgs = [arg?: number | SendMessageOptions];
|
|
42
|
-
/**
|
|
43
|
-
* Messenger returned by `defineExtensionMessaging`.
|
|
44
|
-
*/
|
|
45
|
-
type ExtensionMessenger<TProtocolMap extends Record<string, any>> = GenericMessenger<TProtocolMap, ExtensionMessage, ExtensionSendMessageArgs>;
|
|
46
|
-
/**
|
|
47
|
-
* Returns an `ExtensionMessenger` that is backed by the `browser.runtime.sendMessage` and
|
|
48
|
-
* `browser.tabs.sendMessage` APIs.
|
|
49
|
-
*
|
|
50
|
-
* It can be used to send messages to and from the background page/service worker.
|
|
51
|
-
*/
|
|
52
|
-
declare function defineExtensionMessaging<TProtocolMap extends Record<string, any> = Record<string, any>>(config?: ExtensionMessagingConfig): ExtensionMessenger<TProtocolMap>;
|
|
53
|
-
|
|
54
|
-
export { BaseMessagingConfig, ExtensionMessage, ExtensionMessagingConfig, ExtensionMessenger, ExtensionSendMessageArgs, SendMessageOptions, defineExtensionMessaging };
|