webext-schema 5.3.3 → 5.3.4

package/package.json

@@ -23,12 +23,12 @@
     "@types/firefox-webext-browser": "^120.0.3",
     "@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.9",
+    "eslint-plugin-jsdoc": "^48.2.11",
     "eslint-plugin-regexp": "^2.6.0",
     "eslint-plugin-unicorn": "^53.0.0",
     "mocha": "^10.4.0",
@@ -54,5 +54,5 @@
     "update-mail": "node index update --channel=mail -i",
     "update-release": "node index update --channel=release -i"
   },
-  "version": "5.3.3"
+  "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/mail/mailext.json

@@ -3174,7 +3174,7 @@
               "optional": true,
               "default": false,
               "type": "boolean",
-              "description": "Specifies whether the returned :ref:`accounts.MailAccount` objects should included their account's folders. Defaults to <value>false</value>."
+              "description": "Specifies whether the returned :ref:`accounts.MailAccount` objects should include their account's folders. Defaults to <value>false</value>."
             },
             {
               "type": "function",
@@ -3203,7 +3203,7 @@
               "optional": true,
               "default": true,
               "type": "boolean",
-              "description": "Specifies whether the returned :ref:`accounts.MailAccount` objects should included their account's folders. Defaults to <value>true</value>."
+              "description": "Specifies whether the returned :ref:`accounts.MailAccount` objects should include their account's folders. Defaults to <value>true</value>."
             },
             {
               "type": "function",
@@ -8444,7 +8444,7 @@
             "quota": {
               "type": "array",
               "items": {
-                "$ref": "MailFolderQuota"
+                "$ref": "folders.MailFolderQuota"
               },
               "optional": true,
               "description": "Quota information, if available."
@@ -10488,6 +10488,37 @@
             }
           ]
         },
