webext-schema 2.3.1 → 2.3.4

package/modules/browser.js

@@ -254,9 +254,11 @@ export const getEnabledTheme = async () => {
     const { management } = browser;
     try {
       const arr = await management.getAll();
-      res = arr.filter(info =>
-        info.type && info.type === 'theme' && info.enabled && info
-      );
+      if (Array.isArray(arr) && arr.length) {
+        res = arr.filter(info =>
+          info.type && info.type === 'theme' && info.enabled && info
+        );
+      }
     } catch (e) {
       logErr(e);
     }
@@ -299,7 +301,10 @@ export const getExternalExtensions = async () => {
     const { management } = browser;
     try {
       const arr = await management.getAll();
-      res = arr.filter(info => info.type && info.type === 'extension' && info);
+      if (Array.isArray(arr) && arr.length) {
+        res =
+          arr.filter(info => info.type && info.type === 'extension' && info);
+      }
     } catch (e) {
       logErr(e);
     }

package/modules/schema.js

@@ -83,7 +83,7 @@ export class Schema {
    */
   _assignImportMap() {
     if (this._importMap.size) {
-      const items = Array.from(this._importMap);
+      const items = [...this._importMap];
       for (const [key, value] of items) {
         const target = this._getTargetFromNamespace(key);
         if (target) {
@@ -111,7 +111,7 @@ export class Schema {
    */
   _assignRefMap() {
     if (this._refMap.size) {
-      const items = Array.from(this._refMap);
+      const items = [...this._refMap];
       for (const [key, value] of items) {
         const target = this._getTargetFromNamespace(key);
         if (target) {

package/package.json

@@ -32,7 +32,7 @@
     "commander": "^9.2.0",
     "decamelize": "^6.0.0",
     "json5": "^2.2.1",
-    "node-fetch": "^3.2.3",
+    "node-fetch": "^3.2.4",
     "sinon": "^13.0.2"
   },
   "devDependencies": {
@@ -41,12 +41,12 @@
     "eslint": "^8.14.0",
     "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^39.2.7",
+    "eslint-plugin-jsdoc": "^39.2.9",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.0.0",
-    "mocha": "^9.2.2",
+    "mocha": "^10.0.0",
     "nock": "^13.2.4",
     "npm-run-all": "^4.1.5"
   },
-  "version": "2.3.1"
+  "version": "2.3.4"
 }

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

package/schemas/central/webext.json

@@ -15769,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)."
             }
           }
         },

package/schemas/mail/mailext.json

@@ -2483,7 +2483,7 @@
                 "icons_attention": {
                   "$ref": "ThemeColor",
                   "optional": true,
-                  "description": "The color of the toolbar icons in attention state such as the chat icon whith new messages."
+                  "description": "The color of the toolbar icons in attention state such as the chat icon with new messages."
                 },
                 "button_background_hover": {
                   "$ref": "ThemeColor",

package/schemas/release/webext.json

@@ -5000,6 +5000,11 @@
                   "type": "string",
                   "optional": true,
                   "description": "The title used for display if the tab is created in discarded mode."
+                },
+                "muted": {
+                  "type": "boolean",
+                  "optional": true,
+                  "description": "Whether the tab should be muted when created."
                 }
               }
             },
@@ -13018,6 +13023,11 @@
                 }
               ]
             },
+            "granted_host_permissions": {
+              "type": "boolean",
+              "optional": true,
+              "default": false
+            },
             "host_permissions": {
               "min_manifest_version": 3,
               "type": "array",
@@ -14493,9 +14503,6 @@
   "permissions.json": [
     {
       "namespace": "permissions",
-      "permissions": [
-        "manifest:optional_permissions"
-      ],
       "types": [
         {
           "id": "Permissions",
@@ -15337,7 +15344,6 @@
       "functions": [
         {
           "name": "getBackgroundPage",
-          "max_manifest_version": 2,
           "type": "function",
           "description": "Retrieves the JavaScript 'window' object for the background page running inside the current extension/app. If the background page is an event page, the system will ensure it is loaded before calling the callback. If there is no background page, an error is set.",
           "async": "callback",
@@ -15748,13 +15754,11 @@
         },
         {
           "name": "onSuspend",
-          "unsupported": true,
           "type": "function",
           "description": "Sent to the event page just before it is unloaded. This gives the extension opportunity to do some clean up. Note that since the page is unloading, any asynchronous operations started while handling this event are not guaranteed to complete. If more activity for the event page occurs before it gets unloaded the onSuspendCanceled event will be sent and the page won't be unloaded. "
         },
         {
           "name": "onSuspendCanceled",
-          "unsupported": true,
           "type": "function",
           "description": "Sent after onSuspend to indicate that the app won't be unloaded after all."
         },
@@ -15943,6 +15947,10 @@
             "target": {
               "$ref": "InjectionTarget",
               "description": "Details specifying the target into which to inject the script."
+            },
+            "world": {
+              "$ref": "ExecutionWorld",
+              "optional": true
             }
           }
         },
@@ -16044,6 +16052,14 @@
             }
           }
         },
+        {
+          "id": "ExecutionWorld",
+          "type": "string",
+          "enum": [
+            "ISOLATED"
+          ],
+          "description": "The JavaScript world for a script to execute within. We currently only support the <code>'ISOLATED'</code> world."
+        },
         {
           "id": "RegisteredContentScript",
           "type": "object",
@@ -16084,8 +16100,22 @@
             "runAt": {
               "$ref": "extensionTypes.RunAt",
               "optional": true,
-              "default": "document_idle",
               "description": "Specifies when JavaScript files are injected into the web page. The preferred and default value is <code>document_idle</code>."
+            },
+            "persistAcrossSessions": {
+              "type": "boolean",
+              "enum": [
+                false
+              ],
+              "description": "Specifies if this content script will persist into future sessions. This is currently NOT supported."
+            },
+            "css": {
+              "type": "array",
+              "optional": true,
+              "description": "The list of CSS files to be injected into matching pages. These are injected in the order they appear in this array.",
+              "items": {
+                "$ref": "manifest.ExtensionURL"
+              }
             }
           }
         }
@@ -16225,6 +16255,39 @@
               "parameters": []
             }
           ]
+        },
+        {
+          "name": "updateContentScripts",
+          "type": "function",
+          "description": "Updates one or more content scripts for this extension.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "scripts",
+              "type": "array",
+              "description": "Contains a list of scripts to be updated. If there are errors during script parsing/file validation, or if the IDs specified do not already exist, then no scripts are updated.",
+              "items": {
+                "type": "object",
+                "$import": "RegisteredContentScript",
+                "properties": {
+                  "persistAcrossSessions": {
+                    "type": "boolean",
+                    "optional": true,
+                    "enum": [
+                      false
+                    ],
+                    "description": "Specifies if this content script will persist into future sessions. This is currently NOT supported."
+                  }
+                }
+              }
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "Invoked when scripts have been updated.",
+              "parameters": []
+            }
+          ]
         }
       ]
     }
@@ -17804,6 +17867,26 @@
                   },
                   "maxItems": 15,
                   "optional": true
+                },
+                "color_scheme": {
+                  "optional": true,
+                  "type": "string",
+                  "enum": [
+                    "auto",
+                    "light",
+                    "dark",
+                    "system"
+                  ]
+                },
+                "content_color_scheme": {
+                  "optional": true,
+                  "type": "string",
+                  "enum": [
+                    "auto",
+                    "light",
+                    "dark",
+                    "system"
+                  ]
                 }
               },
               "additionalProperties": {