webext-schema 4.1.3 → 4.2.0

package/modules/browser.js

@@ -620,31 +620,35 @@ export const setSessionWindowValue = async (key, value, windowId) => {
 /**
  * clear storage
  *
+ * @param {string} area - storage area
  * @returns {void}
  */
-export const clearStorage = async () => {
+export const clearStorage = async (area = 'local') => {
   const isGranted = await isPermissionGranted({
     permissions: ['storage']
   });
-  if (isGranted) {
+  const areas = ['local', 'session', 'sync'];
+  if (isGranted && areas.includes(area)) {
     const { storage } = browser;
-    await storage.local.clear();
+    await storage[area]?.clear();
   }
 };
 
 /**
  * get all storage
  *
+ * @param {string} area - storage area
  * @returns {object} - stored data
  */
-export const getAllStorage = async () => {
+export const getAllStorage = async (area = 'local') => {
   const isGranted = await isPermissionGranted({
     permissions: ['storage']
   });
+  const areas = ['local', 'managed', 'session', 'sync'];
   let data;
-  if (isGranted) {
+  if (isGranted && areas.includes(area)) {
     const { storage } = browser;
-    data = await storage.local.get();
+    data = await storage[area]?.get();
   }
   return data || null;
 };
@@ -653,16 +657,18 @@ export const getAllStorage = async () => {
  * get storage
  *
  * @param {*} key - key
+ * @param {string} area - storage area
  * @returns {object} - stored data
  */
-export const getStorage = async key => {
+export const getStorage = async (key, area = 'local') => {
   const isGranted = await isPermissionGranted({
     permissions: ['storage']
   });
+  const areas = ['local', 'managed', 'session', 'sync'];
   let data;
-  if (isGranted) {
+  if (isGranted && areas.includes(area)) {
     const { storage } = browser;
-    data = await storage.local.get(key);
+    data = await storage[area]?.get(key);
   }
   return data || null;
 };
@@ -671,15 +677,17 @@ export const getStorage = async key => {
  * remove storage
  *
  * @param {*} key - key
+ * @param {string} area - storage area
  * @returns {void}
  */
-export const removeStorage = async key => {
+export const removeStorage = async (key, area = 'local') => {
   const isGranted = await isPermissionGranted({
     permissions: ['storage']
   });
-  if (isGranted) {
+  const areas = ['local', 'session', 'sync'];
+  if (isGranted && areas.includes(area)) {
     const { storage } = browser;
-    await storage.local.remove(key);
+    await storage[area]?.remove(key);
   }
 };
 
@@ -687,15 +695,17 @@ export const removeStorage = async key => {
  * set storage
  *
  * @param {object} obj - object to store
+ * @param {string} area - storage area
  * @returns {void}
  */
-export const setStorage = async obj => {
+export const setStorage = async (obj, area = 'local') => {
   const isGranted = await isPermissionGranted({
     permissions: ['storage']
   });
-  if (isGranted && obj) {
+  const areas = ['local', 'session', 'sync'];
+  if (isGranted && obj && areas.includes(area)) {
     const { storage } = browser;
-    await storage.local.set(obj);
+    await storage[area]?.set(obj);
   }
 };
 
@@ -844,8 +854,12 @@ export const getActiveTabId = async windowId => {
   if (!Number.isInteger(windowId)) {
     windowId = windows.WINDOW_ID_CURRENT;
   }
-  const { id } = await getActiveTab(windowId);
-  return id;
+  const tab = await getActiveTab(windowId);
+  let tabId;
+  if (tab) {
+    tabId = tab.id;
+  }
+  return Number.isInteger(tabId) ? tabId : null;
 };
 
 /**

package/package.json

@@ -38,15 +38,15 @@
   "devDependencies": {
     "c8": "^7.12.0",
     "chai": "^4.3.6",
-    "eslint": "^8.21.0",
+    "eslint": "^8.22.0",
     "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^39.3.4",
+    "eslint-plugin-jsdoc": "^39.3.6",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.0.0",
     "mocha": "^10.0.0",
     "nock": "^13.2.9",
     "npm-run-all": "^4.1.5"
   },
-  "version": "4.1.3"
+  "version": "4.2.0"
 }

package/schemas/central/webext.json

@@ -9620,6 +9620,154 @@
       ]
     }
   ],
+  "declarative_net_request.json": [
+    {
+      "namespace": "manifest",
+      "types": [
+        {
+          "$extend": "Permission",
+          "choices": [
+            {
+              "type": "string",
+              "enum": [
+                "declarativeNetRequest"
+              ],
+              "min_manifest_version": 3
+            }
+          ]
+        },
+        {
+          "$extend": "PermissionNoPrompt",
+          "choices": [
+            {
+              "type": "string",
+              "enum": [
+                "declarativeNetRequestFeedback",
+                "declarativeNetRequestWithHostAccess"
+              ],
+              "min_manifest_version": 3
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "namespace": "declarativeNetRequest",
+      "description": "Use the declarativeNetRequest API to block or modify network requests by specifying declarative rules.",
+      "permissions": [
+        "declarativeNetRequest",
+        "declarativeNetRequestWithHostAccess"
+      ],
+      "types": [
+        {
+          "id": "ResourceType",
+          "type": "string",
+          "description": "How the requested resource will be used. Comparable to the webRequest.ResourceType type.",
+          "enum": [
+            "main_frame",
+            "sub_frame",
+            "stylesheet",
+            "script",
+            "image",
+            "object",
+            "object_subrequest",
+            "xmlhttprequest",
+            "xslt",
+            "ping",
+            "beacon",
+            "xml_dtd",
+            "font",
+            "media",
+            "websocket",
+            "csp_report",
+            "imageset",
+            "web_manifest",
+            "speculative",
+            "other"
+          ]
+        },
+        {
+          "id": "MatchedRule",
+          "type": "object",
+          "properties": {
+            "ruleId": {
+              "type": "integer",
+              "description": "A matching rule's ID."
+            },
+            "rulesetId": {
+              "type": "string",
+              "description": "ID of the Ruleset this rule belongs to."
+            }
+          }
+        }
+      ],
+      "functions": [
+        {
+          "name": "testMatchOutcome",
+          "type": "function",
+          "description": "Checks if any of the extension's declarativeNetRequest rules would match a hypothetical request.",
+          "permissions": [
+            "declarativeNetRequestFeedback"
+          ],
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "request",
+              "type": "object",
+              "description": "The details of the request to test.",
+              "properties": {
+                "url": {
+                  "type": "string",
+                  "description": "The URL of the hypothetical request."
+                },
+                "initiator": {
+                  "type": "string",
+                  "description": "The initiator URL (if any) for the hypothetical request.",
+                  "optional": true
+                },
+                "method": {
+                  "type": "string",
+                  "description": "Standard HTTP method of the hypothetical request.",
+                  "optional": true,
+                  "default": "get"
+                },
+                "type": {
+                  "$ref": "ResourceType",
+                  "description": "The resource type of the hypothetical request."
+                },
+                "tabId": {
+                  "type": "integer",
+                  "description": "The ID of the tab in which the hypothetical request takes place. Does not need to correspond to a real tab ID. Default is -1, meaning that the request isn't related to a tab.",
+                  "optional": true,
+                  "default": -1
+                }
+              }
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "Called with the details of matched rules.",
+              "parameters": [
+                {
+                  "name": "result",
+                  "type": "object",
+                  "properties": {
+                    "matchedRules": {
+                      "type": "array",
+                      "description": "The rules (if any) that match the hypothetical request.",
+                      "items": {
+                        "$ref": "MatchedRule"
+                      }
+                    }
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ],
   "dns.json": [
     {
       "namespace": "manifest",
@@ -11577,7 +11725,6 @@
           "enum": [
             "java",
             "js",
-            "leaf",
             "mainthreadio",
             "fileio",
             "fileioall",

package/schemas/mail/mailext.json

@@ -3991,64 +3991,79 @@
     {
       "namespace": "manifest",
       "types": [
+        {
+          "id": "ActionManifest",
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "UnrecognizedProperty"
+          },
+          "properties": {
+            "default_label": {
+              "type": "string",
+              "description": "The label of the action, defaults to its title. Can be set to an empty string to not display any label. If the containing toolbar is configured to display text only, the title will be used as fallback.",
+              "optional": true,
+              "preprocess": "localize"
+            },
+            "default_title": {
+              "type": "string",
+              "description": "The title of the action. This shows up in the tooltip and the label. Defaults to the add-on name.",
+              "optional": true,
+              "preprocess": "localize"
+            },
+            "default_icon": {
+              "$ref": "IconPath",
+              "description": "The icon for the action.",
+              "optional": true
+            },
+            "theme_icons": {
+              "type": "array",
+              "optional": true,
+              "minItems": 1,
+              "items": {
+                "$ref": "ThemeIcons"
+              },
+              "description": "Specifies dark and light icons to be used with themes. The ``light`` icon is used on dark backgrounds and vice versa. **Note:** The default theme uses the ``default_icon`` for light backgrounds (if specified)."
+            },
+            "default_popup": {
+              "type": "string",
+              "format": "relativeUrl",
+              "optional": true,
+              "description": "The html document to be opened as a popup when the user clicks on the action's icon.",
+              "preprocess": "localize"
+            },
+            "browser_style": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Enable browser styles. See the `MDN documentation on browser styles <https://developer.mozilla.org/docs/Mozilla/Add-ons/WebExtensions/user_interface/Browser_styles>`__ for more information.",
+              "default": false
+            },
+            "default_area": {
+              "description": "Defines the location the action will appear. The default location is ``maintoolbar``.",
+              "type": "string",
+              "enum": [
+                "maintoolbar",
+                "tabstoolbar"
+              ],
+              "optional": true
+            }
+          }
+        },
+        {
+          "$extend": "WebExtensionManifest",
+          "properties": {
+            "action": {
+              "min_manifest_version": 3,
+              "$ref": "ActionManifest",
+              "optional": true
+            }
+          }
+        },
         {
           "$extend": "WebExtensionManifest",
           "properties": {
             "browser_action": {
-              "type": "object",
-              "additionalProperties": {
-                "$ref": "UnrecognizedProperty"
-              },
-              "properties": {
-                "default_label": {
-                  "type": "string",
-                  "description": "The label of the browserAction, defaults to its title. Can be set to an empty string to not display any label. If the containing toolbar is configured to display text only, the title will be used as fallback.",
-                  "optional": true,
-                  "preprocess": "localize"
-                },
-                "default_title": {
-                  "type": "string",
-                  "description": "The title of the browserAction. This shows up in the tooltip and the label. Defaults to the add-on name.",
-                  "optional": true,
-                  "preprocess": "localize"
-                },
-                "default_icon": {
-                  "$ref": "IconPath",
-                  "description": "The icon for the messageDisplayAction.",
-                  "optional": true
-                },
-                "theme_icons": {
-                  "type": "array",
-                  "optional": true,
-                  "minItems": 1,
-                  "items": {
-                    "$ref": "ThemeIcons"
-                  },
-                  "description": "Specifies dark and light icons to be used with themes. The ``light`` icon is used on dark backgrounds and vice versa. **Note:** The default theme uses the ``default_icon`` for light backgrounds (if specified)."
-                },
-                "default_popup": {
-                  "type": "string",
-                  "format": "relativeUrl",
-                  "optional": true,
-                  "description": "The html document to be opened as a popup when the user clicks on the browserAction's icon.",
-                  "preprocess": "localize"
-                },
-                "browser_style": {
-                  "type": "boolean",
-                  "optional": true,
-                  "description": "Enable browser styles. See the `MDN documentation on browser styles <https://developer.mozilla.org/docs/Mozilla/Add-ons/WebExtensions/user_interface/Browser_styles>`__ for more information.",
-                  "default": false
-                },
-                "default_area": {
-                  "description": "Defines the location the browserAction will appear. The default location is ``maintoolbar``.",
-                  "type": "string",
-                  "enum": [
-                    "maintoolbar",
-                    "tabstoolbar"
-                  ],
-                  "optional": true
-                }
-              },
+              "max_manifest_version": 2,
+              "$ref": "ActionManifest",
               "optional": true
             }
           }
@@ -4056,11 +4071,13 @@
       ]
     },
     {
-      "namespace": "browserAction",
-      "description": "Use a browserAction to put an icon in the mail window toolbar. In addition to its icon, a browserAction can also have a tooltip, a badge, and a popup. This namespace is called browserAction for compatibility with browser WebExtensions.",
+      "namespace": "action",
+      "description": "Use an action to put an icon in the mail window toolbar. In addition to its icon, an action can also have a tooltip, a badge, and a popup.",
       "permissions": [
+        "manifest:action",
         "manifest:browser_action"
       ],
+      "min_manifest_version": 3,
       "types": [
         {
           "id": "Details",
@@ -4144,7 +4161,7 @@
         {
           "name": "setTitle",
           "type": "function",
-          "description": "Sets the title of the browserAction. This shows up in the tooltip and the label. Defaults to the add-on name.",
+          "description": "Sets the title of the action. This shows up in the tooltip and the label. Defaults to the add-on name.",
           "async": "callback",
           "parameters": [
             {
@@ -4161,7 +4178,7 @@
                       "type": "null"
                     }
                   ],
-                  "description": "The string the browserAction should display as its label and when moused over."
+                  "description": "The string the action should display as its label and when moused over."
                 }
               }
             },
@@ -4176,7 +4193,7 @@
         {
           "name": "getTitle",
           "type": "function",
-          "description": "Gets the title of the browserAction.",
+          "description": "Gets the title of the action.",
           "async": "callback",
           "parameters": [
             {
@@ -4198,7 +4215,7 @@
         {
           "name": "setLabel",
           "type": "function",
-          "description": "Sets the label of the browserAction, defaults to its title. Can be set to an empty string to not display any label. If the containing toolbar is configured to display text only, the title will be used as fallback.",
+          "description": "Sets the label of the action, defaults to its title. Can be set to an empty string to not display any label. If the containing toolbar is configured to display text only, the title will be used as fallback.",
           "async": "callback",
           "parameters": [
             {
@@ -4215,7 +4232,7 @@
                       "type": "null"
                     }
                   ],
-                  "description": "The string the browserAction should use as label. Can be set to an empty string to not display any label. If the containing toolbar is configured to display text only, the title will be used as fallback."
+                  "description": "The string the action should use as label. Can be set to an empty string to not display any label. If the containing toolbar is configured to display text only, the title will be used as fallback."
                 }
               }
             },
@@ -4230,7 +4247,7 @@
         {
           "name": "getLabel",
           "type": "function",
-          "description": "Gets the label of the browserAction.",
+          "description": "Gets the label of the action.",
           "async": "callback",
           "parameters": [
             {
@@ -4252,7 +4269,7 @@
         {
           "name": "setIcon",
           "type": "function",
-          "description": "Sets the icon for the browserAction. The icon can be specified either as the path to an image file or as the pixel data from a canvas element, or as dictionary of either one of those. Either the <b>path</b> or the <b>imageData</b> property must be specified.",
+          "description": "Sets the icon for the action. The icon can be specified either as the path to an image file or as the pixel data from a canvas element, or as dictionary of either one of those. Either the <b>path</b> or the <b>imageData</b> property must be specified.",
           "async": "callback",
           "parameters": [
             {
@@ -4297,7 +4314,7 @@
         {
           "name": "setPopup",
           "type": "function",
-          "description": "Sets the html document to be opened as a popup when the user clicks on the browserAction's icon.",
+          "description": "Sets the html document to be opened as a popup when the user clicks on the action's icon.",
           "async": "callback",
           "parameters": [
             {
@@ -4329,7 +4346,7 @@
         {
           "name": "getPopup",
           "type": "function",
-          "description": "Gets the html document set as the popup for this browserAction.",
+          "description": "Gets the html document set as the popup for this action.",
           "async": "callback",
           "parameters": [
             {
@@ -4351,7 +4368,7 @@
         {
           "name": "setBadgeText",
           "type": "function",
-          "description": "Sets the badge text for the browserAction. The badge is displayed on top of the icon.",
+          "description": "Sets the badge text for the action. The badge is displayed on top of the icon.",
           "async": "callback",
           "parameters": [
             {
@@ -4383,7 +4400,7 @@
         {
           "name": "getBadgeText",
           "type": "function",
-          "description": "Gets the badge text of the browserAction. If no tab nor window is specified, the global badge text is returned.",
+          "description": "Gets the badge text of the action. If no tab nor window is specified, the global badge text is returned.",
           "async": "callback",
           "parameters": [
             {
@@ -4440,7 +4457,7 @@
         {
           "name": "getBadgeBackgroundColor",
           "type": "function",
-          "description": "Gets the background color of the browserAction.",
+          "description": "Gets the background color of the action.",
           "async": "callback",
           "parameters": [
             {
@@ -4462,7 +4479,7 @@
         {
           "name": "enable",
           "type": "function",
-          "description": "Enables the browserAction for a tab. By default, a browserAction is enabled.",
+          "description": "Enables the action for a tab. By default, an action is enabled.",
           "async": "callback",
           "parameters": [
             {
@@ -4470,7 +4487,7 @@
               "optional": true,
               "name": "tabId",
               "minimum": 0,
-              "description": "The id of the tab for which you want to modify the browserAction."
+              "description": "The id of the tab for which you want to modify the action."
             },
             {
               "type": "function",
@@ -4483,7 +4500,7 @@
         {
           "name": "disable",
           "type": "function",
-          "description": "Disables the browserAction for a tab.",
+          "description": "Disables the action for a tab.",
           "async": "callback",
           "parameters": [
             {
@@ -4491,7 +4508,7 @@
               "optional": true,
               "name": "tabId",
               "minimum": 0,
-              "description": "The id of the tab for which you want to modify the browserAction."
+              "description": "The id of the tab for which you want to modify the action."
             },
             {
               "type": "function",
@@ -4504,7 +4521,7 @@
         {
           "name": "isEnabled",
           "type": "function",
-          "description": "Checks whether the browserAction is enabled.",
+          "description": "Checks whether the action is enabled.",
           "async": "callback",
           "parameters": [
             {
@@ -4536,7 +4553,7 @@
         {
           "name": "onClicked",
           "type": "function",
-          "description": "Fired when a browserAction icon is clicked. This event will not fire if the browserAction has a popup. This is a user input event handler. For asynchronous listeners some `restrictions <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/User_actions>`__ apply.",
+          "description": "Fired when an action icon is clicked. This event will not fire if the action has a popup. This is a user input event handler. For asynchronous listeners some `restrictions <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/User_actions>`__ apply.",
           "parameters": [
             {
               "name": "tab",
@@ -4550,6 +4567,15 @@
           ]
         }
       ]
+    },
+    {
+      "namespace": "browserAction",
+      "permissions": [
+        "manifest:action",
+        "manifest:browser_action"
+      ],
+      "max_manifest_version": 2,
+      "$import": "action"
     }
   ],
   "chrome_settings_overrides.json": [
@@ -5621,6 +5647,91 @@
             }
           }
         },
+        {
+          "name": "onAfterSend",
+          "type": "function",
+          "description": "Fired when sending a message succeeded or failed.",
+          "permissions": [
+            "compose"
+          ],
+          "parameters": [
+            {
+              "name": "tab",
+              "$ref": "tabs.Tab"
+            },
+            {
+              "name": "sendInfo",
+              "type": "object",
+              "properties": {
+                "mode": {
+                  "type": "string",
+                  "description": "The used send mode.",
+                  "enum": [
+                    "sendNow",
+                    "sendLater"
+                  ]
+                },
+                "error": {
+                  "type": "string",
+                  "description": "An error description, if sending the message failed.",
+                  "optional": true
+                },
+                "headerMessageId": {
+                  "type": "string",
+                  "description": "The header messageId of the outgoing message. Only included for actually sent messages.",
+                  "optional": true
+                },
+                "messages": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "messages.MessageHeader"
+                  },
+                  "description": "Copies of the sent message. The number of created copies depends on the applied file carbon copy configuration (fcc)."
+                }
+              }
+            }
+          ]
+        },
+        {
+          "name": "onAfterSave",
+          "type": "function",
+          "description": "Fired when saving a message as draft or template succeeded or failed.",
+          "permissions": [
+            "compose"
+          ],
+          "parameters": [
+            {
+              "name": "tab",
+              "$ref": "tabs.Tab"
+            },
+            {
+              "name": "saveInfo",
+              "type": "object",
+              "properties": {
+                "mode": {
+                  "type": "string",
+                  "description": "The used save mode.",
+                  "enum": [
+                    "draft",
+                    "template"
+                  ]
+                },
+                "error": {
+                  "type": "string",
+                  "description": "An error description, if saving the message failed.",
+                  "optional": true
+                },
+                "messages": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "messages.MessageHeader"
+                  },
+                  "description": "The saved message(s). The number of saved messages depends on the applied file carbon copy configuration (fcc)."
+                }
+              }
+            }
+          ]
+        },
         {
           "name": "onAttachmentAdded",
           "type": "function",