webext-schema 5.5.5 → 5.6.0

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.
@@ -4288,6 +4288,287 @@
4288
4288
  ]
4289
4289
  }
4290
4290
  ],
4291
+ "tabGroups.json": [
4292
+ {
4293
+ "namespace": "manifest",
4294
+ "types": [
4295
+ {
4296
+ "$extend": "OptionalPermissionNoPrompt",
4297
+ "choices": [
4298
+ {
4299
+ "type": "string",
4300
+ "enum": [
4301
+ "tabGroups"
4302
+ ]
4303
+ }
4304
+ ]
4305
+ }
4306
+ ]
4307
+ },
4308
+ {
4309
+ "namespace": "tabGroups",
4310
+ "description": "Use the browser.tabGroups API to interact with the browser's tab grouping system. You can use this API to modify, and rearrange tab groups.",
4311
+ "permissions": [
4312
+ "tabGroups"
4313
+ ],
4314
+ "types": [
4315
+ {
4316
+ "id": "Color",
4317
+ "type": "string",
4318
+ "description": "The group's color, using 'grey' spelling for compatibility with Chromium.",
4319
+ "enum": [
4320
+ "blue",
4321
+ "cyan",
4322
+ "grey",
4323
+ "green",
4324
+ "orange",
4325
+ "pink",
4326
+ "purple",
4327
+ "red",
4328
+ "yellow"
4329
+ ]
4330
+ },
4331
+ {
4332
+ "id": "TabGroup",
4333
+ "type": "object",
4334
+ "description": "State of a tab group inside of an open window.",
4335
+ "properties": {
4336
+ "collapsed": {
4337
+ "type": "boolean",
4338
+ "description": "Whether the tab group is collapsed or expanded in the tab strip."
4339
+ },
4340
+ "color": {
4341
+ "$ref": "Color",
4342
+ "description": "User-selected color name for the tab group's label/icons."
4343
+ },
4344
+ "id": {
4345
+ "type": "integer",
4346
+ "description": "Unique ID of the tab group."
4347
+ },
4348
+ "title": {
4349
+ "type": "string",
4350
+ "optional": true,
4351
+ "description": "User-defined name of the tab group."
4352
+ },
4353
+ "windowId": {
4354
+ "type": "integer",
4355
+ "description": "Window that the tab group is in."
4356
+ }
4357
+ }
4358
+ }
4359
+ ],
4360
+ "properties": {
4361
+ "TAB_GROUP_ID_NONE": {
4362
+ "value": -1,
4363
+ "description": "An ID that represents the absence of a group."
4364
+ }
4365
+ },
4366
+ "functions": [
4367
+ {
4368
+ "name": "get",
4369
+ "type": "function",
4370
+ "description": "Retrieves details about the specified group.",
4371
+ "async": "callback",
4372
+ "parameters": [
4373
+ {
4374
+ "type": "integer",
4375
+ "name": "groupId",
4376
+ "minimum": 0
4377
+ },
4378
+ {
4379
+ "type": "function",
4380
+ "name": "callback",
4381
+ "parameters": [
4382
+ {
4383
+ "name": "group",
4384
+ "$ref": "TabGroup"
4385
+ }
4386
+ ]
4387
+ }
4388
+ ]
4389
+ },
4390
+ {
4391
+ "name": "move",
4392
+ "type": "function",
4393
+ "description": "Move a group within, or to another window.",
4394
+ "async": "callback",
4395
+ "parameters": [
4396
+ {
4397
+ "type": "integer",
4398
+ "name": "groupId",
4399
+ "minimum": 0
4400
+ },
4401
+ {
4402
+ "type": "object",
4403
+ "name": "moveProperties",
4404
+ "properties": {
4405
+ "index": {
4406
+ "type": "integer",
4407
+ "minimum": -1
4408
+ },
4409
+ "windowId": {
4410
+ "type": "integer",
4411
+ "optional": true,
4412
+ "minimum": 0
4413
+ }
4414
+ }
4415
+ },
4416
+ {
4417
+ "type": "function",
4418
+ "name": "callback",
4419
+ "parameters": [
4420
+ {
4421
+ "name": "group",
4422
+ "$ref": "TabGroup"
4423
+ }
4424
+ ]
4425
+ }
4426
+ ]
4427
+ },
4428
+ {
4429
+ "name": "query",
4430
+ "type": "function",
4431
+ "description": "Return all grups, or find groups with specified properties.",
4432
+ "async": "callback",
4433
+ "parameters": [
4434
+ {
4435
+ "type": "object",
4436
+ "name": "queryInfo",
4437
+ "properties": {
4438
+ "collapsed": {
4439
+ "type": "boolean",
4440
+ "optional": true
4441
+ },
4442
+ "color": {
4443
+ "$ref": "Color",
4444
+ "optional": true
4445
+ },
4446
+ "title": {
4447
+ "type": "string",
4448
+ "optional": true
4449
+ },
4450
+ "windowId": {
4451
+ "type": "integer",
4452
+ "optional": true,
4453
+ "minimum": -2
4454
+ }
4455
+ }
4456
+ },
4457
+ {
4458
+ "type": "function",
4459
+ "name": "callback",
4460
+ "parameters": [
4461
+ {
4462
+ "name": "groups",
4463
+ "type": "array",
4464
+ "items": {
4465
+ "$ref": "TabGroup"
4466
+ }
4467
+ }
4468
+ ]
4469
+ }
4470
+ ]
4471
+ },
4472
+ {
4473
+ "name": "update",
4474
+ "type": "function",
4475
+ "description": "Modifies state of a specified group.",
4476
+ "async": "callback",
4477
+ "parameters": [
4478
+ {
4479
+ "type": "integer",
4480
+ "name": "groupId",
4481
+ "minimum": 0
4482
+ },
4483
+ {
4484
+ "type": "object",
4485
+ "name": "updateProperties",
4486
+ "properties": {
4487
+ "collapsed": {
4488
+ "type": "boolean",
4489
+ "optional": true
4490
+ },
4491
+ "color": {
4492
+ "$ref": "Color",
4493
+ "optional": true
4494
+ },
4495
+ "title": {
4496
+ "type": "string",
4497
+ "optional": true
4498
+ }
4499
+ }
4500
+ },
4501
+ {
4502
+ "type": "function",
4503
+ "name": "callback",
4504
+ "parameters": [
4505
+ {
4506
+ "name": "group",
4507
+ "$ref": "TabGroup"
4508
+ }
4509
+ ]
4510
+ }
4511
+ ]
4512
+ }
4513
+ ],
4514
+ "events": [
4515
+ {
4516
+ "name": "onCreated",
4517
+ "type": "function",
4518
+ "description": "Fired when a tab group is created.",
4519
+ "parameters": [
4520
+ {
4521
+ "$ref": "TabGroup",
4522
+ "name": "group"
4523
+ }
4524
+ ]
4525
+ },
4526
+ {
4527
+ "name": "onMoved",
4528
+ "type": "function",
4529
+ "description": "Fired when a tab group is moved, within a window or to another window.",
4530
+ "parameters": [
4531
+ {
4532
+ "$ref": "TabGroup",
4533
+ "name": "group"
4534
+ }
4535
+ ]
4536
+ },
4537
+ {
4538
+ "name": "onRemoved",
4539
+ "type": "function",
4540
+ "description": "Fired when a tab group is removed.",
4541
+ "parameters": [
4542
+ {
4543
+ "$ref": "TabGroup",
4544
+ "name": "group"
4545
+ },
4546
+ {
4547
+ "type": "object",
4548
+ "name": "removeInfo",
4549
+ "properties": {
4550
+ "isWindowClosing": {
4551
+ "type": "boolean",
4552
+ "description": "True when the tab group is being closed because its window is being closed."
4553
+ }
4554
+ }
4555
+ }
4556
+ ]
4557
+ },
4558
+ {
4559
+ "name": "onUpdated",
4560
+ "type": "function",
4561
+ "description": "Fired when a tab group is updated.",
4562
+ "parameters": [
4563
+ {
4564
+ "$ref": "TabGroup",
4565
+ "name": "group"
4566
+ }
4567
+ ]
4568
+ }
4569
+ ]
4570
+ }
4571
+ ],
4291
4572
  "tabs.json": [
4292
4573
  {
4293
4574
  "namespace": "manifest",
@@ -4528,6 +4809,12 @@
4528
4809
  "optional": true,
4529
4810
  "minimum": -1,
4530
4811
  "description": "The ID of this tab's successor, if any; $(ref:tabs.TAB_ID_NONE) otherwise."
4812
+ },
4813
+ "groupId": {
4814
+ "type": "integer",
4815
+ "optional": true,
4816
+ "minimum": -1,
4817
+ "description": "The ID of the group that the tab belongs to. $(ref:tabGroups.TAB_GROUP_ID_NONE) (-1) if the tab does not belong to a tab group."
4531
4818
  }
4532
4819
  }
