webext-schema 2.3.4 → 3.0.2

package/modules/browser.js

@@ -74,8 +74,7 @@ export const getCloseTabsByDoubleClickValue = async () => {
   });
   let userValue;
   if (isGranted) {
-    const { browserSettings } = browser;
-    const { closeTabsByDoubleClick } = browserSettings;
+    const { browserSettings: { closeTabsByDoubleClick } } = browser;
     userValue = await closeTabsByDoubleClick.get({});
   }
   return userValue || null;
@@ -92,8 +91,7 @@ export const setContextMenuOnMouseup = async () => {
   });
   let res;
   if (isGranted) {
-    const { browserSettings } = browser;
-    const { contextMenuShowEvent } = browserSettings;
+    const { browserSettings: { contextMenuShowEvent } } = browser;
     const { levelOfControl, value } = await contextMenuShowEvent.get({});
     if (value === 'mouseup') {
       res = true;
@@ -117,8 +115,7 @@ export const clearContextMenuOnMouseup = async () => {
   });
   let res;
   if (isGranted) {
-    const { browserSettings } = browser;
-    const { contextMenuShowEvent } = browserSettings;
+    const { browserSettings: { contextMenuShowEvent } } = browser;
     res = await contextMenuShowEvent.clear({});
   }
   return !!res;
@@ -135,8 +132,7 @@ export const getNewTabPositionValue = async () => {
   });
   let res;
   if (isGranted) {
-    const { browserSettings } = browser;
-    const { newTabPosition } = browserSettings;
+    const { browserSettings: { newTabPosition } } = browser;
     res = await newTabPosition.get({});
   }
   return res || null;
