webext-schema 5.5.0 → 5.5.2

package/schemas/beta/webext.json

@@ -748,54 +748,6 @@
                       "type": "boolean",
                       "optional": true,
                       "description": "Sets the default engine to a built-in engine only."
-                    },
-                    "params": {
-                      "optional": true,
-                      "max_manifest_version": 2,
-                      "type": "array",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "name": {
-                            "type": "string",
-                            "description": "A url parameter name"
-                          },
-                          "condition": {
-                            "type": "string",
-                            "optional": true,
-                            "enum": [
-                              "purpose",
-                              "pref"
-                            ],
-                            "description": "The type of param can be either \"purpose\" or \"pref\"."
-                          },
-                          "pref": {
-                            "type": "string",
-                            "optional": true,
-                            "description": "The preference to retrieve the value from.",
-                            "preprocess": "localize"
-                          },
-                          "purpose": {
-                            "type": "string",
-                            "optional": true,
-                            "enum": [
-                              "contextmenu",
-                              "searchbar",
-                              "homepage",
-                              "keyword",
-                              "newtab"
-                            ],
-                            "description": "The context that initiates a search, required if condition is \"purpose\"."
-                          },
-                          "value": {
-                            "type": "string",
-                            "optional": true,
-                            "description": "A url parameter value.",
-                            "preprocess": "localize"
-                          }
-                        }
-                      },
-                      "description": "A list of optional search url parameters. This allows the additon of search url parameters based on how the search is performed in Firefox."
                     }
                   }
                 }
@@ -9638,6 +9590,7 @@
             "imageset",
             "web_manifest",
             "speculative",
+            "json",
             "other"
           ]
         },
@@ -12445,7 +12398,9 @@
             "cpufreq",
             "bandwidth",
             "memory",
-            "tracing"
+            "tracing",
+            "sandbox",
+            "flows"
           ]
         },
         {
@@ -13912,6 +13867,15 @@
             "$ref": "UnrecognizedProperty"
           }
         },
+        {
+          "id": "OptionalOnlyPermission",
+          "choices": [
+            {
+              "type": "string",
+              "enum": []
+            }
+          ]
+        },
         {
           "id": "OptionalPermissionNoPrompt",
           "choices": [
@@ -13946,6 +13910,9 @@
             {
               "$ref": "OptionalPermission"
             },
+            {
+              "$ref": "OptionalOnlyPermission"
+            },
             {
               "$ref": "MatchPattern"
             }
@@ -14419,7 +14386,7 @@
         {
           "name": "getLinkInfo",
           "type": "function",
-          "description": "Returns the $(ref:NetworkLinkInfo} of the current network connection.",
+          "description": "Returns the $(ref:NetworkLinkInfo) of the current network connection.",
           "async": true,
           "parameters": []
         }
@@ -15249,7 +15216,14 @@
             "permissions": {
               "type": "array",
               "items": {
-                "$ref": "manifest.OptionalPermission"
+                "choices": [
+                  {
+                    "$ref": "manifest.OptionalPermission"
+                  },
+                  {
+                    "$ref": "manifest.OptionalOnlyPermission"
+                  }
+                ]
               },
               "optional": true,
               "default": []
@@ -15271,7 +15245,14 @@
             "permissions": {
               "type": "array",
               "items": {
-                "$ref": "manifest.Permission"
+                "choices": [
+                  {
+                    "$ref": "manifest.Permission"
+                  },
+                  {
+                    "$ref": "manifest.OptionalOnlyPermission"
+                  }
+                ]
               },
               "optional": true,
               "default": []
@@ -16048,6 +16029,11 @@
               "type": "string",
               "optional": true,
               "description": "The TLS channel ID of the page or frame that opened the connection, if requested by the extension or app, and if available."
+            },
+            "userScriptWorldId": {
+              "type": "string",
+              "optional": true,
+              "description": "The worldId of the USER_SCRIPT world that sent the message. Only present on onUserScriptMessage and onUserScriptConnect (in port.sender) events."
             }
           }
         },
@@ -16716,6 +16702,20 @@
             }
           ]
         },
