@webext-core/messaging 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.js CHANGED
@@ -23,22 +23,28 @@ var __async = (__this, __arguments, generator) => {
23
23
  import Browser from "webextension-polyfill";
24
24
  function defineExtensionMessaging(config) {
25
25
  let rootListener;
26
+ function cleanupRootListener() {
27
+ if (Object.entries(keyListeners).length === 0) {
28
+ Browser.runtime.onMessage.removeListener(rootListener);
29
+ rootListener = void 0;
30
+ }
31
+ }
26
32
  let keyListeners = {};
27
33
  let idSeq = Math.floor(Math.random() * 1e4);
28
34
  function getNextId() {
29
35
  return idSeq++;
30
36
  }
31
- function onMessage(key, onReceived) {
37
+ function onMessage(type, onReceived) {
32
38
  var _a, _b, _c;
33
39
  if (rootListener == null) {
34
40
  (_a = config == null ? void 0 : config.logger) == null ? void 0 : _a.debug(
35
- `[messaging] ${key} initialized message listener for this context`
41
+ `[messaging] ${type} initialized message listener for this context`
36
42
  );
37
43
  rootListener = (message, sender) => {
38
44
  var _a2, _b2, _c2;
39
- if (typeof message.key != "string" || typeof message.timestamp !== "number") {
45
+ if (typeof message.type != "string" || typeof message.timestamp !== "number") {
40
46
  const err = Error(
41
- `[messaging] Unknown message format, must include the 'key' & 'timestamp' fields, received: ${JSON.stringify(
47
+ `[messaging] Unknown message format, must include the 'type' & 'timestamp' fields, received: ${JSON.stringify(
42
48
  message
43
49
  )}`
44
50
  );
@@ -47,8 +53,8 @@ function defineExtensionMessaging(config) {
47
53
  }
48
54
  (_b2 = config == null ? void 0 : config.logger) == null ? void 0 : _b2.debug("[messaging] Received message", message, sender);
49
55
  const entries = Object.entries(keyListeners);
50
- for (const [key2, listener] of entries) {
51
- if (message.key !== key2)
56
+ for (const [type2, listener] of entries) {
57
+ if (message.type !== type2)
52
58
  continue;
53
59
  (_c2 = config == null ? void 0 : config.logger) == null ? void 0 : _c2.debug(`[messaging] onMessage {id=${message.id}} \u140A\u2500`, message);
54
60
  const res = listener({
@@ -72,34 +78,31 @@ function defineExtensionMessaging(config) {
72
78
  });
73
79
  }
74
80
  return Promise.resolve({
75
- err: `Listener not found for message.type="${message.key}".
81
+ err: `Listener not found for message.type="${message.type}".
76
82
 
77
83
  Did you forget to call \`onMessage("getLength", ...)\`?`
78
84
  });
79
85
  };
80
86
  Browser.runtime.onMessage.addListener(rootListener);
81
87
  }
82
- if (keyListeners[key] != null) {
88
+ if (keyListeners[type] != null) {
83
89
  const err = Error(
84
- `[messaging] In this JS context, only one listener can be setup for ${key}`
90
+ `[messaging] In this JS context, only one listener can be setup for ${type}`
85
91
  );
86
92
  (_b = config == null ? void 0 : config.logger) == null ? void 0 : _b.error(err);
87
93
  throw err;
88
94
  }
89
- keyListeners[key] = onReceived;
90
- (_c = config == null ? void 0 : config.logger) == null ? void 0 : _c.log(`[messaging] Added listener for ${key}`);
95
+ keyListeners[type] = onReceived;
96
+ (_c = config == null ? void 0 : config.logger) == null ? void 0 : _c.log(`[messaging] Added listener for ${type}`);
91
97
  return function removeListener() {
92
- delete keyListeners[key];
93
- if (Object.entries(keyListeners).length === 0) {
94
- Browser.runtime.onMessage.removeListener(rootListener);
95
- rootListener = void 0;
96
- }
98
+ delete keyListeners[type];
99
+ cleanupRootListener();
97
100
  };
98
101
  }
99
- function sendMessage(key, data, tabId) {
102
+ function sendMessage(type, data, tabId) {
100
103
  return __async(this, null, function* () {
101
104
  var _a, _b;
102
- const message = { id: getNextId(), key, data, timestamp: Date.now() };
105
+ const message = { id: getNextId(), type, data, timestamp: Date.now() };
103
106
  (_a = config == null ? void 0 : config.logger) == null ? void 0 : _a.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message);
104
107
  let response;
105
108
  if (tabId == null)
@@ -113,7 +116,13 @@ Did you forget to call \`onMessage("getLength", ...)\`?`
113
116
  return res;
114
117
  });
115
118
  }
116
- return { onMessage, sendMessage };
119
+ function removeAllMessageListeners() {
120
+ Object.keys(keyListeners).forEach((type) => {
121
+ delete keyListeners[type];
122
+ });
123
+ cleanupRootListener();
124
+ }
125
+ return { onMessage, sendMessage, removeAllMessageListeners };
117
126
  }
118
127
  export {
119
128
  defineExtensionMessaging
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@webext-core/messaging",
3
- "version": "1.1.0",
3
+ "version": "1.2.0",
4
4
  "description": "Light weight, type-safe wrapper around the extension messaging APIs",
5
5
  "license": "MIT",
6
6
  "keywords": [
@@ -48,11 +48,11 @@
48
48
  "tsup": "^6.4.0",
49
49
  "typescript": "^4.8.4",
50
50
  "vitest": "^0.24.5",
51
- "@webext-core/fake-browser": "1.0.2",
51
+ "@webext-core/fake-browser": "1.0.4",
52
52
  "tsconfig": "0.0.0"
53
53
  },
54
54
  "scripts": {
55
- "build": "tsup src/index.ts --clean --out-dir lib --format esm,cjs --dts",
55
+ "build": "tsup src/index.ts --clean --out-dir lib --dts --format esm,cjs,iife --global-name webExtCoreMessaging",
56
56
  "build:dependencies": "cd ../.. && turbo run build --filter=@webext-core/messaging^...",
57
57
  "test": "vitest -r src",
58
58
  "test:coverage": "vitest run -r src --coverage",