webext-schema 5.1.11 → 5.1.13

package/package.json

@@ -13,8 +13,8 @@
   "main": "index.js",
   "types": "types/index.d.ts",
   "dependencies": {
-    "@types/firefox-webext-browser": "^111.0.0",
-    "@types/node": "^18.15.10",
+    "@types/firefox-webext-browser": "^111.0.1",
+    "@types/node": "^18.15.11",
     "@types/sinon": "^10.0.13",
     "camelize": "^1.0.1",
     "commander": "^10.0.0",
@@ -25,18 +25,18 @@
   "devDependencies": {
     "c8": "^7.13.0",
     "chai": "^4.3.7",
-    "eslint": "^8.36.0",
+    "eslint": "^8.38.0",
     "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsdoc": "^40.1.0",
+    "eslint-plugin-jsdoc": "^41.1.1",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-regexp": "^1.13.0",
+    "eslint-plugin-regexp": "^1.14.0",
     "eslint-plugin-unicorn": "^46.0.0",
     "mocha": "^10.2.0",
     "npm-run-all": "^4.1.5",
-    "typescript": "^5.0.2",
-    "undici": "^5.21.0"
+    "typescript": "^5.0.4",
+    "undici": "^5.21.2"
   },
   "scripts": {
     "build": "npm run tsc && npm run lint && npm run test",
@@ -56,5 +56,5 @@
     "update-mail": "node index update --channel=mail -i",
     "update-release": "node index update --channel=release -i"
   },
-  "version": "5.1.11"
+  "version": "5.1.13"
 }

package/schemas/beta/webext.json

@@ -9716,8 +9716,7 @@
               "type": "string",
               "enum": [
                 "declarativeNetRequest"
-              ],
-              "min_manifest_version": 3
+              ]
             }
           ]
         },
@@ -9728,8 +9727,7 @@
               "type": "string",
               "enum": [
                 "declarativeNetRequestFeedback"
-              ],
-              "min_manifest_version": 3
+              ]
             }
           ]
         },
@@ -9740,8 +9738,7 @@
               "type": "string",
               "enum": [
                 "declarativeNetRequestWithHostAccess"
-              ],
-              "min_manifest_version": 3
+              ]
             }
           ]
         },
@@ -9750,7 +9747,6 @@
           "properties": {
             "declarative_net_request": {
               "type": "object",
-              "min_manifest_version": 3,
               "optional": true,
               "additionalProperties": {
                 "$ref": "UnrecognizedProperty"
@@ -13518,7 +13514,7 @@
               "postprocess": "manifestVersionCheck"
             },
             "applications": {
-              "$ref": "BrowserSpecificSettings",
+              "$ref": "DeprecatedApplications",
               "description": "The applications property is deprecated, please use 'browser_specific_settings'",
               "optional": true,
               "max_manifest_version": 2
@@ -14140,6 +14136,41 @@
             }
           }
         },
+        {
+          "id": "GeckoAndroidSpecificProperties",
+          "type": "object",
+          "properties": {
+            "strict_min_version": {
+              "type": "string",
+              "optional": true
+            },
+            "strict_max_version": {
+              "type": "string",
+              "optional": true
+            }
+          },
+          "additionalProperties": {
+            "type": "any"
+          }
+        },
+        {
+          "id": "DeprecatedApplications",
+          "type": "object",
+          "properties": {
+            "gecko": {
+              "$ref": "FirefoxSpecificProperties",
+              "optional": true
+            },
+            "gecko_android": {
+              "$ref": "GeckoAndroidSpecificProperties",
+              "optional": true,
+              "unsupported": true
+            }
+          },
+          "additionalProperties": {
+            "type": "any"
+          }
+        },
         {
           "id": "BrowserSpecificSettings",
           "type": "object",
@@ -14147,6 +14178,10 @@
             "gecko": {
               "$ref": "FirefoxSpecificProperties",
               "optional": true
+            },
+            "gecko_android": {
+              "$ref": "GeckoAndroidSpecificProperties",
+              "optional": true
             }
           },
           "additionalProperties": {

package/schemas/central/webext.json

@@ -9716,8 +9716,7 @@
               "type": "string",
               "enum": [
                 "declarativeNetRequest"
-              ],
-              "min_manifest_version": 3
+              ]
             }
           ]
         },
@@ -9728,8 +9727,7 @@
               "type": "string",
               "enum": [
                 "declarativeNetRequestFeedback"
-              ],
-              "min_manifest_version": 3
+              ]
             }
           ]
         },
@@ -9740,8 +9738,7 @@
               "type": "string",
               "enum": [
                 "declarativeNetRequestWithHostAccess"
-              ],
-              "min_manifest_version": 3
+              ]
             }
           ]
         },
