@mostra/protocol 0.11.0 → 0.13.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.
Files changed (97) hide show
  1. package/dist/actions.d.ts +11 -3
  2. package/dist/actions.d.ts.map +1 -1
  3. package/dist/actions.js.map +1 -1
  4. package/dist/browser.d.ts +1 -1
  5. package/dist/diagnostics/codes/index.d.ts +3 -2
  6. package/dist/diagnostics/codes/index.d.ts.map +1 -1
  7. package/dist/diagnostics/codes/index.js +3 -1
  8. package/dist/diagnostics/codes/index.js.map +1 -1
  9. package/dist/diagnostics/codes/remote.js +2 -2
  10. package/dist/diagnostics/codes/remote.js.map +1 -1
  11. package/dist/diagnostics/codes/team.d.ts +8 -0
  12. package/dist/diagnostics/codes/team.d.ts.map +1 -0
  13. package/dist/diagnostics/codes/team.js +44 -0
  14. package/dist/diagnostics/codes/team.js.map +1 -0
  15. package/dist/diagnostics/diagnostic.d.ts +1 -1
  16. package/dist/diagnostics/diagnostic.d.ts.map +1 -1
  17. package/dist/diagnostics/diagnostic.js +2 -1
  18. package/dist/diagnostics/diagnostic.js.map +1 -1
  19. package/dist/index.d.ts +13 -6
  20. package/dist/index.js +11 -4
  21. package/dist/interaction.d.ts +12 -3
  22. package/dist/interaction.d.ts.map +1 -1
  23. package/dist/interaction.js +15 -12
  24. package/dist/interaction.js.map +1 -1
  25. package/dist/manifest.d.ts +3 -0
  26. package/dist/manifest.d.ts.map +1 -1
  27. package/dist/manifest.js +5 -2
  28. package/dist/manifest.js.map +1 -1
  29. package/dist/methods/index.d.ts.map +1 -1
  30. package/dist/methods/index.js +10 -2
  31. package/dist/methods/index.js.map +1 -1
  32. package/dist/methods/port/trusted-controls-policy.d.ts +1 -1
  33. package/dist/methods/results/get.d.ts +3 -1
  34. package/dist/methods/results/get.d.ts.map +1 -1
  35. package/dist/methods/results/get.js +4 -3
  36. package/dist/methods/results/get.js.map +1 -1
  37. package/dist/methods/results/list.d.ts +33 -0
  38. package/dist/methods/results/list.d.ts.map +1 -0
  39. package/dist/methods/results/list.js +35 -0
  40. package/dist/methods/results/list.js.map +1 -0
  41. package/dist/methods/roster/add.d.ts +47 -0
  42. package/dist/methods/roster/add.d.ts.map +1 -0
  43. package/dist/methods/roster/add.js +46 -0
  44. package/dist/methods/roster/add.js.map +1 -0
  45. package/dist/methods/roster/get.d.ts +18 -0
  46. package/dist/methods/roster/get.d.ts.map +1 -0
  47. package/dist/methods/roster/get.js +22 -0
  48. package/dist/methods/roster/get.js.map +1 -0
  49. package/dist/methods/roster/remove.d.ts +28 -0
  50. package/dist/methods/roster/remove.d.ts.map +1 -0
  51. package/dist/methods/roster/remove.js +31 -0
  52. package/dist/methods/roster/remove.js.map +1 -0
  53. package/dist/methods/share/start.d.ts +15 -2
  54. package/dist/methods/share/start.d.ts.map +1 -1
  55. package/dist/methods/share/start.js +5 -1
  56. package/dist/methods/share/start.js.map +1 -1
  57. package/dist/methods/state/get.d.ts +1 -1
  58. package/dist/methods/state/patch.d.ts +1 -1
  59. package/dist/methods/view/url.d.ts +1 -1
  60. package/dist/methods/wait/wait.d.ts +1 -1
  61. package/dist/operator.d.ts +93 -11
  62. package/dist/operator.d.ts.map +1 -1
  63. package/dist/operator.js.map +1 -1
  64. package/dist/team-settings.d.ts +21 -0
  65. package/dist/team-settings.d.ts.map +1 -0
  66. package/dist/team-settings.js +27 -0
  67. package/dist/team-settings.js.map +1 -0
  68. package/dist/team.d.ts +221 -0
  69. package/dist/team.d.ts.map +1 -0
  70. package/dist/team.js +162 -0
  71. package/dist/team.js.map +1 -0
  72. package/dist/verify.d.ts +7 -0
  73. package/dist/verify.d.ts.map +1 -1
  74. package/dist/verify.js.map +1 -1
  75. package/dist/worker.d.ts +1 -1
  76. package/package.json +1 -1
  77. package/schemas/protocol.draft-07.json +802 -79
  78. package/schemas/protocol.schema.json +782 -91
  79. package/src/actions.ts +8 -4
  80. package/src/diagnostics/codes/index.ts +6 -2
  81. package/src/diagnostics/codes/remote.ts +2 -2
  82. package/src/diagnostics/codes/team.ts +53 -0
  83. package/src/diagnostics/diagnostic.ts +3 -1
  84. package/src/index.ts +47 -2
  85. package/src/interaction.ts +24 -5
  86. package/src/manifest.ts +5 -0
  87. package/src/methods/index.ts +8 -0
  88. package/src/methods/results/get.ts +3 -2
  89. package/src/methods/results/list.ts +61 -0
  90. package/src/methods/roster/add.ts +77 -0
  91. package/src/methods/roster/get.ts +30 -0
  92. package/src/methods/roster/remove.ts +49 -0
  93. package/src/methods/share/start.ts +23 -3
  94. package/src/operator.ts +83 -10
  95. package/src/team-settings.ts +38 -0
  96. package/src/team.ts +398 -0
  97. package/src/verify.ts +7 -0
