webext-schema 5.3.2 → 5.3.4

package/package.json

@@ -14,27 +14,27 @@
   "types": "types/index.d.ts",
   "dependencies": {
     "camelize": "^1.0.1",
-    "commander": "^12.0.0",
+    "commander": "^12.1.0",
     "decamelize": "^6.0.0",
     "json5": "^2.2.3",
     "sinon": "^18.0.0"
   },
   "devDependencies": {
     "@types/firefox-webext-browser": "^120.0.3",
-    "@types/node": "^20.12.12",
+    "@types/node": "^20.14.2",
     "@types/sinon": "^17.0.3",
-    "c8": "^9.1.0",
+    "c8": "^10.1.2",
     "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.4",
-    "eslint-plugin-regexp": "^2.5.0",
+    "eslint-plugin-jsdoc": "^48.2.11",
+    "eslint-plugin-regexp": "^2.6.0",
     "eslint-plugin-unicorn": "^53.0.0",
     "mocha": "^10.4.0",
     "npm-run-all": "^4.1.5",
     "typescript": "^5.4.5",
-    "undici": "^6.16.1"
+    "undici": "^6.18.2"
   },
   "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.2"
+  "version": "5.3.4"
 }

package/schemas/beta/webext.json

@@ -918,7 +918,7 @@
             },
             {
               "name": "tab",
-              "$ref": "tags.Tab",
+              "$ref": "tabs.Tab",
               "optional": true,
               "description": "Details of the $(ref:tabs.Tab) where the command was activated."
             }
@@ -8723,13 +8723,23 @@
             "matchAboutBlank": {
               "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 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. Ignored if matchOriginAsFallback is specified. By default it is <code>false</code>."
+            },
+            "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,
               "description": "The soonest that the JavaScript or CSS will be injected into the tab. Defaults to \"document_idle\"."
             },
+            "world": {
+              "$ref": "extensionTypes.ExecutionWorld",
+              "optional": true,
+              "description": "The JavaScript world for a script to execute within. Defaults to \"ISOLATED\"."
+            },
             "cookieStoreId": {
               "choices": [
                 {
@@ -10094,7 +10104,7 @@
         {
           "name": "updateEnabledRulesets",
           "type": "function",
-          "description": "Returns the ids for the current set of enabled static rulesets.",
+          "description": "Modifies the static rulesets enabled/disabled state.",
           "async": "callback",
           "parameters": [
             {
@@ -10126,6 +10136,44 @@
             }
           ]
         },
+        {
+          "name": "updateStaticRules",
+          "type": "function",
+          "description": "Modified individual static rules enabled/disabled state. Changes to rules belonging to a disabled ruleset will take effect when the ruleset becomes enabled.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "options",
+              "type": "object",
+              "properties": {
+                "rulesetId": {
+                  "type": "string"
+                },
+                "disableRuleIds": {
+                  "type": "array",
+                  "items": {
+                    "type": "integer"
+                  },
+                  "optional": true,
+                  "default": []
+                },
+                "enableRuleIds": {
+                  "type": "array",
+                  "items": {
+                    "type": "integer"
+                  },
+                  "optional": true,
+                  "default": []
+                }
+              }
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "parameters": []
+            }
+          ]
+        },
         {
           "name": "getAvailableStaticRuleCount",
           "type": "function",
@@ -10144,6 +10192,36 @@
             }
           ]
         },
+        {
+          "name": "getDisabledRuleIds",
+          "type": "function",
+          "description": "Returns the list of individual disabled static rules from a given static ruleset id.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "options",
+              "type": "object",
+              "properties": {
+                "rulesetId": {
+                  "type": "string"
+                }
+              }
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "parameters": [
+                {
+                  "name": "disabledRuleIds",
+                  "type": "array",
+                  "items": {
+                    "type": "integer"
+                  }
+                }
+              ]
+            }
+          ]
+        },
         {
           "name": "getDynamicRules",
           "type": "function",
@@ -10339,13 +10417,25 @@
           "type": "number",
           "description": "The maximum number of static Rulesets an extension can specify as part of the rule_resources manifest key."
         },
