@webext-core/messaging 1.0.3 → 1.1.1

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 CHANGED
@@ -1,44 +1,36 @@
1
1
  # `@webext-core/messaging`
2
2
 
3
- A light weight, type-safe wrapper around the `Browser.runtime.sendMessage` APIs.
3
+ A light-weight, type-safe wrapper around the `browser.runtime` messaging APIs.
4
4
 
5
- In addition to adding types, it also includes error handling. Any errors will be returned to where `sendMessage` was called.
6
-
7
- ## Usage
8
-
9
- In your project, create a file that calls `defineExtensionMessaging`, and exports the two functions it returns.
10
-
11
- <!-- prettier-ignore -->
12
5
  ```ts
13
- // messaging.ts
14
- import { defineExtensionMessaging, ProtocolWithReturn } from '@webext-core/messaging';
6
+ // ./messaging.ts
7
+ import { ProtocolWithReturn, defineExtensionMessaging } from '@webext-core/messaging';
15
8
 
16
- // This defines the data and return types used for each message
17
9
  interface ProtocolMap {
18
- message1: undefined; // No data and no return type
19
- message2: string; // Only data
20
- message3: ProtocolWithReturn<undefined, boolean>; // Only a return type
21
- message4: ProtocolWithReturn<string, boolean>; // Data and return type
10
+ getStringLength: ProtocolWithReturn<string, number>;
22
11
  }
23
12
 
24
13
  export const { sendMessage, onMessage } = defineExtensionMessaging<ProtocolMap>();
25
14
  ```
26
15
 
27
- Then import those functions throughout the rest of the extension.
28
-
29
16
  ```ts
30
- // src/background.ts
17
+ // ./background.ts
31
18
  import { onMessage } from './messaging';
32
19
 
33
- onMessage('message4', message => {
34
- console.log(message);
35
- return !!message.data;
20
+ onMessage('getStringLength', message => {
21
+ return message.data.length;
36
22
  });
37
23
  ```
38
24
 
39
25
  ```ts
40
- // src/popup.ts
26
+ // ./content-script.js or anywhere else
41
27
  import { sendMessage } from './messaging';
42
28
 
43
- sendMessage('message4', 'data').then(console.log);
29
+ const length = await sendMessage('getStringLength', 'hello world');
30
+
31
+ console.log(length); // 11
44
32
  ```
33
+
34
+ ## Get Started
35
+
36
+ See [documentation](https://webext-core.aklinker1.io/messaging) to get started!
package/lib/index.cjs CHANGED
@@ -75,8 +75,8 @@ function defineExtensionMessaging(config) {
75
75
  throw err;
76
76
  }
77
77
  (_b2 = config == null ? void 0 : config.logger) == null ? void 0 : _b2.debug("[messaging] Received message", message, sender);
78
- const entires = Object.entries(keyListeners);
79
- for (const [key2, listener] of entires) {
78
+ const entries = Object.entries(keyListeners);
79
+ for (const [key2, listener] of entries) {
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);
@@ -100,6 +100,11 @@ function defineExtensionMessaging(config) {
100
100
  return { err: errMessage };
101
101
  });
102
102
  }
103
+ return Promise.resolve({
104
+ err: `Listener not found for message.type="${message.key}".
105
+
106
+ Did you forget to call \`onMessage("getLength", ...)\`?`
107
+ });
103
108
  };
104
109
  import_webextension_polyfill.default.runtime.onMessage.addListener(rootListener);
105
110
  }
@@ -112,6 +117,13 @@ function defineExtensionMessaging(config) {
112
117
  }
113
118
  keyListeners[key] = onReceived;
114
119
  (_c = config == null ? void 0 : config.logger) == null ? void 0 : _c.log(`[messaging] Added listener for ${key}`);
120
+ return function removeListener() {
121
+ delete keyListeners[key];
122
+ if (Object.entries(keyListeners).length === 0) {
123
+ import_webextension_polyfill.default.runtime.onMessage.removeListener(rootListener);
124
+ rootListener = void 0;
125
+ }
126
+ };
115
127
  }
