@webext-core/messaging 1.3.1 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/lib/chunk-ALTBYIMW.js +149 -0
- package/lib/generic-e806d3a5.d.ts +128 -0
- package/lib/index.cjs +115 -83
- package/lib/index.d.ts +25 -99
- package/lib/index.global.js +300 -83
- package/lib/index.js +21 -115
- package/lib/page.cjs +259 -0
- package/lib/page.d.ts +86 -0
- package/lib/page.global.js +441 -0
- package/lib/page.js +100 -0
- package/package.json +11 -4
package/README.md
CHANGED
|
@@ -0,0 +1,149 @@
|
|
|
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;
|
|
72
|
+
const message = {
|
|
73
|
+
id: getNextId(),
|
|
74
|
+
type,
|
|
75
|
+
data,
|
|
76
|
+
timestamp: Date.now()
|
|
77
|
+
};
|
|
78
|
+
(_a2 = config.logger) == null ? void 0 : _a2.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message, ...args);
|
|
79
|
+
const response = yield config.sendMessage(message, ...args);
|
|
80
|
+
const { res, err } = response != null ? response : { err: new Error("No response") };
|
|
81
|
+
(_b = config.logger) == null ? void 0 : _b.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
|
|
82
|
+
if (err != null)
|
|
83
|
+
throw deserializeError(err);
|
|
84
|
+
return res;
|
|
85
|
+
});
|
|
86
|
+
},
|
|
87
|
+
onMessage(type, onReceived) {
|
|
88
|
+
var _a2, _b, _c;
|
|
89
|
+
if (removeRootListener == null) {
|
|
90
|
+
(_a2 = config.logger) == null ? void 0 : _a2.debug(
|
|
91
|
+
`[messaging] "${type}" initialized the message listener for this context`
|
|
92
|
+
);
|
|
93
|
+
removeRootListener = config.addRootListener((message) => {
|
|
94
|
+
var _a3, _b2;
|
|
95
|
+
if (typeof message.type != "string" || typeof message.timestamp !== "number") {
|
|
96
|
+
const err = Error(
|
|
97
|
+
`[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(
|
|
98
|
+
message
|
|
99
|
+
)}`
|
|
100
|
+
);
|
|
101
|
+
(_a3 = config.logger) == null ? void 0 : _a3.error(err);
|
|
102
|
+
throw err;
|
|
103
|
+
}
|
|
104
|
+
(_b2 = config == null ? void 0 : config.logger) == null ? void 0 : _b2.debug("[messaging] Received message", message);
|
|
105
|
+
const listener = perTypeListeners[message.type];
|
|
106
|
+
if (listener == null)
|
|
107
|
+
return;
|
|
108
|
+
const res = listener(message);
|
|
109
|
+
return Promise.resolve(res).then((res2) => {
|
|
110
|
+
var _a4;
|
|
111
|
+
(_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
|
|
112
|
+
return { res: res2 };
|
|
113
|
+
}).catch((err) => {
|
|
114
|
+
var _a4;
|
|
115
|
+
(_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { err });
|
|
116
|
+
return { err: serializeError(err) };
|
|
117
|
+
});
|
|
118
|
+
});
|
|
119
|
+
}
|
|
120
|
+
if (perTypeListeners[type] != null) {
|
|
121
|
+
const err = Error(
|
|
122
|
+
`[messaging] In this JS context, only one listener can be setup for ${type}`
|
|
123
|
+
);
|
|
124
|
+
(_b = config.logger) == null ? void 0 : _b.error(err);
|
|
125
|
+
throw err;
|
|
126
|
+
}
|
|
127
|
+
perTypeListeners[type] = onReceived;
|
|
128
|
+
(_c = config.logger) == null ? void 0 : _c.log(`[messaging] Added listener for ${type}`);
|
|
129
|
+
return () => {
|
|
130
|
+
delete perTypeListeners[type];
|
|
131
|
+
cleanupRootListener();
|
|
132
|
+
};
|
|
133
|
+
},
|
|
134
|
+
removeAllListeners() {
|
|
135
|
+
Object.keys(perTypeListeners).forEach((type) => {
|
|
136
|
+
delete perTypeListeners[type];
|
|
137
|
+
});
|
|
138
|
+
cleanupRootListener();
|
|
139
|
+
}
|
|
140
|
+
};
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
export {
|
|
144
|
+
__spreadValues,
|
|
145
|
+
__spreadProps,
|
|
146
|
+
__objRest,
|
|
147
|
+
__async,
|
|
148
|
+
defineGenericMessanging
|
|
149
|
+
};
|
|
@@ -0,0 +1,128 @@
|
|
|
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
|
+
declare 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
|
+
declare 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
|
+
declare 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
|
+
declare 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
|
+
interface NamespaceMessagingConfig extends BaseMessagingConfig {
|
|
66
|
+
/**
|
|
67
|
+
* A string used to ensure the messenger only sends messages to and listens for messages from
|
|
68
|
+
* other messengers of the same type, with the same namespace.
|
|
69
|
+
*/
|
|
70
|
+
namespace: string;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Contains information about the message recieved.
|
|
74
|
+
*/
|
|
75
|
+
interface Message<TProtocolMap extends Record<string, any>, TType extends keyof TProtocolMap> {
|
|
76
|
+
/**
|
|
77
|
+
* A semi-unique, auto-incrementing number used to trace messages being sent.
|
|
78
|
+
*/
|
|
79
|
+
id: number;
|
|
80
|
+
/**
|
|
81
|
+
* The data that was passed into `sendMessage`
|
|
82
|
+
*/
|
|
83
|
+
data: GetDataType<TProtocolMap[TType]>;
|
|
84
|
+
type: TType;
|
|
85
|
+
/**
|
|
86
|
+
* The timestamp the message was sent in MS since epoch.
|
|
87
|
+
*/
|
|
88
|
+
timestamp: number;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* Messaging interface shared by all messengers.
|
|
93
|
+
*
|
|
94
|
+
* Type parameters accept:
|
|
95
|
+
* - `TProtocolMap` to define the data and return types of messages.
|
|
96
|
+
* - `TMessageExtension` to define additional fields that are available on a message inside
|
|
97
|
+
* `onMessage`'s callback
|
|
98
|
+
* - `TSendMessageArgs` to define a list of additional arguments for `sendMessage`
|
|
99
|
+
*/
|
|
100
|
+
interface GenericMessenger<TProtocolMap extends Record<string, any>, TMessageExtension, TSendMessageArgs extends any[]> {
|
|
101
|
+
/**
|
|
102
|
+
* Send a message to the background or a specific tab if `tabId` is passed. You can call this
|
|
103
|
+
* function anywhere in your extension.
|
|
104
|
+
*
|
|
105
|
+
* If you haven't setup a listener for the sent `type`, an error will be thrown.
|
|
106
|
+
*
|
|
107
|
+
* @param type The message type being sent. Call `onMessage` with the same type to listen for that message.
|
|
108
|
+
* @param data The data to send with the message.
|
|
109
|
+
* @param args Different messengers will have additional arguments to configure how a message gets sent.
|
|
110
|
+
*/
|
|
111
|
+
sendMessage<TType extends keyof TProtocolMap>(type: TType, data: GetDataType<TProtocolMap[TType]>, ...args: TSendMessageArgs): Promise<GetReturnType<TProtocolMap[TType]>>;
|
|
112
|
+
/**
|
|
113
|
+
* Trigger a callback when a message of the requested type is recieved. You cannot setup multiple
|
|
114
|
+
* listeners for the same message type in the same JS context.
|
|
115
|
+
*
|
|
116
|
+
* To remove the listener, call the returned message.
|
|
117
|
+
*
|
|
118
|
+
* @param type The message type to listen for. Call `sendMessage` with the same type to triggern this listener.
|
|
119
|
+
* @param onReceived The callback executed when a message is recieved.
|
|
120
|
+
*/
|
|
121
|
+
onMessage<TType extends keyof TProtocolMap>(type: TType, onReceived: (message: Message<TProtocolMap, TType> & TMessageExtension) => void | MaybePromise<GetReturnType<TProtocolMap[TType]>>): RemoveListenerCallback;
|
|
122
|
+
/**
|
|
123
|
+
* Removes all listeners.
|
|
124
|
+
*/
|
|
125
|
+
removeAllListeners(): void;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
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
CHANGED
|
@@ -1,10 +1,27 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
var __create = Object.create;
|
|
3
3
|
var __defProp = Object.defineProperty;
|
|
4
|
+
var __defProps = Object.defineProperties;
|
|
4
5
|
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
6
|
+
var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
|
|
5
7
|
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
8
|
+
var __getOwnPropSymbols = Object.getOwnPropertySymbols;
|
|
6
9
|
var __getProtoOf = Object.getPrototypeOf;
|
|
7
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));
|
|
8
25
|
var __export = (target, all) => {
|
|
9
26
|
for (var name in all)
|
|
10
27
|
__defProp(target, name, { get: all[name], enumerable: true });
|
|
@@ -49,104 +66,119 @@ __export(src_exports, {
|
|
|
49
66
|
defineExtensionMessaging: () => defineExtensionMessaging
|
|
50
67
|
});
|
|
51
68
|
module.exports = __toCommonJS(src_exports);
|
|
69
|
+
|
|
70
|
+
// src/extension.ts
|
|
52
71
|
var import_webextension_polyfill = __toESM(require("webextension-polyfill"), 1);
|
|
53
|
-
|
|
54
|
-
|
|
72
|
+
|
|
73
|
+
// src/generic.ts
|
|
74
|
+
var import_serialize_error = require("serialize-error");
|
|
75
|
+
function defineGenericMessanging(config) {
|
|
76
|
+
let removeRootListener;
|
|
77
|
+
let perTypeListeners = {};
|
|
55
78
|
function cleanupRootListener() {
|
|
56
|
-
if (Object.entries(
|
|
57
|
-
|
|
58
|
-
|
|
79
|
+
if (Object.entries(perTypeListeners).length === 0) {
|
|
80
|
+
removeRootListener == null ? void 0 : removeRootListener();
|
|
81
|
+
removeRootListener = void 0;
|
|
59
82
|
}
|
|
60
83
|
}
|
|
61
|
-
let keyListeners = {};
|
|
62
84
|
let idSeq = Math.floor(Math.random() * 1e4);
|
|
63
85
|
function getNextId() {
|
|
64
86
|
return idSeq++;
|
|
65
87
|
}
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
throw err;
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
88
|
+
return {
|
|
89
|
+
sendMessage(type, data, ...args) {
|
|
90
|
+
return __async(this, null, function* () {
|
|
91
|
+
var _a2, _b;
|
|
92
|
+
const message = {
|
|
93
|
+
id: getNextId(),
|
|
94
|
+
type,
|
|
95
|
+
data,
|
|
96
|
+
timestamp: Date.now()
|
|
97
|
+
};
|
|
98
|
+
(_a2 = config.logger) == null ? void 0 : _a2.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message, ...args);
|
|
99
|
+
const response = yield config.sendMessage(message, ...args);
|
|
100
|
+
const { res, err } = response != null ? response : { err: new Error("No response") };
|
|
101
|
+
(_b = config.logger) == null ? void 0 : _b.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
|
|
102
|
+
if (err != null)
|
|
103
|
+
throw (0, import_serialize_error.deserializeError)(err);
|
|
104
|
+
return res;
|
|
105
|
+
});
|
|
106
|
+
},
|
|
107
|
+
onMessage(type, onReceived) {
|
|
108
|
+
var _a2, _b, _c;
|
|
109
|
+
if (removeRootListener == null) {
|
|
110
|
+
(_a2 = config.logger) == null ? void 0 : _a2.debug(
|
|
111
|
+
`[messaging] "${type}" initialized the message listener for this context`
|
|
112
|
+
);
|
|
113
|
+
removeRootListener = config.addRootListener((message) => {
|
|
114
|
+
var _a3, _b2;
|
|
115
|
+
if (typeof message.type != "string" || typeof message.timestamp !== "number") {
|
|
116
|
+
const err = Error(
|
|
117
|
+
`[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(
|
|
118
|
+
message
|
|
119
|
+
)}`
|
|
120
|
+
);
|
|
121
|
+
(_a3 = config.logger) == null ? void 0 : _a3.error(err);
|
|
122
|
+
throw err;
|
|
123
|
+
}
|
|
124
|
+
(_b2 = config == null ? void 0 : config.logger) == null ? void 0 : _b2.debug("[messaging] Received message", message);
|
|
125
|
+
const listener = perTypeListeners[message.type];
|
|
126
|
+
if (listener == null)
|
|
127
|
+
return;
|
|
128
|
+
const res = listener(message);
|
|
94
129
|
return Promise.resolve(res).then((res2) => {
|
|
95
|
-
var
|
|
96
|
-
(
|
|
130
|
+
var _a4;
|
|
131
|
+
(_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
|
|
97
132
|
return { res: res2 };
|
|
98
133
|
}).catch((err) => {
|
|
99
|
-
var
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
errMessage = err.message;
|
|
103
|
-
else
|
|
104
|
-
errMessage = String(err);
|
|
105
|
-
(_a3 = config == null ? void 0 : config.logger) == null ? void 0 : _a3.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { err });
|
|
106
|
-
return { err: errMessage };
|
|
134
|
+
var _a4;
|
|
135
|
+
(_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { err });
|
|
136
|
+
return { err: (0, import_serialize_error.serializeError)(err) };
|
|
107
137
|
});
|
|
108
|
-
}
|
|
138
|
+
});
|
|
139
|
+
}
|
|
140
|
+
if (perTypeListeners[type] != null) {
|
|
141
|
+
const err = Error(
|
|
142
|
+
`[messaging] In this JS context, only one listener can be setup for ${type}`
|
|
143
|
+
);
|
|
144
|
+
(_b = config.logger) == null ? void 0 : _b.error(err);
|
|
145
|
+
throw err;
|
|
146
|
+
}
|
|
147
|
+
perTypeListeners[type] = onReceived;
|
|
148
|
+
(_c = config.logger) == null ? void 0 : _c.log(`[messaging] Added listener for ${type}`);
|
|
149
|
+
return () => {
|
|
150
|
+
delete perTypeListeners[type];
|
|
151
|
+
cleanupRootListener();
|
|
109
152
|
};
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
);
|
|
116
|
-
(_b = config == null ? void 0 : config.logger) == null ? void 0 : _b.error(err);
|
|
117
|
-
throw err;
|
|
118
|
-
}
|
|
119
|
-
keyListeners[type] = onReceived;
|
|
120
|
-
(_c = config == null ? void 0 : config.logger) == null ? void 0 : _c.log(`[messaging] Added listener for ${type}`);
|
|
121
|
-
return function removeListener() {
|
|
122
|
-
delete keyListeners[type];
|
|
153
|
+
},
|
|
154
|
+
removeAllListeners() {
|
|
155
|
+
Object.keys(perTypeListeners).forEach((type) => {
|
|
156
|
+
delete perTypeListeners[type];
|
|
157
|
+
});
|
|
123
158
|
cleanupRootListener();
|
|
124
|
-
}
|
|
125
|
-
}
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
159
|
+
}
|
|
160
|
+
};
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
// src/extension.ts
|
|
164
|
+
function defineExtensionMessaging(config) {
|
|
165
|
+
return defineGenericMessanging(__spreadProps(__spreadValues({}, config), {
|
|
166
|
+
sendMessage(message, tabId) {
|
|
132
167
|
if (tabId == null)
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
cleanupRootListener();
|
|
148
|
-
}
|
|
149
|
-
return { onMessage, sendMessage, removeAllMessageListeners };
|
|
168
|
+
return import_webextension_polyfill.default.runtime.sendMessage(message);
|
|
169
|
+
return import_webextension_polyfill.default.tabs.sendMessage(tabId, message);
|
|
170
|
+
},
|
|
171
|
+
addRootListener(processMessage) {
|
|
172
|
+
const listener = (message, sender) => {
|
|
173
|
+
if (typeof message === "object")
|
|
174
|
+
return processMessage(__spreadProps(__spreadValues({}, message), { sender }));
|
|
175
|
+
else
|
|
176
|
+
return processMessage(message);
|
|
177
|
+
};
|
|
178
|
+
import_webextension_polyfill.default.runtime.onMessage.addListener(listener);
|
|
179
|
+
return () => import_webextension_polyfill.default.runtime.onMessage.removeListener(listener);
|
|
180
|
+
}
|
|
181
|
+
}));
|
|
150
182
|
}
|
|
151
183
|
// Annotate the CommonJS export names for ESM import in node:
|
|
152
184
|
0 && (module.exports = {
|
package/lib/index.d.ts
CHANGED
|
@@ -1,118 +1,44 @@
|
|
|
1
|
+
import { B as BaseMessagingConfig, G as GenericMessenger } from './generic-e806d3a5.js';
|
|
2
|
+
export { B as BaseMessagingConfig, 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-e806d3a5.js';
|
|
1
3
|
import { Runtime } from 'webextension-polyfill';
|
|
2
4
|
|
|
3
5
|
/**
|
|
4
|
-
*
|
|
6
|
+
* Configuration passed into `defineExtensionMessaging`.
|
|
5
7
|
*/
|
|
6
|
-
interface
|
|
7
|
-
debug(...args: any[]): void;
|
|
8
|
-
log(...args: any[]): void;
|
|
9
|
-
warn(...args: any[]): void;
|
|
10
|
-
error(...args: any[]): void;
|
|
8
|
+
interface ExtensionMessagingConfig extends BaseMessagingConfig {
|
|
11
9
|
}
|
|
12
|
-
|
|
10
|
+
/**
|
|
11
|
+
* Additional fields available on the `Message` from an `ExtensionMessenger`.
|
|
12
|
+
*/
|
|
13
|
+
interface ExtensionMessage {
|
|
13
14
|
/**
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* Set to `null` to disable logging.
|
|
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
17
|
*/
|
|
18
|
-
|
|
18
|
+
sender: Runtime.MessageSender;
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
* @example
|
|
24
|
-
* interface ProtocolMap {
|
|
25
|
-
* // data is a string, returns undefined
|
|
26
|
-
* type1: string;
|
|
27
|
-
* // data is a string, returns a number
|
|
28
|
-
* type2: ProtocolWithReturn<string, number>;
|
|
29
|
-
* }
|
|
30
|
-
*
|
|
31
|
-
* > Internally, this is just an object with random keys for the data and return types.
|
|
32
|
-
*/
|
|
33
|
-
declare type ProtocolWithReturn<TData, TReturn> = {
|
|
34
|
-
BtVgCTPYZu: TData;
|
|
35
|
-
RrhVseLgZW: TReturn;
|
|
36
|
-
};
|
|
37
|
-
/**
|
|
38
|
-
* Given a function declaration, `ProtocolWithReturn`, or a value, return the message's data type.
|
|
39
|
-
*/
|
|
40
|
-
declare 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;
|
|
41
|
-
/**
|
|
42
|
-
* Given a function declaration, `ProtocolWithReturn`, or a value, return the message's return type.
|
|
43
|
-
*/
|
|
44
|
-
declare type GetReturnType<T> = T extends (...args: any[]) => infer R ? R : T extends ProtocolWithReturn<any, any> ? T['RrhVseLgZW'] : void;
|
|
45
|
-
/**
|
|
46
|
-
* Either a Promise of a type, or that type directly. Used to indicate that a method can by sync or
|
|
47
|
-
* async.
|
|
48
|
-
*/
|
|
49
|
-
declare type MaybePromise<T> = Promise<T> | T;
|
|
50
|
-
/**
|
|
51
|
-
* Call to ensure an active listener has been removed.
|
|
52
|
-
*
|
|
53
|
-
* If the listener has already been removed with `Messenger.removeAllListeners`, this is a noop.
|
|
54
|
-
*/
|
|
55
|
-
declare type RemoveListenerCallback = () => void;
|
|
56
|
-
declare type OnMessageReceived<TProtocolMap, TType extends keyof TProtocolMap> = (message: Message<TProtocolMap, TType>) => MaybePromise<GetReturnType<TProtocolMap[TType]>>;
|
|
57
|
-
/**
|
|
58
|
-
* Use the functions defined in the messenger to send and recieve messages throughout your entire extension.
|
|
21
|
+
* Send messsage accepts an additional, optional argument `tabId`. Pass it to send a message to a
|
|
22
|
+
* specific tab from the background script.
|
|
59
23
|
*
|
|
60
|
-
*
|
|
24
|
+
* You cannot message between tabs directly. It must go through the background script.
|
|
61
25
|
*/
|
|
62
|
-
|
|
26
|
+
declare type ExtensionSendMessageArgs = [
|
|
63
27
|
/**
|
|
64
|
-
*
|
|
65
|
-
* function anywhere in your extension.
|
|
66
|
-
*
|
|
67
|
-
* If you haven't setup a listener for the sent `type`, an error will be thrown.
|
|
68
|
-
*
|
|
69
|
-
* @param type The message type being sent. Call `onMessage` with the same type to listen for that message.
|
|
70
|
-
* @param data The data to send with the message.
|
|
71
|
-
* @param tabId An optional ID specifying which tab the message should be sent to.
|
|
28
|
+
* The tab to send a message to.
|
|
72
29
|
*/
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
* Trigger a callback when a message of the requested type is recieved. You cannot setup multiple
|
|
76
|
-
* listeners for the same message type in the same JS context.
|
|
77
|
-
*
|
|
78
|
-
* To remove the listener, call the returned message.
|
|
79
|
-
*
|
|
80
|
-
* @param type The message type to listen for. Call `sendMessage` with the same type to triggern this listener.
|
|
81
|
-
* @param onReceived The callback executed when a message is recieved.
|
|
82
|
-
*/
|
|
83
|
-
onMessage<TType extends keyof TProtocolMap>(type: TType, onReceived: OnMessageReceived<TProtocolMap, TType>): RemoveListenerCallback;
|
|
84
|
-
/**
|
|
85
|
-
* Removes all listeners.
|
|
86
|
-
*/
|
|
87
|
-
removeAllMessageListeners(): void;
|
|
88
|
-
}
|
|
30
|
+
tabId?: number
|
|
31
|
+
];
|
|
89
32
|
/**
|
|
90
|
-
*
|
|
33
|
+
* Messenger returned by `defineExtensionMessaging`.
|
|
91
34
|
*/
|
|
92
|
-
|
|
93
|
-
/**
|
|
94
|
-
* A semi-unique, auto-incrementing number used to trace messages being sent.
|
|
95
|
-
*/
|
|
96
|
-
id: number;
|
|
97
|
-
/**
|
|
98
|
-
* The data that was passed into `sendMessage`
|
|
99
|
-
*/
|
|
100
|
-
data: GetDataType<TProtocolMap[TType]>;
|
|
101
|
-
/**
|
|
102
|
-
* See [`MessageSender`](https://developer.chrome.com/docs/extensions/reference/runtime/#type-MessageSender).
|
|
103
|
-
* This contains information about which JS context sent the message.
|
|
104
|
-
*/
|
|
105
|
-
sender: Runtime.MessageSender;
|
|
106
|
-
/**
|
|
107
|
-
* The timestamp the message was sent in MS since epoch.
|
|
108
|
-
*/
|
|
109
|
-
timestamp: number;
|
|
110
|
-
}
|
|
35
|
+
declare type ExtensionMessenger<TProtocolMap extends Record<string, any>> = GenericMessenger<TProtocolMap, ExtensionMessage, ExtensionSendMessageArgs>;
|
|
111
36
|
/**
|
|
112
|
-
*
|
|
37
|
+
* Returns an `ExtensionMessenger` that is backed by the `browser.runtime.sendMessage` and
|
|
38
|
+
* `browser.tabs.sendMessage` APIs.
|
|
113
39
|
*
|
|
114
|
-
*
|
|
40
|
+
* It can be used to send messages to and from the background page/service worker.
|
|
115
41
|
*/
|
|
116
|
-
declare function defineExtensionMessaging<TProtocolMap
|
|
42
|
+
declare function defineExtensionMessaging<TProtocolMap extends Record<string, any> = Record<string, any>>(config?: ExtensionMessagingConfig): ExtensionMessenger<TProtocolMap>;
|
|
117
43
|
|
|
118
|
-
export {
|
|
44
|
+
export { ExtensionMessage, ExtensionMessagingConfig, ExtensionMessenger, ExtensionSendMessageArgs, defineExtensionMessaging };
|