webext-schema 2.0.6 → 2.0.7

package/package.json

@@ -27,7 +27,7 @@
     "commander": "^8.3.0",
     "decamelize": "^6.0.0",
     "json5": "^2.2.0",
-    "node-fetch": "^3.1.0",
+    "node-fetch": "^3.2.0",
     "sinon": "^12.0.1"
   },
   "devDependencies": {
@@ -36,11 +36,11 @@
     "eslint": "^7.32.0",
     "eslint-config-standard": "^16.0.3",
     "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-jsdoc": "^37.6.1",
+    "eslint-plugin-jsdoc": "^37.6.3",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.2.0",
-    "mocha": "^9.1.3",
-    "nock": "^13.2.1"
+    "mocha": "^9.2.0",
+    "nock": "^13.2.2"
   },
-  "version": "2.0.6"
+  "version": "2.0.7"
 }

package/schemas/central/webext.json

@@ -11776,6 +11776,7 @@
             "samplingallthreads",
             "markersallthreads",
             "unregisteredthreads",
+            "processcpu",
             "responsiveness"
           ]
         },
@@ -15941,7 +15942,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 +15965,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 +15998,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 +16071,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 +18098,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"
             }
           }
         },

package/schemas/mail/mailext.json

@@ -4824,7 +4824,7 @@
         {
           "name": "onFileRename",
           "type": "function",
-          "description": "Fired when an already uploaded file should be renamed.",
+          "description": "Fired when a previously uploaded file should be renamed.",
           "parameters": [
             {
               "name": "account",
@@ -4874,7 +4874,7 @@
         {
           "name": "onFileDeleted",
           "type": "function",
-          "description": "Fired when a file previously uploaded should be deleted.",
+          "description": "Fired when a previously uploaded file should be deleted.",
           "parameters": [
             {
               "name": "account",
@@ -5247,7 +5247,7 @@
             },
             "from": {
               "$ref": "ComposeRecipient",
-              "description": "*Caution*: Setting a value for `from` does not change the used identity, it overrides the FROM header. Many email servers do not accept emails where the FROM header does not match the sender identity. Must be set to exactly one valid email address.",
+              "description": "*Caution*: Setting a value for ``from`` does not change the used identity, it overrides the FROM header. Many email servers do not accept emails where the FROM header does not match the sender identity. Must be set to exactly one valid email address.",
               "optional": true
             },
             "to": {
@@ -5309,38 +5309,55 @@
             },
             "body": {
               "type": "string",
+              "description": "The HTML content of the message. Ignored by ``setComposeDetails``, if used on a plain text composer. If only ``body`` is specified when used with ``beginNew``, ``beginReply`` and similar functions, an HTML message will be created. The recommended usage is to always specify both (``body`` and ``plainTextBody``) and use ``isPlainText`` to select the compose format, or use the users default compose format.",
               "optional": true
             },
             "plainTextBody": {
               "type": "string",
+              "description": "The plain text content of the message. Ignored by ``setComposeDetails``, if used on an HTML composer. If only ``plainTextBody`` is specified when used with ``beginNew``, ``beginReply`` and similar functions, a plain text message will be created. The recommended usage is to always specify both (``body`` and ``plainTextBody``) and use ``isPlainText`` to select the compose format, or use the users default compose format.",
               "optional": true
             },
             "isPlainText": {
               "type": "boolean",
+              "description": "Wether the message is an HTML message or a plain text message. Can be used to specify the message format in ``beginNew``, ``beginReply`` and similar functions. It is however not possible to change the compose format with ``setComposeDetails``. Note: Using ``isPlainText`` together with a single but conflicting body type (e.g.: ``isPlainText`` = ``true`` and ``body`` is set but not ``plainTextBody``) will cause an exception. ",
               "optional": true
             },
             "attachments": {
               "type": "array",
               "items": {
-                "type": "object",
-                "properties": {
-                  "name": {
-                    "type": "string",
-                    "description": "The name, as displayed to the user, of this attachment. If not specified, the name of the ``file`` object is used.",
-                    "optional": true
+                "choices": [
+                  {
+                    "$ref": "FileAttachment"
                   },
-                  "file": {
-                    "type": "object",
-                    "isInstanceOf": "File",
-                    "additionalProperties": true
+                  {
+                    "$ref": "ComposeAttachment"
                   }
-                }
+                ]
               },
               "description": "Attachments to add to the message. Only used in the begin* functions.",
               "optional": true
             }
           }
         },
+        {
+          "id": "FileAttachment",
+          "type": "object",
+          "description": "Object used to add, update or rename an attachment in a message being composed.",
+          "properties": {
+            "file": {
+              "type": "object",
+              "isInstanceOf": "File",
+              "additionalProperties": true,
+              "description": "The new content for the attachment.",
+              "optional": true
+            },
+            "name": {
+              "type": "string",
+              "description": "The new name for the attachment, as displayed to the user. If not specified, the name of the provided ``file`` object is used.",
+              "optional": true
+            }
+          }
+        },
         {
           "id": "ComposeAttachment",
           "type": "object",
@@ -5352,22 +5369,15 @@
             },
             "name": {
               "type": "string",
-              "description": "The name, as displayed to the user, of this attachment. This is usually but not always the filename of the attached file."
+              "optional": true,
+              "description": "The name of this attachment, as displayed to the user."
             },
             "size": {
               "type": "integer",
-              "description": "The size in bytes of this attachment."
-            }
-          },
-          "functions": [
-            {
-              "name": "getFile",
-              "type": "function",
-              "description": "Retrieves the contents of the attachment as a DOM ``File`` object.",
-              "async": true,
-              "parameters": []
+              "optional": true,
+              "description": "The size in bytes of this attachment. Read-only."
             }
-          ]
+          }
         }
       ],
       "events": [
@@ -5652,17 +5662,35 @@
               "optional": true,
               "parameters": [
                 {
-                  "choices": [
-                    {
-                      "type": "array",
-                      "items": {
-                        "$ref": "ComposeAttachment"
-                      }
-                    },
-                    {
-                      "type": "any"
-                    }
-                  ]
+                  "type": "array",
+                  "items": {
+                    "$ref": "ComposeAttachment"
+                  }
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "getAttachmentFile",
+          "type": "function",
+          "description": "Gets the content of a :ref:`compose.ComposeAttachment` as a DOM <code>File</code> object.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "id",
+              "type": "integer",
+              "description": "The unique identifier for the attachment."
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "optional": true,
+              "parameters": [
+                {
+                  "type": "object",
+                  "isInstanceOf": "File",
+                  "additionalProperties": true
                 }
               ]
             }
@@ -5682,20 +5710,15 @@
               "type": "integer"
             },
             {
-              "name": "data",
-              "type": "object",
-              "properties": {
-                "name": {
-                  "type": "string",
-                  "description": "The name, as displayed to the user, of this attachment. If not specified, the name of the ``file`` object is used.",
-                  "optional": true
+              "name": "attachment",
+              "choices": [
+                {
+                  "$ref": "FileAttachment"
                 },
-                "file": {
-                  "type": "object",
-                  "isInstanceOf": "File",
-                  "additionalProperties": true
+                {
+                  "$ref": "ComposeAttachment"
                 }
-              }
+              ]
             },
             {
               "type": "function",
@@ -5703,14 +5726,7 @@
               "optional": true,
               "parameters": [
                 {
-                  "choices": [
-                    {
-                      "$ref": "ComposeAttachment"
-                    },
-                    {
-                      "type": "any"
-                    }
-                  ]
+                  "$ref": "ComposeAttachment"
                 }
               ]
             }
@@ -5719,7 +5735,7 @@
         {
           "name": "updateAttachment",
           "type": "function",
-          "description": "Renames and/or replaces the contents of an attachment to the message being composed in the specified tab.",
+          "description": "Updates the name and/or the content of an attachment in the message being composed in the specified tab. If the specified attachment is a cloud file attachment and the associated provider failed to update the attachment, the function will throw an ``ExtensionError``.",
           "permissions": [
             "compose"
           ],
@@ -5734,21 +5750,8 @@
               "type": "integer"
             },
             {
-              "name": "data",
-              "type": "object",
-              "properties": {
-                "name": {
-                  "type": "string",
-                  "description": "The name, as displayed to the user, of this attachment. If not specified, the name of the ``file`` object is used.",
-                  "optional": true
-                },
-                "file": {
-                  "type": "object",
-                  "isInstanceOf": "File",
-                  "additionalProperties": true,
-                  "optional": true
-                }
-              }
+              "name": "attachment",
+              "$ref": "FileAttachment"
             },
             {
               "type": "function",
@@ -5756,14 +5759,7 @@
               "optional": true,
               "parameters": [
                 {
-                  "choices": [
-                    {
-                      "$ref": "ComposeAttachment"
-                    },
-                    {
-                      "type": "any"
-                    }
-                  ]
+                  "$ref": "ComposeAttachment"
                 }
               ]
             }
@@ -9365,7 +9361,7 @@
           }
         },
         {
-          "id": "Attachment",
+          "id": "MessageAttachment",
           "type": "object",
           "description": "Represents an attachment in a message.",
           "properties": {
@@ -9605,7 +9601,7 @@
                 {
                   "type": "array",
                   "items": {
-                    "$ref": "Attachment"
+                    "$ref": "MessageAttachment"
                   }
                 }
               ]
@@ -9615,7 +9611,7 @@
         {
           "name": "getAttachmentFile",
           "type": "function",
-          "description": "Gets the content of an attachment as a DOM <code>File</code> object.",
+          "description": "Gets the content of a :ref:`messages.MessageAttachment` as a DOM <code>File</code> object.",
           "async": "callback",
           "parameters": [
             {