webext-schema 5.2.7 → 5.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -21,20 +21,20 @@
21
21
  },
22
22
  "devDependencies": {
23
23
  "@types/firefox-webext-browser": "^120.0.0",
24
- "@types/node": "^20.10.5",
25
- "@types/sinon": "^17.0.2",
26
- "c8": "^8.0.1",
27
- "chai": "^4.3.10",
24
+ "@types/node": "^20.11.5",
25
+ "@types/sinon": "^17.0.3",
26
+ "c8": "^9.1.0",
27
+ "chai": "^5.0.0",
28
28
  "eslint": "^8.56.0",
29
29
  "eslint-config-standard": "^17.1.0",
30
30
  "eslint-plugin-import": "^2.29.1",
31
- "eslint-plugin-jsdoc": "^46.9.1",
32
- "eslint-plugin-regexp": "^2.1.2",
33
- "eslint-plugin-unicorn": "^49.0.0",
31
+ "eslint-plugin-jsdoc": "^48.0.2",
32
+ "eslint-plugin-regexp": "^2.2.0",
33
+ "eslint-plugin-unicorn": "^50.0.1",
34
34
  "mocha": "^10.2.0",
35
35
  "npm-run-all": "^4.1.5",
36
36
  "typescript": "^5.3.3",
37
- "undici": "^6.0.1"
37
+ "undici": "^6.4.0"
38
38
  },
39
39
  "scripts": {
40
40
  "build": "npm run tsc && npm run lint && npm run test",
@@ -54,5 +54,5 @@
54
54
  "update-mail": "node index update --channel=mail -i",
55
55
  "update-release": "node index update --channel=release -i"
56
56
  },
57
- "version": "5.2.7"
57
+ "version": "5.2.8"
58
58
  }
@@ -9228,10 +9228,38 @@
9228
9228
  }
9229
9229
  ]
9230
9230
  },
9231
+ {
9232
+ "name": "move",
9233
+ "type": "function",
9234
+ "description": "Reorder one or more contextual identities by their cookieStoreIDs to a given position.",
9235
+ "async": true,
9236
+ "parameters": [
9237
+ {
9238
+ "name": "cookieStoreIds",
9239
+ "description": "The ID or list of IDs of the contextual identity cookie stores. ",
9240
+ "choices": [
9241
+ {
9242
+ "type": "string"
9243
+ },
9244
+ {
9245
+ "type": "array",
9246
+ "items": {
9247
+ "type": "string"
9248
+ }
9249
+ }
9250
+ ]
9251
+ },
9252
+ {
9253
+ "type": "integer",
9254
+ "name": "position",
9255
+ "description": "The position the contextual identity should move to."
9256
+ }
9257
+ ]
9258
+ },
9231
9259
  {
9232
9260
  "name": "remove",
9233
9261
  "type": "function",
9234
- "description": "Deletes a contetual identity by its cookie Store ID.",
9262
+ "description": "Deletes a contextual identity by its cookie Store ID.",
9235
9263
  "async": true,
9236
9264
  "parameters": [
9237
9265
  {
@@ -12577,7 +12605,8 @@
12577
12605
  "processcpu",
12578
12606
  "power",
12579
12607
  "responsiveness",
12580
- "cpufreq"
12608
+ "cpufreq",
12609
+ "bandwidth"
12581
12610
  ]
12582
12611
  },
12583
12612
  {
@@ -9228,10 +9228,38 @@
9228
9228
  }
9229
9229
  ]
9230
9230
  },
