webext-messenger 0.27.0 → 0.28.1

package/distribution/receiver.js

@@ -1,5 +1,5 @@
 import { serializeError } from "serialize-error";
-import { getContextName } from "webext-detect-page";
+import { getContextName } from "webext-detect";
 import { messenger } from "./sender.js";
 import { isObject, MessengerError, __webextMessenger } from "./shared.js";
 import { log } from "./logging.js";

package/distribution/sender.js

@@ -1,5 +1,5 @@
 import pRetry from "p-retry";
-import { isBackground } from "webext-detect-page";
+import { isBackground } from "webext-detect";
 import { deserializeError } from "serialize-error";
 import { isObject, MessengerError, __webextMessenger } from "./shared.js";
 import { log } from "./logging.js";
@@ -113,7 +113,10 @@ async function manageMessage(type, target, seq, retry, sendMessage) {
             log.debug(type, seq, "will retry. Attempt", error.attemptNumber);
         },
     }).catch((error) => {
-        if (error?.message === _errorNonExistingTarget) {
+        if (error &&
+            typeof error === "object" &&
+            "message" in error &&
+            error?.message === _errorNonExistingTarget) {
             throw new MessengerError(`The target ${JSON.stringify(target)} for ${type} was not found`);
         }
         events.dispatchEvent(new CustomEvent("attempts-exhausted", {

package/distribution/targetLogic.js

@@ -1,4 +1,4 @@
-import { isBackground, isContentScript } from "webext-detect-page";
+import { isBackground, isContentScript } from "webext-detect";
 export function compareTargets(to, thisTarget) {
     for (const [key, value] of Object.entries(to)) {
         if (thisTarget[key] === value) {

package/distribution/targetLogic.test.js

@@ -1,7 +1,7 @@
 import { assert, describe, test, vi } from "vitest";
 import { getActionForMessage } from "./targetLogic.js";
-import { isContentScript, isBackground } from "webext-detect-page";
-vi.mock("webext-detect-page");
+import { isContentScript, isBackground } from "webext-detect";
+vi.mock("webext-detect");
 const tab = {
     id: 1,
     url: "http://example.com",

package/distribution/thisTarget.js

@@ -1,7 +1,8 @@
-import { getContextName, isBackground, isExtensionContext, } from "webext-detect-page";
+import { getContextName, isBackground, isExtensionContext, isOffscreenDocument, } from "webext-detect";
 import { messenger } from "./sender.js";
 import { registerMethods } from "./receiver.js";
 import { MessengerError, once } from "./shared.js";
+import { pEvent } from "p-event";
 /**
  * @file This file exists because `runtime.sendMessage` acts as a broadcast to
  * all open extension pages, so the receiver needs a way to figure out if the
@@ -25,9 +26,12 @@ import { MessengerError, once } from "./shared.js";
 // Soft warning: Race conditions are possible.
 // This CANNOT be awaited because waiting for it means "I will handle the message."
 // If a message is received before this is ready, it will just have to be ignored.
-export const thisTarget = isBackground()
-    ? { page: "background" }
-    : {
+export const thisTarget = (() => {
+    if (isBackground())
+        return { page: "background" };
+    if (isOffscreenDocument())
+        return { page: "offscreen" };
+    return {
         get page() {
             // Extension pages have relative URLs to simplify comparison
             const origin = location.protocol.startsWith("http")
@@ -37,9 +41,10 @@ export const thisTarget = isBackground()
             return origin + location.pathname + location.search;
         },
     };
+})();
 let tabDataStatus = 
-// The background page doesn't have a tab
-isBackground() ? "not-needed" : "needed";
+// Exclude contexts that don't have a tab associated to them
+isBackground() || isOffscreenDocument() ? "not-needed" : "needed";
 export function getTabDataStatus() {
     return tabDataStatus;
 }
@@ -47,6 +52,11 @@ const storeTabData = once(async () => {
     if (tabDataStatus !== "needed") {
         return;
     }
+    // If the page is prerendering, wait for the change to be able to get the tab data so the frameId is correct
+    // https://developer.mozilla.org/en-US/docs/Web/API/Document/prerenderingchange_event
+    if ("prerendering" in document && Boolean(document.prerendering)) {
+        await pEvent(document, "prerenderingchange");
+    }
     try {
         tabDataStatus = "pending";
         Object.assign(thisTarget, await messenger("__getTabData", {}, { page: "any" }));
@@ -67,8 +77,7 @@ export async function getThisFrame() {
     if (typeof tabId !== "number" || typeof frameId !== "number") {
         let moreInfo = "(error retrieving context information)";
         try {
-            moreInfo = `(context: ${getContextName()}, url: ${globalThis.location
-                ?.href})`;
+            moreInfo = `(context: ${getContextName()}, url: ${globalThis.location?.href})`;
         }
         catch { }
         throw new TypeError(`This target is not in a frame ${moreInfo}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webext-messenger",
-  "version": "0.27.0",
+  "version": "0.28.1",
   "description": "Browser Extension component messaging framework",
   "keywords": [],
   "repository": "pixiebrix/webext-messenger",
@@ -26,34 +26,36 @@
     "watch": "tsc --watch"
   },
   "dependencies": {
-    "p-retry": "^6.2.0",
+    "p-event": "^6.0.1",
+    "p-retry": "^6.2.1",
     "serialize-error": "^11.0.3",
-    "type-fest": "^4.13.0",
-    "webext-detect-page": "^5.0.1"
+    "type-fest": "^4.29.1",
+    "webext-detect": "^5.3.1",
+    "webext-events": "^3.1.1"
   },
   "@parcel/resolver-default": {
     "packageExports": true
   },
   "devDependencies": {
     "@parcel/config-webextension": "^2.11.0",
-    "@sindresorhus/tsconfig": "^5.0.0",
-    "@types/chrome": "^0.0.263",
-    "@types/tape": "^5.6.4",
-    "@types/webextension-polyfill": "^0.10.7",
+    "@sindresorhus/tsconfig": "^7.0.0",
+    "@types/chrome": "^0.0.287",
+    "@types/tape": "^5.6.5",
+    "@types/webextension-polyfill": "^0.12.1",
     "buffer": "^6.0.3",
     "eslint": "^8.57.0",
-    "eslint-config-pixiebrix": "^0.37.2",
+    "eslint-config-pixiebrix": "^0.41.1",
     "events": "^3.3.0",
     "npm-run-all": "^4.1.5",
     "parcel": "^2.11.0",
     "path-browserify": "^1.0.1",
     "process": "^0.11.10",
     "stream-browserify": "^3.0.0",
-    "tape": "^5.7.5",
-    "typescript": "^5.4.2",
-    "vitest": "^1.4.0",
-    "webext-content-scripts": "^2.6.1",
-    "webextension-polyfill": "^0.10.0"
+    "tape": "^5.9.0",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.6",
+    "webext-content-scripts": "^2.7.0",
+    "webextension-polyfill": "^0.12.0"
   },
   "targets": {
     "main": false,
@@ -72,7 +74,8 @@
     "run": {
       "startUrl": [
         "https://fregante.github.io/pixiebrix-testing-ground/Will-call-background-methods",
-        "https://fregante.github.io/pixiebrix-testing-ground/Will-call-other-CS-via-background"
+        "https://fregante.github.io/pixiebrix-testing-ground/Will-call-other-CS-via-background",
+        "https://fregante.github.io/pixiebrix-testing-ground/Will-call-offscreen-methods"
       ]
     }
   }

package/readme.md

@@ -17,8 +17,7 @@ import messenger from "webext-messenger";
 
 ## Context
 
-- [Initial considertions for this library](https://github.com/pixiebrix/webext-messenger/issues/1)
-
+- [Initial considerations for this library](https://github.com/pixiebrix/webext-messenger/issues/1)
 
 ## npm publishing