webext-schema 5.1.0 → 5.1.2

package/README.md

@@ -1,14 +1,10 @@
 [![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)
-<!--
-[![dependencies Status](https://david-dm.org/asamuzaK/webext-schema/status.svg)](https://david-dm.org/asamuzaK/webext-schema)
-[![devDependencies Status](https://david-dm.org/asamuzaK/webext-schema/dev-status.svg)](https://david-dm.org/asamuzaK/webext-schema?type=dev)
--->
-[![npm version](https://badge.fury.io/js/webext-schema.svg)](https://badge.fury.io/js/webext-schema)
+[![npm](https://img.shields.io/npm/v/webext-schema)](https://www.npmjs.com/package/webext-schema)
 
 # webext-schema
 
-WebExtensions schemas and MailExtensions schemas fetched from [hg.mozilla.org](https://hg.mozilla.org/).
+[WebExtentions](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions "Browser Extensions - Mozilla | MDN") schemas and [MailExtensions](https://developer.thunderbird.net/add-ons/mailextensions "A Guide to Extensions - Thunderbird") schemas fetched from [hg.mozilla.org](https://hg.mozilla.org/).
 Stubbed browser API is also available.
 
 ## Install

package/index.js

@@ -1,5 +1,9 @@
-/**
- * index.js
+/*!
+ * webext-schema
+ *
+ * @license MPL-2.0
+ * @copyright asamuzaK (Kazz)
+ * @see {@link https://github.com/asamuzaK/webext-schema/blob/master/LICENSE}
  */
 
 /* api */

package/package.json

@@ -2,31 +2,15 @@
   "name": "webext-schema",
   "description": "WebExtensions schemas fetched from hg.mozilla.org",
   "author": "asamuzaK",
+  "license": "MPL-2.0",
   "homepage": "https://github.com/asamuzaK/webext-schema",
   "bugs": "https://github.com/asamuzaK/webext-schema/issues",
   "repository": {
     "type": "git",
     "url": "https://github.com/asamuzaK/webext-schema.git"
   },
-  "license": "MPL-2.0",
-  "main": "index.js",
   "type": "module",
-  "scripts": {
-    "lint": "eslint --fix .",
-    "start": "node index",
-    "test": "npm run test-central",
-    "test-beta": "c8 mocha --require=test/mocha/setup.js --channel=beta --exit test/*.test.js",
-    "test-central": "c8 mocha --require=test/mocha/setup.js --channel=central --exit test/*.test.js",
-    "test-esr": "c8 mocha --require=test/mocha/setup.js --channel=esr --exit test/*.test.js",
-    "test-release": "c8 mocha --require=test/mocha/setup.js --channel=release --exit test/*.test.js",
-    "test_all": "npm-run-all -s test-*",
-    "update": "node index update -i",
-    "update-beta": "node index update --channel=beta -i",
-    "update-central": "node index update --channel=central -i",
-    "update-esr": "node index update --channel=esr -i",
-    "update-mail": "node index update --channel=mail -i",
-    "update-release": "node index update --channel=release -i"
-  },
+  "main": "index.js",
   "dependencies": {
     "camelize": "^1.0.1",
     "commander": "^10.0.0",
@@ -37,16 +21,32 @@
   "devDependencies": {
     "c8": "^7.12.0",
     "chai": "^4.3.7",
-    "eslint": "^8.32.0",
+    "eslint": "^8.34.0",
     "eslint-config-standard": "^17.0.0",
-    "eslint-plugin-import": "^2.27.4",
-    "eslint-plugin-jsdoc": "^39.6.4",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jsdoc": "^40.0.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-unicorn": "^45.0.2",
     "mocha": "^10.2.0",
     "npm-run-all": "^4.1.5",
-    "undici": "^5.15.0"
+    "undici": "^5.19.1"
+  },
+  "scripts": {
+    "lint": "eslint --fix .",
+    "start": "node index",
+    "test": "npm run test-central",
+    "test-beta": "c8 mocha --require=test/mocha/setup.js --channel=beta --exit test/*.test.js",
+    "test-central": "c8 mocha --require=test/mocha/setup.js --channel=central --exit test/*.test.js",
+    "test-esr": "c8 mocha --require=test/mocha/setup.js --channel=esr --exit test/*.test.js",
+    "test-release": "c8 mocha --require=test/mocha/setup.js --channel=release --exit test/*.test.js",
+    "test_all": "npm-run-all -s test-*",
+    "update": "node index update -i",
+    "update-beta": "node index update --channel=beta -i",
+    "update-central": "node index update --channel=central -i",
+    "update-esr": "node index update --channel=esr -i",
+    "update-mail": "node index update --channel=mail -i",
+    "update-release": "node index update --channel=release -i"
   },
-  "version": "5.1.0"
+  "version": "5.1.2"
 }

package/schemas/beta/webext.json

@@ -1898,6 +1898,11 @@
                   "description": "Find only ranges with case sensitive match.",
                   "optional": true
                 },
+                "matchDiacritics": {
+                  "type": "boolean",
+                  "description": "Find only ranges with diacritic sensitive match.",
+                  "optional": true
+                },
                 "entireWord": {
                   "type": "boolean",
                   "description": "Find only ranges that match entire word.",
@@ -3577,6 +3582,16 @@
               "format": "url"
             }
           }
+        },
+        {
+          "id": "Disposition",
+          "type": "string",
+          "description": "Location where search results should be displayed.",
+          "enum": [
+            "CURRENT_TAB",
+            "NEW_TAB",
+            "NEW_WINDOW"
+          ]
         }
       ],
       "functions": [
@@ -3606,12 +3621,51 @@
                   "optional": true,
                   "description": "Search engine to use. Uses the default if not specified."
                 },
+                "disposition": {
+                  "$ref": "Disposition",
+                  "optional": true,
+                  "description": "Location where search results should be displayed. NEW_TAB is the default."
+                },
+                "tabId": {
+                  "type": "integer",
+                  "optional": true,
+                  "description": "The ID of the tab for the search results. If not specified, a new tab is created, unless disposition is set. tabId cannot be used with disposition."
+                }
+              }
+            }
+          ]
+        },
+        {
+          "name": "query",
+          "type": "function",
+          "async": "callback",
+          "description": "Use the chrome.search API to search via the default provider.",
+          "parameters": [
+            {
+              "type": "object",
+              "name": "queryInfo",
+              "properties": {
+                "text": {
+                  "type": "string",
+                  "description": "String to query with the default search provider."
+                },
+                "disposition": {
+                  "$ref": "Disposition",
+                  "optional": true,
+                  "description": "Location where search results should be displayed. CURRENT_TAB is the default."
+                },
                 "tabId": {
                   "type": "integer",
                   "optional": true,
-                  "description": "The ID of the tab for the search results. If not specified, a new tab is created."
+                  "description": "Location where search results should be displayed. tabId cannot be used with disposition."
                 }
               }
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "optional": true,
+              "parameters": []
             }
           ]
         }
@@ -9898,7 +9952,7 @@
                 "isUrlFilterCaseSensitive": {
                   "type": "boolean",
                   "optional": true,
-                  "description": "Whether 'urlFilter' or 'regexFilter' is case-sensitive. Defaults to true."
+                  "description": "Whether 'urlFilter' or 'regexFilter' is case-sensitive."
                 },
                 "initiatorDomains": {
                   "type": "array",
@@ -10370,7 +10424,35 @@
             }
           ]
         }
-      ]
+      ],
+      "properties": {
+        "DYNAMIC_RULESET_ID": {
+          "type": "string",
+          "value": "_dynamic",
+          "description": "Ruleset ID for the dynamic rules added by the extension."
+        },
+        "GUARANTEED_MINIMUM_STATIC_RULES": {
+          "type": "number",
+          "description": "The minimum number of static rules guaranteed to an extension across its enabled static rulesets. Any rules above this limit will count towards the global static rule limit."
+        },
+        "MAX_NUMBER_OF_STATIC_RULESETS": {
+          "type": "number",
+          "description": "The maximum number of static Rulesets an extension can specify as part of the rule_resources manifest key."
+        },
+        "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."
+        },
+        "SESSION_RULESET_ID": {
+          "type": "string",
+          "value": "_session",
+          "description": "Ruleset ID for the session-scoped rules added by the extension."
+        }
+      }
     }
   ],
   "dns.json": [
@@ -12339,7 +12421,6 @@
             "stackwalk",
             "jsallocations",
             "nostacksampling",
-            "preferencereads",
             "nativeallocations",
             "ipcmessages",
             "audiocallbacktracing",
@@ -13690,12 +13771,6 @@
           "description": "Represents a WebExtension language pack manifest.json file",
           "$import": "ManifestBase",
           "properties": {
-            "homepage_url": {
-              "type": "string",
-              "format": "url",
-              "optional": true,
-              "preprocess": "localize"
-            },
             "langpack_id": {
               "type": "string",
               "pattern": "^[a-zA-Z][a-zA-Z-]+$"
@@ -13763,12 +13838,6 @@
           "description": "Represents a WebExtension dictionary manifest.json file",
           "$import": "ManifestBase",
           "properties": {
-            "homepage_url": {
-              "type": "string",
-              "format": "url",
-              "optional": true,
-              "preprocess": "localize"
-            },
             "dictionaries": {
               "type": "object",
               "patternProperties": {

package/schemas/central/webext.json

@@ -3582,6 +3582,16 @@
               "format": "url"
             }
           }
+        },
+        {
+          "id": "Disposition",
+          "type": "string",
+          "description": "Location where search results should be displayed.",
+          "enum": [
+            "CURRENT_TAB",
+            "NEW_TAB",
+            "NEW_WINDOW"
+          ]
         }
       ],
       "functions": [
@@ -3611,14 +3621,53 @@
                   "optional": true,
                   "description": "Search engine to use. Uses the default if not specified."
                 },
+                "disposition": {
+                  "$ref": "Disposition",
+                  "optional": true,
+                  "description": "Location where search results should be displayed. NEW_TAB is the default."
+                },
                 "tabId": {
                   "type": "integer",
                   "optional": true,
-                  "description": "The ID of the tab for the search results. If not specified, a new tab is created."
+                  "description": "The ID of the tab for the search results. If not specified, a new tab is created, unless disposition is set. tabId cannot be used with disposition."
                 }
               }
             }
           ]
