webext-schema 5.1.16 → 5.2.1

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.
@@ -1836,14 +1836,14 @@
1836
1836
  {
1837
1837
  "name": "setUninstallURL",
1838
1838
  "type": "function",
1839
- "description": "Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics, and implement surveys. Maximum 255 characters.",
1839
+ "description": "Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics, and implement surveys. Maximum 1023 characters.",
1840
1840
  "async": "callback",
1841
1841
  "parameters": [
1842
1842
  {
1843
1843
  "type": "string",
1844
1844
  "name": "url",
1845
1845
  "optional": true,
1846
- "maxLength": 255,
1846
+ "maxLength": 1023,
1847
1847
  "description": "URL to be opened after the extension is uninstalled. This URL must have an http: or https: scheme. Set an empty string to not open a new tab upon uninstallation."
1848
1848
  },
1849
1849
  {
@@ -4118,7 +4118,7 @@
4118
4118
  "type": "string",
4119
4119
  "format": "relativeUrl",
4120
4120
  "optional": true,
4121
- "description": "The html document to be opened as a popup when the user clicks on the action button.",
4121
+ "description": "The html document to be opened as a popup when the user clicks on the action button. Ignored for action buttons with type <value>menu</value>.",
4122
4122
  "preprocess": "localize"
4123
4123
  },
4124
4124
  "browser_style": {
@@ -4161,6 +4161,16 @@
4161
4161
  "mail"
4162
4162
  ],
4163
4163
  "optional": true
4164
+ },
4165
+ "type": {
4166
+ "description": "Specifies the type of the button. Default type is <code>button</code>.",
4167
+ "type": "string",
4168
+ "enum": [
4169
+ "button",
4170
+ "menu"
4171
+ ],
4172
+ "optional": true,
4173
+ "default": "button"
4164
4174
  }
4165
4175
  },
4166
4176
  "optional": true
@@ -4207,7 +4217,7 @@
4207
4217
  "type": "string",
4208
4218
  "format": "relativeUrl",
4209
4219
  "optional": true,
4210
- "description": "The html document to be opened as a popup when the user clicks on the browserAction button.",
4220
+ "description": "The html document to be opened as a popup when the user clicks on the browserAction button. Ignored for action buttons with type <value>menu</value>.",
4211
4221
  "preprocess": "localize"
4212
4222
  },
4213
4223
  "browser_style": {
@@ -4259,6 +4269,16 @@
4259
4269
  "mail"
4260
4270
  ],
4261
4271
  "optional": true
4272
+ },
4273
+ "type": {
4274
+ "description": "Specifies the type of the button. Default type is <code>button</code>.",
4275
+ "type": "string",
4276
+ "enum": [
4277
+ "button",
4278
+ "menu"
4279
+ ],
4280
+ "optional": true,
4281
+ "default": "button"
4262
4282
  }
4263
4283
  },
4264
4284
  "optional": true
@@ -4877,7 +4897,7 @@
4877
4897
  {
4878
4898
  "name": "openPopup",
4879
4899
  "type": "function",
4880
- "description": "Opens the action's popup window in the specified window. Defaults to the current window. Returns false if the popup could not be opened because the action is disabled or has been removed from the toolbar.",
4900
+ "description": "Opens the action's popup window in the specified window. Defaults to the current window. Returns false if the popup could not be opened because the action has no popup, is of type <value>menu</value>, is disabled or has been removed from the toolbar.",
4881
4901
  "async": "callback",
4882
4902
  "parameters": [
4883
4903
  {
@@ -6711,7 +6731,7 @@
6711
6731
  "type": "string",
6712
6732
  "format": "relativeUrl",
6713
6733
  "optional": true,
6714
- "description": "The html document to be opened as a popup when the user clicks on the composeAction button.",
6734
+ "description": "The html document to be opened as a popup when the user clicks on the composeAction button. Ignored for action buttons with type <value>menu</value>.",
6715
6735
  "preprocess": "localize"
6716
6736
  },
6717
6737
  "browser_style": {
@@ -6728,6 +6748,16 @@
6728
6748
  "formattoolbar"
6729
6749
  ],
6730
6750
  "optional": true
6751
+ },
6752
+ "type": {
6753
+ "description": "Specifies the type of the button. Default type is <code>button</code>.",
6754
+ "type": "string",
6755
+ "enum": [
6756
+ "button",
6757
+ "menu"
6758
+ ],
6759
+ "optional": true,
6760
+ "default": "button"
6731
6761
  }
6732
6762
  },
6733
6763
  "optional": true