+        "MAX_NUMBER_OF_DISABLED_STATIC_RULES": {
+          "type": "number",
+          "description": "The maximum number of static rules that can be disabled on each static ruleset."
+        },
         "MAX_NUMBER_OF_ENABLED_STATIC_RULESETS": {
           "type": "number",
           "description": "The maximum number of static Rulesets an extension can enable at any one time."
         },
         "MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES": {
           "type": "number",
-          "description": "The maximum number of dynamic and session rules an extension can add. NOTE: in the Firefox we are enforcing this limit to the session and dynamic rules count separately, instead of enforcing it to the rules count for both combined as the Chrome implementation does."
+          "description": "Deprecated property returning the maximum number of dynamic and session rules an extension can add, replaced by MAX_NUMBER_OF_DYNAMIC_RULES/MAX_NUMBER_OF_SESSION_RULES."
+        },
+        "MAX_NUMBER_OF_DYNAMIC_RULES": {
+          "type": "number",
+          "description": "The maximum number of dynamic session rules an extension can add."
+        },
+        "MAX_NUMBER_OF_SESSION_RULES": {
+          "type": "number",
+          "description": "The maximum number of dynamic session rules an extension can add."
         },
         "MAX_NUMBER_OF_REGEX_RULES": {
           "type": "number",
@@ -12075,6 +12165,15 @@
           ],
           "description": "The soonest that the JavaScript or CSS will be injected into the tab."
         },
+        {
+          "id": "ExecutionWorld",
+          "type": "string",
+          "enum": [
+            "ISOLATED",
+            "MAIN"
+          ],
+          "description": "The JavaScript world for a script to execute within. <code>ISOLATED</code> is the default execution environment of content scripts, <code>MAIN</code> is the web page's execution environment."
+        },
         {
           "id": "CSSOrigin",
           "type": "string",
@@ -13616,6 +13715,16 @@
               "optional": true,
               "default": []
             },
+            "optional_host_permissions": {
+              "min_manifest_version": 3,
+              "type": "array",
+              "items": {
+                "$ref": "MatchPattern",
+                "onError": "warn"
+              },
+              "optional": true,
+              "default": []
+            },
             "optional_permissions": {
               "type": "array",
               "items": {
@@ -13980,6 +14089,9 @@
               "type": "string",
               "optional": true
             }
+          },
+          "additionalProperties": {
+            "$ref": "UnrecognizedProperty"
           }
         },
         {
@@ -13996,7 +14108,7 @@
             }
           },
           "additionalProperties": {
-            "type": "any"
+            "$ref": "UnrecognizedProperty"
           }
         },
         {
@@ -14137,13 +14249,24 @@
             "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",
               "optional": true,
               "default": "document_idle",
               "description": "The soonest that the JavaScript or CSS will be injected into the tab. Defaults to \"document_idle\"."
+            },
+            "world": {
+              "$ref": "extensionTypes.ExecutionWorld",
+              "optional": true,
+              "default": "ISOLATED",
+              "description": "The JavaScript world for a script to execute within. Defaults to \"ISOLATED\"."
             }
           }
         },
@@ -15392,7 +15515,7 @@
             "proxyDNS": {
               "type": "boolean",
               "optional": true,
-              "description": "Proxy DNS when using SOCKS v5."
+              "description": "Proxy DNS when using SOCKS. DNS queries get leaked to the network when set to false. True by default for SOCKS v5. False by default for SOCKS v4."
             },
             "respectBeConservative": {
               "type": "boolean",
@@ -16895,9 +17018,10 @@
           "id": "ExecutionWorld",
           "type": "string",
           "enum": [
-            "ISOLATED"
+            "ISOLATED",
+            "MAIN"
           ],
-          "description": "The JavaScript world for a script to execute within. We currently only support the <code>'ISOLATED'</code> world."
+          "description": "The JavaScript world for a script to execute within. <code>ISOLATED</code> is the default execution environment of content scripts, <code>MAIN</code> is the web page's execution environment."
         },
         {
           "id": "RegisteredContentScript",
@@ -16936,11 +17060,21 @@
                 "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,
               "description": "Specifies when JavaScript files are injected into the web page. The preferred and default value is <code>document_idle</code>."
             },
