webext-schema 7.1.0 → 7.1.1

package/schemas/central/webext.json

@@ -3059,146 +3059,6 @@
       ]
     }
   ],
-  "normandyAddonStudy.json": [
-    {
-      "namespace": "manifest",
-      "types": [
-        {
-          "$extend": "PermissionPrivileged",
-          "choices": [
-            {
-              "type": "string",
-              "enum": [
-                "normandyAddonStudy"
-              ]
-            }
-          ]
-        }
-      ]
-    },
-    {
-      "namespace": "normandyAddonStudy",
-      "description": "Normandy Study API",
-      "allowedContexts": [
-        "content",
-        "devtools"
-      ],
-      "defaultContexts": [
-        "content",
-        "devtools"
-      ],
-      "permissions": [
-        "normandyAddonStudy"
-      ],
-      "types": [
-        {
-          "id": "Study",
-          "type": "object",
-          "properties": {
-            "recipeId": {
-              "type": "integer",
-              "description": "The ID of the recipe for the study."
-            },
-            "slug": {
-              "type": "string",
-              "description": "A slug to identify the study."
-            },
-            "userFacingName": {
-              "type": "string",
-              "description": "The name presented on about:studies."
-            },
-            "userFacingDescription": {
-              "type": "string",
-              "description": "The description presented on about:studies."
-            },
-            "branch": {
-              "type": "string",
-              "description": "The study branch in which the user is enrolled."
-            },
-            "active": {
-              "type": "boolean",
-              "description": "The state of the study."
-            },
-            "addonId": {
-              "type": "string",
-              "description": "The ID of the extension installed by the study."
-            },
-            "addonUrl": {
-              "type": "string",
-              "description": "The URL of the XPI that was downloaded and installed by the study."
-            },
-            "addonVersion": {
-              "type": "string",
-              "description": "The version of the extension installed by the study."
-            },
-            "studyStartDate": {
-              "$ref": "extensionTypes.Date",
-              "description": "The start date for the study."
-            },
-            "studyEndDate": {
-              "$ref": "extensionTypes.Date",
-              "description": "The end date for the study."
-            },
-            "extensionApiId": {
-              "type": "integer",
-              "description": "The record ID for the extension in Normandy server's database."
-            },
-            "extensionHash": {
-              "type": "string",
-              "description": "A hash of the extension XPI file."
-            },
-            "extensionHashAlgorithm": {
-              "type": "string",
-              "description": "The algorithm used to hash the extension XPI file."
-            }
-          }
-        }
-      ],
-      "functions": [
-        {
-          "name": "getStudy",
-          "type": "function",
-          "description": "Returns a study object for the current study.",
-          "async": true,
-          "parameters": []
-        },
-        {
-          "name": "endStudy",
-          "type": "function",
-          "description": "Marks the study as ended and then uninstalls the addon.",
-          "async": true,
-          "parameters": [
-            {
-              "type": "string",
-              "name": "reason",
-              "description": "The reason why the study is ending."
-            }
-          ]
-        },
-        {
-          "name": "getClientMetadata",
-          "type": "function",
-          "description": "Returns an object with metadata about the client which may be required for constructing survey URLs.",
-          "async": true,
-          "parameters": []
-        }
-      ],
-      "events": [
-        {
-          "name": "onUnenroll",
-          "type": "function",
-          "description": "Fired when a user unenrolls from a study but before the addon is uninstalled.",
-          "parameters": [
-            {
-              "type": "string",
-              "name": "reason",
-              "description": "The reason why the study is ending."
-            }
-          ]
-        }
-      ]
-    }
-  ],
   "omnibox.json": [
     {
       "namespace": "manifest",
@@ -7733,13 +7593,7 @@
             {
               "type": "function",
               "name": "callback",
-              "parameters": [
-                {
-                  "name": "wasCleared",
-                  "type": "boolean",
-                  "description": "Whether any alarm was found to clear."
-                }
-              ]
+              "parameters": []
             }
           ]
         }
@@ -9273,6 +9127,21 @@
               "description": "The cookie store ID of the contextual identity."
             }
           }
+        },
+        {
+          "id": "SiteAssociation",
+          "type": "object",
+          "description": "Represents the association between a site and a contextual identity.",
+          "properties": {
+            "site": {
+              "type": "string",
+              "description": "The associated host, normalized to lower case and encoded as ASCII."
+            },
+            "cookieStoreId": {
+              "type": "string",
+              "description": "The cookie store ID of the contextual identity the host is associated with."
+            }
+          }
         }
       ],
       "functions": [
@@ -9476,6 +9345,113 @@
               "description": "The ID of the contextual identity cookie store. "
             }
           ]