@@ -255,9 +251,8 @@ export const getEnabledTheme = async () => {
     try {
       const arr = await management.getAll();
       if (Array.isArray(arr) && arr.length) {
-        res = arr.filter(info =>
-          info.type && info.type === 'theme' && info.enabled && info
-        );
+        res =
+          arr.filter(info => info?.type === 'theme' && info?.enabled && info);
       }
     } catch (e) {
       logErr(e);
@@ -303,7 +298,7 @@ export const getExternalExtensions = async () => {
       const arr = await management.getAll();
       if (Array.isArray(arr) && arr.length) {
         res =
-          arr.filter(info => info.type && info.type === 'extension' && info);
+          arr.filter(info => info?.type === 'extension' && info);
       }
     } catch (e) {
       logErr(e);
@@ -429,21 +424,27 @@ export const getOs = async () => {
 /**
  * make a connection
  *
- * @param {string} [extId] - extension ID
+ * @param {number|string} [id] - tab ID / extension ID
  * @param {object} [info] - info
  * @returns {object} - runtime.Port
  */
-export const makeConnection = async (extId, info) => {
+export const makeConnection = async (id, info) => {
   let port;
-  if (isString(extId)) {
+  if (Number.isInteger(id)) {
+    if (isObjectNotEmpty(info)) {
+      port = await tabs.connect(id, info);
+    } else {
+      port = await tabs.connect(id);
+    }
+  } else if (isString(id)) {
     if (isObjectNotEmpty(info)) {
-      port = await runtime.connect(extId, info);
+      port = await runtime.connect(id, info);
     } else {
-      port = await runtime.connect(extId);
+      port = await runtime.connect(id);
     }
-  } else if (isObjectNotEmpty(extId)) {
-    port = await runtime.connect(extId);
-  } else if (!extId && isObjectNotEmpty(info)) {
+  } else if (isObjectNotEmpty(id)) {
+    port = await runtime.connect(id);
+  } else if (!id && isObjectNotEmpty(info)) {
     port = await runtime.connect(info);
   } else {
     port = await runtime.connect();
@@ -733,17 +734,12 @@ export const queryTabs = async opt => {
 export const execScriptToTab = async (tabId, opt = {}) => {
   let res;
   try {
-    const isGranted = await isPermissionGranted({
-      permissions: ['activeTab']
-    });
     if (Number.isInteger(tabId)) {
       res = await tabs.executeScript(tabId, opt);
-    } else if (isGranted) {
-      if (isObjectNotEmpty(tabId)) {
-        res = await tabs.executeScript(tabId);
-      } else {
-        res = await tabs.executeScript(opt);
-      }
+    } else if (isObjectNotEmpty(tabId)) {
+      res = await tabs.executeScript(tabId);
+    } else if (isObjectNotEmpty(opt)) {
+      res = await tabs.executeScript(opt);
     } else {
       res = null;
     }

package/modules/common.js

@@ -66,7 +66,7 @@ export const getType = o =>
  */
 export const isObjectNotEmpty = o => {
   const items = /Object/i.test(getType(o)) && Object.keys(o);
-  return !!(items && items.length);
+  return !!(items?.length);
 };
 
 /**

package/modules/file-util.js

@@ -3,11 +3,11 @@
  */
 
 /* api */
-import { IS_WIN } from './constant.js';
 import { fileURLToPath } from 'url';
 import { getType, isString } from './common.js';
 import fs, { promises as fsPromise } from 'fs';
 import path from 'path';
+import { IS_WIN } from './constant.js';
 
 /* constants */
 const MASK_BIT = 0o111;
@@ -135,7 +135,7 @@ export const getFileNameFromFilePath = (file, subst = SUBST) => {
 };
 
 /**
- * remove the directory and it's files
+ * remove the directory and it's files synchronously
  *
  * @param {string} dir - directory path
  * @param {string} baseDir - base directory path
@@ -146,16 +146,10 @@ export const removeDir = (dir, baseDir) => {
     if (!isSubDir(dir, baseDir)) {
       throw new Error(`${dir} is not a subdirectory of ${baseDir}.`);
     }
-    const files = fs.readdirSync(dir);
-    files.length && files.forEach(file => {
-      const cur = path.join(dir, file);
-      if (fs.lstatSync(cur).isDirectory()) {
-        removeDir(cur, baseDir);
-      } else {
-        fs.unlinkSync(cur);
-      }
+    fs.rmSync(dir, {
+      force: true,
+      recursive: true
     });
-    fs.rmdirSync(dir);
   }
 };
 
@@ -167,7 +161,15 @@ export const removeDir = (dir, baseDir) => {
  * @returns {void}
  */
 export const removeDirectory = async (dir, baseDir) => {
-  await removeDir(dir, baseDir);
+  if (isDir(dir)) {
+    if (!isSubDir(dir, baseDir)) {
+      throw new Error(`${dir} is not a subdirectory of ${baseDir}.`);
+    }
+    await fsPromise.rm(dir, {
+      force: true,
+      recursive: true
+    });
+  }
 };
 
 /**

package/modules/schema.js

@@ -94,8 +94,7 @@ export class Schema {
           } else if (this._browser[$import]) {
             importValue = this._browser[$import];
           } else {
-            importValue =
-              this._browser[namespace] && this._browser[namespace][$import];
+            importValue = this._browser[namespace]?.[$import];
           }
           Object.assign(target, importValue);
         }
@@ -122,8 +121,7 @@ export class Schema {
           } else if (this._browser[$ref]) {
             refValue = this._browser[$ref];
           } else {
-            refValue =
-              this._browser[namespace] && this._browser[namespace][$ref];
+            refValue = this._browser[namespace]?.[$ref];
           }
           Object.assign(target, refValue);
         }
@@ -149,7 +147,7 @@ export class Schema {
     for (const item of events) {
       const { name, type, unsupported } = item;
       if (!unsupported && name && type === 'function') {
-        target[name] = target[name] || {};
+        target[name] ??= {};
         target[name].addListener = this._sandbox.stub();
         target[name].hasListener = this._sandbox.stub();
         target[name].removeListener = this._sandbox.stub();
@@ -210,7 +208,7 @@ export class Schema {
           target[key] = this._sandbox.stub();
         } else if (type === 'object' || $ref ||
                    Object.prototype.hasOwnProperty.call(item, 'properties')) {
-          target[key] = target[key] || {};
+          target[key] ??= {};
           properties && this._mockProperties(
             target[key], properties, `${namespace}.${key}`
           );
@@ -247,7 +245,7 @@ export class Schema {
         $import &&
           this._importMap.set(`${namespace}.${id}`, { $import, namespace });
         if (type === 'object' || $import || events || functions || properties) {
-          target[id] = target[id] || {};
+          target[id] ??= {};
           events && this._mockEvents(target[id], events);
           functions && this._mockFunctions(target[id], functions);
           properties &&
@@ -287,7 +285,7 @@ export class Schema {
     if (!isString(name)) {
       throw new TypeError(`Expected String but got ${getType(name)}.`);
     }
-    const schemas = this._schema || this._parseSchemaContent();
+    const schemas = this._schema ?? this._parseSchemaContent();
     const items = Object.entries(schemas);
     const label = decamelize(name.replace(/\.json$/, ''));
     let schema;
@@ -306,7 +304,7 @@ export class Schema {
    * @returns {object} - schemas
    */
   getAll() {
-    const schemas = this._schema || this._parseSchemaContent();
+    const schemas = this._schema ?? this._parseSchemaContent();
     return schemas;
   }
 
@@ -316,7 +314,7 @@ export class Schema {
    * @returns {Array} - file list
    */
   list() {
-    const schemas = this._schema || this._parseSchemaContent();
+    const schemas = this._schema ?? this._parseSchemaContent();
     const items = Object.keys(schemas);
     const arr = [];
     for (const item of items) {
@@ -331,7 +329,7 @@ export class Schema {
    * @returns {object} - stubbed browser api
    */
   mock() {
-    const schemas = this._schema || this._parseSchemaContent();
+    const schemas = this._schema ?? this._parseSchemaContent();
     const schemaItems = Object.entries(schemas);
     const aliasKeys = ['action', 'menus'];
     this._browser = {
@@ -354,13 +352,12 @@ export class Schema {
           let ns;
           if (namespace.includes('.')) {
             const [itemNamespace, itemSubNamespace] = namespace.split('.');
-            this._browser[itemNamespace] = this._browser[itemNamespace] || {};
-            this._browser[itemNamespace][itemSubNamespace] =
-              this._browser[itemNamespace][itemSubNamespace] || {};
+            this._browser[itemNamespace] ??= {};
+            this._browser[itemNamespace][itemSubNamespace] ??= {};
             mapKey.push(itemNamespace, itemSubNamespace);
             ns = this._browser[itemNamespace][itemSubNamespace];
           } else {
-            this._browser[namespace] = this._browser[namespace] || {};
+            this._browser[namespace] ??= {};
             mapKey.push(namespace);
             ns = this._browser[namespace];
           }

package/modules/update.js

@@ -168,9 +168,7 @@ export const getMailExtSchemaData = async baseUrl => {
   ];
   const func = [];
   for (const item of items) {
-    if (!excludeFile.includes(item)) {
-      func.push(getSchemaData(item, schemaUrl));
-    }
+    !excludeFile.includes(item) && func.push(getSchemaData(item, schemaUrl));
   }
   return Promise.all(func);
 };

package/package.json

@@ -33,20 +33,20 @@
     "decamelize": "^6.0.0",
     "json5": "^2.2.1",
     "node-fetch": "^3.2.4",
-    "sinon": "^13.0.2"
+    "sinon": "^14.0.0"
   },
   "devDependencies": {
-    "c8": "^7.11.2",
+    "c8": "^7.11.3",
     "chai": "^4.3.6",
-    "eslint": "^8.14.0",
+    "eslint": "^8.16.0",
     "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^39.2.9",
+    "eslint-plugin-jsdoc": "^39.3.2",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.0.0",
     "mocha": "^10.0.0",
     "nock": "^13.2.4",
     "npm-run-all": "^4.1.5"
   },
-  "version": "2.3.4"
+  "version": "3.0.2"
 }

package/schemas/central/webext.json

@@ -3066,7 +3066,7 @@
       "namespace": "manifest",
       "types": [
         {
-          "$extend": "PermissionNoPrompt",
+          "$extend": "PermissionPrivileged",
           "choices": [
             {
               "type": "string",
@@ -6430,7 +6430,7 @@
       "namespace": "manifest",
       "types": [
         {
-          "$extend": "PermissionNoPrompt",
+          "$extend": "PermissionPrivileged",
           "choices": [
             {
               "type": "string",
@@ -7275,7 +7275,7 @@
       "namespace": "manifest",
       "types": [
         {
-          "$extend": "PermissionNoPrompt",
+          "$extend": "PermissionPrivileged",
           "choices": [
             {
               "type": "string",
@@ -10910,7 +10910,8 @@
               "additionalProperties": {
                 "$ref": "experiments.ExperimentAPI"
               },
-              "optional": true
+              "optional": true,
+              "privileged": true
             }
           }
         }
@@ -11761,7 +11762,8 @@
               "items": {
                 "type": "string"
               },
-              "optional": true
+              "optional": true,
+              "privileged": true
             }
           }
         }
@@ -13089,17 +13091,30 @@
             }
           ]
         },
+        {
+          "id": "PermissionPrivileged",
+          "choices": [
+            {
+              "type": "string",
+              "enum": [
+                "mozillaAddons"
+              ]
+            }
+          ]
+        },
         {
           "id": "PermissionNoPrompt",
           "choices": [
             {
-              "$ref": "OptionalPermission"
+              "$ref": "OptionalPermissionNoPrompt"
+            },
+            {
+              "$ref": "PermissionPrivileged"
             },
             {
               "type": "string",
               "enum": [
                 "alarms",
-                "mozillaAddons",
                 "storage",
                 "unlimitedStorage"
               ]
@@ -13443,7 +13458,7 @@
       "namespace": "manifest",
       "types": [
         {
-          "$extend": "PermissionNoPrompt",
+          "$extend": "PermissionPrivileged",
           "choices": [
             {
               "type": "string",
@@ -14865,7 +14880,8 @@
               "type": "boolean",
               "optional": true,
               "default": false,
-              "description": "Whether to create all cookies as nonPersistent (i.e., session) cookies."
+              "description": "Whether to create all cookies as nonPersistent (i.e., session) cookies.",
+              "deprecated": "This property has no effect anymore and its value is always <code>false<code>."
             }
           }
         }
@@ -15720,8 +15736,7 @@
               "type": "string",
               "enum": [
                 "scripting"
-              ],
-              "min_manifest_version": 3
+              ]
             }
           ]
         }
@@ -15733,7 +15748,6 @@
       "permissions": [
         "scripting"
       ],
-      "min_manifest_version": 3,
       "types": [
         {
           "id": "ScriptInjection",
@@ -16635,7 +16649,7 @@
           }
         },
         {
-          "$extend": "PermissionNoPrompt",
+          "$extend": "PermissionPrivileged",
           "choices": [
             {
               "type": "string",

package/schemas/mail/mailext.json

@@ -403,7 +403,8 @@
               "additionalProperties": {
                 "$ref": "experiments.ExperimentAPI"
               },
-              "optional": true
+              "optional": true,
+              "privileged": true
             }
           }
         }
@@ -774,7 +775,8 @@
               "items": {
                 "type": "string"
               },
-              "optional": true
+              "optional": true,
+              "privileged": true
             }
           }
         }
@@ -2873,7 +2875,7 @@
         {
           "name": "list",
           "type": "function",
-          "description": "Returns all mail accounts.",
+          "description": "Returns all mail accounts. They will be returned in the same order as used in Thunderbird's folder pane.",
           "async": "callback",
           "parameters": [
             {
@@ -5359,6 +5361,41 @@
               "$ref": "ComposeRecipientList",
               "optional": true
             },
+            "overrideDefaultFcc": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Indicates whether the default fcc setting (defined by the used identity) is being overridden for this message. Setting ``false`` will clear the override. Setting ``true`` will throw an exception, if ``overrideDefaultFccFolder`` is not set as well."
+            },
+            "overrideDefaultFccFolder": {
+              "choices": [
+                {
+                  "$ref": "folders.MailFolder"
+                },
+                {
+                  "type": "string",
+                  "enum": [
+                    ""
+                  ]
+                }
+              ],
+              "optional": true,
+              "description": " This value overrides the default fcc setting (defined by the used identity) for this message only. Either a :ref:`folders.MailFolder` specifying the folder for the copy of the sent message, or ``\"\"`` to not save a copy at all."
+            },
+            "additionalFccFolder": {
+              "choices": [
+                {
+                  "$ref": "folders.MailFolder"
+                },
+                {
+                  "type": "string",
+                  "enum": [
+                    ""
+                  ]
+                }
+              ],
+              "description": "An additional fcc folder which can be selected while composing the message, ``\"\"`` if not used.",
+              "optional": true
+            },
             "replyTo": {
               "$ref": "ComposeRecipientList",
               "optional": true
@@ -5419,14 +5456,52 @@
               "description": "Whether the message is an HTML message or a plain text message.",
               "optional": true
             },
+            "deliveryFormat": {
+              "type": "string",
+              "enum": [
+                "auto",
+                "plaintext",
+                "html",
+                "both"
+              ],
+              "description": "Defines the mime format of the send message (ignored on plain text messages). Defaults to ``auto``, which will send html messages as plain text, if they do not include any formatting, and as ``both`` otherwise (a multipart/mixed message).",
+              "optional": true
+            },
             "customHeaders": {
               "type": "array",
               "items": {
                 "$ref": "CustomHeader"
               },
-              "description": "Array of custom headers. Headers will be returned in ``Http-Header-Case`` (a.k.a. ``Train-Case``)",
+              "description": "Array of custom headers. Headers will be returned in ``Http-Header-Case`` (a.k.a. ``Train-Case``). Set an empty array to clear all custom headers.",
               "optional": true
             },
+            "priority": {
+              "type": "string",
+              "enum": [
+                "lowest",
+                "low",
+                "normal",
+                "high",
+                "highest"
+              ],
+              "description": "The priority of the message.",
+              "optional": true
+            },
+            "returnReceipt": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Add the ``Disposition-Notification-To`` header to the message to requests the recipients email client to send a reply once the message has been received. Recipient server may strip the header and the recipient might ignore the request."
+            },
+            "deliveryStatusNotification": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Let the sender know when the recipient's server received the message. Not supported by all servers."
+            },
+            "attachVCard": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Wether or not the vCard of the used identity will be attached to the message during send. Note: If the value has not been modified, selecting a different identity will load the default value of the new identity."
+            },
             "attachments": {
               "type": "array",
               "items": {
@@ -5498,6 +5573,14 @@
               "type": "string"
             }
           }
+        },
+        {
+          "id": "ComposeDictionaries",
+          "type": "object",
+          "additionalProperties": {
+            "type": "boolean"
+          },
+          "description": "Object with language identifiers of all installed dictionaries as keys (for example ``en-US``) and a boolean value, indicating whether that dictionary is enabled for spellchecking or not."
         }
       ],
       "events": [
@@ -5603,6 +5686,21 @@
               "$ref": "ComposeState"
             }
           ]
+        },
+        {
+          "name": "onActiveDictionariesChanged",
+          "type": "function",
+          "description": "Fired when one or more dictionaries have been activated or deactivated.",
+          "parameters": [
+            {
+              "name": "tab",
+              "$ref": "tabs.Tab"
+            },
+            {
+              "name": "dictionaries",
+              "$ref": "ComposeDictionaries"
+            }
+          ]
         }
       ],
       "functions": [
@@ -5762,6 +5860,55 @@
             }
           ]
         },
+        {
+          "name": "getActiveDictionaries",
+          "type": "function",
+          "async": "callback",
+          "description": "Returns a :ref:`ComposeDictionaries` object, listing all installed dictionaries, including the information whether they are currently enabled or not.",
+          "permissions": [
+            "compose"
+          ],
+          "parameters": [
+            {
+              "type": "integer",
+              "name": "tabId",
+              "minimum": 0
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "optional": true,
+              "parameters": [
+                {
+                  "$ref": "ComposeDictionaries"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "setActiveDictionaries",
+          "type": "function",
+          "async": true,
+          "description": "Updates the active dictionaries. Throws if the ``activeDictionaries`` array contains unknown or invalid language identifiers.",
+          "permissions": [
+            "compose"
+          ],
+          "parameters": [
+            {
+              "type": "integer",
+              "name": "tabId",
+              "minimum": 0
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "name": "activeDictionaries"
+            }
+          ]
+        },
         {
           "name": "listAttachments",
           "type": "function",
@@ -6715,7 +6862,7 @@
             },
             "subFolders": {
               "type": "array",
-              "description": "Subfolders are only included if requested.",
+              "description": "Subfolders are only included if requested. They will be returned in the same order as used in Thunderbird's folder pane.",
               "items": {
                 "$ref": "MailFolder"
               },
@@ -8708,6 +8855,62 @@
               ]
             }
           ]
+        },
+        {
+          "name": "open",
+          "type": "function",
+          "description": "Opens a message in a new tab or in a new window.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "openProperties",
+              "type": "object",
+              "description": "Settings for opening the message. Exactly one of messageId or headerMessageId must be specified.",
+              "properties": {
+                "messageId": {
+                  "type": "integer",
+                  "optional": true,
+                  "minimum": 1,
+                  "description": "The id of a message to be opened. Will throw, if the provided ``messageId`` is unknown or invalid."
+                },
+                "headerMessageId": {
+                  "type": "string",
+                  "optional": true,
+                  "description": "The headerMessageId of a message to be opened. Will throw, if the provided ``headerMessageId`` is unknown or invalid."
+                },
+                "location": {
+                  "type": "string",
+                  "enum": [
+                    "tab",
+                    "window"
+                  ],
+                  "optional": true,
+                  "description": "Where to open the message. If not specified, the users preference is honoured."
+                },
+                "active": {
+                  "type": "boolean",
+                  "optional": true,
+                  "description": "Whether the new tab should become the active tab in the window. Only applicable to messages opened in tabs."
+                },
+                "windowId": {
+                  "type": "integer",
+                  "minimum": -2,
+                  "optional": true,
+                  "description": "The id of the window, where the new tab should be created. Defaults to the current window. Only applicable to messages opened in tabs."
+                }
+              }
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "parameters": [
+                {
+                  "name": "tab",
+                  "$ref": "tabs.Tab"
+                }
+              ]
+            }
+          ]
         }
       ]
     }
@@ -9285,7 +9488,8 @@
               "enum": [
                 "messagesMove",
                 "messagesRead",
-                "messagesDelete"
+                "messagesDelete",
+                "messagesTags"
               ]
             }
           ]
@@ -9334,6 +9538,10 @@
               "type": "string",
               "description": "The message-id header of the message."
             },
