webext-schema 2.1.2 → 2.2.1

package/modules/file-util.js

@@ -4,7 +4,7 @@
 
 /* api */
 import { IS_WIN } from './constant.js';
-import { URL, fileURLToPath } from 'url';
+import { fileURLToPath } from 'url';
 import { getType, isString } from './common.js';
 import fs, { promises as fsPromise } from 'fs';
 import path from 'path';

package/modules/update.js

@@ -4,7 +4,6 @@
 
 /* api */
 import { CHAR, INDENT } from './constant.js';
-import { URL } from 'url';
 import JSON5 from 'json5';
 import { createFile } from './file-util.js';
 import { getType, isString } from './common.js';

package/package.json

@@ -29,10 +29,10 @@
   },
   "dependencies": {
     "camelize": "^1.0.0",
-    "commander": "^9.0.0",
+    "commander": "^9.1.0",
     "decamelize": "^6.0.0",
-    "json5": "^2.2.0",
-    "node-fetch": "^3.2.2",
+    "json5": "^2.2.1",
+    "node-fetch": "^3.2.3",
     "sinon": "^13.0.1"
   },
   "devDependencies": {
@@ -44,9 +44,9 @@
     "eslint-plugin-jsdoc": "^37.9.7",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.2.0",
-    "mocha": "^9.2.1",
+    "mocha": "^9.2.2",
     "nock": "^13.2.4",
     "npm-run-all": "^4.1.5"
   },
-  "version": "2.1.2"
+  "version": "2.2.1"
 }

package/schemas/central/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": {

package/schemas/mail/mailext.json

@@ -1300,9 +1300,6 @@
   "permissions.json": [
     {
       "namespace": "permissions",
-      "permissions": [
-        "manifest:optional_permissions"
-      ],
       "types": [
         {
           "id": "Permissions",
@@ -1714,7 +1711,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",
@@ -2125,13 +2121,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."
         },
@@ -2638,6 +2632,26 @@
                   },
                   "maxItems": 15,
                   "optional": true
+                },
+                "color_scheme": {
+                  "description": "If set, overrides the general 'toolbar theme'.",
+                  "optional": true,
+                  "type": "string",
+                  "enum": [
+                    "light",
+                    "dark",
+                    "auto"
+                  ]
+                },
+                "content_color_scheme": {
+                  "description": "If set, overrides the color scheme for the content area.",
+                  "optional": true,
+                  "type": "string",
+                  "enum": [
+                    "light",
+                    "dark",
+                    "auto"
+                  ]
                 }
               },
               "additionalProperties": {
@@ -4837,7 +4851,7 @@
             "properties": {
               "aborted": {
                 "type": "boolean",
-                "description": "Set this to true if the file upload was aborted.",
+                "description": "Set this to true if the file upload was aborted by the user and an :ref:`cloudFile.onFileUploadAbort` event has been received. No error message will be shown to the user.",
                 "optional": true
               },
               "error": {
@@ -5419,6 +5433,14 @@
               "description": "Whether the message is an HTML message or a plain text 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``)",
+              "optional": true
+            },
             "attachments": {
               "type": "array",
               "items": {
@@ -5475,6 +5497,21 @@
               "description": "The size in bytes of this attachment. Read-only."
             }
           }
+        },
+        {
+          "id": "CustomHeader",
+          "type": "object",
+          "description": "A custom header definition.",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "Name of a custom header, must have a ``X-`` prefix.",
+              "pattern": "^X-.*$"
+            },
+            "value": {
+              "type": "string"
+            }
+          }
         }
       ],
       "events": [
@@ -10010,6 +10047,132 @@
       ]
     }
   ],