+            "world": {
+              "$ref": "ExecutionWorld",
+              "optional": true,
+              "description": "The JavaScript world for a script to execute within. Defaults to \"ISOLATED\"."
+            },
             "persistAcrossSessions": {
               "type": "boolean",
               "optional": true,
@@ -21004,7 +21138,7 @@
             {
               "type": "function",
               "optional": true,
-              "name": "callback",
+              "name": "asyncCallback",
               "parameters": [
                 {
                   "name": "response",
@@ -21023,6 +21157,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"

package/schemas/central/webext.json

@@ -918,7 +918,7 @@
             },
             {
               "name": "tab",
-              "$ref": "tags.Tab",
+              "$ref": "tabs.Tab",
               "optional": true,
               "description": "Details of the $(ref:tabs.Tab) where the command was activated."
             }
@@ -8723,13 +8723,23 @@
             "matchAboutBlank": {
               "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 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. Ignored if matchOriginAsFallback is specified. By default it is <code>false</code>."
+            },
+            "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,
               "description": "The soonest that the JavaScript or CSS will be injected into the tab. Defaults to \"document_idle\"."
             },
+            "world": {
+              "$ref": "extensionTypes.ExecutionWorld",
+              "optional": true,
+              "description": "The JavaScript world for a script to execute within. Defaults to \"ISOLATED\"."
+            },
             "cookieStoreId": {
               "choices": [
                 {
@@ -10094,7 +10104,7 @@
         {
           "name": "updateEnabledRulesets",
           "type": "function",
-          "description": "Returns the ids for the current set of enabled static rulesets.",
+          "description": "Modifies the static rulesets enabled/disabled state.",
           "async": "callback",
           "parameters": [
             {
@@ -10126,6 +10136,44 @@
             }
           ]
         },
+        {
+          "name": "updateStaticRules",
+          "type": "function",
+          "description": "Modified individual static rules enabled/disabled state. Changes to rules belonging to a disabled ruleset will take effect when the ruleset becomes enabled.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "options",
+              "type": "object",
+              "properties": {
+                "rulesetId": {
+                  "type": "string"
+                },
+                "disableRuleIds": {
+                  "type": "array",
+                  "items": {
+                    "type": "integer"
+                  },
+                  "optional": true,
+                  "default": []
+                },
+                "enableRuleIds": {
+                  "type": "array",
+                  "items": {
+                    "type": "integer"
+                  },
+                  "optional": true,
+                  "default": []
+                }
+              }
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "parameters": []
+            }
+          ]
+        },
         {
           "name": "getAvailableStaticRuleCount",
           "type": "function",
@@ -10144,6 +10192,36 @@
             }
           ]
         },
+        {
+          "name": "getDisabledRuleIds",
+          "type": "function",
+          "description": "Returns the list of individual disabled static rules from a given static ruleset id.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "options",
+              "type": "object",
+              "properties": {
+                "rulesetId": {
+                  "type": "string"
+                }
+              }
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "parameters": [
+                {
+                  "name": "disabledRuleIds",
+                  "type": "array",
+                  "items": {
+                    "type": "integer"
+                  }
+                }
+              ]
+            }
+          ]
+        },
         {
           "name": "getDynamicRules",
           "type": "function",
@@ -10339,13 +10417,25 @@
           "type": "number",
           "description": "The maximum number of static Rulesets an extension can specify as part of the rule_resources manifest key."
         },
