webext-schema 5.3.0 → 5.3.2

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/package.json

@@ -17,24 +17,24 @@
     "commander": "^12.0.0",
     "decamelize": "^6.0.0",
     "json5": "^2.2.3",
-    "sinon": "^17.0.1"
+    "sinon": "^18.0.0"
   },
   "devDependencies": {
     "@types/firefox-webext-browser": "^120.0.3",
-    "@types/node": "^20.12.7",
+    "@types/node": "^20.12.12",
     "@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.3",
+    "eslint-plugin-jsdoc": "^48.2.4",
     "eslint-plugin-regexp": "^2.5.0",
-    "eslint-plugin-unicorn": "^52.0.0",
+    "eslint-plugin-unicorn": "^53.0.0",
     "mocha": "^10.4.0",
     "npm-run-all": "^4.1.5",
     "typescript": "^5.4.5",
-    "undici": "^6.13.0"
+    "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.3.0"
+  "version": "5.3.2"
 }

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": [
@@ -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",

package/schemas/central/webext.json

@@ -9981,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": [
@@ -10136,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",
@@ -10157,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",
@@ -12312,7 +12338,8 @@
             "power",
             "responsiveness",
             "cpufreq",
-            "bandwidth"
+            "bandwidth",
+            "memory"
           ]
         },
         {
@@ -12969,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"
           ]
         },
@@ -13417,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
             },
@@ -14106,7 +14137,12 @@
             "match_about_blank": {
               "type": "boolean",
               "optional": true,
-              "description": "If matchAboutBlank is true, then the code is also injected in about:blank and about:srcdoc frames if your extension has access to its parent document. Code cannot be inserted in top-level about:-frames. By default it is <code>false</code>."
+              "description": "If match_about_blank is true, then the code is also injected in about:blank and about:srcdoc frames if your extension has access to its parent document. Ignored if match_origin_as_fallback is specified. By default it is <code>false</code>."
+            },
+            "match_origin_as_fallback": {
+              "type": "boolean",
+              "optional": true,
+              "description": "If match_origin_as_fallback is true, then the code is also injected in about:, data:, blob: when their origin matches the pattern in 'matches', even if the actual document origin is opaque (due to the use of CSP sandbox or iframe sandbox). Match patterns in 'matches' must specify a wildcard path glob. By default it is <code>false</code>."
             },
             "run_at": {
               "$ref": "extensionTypes.RunAt",
@@ -15725,6 +15761,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",
@@ -15994,6 +16156,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",
@@ -16752,6 +16941,11 @@
                 "type": "string"
               }
             },
+            "matchOriginAsFallback": {
+              "type": "boolean",
+              "optional": true,
+              "description": "If matchOriginAsFallback is true, then the code is also injected in about:, data:, blob: when their origin matches the pattern in 'matches', even if the actual document origin is opaque (due to the use of CSP sandbox or iframe sandbox). Match patterns in 'matches' must specify a wildcard path glob. By default it is <code>false</code>."
+            },
             "runAt": {
               "$ref": "extensionTypes.RunAt",
               "optional": true,
@@ -20820,7 +21014,7 @@
             {
               "type": "function",
               "optional": true,
-              "name": "callback",
+              "name": "asyncCallback",
               "parameters": [
                 {
                   "name": "response",
@@ -20839,6 +21033,7 @@
               "type": "array",
               "optional": true,
               "name": "extraInfoSpec",
+              "postprocess": "mutuallyExclusiveBlockingOrAsyncBlocking",
               "description": "Array of extra information that should be passed to the listener function.",
               "items": {
                 "$ref": "OnAuthRequiredOptions"