webext-schema 5.0.10 → 5.0.11

package/index.js

@@ -5,7 +5,7 @@
 /* api */
 import { logErr, throwErr } from './modules/common.js';
 import { parseCommand } from './modules/update.js';
-import process from 'process';
+import process from 'node:process';
 export { Schema } from './modules/schema.js';
 
 /* process */

package/modules/constant.js

@@ -3,7 +3,7 @@
  */
 
 /* api */
-import os from 'os';
+import os from 'node:os';
 
 /* constants */
 export const CHAR = 'utf8';

package/modules/file-util.js

@@ -3,10 +3,10 @@
  */
 
 /* api */
-import { fileURLToPath } from 'url';
+import { fileURLToPath } from 'node:url';
 import { getType, isString } from './common.js';
-import fs, { promises as fsPromise } from 'fs';
-import path from 'path';
+import fs, { promises as fsPromise } from 'node:fs';
+import path from 'node:path';
 import { IS_WIN } from './constant.js';
 
 /* constants */

package/modules/schema.js

@@ -8,8 +8,8 @@ import { convertUriToFilePath } from './file-util.js';
 import { getType, isObjectNotEmpty, isString } from './common.js';
 import camelize from 'camelize';
 import decamelize from 'decamelize';
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
 import sinon from 'sinon';
 
 export class Schema {

package/modules/update.js

@@ -9,8 +9,8 @@ import { createFile } from './file-util.js';
 import { getType, isString } from './common.js';
 import { program as commander } from 'commander';
 import fetch from 'node-fetch';
-import path from 'path';
-import process from 'process';
+import path from 'node:path';
+import process from 'node:process';
 
 /* constants */
 const DIR_CWD = process.cwd();

package/package.json

@@ -29,24 +29,25 @@
   },
   "dependencies": {
     "camelize": "^1.0.1",
-    "commander": "^9.4.1",
+    "commander": "^9.5.0",
     "decamelize": "^6.0.0",
-    "json5": "^2.2.1",
+    "json5": "^2.2.3",
     "node-fetch": "^3.3.0",
-    "sinon": "^15.0.0"
+    "sinon": "^15.0.1"
   },
   "devDependencies": {
     "c8": "^7.12.0",
     "chai": "^4.3.7",
-    "eslint": "^8.29.0",
+    "eslint": "^8.31.0",
     "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jsdoc": "^39.6.4",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-unicorn": "^45.0.2",
     "mocha": "^10.2.0",
     "nock": "^13.2.9",
     "npm-run-all": "^4.1.5"
   },
-  "version": "5.0.10"
+  "version": "5.0.11"
 }

package/schemas/central/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"
@@ -17457,7 +17516,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": [
             {

package/schemas/mail/mailext.json

@@ -8559,28 +8559,45 @@
       "types": [
         {
           "id": "ContextType",
-          "type": "string",
-          "enum": [
-            "all",
-            "page",
-            "frame",
-            "selection",
-            "link",
-            "editable",
-            "password",
-            "image",
-            "video",
-            "audio",
-            "browser_action",
-            "compose_action",
-            "message_display_action",
-            "tab",
-            "message_list",
-            "folder_pane",
-            "compose_attachments",
-            "message_attachments",
-            "all_message_attachments",
-            "tools_menu"
+          "choices": [
+            {
+              "type": "string",
+              "enum": [
+                "all",
+                "page",
+                "frame",
+                "selection",
+                "link",
+                "editable",
+                "password",
+                "image",
+                "video",
+                "audio",
+                "compose_action",
+                "message_display_action",
+                "tab",
+                "message_list",
+                "folder_pane",
+                "compose_attachments",
+                "message_attachments",
+                "all_message_attachments",
+                "tools_menu"
+              ]
+            },
+            {
+              "type": "string",
+              "max_manifest_version": 2,
+              "enum": [
+                "browser_action"
+              ]
+            },
+            {
+              "type": "string",
+              "min_manifest_version": 3,
+              "enum": [
+                "action"
+              ]
+            }
           ],
           "description": "The different contexts a menu can appear in. Specifying <value>all</value> is equivalent to the combination of all other contexts excluding <value>tab</value> and <value>tools_menu</value>. More information about each context can be found in the `Supported UI Elements <|link-ui-elements|>`__ article on developer.thunderbird.net."
         },
@@ -9005,7 +9022,7 @@
                 "command": {
                   "type": "string",
                   "optional": true,
-                  "description": "Specifies a command to issue for the context click. Currently supports internal commands <value>_execute_browser_action</value>, <value>_execute_compose_action</value> and <value>_execute_message_display_action</value>."
+                  "description": "Specifies a command to issue for the context click. Currently supports internal commands <value>_execute_action</value>, <value>_execute_compose_action</value> and <value>_execute_message_display_action</value>."
                 }
               }
             },

package/schemas/release/webext.json

@@ -3267,6 +3267,11 @@
               "minLength": 1,
               "description": "The text that is displayed in the URL dropdown. Can contain XML-style markup for styling. The supported tags are 'url' (for a literal URL), 'match' (for highlighting text that matched what the user's query), and 'dim' (for dim helper text). The styles can be nested, eg. <dim><match>dimmed match</match></dim>. You must escape the five predefined entities to display them as text: stackoverflow.com/a/1091953/89484 "
             },
