webext-schema 5.4.3 → 5.5.1

package/schemas/mail/mailext.json

@@ -1352,7 +1352,14 @@
             "permissions": {
               "type": "array",
               "items": {
-                "$ref": "manifest.OptionalPermission"
+                "choices": [
+                  {
+                    "$ref": "manifest.OptionalPermission"
+                  },
+                  {
+                    "$ref": "manifest.OptionalOnlyPermission"
+                  }
+                ]
               },
               "optional": true,
               "default": []
@@ -1374,7 +1381,14 @@
             "permissions": {
               "type": "array",
               "items": {
-                "$ref": "manifest.Permission"
+                "choices": [
+                  {
+                    "$ref": "manifest.Permission"
+                  },
+                  {
+                    "$ref": "manifest.OptionalOnlyPermission"
+                  }
+                ]
               },
               "optional": true,
               "default": []
@@ -1720,6 +1734,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."
             }
           }
         },
@@ -2388,6 +2407,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",
@@ -2457,6 +2490,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,
@@ -5623,9 +5686,18 @@
                       "preprocess": "localize"
                     },
                     "favicon_url": {
-                      "type": "string",
+                      "choices": [
+                        {
+                          "type": "string",
+                          "format": "relativeUrl",
+                          "max_manifest_version": 2
+                        },
+                        {
+                          "type": "string",
+                          "format": "strictRelativeUrl"
+                        }
+                      ],
                       "optional": true,
-                      "format": "url",
                       "preprocess": "localize"
                     },
                     "suggest_url": {
@@ -8631,7 +8703,7 @@
                 "STORAGE",
                 "MESSAGE"
               ],