4533
4820
  },
@@ -4739,6 +5026,7 @@
4739
5026
  "autoDiscardable",
4740
5027
  "discarded",
4741
5028
  "favIconUrl",
5029
+ "groupId",
4742
5030
  "hidden",
4743
5031
  "isArticle",
4744
5032
  "mutedInfo",
@@ -5166,6 +5454,12 @@
5166
5454
  "optional": true,
5167
5455
  "description": "The ID of the tab that opened this tab. If specified, the opener tab must be in the same window as this tab."
5168
5456
  },
5457
+ "groupId": {
5458
+ "type": "integer",
5459
+ "minimum": -1,
5460
+ "optional": true,
5461
+ "description": "The ID of the group that the tabs are in, or $(ref:tabGroups.TAB_GROUP_ID_NONE) (-1) for ungrouped tabs."
5462
+ },
5169
5463
  "screen": {
5170
5464
  "choices": [
5171
5465
  {
@@ -6002,6 +6296,95 @@
6002
6296
  "parameters": []
6003
6297
  }
6004
6298
  ]
6299
+ },
6300
+ {
6301
+ "name": "group",
6302
+ "type": "function",
6303
+ "description": "Adds one or more tabs to a specified group, or if no group is specified, adds the given tabs to a newly created group.",
6304
+ "async": "callback",
6305
+ "parameters": [
6306
+ {
6307
+ "name": "options",
6308
+ "type": "object",
6309
+ "properties": {
6310
+ "tabIds": {
6311
+ "description": "The tab ID or list of tab IDs to add to the specified group.",
6312
+ "choices": [
6313
+ {
6314
+ "type": "integer",
6315
+ "minimum": 0
6316
+ },
6317
+ {
6318
+ "type": "array",
6319
+ "items": {
6320
+ "type": "integer",
6321
+ "minimum": 0
6322
+ },
6323
+ "minItems": 1
6324
+ }
6325
+ ]
6326
+ },
6327
+ "groupId": {
6328
+ "type": "integer",
6329
+ "description": "The ID of the group to add the tabs to. If not specified, a new group will be created.",
6330
+ "minimum": 0,
6331
+ "optional": true
6332
+ },
6333
+ "createProperties": {
6334
+ "type": "object",
6335
+ "optional": true,
6336
+ "description": "Configurations for creating a group. Cannot be used if groupId is already specified.",
6337
+ "properties": {
6338
+ "windowId": {
6339
+ "type": "integer",
6340
+ "minimum": -2,
6341
+ "optional": true,
6342
+ "description": "The window of the new group. Defaults to the current window."
6343
+ }
6344
+ }
6345
+ }
6346
+ }
6347
+ },
6348
+ {
6349
+ "type": "function",
6350
+ "name": "callback",
6351
+ "optional": true,
6352
+ "parameters": [
6353
+ {
6354
+ "name": "groupId",
6355
+ "type": "integer",
6356
+ "minimum": 0,
6357
+ "description": "The ID of the group that the tabs were added to."
6358
+ }
6359
+ ]
6360
+ }
6361
+ ]
6362
+ },
6363
+ {
6364
+ "name": "ungroup",
6365
+ "type": "function",
6366
+ "description": "Removes one or more tabs from their respective groups. If any groups become empty, they are deleted.",
6367
+ "async": true,
6368
+ "parameters": [
6369
+ {
6370
+ "name": "tabIds",
6371
+ "description": "The tab ID or list of tab IDs to remove from their respective groups.",
6372
+ "choices": [
6373
+ {
6374
+ "type": "integer",
6375
+ "minimum": 0
6376
+ },
6377
+ {
6378
+ "type": "array",
6379
+ "items": {
6380
+ "type": "integer",
6381
+ "minimum": 0
6382
+ },
6383
+ "minItems": 1
6384
+ }
6385
+ ]
6386
+ }
6387
+ ]
6005
6388
  }
