webext-schema 2.1.1 → 2.2.0

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.1",
+    "node-fetch": "^3.2.3",
     "sinon": "^13.0.1"
   },
   "devDependencies": {
@@ -41,12 +41,12 @@
     "eslint": "^7.32.0",
     "eslint-config-standard": "^16.0.3",
     "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-jsdoc": "^37.9.6",
+    "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.1"
+  "version": "2.2.0"
 }

package/schemas/beta/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": []
+            }
+          ]
         }
       ]
     }

package/schemas/central/webext.json

@@ -13018,6 +13018,11 @@
                 }
               ]
             },
+            "granted_host_permissions": {
+              "type": "boolean",
+              "optional": true,
+              "default": false
+            },
             "host_permissions": {
               "min_manifest_version": 3,
               "type": "array",
@@ -14493,9 +14498,6 @@
   "permissions.json": [
     {
       "namespace": "permissions",
-      "permissions": [
-        "manifest:optional_permissions"
-      ],
       "types": [
         {
           "id": "Permissions",
@@ -15337,7 +15339,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",
@@ -15943,6 +15944,10 @@
             "target": {
               "$ref": "InjectionTarget",
               "description": "Details specifying the target into which to inject the script."
+            },
+            "world": {
+              "$ref": "ExecutionWorld",
+              "optional": true
             }
           }
         },
@@ -16037,13 +16042,21 @@
             "ids": {
               "type": "array",
               "optional": true,
-              "description": "The IDs of specific scripts to retrieve with <code>getRegisteredContentScripts()</code>.",
+              "description": "The IDs of specific scripts to retrieve with <code>getRegisteredContentScripts()</code> or to unregister with <code>unregisterContentScripts()</code>.",
               "items": {
                 "type": "string"
               }
             }
           }
         },
+        {
+          "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 +16097,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"
+              }
             }
           }
         }
@@ -16205,6 +16232,59 @@
               ]
             }
           ]
+        },
+        {
+          "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": []
+            }
+          ]
+        },
+        {
+          "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": []
+            }
+          ]
         }
       ]
     }
@@ -17784,6 +17864,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",
@@ -2638,6 +2634,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": {