-              "description": "The type of the quota as defined by RFC2087. A <var>STORAGE</var> quota is constraining the available storage in bytes, a <var>MESSAGE</var> quota is constraining the number of storable messages."
+              "description": "The type of the quota as defined by RFC 2087. A <var>STORAGE</var> quota is constraining the available storage in bytes, a <var>MESSAGE</var> quota is constraining the number of storable messages."
             },
             "limit": {
               "type": "integer",
@@ -10611,7 +10683,7 @@
         {
           "name": "getSelectedFolders",
           "type": "function",
-          "description": "Lists the selected folders in the folder pane.",
+          "description": "Lists the selected folders in the folder pane. Does not include folders which are context-clicked, but not selected. The context-clicked folders are always returned by the $(ref:menus.onClicked) event of the menus API.",
           "permissions": [
             "accountsRead"
           ],
@@ -10642,7 +10714,7 @@
         {
           "name": "getSelectedMessages",
           "type": "function",
-          "description": "Lists the selected messages in the current folder.",
+          "description": "Lists the selected messages in the current folder. Includes messages in collapsed threads. Does not include messages which are context-clicked, but not selected. The context-clicked messages are always returned by the $(ref:menus.onClicked) event of the menus API.",
           "permissions": [
             "messagesRead"
           ],
@@ -10670,7 +10742,7 @@
         {
           "name": "setSelectedMessages",
           "type": "function",
-          "description": "Selects none, one or multiple messages.",
+          "description": "Selects none, one or multiple messages. Opens collapsed threads to show the selection, if required.",
           "permissions": [
             "messagesRead",
             "accountsRead"
@@ -12886,7 +12958,7 @@
           "properties": {
             "body": {
               "type": "string",
-              "description": "The content of the part.",
+              "description": "The quoted-printable or base64 decoded content of the part. Only present for parts with a content type of <var>text/*</var> and only if requested, see the <var>decodeContent</var> option of $(ref:messages.getFull). Use $(ref:messages.getAttachmentFile) to retrieve the content of parts which have a content type other than <var>text/*</var>.",
               "optional": true
             },
             "contentType": {
@@ -12906,7 +12978,7 @@
             },
             "headers": {
               "type": "object",
-              "description": "A <em>dictionary object</em> of part headers as <em>key-value</em> pairs, with the header name as <em>key</em>, and an array of headers as <em>value</em>.",
+              "description": "A <em>dictionary object</em> of RFC 2047 decoded part headers as <em>key-value</em> pairs, with the header name as <em>key</em>, and an array of headers as <em>value</em>. Only present if requested, see the <var>decodeHeaders</var> option of $(ref:messages.getFull).",
               "optional": true,
               "additionalProperties": {
                 "type": "array",
@@ -12933,6 +13005,22 @@
               "description": "Any sub-parts of this part.",
               "optional": true
             },
+            "rawBody": {
+              "type": "string",
+              "description": "The raw content of the part. Only present if requested, see the <var>decodeContent</var> option of $(ref:messages.getFull).",
+              "optional": true
+            },
+            "rawHeaders": {
+              "type": "object",
+              "description": "A <em>dictionary object</em> of raw part headers as <em>key-value</em> pairs, with the header name as <em>key</em>, and an array of headers as <em>value</em>. Only present if requested, see the <var>decodeHeaders</var> option of $(ref:messages.getFull).",
+              "optional": true,
+              "additionalProperties": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            },
             "size": {
               "type": "integer",
               "optional": true,
@@ -13252,7 +13340,17 @@
               "properties": {
                 "decrypt": {
                   "type": "boolean",
-                  "description": "Whether the message should be decrypted. If the message could not be decrypted, its parts are omitted. Defaults to true.",
+                  "description": "Whether the message should be decrypted. If the message could not be decrypted, its parts are omitted. Defaults to <var>true</var>.",
+                  "optional": true
+                },
+                "decodeHeaders": {
+                  "type": "boolean",
+                  "description": "Whether to decode RFC 2047 encoded headers of message parts. Defaults to <var>true</var>. **Note:** Automatic decoding of headers containing a list of comma separated mailbox strings can have unwanted side effects. Example: <literalinclude>includes/messages/badHeader.js<lang>JavaScript</lang></literalinclude>",
+                  "optional": true
+                },
+                "decodeContent": {
+                  "type": "boolean",
+                  "description": "Whether to decode quoted-printable or base64 encoded content of message parts. Defaults to <var>true</var>.",
                   "optional": true
                 }
               },
@@ -13273,12 +13371,20 @@
         {
           "name": "getRaw",
           "type": "function",
-          "description": "Returns the unmodified source of a message. Throws if the message could not be read, for example due to network issues.",
+          "description": "Returns the raw content of a message. Throws if the message could not be read, for example due to network issues.",
           "async": "callback",
           "parameters": [
             {
-              "name": "messageId",
-              "$ref": "messages.MessageId"
+              "name": "message",
+              "description": "Either a $(ref:messages.MessageId) of an existing message, or a $(ref:messages.MessagePart) with raw header and raw content data representing a full RFC 822 message (the provided data will be used as-is without applying any further encoding). See the <var>decodeHeaders</var> and <var>decodeContent</var> options of $(ref:messages.getFull) for further details on how to retrieve a $(ref:messages.MessagePart) with raw values. You can use $(ref:messengerUtilities.decodeMimeHeader) and $(ref:messengerUtilities.encodeMimeHeader) to manipulate a raw MessagePart.",
+              "choices": [
+                {
+                  "$ref": "messages.MessageId"
+                },
+                {
+                  "$ref": "messages.MessagePart"
+                }
+              ]
             },
             {
               "name": "options",
@@ -13399,7 +13505,7 @@
             {
               "name": "partName",
               "type": "string",
-              "pattern": "^\\d+(\\.\\d+)*$"
+              "pattern": "^\\d+(\\.\\d+\\$?)*$"
             },
             {
               "type": "function",
@@ -13829,7 +13935,7 @@
           "name": "import",
           "type": "function",
           "max_manifest_version": 2,
-          "description": "Imports a message into a local Thunderbird folder. To import a message into an IMAP folder, add it to a local folder first and then move it to the IMAP folder.",
+          "description": "Imports a message into a folder. Supports local folders, POP and IMAP folders. Throws, if the destination folder already contains a message with the Message-ID of the message being imported.",
           "async": "callback",
           "permissions": [
             "accountsRead",
@@ -13876,7 +13982,7 @@
           "name": "import",
           "type": "function",
           "min_manifest_version": 3,
-          "description": "Imports a message into a local Thunderbird folder. To import a message into an IMAP folder, add it to a local folder first and then move it to the IMAP folder.",
+          "description": "Imports a message into a folder. Supports local folders, POP and IMAP folders. Throws, if the destination folder already contains a message with the Message-ID of the message being imported.",
           "async": "callback",
           "permissions": [
             "accountsRead",
@@ -15841,6 +15947,31 @@
               "description": "The members of the group, if available."
             }
           }
+        },
+        {
+          "id": "MailboxHeaders",
+          "type": "string",
+          "description": "MIME headers, which by default are treated as containing one or more mailbox strings.",
+          "enum": [
+            "bcc",
+            "cc",
+            "from",
+            "reply-to",
+            "resent-bcc",
+            "resent-cc",
+            "resent-from",
+            "resent-reply-to",
+            "resent-sender",
+            "resent-to",
+            "sender",
+            "to",
+            "approved",
+            "disposition-notification-to",
+            "delivered-to",
+            "return-receipt-to",
+            "mail-reply-to",
+            "mail-followup-to"
+          ]
         }
       ],
       "functions": [
@@ -15933,6 +16064,96 @@
               ]
             }
           ]
+        },
+        {
+          "name": "decodeMimeHeader",
+          "type": "function",
+          "description": "Decode the provided header into a readable format according to RFC 2047.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "headerName",
+              "type": "string"
+            },
+            {
+              "name": "headerValue",
+              "choices": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "name": "isMailBoxHeader",
+              "type": "boolean",
+              "optional": true,
+              "description": "Headers containing multiple mailbox strings need special handling. For example the header <var>=?UTF-8?Q?H=C3=B6rst=2C_Kenny?= <K.Hoerst@invalid>, new@thunderbird.bug</var> will be wrongly decoded to <var>Hörst, Kenny <K.Hoerst@invalid>, new@thunderbird.bug</var>, corrupting the structure of the first mailbox string. This option overrides the default behavior of treating the headers defined in $(ref:messengerUtilities.MailboxHeaders) as mailbox headers."
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "optional": true,
+              "parameters": [
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "encodeMimeHeader",
+          "type": "function",
+          "description": "Encode the provided header according to RFC 2047.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "headerName",
+              "type": "string"
+            },
+            {
+              "name": "headerValue",
+              "choices": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "name": "isMailBoxHeader",
+              "type": "boolean",
+              "optional": true,
+              "description": "Headers containing multiple mailbox strings need special handling. This option overrides the default behavior of treating the headers defined in $(ref:messengerUtilities.MailboxHeaders) as mailbox headers."
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "optional": true,
+              "parameters": [
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              ]
+            }
+          ]
         }
       ]
     }
@@ -16260,7 +16481,7 @@
                 "allowScriptsToClose": {
                   "type": "boolean",
                   "optional": true,
-                  "description": "Allow scripts running inside the window to close the window by calling <code>window.close()</code>."
+                  "description": "Allow scripts running inside the window to close the window by calling <code>window.close()</code>. Defaults to <var>true</var> when the given URL points to an extension page (a page included with this extension and loaded with the <var>moz-extension:</var> protocol), defaults to <var>false</var> otherwise."
                 },
                 "cookieStoreId": {
                   "type": "string",

package/schemas/release/webext.json

@@ -9085,6 +9085,11 @@
               "type": "string",
               "optional": true,
               "description": "The first-party URL of the cookie, if the cookie is in storage partitioned by the top-level site."
+            },
+            "hasCrossSiteAncestor": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Whether or not the cookie is in a third-party context, respecting ancestor chains."
             }
           }
         },
@@ -12439,7 +12444,8 @@
             "responsiveness",
             "cpufreq",
             "bandwidth",
-            "memory"
+            "memory",
+            "tracing"
           ]
         },
         {
@@ -17703,64 +17709,6 @@
     {
       "namespace": "manifest",
       "types": [
-        {
-          "$extend": "WebExtensionManifest",
-          "properties": {
-            "telemetry": {
-              "type": "object",
-              "optional": true,
-              "additionalProperties": {
-                "$ref": "UnrecognizedProperty"
-              },
-              "properties": {
-                "ping_type": {
-                  "type": "string"
-                },
-                "schemaNamespace": {
-                  "type": "string"
-                },
-                "public_key": {
-                  "type": "object",
-                  "properties": {
-                    "id": {
-                      "type": "string"
-                    },
-                    "key": {
-                      "type": "object",
-                      "properties": {
-                        "crv": {
-                          "type": "string",
-                          "optional": "false"
-                        },
-                        "kty": {
-                          "type": "string",
-                          "optional": "false"
-                        },
-                        "x": {
-                          "type": "string",
-                          "optional": "false"
-                        },
-                        "y": {
-                          "type": "string",
-                          "optional": "false"
-                        }
-                      }
-                    }
-                  }
-                },
-                "study_name": {
-                  "type": "string",
-                  "optional": true
-                },
-                "pioneer_id": {
-                  "type": "boolean",
-                  "optional": true,
-                  "default": false
-                }
-              }
-            }
-          }
-        },
         {
           "$extend": "PermissionPrivileged",
           "choices": [
@@ -17917,39 +17865,6 @@
             }
           ]
         },
-        {
-          "name": "submitEncryptedPing",
-          "type": "function",
-          "description": "Submits a custom ping to the Telemetry back-end, with an encrypted payload. Requires a telemetry entry in the manifest to be used.",
-          "parameters": [
-            {
-              "name": "message",
-              "type": "object",
-              "additionalProperties": {
-                "type": "any"
-              },
-              "description": "The data payload for the ping, which will be encrypted."
-            },
-            {
-              "description": "Options object.",
-              "name": "options",
-              "type": "object",
-              "properties": {
-                "schemaName": {
-                  "type": "string",
-                  "optional": false,
-                  "description": "Schema name used for payload."
-                },
-                "schemaVersion": {
-                  "type": "integer",
-                  "optional": false,
-                  "description": "Schema version used for payload."
-                }
-              }
-            }
-          ],
-          "async": true
-        },
         {
           "name": "canUpload",
           "type": "function",
@@ -18118,6 +18033,7 @@
         },
         {
           "name": "recordEvent",
+          "deprecated": "`recordEvent` is a no-op since Firefox 132 (see bug 1894533)",
           "type": "function",
           "description": "Record an event in Telemetry. Throws when trying to record an unknown event.",
           "async": true,
@@ -18177,6 +18093,7 @@
         },
         {
           "name": "registerEvents",
+          "deprecated": "`registerEvents` is a no-op since Firefox 132 (see bug 1894533)",
           "type": "function",
           "description": "Register new events to record them from addons. See nsITelemetry.idl for more details.",
           "async": true,
@@ -18198,8 +18115,9 @@
         },
         {
           "name": "setEventRecordingEnabled",
+          "deprecated": "`setEventRecordingEnabled` is a no-op since Firefox 133 (see bug 1920562)",
           "type": "function",
-          "description": "Enable recording of events in a category. Events default to recording disabled. This allows to toggle recording for all events in the specified category.",
+          "description": "Enable recording of events in a category. Events default to recording enabled. This allows to toggle recording for all events in the specified category.",
           "async": true,
           "parameters": [
             {

package/tsconfig.json

@@ -12,5 +12,8 @@
     "resolveJsonModule": true,
     "target": "esnext"
   },
-  "include": ["index.js", "modules/browser.js"]
+  "include": [
+    "index.js",
+    "modules/browser.js"
+  ]
 }

package/types/modules/browser.d.ts

@@ -1,17 +1,17 @@
 export function isPermissionGranted(perm: object): Promise<boolean>;
 export function createBookmark(opt: object): Promise<object>;
-export function getBookmarkTreeNode(id?: string | any[]): Promise<any[] | null>;
+export function getBookmarkTreeNode(id?: string | any[]): Promise<Array<object> | null>;
 export function getCloseTabsByDoubleClickValue(): Promise<object>;
 export function setContextMenuOnMouseup(): Promise<boolean>;
 export function clearContextMenuOnMouseup(): Promise<boolean>;
 export function getNewTabPositionValue(): Promise<object>;
 export function isCommandCustomizable(): Promise<boolean>;
 export function updateCommand(id: string, value?: string): Promise<void | null>;
-export function getAllContextualIdentities(): Promise<any[] | null>;
+export function getAllContextualIdentities(): Promise<Array<object> | null>;
 export function getContextualId(cookieStoreId: string): Promise<object>;
-export function getEnabledTheme(): Promise<any[] | null>;
+export function getEnabledTheme(): Promise<Array<object> | null>;
 export function getExtensionInfo(id: string): Promise<object>;
-export function getExternalExtensions(): Promise<(any[] | boolean) | null>;
+export function getExternalExtensions(): Promise<Array<object> | null>;
 export function clearNotification(id: string): Promise<boolean | null>;
 export function createNotification(id: string, opt: object): Promise<string | null>;
 export function removePermission(perm: string | any[]): Promise<boolean>;
@@ -22,7 +22,8 @@ export function getOs(): Promise<string>;
 export function makeConnection(id?: number | string, info?: object | boolean): Promise<object>;
 export function sendMessage(id: number | string, msg: any, opt: object): Promise<object>;
 export function isScriptingAvailable(): Promise<boolean>;
-export function executeScriptToTab(opt?: object): Promise<(any[] | boolean) | null>;
+export function executeScriptToTab(opt?: object): Promise<Array<object> | null>;
+export function searchInNewTab(text: string, opt: object): Promise<object>;
 export function searchWithSearchEngine(query: string, opt?: object): Promise<void>;
 export function getRecentlyClosedTab(windowId?: number): Promise<object>;
 export function getSessionWindowValue(key: string, windowId?: number): Promise<string | null>;
@@ -35,17 +36,17 @@ export function removeStorage(key: any, area?: string): Promise<void>;
 export function setStorage(obj: object, area?: string): Promise<void>;
 export function createTab(opt?: object): Promise<object>;
 export function duplicateTab(tabId: number, opt: object): Promise<object>;
-export function queryTabs(opt: object): Promise<any[] | null>;
+export function queryTabs(opt: object): Promise<Array<object>>;
 export function execScriptToTab(tabId: number | object, opt?: object): Promise<(any[] | boolean) | null>;
 export function execScriptToTabs(opt?: object): Promise<any[]>;
 export function execScriptsToTabInOrder(tabId: number | any[], opts?: any[]): Promise<any>;
 export function getActiveTab(windowId?: number): Promise<object>;
 export function getActiveTabId(windowId?: number): Promise<number | null>;
-export function getAllTabsInWindow(windowId?: number): Promise<any[] | null>;
-export function getHighlightedTab(windowId?: number): Promise<any[] | null>;
+export function getAllTabsInWindow(windowId?: number): Promise<Array<object>>;
+export function getHighlightedTab(windowId?: number): Promise<Array<object>>;
 export function getTab(tabId: number): Promise<object>;
 export function highlightTab(index: number | any[], windowId?: number): Promise<object>;
-export function moveTab(tabId: number | any[], opt?: object): Promise<any[] | null>;
+export function moveTab(tabId: number | any[], opt?: object): Promise<Array<object> | null>;
 export function reloadTab(tabId: number, opt: object): Promise<void>;
 export function removeTab(arg: number | any[]): Promise<void>;
 export function updateTab(tabId: number, opt: object): Promise<object>;
@@ -54,7 +55,7 @@ export function captureVisibleTab(windowId: number, opt: object): Promise<string
 export function isTab(tabId: any): Promise<boolean>;
 export function getCurrentTheme(windowId?: number): Promise<object>;
 export function createNewWindow(opt: object): Promise<object>;
-export function getAllNormalWindows(populate?: boolean): Promise<any[]>;
+export function getAllNormalWindows(populate?: boolean): Promise<Array<object>>;
 export function getCurrentWindow(opt: object): Promise<object>;
 export function getWindow(windowId: number, opt: object): Promise<object>;
 export function checkIncognitoWindowExists(): Promise<boolean>;

package/types/modules/schema.d.ts

@@ -9,17 +9,17 @@ export class Schema {
     _schema: any;
     set channel(ch: any);
     get channel(): any;
-    _getTargetFromNamespace(key: string): object;
-    _assignImportMap(): void;
-    _assignRefMap(): void;
-    _mockEvents(target: object, events: any[]): object;
-    _mockFunctions(target: object, funcs: any[]): object;
-    _mockProperties(target: object, props: object, namespace: string): object;
-    _mockTypes(target: object, types: any[], namespace: string): object;
-    _parseSchemaContent(): object;
-    get(name: string): any[];
+    private _getTargetFromNamespace;
+    private _assignImportMap;
+    private _assignRefMap;
+    private _mockEvents;
+    private _mockFunctions;
+    private _mockProperties;
+    private _mockTypes;
+    private _parseSchemaContent;
+    get(name: string): Array<object> | null;
     getAll(): object;
-    list(): any[];
+    list(): Array<string>;
     mock(): object;
     #private;
 }