webext-schema 3.0.1 → 3.0.2

package/modules/browser.js

@@ -424,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 runtime.connect(extId, info);
+      port = await tabs.connect(id, info);
     } else {
-      port = await runtime.connect(extId);
+      port = await tabs.connect(id);
     }
-  } else if (isObjectNotEmpty(extId)) {
-    port = await runtime.connect(extId);
-  } else if (!extId && isObjectNotEmpty(info)) {
+  } else if (isString(id)) {
+    if (isObjectNotEmpty(info)) {
+      port = await runtime.connect(id, info);
+    } else {
+      port = await runtime.connect(id);
+    }
+  } else if (isObjectNotEmpty(id)) {
+    port = await runtime.connect(id);
+  } else if (!id && isObjectNotEmpty(info)) {
     port = await runtime.connect(info);
   } else {
     port = await runtime.connect();
@@ -728,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/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

@@ -36,17 +36,17 @@
     "sinon": "^14.0.0"
   },
   "devDependencies": {
-    "c8": "^7.11.2",
+    "c8": "^7.11.3",
     "chai": "^4.3.6",
-    "eslint": "^8.15.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": "3.0.1"
+  "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",
@@ -16634,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
             }
           }
         }
@@ -8853,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"
+                }
+              ]
+            }
+          ]
         }
       ]
     }
@@ -10708,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",
@@ -10730,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",
@@ -10903,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"
       ],