webext-schema 2.1.3 → 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,7 +29,7 @@
   },
   "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.3",
@@ -48,5 +48,5 @@
     "nock": "^13.2.4",
     "npm-run-all": "^4.1.5"
   },
-  "version": "2.1.3"
+  "version": "2.2.0"
 }

package/schemas/central/webext.json

@@ -15339,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",
@@ -15945,6 +15944,10 @@
             "target": {
               "$ref": "InjectionTarget",
               "description": "Details specifying the target into which to inject the script."
+            },
+            "world": {
+              "$ref": "ExecutionWorld",
+              "optional": true
             }
           }
         },
@@ -16046,6 +16049,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",
@@ -16086,7 +16097,6 @@
             "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": {
@@ -16095,6 +16105,14 @@
                 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"
+              }
             }
           }
         }
@@ -16234,6 +16252,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": []
+            }
+          ]
         }
       ]
     }
@@ -17813,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

@@ -1711,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",
@@ -2635,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": {

package/schemas/release/webext.json

@@ -11776,6 +11776,7 @@
             "samplingallthreads",
             "markersallthreads",
             "unregisteredthreads",
+            "processcpu",
             "responsiveness"
           ]
         },
@@ -12895,7 +12896,9 @@
                     },
                     "persistent": {
                       "optional": true,
-                      "$ref": "PersistentBackgroundProperty"
+                      "type": "boolean",
+                      "max_manifest_version": 2,
+                      "default": true
                     }
                   },
                   "additionalProperties": {
@@ -12913,7 +12916,9 @@
                     },
                     "persistent": {
                       "optional": true,
-                      "$ref": "PersistentBackgroundProperty"
+                      "type": "boolean",
+                      "max_manifest_version": 2,
+                      "default": true
                     }
                   },
                   "additionalProperties": {
@@ -13536,24 +13541,6 @@
           "id": "UnrecognizedProperty",
           "type": "any",
           "deprecated": "An unexpected property was found in the WebExtension manifest."
-        },
-        {
-          "id": "PersistentBackgroundProperty",
-          "choices": [
-            {
-              "type": "boolean",
-              "enum": [
-                true
-              ]
-            },
-            {
-              "type": "boolean",
-              "enum": [
-                false
-              ],
-              "deprecated": "Event pages are not currently supported. This will run as a persistent background page."
-            }
-          ]
         }
       ]
     }
@@ -15941,7 +15928,7 @@
             "files": {
               "type": "array",
               "optional": true,
-              "description": "The path of the JS or CSS files to inject, relative to the extension's root directory. Exactly one of <code>files</code> and <code>func</code> must be specified.",
+              "description": "The path of the JS files to inject, relative to the extension's root directory. Exactly one of <code>files</code> and <code>func</code> must be specified.",
               "minItems": 1,
               "items": {
                 "type": "string"
@@ -15964,13 +15951,24 @@
           "description": "Result of a script injection.",
           "properties": {
             "frameId": {
-              "type": "number",
+              "type": "integer",
               "description": "The frame ID associated with the injection."
             },
             "result": {
               "type": "any",
               "optional": true,
               "description": "The result of the script execution."
+            },
+            "error": {
+              "type": "object",
+              "optional": true,
+              "description": "When the injection has failed, the error is exposed to the caller with this property.",
+              "properties": {
+                "message": {
+                  "type": "string",
+                  "description": "A message explaining why the injection has failed."
+                }
+              }
             }
           }
         },
@@ -15986,11 +15984,50 @@
                 "type": "number"
               }
             },
+            "allFrames": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Whether the script should inject into all frames within the tab. Defaults to false. This must not be true if <code>frameIds</code> is specified."
+            },
             "tabId": {
               "type": "number",
               "description": "The ID of the tab into which to inject."
             }
           }
+        },
+        {
+          "id": "CSSInjection",
+          "type": "object",
+          "properties": {
+            "css": {
+              "type": "string",
+              "optional": true,
+              "description": "A string containing the CSS to inject. Exactly one of <code>files</code> and <code>css</code> must be specified."
+            },
+            "files": {
+              "type": "array",
+              "optional": true,
+              "description": "The path of the CSS files to inject, relative to the extension's root directory. Exactly one of <code>files</code> and <code>css</code> must be specified.",
+              "minItems": 1,
+              "items": {
+                "type": "string"
+              }
+            },
+            "origin": {
+              "type": "string",
+              "optional": true,
+              "enum": [
+                "USER",
+                "AUTHOR"
+              ],
+              "default": "AUTHOR",
+              "description": "The style origin for the injection. Defaults to <code>'AUTHOR'</code>."
+            },
+            "target": {
+              "$ref": "InjectionTarget",
+              "description": "Details specifying the target into which to inject the CSS."
+            }
+          }
         }
       ],
       "functions": [
@@ -16020,6 +16057,44 @@
               ]
             }
           ]
+        },
+        {
+          "name": "insertCSS",
+          "type": "function",
+          "description": "Inserts a CSS stylesheet into a target context. If multiple frames are specified, unsuccessful injections are ignored.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "injection",
+              "$ref": "CSSInjection",
+              "description": "The details of the styles to insert."
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "Invoked upon completion of the injection.",
+              "parameters": []
+            }
+          ]
+        },
+        {
+          "name": "removeCSS",
+          "type": "function",
+          "description": "Removes a CSS stylesheet that was previously inserted by this extension from a target context.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "injection",
+              "$ref": "CSSInjection",
+              "description": "The details of the styles to remove. Note that the <code>css</code>, <code>files</code>, and <code>origin</code> properties must exactly match the stylesheet inserted through <code>insertCSS</code>. Attempting to remove a non-existent stylesheet is a no-op."
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "Invoked upon completion of the injection.",
+              "parameters": []
+            }
+          ]
         }
       ]
     }
@@ -18009,6 +18084,22 @@
               "default": "document_idle",
               "optional": true,
               "description": "The soonest that the JavaScript will be injected into the tab. Defaults to \"document_idle\"."
+            },
+            "cookieStoreId": {
+              "choices": [
+                {
+                  "type": "array",
+                  "minItems": 1,
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                {
+                  "type": "string"
+                }
+              ],
+              "optional": true,
+              "description": "limit the set of matched tabs to those that belong to the given cookie store id"
             }
           }
         },