+        {
+          "name": "getSelectedFolders",
+          "type": "function",
+          "description": "Lists the selected folders in the folder pane.",
+          "permissions": [
+            "accountsRead"
+          ],
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "tabId",
+              "type": "integer",
+              "description": "Defaults to the active tab of the current window.",
+              "optional": true,
+              "minimum": 1
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "optional": true,
+              "parameters": [
+                {
+                  "type": "array",
+                  "items": {
+                    "$ref": "folders.MailFolder"
+                  }
+                }
+              ]
+            }
+          ]
+        },
         {
           "name": "getSelectedMessages",
           "type": "function",
@@ -10839,18 +10870,19 @@
             "selectedMessages": {
               "$ref": "messages.MessageList",
               "optional": true,
-              "description": "The selected message(s), if the context menu was opened in the message list. The <permission>messagesRead</permission> permission is required."
+              "description": "The selected message(s) in the message list (a.k.a. the thread pane). Only available for the `message_list` context. The <permission>messagesRead</permission> permission is required. The returned selection includes the messages which would be affected by a context action through Thunderbirds UI, which may not be the actuall selected messages. For example, if the user has multiple messages selected and opens the context menu for a message outside that selection, only the message for which the context menu was opened, is returned."
             },
             "displayedFolder": {
               "$ref": "folders.MailFolder",
               "optional": true,
-              "description": "The displayed folder, if the context menu was opened in the message list. The <permission>accountsRead</permission> permission is required."
+              "description": "The displayed folder. Only available for the `message_list` context. The <permission>accountsRead</permission> permission is required."
             },
             "selectedFolder": {
               "$ref": "folders.MailFolder",
               "max_manifest_version": 2,
               "optional": true,
-              "description": "The selected folder, if the context menu was opened in the folder pane. The <permission>accountsRead</permission> permission is required."
+              "deprecated": "Deprecated since Thunderbird 128 and removed in Manifest V3: The selectedFolder property has been replaced by the selectedFolders property.",
+              "description": "The selected folder in the folder pane (where the context menu was opened). Only available for the `folder_pane` context. The <permission>accountsRead</permission> permission is required."
             },
             "selectedFolders": {
               "type": "array",
@@ -10858,13 +10890,14 @@
                 "$ref": "folders.MailFolder"
               },
               "optional": true,
-              "description": "The selected folder(s), if the context menu was opened in the folder pane. The <permission>accountsRead</permission> permission is required."
+              "description": "The selected folders in the folder pane. Only available for the `folder_pane` context. The <permission>accountsRead</permission> permission is required. The returned selection includes the folders which would be affected by a context action through Thunderbirds UI, which may not be the actuall selected folders. For example, if the user has multiple folders selected and opens the context menu for a folder outside that selection, only the folder for which the context menu was opened, is returned."
             },
             "selectedAccount": {
               "$ref": "accounts.MailAccount",
               "max_manifest_version": 2,
               "optional": true,
-              "description": "The selected account, if the context menu was opened on an account entry in the folder pane. The <permission>accountsRead</permission> permission is required."
+              "deprecated": "Deprecated since Thunderbird 128 and removed in Manifest V3: The selectedAccount property has been replaced by the selectedFolders property, returning the root folder of the account.",
+              "description": "The selected account in the folder pane, if the context menu was opened on an account entry. Only available for the `folder_pane` context. The <permission>accountsRead</permission> permission is required."
             },
             "attachments": {
               "type": "array",
@@ -11011,18 +11044,19 @@
             "selectedMessages": {
               "$ref": "messages.MessageList",
               "optional": true,
-              "description": "The selected message(s), if the context menu was opened in the message list. The <permission>messagesRead</permission> permission is required."
+              "description": "The selected message(s) in the message list (a.k.a. the thread pane). Only available for the `message_list` context. The <permission>messagesRead</permission> permission is required. The returned selection includes the messages which would be affected by a context action through Thunderbirds UI, which may not be the actuall selected messages. For example, if the user has multiple messages selected and opens the context menu for a message outside that selection, only the message for which the context menu was opened, is returned."
             },
             "displayedFolder": {
               "$ref": "folders.MailFolder",
               "optional": true,
-              "description": "The displayed folder, if the context menu was opened in the message list. The <permission>accountsRead</permission> permission is required."
+              "description": "The displayed folder. Only available for the `message_list` context. The <permission>accountsRead</permission> permission is required."
             },
             "selectedFolder": {
               "$ref": "folders.MailFolder",
               "max_manifest_version": 2,
               "optional": true,
-              "description": "The selected folder, if the context menu was opened in the folder pane. The <permission>accountsRead</permission> permission is required."
+              "deprecated": "Deprecated since Thunderbird 128 and removed in Manifest V3: The selectedFolder property has been replaced by the selectedFolders property.",
+              "description": "The selected folder in the folder pane (where the context menu was opened). Only available for the `folder_pane` context. The <permission>accountsRead</permission> permission is required."
             },
             "selectedFolders": {
               "type": "array",
@@ -11030,13 +11064,14 @@
                 "$ref": "folders.MailFolder"
               },
               "optional": true,
-              "description": "The selected folder(s), if the context menu was opened in the folder pane. The <permission>accountsRead</permission> permission is required."
+              "description": "The selected folders in the folder pane. Only available for the `folder_pane` context. The <permission>accountsRead</permission> permission is required. The returned selection includes the folders which would be affected by a context action through Thunderbirds UI, which may not be the actuall selected folders. For example, if the user has multiple folders selected and opens the context menu for a folder outside that selection, only the folder for which the context menu was opened, is returned."
             },
             "selectedAccount": {
               "$ref": "accounts.MailAccount",
               "max_manifest_version": 2,
               "optional": true,
-              "description": "The selected account, if the context menu was opened on an account entry in the folder pane. The <permission>accountsRead</permission> permission is required."
+              "deprecated": "Deprecated since Thunderbird 128 and removed in Manifest V3: The selectedAccount property has been replaced by the selectedFolders property, returning the root folder of the account.",
+              "description": "The selected account in the folder pane, if the context menu was opened on an account entry. Only available for the `folder_pane` context. The <permission>accountsRead</permission> permission is required."
             },
             "attachments": {
               "type": "array",
@@ -11558,11 +11593,17 @@
               "$ref": "tabs.Tab"
             },
             {
+              "max_manifest_version": 2,
               "name": "messages",
               "type": "array",
               "items": {
                 "$ref": "messages.MessageHeader"
               }
+            },
+            {
+              "min_manifest_version": 3,
+              "name": "displayedMessages",
+              "$ref": "messages.MessageList"
             }
           ]
         }