@@ -7344,7 +7374,7 @@
7344
7374
  {
7345
7375
  "name": "openPopup",
7346
7376
  "type": "function",
7347
- "description": "Opens the action's popup window in the specified window. Defaults to the current window. Returns false if the popup could not be opened because the action is disabled or has been removed from the toolbar.",
7377
+ "description": "Opens the action's popup window in the specified window. Defaults to the current window. Returns false if the popup could not be opened because the action has no popup, is of type <value>menu</value>, is disabled or has been removed from the toolbar.",
7348
7378
  "async": "callback",
7349
7379
  "parameters": [
7350
7380
  {
@@ -8753,6 +8783,7 @@
8753
8783
  "all_message_attachments",
8754
8784
  "audio",
8755
8785
  "compose_action",
8786
+ "compose_action_menu",
8756
8787
  "compose_attachments",
8757
8788
  "compose_body",
8758
8789
  "editable",
@@ -8762,6 +8793,7 @@
8762
8793
  "link",
8763
8794
  "message_attachments",
8764
8795
  "message_display_action",
8796
+ "message_display_action_menu",
8765
8797
  "message_list",
8766
8798
  "page",
8767
8799
  "password",
@@ -8775,14 +8807,16 @@
8775
8807
  "type": "string",
8776
8808
  "max_manifest_version": 2,
8777
8809
  "enum": [
8778
- "browser_action"
8810
+ "browser_action",
8811
+ "browser_action_menu"
8779
8812
  ]
8780
8813
  },
8781
8814
  {
8782
8815
  "type": "string",
8783
8816
  "min_manifest_version": 3,
8784
8817
  "enum": [
8785
- "action"
8818
+ "action",
8819
+ "action_menu"
8786
8820
  ]
8787
8821
  }
8788
8822
  ],
@@ -9725,7 +9759,7 @@
9725
9759
  "type": "string",
9726
9760
  "format": "relativeUrl",
9727
9761
  "optional": true,
9728
- "description": "The html document to be opened as a popup when the user clicks on the messageDisplayAction button.",
9762
+ "description": "The html document to be opened as a popup when the user clicks on the messageDisplayAction button. Ignored for action buttons with type <value>menu</value>.",
9729
9763
  "preprocess": "localize"
9730
9764
  },
9731
9765
  "browser_style": {
@@ -9738,6 +9772,16 @@
9738
9772
  "description": "Currently unused.",
9739
9773
  "type": "string",
9740
9774
  "optional": true
9775
+ },
9776
+ "type": {
9777
+ "description": "Specifies the type of the button. Default type is <code>button</code>.",
9778
+ "type": "string",
9779
+ "enum": [
9780
+ "button",
9781
+ "menu"
9782
+ ],
9783
+ "optional": true,
9784
+ "default": "button"
9741
9785
  }
9742
9786
  },
9743
9787
  "optional": true
@@ -10354,7 +10398,7 @@
10354
10398
  {
10355
10399
  "name": "openPopup",
10356
10400
  "type": "function",
10357
- "description": "Opens the action's popup window in the specified window. Defaults to the current window. Returns false if the popup could not be opened because the action is disabled or has been removed from the toolbar.",
10401
+ "description": "Opens the action's popup window in the specified window. Defaults to the current window. Returns false if the popup could not be opened because the action has no popup, is of type <value>menu</value>, is disabled or has been removed from the toolbar.",
10358
10402
  "async": "callback",
10359
10403
  "parameters": [
10360
10404
  {
@@ -11338,6 +11382,82 @@
11338
11382
  ]
11339
11383
  }
11340
11384
  ],