116
128
  function sendMessage(key, data, tabId) {
117
129
  return __async(this, null, function* () {
package/lib/index.d.ts CHANGED
@@ -23,7 +23,7 @@ interface Message<TProtocolMap, TKey extends keyof TProtocolMap> {
23
23
  declare type MaybePromise<T> = Promise<T> | T;
24
24
  declare type OnMessageReceived<TProtocolMap, TKey extends keyof TProtocolMap> = (message: Message<TProtocolMap, TKey>) => MaybePromise<GetResponse<TProtocolMap[TKey]>>;
25
25
  declare function defineExtensionMessaging<TProtocolMap>(config?: ExtensionMessagingConfig): {
26
- onMessage: <TKey extends keyof TProtocolMap>(key: TKey, onReceived: OnMessageReceived<TProtocolMap, TKey>) => void;
26
+ onMessage: <TKey extends keyof TProtocolMap>(key: TKey, onReceived: OnMessageReceived<TProtocolMap, TKey>) => () => void;
27
27
  sendMessage: <TKey_1 extends keyof TProtocolMap>(key: TKey_1, data: GetData<TProtocolMap[TKey_1]>, tabId?: number) => Promise<GetResponse<TProtocolMap[TKey_1]>>;
28
28
  };
29
29
 
@@ -0,0 +1,1146 @@
1
+ "use strict";
2
+ var webExtCoreMessaging = (() => {
3
+ var __create = Object.create;
4
+ var __defProp = Object.defineProperty;
5
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
6
+ var __getOwnPropNames = Object.getOwnPropertyNames;
7
+ var __getProtoOf = Object.getPrototypeOf;
8
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
9
+ var __commonJS = (cb, mod) => function __require() {
10
+ return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
11
+ };
12
+ var __export = (target, all) => {
13
+ for (var name in all)
14
+ __defProp(target, name, { get: all[name], enumerable: true });
15
+ };
16
+ var __copyProps = (to, from, except, desc) => {
17
+ if (from && typeof from === "object" || typeof from === "function") {
18
+ for (let key of __getOwnPropNames(from))
19
+ if (!__hasOwnProp.call(to, key) && key !== except)
20
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
21
+ }
22
+ return to;
23
+ };
24
+ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
25
+ isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
26
+ mod
27
+ ));
28
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
29
+ var __async = (__this, __arguments, generator) => {
30
+ return new Promise((resolve, reject) => {
31
+ var fulfilled = (value) => {
32
+ try {
33
+ step(generator.next(value));
34
+ } catch (e) {
35
+ reject(e);
36
+ }
37
+ };
38
+ var rejected = (value) => {
39
+ try {
40
+ step(generator.throw(value));
41
+ } catch (e) {
42
+ reject(e);
43
+ }
44
+ };
45
+ var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
46
+ step((generator = generator.apply(__this, __arguments)).next());
47
+ });
48
+ };
49
+
50
+ // ../../node_modules/.pnpm/webextension-polyfill@0.10.0/node_modules/webextension-polyfill/dist/browser-polyfill.js
51
+ var require_browser_polyfill = __commonJS({
52
+ "../../node_modules/.pnpm/webextension-polyfill@0.10.0/node_modules/webextension-polyfill/dist/browser-polyfill.js"(exports, module) {
53
+ (function(global, factory) {
54
+ if (typeof define === "function" && define.amd) {
55
+ define("webextension-polyfill", ["module"], factory);
56
+ } else if (typeof exports !== "undefined") {
57
+ factory(module);
58
+ } else {
59
+ var mod = {
60
+ exports: {}
61
+ };
62
+ factory(mod);
63
+ global.browser = mod.exports;
64
+ }
65
+ })(typeof globalThis !== "undefined" ? globalThis : typeof self !== "undefined" ? self : exports, function(module2) {
66
+ var _a, _b;
67
+ "use strict";
68
+ if (!((_b = (_a = globalThis.chrome) == null ? void 0 : _a.runtime) == null ? void 0 : _b.id)) {
69
+ throw new Error("This script should only be loaded in a browser extension.");
70
+ }
71
+ if (typeof globalThis.browser === "undefined" || Object.getPrototypeOf(globalThis.browser) !== Object.prototype) {
72
+ const CHROME_SEND_MESSAGE_CALLBACK_NO_RESPONSE_MESSAGE = "The message port closed before a response was received.";
73
+ const wrapAPIs = (extensionAPIs) => {
74
+ const apiMetadata = {
75
+ "alarms": {
76
+ "clear": {
77
+ "minArgs": 0,
78
+ "maxArgs": 1
79
+ },
80
+ "clearAll": {
81
+ "minArgs": 0,
82
+ "maxArgs": 0
83
+ },
84
+ "get": {
85
+ "minArgs": 0,
86
+ "maxArgs": 1
87
+ },
88
+ "getAll": {
89
+ "minArgs": 0,
90
+ "maxArgs": 0
91
+ }
92
+ },
93
+ "bookmarks": {
94
+ "create": {
95
+ "minArgs": 1,
96
+ "maxArgs": 1
97
+ },
98
+ "get": {
99
+ "minArgs": 1,
100
+ "maxArgs": 1
101
+ },
102
+ "getChildren": {
103
+ "minArgs": 1,
104
+ "maxArgs": 1
105
+ },
106
+ "getRecent": {
107
+ "minArgs": 1,
108
+ "maxArgs": 1
109
+ },
110
+ "getSubTree": {
111
+ "minArgs": 1,
112
+ "maxArgs": 1
113
+ },
114
+ "getTree": {
115
+ "minArgs": 0,
116
+ "maxArgs": 0
117
+ },
118
+ "move": {
119
+ "minArgs": 2,
120
+ "maxArgs": 2
121
+ },
122
+ "remove": {
123
+ "minArgs": 1,
124
+ "maxArgs": 1
125
+ },
126
+ "removeTree": {
127
+ "minArgs": 1,
128
+ "maxArgs": 1
129
+ },
130
+ "search": {
131
+ "minArgs": 1,
132
+ "maxArgs": 1
133
+ },
134
+ "update": {
135
+ "minArgs": 2,
136
+ "maxArgs": 2
137
+ }
138
+ },
139
+ "browserAction": {
140
+ "disable": {
141
+ "minArgs": 0,
142
+ "maxArgs": 1,
143
+ "fallbackToNoCallback": true
144
+ },
145
+ "enable": {
146
+ "minArgs": 0,
147
+ "maxArgs": 1,
148
+ "fallbackToNoCallback": true
149
+ },
150
+ "getBadgeBackgroundColor": {
151
+ "minArgs": 1,
152
+ "maxArgs": 1
153
+ },
154
+ "getBadgeText": {
155
+ "minArgs": 1,
156
+ "maxArgs": 1
157
+ },
158
+ "getPopup": {
159
+ "minArgs": 1,
160
+ "maxArgs": 1
161
+ },
162
+ "getTitle": {
163
+ "minArgs": 1,
164
+ "maxArgs": 1
165
+ },
166
+ "openPopup": {
167
+ "minArgs": 0,
168
+ "maxArgs": 0
169
+ },
170
+ "setBadgeBackgroundColor": {
171
+ "minArgs": 1,
172
+ "maxArgs": 1,
173
+ "fallbackToNoCallback": true
174
+ },
175
+ "setBadgeText": {
176
+ "minArgs": 1,
177
+ "maxArgs": 1,
178
+ "fallbackToNoCallback": true
179
+ },
180
+ "setIcon": {
181
+ "minArgs": 1,
182
+ "maxArgs": 1
183
+ },
184
+ "setPopup": {
185
+ "minArgs": 1,
186
+ "maxArgs": 1,
187
+ "fallbackToNoCallback": true
188
+ },
189
+ "setTitle": {
190
+ "minArgs": 1,
191
+ "maxArgs": 1,
192
+ "fallbackToNoCallback": true
193
+ }
194
+ },
195
+ "browsingData": {
196
+ "remove": {
197
+ "minArgs": 2,
198
+ "maxArgs": 2
199
+ },
200
+ "removeCache": {
201
+ "minArgs": 1,
202
+ "maxArgs": 1
203
+ },
204
+ "removeCookies": {
205
+ "minArgs": 1,
206
+ "maxArgs": 1
207
+ },
208
+ "removeDownloads": {
209
+ "minArgs": 1,
210
+ "maxArgs": 1
211
+ },
212
+ "removeFormData": {
213
+ "minArgs": 1,
214
+ "maxArgs": 1
215
+ },
216
+ "removeHistory": {
217
+ "minArgs": 1,
218
+ "maxArgs": 1
219
+ },
220
+ "removeLocalStorage": {
221
+ "minArgs": 1,
222
+ "maxArgs": 1
223
+ },
224
+ "removePasswords": {
225
+ "minArgs": 1,
226
+ "maxArgs": 1
227
+ },
228
+ "removePluginData": {
229
+ "minArgs": 1,
230
+ "maxArgs": 1
231
+ },
232
+ "settings": {
233
+ "minArgs": 0,
234
+ "maxArgs": 0
235
+ }
236
+ },
237
+ "commands": {
238
+ "getAll": {
239
+ "minArgs": 0,
240
+ "maxArgs": 0
241
+ }
242
+ },
243
+ "contextMenus": {
244
+ "remove": {
245
+ "minArgs": 1,
246
+ "maxArgs": 1
247
+ },
248
+ "removeAll": {
249
+ "minArgs": 0,
250
+ "maxArgs": 0
251
+ },
252
+ "update": {
253
+ "minArgs": 2,
254
+ "maxArgs": 2
255
+ }
256
+ },
257
+ "cookies": {
258
+ "get": {
259
+ "minArgs": 1,
260
+ "maxArgs": 1
261
+ },
262
+ "getAll": {
263
+ "minArgs": 1,
264
+ "maxArgs": 1
265
+ },
266
+ "getAllCookieStores": {
267
+ "minArgs": 0,
268
+ "maxArgs": 0
269
+ },
270
+ "remove": {
271
+ "minArgs": 1,
272
+ "maxArgs": 1
273
+ },
274
+ "set": {
275
+ "minArgs": 1,
276
+ "maxArgs": 1
277
+ }
278
+ },
279
+ "devtools": {
280
+ "inspectedWindow": {
281
+ "eval": {
282
+ "minArgs": 1,
283
+ "maxArgs": 2,
284
+ "singleCallbackArg": false
285
+ }
286
+ },
287
+ "panels": {
288
+ "create": {
289
+ "minArgs": 3,
290
+ "maxArgs": 3,
291
+ "singleCallbackArg": true
292
+ },
293
+ "elements": {
294
+ "createSidebarPane": {
295
+ "minArgs": 1,
296
+ "maxArgs": 1
297
+ }
298
+ }
299
+ }
300
+ },
301
+ "downloads": {
302
+ "cancel": {
303
+ "minArgs": 1,
304
+ "maxArgs": 1
305
+ },
306
+ "download": {
307
+ "minArgs": 1,
308
+ "maxArgs": 1
309
+ },
310
+ "erase": {
311
+ "minArgs": 1,
312
+ "maxArgs": 1
313
+ },
314
+ "getFileIcon": {
315
+ "minArgs": 1,
316
+ "maxArgs": 2
317
+ },
318
+ "open": {
319
+ "minArgs": 1,
320
+ "maxArgs": 1,
321
+ "fallbackToNoCallback": true
322
+ },
323
+ "pause": {
324
+ "minArgs": 1,
325
+ "maxArgs": 1
326
+ },
327
+ "removeFile": {
328
+ "minArgs": 1,
329
+ "maxArgs": 1
330
+ },
331
+ "resume": {
332
+ "minArgs": 1,
333
+ "maxArgs": 1
334
+ },
335
+ "search": {
336
+ "minArgs": 1,
337
+ "maxArgs": 1
338
+ },
339
+ "show": {
340
+ "minArgs": 1,
341
+ "maxArgs": 1,
342
+ "fallbackToNoCallback": true
343
+ }
344
+ },
345
+ "extension": {
346
+ "isAllowedFileSchemeAccess": {
347
+ "minArgs": 0,
348
+ "maxArgs": 0
349
+ },
350
+ "isAllowedIncognitoAccess": {
351
+ "minArgs": 0,
352
+ "maxArgs": 0
353
+ }
354
+ },
355
+ "history": {
356
+ "addUrl": {
357
+ "minArgs": 1,
358
+ "maxArgs": 1
359
+ },
360
+ "deleteAll": {
361
+ "minArgs": 0,
362
+ "maxArgs": 0
363
+ },
364
+ "deleteRange": {
365
+ "minArgs": 1,
366
+ "maxArgs": 1
367
+ },
368
+ "deleteUrl": {
369
+ "minArgs": 1,
370
+ "maxArgs": 1
371
+ },
372
+ "getVisits": {
373
+ "minArgs": 1,
374
+ "maxArgs": 1
375
+ },
376
+ "search": {
377
+ "minArgs": 1,
378
+ "maxArgs": 1
379
+ }
380
+ },
381
+ "i18n": {
382
+ "detectLanguage": {
383
+ "minArgs": 1,
384
+ "maxArgs": 1
385
+ },
386
+ "getAcceptLanguages": {
387
+ "minArgs": 0,
388
+ "maxArgs": 0
389
+ }
390
+ },
391
+ "identity": {
392
+ "launchWebAuthFlow": {
393
+ "minArgs": 1,
394
+ "maxArgs": 1
395
+ }
396
+ },
397
+ "idle": {
398
+ "queryState": {
399
+ "minArgs": 1,
400
+ "maxArgs": 1
401
+ }
402
+ },
403
+ "management": {
404
+ "get": {
405
+ "minArgs": 1,
406
+ "maxArgs": 1
407
+ },
408
+ "getAll": {
409
+ "minArgs": 0,
410
+ "maxArgs": 0
411
+ },
412
+ "getSelf": {
413
+ "minArgs": 0,
414
+ "maxArgs": 0
415
+ },
416
+ "setEnabled": {
417
+ "minArgs": 2,
418
+ "maxArgs": 2
419
+ },
420
+ "uninstallSelf": {
421
+ "minArgs": 0,
422
+ "maxArgs": 1
423
+ }
424
+ },
425
+ "notifications": {
426
+ "clear": {
427
+ "minArgs": 1,
428
+ "maxArgs": 1
429
+ },
430
+ "create": {
431
+ "minArgs": 1,
432
+ "maxArgs": 2
433
+ },
434
+ "getAll": {
435
+ "minArgs": 0,
436
+ "maxArgs": 0
437
+ },
438
+ "getPermissionLevel": {
439
+ "minArgs": 0,
440
+ "maxArgs": 0
441
+ },
442
+ "update": {
443
+ "minArgs": 2,
444
+ "maxArgs": 2
445
+ }
446
+ },
447
+ "pageAction": {
448
+ "getPopup": {
449
+ "minArgs": 1,
450
+ "maxArgs": 1
451
+ },
452
+ "getTitle": {
453
+ "minArgs": 1,
454
+ "maxArgs": 1
455
+ },
456
+ "hide": {
457
+ "minArgs": 1,
458
+ "maxArgs": 1,
459
+ "fallbackToNoCallback": true
460
+ },
461
+ "setIcon": {
462
+ "minArgs": 1,
463
+ "maxArgs": 1
464
+ },
465
+ "setPopup": {
466
+ "minArgs": 1,
467
+ "maxArgs": 1,
468
+ "fallbackToNoCallback": true
469
+ },
470
+ "setTitle": {
471
+ "minArgs": 1,
472
+ "maxArgs": 1,
473
+ "fallbackToNoCallback": true
474
+ },
475
+ "show": {
476
+ "minArgs": 1,
477
+ "maxArgs": 1,
478
+ "fallbackToNoCallback": true
479
+ }
480
+ },
481
+ "permissions": {
482
+ "contains": {
483
+ "minArgs": 1,
484
+ "maxArgs": 1
485
+ },
486
+ "getAll": {
487
+ "minArgs": 0,
488
+ "maxArgs": 0
489
+ },
490
+ "remove": {
491
+ "minArgs": 1,
492
+ "maxArgs": 1
493
+ },
494
+ "request": {
495
+ "minArgs": 1,
496
+ "maxArgs": 1
497
+ }
498
+ },
499
+ "runtime": {
500
+ "getBackgroundPage": {
501
+ "minArgs": 0,
502
+ "maxArgs": 0
503
+ },
504
+ "getPlatformInfo": {
505
+ "minArgs": 0,
506
+ "maxArgs": 0
507
+ },
508
+ "openOptionsPage": {
509
+ "minArgs": 0,
510
+ "maxArgs": 0
511
+ },
512
+ "requestUpdateCheck": {
513
+ "minArgs": 0,
514
+ "maxArgs": 0
515
+ },
516
+ "sendMessage": {
517
+ "minArgs": 1,
518
+ "maxArgs": 3
519
+ },
520
+ "sendNativeMessage": {
521
+ "minArgs": 2,
522
+ "maxArgs": 2
523
+ },
524
+ "setUninstallURL": {
525
+ "minArgs": 1,
526
+ "maxArgs": 1
527
+ }
528
+ },
529
+ "sessions": {
530
+ "getDevices": {
531
+ "minArgs": 0,
532
+ "maxArgs": 1
533
+ },
534
+ "getRecentlyClosed": {
535
+ "minArgs": 0,
536
+ "maxArgs": 1
537
+ },
538
+ "restore": {
539
+ "minArgs": 0,
540
+ "maxArgs": 1
541
+ }
542
+ },
543
+ "storage": {
544
+ "local": {
545
+ "clear": {
546
+ "minArgs": 0,
547
+ "maxArgs": 0
548
+ },
549
+ "get": {
550
+ "minArgs": 0,
551
+ "maxArgs": 1
552
+ },
553
+ "getBytesInUse": {
554
+ "minArgs": 0,
555
+ "maxArgs": 1
556
+ },
557
+ "remove": {
558
+ "minArgs": 1,
559
+ "maxArgs": 1
560
+ },
561
+ "set": {
562
+ "minArgs": 1,
563
+ "maxArgs": 1
564
+ }
565
+ },
566
+ "managed": {
567
+ "get": {
568
+ "minArgs": 0,
569
+ "maxArgs": 1
570
+ },
571
+ "getBytesInUse": {
572
+ "minArgs": 0,
573
+ "maxArgs": 1
574
+ }
575
+ },
576
+ "sync": {
577
+ "clear": {
578
+ "minArgs": 0,
579
+ "maxArgs": 0
580
+ },
581
+ "get": {
582
+ "minArgs": 0,
583
+ "maxArgs": 1
584
+ },
585
+ "getBytesInUse": {
586
+ "minArgs": 0,
587
+ "maxArgs": 1
588
+ },
589
+ "remove": {
590
+ "minArgs": 1,
591
+ "maxArgs": 1
592
+ },
593
+ "set": {
594
+ "minArgs": 1,
595
+ "maxArgs": 1
596
+ }
597
+ }
598
+ },
599
+ "tabs": {
600
+ "captureVisibleTab": {
601
+ "minArgs": 0,
602
+ "maxArgs": 2
603
+ },
604
+ "create": {
605
+ "minArgs": 1,
606
+ "maxArgs": 1
607
+ },
608
+ "detectLanguage": {
609
+ "minArgs": 0,
610
+ "maxArgs": 1
611
+ },
612
+ "discard": {
613
+ "minArgs": 0,
614
+ "maxArgs": 1
615
+ },
616
+ "duplicate": {
617
+ "minArgs": 1,
618
+ "maxArgs": 1
619
+ },
620
+ "executeScript": {
621
+ "minArgs": 1,
622
+ "maxArgs": 2
623
+ },
624
+ "get": {
625
+ "minArgs": 1,
626
+ "maxArgs": 1
627
+ },
628
+ "getCurrent": {
629
+ "minArgs": 0,
630
+ "maxArgs": 0
631
+ },
632
+ "getZoom": {
633
+ "minArgs": 0,
634
+ "maxArgs": 1
635
+ },
636
+ "getZoomSettings": {
637
+ "minArgs": 0,
638
+ "maxArgs": 1
639
+ },
640
+ "goBack": {
641
+ "minArgs": 0,
642
+ "maxArgs": 1
643
+ },
644
+ "goForward": {
645
+ "minArgs": 0,
646
+ "maxArgs": 1
647
+ },
648
+ "highlight": {
649
+ "minArgs": 1,
650
+ "maxArgs": 1
651
+ },
652
+ "insertCSS": {
653
+ "minArgs": 1,
654
+ "maxArgs": 2
655
+ },
656
+ "move": {
657
+ "minArgs": 2,
658
+ "maxArgs": 2
659
+ },
660
+ "query": {
661
+ "minArgs": 1,
662
+ "maxArgs": 1
663
+ },
664
+ "reload": {
665
+ "minArgs": 0,
666
+ "maxArgs": 2
667
+ },
668
+ "remove": {
669
+ "minArgs": 1,
670
+ "maxArgs": 1
671
+ },
672
+ "removeCSS": {
673
+ "minArgs": 1,
674
+ "maxArgs": 2
675
+ },
676
+ "sendMessage": {
677
+ "minArgs": 2,
678
+ "maxArgs": 3
679
+ },
680
+ "setZoom": {
681
+ "minArgs": 1,
682
+ "maxArgs": 2
683
+ },
684
+ "setZoomSettings": {
685
+ "minArgs": 1,
686
+ "maxArgs": 2
687
+ },
688
+ "update": {
689
+ "minArgs": 1,
690
+ "maxArgs": 2
691
+ }
692
+ },
693
+ "topSites": {
694
+ "get": {
695
+ "minArgs": 0,
696
+ "maxArgs": 0
697
+ }
698
+ },
699
+ "webNavigation": {
700
+ "getAllFrames": {
701
+ "minArgs": 1,
702
+ "maxArgs": 1
703
+ },
704
+ "getFrame": {
705
+ "minArgs": 1,
706
+ "maxArgs": 1
707
+ }
708
+ },
709
+ "webRequest": {
710
+ "handlerBehaviorChanged": {
711
+ "minArgs": 0,
712
+ "maxArgs": 0
713
+ }
714
+ },
715
+ "windows": {
716
+ "create": {
717
+ "minArgs": 0,
718
+ "maxArgs": 1
719
+ },
720
+ "get": {
721
+ "minArgs": 1,
722
+ "maxArgs": 2
723
+ },
724
+ "getAll": {
725
+ "minArgs": 0,
726
+ "maxArgs": 1
727
+ },
728
+ "getCurrent": {
729
+ "minArgs": 0,
730
+ "maxArgs": 1
731
+ },
732
+ "getLastFocused": {
733
+ "minArgs": 0,
734
+ "maxArgs": 1
735
+ },
736
+ "remove": {
737
+ "minArgs": 1,
738
+ "maxArgs": 1
739
+ },
740
+ "update": {
741
+ "minArgs": 2,
742
+ "maxArgs": 2
743
+ }
744
+ }
745
+ };
746
+ if (Object.keys(apiMetadata).length === 0) {
747
+ throw new Error("api-metadata.json has not been included in browser-polyfill");
748
+ }
749
+ class DefaultWeakMap extends WeakMap {
750
+ constructor(createItem, items = void 0) {
751
+ super(items);
752
+ this.createItem = createItem;
753
+ }
754
+ get(key) {
755
+ if (!this.has(key)) {
756
+ this.set(key, this.createItem(key));
757
+ }
758
+ return super.get(key);
759
+ }
760
+ }
761
+ const isThenable = (value) => {
762
+ return value && typeof value === "object" && typeof value.then === "function";
763
+ };
764
+ const makeCallback = (promise, metadata) => {
765
+ return (...callbackArgs) => {
766
+ if (extensionAPIs.runtime.lastError) {
767
+ promise.reject(new Error(extensionAPIs.runtime.lastError.message));
768
+ } else if (metadata.singleCallbackArg || callbackArgs.length <= 1 && metadata.singleCallbackArg !== false) {
769
+ promise.resolve(callbackArgs[0]);
770
+ } else {
771
+ promise.resolve(callbackArgs);
772
+ }
773
+ };
774
+ };
775
+ const pluralizeArguments = (numArgs) => numArgs == 1 ? "argument" : "arguments";
776
+ const wrapAsyncFunction = (name, metadata) => {
777
+ return function asyncFunctionWrapper(target, ...args) {
778
+ if (args.length < metadata.minArgs) {
779
+ throw new Error(`Expected at least ${metadata.minArgs} ${pluralizeArguments(metadata.minArgs)} for ${name}(), got ${args.length}`);
780
+ }
781
+ if (args.length > metadata.maxArgs) {
782
+ throw new Error(`Expected at most ${metadata.maxArgs} ${pluralizeArguments(metadata.maxArgs)} for ${name}(), got ${args.length}`);
783
+ }
784
+ return new Promise((resolve, reject) => {
785
+ if (metadata.fallbackToNoCallback) {
786
+ try {
787
+ target[name](...args, makeCallback({
788
+ resolve,
789
+ reject
790
+ }, metadata));
791
+ } catch (cbError) {
792
+ console.warn(`${name} API method doesn't seem to support the callback parameter, falling back to call it without a callback: `, cbError);
793
+ target[name](...args);
794
+ metadata.fallbackToNoCallback = false;
795
+ metadata.noCallback = true;
796
+ resolve();
797
+ }
798
+ } else if (metadata.noCallback) {
799
+ target[name](...args);
800
+ resolve();
801
+ } else {
802
+ target[name](...args, makeCallback({
803
+ resolve,
804
+ reject
805
+ }, metadata));
806
+ }
807
+ });
808
+ };
809
+ };
810
+ const wrapMethod = (target, method, wrapper) => {
811
+ return new Proxy(method, {
812
+ apply(targetMethod, thisObj, args) {
813
+ return wrapper.call(thisObj, target, ...args);
814
+ }
815
+ });
816
+ };
817
+ let hasOwnProperty = Function.call.bind(Object.prototype.hasOwnProperty);
818
+ const wrapObject = (target, wrappers = {}, metadata = {}) => {
819
+ let cache = /* @__PURE__ */ Object.create(null);
820
+ let handlers = {
821
+ has(proxyTarget2, prop) {
822
+ return prop in target || prop in cache;
823
+ },
824
+ get(proxyTarget2, prop, receiver) {
825
+ if (prop in cache) {
826
+ return cache[prop];
827
+ }
828
+ if (!(prop in target)) {
829
+ return void 0;
830
+ }
831
+ let value = target[prop];
832
+ if (typeof value === "function") {
833
+ if (typeof wrappers[prop] === "function") {
834
+ value = wrapMethod(target, target[prop], wrappers[prop]);
835
+ } else if (hasOwnProperty(metadata, prop)) {
836
+ let wrapper = wrapAsyncFunction(prop, metadata[prop]);
837
+ value = wrapMethod(target, target[prop], wrapper);
838
+ } else {
839
+ value = value.bind(target);
840
+ }
841
+ } else if (typeof value === "object" && value !== null && (hasOwnProperty(wrappers, prop) || hasOwnProperty(metadata, prop))) {
842
+ value = wrapObject(value, wrappers[prop], metadata[prop]);
843
+ } else if (hasOwnProperty(metadata, "*")) {
844
+ value = wrapObject(value, wrappers[prop], metadata["*"]);
845
+ } else {
846
+ Object.defineProperty(cache, prop, {
847
+ configurable: true,
848
+ enumerable: true,
849
+ get() {
850
+ return target[prop];
851
+ },
852
+ set(value2) {
853
+ target[prop] = value2;
854
+ }
855
+ });
856
+ return value;
857
+ }
858
+ cache[prop] = value;
859
+ return value;
860
+ },
861
+ set(proxyTarget2, prop, value, receiver) {
862
+ if (prop in cache) {
863
+ cache[prop] = value;
864
+ } else {
865
+ target[prop] = value;
866
+ }
867
+ return true;
868
+ },
869
+ defineProperty(proxyTarget2, prop, desc) {
870
+ return Reflect.defineProperty(cache, prop, desc);
871
+ },
872
+ deleteProperty(proxyTarget2, prop) {
873
+ return Reflect.deleteProperty(cache, prop);
874
+ }
875
+ };
876
+ let proxyTarget = Object.create(target);
877
+ return new Proxy(proxyTarget, handlers);
878
+ };
879
+ const wrapEvent = (wrapperMap) => ({
880
+ addListener(target, listener, ...args) {
881
+ target.addListener(wrapperMap.get(listener), ...args);
882
+ },
883
+ hasListener(target, listener) {
884
+ return target.hasListener(wrapperMap.get(listener));
885
+ },
886
+ removeListener(target, listener) {
887
+ target.removeListener(wrapperMap.get(listener));
888
+ }
889
+ });
890
+ const onRequestFinishedWrappers = new DefaultWeakMap((listener) => {
891
+ if (typeof listener !== "function") {
892
+ return listener;
893
+ }
894
+ return function onRequestFinished(req) {
895
+ const wrappedReq = wrapObject(
896
+ req,
897
+ {},
898
+ {
899
+ getContent: {
900
+ minArgs: 0,
901
+ maxArgs: 0
902
+ }
903
+ }
904
+ );
905
+ listener(wrappedReq);
906
+ };
907
+ });
908
+ const onMessageWrappers = new DefaultWeakMap((listener) => {
909
+ if (typeof listener !== "function") {
910
+ return listener;
911
+ }
912
+ return function onMessage(message, sender, sendResponse) {
913
+ let didCallSendResponse = false;
914
+ let wrappedSendResponse;
915
+ let sendResponsePromise = new Promise((resolve) => {
916
+ wrappedSendResponse = function(response) {
917
+ didCallSendResponse = true;
918
+ resolve(response);
919
+ };
920
+ });
921
+ let result;
922
+ try {
923
+ result = listener(message, sender, wrappedSendResponse);
924
+ } catch (err) {
925
+ result = Promise.reject(err);
926
+ }
927
+ const isResultThenable = result !== true && isThenable(result);
928
+ if (result !== true && !isResultThenable && !didCallSendResponse) {
929
+ return false;
930
+ }
931
+ const sendPromisedResult = (promise) => {
932
+ promise.then((msg) => {
933
+ sendResponse(msg);
934
+ }, (error) => {
935
+ let message2;
936
+ if (error && (error instanceof Error || typeof error.message === "string")) {
937
+ message2 = error.message;
938
+ } else {
939
+ message2 = "An unexpected error occurred";
940
+ }
941
+ sendResponse({
942
+ __mozWebExtensionPolyfillReject__: true,
943
+ message: message2
944
+ });
945
+ }).catch((err) => {
946
+ console.error("Failed to send onMessage rejected reply", err);
947
+ });
948
+ };
949
+ if (isResultThenable) {
950
+ sendPromisedResult(result);
951
+ } else {
952
+ sendPromisedResult(sendResponsePromise);
953
+ }
954
+ return true;
955
+ };
956
+ });
957
+ const wrappedSendMessageCallback = ({
958
+ reject,
959
+ resolve
960
+ }, reply) => {
961
+ if (extensionAPIs.runtime.lastError) {
962
+ if (extensionAPIs.runtime.lastError.message === CHROME_SEND_MESSAGE_CALLBACK_NO_RESPONSE_MESSAGE) {
963
+ resolve();
964
+ } else {
965
+ reject(new Error(extensionAPIs.runtime.lastError.message));
966
+ }
967
+ } else if (reply && reply.__mozWebExtensionPolyfillReject__) {
968
+ reject(new Error(reply.message));
969
+ } else {
970
+ resolve(reply);
971
+ }
972
+ };
973
+ const wrappedSendMessage = (name, metadata, apiNamespaceObj, ...args) => {
974
+ if (args.length < metadata.minArgs) {
975
+ throw new Error(`Expected at least ${metadata.minArgs} ${pluralizeArguments(metadata.minArgs)} for ${name}(), got ${args.length}`);
976
+ }
977
+ if (args.length > metadata.maxArgs) {
978
+ throw new Error(`Expected at most ${metadata.maxArgs} ${pluralizeArguments(metadata.maxArgs)} for ${name}(), got ${args.length}`);
979
+ }
980
+ return new Promise((resolve, reject) => {
981
+ const wrappedCb = wrappedSendMessageCallback.bind(null, {
982
+ resolve,
983
+ reject
984
+ });
985
+ args.push(wrappedCb);
986
+ apiNamespaceObj.sendMessage(...args);
987
+ });
988
+ };
989
+ const staticWrappers = {
990
+ devtools: {
991
+ network: {
992
+ onRequestFinished: wrapEvent(onRequestFinishedWrappers)
993
+ }
994
+ },
995
+ runtime: {
996
+ onMessage: wrapEvent(onMessageWrappers),
997
+ onMessageExternal: wrapEvent(onMessageWrappers),
998
+ sendMessage: wrappedSendMessage.bind(null, "sendMessage", {
999
+ minArgs: 1,
1000
+ maxArgs: 3
1001
+ })
1002
+ },
1003
+ tabs: {
1004
+ sendMessage: wrappedSendMessage.bind(null, "sendMessage", {
1005
+ minArgs: 2,
1006
+ maxArgs: 3
1007
+ })
1008
+ }
1009
+ };
1010
+ const settingMetadata = {
1011
+ clear: {
1012
+ minArgs: 1,
1013
+ maxArgs: 1
1014
+ },
1015
+ get: {
1016
+ minArgs: 1,
1017
+ maxArgs: 1
1018
+ },
1019
+ set: {
1020
+ minArgs: 1,
1021
+ maxArgs: 1
1022
+ }
1023
+ };
1024
+ apiMetadata.privacy = {
1025
+ network: {
1026
+ "*": settingMetadata
1027
+ },
1028
+ services: {
1029
+ "*": settingMetadata
1030
+ },
1031
+ websites: {
1032
+ "*": settingMetadata
1033
+ }
1034
+ };
1035
+ return wrapObject(extensionAPIs, staticWrappers, apiMetadata);
1036
+ };
1037
+ module2.exports = wrapAPIs(chrome);
1038
+ } else {
1039
+ module2.exports = globalThis.browser;
1040
+ }
1041
+ });
1042
+ }
1043
+ });
1044
+
1045
+ // src/index.ts
1046
+ var src_exports = {};
1047
+ __export(src_exports, {
1048
+ defineExtensionMessaging: () => defineExtensionMessaging
1049
+ });
1050
+ var import_webextension_polyfill = __toESM(require_browser_polyfill(), 1);
1051
+ function defineExtensionMessaging(config) {
1052
+ let rootListener;
1053
+ let keyListeners = {};
1054
+ let idSeq = Math.floor(Math.random() * 1e4);
1055
+ function getNextId() {
1056
+ return idSeq++;
1057
+ }
1058
+ function onMessage(key, onReceived) {
1059
+ var _a, _b, _c;
1060
+ if (rootListener == null) {
1061
+ (_a = config == null ? void 0 : config.logger) == null ? void 0 : _a.debug(
1062
+ `[messaging] ${key} initialized message listener for this context`
1063
+ );
1064
+ rootListener = (message, sender) => {
1065
+ var _a2, _b2, _c2;
1066
+ if (typeof message.key != "string" || typeof message.timestamp !== "number") {
1067
+ const err = Error(
1068
+ `[messaging] Unknown message format, must include the 'key' & 'timestamp' fields, received: ${JSON.stringify(
1069
+ message
1070
+ )}`
1071
+ );
1072
+ (_a2 = config == null ? void 0 : config.logger) == null ? void 0 : _a2.error(err);
1073
+ throw err;
1074
+ }
1075
+ (_b2 = config == null ? void 0 : config.logger) == null ? void 0 : _b2.debug("[messaging] Received message", message, sender);
1076
+ const entries = Object.entries(keyListeners);
1077
+ for (const [key2, listener] of entries) {
1078
+ if (message.key !== key2)
1079
+ continue;
1080
+ (_c2 = config == null ? void 0 : config.logger) == null ? void 0 : _c2.debug(`[messaging] onMessage {id=${message.id}} \u140A\u2500`, message);
1081
+ const res = listener({
1082
+ data: message.data,
1083
+ sender,
1084
+ timestamp: message.timestamp
1085
+ });
1086
+ return Promise.resolve(res).then((res2) => {
1087
+ var _a3;
1088
+ (_a3 = config == null ? void 0 : config.logger) == null ? void 0 : _a3.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { res: res2 });
1089
+ return { res: res2 };
1090
+ }).catch((err) => {
1091
+ var _a3;
1092
+ let errMessage;
1093
+ if (err instanceof Error)
1094
+ errMessage = err.message;
1095
+ else
1096
+ errMessage = String(err);
1097
+ (_a3 = config == null ? void 0 : config.logger) == null ? void 0 : _a3.debug(`[messaging] onMessage {id=${message.id}} \u2500\u1405`, { err });
1098
+ return { err: errMessage };
1099
+ });
1100
+ }
1101
+ return Promise.resolve({
1102
+ err: `Listener not found for message.type="${message.key}".
1103
+
1104
+ Did you forget to call \`onMessage("getLength", ...)\`?`
1105
+ });
1106
+ };
1107
+ import_webextension_polyfill.default.runtime.onMessage.addListener(rootListener);
1108
+ }
1109
+ if (keyListeners[key] != null) {
1110
+ const err = Error(
1111
+ `[messaging] In this JS context, only one listener can be setup for ${key}`
1112
+ );
1113
+ (_b = config == null ? void 0 : config.logger) == null ? void 0 : _b.error(err);
1114
+ throw err;
1115
+ }
1116
+ keyListeners[key] = onReceived;
1117
+ (_c = config == null ? void 0 : config.logger) == null ? void 0 : _c.log(`[messaging] Added listener for ${key}`);
1118
+ return function removeListener() {
1119
+ delete keyListeners[key];
1120
+ if (Object.entries(keyListeners).length === 0) {
1121
+ import_webextension_polyfill.default.runtime.onMessage.removeListener(rootListener);
1122
+ rootListener = void 0;
1123
+ }
1124
+ };
1125
+ }
1126
+ function sendMessage(key, data, tabId) {
1127
+ return __async(this, null, function* () {
1128
+ var _a, _b;
1129
+ const message = { id: getNextId(), key, data, timestamp: Date.now() };
1130
+ (_a = config == null ? void 0 : config.logger) == null ? void 0 : _a.debug(`[messaging] sendMessage {id=${message.id}} \u2500\u1405`, message);
1131
+ let response;
1132
+ if (tabId == null)
1133
+ response = yield import_webextension_polyfill.default.runtime.sendMessage(message);
1134
+ else
1135
+ response = yield import_webextension_polyfill.default.tabs.sendMessage(tabId, message);
1136
+ const { res, err } = response != null ? response : { err: "No response" };
1137
+ (_b = config == null ? void 0 : config.logger) == null ? void 0 : _b.debug(`[messaging] sendMessage {id=${message.id}} \u140A\u2500`, { res, err });
1138
+ if (err != null)
1139
+ throw Error(err);
1140
+ return res;
1141
+ });
1142
+ }
1143
+ return { onMessage, sendMessage };
1144
+ }
1145
+ return __toCommonJS(src_exports);
1146
+ })();
package/lib/index.js CHANGED
@@ -46,8 +46,8 @@ function defineExtensionMessaging(config) {
46
46
  throw err;
47
47
  }
48
48
  (_b2 = config == null ? void 0 : config.logger) == null ? void 0 : _b2.debug("[messaging] Received message", message, sender);
49
- const entires = Object.entries(keyListeners);
50
- for (const [key2, listener] of entires) {
49
+ const entries = Object.entries(keyListeners);
50
+ for (const [key2, listener] of entries) {
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);
@@ -71,6 +71,11 @@ function defineExtensionMessaging(config) {
71
71
  return { err: errMessage };
72
72
  });
73
73
  }