+            "deletable": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Whether the suggest result can be deleted by the user."
+            },
             "descriptionStyles": {
               "optional": true,
               "unsupported": true,
@@ -3431,6 +3436,17 @@
           "type": "function",
           "description": "User has ended the keyword input session without accepting the input.",
           "parameters": []
+        },
+        {
+          "name": "onDeleteSuggestion",
+          "type": "function",
+          "description": "User has deleted a suggested result.",
+          "parameters": [
+            {
+              "type": "string",
+              "name": "text"
+            }
+          ]
         }
       ]
     }
@@ -9662,6 +9678,46 @@
               "min_manifest_version": 3
             }
           ]
+        },
+        {
+          "$extend": "WebExtensionManifest",
+          "properties": {
+            "declarative_net_request": {
+              "type": "object",
+              "min_manifest_version": 3,
+              "optional": true,
+              "additionalProperties": {
+                "$ref": "UnrecognizedProperty"
+              },
+              "properties": {
+                "rule_resources": {
+                  "type": "array",
+                  "minItems": 1,
+                  "items": {
+                    "type": "object",
+                    "additionalProperties": {
+                      "$ref": "UnrecognizedProperty"
+                    },
+                    "properties": {
+                      "id": {
+                        "type": "string",
+                        "pattern": "^[^_]",
+                        "description": "A non-empty string uniquely identifying the ruleset. IDs beginning with '_' are reserved for internal use."
+                      },
+                      "enabled": {
+                        "type": "boolean",
+                        "description": "Whether the ruleset is enabled by default."
+                      },
+                      "path": {
+                        "$ref": "manifest.ExtensionURL",
+                        "description": "The path of the JSON ruleset relative to the extension directory."
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
         }
       ]
     },
@@ -9719,6 +9775,95 @@
             }
           }
         },
+        {
+          "id": "URLTransform",
+          "type": "object",
+          "description": "Describes the type of the Rule.action.redirect.transform property.",
+          "properties": {
+            "scheme": {
+              "type": "string",
+              "optional": true,
+              "description": "The new scheme for the request.",
+              "enum": [
+                "http",
+                "https",
+                "moz-extension"
+              ]
+            },
+            "username": {
+              "type": "string",
+              "optional": true,
+              "description": "The new username for the request."
+            },
+            "password": {
+              "type": "string",
+              "optional": true,
+              "description": "The new password for the request."
+            },
+            "host": {
+              "type": "string",
+              "optional": true,
+              "description": "The new host name for the request."
+            },
+            "port": {
+              "type": "string",
+              "optional": true,
+              "description": "The new port for the request. If empty, the existing port is cleared."
+            },
+            "path": {
+              "type": "string",
+              "optional": true,
+              "description": "The new path for the request. If empty, the existing path is cleared."
+            },
+            "query": {
+              "type": "string",
+              "optional": true,
+              "description": "The new query for the request. Should be either empty, in which case the existing query is cleared; or should begin with '?'. Cannot be specified if 'queryTransform' is specified."
+            },
+            "queryTransform": {
+              "type": "object",
+              "optional": true,
+              "description": "Add, remove or replace query key-value pairs. Cannot be specified if 'query' is specified.",
+              "properties": {
+                "removeParams": {
+                  "type": "array",
+                  "optional": true,
+                  "description": "The list of query keys to be removed.",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                "addOrReplaceParams": {
+                  "type": "array",
+                  "optional": true,
+                  "description": "The list of query key-value pairs to be added or replaced.",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "key": {
+                        "type": "string"
+                      },
+                      "value": {
+                        "type": "string"
+                      },
+                      "replaceOnly": {
+                        "type": "boolean",
+                        "optional": true,
+                        "description": "If true, the query key is replaced only if it's already present. Otherwise, the key is also added if it's missing.",
+                        "default": false
+                      }
+                    }
+                  }
+                }
+              }
+            },
+            "fragment": {
+              "type": "string",
+              "optional": true,
+              "description": "The new fragment for the request. Should be either empty, in which case the existing fragment is cleared; or should begin with '#'."
+            }
+          }
+        },
         {
           "id": "Rule",
           "type": "object",
@@ -9880,9 +10025,9 @@
                       "description": "Path relative to the extension directory. Should start with '/'."
                     },
                     "transform": {
-                      "type": "object",
+                      "$ref": "URLTransform",
                       "optional": true,
-                      "description": "TODO: URLTransform - Url transformations to perform."
+                      "description": "Url transformations to perform."
                     },
                     "url": {
                       "type": "string",
@@ -9911,8 +10056,9 @@
                       },
                       "operation": {
                         "type": "string",
-                        "description": "The operation to be performed on a header. The 'append' operation is not supported for request headers.",
+                        "description": "The operation to be performed on a header.",
                         "enum": [
+                          "append",
                           "set",
                           "remove"
                         ]
@@ -9920,7 +10066,7 @@
                       "value": {
                         "type": "string",
                         "optional": true,
-                        "description": "The new value for the header. Must be specified for the 'set' operation."
+                        "description": "The new value for the header. Must be specified for the 'append' and 'set' operations."
                       }
                     }
                   }
