webext-schema 5.5.0 → 5.5.2

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.
@@ -1352,7 +1352,14 @@
1352
1352
  "permissions": {
1353
1353
  "type": "array",
1354
1354
  "items": {
1355
- "$ref": "manifest.OptionalPermission"
1355
+ "choices": [
1356
+ {
1357
+ "$ref": "manifest.OptionalPermission"
1358
+ },
1359
+ {
1360
+ "$ref": "manifest.OptionalOnlyPermission"
1361
+ }
1362
+ ]
1356
1363
  },
1357
1364
  "optional": true,
1358
1365
  "default": []
@@ -1374,7 +1381,14 @@
1374
1381
  "permissions": {
1375
1382
  "type": "array",
1376
1383
  "items": {
1377
- "$ref": "manifest.Permission"
1384
+ "choices": [
1385
+ {
1386
+ "$ref": "manifest.Permission"
1387
+ },
1388
+ {
1389
+ "$ref": "manifest.OptionalOnlyPermission"
1390
+ }
1391
+ ]
1378
1392
  },
1379
1393
  "optional": true,
1380
1394
  "default": []
@@ -1720,6 +1734,11 @@
1720
1734
  "type": "string",
1721
1735
  "optional": true,
1722
1736
  "description": "The TLS channel ID of the page or frame that opened the connection, if requested by the extension or app, and if available."
1737
+ },
1738
+ "userScriptWorldId": {
1739
+ "type": "string",
1740
+ "optional": true,
1741
+ "description": "The worldId of the USER_SCRIPT world that sent the message. Only present on onUserScriptMessage and onUserScriptConnect (in port.sender) events."
1723
1742
  }
1724
1743
  }
1725
1744
  },
@@ -2388,6 +2407,20 @@
2388
2407
  }
2389
2408
  ]
2390
2409
  },
2410
+ {
2411
+ "name": "onUserScriptConnect",
2412
+ "type": "function",
2413
+ "description": "Fired when a connection is made from a USER_SCRIPT world registered through the userScripts API.",
2414
+ "permissions": [
2415
+ "userScripts"
2416
+ ],
2417
+ "parameters": [
2418
+ {
2419
+ "$ref": "Port",
2420
+ "name": "port"
2421
+ }
2422
+ ]
2423
+ },
2391
2424
  {
2392
2425
  "name": "onConnectExternal",
2393
2426
  "type": "function",
@@ -2457,6 +2490,36 @@
2457
2490
  "description": "Return true from the event listener if you wish to call <code>sendResponse</code> after the event listener returns."
2458
2491
  }
2459
2492
  },
2493
+ {
2494
+ "name": "onUserScriptMessage",
2495
+ "type": "function",
2496
+ "description": "Fired when a message is sent from a USER_SCRIPT world registered through the userScripts API.",
2497
+ "permissions": [
2498
+ "userScripts"
2499
+ ],
2500
+ "parameters": [
2501
+ {
2502
+ "name": "message",
2503
+ "type": "any",
2504
+ "optional": true,
2505
+ "description": "The message sent by the calling script."
2506
+ },
2507
+ {
2508
+ "name": "sender",
2509
+ "$ref": "MessageSender"
2510
+ },
2511
+ {
2512
+ "name": "sendResponse",
2513
+ "type": "function",
2514
+ "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)."
2515
+ }
2516
+ ],
2517
+ "returns": {
2518
+ "type": "boolean",
2519
+ "optional": true,
2520
+ "description": "Return true from the event listener if you wish to call <code>sendResponse</code> after the event listener returns."
2521
+ }
2522
+ },
2460
2523
  {
2461
2524
  "name": "onRestartRequired",
2462
2525
  "unsupported": true,
@@ -5623,9 +5686,18 @@
5623
5686
  "preprocess": "localize"
5624
5687
  },
5625
5688
  "favicon_url": {
5626
- "type": "string",
5689
+ "choices": [
5690
+ {
5691
+ "type": "string",
5692
+ "format": "relativeUrl",
5693
+ "max_manifest_version": 2
5694
+ },
5695
+ {
5696
+ "type": "string",
5697
+ "format": "strictRelativeUrl"
5698
+ }
5699
+ ],
5627
5700
  "optional": true,
5628
- "format": "url",
5629
5701
  "preprocess": "localize"
5630
5702
  },