+        "MAX_NUMBER_OF_DISABLED_STATIC_RULES": {
+          "type": "number",
+          "description": "The maximum number of static rules that can be disabled on each static ruleset."
+        },
         "MAX_NUMBER_OF_ENABLED_STATIC_RULESETS": {
           "type": "number",
           "description": "The maximum number of static Rulesets an extension can enable at any one time."
         },
         "MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES": {
           "type": "number",
-          "description": "The maximum number of dynamic and session rules an extension can add. NOTE: in the Firefox we are enforcing this limit to the session and dynamic rules count separately, instead of enforcing it to the rules count for both combined as the Chrome implementation does."
+          "description": "Deprecated property returning the maximum number of dynamic and session rules an extension can add, replaced by MAX_NUMBER_OF_DYNAMIC_RULES/MAX_NUMBER_OF_SESSION_RULES."
+        },
+        "MAX_NUMBER_OF_DYNAMIC_RULES": {
+          "type": "number",
+          "description": "The maximum number of dynamic session rules an extension can add."
+        },
+        "MAX_NUMBER_OF_SESSION_RULES": {
+          "type": "number",
+          "description": "The maximum number of dynamic session rules an extension can add."
         },
         "MAX_NUMBER_OF_REGEX_RULES": {
           "type": "number",
@@ -12075,6 +12165,15 @@
           ],
           "description": "The soonest that the JavaScript or CSS will be injected into the tab."
         },
+        {
+          "id": "ExecutionWorld",
+          "type": "string",
+          "enum": [
+            "ISOLATED",
+            "MAIN"
+          ],
+          "description": "The JavaScript world for a script to execute within. <code>ISOLATED</code> is the default execution environment of content scripts, <code>MAIN</code> is the web page's execution environment."
+        },
         {
           "id": "CSSOrigin",
           "type": "string",
@@ -13616,6 +13715,16 @@
               "optional": true,
               "default": []
             },
+            "optional_host_permissions": {
+              "min_manifest_version": 3,
+              "type": "array",
+              "items": {
+                "$ref": "MatchPattern",
+                "onError": "warn"
+              },
+              "optional": true,
+              "default": []
+            },
             "optional_permissions": {
               "type": "array",
               "items": {
@@ -13980,6 +14089,9 @@
               "type": "string",
               "optional": true
             }
+          },
+          "additionalProperties": {
+            "$ref": "UnrecognizedProperty"
           }
         },
         {
@@ -13996,7 +14108,7 @@
             }
           },
           "additionalProperties": {
-            "type": "any"
+            "$ref": "UnrecognizedProperty"
           }
         },
         {
@@ -14149,6 +14261,12 @@
               "optional": true,
               "default": "document_idle",
               "description": "The soonest that the JavaScript or CSS will be injected into the tab. Defaults to \"document_idle\"."
+            },
+            "world": {
+              "$ref": "extensionTypes.ExecutionWorld",
+              "optional": true,
+              "default": "ISOLATED",
+              "description": "The JavaScript world for a script to execute within. Defaults to \"ISOLATED\"."
             }
           }
         },
@@ -15397,7 +15515,7 @@
             "proxyDNS": {
               "type": "boolean",
               "optional": true,
-              "description": "Proxy DNS when using SOCKS v5."
+              "description": "Proxy DNS when using SOCKS. DNS queries get leaked to the network when set to false. True by default for SOCKS v5. False by default for SOCKS v4."
             },
             "respectBeConservative": {
               "type": "boolean",
@@ -16900,9 +17018,10 @@
           "id": "ExecutionWorld",
           "type": "string",
           "enum": [
-            "ISOLATED"
+            "ISOLATED",
+            "MAIN"
           ],
-          "description": "The JavaScript world for a script to execute within. We currently only support the <code>'ISOLATED'</code> world."
+          "description": "The JavaScript world for a script to execute within. <code>ISOLATED</code> is the default execution environment of content scripts, <code>MAIN</code> is the web page's execution environment."
         },
         {
           "id": "RegisteredContentScript",
@@ -16951,6 +17070,11 @@
               "optional": true,
               "description": "Specifies when JavaScript files are injected into the web page. The preferred and default value is <code>document_idle</code>."
             },
+            "world": {
+              "$ref": "ExecutionWorld",
+              "optional": true,
+              "description": "The JavaScript world for a script to execute within. Defaults to \"ISOLATED\"."
+            },
             "persistAcrossSessions": {
               "type": "boolean",
               "optional": true,