webext-messenger 0.17.0-0 → 0.18.0

package/distribution/receiver.js

@@ -1,4 +1,3 @@
-import browser from "webextension-polyfill";
 import { serializeError } from "serialize-error";
 import { messenger } from "./sender.js";
 import { handlers, isObject, MessengerError, debug, __webextMessenger, } from "./shared.js";
@@ -32,18 +31,21 @@ action) {
     const { trace = [] } = options;
     trace.push(sender);
     const meta = { trace };
-    debug(type, "↘️ received", { sender, args, wasForwarded: trace.length > 1 });
     let handleMessage;
     if (action === "forward") {
         debug(type, "🔀 forwarded", { sender, target });
         handleMessage = async () => messenger(type, meta, target, ...args);
     }
     else {
+        debug(type, "↘️ received in", getContextName(), {
+            sender,
+            args,
+            wasForwarded: trace.length > 1,
+        });
         const localHandler = handlers.get(type);
         if (!localHandler) {
             throw new MessengerError(`No handler registered for ${type} in ${getContextName()}`);
         }
-        debug(type, "➡️ will be handled here,", getContextName());
         handleMessage = async () => localHandler.apply(meta, args);
     }
     const response = await handleMessage().then((value) => ({ value }), (error) => ({
@@ -62,7 +64,7 @@ export function registerMethods(methods) {
         if (handlers.has(type)) {
             throw new MessengerError(`Handler already set for ${type}`);
         }
-        console.debug("Messenger: Registered", type);
+        debug("Registered", type);
         handlers.set(type, method);
     }
     browser.runtime.onMessage.addListener(onMessageListener);

package/distribution/sender.js

@@ -1,4 +1,3 @@
-import browser from "webextension-polyfill";
 import pRetry from "p-retry";
 import { isBackground } from "webext-detect-page";
 import { deserializeError } from "serialize-error";

package/distribution/shared.js

@@ -1,3 +1,15 @@
+const logging = (() => {
+    try {
+        // @ts-expect-error it would break Webpack
+        return process.env.WEBEXT_MESSENGER_LOGGING === "true";
+    }
+    catch {
+        return false;
+    }
+})();
+function noop() {
+    /* */
+}
 export const __webextMessenger = true;
 export function isObject(value) {
     return typeof value === "object" && value !== null;
@@ -15,12 +27,11 @@ export class MessengerError extends Error {
 }
 export const handlers = new Map();
 // .bind preserves the call location in the console
-export const debug = console.debug.bind(console, "Messenger:");
-export const warn = console.warn.bind(console, "Messenger:");
+export const debug = logging ? console.debug.bind(console, "Messenger:") : noop;
+export const warn = logging ? console.warn.bind(console, "Messenger:") : noop;
 export function isErrorObject(error) {
-    var _a;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any -- This is a type guard function and it uses ?.
-    return typeof ((_a = error) === null || _a === void 0 ? void 0 : _a.message) === "string";
+    return typeof (error === null || error === void 0 ? void 0 : error.message) === "string";
 }
 export async function delay(milliseconds) {
     return new Promise((resolve) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webext-messenger",
-  "version": "0.17.0-0",
+  "version": "0.18.0",
   "description": "Browser Extension component messaging framework",
   "keywords": [],
   "repository": "pixiebrix/webext-messenger",
@@ -8,17 +8,9 @@
   "author": "Federico Brigante for PixieBrix <federico@pixiebrix.com> (https://www.pixiebrix.com)",
   "type": "module",
   "main": "distribution/index.js",
-  "alias": {
-    "./this-stuff-is-just-for-local-parcel-tests": "./package.json",
-    "./source/sender.js": "./source/sender.ts",
-    "./source/receiver.js": "./source/receiver.ts",
-    "./source/types.js": "./source/types.ts",
-    "./source/shared.js": "./source/shared.ts",
-    "./source/thisTarget.js": "./source/thisTarget.ts"
-  },
   "scripts": {
     "build": "tsc",
-    "demo:watch": "parcel watch --no-cache --no-hmr",
+    "demo:watch": "WEBEXT_MESSENGER_LOGGING=true parcel watch --no-cache --no-hmr",
     "demo:build": "parcel build --no-cache",
     "prepack": "tsc --sourceMap false",
     "test": "eslint . && tsc --noEmit",
@@ -89,8 +81,8 @@
           "*.test.ts"
         ],
         "rules": {
-          "@typescript-eslint/no-non-null-assertion": "off",
           "@typescript-eslint/no-explicit-any": "off",
+          "@typescript-eslint/no-non-null-assertion": "off",
           "@typescript-eslint/no-unsafe-member-access": "off"
         }
       },
@@ -105,31 +97,44 @@
     ]
   },
   "dependencies": {
-    "p-retry": "^5.0.0",
-    "serialize-error": "^9.0.0",
-    "type-fest": "^2.8.0",
-    "webext-detect-page": "^4.0.0",
-    "webextension-polyfill": "^0.8.0"
+    "p-retry": "^5.1.0",
+    "serialize-error": "^9.1.1",
+    "type-fest": "^2.12.1",
+    "webext-detect-page": "^4.0.1"
   },
   "devDependencies": {
-    "@parcel/config-webextension": "^2.0.1",
+    "@parcel/config-webextension": "^2.4.0",
     "@sindresorhus/tsconfig": "^2.0.0",
-    "@types/chrome": "^0.0.171",
+    "@types/chrome": "^0.0.180",
     "@types/tape": "^4.13.2",
-    "@types/webextension-polyfill": "^0.8.2",
-    "@typescript-eslint/eslint-plugin": "^5.7.0",
-    "@typescript-eslint/parser": "^5.7.0",
-    "eslint": "^8.4.1",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-config-xo": "^0.39.0",
-    "eslint-config-xo-typescript": "^0.47.1",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-unicorn": "^39.0.0",
+    "@types/webextension-polyfill": "^0.8.3",
+    "@typescript-eslint/eslint-plugin": "^5.17.0",
+    "@typescript-eslint/parser": "^5.17.0",
+    "buffer": "^6.0.3",
+    "eslint": "^8.12.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-xo": "^0.40.0",
+    "eslint-config-xo-typescript": "^0.50.0",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-unicorn": "^41.0.1",
+    "events": "^3.3.0",
     "npm-run-all": "^4.1.5",
-    "parcel": "^2.0.1",
-    "tape": "^5.3.2",
-    "typescript": "^4.5.4",
-    "webext-content-scripts": "^0.12.0"
+    "parcel": "^2.4.0",
+    "path-browserify": "^1.0.1",
+    "process": "^0.11.10",
+    "stream-browserify": "^3.0.0",
+    "tape": "^5.5.2",
+    "typescript": "^4.6.3",
+    "webext-content-scripts": "^1.0.1",
+    "webextension-polyfill": "^0.9.0"
+  },
+  "alias": {
+    "./this-stuff-is-just-for-local-parcel-tests": "./package.json",
+    "./source/sender.js": "./source/sender.ts",
+    "./source/receiver.js": "./source/receiver.ts",
+    "./source/types.js": "./source/types.ts",
+    "./source/shared.js": "./source/shared.ts",
+    "./source/thisTarget.js": "./source/thisTarget.ts"
   },
   "targets": {
     "main": false,