webext-active-tab 0.0.0 → 0.10.0

package/distribution/on-active-tab.d.ts

@@ -1,3 +1,4 @@
+import { StorageItemMap } from 'webext-storage';
 type TabId = number;
 type Origin = string;
 export type ActiveTab = {
@@ -7,7 +8,7 @@ export type ActiveTab = {
 /**
  * The list is not guaranteed to be up to date. The activeTab permission might be lost before it's detected.
  */
-export declare const possiblyActiveTabs: Map<number, string>;
+export declare const possiblyActiveTabs: StorageItemMap<string, string | undefined> | Map<string, string>;
 declare function startActiveTabTracking(): void;
 declare function stopActiveTabTracking(): void;
 export declare const PRIVATE: {

package/distribution/on-active-tab.js

@@ -1,6 +1,7 @@
 import { isScriptableUrl } from 'webext-content-scripts';
 import { isBackground } from 'webext-detect';
 import SimpleEventTarget from 'simple-event-target';
+import { StorageItemMap } from 'webext-storage';
 if (!isBackground()) {
     throw new Error('This module is only allowed in a background script');
 }
@@ -10,35 +11,40 @@ if (!chrome.runtime.getManifest().permissions?.includes('activeTab')) {
 const activation = new SimpleEventTarget();
 const deactivation = new SimpleEventTarget();
 const browserAction = chrome.action ?? chrome.browserAction;
-// TODO: use https://github.com/fregante/webext-storage/issues/5
 /**
  * The list is not guaranteed to be up to date. The activeTab permission might be lost before it's detected.
  */
-export const possiblyActiveTabs = new Map();
+export const possiblyActiveTabs = chrome.storage.session
+    ? new StorageItemMap('webext-active-tab', {
+        area: 'session',
+    })
+    : new Map();
 async function addIfScriptable({ url, id }) {
     if (id && url
         // Skip if it already exists. A previous change of origin already cleared this
-        && !possiblyActiveTabs.has(id)
+        && !await possiblyActiveTabs.has(String(id))
         // ActiveTab doesn't make sense on non-scriptable URLs as they generally don't have scriptable frames
         && isScriptableUrl(url)
     // Note: Do not filter by `isContentScriptRegistered`; `active-tab` also applies to random `executeScript` calls
     ) {
         const { origin } = new URL(url);
         console.debug('activeTab:', id, 'added', { origin });
-        possiblyActiveTabs.set(id, origin);
+        await possiblyActiveTabs.set(String(id), origin);
         activation.emit({ id, origin });
     }
     else {
         console.debug('activeTab:', id, 'not added', { origin });
     }
 }
-function dropIfOriginChanged(tabId, { url }) {
-    if (url && possiblyActiveTabs.has(tabId)) {
-        const { origin } = new URL(url);
-        if (possiblyActiveTabs.get(tabId) !== origin) {
-            console.debug('activeTab:', tabId, 'removed because origin changed from', possiblyActiveTabs.get(tabId), 'to', origin);
-            possiblyActiveTabs.delete(tabId);
-        }
+async function dropIfOriginChanged(tabId, { url }) {
+    if (!url) {
+        return;
+    }
+    const activeOrigin = await possiblyActiveTabs.get(String(tabId));
+    const { origin } = new URL(url);
+    if (activeOrigin !== origin) {
+        console.debug('activeTab:', tabId, 'removed because origin changed from', activeOrigin, 'to', origin);
+        void possiblyActiveTabs.delete(String(tabId));
     }
 }
 function altListener(_, tab) {
@@ -48,7 +54,7 @@ function altListener(_, tab) {
 }
 function drop(tabId) {
     console.debug('activeTab:', tabId, 'removed');
-    possiblyActiveTabs.delete(tabId);
+    void possiblyActiveTabs.delete(String(tabId));
     deactivation.emit(tabId);
 }
 // https://developer.chrome.com/docs/extensions/mv3/manifest/activeTab/#invoking-activeTab
@@ -65,7 +71,8 @@ function stopActiveTabTracking() {
     chrome.commands?.onCommand.removeListener(altListener);
     chrome.tabs.onUpdated.removeListener(dropIfOriginChanged);
     chrome.tabs.onRemoved.removeListener(drop);
-    possiblyActiveTabs.clear();
+    // TODO: Restore after https://github.com/fregante/webext-storage/issues/9
+    // void possiblyActiveTabs.clear();
 }
 export const PRIVATE = {
     startActiveTabTracking,

package/distribution/register-active-tab-scripts.js

@@ -16,13 +16,14 @@ async function injectAllFrames({ id: tabId, origin: url }) {
 }
 async function injectOneFrame({ tabId, frameId, url }) {
     const { origin } = new URL(url);
+    const activeOrigin = await possiblyActiveTabs.get(String(tabId));
     // Check origin because the request might be for a frame; cross-origin frames do not receive activeTab
-    if (possiblyActiveTabs.get(tabId) === origin) {
+    if (activeOrigin === origin) {
         console.debug('activeTab: will inject', { tabId, frameId, url });
         await injectContentScript({ tabId, frameId }, scripts);
     }
     else {
-        console.debug('activeTab: won’t inject', { tabId, frameId, url }, { activeTab: possiblyActiveTabs.get(tabId) ?? 'no' });
+        console.debug('activeTab: won’t inject', { tabId, frameId, url }, { activeTab: activeOrigin ?? 'no' });
     }
 }
 async function tabListener(tabId, { status }, { url }) {

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "webext-active-tab",
-	"version": "0.0.0",
-	"description": "WebExtension module: Automatically registers your `content_scripts` on domains added via `permission.request` or on `activeTab`",
+	"version": "0.10.0",
+	"description": "WebExtension module: Track `activeTab` permission; automatically inject content scripts",
 	"keywords": [
 		"contentscript",
 		"register",
@@ -24,9 +24,9 @@
 	"author": "Federico Brigante <me@fregante.com> (https://fregante.com)",
 	"type": "module",
 	"exports": {
-		"./on-active-tabs": {
-			"types": "./distribution/on-active-tabs.d.ts",
-			"default": "./distribution/on-active-tabs.js"
+		"./on-active-tab": {
+			"types": "./distribution/on-active-tab.d.ts",
+			"default": "./distribution/on-active-tab.js"
 		},
 		"./register-active-tab-scripts": {
 			"types": "./distribution/register-active-tab-scripts.d.ts",
@@ -63,7 +63,8 @@
 	"dependencies": {
 		"simple-event-target": "^2.0.0",
 		"webext-content-scripts": "^2.7.2",
-		"webext-detect": "^5.3.2"
+		"webext-detect": "^5.3.2",
+		"webext-storage": "^1.3.1"
 	},
 	"devDependencies": {
 		"@parcel/config-webextension": "^2.13.3",