@@ -471,6 +471,46 @@
471
471
  "$ref": "#/definitions/ResultsGetResult"
472
472
  }
473
473
  },
474
+ "results/list": {
475
+ "direction": "client-to-instance",
476
+ "mutating": false,
477
+ "params": {
478
+ "$ref": "#/definitions/ResultsListParams"
479
+ },
480
+ "result": {
481
+ "$ref": "#/definitions/ResultsListResult"
482
+ }
483
+ },
484
+ "roster/add": {
485
+ "direction": "client-to-instance",
486
+ "mutating": true,
487
+ "params": {
488
+ "$ref": "#/definitions/RosterAddParams"
489
+ },
490
+ "result": {
491
+ "$ref": "#/definitions/RosterAddResult"
492
+ }
493
+ },
494
+ "roster/get": {
495
+ "direction": "client-to-instance",
496
+ "mutating": false,
497
+ "params": {
498
+ "$ref": "#/definitions/RosterGetParams"
499
+ },
500
+ "result": {
501
+ "$ref": "#/definitions/Roster"
502
+ }
503
+ },
504
+ "roster/remove": {
505
+ "direction": "client-to-instance",
506
+ "mutating": true,
507
+ "params": {
508
+ "$ref": "#/definitions/RosterRemoveParams"
509
+ },
510
+ "result": {
511
+ "$ref": "#/definitions/RosterRemoveResult"
512
+ }
513
+ },
474
514
  "secret/delete": {
475
515
  "direction": "client-to-instance",
476
516
  "mutating": false,
@@ -670,6 +710,9 @@
670
710
  },
671
711
  "name": {
672
712
  "type": "string"
713
+ },
714
+ "key": {
715
+ "type": "string"
673
716
  }
674
717
  },
675
718
  "required": [
@@ -1163,6 +1206,13 @@
1163
1206
  "$ref": "#/definitions/HostedSettings"
1164
1207
  }
1165
1208
  ]
1209
+ },
1210
+ "team": {
1211
+ "allOf": [
1212
+ {
1213
+ "$ref": "#/definitions/TeamSettings"
1214
+ }
1215
+ ]
1166
1216
  }
1167
1217
  },
1168
1218
  "required": [
@@ -4686,6 +4736,169 @@
4686
4736
  ],
4687
4737
  "description": "The artifact a frame is about to show, for its host's controls policy."
4688
4738
  },