@@ -9750,7 +9747,6 @@
           "properties": {
             "declarative_net_request": {
               "type": "object",
-              "min_manifest_version": 3,
               "optional": true,
               "additionalProperties": {
                 "$ref": "UnrecognizedProperty"
@@ -13518,7 +13514,7 @@
               "postprocess": "manifestVersionCheck"
             },
             "applications": {
-              "$ref": "BrowserSpecificSettings",
+              "$ref": "DeprecatedApplications",
               "description": "The applications property is deprecated, please use 'browser_specific_settings'",
               "optional": true,
               "max_manifest_version": 2
@@ -14140,6 +14136,41 @@
             }
           }
         },
+        {
+          "id": "GeckoAndroidSpecificProperties",
+          "type": "object",
+          "properties": {
+            "strict_min_version": {
+              "type": "string",
+              "optional": true
+            },
+            "strict_max_version": {
+              "type": "string",
+              "optional": true
+            }
+          },
+          "additionalProperties": {
+            "type": "any"
+          }
+        },
+        {
+          "id": "DeprecatedApplications",
+          "type": "object",
+          "properties": {
+            "gecko": {
+              "$ref": "FirefoxSpecificProperties",
+              "optional": true
+            },
+            "gecko_android": {
+              "$ref": "GeckoAndroidSpecificProperties",
+              "optional": true,
+              "unsupported": true
+            }
+          },
+          "additionalProperties": {
+            "type": "any"
+          }
+        },
         {
           "id": "BrowserSpecificSettings",
           "type": "object",
@@ -14147,6 +14178,10 @@
             "gecko": {
               "$ref": "FirefoxSpecificProperties",
               "optional": true
+            },
+            "gecko_android": {
+              "$ref": "GeckoAndroidSpecificProperties",
+              "optional": true
             }
           },
           "additionalProperties": {

package/schemas/mail/mailext.json

@@ -4764,9 +4764,34 @@
         {
           "name": "openPopup",
           "type": "function",
-          "description": "Opens the action's popup window in the active window.",
-          "async": true,
-          "parameters": []
+          "description": "Opens the action's popup window in the specified window. Defaults to the current window. Returns false if the popup could not be opened because the action is disabled or has been removed from the toolbar.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "options",
+              "optional": true,
+              "type": "object",
+              "description": "An object with information about the popup to open.",
+              "properties": {
+                "windowId": {
+                  "type": "integer",
+                  "minimum": -2,
+                  "optional": true,
+                  "description": "Defaults to the current window."
+                }
+              }
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "optional": true,
+              "parameters": [
+                {
+                  "type": "boolean"
+                }
+              ]
+            }
+          ]
         }
       ],
       "events": [
@@ -6178,7 +6203,7 @@
           "name": "setComposeDetails",
           "type": "function",
           "async": true,
-          "description": "Updates the compose window. Only fields that are to be changed should be specified. Currently only a limited amount of information can be set, more will be added in later versions.\n\n**Note:** The compose format of an existing compose window cannot be changed. Since Thunderbird 98, setting conflicting values for ``details.body``, ``details.plainTextBody`` or ``details.isPlaintext`` no longer throw an exception, instead the compose window chooses the matching ``details.body`` or ``details.plainTextBody`` value and ignores the other.",
+          "description": "Updates the compose window. The properties of the given :ref:`compose.ComposeDetails` object will be used to overwrite the current values of the specified compose window, so only properties that are to be changed should be included.\n\nWhen updating any of the array properties (``customHeaders`` and most address fields), make sure to first get the current values to not accidentally remove all existing entries when setting the new value.\n\n**Note:** The compose format of an existing compose window cannot be changed. Since Thunderbird 98, setting conflicting values for ``details.body``, ``details.plainTextBody`` or ``details.isPlaintext`` no longer throws an exception, instead the compose window chooses the matching ``details.body`` or ``details.plainTextBody`` value and ignores the other.",
           "permissions": [
             "compose"
           ],
@@ -7206,10 +7231,34 @@
         {
           "name": "openPopup",
           "type": "function",
-          "requireUserInput": true,
-          "description": "Opens the action's popup window in the active window.",
-          "async": true,
-          "parameters": []
+          "description": "Opens the action's popup window in the specified window. Defaults to the current window. Returns false if the popup could not be opened because the action is disabled or has been removed from the toolbar.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "options",
+              "optional": true,
+              "type": "object",
+              "description": "An object with information about the popup to open.",
+              "properties": {
+                "windowId": {
+                  "type": "integer",
+                  "minimum": -2,
+                  "optional": true,
+                  "description": "Defaults to the current window."
+                }
+              }
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "optional": true,
+              "parameters": [
+                {
+                  "type": "boolean"
+                }
+              ]
+            }
+          ]
         }
       ],
       "events": [
@@ -10172,10 +10221,34 @@
         {
           "name": "openPopup",
           "type": "function",
-          "requireUserInput": true,
-          "description": "Opens the action's popup window in the active window.",
-          "async": true,
-          "parameters": []
+          "description": "Opens the action's popup window in the specified window. Defaults to the current window. Returns false if the popup could not be opened because the action is disabled or has been removed from the toolbar.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "options",
+              "optional": true,
+              "type": "object",
+              "description": "An object with information about the popup to open.",
+              "properties": {
+                "windowId": {
+                  "type": "integer",
+                  "minimum": -2,
+                  "optional": true,
+                  "description": "Defaults to the current window."
+                }
+              }
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "optional": true,
+              "parameters": [
+                {
+                  "type": "boolean"
+                }
+              ]
+            }
+          ]
         }
       ],
       "events": [

package/schemas/release/webext.json

@@ -9721,13 +9721,24 @@
             }
           ]
         },