+  "spacesToolbar.json": [
+    {
+      "namespace": "spacesToolbar",
+      "types": [
+        {
+          "id": "ButtonProperties",
+          "type": "object",
+          "properties": {
+            "badgeBackgroundColor": {
+              "choices": [
+                {
+                  "type": "string"
+                },
+                {
+                  "$ref": "ColorArray"
+                }
+              ],
+              "optional": true,
+              "description": "Sets the background color of the badge. Can be specified as an array of four integers in the range [0,255] that make up the RGBA color of the badge. For example, opaque red is <code>[255, 0, 0, 255]</code>. Can also be a string with an HTML color name (<code>red</code>) or a HEX color value (<code>#FF0000</code> or <code>#F00</code>). Reset when set to an empty string."
+            },
+            "badgeText": {
+              "type": "string",
+              "optional": true,
+              "description": "Sets the badge text for the spaces toolbar button. The badge is displayed on top of the icon. Any number of characters can be set, but only about four can fit in the space. Removed when set to an empty string."
+            },
+            "defaultIcons": {
+              "choices": [
+                {
+                  "type": "string"
+                },
+                {
+                  "$ref": "manifest.IconPath"
+                }
+              ],
+              "optional": true,
+              "description": "Either a relative image path defining a single icon used for all sizes or an IconPathDictionary object defining dedicated icons for different sizes. At least the ``16px`` icon should be specified. The ``32px`` icon will be used on screens with a very high pixel density, if specified. Defaults to the extension icon, if set to an empty string."
+            },
+            "themeIcons": {
+              "type": "array",
+              "optional": true,
+              "items": {
+                "$ref": "manifest.ThemeIcons"
+              },
+              "description": "Specifies dark and light icons for the spaces toolbar button to be used with themes: The ``light`` icons will be used on dark backgrounds and vice versa. At least the set for ``16px`` icons should be specified. The set for ``32px`` icons will be used on screens with a very high pixel density, if specified."
+            },
+            "title": {
+              "type": "string",
+              "optional": true,
+              "description": "The title for the spaces toolbar button, used in the tooltip of the button and as the displayed name in the overflow menu. Defaults to the name of the extension, if set to an empty string."
+            },
+            "url": {
+              "type": "string",
+              "optional": true,
+              "description": "The page url, loaded into a tab when the button is clicked. Supported are ``https://`` and ``http://`` links, as well as links to WebExtension pages."
+            }
+          }
+        },
+        {
+          "id": "ColorArray",
+          "description": "An array of four integers in the range [0,255] that make up the RGBA color. For example, opaque red is <code>[255, 0, 0, 255]</code>.",
+          "type": "array",
+          "items": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 255
+          },
+          "minItems": 4,
+          "maxItems": 4
+        }
+      ],
+      "functions": [
+        {
+          "name": "addButton",
+          "type": "function",
+          "description": "Adds a new button to the spaces toolbar. Throws an exception, if the used ``id`` is not unique within the extension.",
+          "async": true,
+          "parameters": [
+            {
+              "name": "id",
+              "type": "string",
+              "pattern": "^[a-zA-Z0-9_]+$",
+              "description": "The unique id to assign to this button. May only contain alphanumeric characters and underscores."
+            },
+            {
+              "name": "properties",
+              "description": "Properties of the new button. The ``url`` is mandatory.",
+              "$ref": "spacesToolbar.ButtonProperties"
+            }
+          ]
+        },
+        {
+          "name": "removeButton",
+          "type": "function",
+          "description": "Removes the specified button from the spaces toolbar. Throws an exception if the requested spaces toolbar button does not exist. If the tab of this button is currently open, it will be closed.",
+          "async": true,
+          "parameters": [
+            {
+              "name": "id",
+              "type": "string",
+              "pattern": "^[a-zA-Z0-9_]+$",
+              "description": "The id of the button which is to be removed. May only contain alphanumeric characters and underscores."
+            }
+          ]
+        },
+        {
+          "name": "updateButton",
+          "type": "function",
+          "description": "Updates properties of the specified spaces toolbar button. Throws an exception if the requested spaces toolbar button does not exist.",
+          "async": true,
+          "parameters": [
+            {
+              "name": "id",
+              "type": "string",
+              "description": "The id of the button which is to be updated. May only contain alphanumeric characters and underscores.",
+              "pattern": "^[a-zA-Z0-9_]+$"
+            },
+            {
+              "name": "properties",
+              "description": "Only specified properties will be updated.",
+              "$ref": "spacesToolbar.ButtonProperties"
+            }
+          ]
+        }
+      ]
+    }
+  ],
   "tabs.json": [
     {
       "namespace": "manifest",

package/schemas/release/webext.json

@@ -15206,7 +15206,8 @@
             "s390x",
             "sparc64",
             "x86-32",
-            "x86-64"
+            "x86-64",
+            "noarch"
           ],
           "allowedContexts": [
             "content",
@@ -16028,6 +16029,65 @@
               "description": "Details specifying the target into which to inject the CSS."
             }
           }