5631
5703
  "suggest_url": {
@@ -12994,12 +13066,26 @@
12994
13066
  {
12995
13067
  "id": "MessageAttachment",
12996
13068
  "type": "object",
12997
- "description": "Represents an attachment in a message. This includes all MIME parts with a <em>content-disposition</em> header set to <var>attachment</var>, but also related parts like inline images.",
13069
+ "description": "Represents an attachment in a message.",
12998
13070
  "properties": {
13071
+ "contentDisposition": {
13072
+ "type": "string",
13073
+ "description": "The content disposition of the attachment, for example <var>attachment</var> for normal attachments, or <var>inline</var> for inline attachments."
13074
+ },
12999
13075
  "contentType": {
13000
13076
  "type": "string",
13001
13077
  "description": "The content type of the attachment. A value of <var>text/x-moz-deleted</var> indicates that the original attachment was permanently deleted and replaced by a placeholder text attachment with some meta information about the original attachment."
13002
13078
  },
13079
+ "headers": {
13080
+ "type": "object",
13081
+ "description": "A <em>dictionary object</em> of RFC 2047 decoded attachment headers as <em>key-value</em> pairs, with the header name as <em>key</em>, and an array of headers as <em>value</em>.",
13082
+ "additionalProperties": {
13083
+ "type": "array",
13084
+ "items": {
13085
+ "type": "string"
13086
+ }
13087
+ }
13088
+ },
13003
13089
  "name": {
13004
13090
  "type": "string",
13005
13091
  "description": "The name, as displayed to the user, of this attachment. This is usually but not always the filename of the attached file."
@@ -14311,8 +14397,26 @@
14311
14397
  {
14312
14398
  "namespace": "spaces",
14313
14399
  "types": [
14400
+ {
14401
+ "id": "SpaceTabProperties",
14402
+ "description": "Properties for the new tab being opened by clicking on the associated button in the spaces toolbar.",
14403
+ "type": "object",
14404
+ "properties": {
14405
+ "url": {
14406
+ "type": "string",
14407
+ "optional": true,
14408
+ "description": "The default URL. May point to a WebExtension page or a web page."
14409
+ },
14410
+ "cookieStoreId": {
14411
+ "type": "string",
14412
+ "optional": true,
14413
+ "description": "The <a href='url-cookieStore'>CookieStore</a> id used by the tab. Either a custom id created using the <a href='url-contextualIdentity'>contextualIdentities API</a>, or a built-in one: <var>firefox-default</var>, <var>firefox-container-1</var>, <var>firefox-container-2</var>, <var>firefox-container-3</var>, <var>firefox-container-4</var>, <var>firefox-container-5</var>. **Note:** The naming pattern was deliberately not changed for Thunderbird, but kept for compatibility reasons. The <permission>cookies</permission> permission is required to be able to specify this property. Furthermore, the <permission>contextualIdentities</permission> permission should be requested, to enable the contextual identities feature (enabled by default only on Thunderbird Daily)."
14414
+ }
14415
+ }
14416
+ },
14314
14417
  {
14315
14418
  "id": "SpaceButtonProperties",
14419
+ "description": "Properties of a button in the spaces toolbar.",
14316
14420
  "choices": [
14317
14421
  {
14318
14422
  "max_manifest_version": 2,
@@ -14461,13 +14565,20 @@
14461
14565
  "description": "The name to assign to this space. May only contain alphanumeric characters and underscores. Must be unique for this extension."
14462
14566
  },
14463
14567
  {
14464
- "name": "defaultUrl",
14465
- "type": "string",
14466
- "description": "The default space url, loaded into a tab when the button in the spaces toolbar is clicked. Supported are <var>https://</var> and <var>http://</var> links, as well as links to WebExtension pages."
14568
+ "name": "tabProperties",
14569
+ "choices": [
14570
+ {
14571
+ "$ref": "spaces.SpaceTabProperties"
14572
+ },
14573
+ {
14574
+ "type": "string"
14575
+ }
14576
+ ],
14577
+ "description": "The properties for the new tab being opened, when the associated button in the spaces toolbar is clicked. Either a <em>string</em> specifiying the default URL, or a $(ref:spaces.SpaceTabProperties) object. The URL may point to a WebExtension page or a web page."
14467
14578
  },
14468
14579
  {
14469
14580
  "name": "buttonProperties",
14470
- "description": "Properties of the button for the new space.",
14581
+ "description": "Properties of the button in the spaces toolbar for the new space.",
14471
14582
  "$ref": "spaces.SpaceButtonProperties",
14472
14583
  "optional": true,
14473
14584
  "default": {}
@@ -14602,14 +14713,23 @@
14602
14713
  "minimum": 1
14603
14714
  },
14604
14715
  {
14605
- "name": "defaultUrl",
14606
- "type": "string",
14607
- "description": "The default space url, loaded into a tab when the button in the spaces toolbar is clicked. Supported are <var>https://</var> and <var>http://</var> links, as well as links to WebExtension pages.",
14608
- "optional": true
14716
+ "name": "tabProperties",
14717
+ "choices": [
14718
+ {
14719
+ "type": "string"
14720
+ },
14721
+ {
14722
+ "$ref": "spaces.SpaceTabProperties"
14723
+ },
14724
+ {
14725
+ "$ref": "spaces.SpaceButtonProperties"
14726
+ }
14727
+ ],
14728
+ "description": "The properties for the new tab being opened, when the associated button in the spaces toolbar is clicked. Either a <em>string</em> specifiying the default URL, or a $(ref:spaces.SpaceTabProperties) object. The URL may point to a WebExtension page or a web page."
14609
14729
  },
14610
14730
  {
14611
14731
  "name": "buttonProperties",
14612
- "description": "Only specified button properties will be updated.",
14732
+ "description": "Properties of the button in the spaces toolbar for the specified space Only specified button properties will be updated.",
14613
14733
  "$ref": "spaces.SpaceButtonProperties",
14614
14734
  "optional": true
14615
14735
  }
@@ -15201,7 +15321,7 @@
15201
15321
  "cookieStoreId": {
15202
15322
  "type": "string",
15203
15323
  "optional": true,
15204
- "description": "The <a href='url-cookieStore'>CookieStore</a> id the new tab should use. Either a custom id created using the <a href='url-contextualIdentity'>contextualIdentities API</a>, or a built-in one: <var>firefox-default</var>, <var>firefox-container-1</var>, <var>firefox-container-2</var>, <var>firefox-container-3</var>, <var>firefox-container-4</var>, <var>firefox-container-5</var>. **Note:** The naming pattern was deliberately not changed for Thunderbird, but kept for compatibility reasons."
15324
+ "description": "The <a href='url-cookieStore'>CookieStore</a> id the new tab should use. Either a custom id created using the <a href='url-contextualIdentity'>contextualIdentities API</a>, or a built-in one: <var>firefox-default</var>, <var>firefox-container-1</var>, <var>firefox-container-2</var>, <var>firefox-container-3</var>, <var>firefox-container-4</var>, <var>firefox-container-5</var>. **Note:** The naming pattern was deliberately not changed for Thunderbird, but kept for compatibility reasons. The <permission>cookies</permission> permission is required to be able to specify this property. Furthermore, the <permission>contextualIdentities</permission> permission should be requested, to enable the contextual identities feature (enabled by default only on Thunderbird Daily)."
15205
15325
  },
15206
15326
  "selected": {
15207
15327
  "deprecated": "Please use <var>createProperties.active</var>.",
@@ -16414,7 +16534,7 @@
16414
16534
  "cookieStoreId": {
16415
16535
  "type": "string",
16416
16536
  "optional": true,
16417
- "description": "The CookieStoreId to use for all tabs that were created when the window is opened."
16537
+ "description": "The <a href='url-cookieStore'>CookieStore</a> id which all initially opened tabs should use. Either a custom id created using the <a href='url-contextualIdentity'>contextualIdentities API</a>, or a built-in one: <var>firefox-default</var>, <var>firefox-container-1</var>, <var>firefox-container-2</var>, <var>firefox-container-3</var>, <var>firefox-container-4</var>, <var>firefox-container-5</var>. **Note:** The naming pattern was deliberately not changed for Thunderbird, but kept for compatibility reasons. The <permission>cookies</permission> permission is required to be able to specify this property. Furthermore, the <permission>contextualIdentities</permission> permission should be requested, to enable the contextual identities feature (enabled by default only on Thunderbird Daily)."
16418
16538
  },
16419
16539
  "titlePreface": {
16420
16540
  "type": "string",