+        {
+          "$extend": "OptionalPermission",
+          "choices": [
+            {
+              "type": "string",
+              "enum": [
+                "declarativeNetRequestFeedback"
+              ],
+              "min_manifest_version": 3
+            }
+          ]
+        },
         {
           "$extend": "PermissionNoPrompt",
           "choices": [
             {
               "type": "string",
               "enum": [
-                "declarativeNetRequestFeedback",
                 "declarativeNetRequestWithHostAccess"
               ],
               "min_manifest_version": 3
@@ -9811,6 +9822,15 @@
             "other"
           ]
         },
+        {
+          "id": "UnsupportedRegexReason",
+          "type": "string",
+          "description": "Describes the reason why a given regular expression isn't supported.",
+          "enum": [
+            "syntaxError",
+            "memoryLimitExceeded"
+          ]
+        },
         {
           "id": "MatchedRule",
           "type": "object",
@@ -10093,7 +10113,7 @@
                     "regexSubstitution": {
                       "type": "string",
                       "optional": true,
-                      "description": "TODO with regexFilter + Substitution pattern for rules which specify a 'regexFilter'."
+                      "description": "Substitution pattern for rules which specify a 'regexFilter'. The first match of regexFilter within the url will be replaced with this pattern. Within regexSubstitution, backslash-escaped digits (\\1 to \\9) can be used to insert the corresponding capture groups. \\0 refers to the entire matching text."
                     }
                   }
                 },
@@ -10349,6 +10369,57 @@
             }
           ]
         },
+        {
+          "name": "isRegexSupported",
+          "type": "function",
+          "description": "Checks if the given regular expression will be supported as a 'regexFilter' rule condition.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "regexOptions",
+              "type": "object",
+              "properties": {
+                "regex": {
+                  "type": "string",
+                  "description": "The regular expresson to check."
+                },
+                "isCaseSensitive": {
+                  "type": "boolean",
+                  "optional": true,
+                  "description": "Whether the 'regex' specified is case sensitive.",
+                  "default": false
+                },
+                "requireCapturing": {
+                  "type": "boolean",
+                  "optional": true,
+                  "description": "Whether the 'regex' specified requires capturing. Capturing is only required for redirect rules which specify a 'regexSubstition' action.",
+                  "default": false
+                }
+              }
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "parameters": [
+                {
+                  "name": "result",
+                  "type": "object",
+                  "properties": {
+                    "isSupported": {
+                      "type": "boolean",
+                      "description": "Whether the given regex is supported"
+                    },
+                    "reason": {
+                      "$ref": "UnsupportedRegexReason",
+                      "optional": true,
+                      "description": "Specifies the reason why the regular expression is not supported. Only provided if 'isSupported' is false."
+                    }
+                  }
+                }
+              ]
+            }
+          ]
+        },
         {
           "name": "testMatchOutcome",
           "type": "function",
@@ -10447,6 +10518,10 @@
           "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."
         },
+        "MAX_NUMBER_OF_REGEX_RULES": {
+          "type": "number",
+          "description": "The maximum number of regular expression rules that an extension can add. This limit is evaluated separately for the set of session rules, dynamic rules and those specified in the rule_resources file."
+        },
         "SESSION_RULESET_ID": {
           "type": "string",
           "value": "_session",
@@ -12415,7 +12490,7 @@
             "mainthreadio",
             "fileio",
             "fileioall",
-            "noiostacks",
+            "nomarkerstacks",
             "screenshots",
             "seqstyle",
             "stackwalk",
@@ -13572,6 +13647,14 @@
                         "$ref": "ExtensionURL"
                       }
                     },
+                    "type": {
+                      "optional": true,
+                      "type": "string",
+                      "enum": [
+                        "module",
+                        "classic"
+                      ]
+                    },
                     "persistent": {
                       "optional": true,
                       "type": "boolean",
@@ -20148,6 +20231,26 @@
               },
               "description": "list of reasons that cause the request to be considered weak, if state is \"weak\"",
               "optional": true
+            },
+            "usedEch": {
+              "type": "boolean",
+              "description": "True if the TLS connection used Encrypted Client Hello.",
+              "optional": true
+            },
+            "usedDelegatedCredentials": {
+              "type": "boolean",
+              "description": "True if the TLS connection used Delegated Credentials.",
+              "optional": true
+            },
+            "usedOcsp": {
+              "type": "boolean",
+              "description": "True if the TLS connection made OCSP requests.",
+              "optional": true
+            },
+            "usedPrivateDns": {
+              "type": "boolean",
+              "description": "True if the TLS connection used a privacy-preserving DNS transport like DNS-over-HTTPS.",
+              "optional": true
             }
           }
         },