webext-schema 5.2.0 → 5.2.2

package/package.json

@@ -21,25 +21,20 @@
   },
   "devDependencies": {
     "@types/firefox-webext-browser": "^111.0.1",
-    "@types/node": "^20.3.3",
-    "@types/sinon": "^10.0.15",
-    "c8": "^8.0.0",
-    "chai": "^4.3.7",
-    "eslint": "^8.44.0",
+    "@types/node": "^20.5.7",
+    "@types/sinon": "^10.0.16",
+    "c8": "^8.0.1",
+    "chai": "^4.3.8",
+    "eslint": "^8.48.0",
     "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsdoc": "^46.4.3",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-jsdoc": "^46.5.1",
     "eslint-plugin-regexp": "^1.15.0",
-    "eslint-plugin-unicorn": "^47.0.0",
+    "eslint-plugin-unicorn": "^48.0.1",
     "mocha": "^10.2.0",
     "npm-run-all": "^4.1.5",
-    "typescript": "^5.1.6",
-    "undici": "^5.22.1"
-  },
-  "overrides": {
-    "semver": "^7.5.2"
+    "typescript": "^5.2.2",
+    "undici": "^5.23.0"
   },
   "scripts": {
     "build": "npm run tsc && npm run lint && npm run test",
@@ -59,5 +54,5 @@
     "update-mail": "node index update --channel=mail -i",
     "update-release": "node index update --channel=release -i"
   },
-  "version": "5.2.0"
+  "version": "5.2.2"
 }

package/schemas/beta/webext.json

@@ -12575,7 +12575,8 @@
             "unregisteredthreads",
             "processcpu",
             "power",
-            "responsiveness"
+            "responsiveness",
+            "cpufreq"
           ]
         },
         {

package/schemas/central/webext.json

@@ -12575,7 +12575,8 @@
             "unregisteredthreads",
             "processcpu",
             "power",
-            "responsiveness"
+            "responsiveness",
+            "cpufreq"
           ]
         },
         {

package/schemas/mail/mailext.json

@@ -10926,20 +10926,58 @@
         {
           "name": "getRaw",
           "type": "function",
-          "description": "Returns the unmodified source of a message as a `binary string <|link-binary-string|>`__, which is a simple series of 8-bit values. Throws if the message could not be read, for example due to network issues. If the message contains non-ASCII characters, the body parts in the binary string cannot be read directly and must be decoded according to their character sets. Use :ref:`messages.getFull` to get the correctly decoded parts. Manually decoding the raw message is probably too error-prone, especially if the message contains MIME parts with different character set encodings or attachments.\n\nTo get a readable version of the raw message as it appears in Thunderbird's message source view, it may be sufficient to decode the message according to the character set specified in its main `content-type <|link-content-type|>`__ header (example: <value>text/html; charset=UTF-8</value>) using the following function (see MDN for `supported input encodings <|link-input-encoding|>`__): <literalinclude>includes/messages/decodeBinaryString.js<lang>JavaScript</lang></literalinclude>",
+          "description": "Returns the unmodified source of a message. Throws if the message could not be read, for example due to network issues.",
           "async": "callback",
           "parameters": [
             {
               "name": "messageId",
               "type": "integer"
             },
+            {
+              "name": "options",
+              "type": "object",
+              "properties": {
+                "data_format": {
+                  "choices": [
+                    {
+                      "max_manifest_version": 2,
+                      "description": "The message can either be returned as a DOM File or as a `binary string <|link-binary-string|>`__. The historic default is to return a binary string (kept for backward compatibility). However, it is now recommended to use the ``File`` format, because the DOM File object can be used as-is with the downloads API and has useful methods to access the content, like `File.text() <|link-DOMFile-text|>`__ and `File.arrayBuffer() <|link-DOMFile-arrayBuffer|>`__. Working with binary strings is error prone and needs special handling: <literalinclude>includes/messages/decodeBinaryString.js<lang>JavaScript</lang></literalinclude> (see MDN for `supported input encodings <|link-input-encoding|>`__).",
+                      "type": "string",
+                      "enum": [
+                        "File",
+                        "BinaryString"
+                      ]
+                    },
+                    {
+                      "min_manifest_version": 3,
+                      "description": "The message can either be returned as a DOM File (default) or as a `binary string <|link-binary-string|>`__. It is recommended to use the ``File`` format, because the DOM File object can be used as-is with the downloads API and has useful methods to access the content, like `File.text() <|link-DOMFile-text|>`__ and `File.arrayBuffer() <|link-DOMFile-arrayBuffer|>`__. Working with binary strings is error prone and needs special handling: <literalinclude>includes/messages/decodeBinaryString.js<lang>JavaScript</lang></literalinclude> (see MDN for `supported input encodings <|link-input-encoding|>`__).",
+                      "type": "string",
+                      "enum": [
+                        "File",
+                        "BinaryString"
+                      ]
+                    }
+                  ]
+                }
+              },
+              "optional": true
+            },
             {
               "type": "function",
               "name": "callback",
               "optional": true,
               "parameters": [
                 {
-                  "type": "string"
+                  "choices": [
+                    {
+                      "type": "string"
+                    },
+                    {
+                      "type": "object",
+                      "isInstanceOf": "File",
+                      "additionalProperties": true
+                    }
+                  ]
                 }
               ]
             }

package/schemas/release/webext.json

@@ -4463,6 +4463,11 @@
               "optional": true,
               "description": "Whether the tab has produced sound over the past couple of seconds (but it might not be heard if also muted). Equivalent to whether the speaker audio indicator is showing."
             },
+            "autoDiscardable": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Whether the tab can be discarded automatically by the browser when resources are low."
+            },
             "mutedInfo": {
               "$ref": "MutedInfo",
               "optional": true,
@@ -4764,6 +4769,7 @@
           "enum": [
             "attention",
             "audible",
+            "autoDiscardable",
             "discarded",
             "favIconUrl",
             "hidden",
@@ -5095,6 +5101,11 @@
                   "optional": true,
                   "description": "Whether the tabs are audible."
                 },
+                "autoDiscardable": {
+                  "type": "boolean",
+                  "optional": true,
+                  "description": "Whether the tab can be discarded automatically by the browser when resources are low."
+                },
                 "muted": {
                   "type": "boolean",
                   "optional": true,
@@ -5312,6 +5323,11 @@
                   "optional": true,
                   "description": "Whether the tab should be active. Does not affect whether the window is focused (see $(ref:windows.update))."
                 },
+                "autoDiscardable": {
+                  "type": "boolean",
+                  "optional": true,
+                  "description": "Whether the tab can be discarded automatically by the browser when resources are low."
+                },
                 "highlighted": {
                   "type": "boolean",
                   "optional": true,
@@ -6058,6 +6074,11 @@
                   "optional": true,
                   "description": "The tab's new audible state."
                 },
+                "autoDiscardable": {
+                  "type": "boolean",
+                  "optional": true,
+                  "description": "The tab's new autoDiscardable state."
+                },
                 "discarded": {
                   "type": "boolean",
                   "optional": true,
@@ -7860,6 +7881,32 @@
             }
           ]
         },
