webext-messenger 0.15.0-0 → 0.15.0-1

package/distribution/index.js

@@ -1,5 +1,10 @@
+// Imports must use the .js extension because of ESM requires it and TS refuses to rewrite .ts to .js
+// This works in TS even if the .js doesn't exist, but it breaks Parcel (the tests builder)
+// For this reason, there's an `alias` field in package.json to redirect these imports.
+// If you see "@parcel/resolver-default: Cannot load file './yourNewFile.js'" you need to add it to the `alias` list
+// 🥲
 export * from "./receiver.js";
 export * from "./sender.js";
 export * from "./types.js";
-import { initPrivateApi } from "./thisTarget";
+import { initPrivateApi } from "./thisTarget.js";
 initPrivateApi();

package/distribution/receiver.js

@@ -3,7 +3,7 @@ import { serializeError } from "serialize-error";
 import { messenger } from "./sender.js";
 import { handlers, isObject, MessengerError, debug, __webextMessenger, } from "./shared.js";
 import { getContextName } from "webext-detect-page";
-import { getActionForMessage, nameThisTarget } from "./thisTarget";
+import { getActionForMessage, nameThisTarget } from "./thisTarget.js";
 export function isMessengerMessage(message) {
     return (isObject(message) &&
         typeof message["type"] === "string" &&

package/distribution/thisTarget.js

@@ -1,5 +1,5 @@
 import { isBackgroundPage, isContentScript } from "webext-detect-page";
-import { messenger } from "./index";
+import { messenger } from "./sender.js";
 import { registerMethods } from "./receiver.js";
 import { debug } from "./shared.js";
 // Soft warning: Race conditions are possible.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webext-messenger",
-  "version": "0.15.0-0",
+  "version": "0.15.0-1",
   "description": "Browser Extension component messaging framework",
   "keywords": [],
   "repository": "pixiebrix/webext-messenger",
@@ -13,7 +13,8 @@
     "./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/shared.js": "./source/shared.ts",
+    "./source/thisTarget.js": "./source/thisTarget.ts"
   },
   "scripts": {
     "build": "tsc",
@@ -45,6 +46,21 @@
       "plugin:unicorn/recommended"
     ],
     "rules": {
+      "no-restricted-imports": [
+        "error",
+        {
+          "paths": [
+            {
+              "name": "./index",
+              "message": "The index file is only used to re-export internal files. Use direct imports instead."
+            }
+          ]
+        }
+      ],
+      "import/extensions": [
+        "error",
+        "always"
+      ],
       "import/no-unresolved": "off",
       "unicorn/filename-case": [
         "error",
@@ -77,35 +93,43 @@
           "@typescript-eslint/no-explicit-any": "off",
           "@typescript-eslint/no-unsafe-member-access": "off"
         }
+      },
+      {
+        "files": [
+          "source/test/**/*"
+        ],
+        "rules": {
+          "import/extensions": "off"
+        }
       }
     ]
   },
   "dependencies": {
-    "p-retry": "^4.6.1",
-    "serialize-error": "^8.1.0",
-    "type-fest": "^2.5.1",
+    "p-retry": "^5.0.0",
+    "serialize-error": "^9.0.0",
+    "type-fest": "^2.6.0",
     "webext-detect-page": "^3.1.0",
     "webextension-polyfill": "^0.8.0"
   },
   "devDependencies": {
-    "@parcel/config-webextension": "^2.0.0",
+    "@parcel/config-webextension": "^2.0.1",
     "@sindresorhus/tsconfig": "^2.0.0",
-    "@types/chrome": "^0.0.159",
-    "@types/webextension-polyfill": "^0.8.0",
-    "@typescript-eslint/eslint-plugin": "^5.1.0",
-    "@typescript-eslint/parser": "^5.1.0",
-    "eslint": "^8.1.0",
+    "@types/chrome": "^0.0.164",
+    "@types/tape": "^4.13.2",
+    "@types/webextension-polyfill": "^0.8.2",
+    "@typescript-eslint/eslint-plugin": "^5.4.0",
+    "@typescript-eslint/parser": "^5.4.0",
+    "eslint": "^8.3.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-config-xo": "^0.39.0",
-    "eslint-config-xo-typescript": "^0.45.2",
-    "eslint-plugin-import": "^2.25.2",
-    "eslint-plugin-unicorn": "^37.0.1",
-    "fresh-tape": "^5.3.1",
+    "eslint-config-xo-typescript": "^0.47.1",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-unicorn": "^39.0.0",
     "npm-run-all": "^4.1.5",
-    "parcel": "^2.0.0",
-    "typescript": "^4.4.4",
-    "webext-content-scripts": "^0.10.1",
-    "xo": "^0.45.0"
+    "parcel": "^2.0.1",
+    "tape": "^5.3.2",
+    "typescript": "^4.5.2",
+    "webext-content-scripts": "^0.10.1"
   },
   "targets": {
     "main": false,

package/distribution/api.d.ts

@@ -1,10 +0,0 @@
-import { Target, MessengerMeta } from "./types";
-declare function __getTabData(this: MessengerMeta): Target;
-declare global {
-    interface MessengerMethods {
-        __getTabData: typeof __getTabData;
-    }
-}
-export declare const getTabData: () => Promise<Target>;
-export declare function initPrivateApi(): void;
-export {};

package/distribution/api.js

@@ -1,13 +0,0 @@
-import { getMethod } from "./sender";
-import { registerMethods } from "./receiver";
-import { isBackgroundPage } from "webext-detect-page";
-function __getTabData() {
-    return { tabId: this.trace[0].tab.id, frameId: this.trace[0].frameId };
-}
-// First page to respond wins. Any context has this piece of information.
-export const getTabData = getMethod("__getTabData", { page: "any" });
-export function initPrivateApi() {
-    if (isBackgroundPage()) {
-        registerMethods({ __getTabData });
-    }
-}

package/distribution/namedTargets.d.ts

@@ -1,14 +0,0 @@
-/// <reference types="firefox-webext-browser" />
-import { NamedTarget, Target, MessengerMeta } from "./types.js";
-declare global {
-    interface MessengerMethods {
-        __webextMessengerTargetRegistration: typeof _registerTarget;
-    }
-}
-export declare function resolveNamedTarget(target: NamedTarget, sender?: browser.runtime.MessageSender): Target;
-export declare const targets: Map<string, Target>;
-/** Register the current context so that it can be targeted with a name */
-export declare const registerTarget: (name: string) => Promise<void>;
-declare function _registerTarget(this: MessengerMeta, name: string): Promise<void>;
-export declare function initTargets(): void;
-export {};

package/distribution/namedTargets.js

@@ -1,40 +0,0 @@
-import { isBackgroundPage } from "webext-detect-page";
-import { errorNonExistingTarget, getMethod } from "./sender.js";
-import { registerMethods } from "./receiver.js";
-export function resolveNamedTarget(target, sender) {
-    var _a;
-    if (!isBackgroundPage()) {
-        throw new Error("Named targets can only be resolved in the background page");
-    }
-    const { name, tabId = (_a = sender === null || sender === void 0 ? void 0 : sender.tab) === null || _a === void 0 ? void 0 : _a.id, // If not specified, try to use the sender’s
-     } = target;
-    if (typeof tabId === "undefined") {
-        throw new TypeError(`${errorNonExistingTarget} The tab ID was not specified nor it was automatically determinable.`);
-    }
-    const resolvedTarget = targets.get(`${tabId}%${name}`);
-    if (!resolvedTarget) {
-        throw new Error(`${errorNonExistingTarget} Target named ${name} not registered for tab ${tabId}.`);
-    }
-    return resolvedTarget;
-}
-// TODO: Remove targets after tab closes to avoid "memory leaks"
-export const targets = new Map();
-/** Register the current context so that it can be targeted with a name */
-export const registerTarget = getMethod("__webextMessengerTargetRegistration");
-async function _registerTarget(name) {
-    const sender = this.trace[0];
-    const tabId = sender.tab.id;
-    const { frameId } = sender;
-    targets.set(`${tabId}%${name}`, {
-        tabId,
-        frameId,
-    });
-    console.debug(`Messenger: Target "${name}" registered for tab ${tabId}`);
-}
-export function initTargets() {
-    if (isBackgroundPage()) {
-        registerMethods({
-            __webextMessengerTargetRegistration: _registerTarget,
-        });
-    }
-}