webext-schema 5.1.9 → 5.1.11

package/README.md

@@ -9,13 +9,13 @@ Stubbed browser API is also available.
 
 ## Install
 
-```
+```console
 npm i webext-schema
 ```
 
 ## Usage
 
-```
+```javascript
 import { Schema } from 'webext-schema';
 
 const schema = new Schema();
@@ -28,7 +28,7 @@ const schema = new Schema();
 
 Both arguments are optional.
 
-```
+```javascript
 const schema = new Schema("central", {
   useFakeTimers: true,
   useFakeServer: true,
@@ -40,13 +40,13 @@ const schema = new Schema("central", {
 "central", "beta", "release", "esr" for WebExtensions, and "mail" for MailExtensions are available.
 Channel defaults to "beta".
 
-```
+```javascript
 const schema = new Schema("central");
 ```
 
 Also, you can set it afterwards.
 
-```
+```javascript
 const schema = new Schema();
 schema.channel = "central";
 ```
@@ -59,12 +59,12 @@ schema.channel = "central";
 Get the schema for the specific API.
 Argument can be either an API name or a file name.
 
-```
+```javascript
 const schema = new Schema().get("browserAction");
 // [{namespace: "browserAction", events: [...], ...}]
 ```
 
-```
+```javascript
 const schema = new Schema().get("browser_action.json");
 // [{namespace: "browserAction", events: [...], ...}]
 ```
@@ -76,7 +76,7 @@ const schema = new Schema().get("browser_action.json");
 Get all schemas as a single object.
 Note that the key of the object is the file name and the value is the schema.
 
-```
+```javascript
 const schema = new Schema().getAll();
 // {"alarms.json": [{...}], "bookmarks.json": [{...}], ...}
 ```
@@ -87,7 +87,7 @@ const schema = new Schema().getAll();
 
 Get the list of schema files.
 