+        {
+          "name": "getUserSettings",
+          "type": "function",
+          "description": "Returns the user-specified settings relating to an extension's action.",
+          "async": "callback",
+          "parameters": [
+            {
+              "type": "function",
+              "name": "callback",
+              "parameters": [
+                {
+                  "name": "userSettings",
+                  "type": "object",
+                  "properties": {
+                    "isOnToolbar": {
+                      "type": "boolean",
+                      "optional": true,
+                      "description": "Whether the extension's action icon is visible on browser windows' top-level toolbar (i.e., whether the extension has been 'pinned' by the user)."
+                    }
+                  },
+                  "description": "The collection of user-specified settings relating to an extension's action."
+                }
+              ]
+            }
+          ]
+        },
         {
           "name": "setIcon",
           "type": "function",
@@ -16263,14 +16310,14 @@
         {
           "name": "setUninstallURL",
           "type": "function",
-          "description": "Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics, and implement surveys. Maximum 255 characters.",
+          "description": "Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics, and implement surveys. Maximum 1023 characters.",
           "async": "callback",
           "parameters": [
             {
               "type": "string",
               "name": "url",
               "optional": true,
-              "maxLength": 255,
+              "maxLength": 1023,
               "description": "URL to be opened after the extension is uninstalled. This URL must have an http: or https: scheme. Set an empty string to not open a new tab upon uninstallation."
             },
             {
@@ -19543,12 +19590,10 @@
                   "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab."
                 },
                 "transitionType": {
-                  "unsupported": true,
                   "$ref": "TransitionType",
                   "description": "Cause of the navigation."
                 },
                 "transitionQualifiers": {
-                  "unsupported": true,
                   "type": "array",
                   "description": "A list of transition qualifiers.",
                   "items": {
@@ -19770,12 +19815,10 @@
                   "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab."
                 },
                 "transitionType": {
-                  "unsupported": true,
                   "$ref": "TransitionType",
                   "description": "Cause of the navigation."
                 },
                 "transitionQualifiers": {
-                  "unsupported": true,
                   "type": "array",
                   "description": "A list of transition qualifiers.",
                   "items": {
@@ -19849,12 +19892,10 @@
                   "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab."
                 },
                 "transitionType": {
-                  "unsupported": true,
                   "$ref": "TransitionType",
                   "description": "Cause of the navigation."
                 },
                 "transitionQualifiers": {
-                  "unsupported": true,
                   "type": "array",
                   "description": "A list of transition qualifiers.",
                   "items": {