+        },
+        {
+          "id": "ContentScriptFilter",
+          "type": "object",
+          "properties": {
+            "ids": {
+              "type": "array",
+              "optional": true,
+              "description": "The IDs of specific scripts to retrieve with <code>getRegisteredContentScripts()</code> or to unregister with <code>unregisterContentScripts()</code>.",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        {
+          "id": "RegisteredContentScript",
+          "type": "object",
+          "properties": {
+            "allFrames": {
+              "type": "boolean",
+              "optional": true,
+              "description": "If specified true, it will inject into all frames, even if the frame is not the top-most frame in the tab. Each frame is checked independently for URL requirements; it will not inject into child frames if the URL requirements are not met. Defaults to false, meaning that only the top frame is matched."
+            },
+            "excludeMatches": {
+              "type": "array",
+              "optional": true,
+              "description": "Excludes pages that this content script would otherwise be injected into.",
+              "items": {
+                "type": "string"
+              }
+            },
+            "id": {
+              "type": "string",
+              "description": "The id of the content script, specified in the API call."
+            },
+            "js": {
+              "type": "array",
+              "optional": true,
+              "description": "The list of JavaScript files to be injected into matching pages. These are injected in the order they appear in this array.",
+              "items": {
+                "$ref": "manifest.ExtensionURL"
+              }
+            },
+            "matches": {
+              "type": "array",
+              "optional": true,
+              "description": "Specifies which pages this content script will be injected into. Must be specified for <code>registerContentScripts()</code>.",
+              "items": {
+                "type": "string"
+              }
+            },
+            "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>."
+            }
+          }
         }
       ],
       "functions": [
@@ -16095,6 +16155,76 @@
               "parameters": []
             }
           ]
+        },
+        {
+          "name": "registerContentScripts",
+          "type": "function",
+          "description": "Registers one or more content scripts for this extension.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "scripts",
+              "type": "array",
+              "description": "Contains a list of scripts to be registered. If there are errors during script parsing/file validation, or if the IDs specified already exist, then no scripts are registered.",
+              "items": {
+                "$ref": "RegisteredContentScript"
+              }
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "Invoked upon completion of the registration.",
+              "parameters": []
+            }
+          ]
+        },
+        {
+          "name": "getRegisteredContentScripts",
+          "type": "function",
+          "description": "Returns all dynamically registered content scripts for this extension that match the given filter.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "filter",
+              "$ref": "ContentScriptFilter",
+              "optional": true,
+              "description": "An object to filter the extension's dynamically registered scripts."
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "The resulting array contains the registered content scripts.",
+              "parameters": [
+                {
+                  "name": "scripts",
+                  "type": "array",
+                  "items": {
+                    "$ref": "RegisteredContentScript"
+                  }
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "unregisterContentScripts",
+          "type": "function",
+          "description": "Unregisters one or more content scripts for this extension.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "filter",
+              "$ref": "ContentScriptFilter",
+              "optional": true,
+              "description": "If specified, only unregisters dynamic content scripts which match the filter. Otherwise, all of the extension's dynamic content scripts are unregistered."
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "Invoked upon completion of the unregistration.",
+              "parameters": []
+            }
+          ]
         }
       ]
     }