+        },
+        {
+          "name": "setSiteAssociation",
+          "type": "function",
+          "description": "Associates a site with a container. Top-level navigations to that site will load in the given container.",
+          "async": true,
+          "parameters": [
+            {
+              "type": "object",
+              "name": "details",
+              "description": "Details about the site association.",
+              "properties": {
+                "site": {
+                  "type": "string",
+                  "description": "The host to associate with the container (matched as an exact host)."
+                },
+                "cookieStoreId": {
+                  "type": "string",
+                  "description": "The cookie store ID of the container to associate the site with."
+                }
+              }
+            }
+          ]
+        },
+        {
+          "name": "removeSiteAssociation",
+          "type": "function",
+          "description": "Removes the container association for a site.",
+          "async": true,
+          "parameters": [
+            {
+              "type": "object",
+              "name": "details",
+              "description": "Details about the site association to remove.",
+              "properties": {
+                "site": {
+                  "type": "string",
+                  "description": "The host whose container association should be removed."
+                }
+              }
+            }
+          ]
+        },
+        {
+          "name": "getSiteAssociation",
+          "type": "function",
+          "description": "Retrieves the association of a site, or null if the site is not associated with any container.",
+          "async": "callback",
+          "parameters": [
+            {
+              "type": "object",
+              "name": "details",
+              "description": "Details about the site to look up.",
+              "properties": {
+                "site": {
+                  "type": "string",
+                  "description": "The host to look up."
+                }
+              }
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "parameters": [
+                {
+                  "name": "association",
+                  "$ref": "SiteAssociation",
+                  "optional": true,
+                  "description": "The association of the site, null if the site is not associated with any container."
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "querySiteAssociations",
+          "type": "function",
+          "description": "Retrieves the list of site-to-container associations.",
+          "async": "callback",
+          "parameters": [
+            {
+              "type": "object",
+              "name": "details",
+              "description": "Information to filter the associations being retrieved.",
+              "properties": {
+                "cookieStoreId": {
+                  "type": "string",
+                  "optional": true,
+                  "description": "If provided, only associations for this container are returned."
+                }
+              }
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "parameters": [
+                {
+                  "name": "associations",
+                  "type": "array",
+                  "items": {
+                    "$ref": "SiteAssociation"
+                  },
+                  "description": "The site-to-container associations."
+                }
+              ]
+            }
+          ]
         }
       ],
       "events": [
@@ -9529,6 +9505,28 @@
               }
             }
           ]
+        },
+        {
+          "name": "onSiteAssociationChanged",
+          "type": "function",
+          "description": "Fired when a site-to-container association is added, changed, or removed.",
+          "parameters": [
+            {
+              "type": "object",
+              "name": "changeInfo",
+              "properties": {
+                "site": {
+                  "type": "string",
+                  "description": "The host whose association changed."
+                },
+                "cookieStoreId": {
+                  "type": "string",
+                  "optional": true,
+                  "description": "The cookie store ID of the now-associated container, or omitted if the association was removed."
+                }
+              }
+            }
+          ]
         }
       ]
     }
@@ -17118,6 +17116,20 @@
             "description": "The manifest details."
           }
         },
+        {
+          "name": "getVersion",
+          "allowedContexts": [
+            "content",
+            "devtools"
+          ],
+          "description": "Returns the extension version as declared in the manifest.",
+          "type": "function",
+          "parameters": [],
+          "returns": {
+            "type": "string",
+            "description": "The extension version."
+          }
+        },
         {
           "name": "getURL",
           "type": "function",
@@ -19578,6 +19590,15 @@
               "type": "object",
               "optional": true,
               "properties": {
+                "backgrounds_area": {
+                  "type": "string",
+                  "enum": [
+                    "auto",
+                    "window",
+                    "top_toolbars"
+                  ],
+                  "optional": true
+                },
                 "additional_backgrounds_alignment": {
                   "type": "array",
                   "items": {

package/schemas/mail/mailext.json

@@ -2054,6 +2054,20 @@
             "description": "The manifest details."
           }
         },
+        {
+          "name": "getVersion",
+          "allowedContexts": [
+            "content",
+            "devtools"
+          ],
+          "description": "Returns the extension version as declared in the manifest.",
+          "type": "function",
+          "parameters": [],
+          "returns": {
+            "type": "string",
+            "description": "The extension version."
+          }
+        },
         {
           "name": "getURL",
           "type": "function",
@@ -15013,8 +15027,8 @@
             {
               "type": "string",
               "name": "key",
-              "description": "Unique tag identifier (will be converted to lower case). Must not include <var>()<>{/%*\"</var> or spaces.",
-              "pattern": "^[^ ()/{%*<>\"]+$"
+              "description": "Unique tag identifier (will be converted to lower case). Must be an ASCII string that is safe to use as an IMAP keyword.",
+              "pattern": "^[!#$&'+,\\-.0-9:=?@A-Z^_`a-z|~]+$"
             },
             {
               "type": "string",
@@ -15280,8 +15294,8 @@
               "type": "string",
               "name": "key",
               "optional": true,
-              "description": "Unique tag identifier (will be converted to lower case). Must not include <var>()<>{/%*\"</var> or spaces. Will be auto-generated if not provided.",
-              "pattern": "^[^ ()/{%*<>\"]+$"
+              "description": "Unique tag identifier (will be converted to lower case). Must be an ASCII string that is safe to use as an IMAP keyword. Will be auto-generated if not provided.",
+              "pattern": "^[!#$&'+,\\-.0-9:=?@A-Z^_`a-z|~]+$"
             },
             {
               "type": "string",
@@ -15708,13 +15722,22 @@
                   "optional": true
                 },
                 "hostnames": {
-                  "description": "One or more hostnames which use this OAuth provider.",
+                  "description": "One or more server hostnames that use this OAuth provider. Include any service or autodiscovery hostnames that may initiate OAuth authentication. For example, to override many Microsoft configurations, both of these would be needed - [\"office365.com\", \"outlook.com\"]",
                   "type": "array",
                   "items": {
                     "type": "string"
                   },
                   "minItems": 1
                 },
+                "emailDomains": {
+                  "description": "Email domains for which this OAuth provider should be used. If omitted, the provider applies to all domains in use with a given hostname",
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  },
+                  "minItems": 1,
+                  "optional": true
+                },
                 "scopes": {
                   "description": "The scopes to request when using this OAuth provider.",
                   "type": "string"