@@ -9996,6 +10142,80 @@
             }
           ]
         },
+        {
+          "name": "getEnabledRulesets",
+          "type": "function",
+          "description": "Returns the ids for the current set of enabled static rulesets.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "callback",
+              "type": "function",
+              "parameters": [
+                {
+                  "type": "array",
+                  "name": "rulesetIds",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "updateEnabledRulesets",
+          "type": "function",
+          "description": "Returns the ids for the current set of enabled static rulesets.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "updateRulesetOptions",
+              "type": "object",
+              "properties": {
+                "disableRulesetIds": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  },
+                  "optional": true,
+                  "default": []
+                },
+                "enableRulesetIds": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  },
+                  "optional": true,
+                  "default": []
+                }
+              }
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "parameters": []
+            }
+          ]
+        },
+        {
+          "name": "getAvailableStaticRuleCount",
+          "type": "function",
+          "description": "Returns the remaining number of static rules an extension can enable",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "callback",
+              "type": "function",
+              "parameters": [
+                {
+                  "name": "count",
+                  "type": "integer"
+                }
+              ]
+            }
+          ]
+        },
         {
           "name": "getSessionRules",
           "type": "function",
@@ -19730,6 +19950,11 @@
               "description": "The key exchange algorithm used in this request if state is \"secure\".",
               "optional": true
             },
+            "secretKeyLength": {
+              "type": "number",
+              "description": "The length (in bits) of the secret key.",
+              "optional": true
+            },
             "signatureSchemeName": {
               "type": "string",
               "description": "The signature scheme used in this request if state is \"secure\".",