9231
+ {
9232
+ "name": "move",
9233
+ "type": "function",
9234
+ "description": "Reorder one or more contextual identities by their cookieStoreIDs to a given position.",
9235
+ "async": true,
9236
+ "parameters": [
9237
+ {
9238
+ "name": "cookieStoreIds",
9239
+ "description": "The ID or list of IDs of the contextual identity cookie stores. ",
9240
+ "choices": [
9241
+ {
9242
+ "type": "string"
9243
+ },
9244
+ {
9245
+ "type": "array",
9246
+ "items": {
9247
+ "type": "string"
9248
+ }
9249
+ }
9250
+ ]
9251
+ },
9252
+ {
9253
+ "type": "integer",
9254
+ "name": "position",
9255
+ "description": "The position the contextual identity should move to."
9256
+ }
9257
+ ]
9258
+ },
9231
9259
  {
9232
9260
  "name": "remove",
9233
9261
  "type": "function",
9234
- "description": "Deletes a contetual identity by its cookie Store ID.",
9262
+ "description": "Deletes a contextual identity by its cookie Store ID.",
9235
9263
  "async": true,
9236
9264
  "parameters": [
9237
9265
  {
@@ -12577,7 +12605,8 @@
12577
12605
  "processcpu",
12578
12606
  "power",
12579
12607
  "responsiveness",
12580
- "cpufreq"
12608
+ "cpufreq",
12609
+ "bandwidth"
12581
12610
  ]
12582
12611
  },
12583
12612
  {
@@ -2337,7 +2337,7 @@
2337
2337
  "properties": {
2338
2338
  "stylesheet": {
2339
2339
  "optional": true,
2340
- "description": "URL to a stylesheet introducing additional CSS variables, extending the theme-able areas of Thunderbird. The `theme_experiment add-on in our example repository <https://github.com/thunderbird/sample-extensions/tree/master/theme_experiment>`__ is using the stylesheet shown below, to add the <value>--chat-button-color</value> CSS color variable: <literalinclude>includes/theme/theme_experiment_style.css<lang>CSS</lang></literalinclude>The following <em>manifest.json</em> file maps the </value>--chat-button-color</value> CSS color variable to the theme color key <value>exp_chat_button</value> and uses it to set a color for the chat button: <literalinclude>includes/theme/theme_experiment_manifest.json<lang>JSON</lang></literalinclude>",
2340
+ "description": "URL to a stylesheet introducing additional CSS variables, extending the theme-able areas of Thunderbird. The `theme_experiment add-on in our example repository <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v2/theme_experiment>`__ is using the stylesheet shown below, to add the <value>--chat-button-color</value> CSS color variable: <literalinclude>includes/theme/theme_experiment_style.css<lang>CSS</lang></literalinclude>The following <em>manifest.json</em> file maps the </value>--chat-button-color</value> CSS color variable to the theme color key <value>exp_chat_button</value> and uses it to set a color for the chat button: <literalinclude>includes/theme/theme_experiment_manifest.json<lang>JSON</lang></literalinclude>",
2341
2341
  "$ref": "ExtensionURL"
2342
2342
  },
2343
2343
  "images": {
@@ -3494,7 +3494,7 @@
3494
3494
  {
3495
3495
  "id": "ContactProperties",
3496
3496
  "type": "object",
3497
- "description": "A set of individual properties for a particular contact, and its vCard string. Further information can be found in :ref:`howto_contacts`.",
3497
+ "description": "A set of individual properties for a particular contact, and its vCard string. Further information can be found in :doc:`examples/vcard`.",
3498
3498
  "patternProperties": {
3499
3499
  "^\\w+$": {
3500
3500
  "choices": [
@@ -5712,7 +5712,7 @@
5712
5712
  "properties": {
5713
5713
  "id": {
5714
5714
  "type": "string",
5715
- "description": "The ID of a contact or mailing list from the :doc:`contacts` and :doc:`mailingLists` APIs."
5715
+ "description": "The ID of a contact or mailing list from the :doc:`contacts` and :doc:`mailingLists`."
5716
5716
  },
5717
5717
  "type": {
5718
5718
  "type": "string",
@@ -5762,7 +5762,7 @@
5762
5762
  "properties": {
5763
5763
  "identityId": {
5764
5764
  "type": "string",
5765
- "description": "The ID of an identity from the :doc:`accounts` API. The settings from the identity will be used in the composed message. If ``replyTo`` is also specified, the ``replyTo`` property of the identity is overridden. The permission <permission>accountsRead</permission> is required to include the ``identityId``.",
5765
+ "description": "The ID of an identity from the :doc:`accounts`. The settings from the identity will be used in the composed message. If ``replyTo`` is also specified, the ``replyTo`` property of the identity is overridden. The permission <permission>accountsRead</permission> is required to include the ``identityId``.",
5766
5766
  "optional": true
5767
5767
  },
5768
5768
  "from": {
@@ -9795,7 +9795,7 @@
9795
9795
  }
9796
9796
  }
9797
9797
  ],
9798
- "description": "Either a <em>string</em> to specify a single icon path to be used for all sizes, or a <em>dictionary object</em> to specify paths for multiple icons in different sizes, so the icon does not have to be scaled for a device with a different pixel density. Each entry is a <em>name-value</em> pair with <em>name</em> being a size and <em>value</em> being a path to the icon for the specified size. Example: <literalinclude>includes/MenuIconPath.json<lang>JSON</lang></literalinclude>See the `MDN documentation about choosing icon sizes <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/browser_action#choosing_icon_sizes>`__ for more information on this. "
9798
+ "description": "Either a <em>string</em> to specify a single icon path to be used for all sizes, or a <em>dictionary object</em> to specify paths for multiple icons in different sizes, so the icon does not have to be scaled for a device with a different pixel density. Each entry is a <em>name-value</em> pair with <em>name</em> being a size and <em>value</em> being a path to the icon for the specified size. Example: <literalinclude>includes/IconPath.json<lang>JSON</lang></literalinclude>See the `MDN documentation about choosing icon sizes <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/browser_action#choosing_icon_sizes>`__ for more information on this. "
9799
9799
  }
9800
9800
  ],
9801
9801
  "functions": [
@@ -11141,6 +11141,7 @@
11141
11141
  "messagesTags",
11142
11142
  "messagesTagsList",
11143
11143
  "messagesUpdate",
11144
+ "messagesModifyPermanent",
11144
11145
  "sensitiveDataUpload"
11145
11146
  ]
11146
11147
  }
@@ -11255,7 +11256,7 @@
11255
11256
  {
11256
11257
  "id": "MessageList",
11257
11258
  "type": "object",
11258
- "description": "See :doc:`how-to/messageLists` for more information.",
11259
+ "description": "See :doc:`examples/messageLists` for more information.",
11259
11260
  "properties": {
11260
11261
  "id": {
11261
11262
  "type": "string",
@@ -11361,7 +11362,7 @@
11361
11362
  "properties": {
11362
11363
  "contentType": {
11363
11364
  "type": "string",
11364
- "description": "The content type of the attachment."
11365
+ "description": "The content type of the attachment. A value of <value>text/x-moz-deleted</value> indicates that the original attachment was permanently deleted and replaced by a placeholder text attachment with some meta information about the original attachment."
11365
11366
  },
11366
11367
  "name": {
11367
11368
  "type": "string",
@@ -11531,7 +11532,7 @@
11531
11532
  {
11532
11533
  "name": "continueList",
11533
11534
  "type": "function",
11534
- "description": "Returns the next chunk of messages in a list. See :doc:`how-to/messageLists` for more information.",
11535
+ "description": "Returns the next chunk of messages in a list. See :doc:`examples/messageLists` for more information.",
11535
11536
  "async": "callback",
11536
11537
  "parameters": [
11537
11538
  {
@@ -11720,6 +11721,31 @@
11720
11721
  }
11721
11722
  ]
11722
11723
  },
11724
+ {
11725
+ "name": "deleteAttachments",
11726
+ "type": "function",
11727
+ "description": "Deletes the specified attachments and replaces them by placeholder text attachments with meta information about the original attachments and a <value>text/x-moz-deleted</value> content type. This permanently modifies the message.",
11728
+ "permissions": [
11729
+ "messagesModifyPermanent"
11730
+ ],
11731
+ "async": true,
11732
+ "parameters": [
11733
+ {
11734
+ "name": "messageId",
11735
+ "type": "integer"
11736
+ },
11737
+ {
11738
+ "name": "partNames",
11739
+ "type": "array",
11740
+ "description": "An array of attachments, identifiying the to be detached attachments by their <value>partName</value>.",
11741
+ "items": {
11742
+ "type": "string",
11743
+ "pattern": "^\\d+(\\.\\d+)*$"
11744
+ },
11745
+ "minItems": 1
11746
+ }
11747
+ ]
11748
+ },
11723
11749
  {
11724
11750
  "name": "openAttachment",
11725
11751
  "type": "function",
@@ -750,6 +750,7 @@
750
750
  },
751
751
  "params": {
752
752
  "optional": true,
753
+ "max_manifest_version": 2,
753
754
  "type": "array",
754
755
  "items": {
755
756
  "type": "object",