-```
+```javascript
 const list = new Schema().list();
 // ["alarms.json", "bookmarks.json", ...]
 ```
@@ -105,18 +105,18 @@ Creates stubbed browser API.
 
 See [Sinon.JS](https://sinonjs.org/) for details of sinon.sandbox.
 
-```
+```javascript
 const browser = new Schema().mock();
 
 // example of mocking runtime.connect()
-const mockConnect = browser.runtime.connect.callsFake(({name}) => {
+const mockConnect = browser.runtime.connect.callsFake(({ name }) => {
   const port = Object.assign({}, browser.runtime.Port);
   port.name = name;
   return port;
 });
 
-const port1 = mockConnect({name: "foo"});
-const port2 = mockConnect({name: "bar"});
+const port1 = mockConnect({ name: "foo" });
+const port2 = mockConnect({ name: "bar" });
 assert.strictEqual(port1.name, "foo");
 assert.isFunction(port1.onDisconnect.addListener);
 assert.strictEqual(port2.name, "bar");

package/package.json

@@ -14,29 +14,29 @@
   "types": "types/index.d.ts",
   "dependencies": {
     "@types/firefox-webext-browser": "^111.0.0",
-    "@types/node": "^18.14.6",
+    "@types/node": "^18.15.10",
     "@types/sinon": "^10.0.13",
     "camelize": "^1.0.1",
     "commander": "^10.0.0",
     "decamelize": "^6.0.0",
     "json5": "^2.2.3",
-    "sinon": "^15.0.1"
+    "sinon": "^15.0.3"
   },
   "devDependencies": {
     "c8": "^7.13.0",
     "chai": "^4.3.7",
-    "eslint": "^8.35.0",
+    "eslint": "^8.36.0",
     "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsdoc": "^40.0.1",
+    "eslint-plugin-jsdoc": "^40.1.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-regexp": "^1.12.0",
+    "eslint-plugin-regexp": "^1.13.0",
     "eslint-plugin-unicorn": "^46.0.0",
     "mocha": "^10.2.0",
     "npm-run-all": "^4.1.5",
-    "typescript": "^4.9.5",
-    "undici": "^5.20.0"
+    "typescript": "^5.0.2",
+    "undici": "^5.21.0"
   },
   "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.9"
+  "version": "5.1.11"
 }

package/schemas/beta/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
             }
           }
         },

package/schemas/central/webext.json

@@ -9822,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",
@@ -10104,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."
                     }
                   }
                 },
@@ -10360,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",
@@ -10458,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",

package/schemas/mail/mailext.json

@@ -4087,7 +4087,7 @@
               "default": false
             },
             "default_area": {
-              "description": "Defines the location the action button will appear. The default location is <value>maintoolbar</value>.",
+              "description": "Defines the location the action button will appear. This will always behave like <value>maintoolbar</value>. The <value>tabstoolbar</value> area should no longer be used.",
               "type": "string",
               "enum": [
                 "maintoolbar",
@@ -4109,6 +4109,26 @@
                 "normal"
               ],
               "optional": true
+            },
+            "allowed_spaces": {
+              "description": "Defines the spaces, in which the action button can appear in the toolbar of the normal Thunderbird window. Defaults to only allowing the action in the <value>mail</value> space. The <value>default</value> space is for tabs that don't belong to any space. If this is an empty array, the action button is shown in all spaces.",
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": [
+                  "mail",
+                  "addressbook",
+                  "calendar",
+                  "tasks",
+                  "chat",
+                  "settings",
+                  "default"
+                ]
+              },
+              "default": [
+                "mail"
+              ],
+              "optional": true
             }
           }
         },
@@ -4359,7 +4379,8 @@
               "parameters": [
                 {
                   "name": "result",
-                  "type": "string"
+                  "type": "string",
+                  "optional": true
                 }
               ]
             }
@@ -4664,7 +4685,7 @@
         {
           "name": "enable",
           "type": "function",
-          "description": "Enables the action button for a tab. By default, an action button is enabled.",
+          "description": "Enables the action button for a specific tab (if a ``tabId`` is provided), or for all tabs which do not have a custom enable state. Once the enable state of a tab has been updated individually, all further changes to its state have to be done individually as well. By default, an action button is enabled.",
           "async": "callback",
           "parameters": [
             {
@@ -4685,7 +4706,7 @@
         {
           "name": "disable",
           "type": "function",
-          "description": "Disables the action button for a tab.",
+          "description": "Disables the action button for a specific tab (if a ``tabId`` is provided), or for all tabs which do not have a custom enable state. Once the enable state of a tab has been updated individually, all further changes to its state have to be done individually as well.",
           "async": "callback",
           "parameters": [
             {
@@ -4743,7 +4764,6 @@
         {
           "name": "openPopup",
           "type": "function",
-          "requireUserInput": true,
           "description": "Opens the action's popup window in the active window.",
           "async": true,
           "parameters": []
@@ -6801,7 +6821,8 @@
               "parameters": [
                 {
                   "name": "result",
-                  "type": "string"
+                  "type": "string",
+                  "optional": true
                 }
               ]
             }
@@ -9449,7 +9470,7 @@
                     "window"
                   ],
                   "optional": true,
-                  "description": "Where to open the message. If not specified, the users preference is honoured. Ignored for external messages, which are always opened in a new window."
+                  "description": "Where to open the message. If not specified, the users preference is honoured."
                 },
                 "active": {
                   "type": "boolean",
@@ -9766,7 +9787,8 @@
               "parameters": [
                 {
                   "name": "result",
-                  "type": "string"
+                  "type": "string",
+                  "optional": true
                 }
               ]
             }

package/types/modules/commander.d.ts

@@ -1,4 +1,4 @@
 export function cleanDirectory(cmdOpts?: object): void;
 export function parseCommand(args: any[]): void;
 export { commander };
-import { program as commander } from "commander";
+import { program as commander } from 'commander';

package/types/modules/schema.d.ts

@@ -23,4 +23,4 @@ export class Schema {
     mock(): object;
     #private;
 }
-import sinon from "sinon";
+import sinon from 'sinon';