@webext-core/messaging 1.0.0 → 1.0.2
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/index.cjs +17 -17
- package/lib/index.js +17 -17
- package/package.json +22 -2
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
A light weight, type-safe wrapper around the `Browser.runtime.sendMessage` APIs.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
In addition to adding types, it also includes error handling. Any errors will be returned to where `sendMessage` was called.
|
|
6
6
|
|
|
7
7
|
## Usage
|
|
8
8
|
|
package/lib/index.cjs
CHANGED
|
@@ -55,7 +55,7 @@ function defineExtensionMessaging(config) {
|
|
|
55
55
|
let keyListeners = {};
|
|
56
56
|
let idSeq = Math.floor(Math.random() * 1e4);
|
|
57
57
|
function getNextId() {
|
|
58
|
-
return idSeq
|
|
58
|
+
return idSeq++;
|
|
59
59
|
}
|
|
60
60
|
function onMessage(key, onReceived) {
|
|
61
61
|
var _a, _b, _c;
|
|
@@ -63,8 +63,8 @@ function defineExtensionMessaging(config) {
|
|
|
63
63
|
(_a = config == null ? void 0 : config.logger) == null ? void 0 : _a.debug(
|
|
64
64
|
`[messaging] ${key} initialized message listener for this context`
|
|
65
65
|
);
|
|
66
|
-
rootListener = (message, sender) =>
|
|
67
|
-
var _a2, _b2, _c2
|
|
66
|
+
rootListener = (message, sender) => {
|
|
67
|
+
var _a2, _b2, _c2;
|
|
68
68
|
if (typeof message.key != "string" || typeof message.timestamp !== "number") {
|
|
69
69
|
const err = Error(
|
|
70
70
|
`[messaging] Unknown message format, must include the 'key' & 'timestamp' fields, received: ${JSON.stringify(
|
|
@@ -80,27 +80,27 @@ function defineExtensionMessaging(config) {
|
|
|
80
80
|
if (message.key !== key2)
|
|
81
81
|
continue;
|
|
82
82
|
(_c2 = config == null ? void 0 : config.logger) == null ? void 0 : _c2.debug(`[messaging] onMessage {id=${message.id}} \u140A\u2500`, message);
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
83
|
+
const res = listener({
|
|
84
|
+
data: message.data,
|
|
85
|
+
sender,
|
|
86
|
+
timestamp: message.timestamp
|
|
87
|
+
});
|
|
88
|
+
return Promise.resolve(res).then((res2) => {
|
|
89
|
+
var _a3;
|
|
90
|
+
(_a3 = config == null ? void 0 : config.logger) == null ? void 0 : _a3.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
|
|
91
|
+
return { res: res2 };
|
|
92
|
+
}).catch((err) => {
|
|
93
|
+
var _a3;
|
|
92
94
|
let errMessage;
|
|
93
95
|
if (err instanceof Error)
|
|
94
96
|
errMessage = err.message;
|
|
95
97
|
else
|
|
96
98
|
errMessage = String(err);
|
|
97
|
-
(
|
|
99
|
+
(_a3 = config == null ? void 0 : config.logger) == null ? void 0 : _a3.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { err });
|
|
98
100
|
return { err: errMessage };
|
|
99
|
-
}
|
|
101
|
+
});
|
|
100
102
|
}
|
|
101
|
-
|
|
102
|
-
});
|
|
103
|
-
});
|
|
103
|
+
};
|
|
104
104
|
import_webextension_polyfill.default.runtime.onMessage.addListener(rootListener);
|
|
105
105
|
}
|
|
106
106
|
if (keyListeners[key] != null) {
|
package/lib/index.js
CHANGED
|
@@ -26,7 +26,7 @@ function defineExtensionMessaging(config) {
|
|
|
26
26
|
let keyListeners = {};
|
|
27
27
|
let idSeq = Math.floor(Math.random() * 1e4);
|
|
28
28
|
function getNextId() {
|
|
29
|
-
return idSeq
|
|
29
|
+
return idSeq++;
|
|
30
30
|
}
|
|
31
31
|
function onMessage(key, onReceived) {
|
|
32
32
|
var _a, _b, _c;
|
|
@@ -34,8 +34,8 @@ function defineExtensionMessaging(config) {
|
|
|
34
34
|
(_a = config == null ? void 0 : config.logger) == null ? void 0 : _a.debug(
|
|
35
35
|
`[messaging] ${key} initialized message listener for this context`
|
|
36
36
|
);
|
|
37
|
-
rootListener = (message, sender) =>
|
|
38
|
-
var _a2, _b2, _c2
|
|
37
|
+
rootListener = (message, sender) => {
|
|
38
|
+
var _a2, _b2, _c2;
|
|
39
39
|
if (typeof message.key != "string" || typeof message.timestamp !== "number") {
|
|
40
40
|
const err = Error(
|
|
41
41
|
`[messaging] Unknown message format, must include the 'key' & 'timestamp' fields, received: ${JSON.stringify(
|
|
@@ -51,27 +51,27 @@ function defineExtensionMessaging(config) {
|
|
|
51
51
|
if (message.key !== key2)
|
|
52
52
|
continue;
|
|
53
53
|
(_c2 = config == null ? void 0 : config.logger) == null ? void 0 : _c2.debug(`[messaging] onMessage {id=${message.id}} \u140A\u2500`, message);
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
54
|
+
const res = listener({
|
|
55
|
+
data: message.data,
|
|
56
|
+
sender,
|
|
57
|
+
timestamp: message.timestamp
|
|
58
|
+
});
|
|
59
|
+
return Promise.resolve(res).then((res2) => {
|
|
60
|
+
var _a3;
|
|
61
|
+
(_a3 = config == null ? void 0 : config.logger) == null ? void 0 : _a3.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
|
|
62
|
+
return { res: res2 };
|
|
63
|
+
}).catch((err) => {
|
|
64
|
+
var _a3;
|
|
63
65
|
let errMessage;
|
|
64
66
|
if (err instanceof Error)
|
|
65
67
|
errMessage = err.message;
|
|
66
68
|
else
|
|
67
69
|
errMessage = String(err);
|
|
68
|
-
(
|
|
70
|
+
(_a3 = config == null ? void 0 : config.logger) == null ? void 0 : _a3.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { err });
|
|
69
71
|
return { err: errMessage };
|
|
70
|
-
}
|
|
72
|
+
});
|
|
71
73
|
}
|
|
72
|
-
|
|
73
|
-
});
|
|
74
|
-
});
|
|
74
|
+
};
|
|
75
75
|
Browser.runtime.onMessage.addListener(rootListener);
|
|
76
76
|
}
|
|
77
77
|
if (keyListeners[key] != null) {
|
package/package.json
CHANGED
|
@@ -1,8 +1,28 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@webext-core/messaging",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "Light weight, type-safe wrapper around the extension messaging APIs",
|
|
5
5
|
"license": "MIT",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"web-extension",
|
|
8
|
+
"browser-extension",
|
|
9
|
+
"chrome-extension",
|
|
10
|
+
"webext",
|
|
11
|
+
"web-ext",
|
|
12
|
+
"web",
|
|
13
|
+
"chrome",
|
|
14
|
+
"browser",
|
|
15
|
+
"extension",
|
|
16
|
+
"message",
|
|
17
|
+
"messaging",
|
|
18
|
+
"webextension-polyfill"
|
|
19
|
+
],
|
|
20
|
+
"homepage": "https://github.com/aklinker1/webext-core/tree/main/packages/messaging",
|
|
21
|
+
"repository": {
|
|
22
|
+
"type": "git",
|
|
23
|
+
"url": "https://github.com/aklinker1/webext-core",
|
|
24
|
+
"directory": "packages/messaging"
|
|
25
|
+
},
|
|
6
26
|
"type": "module",
|
|
7
27
|
"publishConfig": {
|
|
8
28
|
"access": "public"
|
|
@@ -28,7 +48,7 @@
|
|
|
28
48
|
"tsup": "^6.4.0",
|
|
29
49
|
"typescript": "^4.8.4",
|
|
30
50
|
"vitest": "^0.24.5",
|
|
31
|
-
"@webext-core/fake-browser": "1.0.
|
|
51
|
+
"@webext-core/fake-browser": "1.0.1",
|
|
32
52
|
"tsconfig": "0.0.0"
|
|
33
53
|
},
|
|
34
54
|
"scripts": {
|