@webext-core/messaging 3.0.1 → 3.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/lib/generic-429riQla.mjs +79 -0
- package/lib/generic-B-kFbyP9.d.cts +122 -0
- package/lib/generic-B-kFbyP9.d.mts +122 -0
- package/lib/generic-CSGM8pRq.cjs +84 -0
- package/lib/index.cjs +46 -195
- package/lib/index.d.cts +42 -0
- package/lib/index.d.mts +42 -0
- package/lib/index.global.js +1 -1245
- package/lib/index.mjs +32 -0
- package/lib/page.cjs +189 -287
- package/lib/{page.d.ts → page.d.cts} +44 -51
- package/lib/page.d.mts +91 -0
- package/lib/page.global.js +1 -335
- package/lib/page.mjs +194 -0
- package/package.json +34 -30
- package/lib/chunk-GMKXECDR.js +0 -157
- package/lib/generic-c22f9780.d.ts +0 -137
- package/lib/index.d.ts +0 -54
- package/lib/index.js +0 -37
- package/lib/page.js +0 -127
package/README.md
CHANGED
|
@@ -18,7 +18,7 @@ export const { sendMessage, onMessage } = defineExtensionMessaging<ProtocolMap>(
|
|
|
18
18
|
// ./background.ts
|
|
19
19
|
import { onMessage } from './messaging';
|
|
20
20
|
|
|
21
|
-
onMessage('getStringLength', message => {
|
|
21
|
+
onMessage('getStringLength', (message) => {
|
|
22
22
|
return message.data.length;
|
|
23
23
|
});
|
|
24
24
|
```
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import { deserializeError, serializeError } from "@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 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: 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
|
+
export { defineGenericMessanging as t };
|
|
@@ -0,0 +1,122 @@
|
|
|
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 };
|
|
@@ -0,0 +1,122 @@
|
|
|
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 };
|
|
@@ -0,0 +1,84 @@
|
|
|
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
CHANGED
|
@@ -1,205 +1,56 @@
|
|
|
1
|
-
"
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
+
//#region \0rolldown/runtime.js
|
|
2
3
|
var __create = Object.create;
|
|
3
4
|
var __defProp = Object.defineProperty;
|
|
4
|
-
var __defProps = Object.defineProperties;
|
|
5
5
|
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
6
|
-
var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
|
|
7
6
|
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
8
|
-
var __getOwnPropSymbols = Object.getOwnPropertySymbols;
|
|
9
7
|
var __getProtoOf = Object.getPrototypeOf;
|
|
10
8
|
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
9
|
var __copyProps = (to, from, except, desc) => {
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
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;
|
|
36
18
|
};
|
|
37
|
-
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
)
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
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_zero_serialize_error = require("@aklinker1/zero-serialize-error");
|
|
79
|
-
function defineGenericMessanging(config) {
|
|
80
|
-
let removeRootListener;
|
|
81
|
-
let perTypeListeners = {};
|
|
82
|
-
function cleanupRootListener() {
|
|
83
|
-
if (Object.entries(perTypeListeners).length === 0) {
|
|
84
|
-
removeRootListener == null ? void 0 : removeRootListener();
|
|
85
|
-
removeRootListener = void 0;
|
|
86
|
-
}
|
|
87
|
-
}
|
|
88
|
-
let idSeq = Math.floor(Math.random() * 1e4);
|
|
89
|
-
function getNextId() {
|
|
90
|
-
return idSeq++;
|
|
91
|
-
}
|
|
92
|
-
return {
|
|
93
|
-
sendMessage(type, data, ...args) {
|
|
94
|
-
return __async(this, null, function* () {
|
|
95
|
-
var _a2, _b, _c, _d;
|
|
96
|
-
const _message = {
|
|
97
|
-
id: getNextId(),
|
|
98
|
-
type,
|
|
99
|
-
data,
|
|
100
|
-
timestamp: Date.now()
|
|
101
|
-
};
|
|
102
|
-
const message = (_b = yield (_a2 = config.verifyMessageData) == null ? void 0 : _a2.call(config, _message)) != null ? _b : _message;
|
|
103
|
-
(_c = config.logger) == null ? void 0 : _c.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message, ...args);
|
|
104
|
-
const response = yield config.sendMessage(message, ...args);
|
|
105
|
-
const { res, err } = response != null ? response : { err: new Error("No response") };
|
|
106
|
-
(_d = config.logger) == null ? void 0 : _d.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
|
|
107
|
-
if (err != null)
|
|
108
|
-
throw (0, import_zero_serialize_error.deserializeError)(err);
|
|
109
|
-
return res;
|
|
110
|
-
});
|
|
111
|
-
},
|
|
112
|
-
onMessage(type, onReceived) {
|
|
113
|
-
var _a2, _b, _c;
|
|
114
|
-
if (removeRootListener == null) {
|
|
115
|
-
(_a2 = config.logger) == null ? void 0 : _a2.debug(
|
|
116
|
-
`[messaging] "${type}" initialized the message listener for this context`
|
|
117
|
-
);
|
|
118
|
-
removeRootListener = config.addRootListener((message) => {
|
|
119
|
-
var _a3, _b2;
|
|
120
|
-
if (typeof message.type != "string" || typeof message.timestamp !== "number") {
|
|
121
|
-
if (config.throwOnUnknownMessageFormat) {
|
|
122
|
-
const err = Error(
|
|
123
|
-
`[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(
|
|
124
|
-
message
|
|
125
|
-
)}`
|
|
126
|
-
);
|
|
127
|
-
(_a3 = config.logger) == null ? void 0 : _a3.error(err);
|
|
128
|
-
throw err;
|
|
129
|
-
} else {
|
|
130
|
-
return;
|
|
131
|
-
}
|
|
132
|
-
}
|
|
133
|
-
(_b2 = config == null ? void 0 : config.logger) == null ? void 0 : _b2.debug("[messaging] Received message", message);
|
|
134
|
-
const listener = perTypeListeners[message.type];
|
|
135
|
-
if (listener == null)
|
|
136
|
-
return;
|
|
137
|
-
const res = listener(message);
|
|
138
|
-
return Promise.resolve(res).then((res2) => {
|
|
139
|
-
var _a4, _b3;
|
|
140
|
-
return (_b3 = (_a4 = config.verifyMessageData) == null ? void 0 : _a4.call(config, res2)) != null ? _b3 : res2;
|
|
141
|
-
}).then((res2) => {
|
|
142
|
-
var _a4;
|
|
143
|
-
(_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
|
|
144
|
-
return { res: res2 };
|
|
145
|
-
}).catch((err) => {
|
|
146
|
-
var _a4;
|
|
147
|
-
(_a4 = config == null ? void 0 : config.logger) == null ? void 0 : _a4.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { err });
|
|
148
|
-
return { err: (0, import_zero_serialize_error.serializeError)(err) };
|
|
149
|
-
});
|
|
150
|
-
});
|
|
151
|
-
}
|
|
152
|
-
if (perTypeListeners[type] != null) {
|
|
153
|
-
const err = Error(
|
|
154
|
-
`[messaging] In this JS context, only one listener can be setup for ${type}`
|
|
155
|
-
);
|
|
156
|
-
(_b = config.logger) == null ? void 0 : _b.error(err);
|
|
157
|
-
throw err;
|
|
158
|
-
}
|
|
159
|
-
perTypeListeners[type] = onReceived;
|
|
160
|
-
(_c = config.logger) == null ? void 0 : _c.log(`[messaging] Added listener for ${type}`);
|
|
161
|
-
return () => {
|
|
162
|
-
delete perTypeListeners[type];
|
|
163
|
-
cleanupRootListener();
|
|
164
|
-
};
|
|
165
|
-
},
|
|
166
|
-
removeAllListeners() {
|
|
167
|
-
Object.keys(perTypeListeners).forEach((type) => {
|
|
168
|
-
delete perTypeListeners[type];
|
|
169
|
-
});
|
|
170
|
-
cleanupRootListener();
|
|
171
|
-
}
|
|
172
|
-
};
|
|
173
|
-
}
|
|
174
|
-
|
|
175
|
-
// src/extension.ts
|
|
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
|
+
*/
|
|
176
34
|
function defineExtensionMessaging(config) {
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
};
|
|
197
|
-
import_webextension_polyfill.default.runtime.onMessage.addListener(listener);
|
|
198
|
-
return () => import_webextension_polyfill.default.runtime.onMessage.removeListener(listener);
|
|
199
|
-
}
|
|
200
|
-
}));
|
|
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
|
+
});
|
|
201
54
|
}
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
defineExtensionMessaging
|
|
205
|
-
});
|
|
55
|
+
//#endregion
|
|
56
|
+
exports.defineExtensionMessaging = defineExtensionMessaging;
|