@@ -11618,10 +11659,19 @@
               "optional": true,
               "parameters": [
                 {
-                  "type": "array",
-                  "items": {
-                    "$ref": "messages.MessageHeader"
-                  }
+                  "choices": [
+                    {
+                      "max_manifest_version": 2,
+                      "type": "array",
+                      "items": {
+                        "$ref": "messages.MessageHeader"
+                      }
+                    },
+                    {
+                      "min_manifest_version": 3,
+                      "$ref": "messages.MessageList"
+                    }
+                  ]
                 }
               ]
             }
@@ -12552,6 +12602,21 @@
           "minimum": 1,
           "description": "A unique id representing a :ref:`messages.MessageHeader` and the associated message. This id doesn’t refer to the Message-ID email header. It is an internal tracking number that does not remain after a restart. Nor does it follow an email that has been moved to a different folder."
         },
+        {
+          "id": "InlineTextPart",
+          "type": "object",
+          "description": "An inline part with content type <value>text/*</value>. These parts are not returned by :ref:`listAttachments` and usually make up the readable content of the message, mostly with content type <value>text/plain</value> or <value>text/html</value>",
+          "properties": {
+            "contentType": {
+              "type": "string",
+              "description": "The content type of the part. Most common types for inline text parts are <value>text/plain</value> and <value>text/html</value>. Possible other (deprecated) types are <value>text/richtext</value> and <value>text/enriched</value>. Some calendaring services include an inline text part with type <value>text/calendar</value>."
+            },
+            "content": {
+              "type": "string",
+              "description": "The content of this inline text part."
+            }
+          }
+        },
         {
           "id": "MessageHeader",
           "type": "object",
@@ -12663,7 +12728,7 @@
             "messages": {
               "type": "array",
               "items": {
-                "$ref": "MessageHeader"
+                "$ref": "messages.MessageHeader"
               }
             }
           }
@@ -12717,7 +12782,7 @@
             "parts": {
               "type": "array",
               "items": {
-                "$ref": "MessagePart"
+                "$ref": "messages.MessagePart"
               },
               "description": "Any sub-parts of this part.",
               "optional": true
@@ -12725,7 +12790,7 @@
             "size": {
               "type": "integer",
               "optional": true,
-              "description": "The size of this part. The size of <em>message/*</em> parts is not the actual message size (on disc), but the total size of its decoded body parts, excluding headers."
+              "description": "The size of this part. The size of parts with content type <em>message/rfc822</em> is not the actual message size (on disc), but the total size of its decoded body parts, excluding headers."
             }
           }
         },
@@ -13019,7 +13084,7 @@
               "optional": true,
               "parameters": [
                 {
-                  "$ref": "MessageHeader"
+                  "$ref": "messages.MessageHeader"
                 }
               ]
             }
@@ -13053,7 +13118,7 @@
               "optional": true,
               "parameters": [
                 {
-                  "$ref": "MessagePart"
+                  "$ref": "messages.MessagePart"
                 }
               ]
             }
@@ -13143,7 +13208,32 @@
                 {
                   "type": "array",
                   "items": {
-                    "$ref": "MessageAttachment"
+                    "$ref": "messages.MessageAttachment"
+                  }
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "listInlineTextParts",
+          "type": "function",
+          "description": "Lists all inline text parts of a message. These parts are not returned by :ref:`listAttachments` and usually make up the readable content of the message, mostly with content type <value>text/plain</value> or <value>text/html</value>. If a message only includes a <value>text/html</value> part, the method :ref:`messengerUtilities.convertToPlainText` can be used to retreive a plain text version. \n\n**Note:** A message usually contains only one inline text part per subtype, but technically messages can contain multiple inline text parts per subtype.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "messageId",
+              "$ref": "messages.MessageId"
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "optional": true,
+              "parameters": [
+                {
+                  "type": "array",
+                  "items": {
+                    "$ref": "messages.InlineTextPart"
                   }
                 }
               ]
@@ -13415,7 +13505,7 @@
             },
             {
               "name": "newProperties",
-              "$ref": "MessageProperties"
+              "$ref": "messages.MessageProperties"
             }
           ]
         },