4739
+ "PresenceCursor": {
4740
+ "type": "object",
4741
+ "properties": {
4742
+ "x": {
4743
+ "type": "number",
4744
+ "minimum": -10000000,
4745
+ "maximum": 10000000
4746
+ },
4747
+ "y": {
4748
+ "type": "number",
4749
+ "minimum": -10000000,
4750
+ "maximum": 10000000
4751
+ }
4752
+ },
4753
+ "required": [
4754
+ "x",
4755
+ "y"
4756
+ ],
4757
+ "description": "A shared pointer position in the page's document coordinates, in CSS pixels."
4758
+ },
4759
+ "PresencePeer": {
4760
+ "type": "object",
4761
+ "properties": {
4762
+ "key": {
4763
+ "type": "string",
4764
+ "minLength": 1,
4765
+ "maxLength": 64
4766
+ },
4767
+ "self": {
4768
+ "type": "boolean"
4769
+ },
4770
+ "name": {
4771
+ "type": "string"
4772
+ },
4773
+ "kind": {
4774
+ "type": "string",
4775
+ "enum": [
4776
+ "local",
4777
+ "tailnet",
4778
+ "token",
4779
+ "host",
4780
+ "account",
4781
+ "anonymous"
4782
+ ]
4783
+ },
4784
+ "verified": {
4785
+ "type": "boolean"
4786
+ },
4787
+ "cursor": {
4788
+ "allOf": [
4789
+ {
4790
+ "$ref": "#/definitions/PresenceCursor"
4791
+ }
4792
+ ]
4793
+ },
4794
+ "selection": {
4795
+ "allOf": [
4796
+ {
4797
+ "$ref": "#/definitions/PresenceSelection"
4798
+ }
4799
+ ]
4800
+ },
4801
+ "at": {
4802
+ "type": "string",
4803
+ "format": "date-time",
4804
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
4805
+ }
4806
+ },
4807
+ "required": [
4808
+ "key",
4809
+ "self",
4810
+ "kind",
4811
+ "at"
4812
+ ],
4813
+ "description": "A viewer present now: key, name, and the cursor and selection they share."
4814
+ },
4815
+ "PresenceRequest": {
4816
+ "type": "object",
4817
+ "properties": {
4818
+ "viewId": {
4819
+ "$ref": "#/definitions/ViewId"
4820
+ },
4821
+ "cursor": {
4822
+ "anyOf": [
4823
+ {
4824
+ "$ref": "#/definitions/PresenceCursor"
4825
+ },
4826
+ {
4827
+ "type": "null"
4828
+ }
4829
+ ]
4830
+ },
4831
+ "selection": {
4832
+ "anyOf": [
4833
+ {
4834
+ "$ref": "#/definitions/PresenceSelection"
4835
+ },
4836
+ {
4837
+ "type": "null"
4838
+ }
4839
+ ]
4840
+ },
4841
+ "leave": {
4842
+ "type": "boolean",
4843
+ "const": true
4844
+ },
4845
+ "seq": {
4846
+ "type": "integer",
4847
+ "minimum": 0,
4848
+ "maximum": 9007199254740991
4849
+ }
4850
+ },
4851
+ "required": [
4852
+ "viewId"
4853
+ ],
4854
+ "description": "Joins presence for half a minute, sharing a cursor and a selection, or leaves."
4855
+ },
4856
+ "PresenceSelection": {
4857
+ "type": "object",
4858
+ "properties": {
4859
+ "element": {
4860
+ "type": "string",
4861
+ "minLength": 1,
4862
+ "maxLength": 256
4863
+ },
4864
+ "start": {
4865
+ "type": "integer",
4866
+ "minimum": 0,
4867
+ "maximum": 10000000
4868
+ },
4869
+ "end": {
4870
+ "type": "integer",
4871
+ "minimum": 0,
4872
+ "maximum": 10000000
4873
+ }
4874
+ },
4875
+ "description": "A shared selection: the element the viewer is in and the selected text range."
4876
+ },
4877
+ "PresenceState": {
4878
+ "type": "object",
4879
+ "properties": {
4880
+ "visibility": {
4881
+ "$ref": "#/definitions/TeamVisibility"
4882
+ },
4883
+ "peers": {
4884
+ "readOnly": true,
4885
+ "type": "array",
4886
+ "items": {
4887
+ "$ref": "#/definitions/PresencePeer"
4888
+ }
4889
+ },
4890
+ "others": {
4891
+ "type": "integer",
4892
+ "minimum": 0,
4893
+ "maximum": 9007199254740991
4894
+ }
4895
+ },
4896
+ "required": [
4897
+ "visibility",
4898
+ "peers"
4899
+ ],
4900
+ "description": "Who is present, as a page may see them under the visibility policy."
4901
+ },
4689
4902
  "PublishReceipt": {
4690
4903
  "type": "object",
4691
4904
  "properties": {
@@ -5366,94 +5579,273 @@
5366
5579
  ],
5367
5580
  "description": "When the binding closes unless its token is refreshed again."
5368
5581
  },
