webext-messenger 0.21.0 → 0.22.0-2

package/distribution/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./receiver.js";
 export * from "./sender.js";
 export * from "./types.js";
+export { getThisTarget } from "./thisTarget.js";

package/distribution/index.js

@@ -2,5 +2,6 @@
 export * from "./receiver.js";
 export * from "./sender.js";
 export * from "./types.js";
+export { getThisTarget } from "./thisTarget.js";
 import { initPrivateApi } from "./thisTarget.js";
 initPrivateApi();

package/distribution/shared.d.ts

@@ -14,4 +14,5 @@ export declare const debug: (...args: any[]) => void;
 export declare const warn: (...args: any[]) => void;
 export declare function isErrorObject(error: unknown): error is ErrorObject;
 export declare function delay(milliseconds: number): Promise<void>;
+export declare function once<Callback extends (...arguments_: unknown[]) => unknown>(function_: Callback): Callback;
 export {};

package/distribution/shared.js

@@ -40,3 +40,14 @@ export async function delay(milliseconds) {
         setTimeout(resolve, milliseconds);
     });
 }
+export function once(function_) {
+    let called = false;
+    let returnValue;
+    return function (...arguments_) {
+        if (called) {
+            returnValue = function_.apply(this, arguments_);
+            called = true;
+        }
+        return returnValue;
+    };
+}

package/distribution/thisTarget.d.ts

@@ -1,4 +1,5 @@
 import { AnyTarget, Message, MessengerMeta, Sender } from "./types.js";
 export declare function getActionForMessage(from: Sender, message: Message): "respond" | "forward" | "ignore";
 export declare function __getTabData(this: MessengerMeta): AnyTarget;
+export declare function getThisTarget(): Promise<AnyTarget>;
 export declare function initPrivateApi(): void;

package/distribution/thisTarget.js

@@ -1,7 +1,7 @@
 import { isBackground, isContentScript, isExtensionContext, } from "webext-detect-page";
 import { messenger } from "./sender.js";
 import { registerMethods } from "./receiver.js";
-import { debug, MessengerError } from "./shared.js";
+import { debug, MessengerError, once } from "./shared.js";
 /**
  * @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
@@ -91,7 +91,7 @@ export function getActionForMessage(from, message) {
     }
     return isThisTarget ? "respond" : "ignore";
 }
-async function storeTabData() {
+const storeTabData = once(async () => {
     if (tabDataStatus !== "needed") {
         return;
     }
@@ -108,13 +108,17 @@ async function storeTabData() {
         // @ts-expect-error TODO: update lib to accept Error#cause
         { cause: error });
     }
-}
+});
 export function __getTabData() {
     return { tabId: this.trace[0]?.tab?.id, frameId: this.trace[0]?.frameId };
 }
+export async function getThisTarget() {
+    await storeTabData(); // It should already have been called by we still need to await it
+    return thisTarget;
+}
 export function initPrivateApi() {
     if (isExtensionContext()) {
-        // Only `runtime` pages can handle this message but I can't remove it  because its listener
+        // Only `runtime` pages can handle this message but I can't remove it because its listener
         // also serves the purpose of throwing a specific error when no methods have been registered.
         // https://github.com/pixiebrix/webext-messenger/pull/80
         registerMethods({ __getTabData });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webext-messenger",
-  "version": "0.21.0",
+  "version": "0.22.0-2",
   "description": "Browser Extension component messaging framework",
   "keywords": [],
   "repository": "pixiebrix/webext-messenger",

package/readme.md

@@ -18,7 +18,3 @@ import messenger from "webext-messenger";
 ## Context
 
 - [Initial considerations for this library](https://github.com/pixiebrix/webext-messenger/issues/1)
-
-## npm publishing
-
-Collaborators can publish a new version of what's on main [via "workflow_dispatch"](https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch/) under [Actions » Publish](https://github.com/pixiebrix/webext-messenger/actions/workflows/npm-publish.yml)