6006
6389
  ],
6007
6390
  "events": [
@@ -9036,6 +9419,7 @@
9036
9419
  "id": "SameSiteStatus",
9037
9420
  "type": "string",
9038
9421
  "enum": [
9422
+ "unspecified",
9039
9423
  "no_restriction",
9040
9424
  "lax",
9041
9425
  "strict"
@@ -9329,7 +9713,7 @@
9329
9713
  "$ref": "SameSiteStatus",
9330
9714
  "optional": true,
9331
9715
  "description": "The cookie's same-site status.",
9332
- "default": "no_restriction"
9716
+ "default": "unspecified"
9333
9717
  },
9334
9718
  "expirationDate": {
9335
9719
  "type": "number",
@@ -9583,7 +9967,7 @@
9583
9967
  {
9584
9968
  "id": "ResourceType",
9585
9969
  "type": "string",
9586
- "description": "How the requested resource will be used. Comparable to the webRequest.ResourceType type.",
9970
+ "description": "How the requested resource will be used. Comparable to the webRequest.ResourceType type. object_subrequest is unsupported.",
9587
9971
  "enum": [
9588
9972
  "main_frame",
9589
9973
  "sub_frame",
@@ -13941,6 +14325,55 @@
13941
14325
  }
13942
14326
  ]
13943
14327
  },
14328
+ {
14329
+ "id": "CommonDataCollectionPermission",
14330
+ "choices": [
14331
+ {
14332
+ "type": "string",
14333
+ "enum": [
14334
+ "authenticationInfo",
14335
+ "bookmarksInfo",
14336
+ "browsingActivity",
14337
+ "financialAndPaymentInfo",
14338
+ "healthInfo",
14339
+ "locationInfo",
14340
+ "personalCommunications",
14341
+ "personallyIdentifyingInfo",
14342
+ "searchTerms",
14343
+ "websiteActivity",
14344
+ "websiteContent"
14345
+ ]
14346
+ }
14347
+ ]
14348
+ },
14349
+ {
14350
+ "id": "DataCollectionPermission",
14351
+ "choices": [
14352
+ {
14353
+ "$ref": "CommonDataCollectionPermission"
14354
+ },
14355
+ {
14356
+ "type": "string",
14357
+ "enum": [
14358
+ "none"
14359
+ ]
14360
+ }
14361
+ ]
14362
+ },
14363
+ {
14364
+ "id": "OptionalDataCollectionPermission",
14365
+ "choices": [
14366
+ {
14367
+ "$ref": "CommonDataCollectionPermission"
14368
+ },
14369
+ {
14370
+ "type": "string",
14371
+ "enum": [
14372
+ "technicalAndInteraction"
14373
+ ]
14374
+ }
14375
+ ]
14376
+ },
13944
14377
  {
13945
14378
  "id": "PermissionNoPrompt",
13946
14379
  "choices": [
@@ -14042,6 +14475,31 @@
14042
14475
  "admin_install_only": {
14043
14476
  "type": "boolean",
14044
14477
  "optional": true
14478
+ },
14479
+ "data_collection_permissions": {
14480
+ "type": "object",
14481
+ "optional": true,
14482
+ "properties": {
14483
+ "required": {
14484
+ "type": "array",
14485
+ "items": {
14486
+ "$ref": "DataCollectionPermission",
14487
+ "onError": "warn"
14488
+ },
14489
+ "optional": true,
14490
+ "default": [],
14491
+ "postprocess": "checkValidRequiredDataCollection"
14492
+ },
14493
+ "optional": {
14494
+ "type": "array",
14495
+ "items": {
14496
+ "$ref": "OptionalDataCollectionPermission",
14497
+ "onError": "warn"
14498
+ },
14499
+ "optional": true,
14500
+ "default": []
14501
+ }
14502
+ }
14045
14503
  }
14046
14504
  },
14047
14505
  "additionalProperties": {
@@ -15247,6 +15705,14 @@
15247
15705
  },
15248
15706
  "optional": true,
15249
15707
  "default": []
15708
+ },
15709
+ "data_collection": {
15710
+ "type": "array",
15711
+ "items": {
15712
+ "$ref": "manifest.OptionalDataCollectionPermission"
15713
+ },
15714
+ "optional": true,
15715
+ "default": []
15250
15716
  }
15251
15717
  }