+        {
+          "name": "onUserScriptConnect",
+          "type": "function",
+          "description": "Fired when a connection is made from a USER_SCRIPT world registered through the userScripts API.",
+          "permissions": [
+            "userScripts"
+          ],
+          "parameters": [
+            {
+              "$ref": "Port",
+              "name": "port"
+            }
+          ]
+        },
         {
           "name": "onConnectExternal",
           "type": "function",
@@ -16785,6 +16785,36 @@
             "description": "Return true from the event listener if you wish to call <code>sendResponse</code> after the event listener returns."
           }
         },
+        {
+          "name": "onUserScriptMessage",
+          "type": "function",
+          "description": "Fired when a message is sent from a USER_SCRIPT world registered through the userScripts API.",
+          "permissions": [
+            "userScripts"
+          ],
+          "parameters": [
+            {
+              "name": "message",
+              "type": "any",
+              "optional": true,
+              "description": "The message sent by the calling script."
+            },
+            {
+              "name": "sender",
+              "$ref": "MessageSender"
+            },
+            {
+              "name": "sendResponse",
+              "type": "function",
+              "description": "Function to call (at most once) when you have a response. The argument should be any JSON-ifiable object. If you have more than one <code>onMessage</code> listener in the same document, then only one may send a response. This function becomes invalid when the event listener returns, unless you return true from the event listener to indicate you wish to send a response asynchronously (this will keep the message channel open to the other end until <code>sendResponse</code> is called)."
+            }
+          ],
+          "returns": {
+            "type": "boolean",
+            "optional": true,
+            "description": "Return true from the event listener if you wish to call <code>sendResponse</code> after the event listener returns."
+          }
+        },
         {
           "name": "onRestartRequired",
           "unsupported": true,
@@ -17874,6 +17904,7 @@
         },
         {
           "name": "scalarAdd",
+          "deprecated": "`scalarAdd` is a no-op since Firefox 134 (see bug 1930196)",
           "type": "function",
           "description": "Adds the value to the given scalar.",
           "async": true,
@@ -17893,6 +17924,7 @@
         },
         {
           "name": "scalarSet",
+          "deprecated": "`scalarSet` is a no-op since Firefox 134 (see bug 1930196)",
           "type": "function",
           "description": "Sets the named scalar to the given value. Throws if the value type doesn't match the scalar type.",
           "async": true,
@@ -17927,6 +17959,7 @@
         },
         {
           "name": "scalarSetMaximum",
+          "deprecated": "`scalarSetMaximum` is a no-op since Firefox 134 (see bug 1930196)",
           "type": "function",
           "description": "Sets the scalar to the maximum of the current and the passed value",
           "async": true,
@@ -17946,6 +17979,7 @@
         },
         {
           "name": "keyedScalarAdd",
+          "deprecated": "`keyedScalarAdd` is a no-op since Firefox 134 (see bug 1930196)",
           "type": "function",
           "description": "Adds the value to the given keyed scalar.",
           "async": true,
@@ -17970,6 +18004,7 @@
         },
         {
           "name": "keyedScalarSet",
+          "deprecated": "`keyedScalarSet` is a no-op since Firefox 134 (see bug 1930196)",
           "type": "function",
           "description": "Sets the keyed scalar to the given value. Throws if the value type doesn't match the scalar type.",
           "async": true,
@@ -18009,6 +18044,7 @@
         },
         {
           "name": "keyedScalarSetMaximum",
+          "deprecated": "`keyedScalarSetMaximum` is a no-op since Firefox 134 (see bug 1930196)",
           "type": "function",
           "description": "Sets the keyed scalar to the maximum of the current and the passed value",
           "async": true,
@@ -18072,6 +18108,7 @@
         },
         {
           "name": "registerScalars",
+          "deprecated": "`registerScalars` is a no-op since Firefox 134 (see bug 1930196)",
           "type": "function",
           "description": "Register new scalars to record them from addons. See nsITelemetry.idl for more details.",
           "async": true,
@@ -18939,6 +18976,110 @@
       ]
     }
   ],