11385
+ "sessions.json": [
11386
+ {
11387
+ "namespace": "sessions",
11388
+ "functions": [
11389
+ {
11390
+ "name": "setTabValue",
11391
+ "type": "function",
11392
+ "description": "Store a key/value pair associated with a given tab.",
11393
+ "async": true,
11394
+ "parameters": [
11395
+ {
11396
+ "name": "tabId",
11397
+ "type": "integer",
11398
+ "description": "ID of the tab with which you want to associate the data. Error is thrown if ID is invalid."
11399
+ },
11400
+ {
11401
+ "name": "key",
11402
+ "type": "string",
11403
+ "description": "Key that you can later use to retrieve this particular data value."
11404
+ },
11405
+ {
11406
+ "name": "value",
11407
+ "type": "string"
11408
+ }
11409
+ ]
11410
+ },
11411
+ {
11412
+ "name": "getTabValue",
11413
+ "type": "function",
11414
+ "description": "Retrieve a previously stored value for a given tab, given its key.",
11415
+ "async": "callback",
11416
+ "parameters": [
11417
+ {
11418
+ "name": "tabId",
11419
+ "type": "integer",
11420
+ "description": "ID of the tab whose data you are trying to retrieve. Error is thrown if ID is invalid."
11421
+ },
11422
+ {
11423
+ "name": "key",
11424
+ "type": "string",
11425
+ "description": "Key identifying the particular value to retrieve."
11426
+ },
11427
+ {
11428
+ "type": "function",
11429
+ "name": "callback",
11430
+ "optional": true,
11431
+ "parameters": [
11432
+ {
11433
+ "type": "string",
11434
+ "optional": true
11435
+ }
11436
+ ]
11437
+ }
11438
+ ]
11439
+ },
11440
+ {
11441
+ "name": "removeTabValue",
11442
+ "type": "function",
11443
+ "description": "Remove a key/value pair from a given tab.",
11444
+ "async": true,
11445
+ "parameters": [
11446
+ {
11447
+ "name": "tabId",
11448
+ "type": "integer",
11449
+ "description": "ID of the tab whose data you are trying to remove. Error is thrown if ID is invalid."
11450
+ },
11451
+ {
11452
+ "name": "key",
11453
+ "type": "string",
11454
+ "description": "Key identifying the particular value to remove."
11455
+ }
11456
+ ]
11457
+ }
11458
+ ]
11459
+ }
11460
+ ],
11341
11461
  "spaces.json": [
11342
11462
  {
11343
11463
  "namespace": "spaces",
@@ -12819,9 +12939,6 @@
12819
12939
  "enum": [
12820
12940
  "normal",
12821
12941
  "popup",
12822
- "panel",
12823
- "app",
12824
- "devtools",
12825
12942
  "messageCompose",
12826
12943
  "messageDisplay"
12827
12944
  ]
@@ -916,6 +916,31 @@
916
916
  "type": "string"
917
917
  }
918
918
  ]
919
+ },
920
+ {
921
+ "name": "onChanged",
922
+ "description": "Fired when a registered command's shortcut is changed.",
923
+ "type": "function",
924
+ "parameters": [
925
+ {
926
+ "type": "object",
927
+ "name": "changeInfo",
928
+ "properties": {
929
+ "name": {
930
+ "type": "string",
931
+ "description": "The name of the shortcut."
932
+ },
933
+ "newShortcut": {
934
+ "type": "string",
935
+ "description": "The new shortcut active for this command, or blank if not active."
936
+ },
937
+ "oldShortcut": {
938
+ "type": "string",
939
+ "description": "The old shortcut which is no longer active for this command, or blank if the shortcut was previously inactive."
940
+ }
941
+ }
942
+ }
943
+ ]
919
944
  }
920
945
  ],
921
946
  "functions": [
@@ -4438,6 +4463,11 @@
4438
4463
  "optional": true,
4439
4464
  "description": "Whether the tab has produced sound over the past couple of seconds (but it might not be heard if also muted). Equivalent to whether the speaker audio indicator is showing."
4440
4465
  },
4466
+ "autoDiscardable": {
4467
+ "type": "boolean",
4468
+ "optional": true,
4469
+ "description": "Whether the tab can be discarded automatically by the browser when resources are low."
4470
+ },
4441
4471
  "mutedInfo": {
4442
4472
  "$ref": "MutedInfo",
4443
4473
  "optional": true,
@@ -4739,6 +4769,7 @@
4739
4769
  "enum": [
4740
4770
  "attention",
4741
4771
  "audible",
4772
+ "autoDiscardable",
4742
4773
  "discarded",
4743
4774
  "favIconUrl",
4744
4775
  "hidden",
@@ -5070,6 +5101,11 @@
5070
5101
  "optional": true,
5071
5102
  "description": "Whether the tabs are audible."
5072
5103
  },
5104
+ "autoDiscardable": {
5105
+ "type": "boolean",
5106
+ "optional": true,
5107
+ "description": "Whether the tab can be discarded automatically by the browser when resources are low."
5108
+ },
5073
5109
  "muted": {
5074
5110
  "type": "boolean",
5075
5111
  "optional": true,
@@ -5287,6 +5323,11 @@
5287
5323
  "optional": true,
5288
5324
  "description": "Whether the tab should be active. Does not affect whether the window is focused (see $(ref:windows.update))."
5289
5325
  },
5326
+ "autoDiscardable": {
5327
+ "type": "boolean",
5328
+ "optional": true,
5329
+ "description": "Whether the tab can be discarded automatically by the browser when resources are low."
5330
+ },
5290
5331
  "highlighted": {
5291
5332
  "type": "boolean",
5292
5333
  "optional": true,
@@ -6033,6 +6074,11 @@
6033
6074
  "optional": true,
6034
6075
  "description": "The tab's new audible state."
6035
6076
  },
6077
+ "autoDiscardable": {
6078
+ "type": "boolean",
6079
+ "optional": true,
6080
+ "description": "The tab's new autoDiscardable state."
6081
+ },
6036
6082
  "discarded": {
6037
6083
  "type": "boolean",
6038
6084
  "optional": true,
@@ -7835,6 +7881,32 @@
7835
7881
  }
7836
7882
  ]