+            "headersOnly": {
+              "description": "Some account types (for example POP) allow to download only the headers of the message, but not its body. The body of such messages will not be available.",
+              "type": "boolean"
+            },
             "id": {
               "type": "integer",
               "minimum": 1
@@ -9695,7 +9903,7 @@
         {
           "name": "getFull",
           "type": "function",
-          "description": "Returns a specified message, including all headers and MIME parts.",
+          "description": "Returns a specified message, including all headers and MIME parts. Throws if the message could not be read, for example due to network issues.",
           "async": "callback",
           "parameters": [
             {
@@ -9717,7 +9925,7 @@
         {
           "name": "getRaw",
           "type": "function",
-          "description": "Returns the unmodified source of a message as a `binary string <https://developer.mozilla.org/en-US/docs/Web/API/DOMString/Binary>`__, which is a simple series of 8-bit values. 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`` header (example: `text/html; charset=UTF-8`) using the following function (see MDN for `supported input encodings <https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API/Encodings>`__): <literalinclude>includes/messages/decodeBinaryString.js<lang>JavaScript</lang></literalinclude>",
+          "description": "Returns the unmodified source of a message as a `binary string <https://developer.mozilla.org/en-US/docs/Web/API/DOMString/Binary>`__, 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`` header (example: `text/html; charset=UTF-8`) using the following function (see MDN for `supported input encodings <https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API/Encodings>`__): <literalinclude>includes/messages/decodeBinaryString.js<lang>JavaScript</lang></literalinclude>",
           "async": "callback",
           "parameters": [
             {
@@ -10029,6 +10237,78 @@
               ]
             }
           ]
+        },
+        {
+          "name": "createTag",
+          "type": "function",
+          "description": "Creates a new message tag. Tagging a message will store the tag's key in the user's message.",
+          "async": true,
+          "permissions": [
+            "messagesTags"
+          ],
+          "parameters": [
+            {
+              "type": "string",
+              "name": "key",
+              "pattern": "^[$a-zA-Z0-9]+$"
+            },
+            {
+              "type": "string",
+              "name": "tag"
+            },
+            {
+              "type": "string",
+              "name": "color",
+              "pattern": "^#[0-9a-f]{6}"
+            }
+          ]
+        },
+        {
+          "name": "updateTag",
+          "type": "function",
+          "description": "Updates a message tag.",
+          "async": true,
+          "permissions": [
+            "messagesTags"
+          ],
+          "parameters": [
+            {
+              "type": "string",
+              "name": "key",
+              "pattern": "^[$a-zA-Z0-9]+$"
+            },
+            {
+              "type": "object",
+              "name": "updateProperties",
+              "properties": {
+                "tag": {
+                  "type": "string",
+                  "optional": "true"
+                },
+                "color": {
+                  "type": "string",
+                  "pattern": "^#[0-9a-f]{6}",
+                  "optional": "true"
+                }
+              }
+            }
+          ]
+        },
+        {
+          "name": "deleteTag",
+          "type": "function",
+          "description": "Deletes a message tag, removing it from the list of known tags. Its key will not be removed from tagged messages, but they will appear untagged. Recreating a deleted tag, will make all former tagged messages appear tagged again.",
+          "async": true,
+          "permissions": [
+            "messagesTags"
+          ],
+          "parameters": [
+            {
+              "type": "string",
+              "name": "key",
+              "pattern": "^[$a-zA-Z0-9]+$"
+            }
+          ]
         }
       ]
     }
@@ -10486,12 +10766,13 @@
         {
           "name": "create",
           "type": "function",
-          "description": "Creates a new tab.",
+          "description": "Creates a new content tab. Use the :ref:`messageDisplay_api` to open messages.",
           "async": "callback",
           "parameters": [
             {
               "type": "object",
               "name": "createProperties",
+              "description": "Properties for the new tab. Defaults to an empty tab, if no ``url`` is provided.",
               "properties": {
                 "windowId": {
                   "type": "integer",
@@ -10508,7 +10789,7 @@
                 "url": {
                   "type": "string",
                   "optional": true,
-                  "description": "The URL to navigate the tab to initially. Fully-qualified URLs must include a scheme (i.e. 'http://www.google.com', not 'www.google.com'). Relative URLs will be relative to the current page within the extension. Defaults to the New Tab Page."
+                  "description": "The URL to navigate the tab to initially. Fully-qualified URLs must include a scheme (i.e. 'http://www.google.com', not 'www.google.com'). Relative URLs will be relative to the current page within the extension."
                 },
                 "active": {
                   "type": "boolean",
@@ -10681,16 +10962,17 @@
             {
               "type": "object",
               "name": "updateProperties",
+              "description": "Properties which should to be updated.",
               "properties": {
                 "url": {
                   "type": "string",
                   "optional": true,
-                  "description": "A URL to navigate the tab to."
+                  "description": "A URL to navigate the tab to. Only applicable for ``content`` tabs and active ``mail`` tabs."
                 },
                 "active": {
                   "type": "boolean",
                   "optional": true,
-                  "description": "Whether the tab should be active. Does not affect whether the window is focused (see :ref:`windows.update`)."
+                  "description": "Set this to true, if the tab should be active. Does not affect whether the window is focused (see :ref:`windows.update`). Setting this to false has no effect."
                 }
               }
             },

package/schemas/release/webext.json

@@ -2611,6 +2611,7 @@
                 },
                 "onclick": {
                   "type": "function",
+                  "max_manifest_version": 2,
                   "optional": true,
                   "description": "A function that will be called back when the menu item is clicked. Event pages cannot use this; instead, they should register a listener for $(ref:contextMenus.onClicked).",
                   "parameters": [
@@ -2766,6 +2767,7 @@
                 },
                 "onclick": {
                   "type": "function",
+                  "max_manifest_version": 2,
                   "optional": "omit-key-if-missing",
                   "parameters": [
                     {
@@ -4343,12 +4345,6 @@
               "optional": true,
               "description": "The ID of the tab that opened this tab, if any. This property is only present if the opener tab still exists."
             },
-            "selected": {
-              "type": "boolean",
-              "description": "Whether the tab is selected.",
-              "deprecated": "Please use $(ref:tabs.Tab.highlighted).",
-              "unsupported": true
-            },
             "highlighted": {
               "type": "boolean",
               "description": "Whether the tab is highlighted. Works as an alias of active"
@@ -4802,36 +4798,6 @@
             "description": "A port that can be used to communicate with the content scripts running in the specified tab. The port's $(ref:runtime.Port) event is fired if the tab closes or does not exist. "
           }
         },
-        {
-          "name": "sendRequest",
-          "deprecated": "Please use $(ref:runtime.sendMessage).",
-          "unsupported": true,
-          "type": "function",
-          "description": "Sends a single request to the content script(s) in the specified tab, with an optional callback to run when a response is sent back.  The $(ref:extension.onRequest) event is fired in each content script running in the specified tab for the current extension.",
-          "parameters": [
-            {
-              "type": "integer",
-              "name": "tabId",
-              "minimum": 0
-            },
-            {
-              "type": "any",
-              "name": "request"
-            },
-            {
-              "type": "function",
-              "name": "responseCallback",
-              "optional": true,
-              "parameters": [
-                {
-                  "name": "response",
-                  "type": "any",
-                  "description": "The JSON response object sent by the handler of the request. If an error occurs while connecting to the specified tab, the callback will be called with no arguments and $(ref:runtime.lastError) will be set to the error message."
-                }
-              ]
-            }
-          ]
-        },
         {
           "name": "sendMessage",
           "type": "function",
@@ -4874,63 +4840,6 @@
             }
           ]
         },
-        {
-          "name": "getSelected",
-          "deprecated": "Please use $(ref:tabs.query) <code>{active: true}</code>.",
-          "unsupported": true,
-          "type": "function",
-          "description": "Gets the tab that is selected in the specified window.",
-          "async": "callback",
-          "parameters": [
-            {
-              "type": "integer",
-              "name": "windowId",
-              "minimum": -2,
-              "optional": true,
-              "description": "Defaults to the $(topic:current-window)[current window]."
-            },
-            {
-              "type": "function",
-              "name": "callback",
-              "parameters": [
-                {
-                  "name": "tab",
-                  "$ref": "Tab"
-                }
-              ]
-            }
-          ]
-        },
-        {
-          "name": "getAllInWindow",
-          "deprecated": "Please use $(ref:tabs.query) <code>{windowId: windowId}</code>.",
-          "unsupported": true,
-          "type": "function",
-          "description": "Gets details about all tabs in the specified window.",
-          "async": "callback",
-          "parameters": [
-            {
-              "type": "integer",
-              "name": "windowId",
-              "minimum": -2,
-              "optional": true,
-              "description": "Defaults to the $(topic:current-window)[current window]."
-            },
-            {
-              "type": "function",
-              "name": "callback",
-              "parameters": [
-                {
-                  "name": "tabs",
-                  "type": "array",
-                  "items": {
-                    "$ref": "Tab"
-                  }
-                }
-              ]
-            }
-          ]
-        },
         {
           "name": "create",
           "type": "function",
@@ -4963,13 +4872,6 @@
                   "optional": true,
                   "description": "Whether the tab should become the active tab in the window. Does not affect whether the window is focused (see $(ref:windows.update)). Defaults to <var>true</var>."
                 },
-                "selected": {
-                  "deprecated": "Please use <em>active</em>.",
-                  "unsupported": true,
-                  "type": "boolean",
-                  "optional": true,
-                  "description": "Whether the tab should become the selected tab in the window. Defaults to <var>true</var>"
-                },
                 "pinned": {
                   "type": "boolean",
                   "optional": true,
@@ -5319,13 +5221,6 @@
                   "optional": true,
                   "description": "Adds or removes the tab from the current selection."
                 },
-                "selected": {
-                  "unsupported": true,
-                  "deprecated": "Please use <em>highlighted</em>.",
-                  "type": "boolean",
-                  "optional": true,
-                  "description": "Whether the tab should be selected."
-                },
                 "pinned": {
                   "type": "boolean",
                   "optional": true,
@@ -5639,6 +5534,7 @@
         {
           "name": "executeScript",
           "type": "function",
+          "max_manifest_version": 2,
           "description": "Injects JavaScript code into a page. For details, see the $(topic:content_scripts)[programmatic injection] section of the content scripts doc.",
           "async": "callback",
           "parameters": [
@@ -5676,6 +5572,7 @@
         {
           "name": "insertCSS",
           "type": "function",
+          "max_manifest_version": 2,
           "description": "Injects CSS into a page. For details, see the $(topic:content_scripts)[programmatic injection] section of the content scripts doc.",
           "async": "callback",
           "parameters": [
@@ -5703,6 +5600,7 @@
         {
           "name": "removeCSS",
           "type": "function",
+          "max_manifest_version": 2,
           "description": "Removes injected CSS from a page. For details, see the $(topic:content_scripts)[programmatic injection] section of the content scripts doc.",
           "async": "callback",
           "parameters": [
@@ -6170,58 +6068,6 @@
             }
           ]
         },
-        {
-          "name": "onSelectionChanged",
-          "deprecated": "Please use $(ref:tabs.onActivated).",
-          "unsupported": true,
-          "type": "function",
-          "description": "Fires when the selected tab in a window changes.",
-          "parameters": [
-            {
-              "type": "integer",
-              "name": "tabId",
-              "minimum": 0,
-              "description": "The ID of the tab that has become active."
-            },
-            {
-              "type": "object",
-              "name": "selectInfo",
-              "properties": {
-                "windowId": {
-                  "type": "integer",
-                  "minimum": 0,
-                  "description": "The ID of the window the selected tab changed inside of."
-                }
-              }
-            }
-          ]
-        },
-        {
-          "name": "onActiveChanged",
-          "deprecated": "Please use $(ref:tabs.onActivated).",
-          "unsupported": true,
-          "type": "function",
-          "description": "Fires when the selected tab in a window changes. Note that the tab's URL may not be set at the time this event fired, but you can listen to $(ref:tabs.onUpdated) events to be notified when a URL is set.",
-          "parameters": [
-            {
-              "type": "integer",
-              "name": "tabId",
-              "minimum": 0,
-              "description": "The ID of the tab that has become active."
-            },
-            {
-              "type": "object",
-              "name": "selectInfo",
-              "properties": {
-                "windowId": {
-                  "type": "integer",
-                  "minimum": 0,
-                  "description": "The ID of the window the selected tab changed inside of."
-                }
-              }
-            }
-          ]
-        },
         {
           "name": "onActivated",
           "type": "function",
@@ -6251,34 +6097,6 @@
             }
           ]
         },
-        {
-          "name": "onHighlightChanged",
-          "deprecated": "Please use $(ref:tabs.onHighlighted).",
-          "unsupported": true,
-          "type": "function",
-          "description": "Fired when the highlighted or selected tabs in a window changes.",
-          "parameters": [
-            {
-              "type": "object",
-              "name": "selectInfo",
-              "properties": {
-                "windowId": {
-                  "type": "integer",
-                  "minimum": 0,
-                  "description": "The window whose tabs changed."
-                },
-                "tabIds": {
-                  "type": "array",
-                  "items": {
-                    "type": "integer",
-                    "minimum": 0
-                  },
-                  "description": "All highlighted tabs in the window."
-                }
-              }
-            }
-          ]
-        },
         {
           "name": "onHighlighted",
           "type": "function",
@@ -8982,6 +8800,7 @@
   "content_scripts.json": [
     {
       "namespace": "contentScripts",
+      "max_manifest_version": 2,
       "types": [
         {
           "id": "RegisteredContentScriptOptions",
@@ -11331,7 +11150,6 @@
         {
           "name": "getBackgroundPage",
           "type": "function",
-          "max_manifest_version": 2,
           "description": "Returns the JavaScript 'window' object for the background page running inside the current extension. Returns null if the extension has no background page.",
           "parameters": [],
           "returns": {
@@ -15951,6 +15769,11 @@
             "world": {
               "$ref": "ExecutionWorld",
               "optional": true
+            },
+            "injectImmediately": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Whether the injection should be triggered in the target as soon as possible (but not necessarily prior to page load)."
             }
           }
         },
@@ -16479,6 +16302,23 @@
                 }
               ]
             }
+          ],
+          "events": [
+            {
+              "name": "onChanged",
+              "type": "function",
+              "description": "Fired when one or more items change.",
+              "parameters": [
+                {
+                  "name": "changes",
+                  "type": "object",
+                  "additionalProperties": {
+                    "$ref": "StorageChange"
+                  },
+                  "description": "Object mapping each key that changed to its corresponding $(ref:storage.StorageChange) for that item."
+                }
+              ]
+            }
           ]
         },
         {
@@ -16635,6 +16475,23 @@
                 }
               ]
             }
+          ],
+          "events": [
+            {
+              "name": "onChanged",
+              "type": "function",
+              "description": "Fired when one or more items change.",
+              "parameters": [
+                {
+                  "name": "changes",
+                  "type": "object",
+                  "additionalProperties": {
+                    "$ref": "StorageChange"
+                  },
+                  "description": "Object mapping each key that changed to its corresponding $(ref:storage.StorageChange) for that item."
+                }
+              ]
+            }
           ]
         }
       ],
@@ -18210,6 +18067,7 @@
           "properties": {
             "user_scripts": {
               "type": "object",
+              "max_manifest_version": 2,
               "optional": true,
               "properties": {
                 "api_script": {
@@ -18227,6 +18085,7 @@
     },
     {
       "namespace": "userScripts",
+      "max_manifest_version": 2,
       "permissions": [
         "manifest:user_scripts"
       ],
@@ -18350,6 +18209,7 @@
   "user_scripts_content.json": [
     {
       "namespace": "userScripts",
+      "max_manifest_version": 2,
       "permissions": [
         "manifest:user_scripts"
       ],