15252
15718
  },
@@ -15276,6 +15742,14 @@
15276
15742
  },
15277
15743
  "optional": true,
15278
15744
  "default": []
15745
+ },
15746
+ "data_collection": {
15747
+ "type": "array",
15748
+ "items": {
15749
+ "$ref": "manifest.OptionalDataCollectionPermission"
15750
+ },
15751
+ "optional": true,
15752
+ "default": []
15279
15753
  }
15280
15754
  }
15281
15755
  }
@@ -18425,6 +18899,7 @@
18425
18899
  {
18426
18900
  "name": "assertThrows",
18427
18901
  "type": "function",
18902
+ "allowAmbiguousOptionalArguments": true,
18428
18903
  "parameters": [
18429
18904
  {
18430
18905
  "name": "func",
@@ -18432,7 +18907,9 @@
18432
18907
  },
18433
18908
  {
18434
18909
  "name": "expectedError",
18435
- "$ref": "ExpectedError"
18910
+ "$ref": "ExpectedError",
18911
+ "optional": true,
18912
+ "description": "Required, unless running with extensions.wpt.enabled"
18436
18913
  },
18437
18914
  {
18438
18915
  "name": "message",
@@ -18440,6 +18917,21 @@
18440
18917
  "optional": true
18441
18918
  }
18442
18919
  ]
18920
+ },
18921
+ {
18922
+ "name": "runTests",
18923
+ "type": "function",
18924
+ "async": true,
18925
+ "parameters": [
18926
+ {
18927
+ "name": "tests",
18928
+ "type": "array",
18929
+ "minItems": 1,
18930
+ "items": {
18931
+ "type": "function"
18932
+ }
18933
+ }
18934
+ ]
18443
18935
  }
18444
18936
  ],
18445
18937
  "types": [
@@ -20425,7 +20917,6 @@
20425
20917
  "script",
20426
20918
  "image",
20427
20919
  "object",
20428
- "object_subrequest",
20429
20920
  "xmlhttprequest",
20430
20921
  "xslt",
20431
20922
  "ping",