74
+ return Promise.resolve({
75
+ err: `Listener not found for message.type="${message.key}".
76
+
77
+ Did you forget to call \`onMessage("getLength", ...)\`?`
78
+ });
74
79
  };
75
80
  Browser.runtime.onMessage.addListener(rootListener);
76
81
  }
@@ -83,6 +88,13 @@ function defineExtensionMessaging(config) {
83
88
  }
84
89
  keyListeners[key] = onReceived;
85
90
  (_c = config == null ? void 0 : config.logger) == null ? void 0 : _c.log(`[messaging] Added listener for ${key}`);
91
+ 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
+ }
97
+ };
86
98
  }
87
99
  function sendMessage(key, data, tabId) {
88
100
  return __async(this, null, function* () {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@webext-core/messaging",
3
- "version": "1.0.3",
3
+ "version": "1.1.1",
4
4
  "description": "Light weight, type-safe wrapper around the extension messaging APIs",
5
5
  "license": "MIT",
6
6
  "keywords": [
@@ -48,11 +48,12 @@
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.1",
51
+ "@webext-core/fake-browser": "1.0.3",
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
+ "build:dependencies": "cd ../.. && turbo run build --filter=@webext-core/messaging^...",
56
57
  "test": "vitest -r src",
57
58
  "test:coverage": "vitest run -r src --coverage",
58
59
  "compile": "tsc --noEmit"