webext-schema 5.2.10 → 5.3.1

package/README.md

@@ -1,5 +1,5 @@
 [![build](https://github.com/asamuzaK/webext-schema/workflows/build/badge.svg)](https://github.com/asamuzaK/webext-schema/actions?query=workflow%3Abuild)
-[![CodeQL](https://github.com/asamuzaK/webext-schema/workflows/CodeQL/badge.svg)](https://github.com/asamuzaK/webext-schema/actions?query=workflow%3ACodeQL)
+[![CodeQL](https://github.com/asamuzaK/webext-schema/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/asamuzaK/webext-schema/actions/workflows/github-code-scanning/codeql)
 [![npm](https://img.shields.io/npm/v/webext-schema)](https://www.npmjs.com/package/webext-schema)
 
 # webext-schema

package/modules/browser.js

@@ -989,6 +989,44 @@ export const warmupTab = async tabId => {
   }
 };
 
+/**
+ * capture visible tab
+ * @param {number} windowId - window ID
+ * @param {object} opt - options
+ * @returns {Promise.<?string>} - data URL
+ */
+export const captureVisibleTab = async (windowId, opt) => {
+  const info = await runtime.getBrowserInfo();
+  let isGranted;
+  if (info.vender === 'Mozilla') {
+    const browserVersion = parseFloat(info.version);
+    isGranted = (browserVersion >= 126 && await isPermissionGranted({
+      permissions: ['activeTab']
+    })) || await isPermissionGranted({
+      origins: ['<all_urls>']
+    });
+  } else {
+    isGranted = await isPermissionGranted({
+      permissions: ['activeTab']
+    }) || await isPermissionGranted({
+      origins: ['<all_urls>']
+    });
+  }
+  let url;
+  if (isGranted) {
+    if (!Number.isInteger(windowId)) {
+      windowId = windows.WINDOW_ID_CURRENT;
+    }
+    if (!opt) {
+      opt = {
+        format: 'png'
+      };
+    }
+    url = await tabs.captureVisibleTab(windowId, opt);
+  }
+  return url ?? null;
+};
+
 /**
  * is tab
  * @param {*} tabId - tab ID

package/package.json

@@ -17,24 +17,24 @@
     "commander": "^12.0.0",
     "decamelize": "^6.0.0",
     "json5": "^2.2.3",
-    "sinon": "^17.0.1"
+    "sinon": "^17.0.2"
   },
   "devDependencies": {
     "@types/firefox-webext-browser": "^120.0.3",
-    "@types/node": "^20.11.30",
+    "@types/node": "^20.12.11",
     "@types/sinon": "^17.0.3",
     "c8": "^9.1.0",
-    "chai": "^5.1.0",
+    "chai": "^5.1.1",
     "eslint": "^8.57.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jsdoc": "^48.2.1",
-    "eslint-plugin-regexp": "^2.3.0",
-    "eslint-plugin-unicorn": "^51.0.1",
-    "mocha": "^10.3.0",
+    "eslint-plugin-jsdoc": "^48.2.4",
+    "eslint-plugin-regexp": "^2.5.0",
+    "eslint-plugin-unicorn": "^53.0.0",
+    "mocha": "^10.4.0",
     "npm-run-all": "^4.1.5",
-    "typescript": "^5.4.2",
-    "undici": "^6.9.0"
+    "typescript": "^5.4.5",
+    "undici": "^6.16.1"
   },
   "scripts": {
     "build": "npm run tsc && npm run lint && npm run test",
@@ -54,5 +54,5 @@
     "update-mail": "node index update --channel=mail -i",
     "update-release": "node index update --channel=release -i"
   },
-  "version": "5.2.10"
+  "version": "5.3.1"
 }

package/schemas/beta/webext.json

@@ -915,6 +915,12 @@
             {
               "name": "command",
               "type": "string"
+            },
+            {
+              "name": "tab",
+              "$ref": "tags.Tab",
+              "optional": true,
+              "description": "Details of the $(ref:tabs.Tab) where the command was activated."
             }
           ]
         },
@@ -5613,9 +5619,10 @@
         {
           "name": "captureVisibleTab",
           "type": "function",
-          "description": "Captures an area of the currently active tab in the specified window. You must have $(topic:declare_permissions)[<all_urls>] permission to use this method.",
+          "description": "Captures an area of the currently active tab in the specified window. You must have <all_urls> or activeTab permission to use this method.",
           "permissions": [
-            "<all_urls>"
+            "<all_urls>",
+            "activeTab"
           ],
           "async": "callback",
           "parameters": [
@@ -13476,6 +13483,11 @@
               ],
               "optional": true
             },
+            "options_page": {
+              "$ref": "ExtensionURL",
+              "optional": true,
+              "description": "Alias property for options_ui.page, ignored when options_ui.page is set. When using this property the options page is always opened in a new tab."
+            },
             "options_ui": {
               "type": "object",
               "optional": true,
@@ -19710,6 +19722,7 @@
               "type": "string",
               "enum": [
                 "webRequest",
+                "webRequestAuthProvider",
                 "webRequestBlocking",
                 "webRequestFilterResponse",
                 "webRequestFilterResponse.serviceWorkerScript"
@@ -19800,7 +19813,7 @@
             "blocking",
             "asyncBlocking"
           ],
-          "postprocess": "webRequestBlockingPermissionRequired"
+          "postprocess": "webRequestBlockingOrAuthProviderPermissionRequired"
         },
         {
           "id": "OnResponseStartedOptions",

package/schemas/central/webext.json

@@ -915,6 +915,12 @@
             {
               "name": "command",
               "type": "string"
+            },
+            {
+              "name": "tab",
+              "$ref": "tags.Tab",
+              "optional": true,
+              "description": "Details of the $(ref:tabs.Tab) where the command was activated."
             }
           ]
         },
@@ -5613,9 +5619,10 @@
         {
           "name": "captureVisibleTab",
           "type": "function",
-          "description": "Captures an area of the currently active tab in the specified window. You must have $(topic:declare_permissions)[<all_urls>] permission to use this method.",
+          "description": "Captures an area of the currently active tab in the specified window. You must have <all_urls> or activeTab permission to use this method.",
           "permissions": [
-            "<all_urls>"
+            "<all_urls>",
+            "activeTab"
           ],
           "async": "callback",
           "parameters": [
@@ -9974,6 +9981,20 @@
               }
             }
           }
+        },
+        {
+          "id": "GetRulesFilter",
+          "type": "object",
+          "properties": {
+            "ruleIds": {
+              "type": "array",
+              "optional": true,
+              "description": "If specified, only rules with matching IDs are included.",
+              "items": {
+                "type": "integer"
+              }
+            }
+          }
         }
       ],
       "functions": [
@@ -10129,6 +10150,12 @@
           "description": "Returns the current set of dynamic rules for the extension.",
           "async": "callback",
           "parameters": [
+            {
+              "name": "filter",
+              "$ref": "GetRulesFilter",
+              "optional": true,
+              "description": "An object to filter the set of dynamic rules for the extension."
+            },
             {
               "name": "callback",
               "type": "function",
@@ -10150,6 +10177,12 @@
           "description": "Returns the current set of session scoped rules for the extension.",
           "async": "callback",
           "parameters": [
+            {
+              "name": "filter",
+              "$ref": "GetRulesFilter",
+              "optional": true,
+              "description": "An object to filter the set of session scoped rules for the extension."
+            },
             {
               "name": "callback",
               "type": "function",
@@ -12305,7 +12338,8 @@
             "power",
             "responsiveness",
             "cpufreq",
-            "bandwidth"
+            "bandwidth",
+            "memory"
           ]
         },
         {
@@ -12962,12 +12996,13 @@
         },
         {
           "id": "ExtensionInstallType",
-          "description": "How the extension was installed. One of<br><var>development</var>: The extension was loaded unpacked in developer mode,<br><var>normal</var>: The extension was installed normally via an .xpi file,<br><var>sideload</var>: The extension was installed by other software on the machine,<br><var>other</var>: The extension was installed by other means.",
+          "description": "How the extension was installed. One of<br><var>development</var>: The extension was loaded unpacked in developer mode,<br><var>normal</var>: The extension was installed normally via an .xpi file,<br><var>sideload</var>: The extension was installed by other software on the machine,<br><var>admin</var>: The extension was installed by policy,<br><var>other</var>: The extension was installed by other means.",
           "type": "string",
           "enum": [
             "development",
             "normal",
             "sideload",
+            "admin",
             "other"
           ]
         },
@@ -13410,10 +13445,13 @@
             },
             "incognito": {
               "type": "string",
+              "description": "The 'split' value is not supported.",
               "enum": [
                 "not_allowed",
-                "spanning"
+                "spanning",
+                "split"
               ],
+              "postprocess": "incognitoSplitUnsupportedAndFallback",
               "default": "spanning",
               "optional": true
             },
@@ -13476,6 +13514,11 @@
               ],
               "optional": true
             },
+            "options_page": {
+              "$ref": "ExtensionURL",
+              "optional": true,
+              "description": "Alias property for options_ui.page, ignored when options_ui.page is set. When using this property the options page is always opened in a new tab."
+            },
             "options_ui": {
               "type": "object",
               "optional": true,
@@ -15713,6 +15756,132 @@
       ],
       "description": "Use the <code>browser.runtime</code> API to retrieve the background page, return details about the manifest, and listen for and respond to events in the app or extension lifecycle. You can also use this API to convert the relative path of URLs to fully-qualified URLs.",
       "types": [
+        {
+          "id": "ContextFilter",
+          "min_manifest_version": 3,
+          "type": "object",
+          "description": "A filter to match against existing extension context. Matching contexts must match all specified filters.",
+          "properties": {
+            "contextIds": {
+              "optional": true,
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "contextTypes": {
+              "optional": true,
+              "type": "array",
+              "items": {
+                "$ref": "ContextType"
+              }
+            },
+            "documentIds": {
+              "optional": true,
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "documentOrigins": {
+              "optional": true,
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "documentUrls": {
+              "optional": true,
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "frameIds": {
+              "optional": true,
+              "type": "array",
+              "items": {
+                "type": "integer"
+              }
+            },
+            "tabIds": {
+              "optional": true,
+              "type": "array",
+              "items": {
+                "type": "integer"
+              }
+            },
+            "windowIds": {
+              "optional": true,
+              "type": "array",
+              "items": {
+                "type": "integer"
+              }
+            },
+            "incognito": {
+              "optional": true,
+              "type": "boolean"
+            }
+          }
+        },
+        {
+          "id": "ContextType",
+          "type": "string",
+          "enum": [
+            "BACKGROUND",
+            "POPUP",
+            "SIDE_PANEL",
+            "TAB"
+          ],
+          "description": "The type of extension view."
+        },
+        {
+          "id": "ExtensionContext",
+          "type": "object",
+          "description": "A context hosting extension content",
+          "properties": {
+            "contextId": {
+              "type": "string",
+              "description": "An unique identifier associated to this context"
+            },
+            "contextType": {
+              "$ref": "ContextType",
+              "description": "The type of the context"
+            },
+            "documentId": {
+              "type": "string",
+              "unsupported": true,
+              "optional": true,
+              "description": "An UUID for the document associated with this context, or undefined if it is not hosted in a document"
+            },
+            "documentOrigin": {
+              "type": "string",
+              "optional": true,
+              "description": "The origin of the document associated with this context, or undefined if it is not hosted in a document"
+            },
+            "documentUrl": {
+              "type": "string",
+              "optional": true,
+              "description": "The URL of the document associated with this context, or undefined if it is not hosted in a document"
+            },
+            "incognito": {
+              "type": "boolean",
+              "description": "Whether the context is associated with an private browsing context."
+            },
+            "frameId": {
+              "type": "integer",
+              "description": "The frame ID for this context, or -1 if it is not hosted in a frame."
+            },
+            "tabId": {
+              "type": "integer",
+              "description": "The tab ID for this context, or -1 if it is not hosted in a tab."
+            },
+            "windowId": {
+              "type": "integer",
+              "description": "The window ID for this context, or -1 if it is not hosted in a window."
+            }
+          }
+        },
         {
           "id": "Port",
           "type": "object",
@@ -15982,6 +16151,33 @@
             }
           ]
         },
+        {
+          "name": "getContexts",
+          "type": "function",
+          "description": "Fetches information about active contexts associated with this extension",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "filter",
+              "$ref": "ContextFilter",
+              "description": "A filter to find matching context."
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "parameters": [
+                {
+                  "name": "contexts",
+                  "type": "array",
+                  "items": {
+                    "$ref": "ExtensionContext"
+                  },
+                  "description": "The matching contexts, if any."
+                }
+              ]
+            }
+          ]
+        },
         {
           "name": "openOptionsPage",
           "type": "function",
@@ -19710,6 +19906,7 @@
               "type": "string",
               "enum": [
                 "webRequest",
+                "webRequestAuthProvider",
                 "webRequestBlocking",
                 "webRequestFilterResponse",
                 "webRequestFilterResponse.serviceWorkerScript"
@@ -19800,7 +19997,7 @@
             "blocking",
             "asyncBlocking"
           ],
-          "postprocess": "webRequestBlockingPermissionRequired"
+          "postprocess": "webRequestBlockingOrAuthProviderPermissionRequired"
         },
         {
           "id": "OnResponseStartedOptions",