+        },
+        {
+          "name": "query",
+          "type": "function",
+          "async": "callback",
+          "description": "Use the chrome.search API to search via the default provider.",
+          "parameters": [
+            {
+              "type": "object",
+              "name": "queryInfo",
+              "properties": {
+                "text": {
+                  "type": "string",
+                  "description": "String to query with the default search provider."
+                },
+                "disposition": {
+                  "$ref": "Disposition",
+                  "optional": true,
+                  "description": "Location where search results should be displayed. CURRENT_TAB is the default."
+                },
+                "tabId": {
+                  "type": "integer",
+                  "optional": true,
+                  "description": "Location where search results should be displayed. tabId cannot be used with disposition."
+                }
+              }
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "optional": true,
+              "parameters": []
+            }
+          ]
         }
       ]
     }
@@ -9903,7 +9952,7 @@
                 "isUrlFilterCaseSensitive": {
                   "type": "boolean",
                   "optional": true,
-                  "description": "Whether 'urlFilter' or 'regexFilter' is case-sensitive. Defaults to true."
+                  "description": "Whether 'urlFilter' or 'regexFilter' is case-sensitive."
                 },
                 "initiatorDomains": {
                   "type": "array",
@@ -10375,7 +10424,25 @@
             }
           ]
         }
-      ]
+      ],
+      "properties": {
+        "GUARANTEED_MINIMUM_STATIC_RULES": {
+          "type": "number",
+          "description": "The minimum number of static rules guaranteed to an extension across its enabled static rulesets. Any rules above this limit will count towards the global static rule limit."
+        },
+        "MAX_NUMBER_OF_STATIC_RULESETS": {
+          "type": "number",
+          "description": "The maximum number of static Rulesets an extension can specify as part of the rule_resources manifest key."
+        },
+        "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."
+        }
+      }
     }
   ],
   "dns.json": [
@@ -12344,7 +12411,6 @@
             "stackwalk",
             "jsallocations",
             "nostacksampling",
-            "preferencereads",
             "nativeallocations",
             "ipcmessages",
             "audiocallbacktracing",
@@ -13695,12 +13761,6 @@
           "description": "Represents a WebExtension language pack manifest.json file",
           "$import": "ManifestBase",
           "properties": {
-            "homepage_url": {
-              "type": "string",
-              "format": "url",
-              "optional": true,
-              "preprocess": "localize"
-            },
             "langpack_id": {
               "type": "string",
               "pattern": "^[a-zA-Z][a-zA-Z-]+$"
@@ -13768,12 +13828,6 @@
           "description": "Represents a WebExtension dictionary manifest.json file",
           "$import": "ManifestBase",
           "properties": {
-            "homepage_url": {
-              "type": "string",
-              "format": "url",
-              "optional": true,
-              "preprocess": "localize"
-            },
             "dictionaries": {
               "type": "object",
               "patternProperties": {

package/schemas/mail/mailext.json

@@ -8564,24 +8564,25 @@
               "type": "string",
               "enum": [
                 "all",
-                "page",
-                "frame",
-                "selection",
-                "link",
-                "editable",
-                "password",
-                "image",
-                "video",
+                "all_message_attachments",
                 "audio",
                 "compose_action",
-                "message_display_action",
-                "tab",
-                "message_list",
-                "folder_pane",
                 "compose_attachments",
+                "compose_body",
+                "editable",
+                "folder_pane",
+                "frame",
+                "image",
+                "link",
                 "message_attachments",
-                "all_message_attachments",
-                "tools_menu"
+                "message_display_action",
+                "message_list",
+                "page",
+                "password",
+                "selection",
+                "tab",
+                "tools_menu",
+                "video"
               ]
             },
             {
@@ -11536,7 +11537,7 @@
         {
           "name": "create",
           "type": "function",
-          "description": "Creates a new content tab. Use the :ref:`messageDisplay_api` to open messages. Only supported in <value>normal</value> windows.",
+          "description": "Creates a new content tab. Use the :ref:`messageDisplay_api` to open messages. Only supported in <value>normal</value> windows. Same-site links in the loaded page are opened within Thunderbird, all other links are opened in the user's default browser. To override this behavior, add-ons have to register a `content script <https://bugzilla.mozilla.org/show_bug.cgi?id=1618828#c3>`__ , capture click events and handle them manually.",
           "async": "callback",
           "parameters": [
             {
@@ -12420,7 +12421,7 @@
         {
           "name": "create",
           "type": "function",
-          "description": "Creates (opens) a new window with any optional sizing, position or default URL provided.",
+          "description": "Creates (opens) a new window with any optional sizing, position or default URL provided. When loading a page into a popup window, same-site links are opened within the same window, all other links are opened in the user's default browser. To override this behavior, add-ons have to register a `content script <https://bugzilla.mozilla.org/show_bug.cgi?id=1618828#c3>`__ , capture click events and handle them manually. Same-site links with targets other than <value>_self</value> are opened in a new tab in the most recent ``normal`` Thunderbird window.",
           "async": "callback",
           "parameters": [
             {

package/schemas/release/webext.json

@@ -2507,6 +2507,7 @@
             },
             "bookmarkId": {
               "type": "string",
+              "optional": true,
               "description": "The id of the bookmark where the context menu was clicked, if it was on a bookmark."
             },
             "modifiers": {
@@ -10106,6 +10107,42 @@
         }
       ],
       "functions": [
+        {
+          "name": "updateDynamicRules",
+          "type": "function",
+          "description": "Modifies the current set of dynamic rules for the extension. The rules with IDs listed in options.removeRuleIds are first removed, and then the rules given in options.addRules are added. These rules are persisted across browser sessions and extension updates.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "options",
+              "type": "object",
+              "properties": {
+                "removeRuleIds": {
+                  "type": "array",
+                  "optional": true,
+                  "description": "IDs of the rules to remove. Any invalid IDs will be ignored.",
+                  "items": {
+                    "type": "integer"
+                  }
+                },
+                "addRules": {
+                  "type": "array",
+                  "optional": true,
+                  "description": "Rules to add.",
+                  "items": {
+                    "$ref": "Rule"
+                  }
+                }
+              }
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "Called when the dynamic rules have been updated",
+              "parameters": []
+            }
+          ]
+        },
         {
           "name": "updateSessionRules",
           "type": "function",
@@ -10216,6 +10253,27 @@
             }
           ]
         },
+        {
+          "name": "getDynamicRules",
+          "type": "function",
+          "description": "Returns the current set of dynamic rules for the extension.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "callback",
+              "type": "function",
+              "parameters": [
+                {
+                  "name": "dynamicRules",
+                  "type": "array",
+                  "items": {
+                    "$ref": "Rule"
+                  }
+                }
+              ]
+            }
+          ]
+        },
         {
           "name": "getSessionRules",
           "type": "function",
@@ -10227,6 +10285,7 @@
               "type": "function",
               "parameters": [
                 {
+                  "name": "sessionRules",
                   "type": "array",
                   "items": {
                     "$ref": "Rule"
@@ -13596,7 +13655,6 @@
                       "extension_ids": {
                         "optional": true,
                         "type": "array",
-                        "minItems": 1,
                         "items": {
                           "choices": [
                             {
@@ -17457,7 +17515,7 @@
         {
           "name": "submitPing",
           "type": "function",
-          "description": "Submits a custom ping to the Telemetry back-end. See <code>submitExternalPing</code> inside TelemetryController.jsm for more details.",
+          "description": "Submits a custom ping to the Telemetry back-end. See <code>submitExternalPing</code> inside TelemetryController.sys.mjs for more details.",
           "async": true,
           "parameters": [
             {
@@ -19614,6 +19672,7 @@
               "enum": [
                 "webRequest",
                 "webRequestBlocking",
+                "webRequestFilterResponse",
                 "webRequestFilterResponse.serviceWorkerScript"
               ]
             }