7837
7883
  },
7884
+ {
7885
+ "name": "getUserSettings",
7886
+ "type": "function",
7887
+ "description": "Returns the user-specified settings relating to an extension's action.",
7888
+ "async": "callback",
7889
+ "parameters": [
7890
+ {
7891
+ "type": "function",
7892
+ "name": "callback",
7893
+ "parameters": [
7894
+ {
7895
+ "name": "userSettings",
7896
+ "type": "object",
7897
+ "properties": {
7898
+ "isOnToolbar": {
7899
+ "type": "boolean",
7900
+ "optional": true,
7901
+ "description": "Whether the extension's action icon is visible on browser windows' top-level toolbar (i.e., whether the extension has been 'pinned' by the user)."
7902
+ }
7903
+ },
7904
+ "description": "The collection of user-specified settings relating to an extension's action."
7905
+ }
7906
+ ]
7907
+ }
7908
+ ]
7909
+ },
7838
7910
  {
7839
7911
  "name": "setIcon",
7840
7912
  "type": "function",
@@ -16238,14 +16310,14 @@
16238
16310
  {
16239
16311
  "name": "setUninstallURL",
16240
16312
  "type": "function",
16241
- "description": "Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics, and implement surveys. Maximum 255 characters.",
16313
+ "description": "Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics, and implement surveys. Maximum 1023 characters.",
16242
16314
  "async": "callback",
16243
16315
  "parameters": [
16244
16316
  {
16245
16317
  "type": "string",
16246
16318
  "name": "url",
16247
16319
  "optional": true,
16248
- "maxLength": 255,
16320
+ "maxLength": 1023,
16249
16321
  "description": "URL to be opened after the extension is uninstalled. This URL must have an http: or https: scheme. Set an empty string to not open a new tab upon uninstallation."
16250
16322
  },
16251
16323
  {
@@ -17534,6 +17606,13 @@
17534
17606
  "description": "The maximum size (in bytes) of the managed storage JSON manifest file. Files larger than this limit will fail to load."
17535
17607
  }
17536
17608
  }
17609
+ },
17610
+ "session": {
17611
+ "allowedContexts": [
17612
+ "devtools"
17613
+ ],
17614
+ "$ref": "StorageArea",
17615
+ "description": "Items in the <code>session</code> storage area are kept in memory, and only until the either browser or extension is closed or reloaded."
17537
17616
  }
17538
17617
  }
17539
17618
  }
@@ -19511,12 +19590,10 @@
19511
19590
  "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab."
19512
19591
  },
19513
19592
  "transitionType": {
19514
- "unsupported": true,
19515
19593
  "$ref": "TransitionType",
19516
19594
  "description": "Cause of the navigation."
19517
19595
  },
19518
19596
  "transitionQualifiers": {
19519
- "unsupported": true,
19520
19597
  "type": "array",
19521
19598
  "description": "A list of transition qualifiers.",
19522
19599
  "items": {
@@ -19738,12 +19815,10 @@
19738
19815
  "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab."
19739
19816
  },
19740
19817
  "transitionType": {
19741
- "unsupported": true,
19742
19818
  "$ref": "TransitionType",
19743
19819
  "description": "Cause of the navigation."
19744
19820
  },
19745
19821
  "transitionQualifiers": {
19746
- "unsupported": true,
19747
19822
  "type": "array",
19748
19823
  "description": "A list of transition qualifiers.",
19749
19824
  "items": {
@@ -19817,12 +19892,10 @@
19817
19892
  "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab."
19818
19893
  },
19819
19894
  "transitionType": {
19820
- "unsupported": true,
19821
19895
  "$ref": "TransitionType",
19822
19896
  "description": "Cause of the navigation."
19823
19897
  },
19824
19898
  "transitionQualifiers": {
19825
- "unsupported": true,
19826
19899
  "type": "array",
19827
19900
  "description": "A list of transition qualifiers.",
19828
19901
  "items": {
@@ -1,4 +1,4 @@
1
- export const ESR_VER: 102;
1
+ export const ESR_VER: 115;
2
2
  export function fetchText(url: string): Promise<string>;
3
3
  export function getChannelUrl(channel: string): string;
4
4
  export function getSchemaData(file: string, baseUrl: string): Promise<object>;