+  "trial_ml.json": [
+    {
+      "namespace": "manifest",
+      "types": [
+        {
+          "$extend": "OptionalOnlyPermission",
+          "choices": [
+            {
+              "type": "string",
+              "enum": [
+                "trialML"
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "namespace": "trial",
+      "allowedContexts": [
+        "content"
+      ],
+      "permissions": [
+        "trialML"
+      ]
+    },
+    {
+      "namespace": "trial.ml",
+      "description": "Use the trial ML API to run Machine Learning models requests from extensions pages or content scripts.",
+      "allowedContexts": [
+        "content"
+      ],
+      "permissions": [
+        "trialML"
+      ],
+      "events": [
+        {
+          "name": "onProgress",
+          "type": "function",
+          "allowedContexts": [
+            "content"
+          ],
+          "description": "Events from the inference engine.",
+          "parameters": [
+            {
+              "name": "progressData",
+              "description": "Object containing the data, see https://firefox-source-docs.mozilla.org/toolkit/components/ml/notifications.html",
+              "type": "object"
+            }
+          ]
+        }
+      ],
+      "types": [
+        {
+          "id": "CreateEngineRequest",
+          "type": "object",
+          "additionalProperties": true
+        },
+        {
+          "id": "RunEngineRequest",
+          "type": "object",
+          "additionalProperties": true
+        }
+      ],
+      "functions": [
+        {
+          "name": "createEngine",
+          "type": "function",
+          "description": "Prepare the inference engine",
+          "async": true,
+          "parameters": [
+            {
+              "name": "CreateEngineRequest",
+              "$ref": "CreateEngineRequest"
+            }
+          ]
+        },
+        {
+          "name": "runEngine",
+          "type": "function",
+          "allowedContexts": [
+            "content"
+          ],
+          "description": "Call the inference engine",
+          "async": true,
+          "parameters": [
+            {
+              "name": "RunEngineRequest",
+              "$ref": "RunEngineRequest"
+            }
+          ]
+        },
+        {
+          "name": "deleteCachedModels",
+          "type": "function",
+          "allowedContexts": [
+            "content"
+          ],
+          "description": "Delete the models the extension downloaded.",
+          "async": true
+        }
+      ]
+    }
+  ],
   "types.json": [
     {
       "namespace": "types",
@@ -19111,6 +19252,17 @@
     {
       "namespace": "manifest",
       "types": [
+        {
+          "$extend": "OptionalOnlyPermission",
+          "choices": [
+            {
+              "type": "string",
+              "enum": [
+                "userScripts"
+              ]
+            }
+          ]
+        },
         {
           "$extend": "WebExtensionManifest",
           "properties": {
@@ -19134,13 +19286,14 @@
     },
     {
       "namespace": "userScripts",
-      "max_manifest_version": 2,
       "permissions": [
-        "manifest:user_scripts"
+        "manifest:user_scripts",
+        "userScripts"
       ],
       "types": [
         {
           "id": "UserScriptOptions",
+          "max_manifest_version": 2,
           "type": "object",
           "description": "Details of a user script",
           "properties": {
@@ -19226,29 +19379,322 @@
         },
         {
           "id": "RegisteredUserScript",
+          "min_manifest_version": 3,
           "type": "object",
           "description": "An object that represents a user script registered programmatically",
-          "functions": [
+          "properties": {
+            "id": {
+              "type": "string",
+              "optional": false,
+              "description": "The ID of the user script specified in the API call. This property must not start with a '_' as it's reserved as a prefix for generated script IDs."
+            },
+            "allFrames": {
+              "type": "boolean",
+              "optional": true,
+              "description": "If allFrames is <code>true</code>, implies that the JavaScript should be injected into all frames of current page. By default, it's <code>false</code> and is only injected into the top frame."
+            },
+            "js": {
+              "type": "array",
+              "optional": false,
+              "description": "The list of ScriptSource objects defining sources of scripts to be injected into matching pages.",
+              "items": {
+                "$ref": "ScriptSource"
+              }
+            },
+            "matches": {
+              "type": "array",
+              "optional": true,
+              "description": "At least one of matches or includeGlobs should be non-empty. The script runs in documents whose URL match either pattern.",
+              "items": {
+                "$ref": "manifest.MatchPattern"
+              }
+            },
+            "excludeMatches": {
+              "type": "array",
+              "optional": true,
+              "items": {
+                "$ref": "manifest.MatchPattern"
+              }
+            },
+            "includeGlobs": {
+              "type": "array",
+              "optional": true,
+              "description": "At least one of matches or includeGlobs should be non-empty. The script runs in documents whose URL match either pattern.",
+              "items": {
+                "type": "string"
+              }
+            },
+            "excludeGlobs": {
+              "type": "array",
+              "optional": true,
+              "items": {
+                "type": "string"
+              }
+            },
+            "runAt": {
+              "$ref": "extensionTypes.RunAt",
+              "optional": true,
+              "description": "The soonest that the JavaScript will be injected into the tab. Defaults to \"document_idle\"."
+            },
+            "world": {
+              "$ref": "ExecutionWorld",
+              "optional": true,
+              "description": "The JavaScript script for a script to execute within. Defaults to \"USER_SCRIPT\"."
+            },
+            "worldId": {
+              "type": "string",
+              "optional": true,
+              "description": "If specified, specifies a specific user script world ID to execute in. Only valid if `world` is omitted or is `USER_SCRIPT`. If `worldId` is omitted, the script will execute in the default user script world (\"\"). Values with leading underscores (`_`) are reserved. The maximum length is 256."
+            }
+          }
+        },
+        {
+          "id": "ExecutionWorld",
+          "min_manifest_version": 3,
+          "type": "string",
+          "enum": [
+            "MAIN",
+            "USER_SCRIPT"
+          ],
+          "description": "The JavaScript world for a script to execute within. <code>USER_SCRIPT</code> is the default execution environment of user scripts, <code>MAIN</code> is the web page's execution environment."
+        },
+        {
+          "id": "UserScriptFilter",
+          "min_manifest_version": 3,
+          "type": "object",
+          "description": "Optional filter to use with getScripts() and unregister().",
+          "properties": {
+            "ids": {
+              "type": "array",
+              "optional": true,
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        {
+          "id": "ScriptSource",
+          "min_manifest_version": 3,
+          "description": "Object with file xor code property. Equivalent to the ExtensionFileOrCode, except the file remains a relative URL.",
+          "choices": [
             {
-              "name": "unregister",
-              "type": "function",
-              "description": "Unregister a user script registered programmatically",
-              "async": true,
-              "parameters": []
+              "type": "object",
+              "properties": {
+                "file": {
+                  "type": "string",
+                  "description": "The path of the JavaScript file to inject relative to the extension's root directory.",
+                  "format": "unresolvedRelativeUrl"
+                }
+              }
+            },
+            {
+              "type": "object",
+              "properties": {
+                "code": {
+                  "type": "string"
+                }
+              }
             }
           ]
+        },
+        {
+          "id": "WorldProperties",
+          "min_manifest_version": 3,
+          "type": "object",
+          "description": "The configuration of a USER_SCRIPT world.",
+          "properties": {
+            "worldId": {
+              "type": "string",
+              "optional": true,
+              "default": "",
+              "description": "The identifier of the world. Values with leading underscores (`_`) are reserved. The maximum length is 256. Defaults to the default USER_SCRIPT world (\"\")."
+            },
+            "csp": {
+              "type": "string",
+              "optional": true,
+              "description": "The world's Content Security Policy. Defaults to the CSP of regular content scripts, which prohibits dynamic code execution such as eval."
+            },
+            "messaging": {
+              "type": "boolean",
+              "optional": true,
+              "default": false,
+              "description": "Whether the runtime.sendMessage and runtime.connect methods are exposed. Defaults to not exposing these messaging APIs."
+            }
+          }
         }
       ],
       "functions": [
         {
           "name": "register",
+          "max_manifest_version": 2,
           "type": "function",
-          "description": "Register a user script programmatically given its $(ref:userScripts.UserScriptOptions), and resolves to a $(ref:userScripts.RegisteredUserScript) instance",
-          "async": true,
+          "description": "Register a user script programmatically given its $(ref:userScripts.UserScriptOptions), and resolves to an object with the unregister() function",
+          "async": "callback",
           "parameters": [
             {
               "name": "userScriptOptions",
               "$ref": "UserScriptOptions"
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "parameters": [
+                {
+                  "name": "legacyRegisteredUserScript",
+                  "type": "object",
+                  "description": "An object that represents a user script registered programmatically",
+                  "properties": {
+                    "unregister": {
+                      "type": "function",
+                      "description": "Unregister a user script registered programmatically",
+                      "async": true,
+                      "parameters": []
+                    }
+                  }
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "register",
+          "min_manifest_version": 3,
+          "type": "function",
+          "description": "Registers one or more user scripts for this extension.",
+          "async": true,
+          "parameters": [
+            {
+              "name": "scripts",
+              "type": "array",
+              "items": {
+                "$ref": "RegisteredUserScript"
+              },
+              "description": "List of user scripts to be registered."
+            }
+          ]
+        },
+        {
+          "name": "update",
+          "min_manifest_version": 3,
+          "type": "function",
+          "description": "Updates one or more user scripts for this extension.",
+          "async": true,
+          "parameters": [
+            {
+              "name": "scripts",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "$import": "RegisteredUserScript",
+                "properties": {
+                  "js": {
+                    "type": "array",
+                    "optional": true,
+                    "items": {
+                      "$ref": "ScriptSource"
+                    }
+                  }
+                }
+              },
+              "description": "List of user scripts to be updated."
+            }
+          ]
+        },
+        {
+          "name": "unregister",
+          "min_manifest_version": 3,
+          "type": "function",
+          "description": "Unregisters all dynamically-registered user scripts for this extension.",
+          "async": true,
+          "parameters": [
+            {
+              "name": "filter",
+              "$ref": "UserScriptFilter",
+              "optional": true,
+              "description": "If specified, this method unregisters only the user scripts that match it."
+            }
+          ]
+        },
+        {
+          "name": "getScripts",
+          "min_manifest_version": 3,
+          "type": "function",
+          "description": "Returns all dynamically-registered user scripts for this extension.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "filter",
+              "$ref": "UserScriptFilter",
+              "optional": true,
+              "description": "If specified, this method returns only the user scripts that match it."
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "parameters": [
+                {
+                  "name": "scripts",
+                  "type": "array",
+                  "items": {
+                    "$ref": "RegisteredUserScript"
+                  },
+                  "description": "List of registered user scripts."
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "configureWorld",
+          "min_manifest_version": 3,
+          "type": "function",
+          "description": "Configures the environment for scripts running in a USER_SCRIPT world.",
+          "async": true,
+          "parameters": [
+            {
+              "name": "properties",
+              "$ref": "WorldProperties",
+              "description": "The desired configuration for a USER_SCRIPT world."
+            }
+          ]
+        },
+        {
+          "name": "resetWorldConfiguration",
+          "min_manifest_version": 3,
+          "type": "function",
+          "description": "Resets the configuration for a given world. That world will fall back to the default world's configuration.",
+          "async": true,
+          "parameters": [
+            {
+              "name": "worldId",
+              "type": "string",
+              "optional": true,
+              "default": "",
+              "description": "The ID of the USER_SCRIPT world to reset. If omitted or empty, resets the default world's configuration."
+            }
+          ]
+        },
+        {
+          "name": "getWorldConfigurations",
+          "min_manifest_version": 3,
+          "type": "function",
+          "description": "Returns all registered USER_SCRIPT world configurations.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "callback",
+              "type": "function",
+              "parameters": [
+                {
+                  "name": "configurations",
+                  "type": "array",
+                  "items": {
+                    "$ref": "WorldProperties"
+                  },
+                  "description": "All configurations registered with configureWorld()."
+                }
+              ]
             }
           ]
         }
@@ -19258,9 +19704,9 @@
   "user_scripts_content.json": [
     {
       "namespace": "userScripts",
-      "max_manifest_version": 2,
       "permissions": [
-        "manifest:user_scripts"
+        "manifest:user_scripts",
+        "userScripts"
       ],
       "allowedContexts": [
         "content"
@@ -19268,6 +19714,7 @@
       "events": [
         {
           "name": "onBeforeScript",
+          "max_manifest_version": 2,
           "permissions": [
             "manifest:user_scripts.api_script"
           ],
@@ -19978,6 +20425,7 @@
             "imageset",
             "web_manifest",
             "speculative",
+            "json",
             "other"
           ]
         },