5369
- "ResultComment": {
5582
+ "Respondent": {
5370
5583
  "type": "object",
5371
5584
  "properties": {
5372
- "threadId": {
5585
+ "ref": {
5586
+ "type": "string"
5587
+ },
5588
+ "name": {
5589
+ "type": "string"
5590
+ },
5591
+ "email": {
5373
5592
  "type": "string"
5374
5593
  },
5594
+ "viewerId": {
5595
+ "$ref": "#/definitions/ViewerId"
5596
+ },
5375
5597
  "status": {
5598
+ "$ref": "#/definitions/RespondentStatus"
5599
+ },
5600
+ "openedAt": {
5376
5601
  "type": "string",
5377
- "enum": [
5378
- "open",
5379
- "resolved"
5380
- ]
5602
+ "format": "date-time",
5603
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
5381
5604
  },
5382
- "messages": {
5383
- "readOnly": true,
5384
- "type": "array",
5385
- "items": {
5386
- "type": "object",
5387
- "properties": {
5388
- "author": {
5389
- "$ref": "#/definitions/Viewer"
5390
- },
5391
- "at": {
5392
- "type": "string",
5393
- "format": "date-time",
5394
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
5395
- },
5396
- "text": {
5397
- "type": "string"
5398
- }
5399
- },
5400
- "required": [
5401
- "author",
5402
- "at",
5403
- "text"
5404
- ]
5405
- }
5605
+ "activeAt": {
5606
+ "type": "string",
5607
+ "format": "date-time",
5608
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
5406
5609
  },
5407
- "anchor": {
5610
+ "submission": {
5408
5611
  "type": "object",
5409
5612
  "properties": {
5410
- "reviewId": {
5411
- "type": "string"
5412
- },
5413
- "selectors": {
5414
- "readOnly": true,
5415
- "type": "array",
5416
- "items": {}
5417
- },
5418
- "rect": {
5419
- "type": "object",
5420
- "properties": {
5421
- "x": {
5422
- "type": "number"
5423
- },
5424
- "y": {
5425
- "type": "number"
5426
- },
5427
- "width": {
5428
- "type": "number"
5429
- },
5430
- "height": {
5431
- "type": "number"
5432
- }
5433
- },
5434
- "required": [
5435
- "x",
5436
- "y",
5437
- "width",
5438
- "height"
5439
- ]
5613
+ "id": {
5614
+ "$ref": "#/definitions/SubmissionId"
5440
5615
  },
5441
- "viewport": {
5442
- "type": "object",
5443
- "properties": {
5444
- "width": {
5445
- "type": "number"
5446
- },
5447
- "height": {
5448
- "type": "number"
5449
- },
5450
- "dpr": {
5451
- "type": "number"
5452
- }
5453
- },
5454
- "required": [
5455
- "width",
5456
- "height",
5616
+ "at": {
5617
+ "type": "string",
5618
+ "format": "date-time",
5619
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
5620
+ }
5621
+ },
5622
+ "required": [
5623
+ "id",
5624
+ "at"
5625
+ ]
5626
+ },
5627
+ "submissions": {
5628
+ "type": "integer",
5629
+ "minimum": 0,
5630
+ "maximum": 9007199254740991
5631
+ },
5632
+ "tokenId": {
5633
+ "type": "string"
5634
+ },
5635
+ "addedAt": {
5636
+ "type": "string",
5637
+ "format": "date-time",
5638
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
5639
+ }
5640
+ },
5641
+ "required": [
5642
+ "ref",
5643
+ "viewerId",
5644
+ "status",
5645
+ "submissions",
5646
+ "addedAt"
5647
+ ],
5648
+ "description": "An expected respondent as agents and hosts read it: name, viewer, status and submission."
5649
+ },
5650
+ "RespondentForPage": {
5651
+ "type": "object",
5652
+ "properties": {
5653
+ "key": {
5654
+ "type": "string",
5655
+ "minLength": 1,
5656
+ "maxLength": 64
5657
+ },
5658
+ "self": {
5659
+ "type": "boolean"
5660
+ },
5661
+ "name": {
5662
+ "type": "string"
5663
+ },
5664
+ "kind": {
5665
+ "type": "string",
5666
+ "enum": [
5667
+ "local",
5668
+ "tailnet",
5669
+ "token",
5670
+ "host",
5671
+ "account",
5672
+ "anonymous"
5673
+ ]
5674
+ },
5675
+ "verified": {
5676
+ "type": "boolean"
5677
+ },
5678
+ "status": {
5679
+ "$ref": "#/definitions/RespondentStatus"
5680
+ },
5681
+ "openedAt": {
5682
+ "type": "string",
5683
+ "format": "date-time",
5684
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
5685
+ },
5686
+ "submittedAt": {
5687
+ "type": "string",
5688
+ "format": "date-time",
5689
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
5690
+ }
5691
+ },
5692
+ "required": [
5693
+ "key",
5694
+ "self",
5695
+ "kind",
5696
+ "status"
5697
+ ],
5698
+ "description": "A respondent as a page sees them: key, name, status, when opened and submitted."
5699
+ },
5700
+ "RespondentLink": {
5701
+ "type": "object",
5702
+ "properties": {
5703
+ "ref": {
5704
+ "type": "string"
5705
+ },
5706
+ "link": {
5707
+ "$ref": "#/definitions/CapabilityLink"
5708
+ }
5709
+ },
5710
+ "required": [
5711
+ "ref",
5712
+ "link"
5713
+ ],
5714
+ "description": "An expected respondent's personal link, acting as their viewer."
5715
+ },
5716
+ "RespondentSpec": {
5717
+ "type": "object",
5718
+ "properties": {
5719
+ "ref": {
5720
+ "type": "string",
5721
+ "minLength": 1,
5722
+ "maxLength": 256
5723
+ },
5724
+ "name": {
5725
+ "type": "string",
5726
+ "minLength": 1,
5727
+ "maxLength": 256
5728
+ },
5729
+ "email": {
5730
+ "type": "string",
5731
+ "maxLength": 320,
5732
+ "pattern": "^[^\\s@]+@[^\\s@]+$"
5733
+ }
5734
+ },
5735
+ "required": [
5736
+ "ref"
5737
+ ],
5738
+ "description": "An expected respondent: the host's stable key, a display name, an email."
5739
+ },
5740
+ "RespondentStatus": {
5741
+ "type": "string",
5742
+ "enum": [
5743
+ "not-opened",
5744
+ "drafting",
5745
+ "submitted"
5746
+ ],
5747
+ "description": "Where a respondent stands in the round: not-opened, drafting or submitted."
5748
+ },
5749
+ "RespondentsRequest": {
5750
+ "type": "object",
5751
+ "properties": {
5752
+ "viewId": {
5753
+ "$ref": "#/definitions/ViewId"
5754
+ }
5755
+ },
5756
+ "required": [
5757
+ "viewId"
5758
+ ],
5759
+ "description": "Reads the roster as the page may see it, and follows it for a minute."
5760
+ },
5761
+ "ResultComment": {
5762
+ "type": "object",
5763
+ "properties": {
5764
+ "threadId": {
5765
+ "type": "string"
5766
+ },
5767
+ "status": {
5768
+ "type": "string",
5769
+ "enum": [
5770
+ "open",
5771
+ "resolved"
5772
+ ]
5773
+ },
5774
+ "messages": {
5775
+ "readOnly": true,
5776
+ "type": "array",
5777
+ "items": {
5778
+ "type": "object",
5779
+ "properties": {
5780
+ "author": {
5781
+ "$ref": "#/definitions/Viewer"
5782
+ },
5783
+ "at": {
5784
+ "type": "string",
5785
+ "format": "date-time",
5786
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
5787
+ },
5788
+ "text": {
5789
+ "type": "string"
5790
+ }
5791
+ },
5792
+ "required": [
5793
+ "author",
5794
+ "at",
5795
+ "text"
5796
+ ]
5797
+ }
5798
+ },
5799
+ "anchor": {
5800
+ "type": "object",
5801
+ "properties": {
5802
+ "reviewId": {
5803
+ "type": "string"
5804
+ },
5805
+ "selectors": {
5806
+ "readOnly": true,
5807
+ "type": "array",
5808
+ "items": {}
5809
+ },
5810
+ "rect": {
5811
+ "type": "object",
5812
+ "properties": {
5813
+ "x": {
5814
+ "type": "number"
5815
+ },
5816
+ "y": {
5817
+ "type": "number"
5818
+ },
5819
+ "width": {
5820
+ "type": "number"
5821
+ },
5822
+ "height": {
5823
+ "type": "number"
5824
+ }
5825
+ },
5826
+ "required": [
5827
+ "x",
5828
+ "y",
5829
+ "width",
5830
+ "height"
5831
+ ]
5832
+ },
5833
+ "viewport": {
5834
+ "type": "object",
5835
+ "properties": {
5836
+ "width": {
5837
+ "type": "number"
5838
+ },
5839
+ "height": {
5840
+ "type": "number"
5841
+ },
5842
+ "dpr": {
5843
+ "type": "number"
5844
+ }
5845
+ },
5846
+ "required": [
5847
+ "width",
5848
+ "height",
5457
5849
  "dpr"
5458
5850
  ]
5459
5851
  },
@@ -5922,6 +6314,59 @@
5922
6314
  }
5923
6315
  ]
5924
6316
  },
6317
+ "ResultsListParams": {
6318
+ "type": "object",
6319
+ "properties": {
6320
+ "artifact": {
6321
+ "$ref": "#/definitions/ArtifactRef"
6322
+ },
6323
+ "after": {
6324
+ "allOf": [
6325
+ {
6326
+ "$ref": "#/definitions/Cursor"
6327
+ }
6328
+ ]
6329
+ },
6330
+ "limit": {
6331
+ "type": "integer",
6332
+ "minimum": 1,
6333
+ "maximum": 100
6334
+ },
6335
+ "format": {
6336
+ "type": "string",
6337
+ "enum": [
6338
+ "json",
6339
+ "md"
6340
+ ]
6341
+ }
6342
+ },
6343
+ "required": [
6344
+ "artifact"
6345
+ ]
6346
+ },
6347
+ "ResultsListResult": {
6348
+ "type": "object",
6349
+ "properties": {
6350
+ "results": {
6351
+ "readOnly": true,
6352
+ "type": "array",
6353
+ "items": {
6354
+ "$ref": "#/definitions/ResultsGetResult"
6355
+ }
6356
+ },
6357
+ "cursor": {
6358
+ "$ref": "#/definitions/Cursor"
6359
+ },
6360
+ "more": {
6361
+ "type": "boolean"
6362
+ }
6363
+ },
6364
+ "required": [
6365
+ "results",
6366
+ "cursor",
6367
+ "more"
6368
+ ]
6369
+ },
5925
6370
  "ResultsMarkdown": {
5926
6371
  "type": "object",
5927
6372
  "properties": {
@@ -5944,6 +6389,246 @@
5944
6389
  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
5945
6390
  "description": "Protocol revision: a calendar date in YYYY-MM-DD form."
5946
6391
  },
6392
+ "Roster": {
6393
+ "type": "object",
6394
+ "properties": {
6395
+ "round": {
6396
+ "type": "integer",
6397
+ "minimum": 1,
6398
+ "maximum": 9007199254740991
6399
+ },
6400
+ "complete": {
6401
+ "type": "boolean"
6402
+ },
6403
+ "visibility": {
6404
+ "$ref": "#/definitions/TeamVisibility"
6405
+ },
6406
+ "counts": {
6407
+ "$ref": "#/definitions/RosterCounts"
6408
+ },
6409
+ "respondents": {
6410
+ "readOnly": true,
6411
+ "type": "array",
6412
+ "items": {
6413
+ "$ref": "#/definitions/Respondent"
6414
+ }
6415
+ }
6416
+ },
6417
+ "required": [
6418
+ "round",
6419
+ "complete",
6420
+ "visibility",
6421
+ "counts",
6422
+ "respondents"
6423
+ ],
6424
+ "description": "An artifact's expected respondents with their status, the round and its counts."
6425
+ },
6426
+ "RosterAddParams": {
6427
+ "type": "object",
6428
+ "properties": {
6429
+ "artifact": {
6430
+ "$ref": "#/definitions/ArtifactRef"
6431
+ },
6432
+ "respondents": {
6433
+ "readOnly": true,
6434
+ "minItems": 1,
6435
+ "maxItems": 1000,
6436
+ "type": "array",
6437
+ "items": {
6438
+ "$ref": "#/definitions/RespondentSpec"
6439
+ }
6440
+ },
6441
+ "scopes": {
6442
+ "readOnly": true,
6443
+ "minItems": 1,
6444
+ "type": "array",
6445
+ "items": {
6446
+ "$ref": "#/definitions/CapabilityScope"
6447
+ }
6448
+ },
6449
+ "ttl": {
6450
+ "allOf": [
6451
+ {
6452
+ "$ref": "#/definitions/Duration"
6453
+ }
6454
+ ]
6455
+ },
6456
+ "version": {
6457
+ "anyOf": [
6458
+ {
6459
+ "type": "integer",
6460
+ "minimum": 1,
6461
+ "maximum": 9007199254740991
6462
+ },
6463
+ {
6464
+ "$ref": "#/definitions/VersionId"
6465
+ }
6466
+ ]
6467
+ },
6468
+ "requestId": {
6469
+ "type": "string",
6470
+ "minLength": 1
6471
+ }
6472
+ },
6473
+ "required": [
6474
+ "artifact",
6475
+ "respondents"
6476
+ ]
6477
+ },
6478
+ "RosterAddResult": {
6479
+ "type": "object",
6480
+ "properties": {
6481
+ "roster": {
6482
+ "$ref": "#/definitions/Roster"
6483
+ },
6484
+ "links": {
6485
+ "readOnly": true,
6486
+ "type": "array",
6487
+ "items": {
6488
+ "$ref": "#/definitions/RespondentLink"
6489
+ }
6490
+ }
6491
+ },
6492
+ "required": [
6493
+ "roster",
6494
+ "links"
6495
+ ]
6496
+ },
6497
+ "RosterCounts": {
6498
+ "type": "object",
6499
+ "properties": {
6500
+ "total": {
6501
+ "type": "integer",
6502
+ "minimum": 0,
6503
+ "maximum": 9007199254740991
6504
+ },
6505
+ "notOpened": {
6506
+ "type": "integer",
6507
+ "minimum": 0,
6508
+ "maximum": 9007199254740991
6509
+ },
6510
+ "drafting": {
6511
+ "type": "integer",
6512
+ "minimum": 0,
6513
+ "maximum": 9007199254740991
6514
+ },
6515
+ "submitted": {
6516
+ "type": "integer",
6517
+ "minimum": 0,
6518
+ "maximum": 9007199254740991
6519
+ }
6520
+ },
6521
+ "required": [
6522
+ "total",
6523
+ "notOpened",
6524
+ "drafting",
6525
+ "submitted"
6526
+ ],
6527
+ "description": "How many respondents have not opened, are drafting, or submitted in the round."
6528
+ },
6529
+ "RosterForPage": {
6530
+ "type": "object",
6531
+ "properties": {
6532
+ "visibility": {
6533
+ "$ref": "#/definitions/TeamVisibility"
6534
+ },
6535
+ "owner": {
6536
+ "type": "boolean"
6537
+ },
6538
+ "round": {
6539
+ "type": "integer",
6540
+ "minimum": 1,
6541
+ "maximum": 9007199254740991
6542
+ },
6543
+ "self": {
6544
+ "allOf": [
6545
+ {
6546
+ "$ref": "#/definitions/RespondentForPage"
6547
+ }
6548
+ ]
6549
+ },
6550
+ "counts": {
6551
+ "allOf": [
6552
+ {
6553
+ "$ref": "#/definitions/RosterCounts"
6554
+ }
6555
+ ]
6556
+ },
6557
+ "complete": {
6558
+ "type": "boolean"
6559
+ },
6560
+ "respondents": {
6561
+ "readOnly": true,
6562
+ "type": "array",
6563
+ "items": {
6564
+ "$ref": "#/definitions/RespondentForPage"
6565
+ }
6566
+ }
6567
+ },
6568
+ "required": [
6569
+ "visibility",
6570
+ "owner",
6571
+ "round"
6572
+ ],
6573
+ "description": "The roster as a page may see it under the visibility policy (CO-07)."
6574
+ },
6575
+ "RosterGetParams": {
6576
+ "type": "object",
6577
+ "properties": {
6578
+ "artifact": {
6579
+ "$ref": "#/definitions/ArtifactRef"
6580
+ }
6581
+ },
6582
+ "required": [
6583
+ "artifact"
6584
+ ]
6585
+ },
6586
+ "RosterRemoveParams": {
6587
+ "type": "object",
6588
+ "properties": {
6589
+ "artifact": {
6590
+ "$ref": "#/definitions/ArtifactRef"
6591
+ },
6592
+ "refs": {
6593
+ "readOnly": true,
6594
+ "minItems": 1,
6595
+ "maxItems": 1000,
6596
+ "type": "array",
6597
+ "items": {
6598
+ "type": "string",
6599
+ "minLength": 1,
6600
+ "maxLength": 256
6601
+ }
6602
+ },
6603
+ "requestId": {
6604
+ "type": "string",
6605
+ "minLength": 1
6606
+ }
6607
+ },
6608
+ "required": [
6609
+ "artifact",
6610
+ "refs"
6611
+ ]
6612
+ },
6613
+ "RosterRemoveResult": {
6614
+ "type": "object",
6615
+ "properties": {
6616
+ "roster": {
6617
+ "$ref": "#/definitions/Roster"
6618
+ },
6619
+ "removed": {
6620
+ "readOnly": true,
6621
+ "type": "array",
6622
+ "items": {
6623
+ "type": "string"
6624
+ }
6625
+ }
6626
+ },
6627
+ "required": [
6628
+ "roster",
6629
+ "removed"
6630
+ ]
6631
+ },
5947
6632
  "RouteId": {
5948
6633
  "type": "string",
5949
6634
  "pattern": "^rte_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
@@ -6456,6 +7141,15 @@
6456
7141
  }
6457
7142
  ]
6458
7143
  },
7144
+ "respondents": {
7145
+ "readOnly": true,
7146
+ "minItems": 1,
7147
+ "maxItems": 1000,
7148
+ "type": "array",
7149
+ "items": {
7150
+ "$ref": "#/definitions/RespondentSpec"
7151
+ }
7152
+ },
6459
7153
  "requestId": {
6460
7154
  "type": "string",
6461
7155
  "minLength": 1
@@ -6525,6 +7219,13 @@
6525
7219
  "stopReason": {
6526
7220
  "type": "string",
6527
7221
  "minLength": 1
7222
+ },
7223
+ "respondents": {
7224
+ "readOnly": true,
7225
+ "type": "array",
7226
+ "items": {
7227
+ "$ref": "#/definitions/RespondentLink"
7228
+ }
6528
7229
  }
6529
7230
  },
6530
7231
  "required": [
@@ -7053,6 +7754,28 @@
7053
7754
  ],
7054
7755
  "description": "A count by choice of a viewer-scoped field: its field, 2 to 50 distinct choices and minTotal."
7055
7756
  },
7757
+ "TeamSettings": {
7758
+ "type": "object",
7759
+ "properties": {
7760
+ "visibility": {
7761
+ "allOf": [
7762
+ {
7763
+ "$ref": "#/definitions/TeamVisibility"
7764
+ }
7765
+ ]
7766
+ }
7767
+ },
7768
+ "description": "An artifact's team settings: what viewers see of each other (D168)."
7769
+ },
7770
+ "TeamVisibility": {
7771
+ "type": "string",
7772
+ "enum": [
7773
+ "private",
7774
+ "counts",
7775
+ "names"
7776
+ ],
7777
+ "description": "What viewers see of each other: private, counts or names (D168)."
7778
+ },
7056
7779
  "ThreadId": {
7057
7780
  "type": "string",
7058
7781
  "pattern": "^thr_[0-7][0-9A-HJKMNP-TV-Z]{25}$",
@@ -7689,8 +8412,8 @@
7689
8412
  },
7690
8413
  "WaitCondition": {
7691
8414
  "type": "string",
7692
- "pattern": "^(submitted|signal:[A-Za-z0-9][A-Za-z0-9._-]{0,63}|state:[^\\u0000-\\u001f\\u007f]{1,256}|event:[a-z][a-zA-Z0-9_-]*(\\.[a-zA-Z0-9_-]+)*(\\.\\*)?)$",
7693
- "description": "What wait waits for: submitted, signal:<name>, state:<fieldId> or event:<type>."
8415
+ "pattern": "^(?:(submitted|signal:[A-Za-z0-9][A-Za-z0-9._-]{0,63}|state:[^\\u0000-\\u001f\\u007f]{1,256}|event:[a-z][a-zA-Z0-9_-]*(\\.[a-zA-Z0-9_-]+)*(\\.\\*)?)$|submitted:(?:all|[1-9][0-9]{0,3}|10000)$)",
8416
+ "description": "What wait waits for: submitted, submitted:all, submitted:<N>, signal:<name>, state:<fieldId> or event:<type>."
7694
8417
  },
7695
8418
  "WaitParams": {
7696
8419
  "type": "object",