@crvouga/atlas 0.10.0 → 0.10.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.
Files changed (51) hide show
  1. package/CHANGELOG.md +13 -1
  2. package/dist/reports/src/layer-merge.d.ts +5 -1
  3. package/dist/reports/src/layer-merge.js +17 -2
  4. package/dist/schema/src/common.d.ts +2 -2
  5. package/dist/schema/src/manifest.d.ts +4 -4
  6. package/dist/schema/src/spec.d.ts +6 -6
  7. package/docs/agents.md +25 -0
  8. package/docs/reference/reports.md +2 -0
  9. package/docs/report-contract.md +3 -0
  10. package/llms-full.txt +28 -0
  11. package/package.json +3 -3
  12. package/packages/schema/schemas/check-detail.schema.json +15 -15
  13. package/packages/schema/schemas/checks-result.schema.json +2 -2
  14. package/packages/schema/schemas/command-error.schema.json +4 -4
  15. package/packages/schema/schemas/doctor-result.schema.json +4 -4
  16. package/packages/schema/schemas/effective-delta.schema.json +69 -95
  17. package/packages/schema/schemas/effective-evidence.schema.json +63 -89
  18. package/packages/schema/schemas/evidence-page.schema.json +41 -59
  19. package/packages/schema/schemas/init-plan.schema.json +58 -90
  20. package/packages/schema/schemas/layer-rows.schema.json +17 -29
  21. package/packages/schema/schemas/layer.schema.json +54 -70
  22. package/packages/schema/schemas/live-run-start.schema.json +1 -1
  23. package/packages/schema/schemas/live-run.schema.json +1 -1
  24. package/packages/schema/schemas/merge-result.schema.json +6 -6
  25. package/packages/schema/schemas/outline.schema.json +7 -11
  26. package/packages/schema/schemas/path-record.schema.json +12 -28
  27. package/packages/schema/schemas/problem.schema.json +9 -9
  28. package/packages/schema/schemas/publish-checks.schema.json +27 -43
  29. package/packages/schema/schemas/publish-result.schema.json +16 -24
  30. package/packages/schema/schemas/ready.schema.json +12 -12
  31. package/packages/schema/schemas/report-event.schema.json +22 -28
  32. package/packages/schema/schemas/report-run.schema.json +33 -59
  33. package/packages/schema/schemas/report-runs.schema.json +24 -38
  34. package/packages/schema/schemas/report-status.schema.json +30 -54
  35. package/packages/schema/schemas/run-info.schema.json +9 -21
  36. package/packages/schema/schemas/run-summary.schema.json +6 -14
  37. package/packages/schema/schemas/server-config.schema.json +21 -21
  38. package/packages/schema/schemas/server-editable-settings.schema.json +14 -14
  39. package/packages/schema/schemas/server-info.schema.json +15 -19
  40. package/packages/schema/schemas/server-settings-snapshot.schema.json +28 -28
  41. package/packages/schema/schemas/spec-set.schema.json +16 -24
  42. package/packages/schema/schemas/state-node.schema.json +16 -16
  43. package/packages/schema/schemas/state-record.schema.json +5 -9
  44. package/packages/schema/schemas/store-listing.schema.json +3 -7
  45. package/packages/schema/schemas/store-write-result.schema.json +2 -2
  46. package/packages/schema/schemas/stream-result.schema.json +13 -17
  47. package/packages/schema/schemas/test-catalog.schema.json +109 -151
  48. package/packages/schema/schemas/test-history.schema.json +72 -136
  49. package/packages/schema/schemas/timeline-entry.schema.json +2 -2
  50. package/packages/schema/schemas/transition-record.schema.json +9 -21
  51. package/packages/server/openapi.json +620 -910
package/packages/schema/schemas/state-node.schema.json CHANGED
@@ -26,11 +26,11 @@
26
26
  "type": "string"
27
27
  },
28
28
  "events": {
29
- "description": "Business events that happen on entering the state",
30
29
  "type": "array",
31
30
  "items": {
32
31
  "type": "string"
33
- }
32
+ },
33
+ "description": "Business events that happen on entering the state"
34
34
  },
35
35
  "confidence": {
36
36
  "type": "string",
@@ -73,18 +73,17 @@
73
73
  "type": "string"
74
74
  },
75
75
  "quint": {
76
- "description": "Quint model reference",
77
- "type": "string"
76
+ "type": "string",
77
+ "description": "Quint model reference"
78
78
  },
79
79
  "gherkin": {
80
- "description": "Feature files or scenarios that cover the state",
81
80
  "type": "array",
82
81
  "items": {
83
82
  "type": "string"
84
- }
83
+ },
84
+ "description": "Feature files or scenarios that cover the state"
85
85
  },
86
86
  "contracts": {
87
- "description": "Business rules and their exact Given/When/Then examples, copied from the authoritative source",
88
87
  "type": "array",
89
88
  "items": {
90
89
  "type": "object",
@@ -142,15 +141,16 @@
142
141
  "source",
143
142
  "steps"
144
143
  ]
145
- }
144
+ },
145
+ "description": "Business rules and their exact Given/When/Then examples, copied from the authoritative source"
146
146
  },
147
147
  "design": {
148
148
  "type": "object",
149
149
  "properties": {
150
150
  "image": {
151
- "description": "URL or spec-relative path of a design frame",
152
151
  "type": "string",
153
- "minLength": 1
152
+ "minLength": 1,
153
+ "description": "URL or spec-relative path of a design frame"
154
154
  },
155
155
  "url": {
156
156
  "description": "Where the design lives, for example a Figma frame link",
@@ -165,14 +165,13 @@
165
165
  ]
166
166
  },
167
167
  "hints": {
168
- "description": "What the screen shows, for the placeholder sketch",
169
168
  "type": "array",
170
169
  "items": {
171
170
  "type": "string"
172
- }
171
+ },
172
+ "description": "What the screen shows, for the placeholder sketch"
173
173
  },
174
174
  "eventKinds": {
175
- "description": "Chart-level: who or what sends each event; overrides the runner and the guess",
176
175
  "type": "object",
177
176
  "propertyNames": {
178
177
  "type": "string"
@@ -185,17 +184,18 @@
185
184
  "time",
186
185
  "hand-off"
187
186
  ]
188
- }
187
+ },
188
+ "description": "Chart-level: who or what sends each event; overrides the runner and the guess"
189
189
  },
190
190
  "timeEvents": {
191
- "description": "Chart-level: time events and the span each one jumps, for example \"5 minutes\"",
192
191
  "type": "object",
193
192
  "propertyNames": {
194
193
  "type": "string"
195
194
  },
196
195
  "additionalProperties": {
197
196
  "type": "string"
198
- }
197
+ },
198
+ "description": "Chart-level: time events and the span each one jumps, for example \"5 minutes\""
199
199
  }
200
200
  }
201
201
  },
package/packages/schema/schemas/state-record.schema.json CHANGED
@@ -7,13 +7,9 @@
7
7
  "type": "string"
8
8
  },
9
9
  "chart": {
10
- "anyOf": [
11
- {
12
- "type": "string"
13
- },
14
- {
15
- "type": "null"
16
- }
10
+ "type": [
11
+ "string",
12
+ "null"
17
13
  ]
18
14
  },
19
15
  "description": {
@@ -249,11 +245,11 @@
249
245
  }
250
246
  },
251
247
  "noSignal": {
252
- "description": "No observable signal is mapped yet",
253
248
  "type": "array",
254
249
  "items": {
255
250
  "type": "string"
256
- }
251
+ },
252
+ "description": "No observable signal is mapped yet"
257
253
  },
258
254
  "events": {
259
255
  "description": "The CloudEvents observed during the step",
package/packages/schema/schemas/store-listing.schema.json CHANGED
@@ -11,13 +11,9 @@
11
11
  },
12
12
  "next": {
13
13
  "description": "Pass as `?after=` for the next page; null when there are no more",
14
- "anyOf": [
15
- {
16
- "type": "string"
17
- },
18
- {
19
- "type": "null"
20
- }
14
+ "type": [
15
+ "string",
16
+ "null"
21
17
  ]
22
18
  }
23
19
  },
package/packages/schema/schemas/store-write-result.schema.json CHANGED
@@ -11,8 +11,8 @@
11
11
  "type": "string"
12
12
  },
13
13
  "kind": {
14
- "description": "What the server recognised the key as: `layer`, `layer-catalog`, `blob`, `spec-body`, `spec-set`, `spec-catalog`, `run-manifest`, `run-catalog`, `run-file` or `scratch`",
15
- "type": "string"
14
+ "type": "string",
15
+ "description": "What the server recognised the key as: `layer`, `layer-catalog`, `blob`, `spec-body`, `spec-set`, `spec-catalog`, `run-manifest`, `run-catalog`, `run-file` or `scratch`"
16
16
  },
17
17
  "created": {
18
18
  "type": "boolean"
package/packages/schema/schemas/stream-result.schema.json CHANGED
@@ -4,46 +4,42 @@
4
4
  "type": "object",
5
5
  "properties": {
6
6
  "ok": {
7
- "description": "False when any check could not be sent (the exit code is then 1)",
8
- "type": "boolean"
7
+ "type": "boolean",
8
+ "description": "False when any check could not be sent (the exit code is then 1)"
9
9
  },
10
10
  "producer": {
11
11
  "type": "string"
12
12
  },
13
13
  "environment": {
14
- "anyOf": [
15
- {
16
- "type": "string"
17
- },
18
- {
19
- "type": "null"
20
- }
14
+ "type": [
15
+ "string",
16
+ "null"
21
17
  ]
22
18
  },
23
19
  "layers": {
24
- "description": "Layers that arrived",
25
20
  "type": "integer",
26
21
  "minimum": 0,
27
- "maximum": 9007199254740991
22
+ "maximum": 9007199254740991,
23
+ "description": "Layers that arrived"
28
24
  },
29
25
  "checks": {
30
- "description": "Checks that arrived",
31
26
  "type": "integer",
32
27
  "minimum": 0,
33
- "maximum": 9007199254740991
28
+ "maximum": 9007199254740991,
29
+ "description": "Checks that arrived"
34
30
  },
35
31
  "lost": {
36
- "description": "Checks that never arrived",
37
32
  "type": "integer",
38
33
  "minimum": 0,
39
- "maximum": 9007199254740991
34
+ "maximum": 9007199254740991,
35
+ "description": "Checks that never arrived"
40
36
  },
41
37
  "warnings": {
42
- "description": "Input lines that were skipped, and sends that failed",
43
38
  "type": "array",
44
39
  "items": {
45
40
  "type": "string"
46
- }
41
+ },
42
+ "description": "Input lines that were skipped, and sends that failed"
47
43
  }
48
44
  },
49
45
  "required": [
package/packages/schema/schemas/test-catalog.schema.json CHANGED
@@ -8,8 +8,8 @@
8
8
  "const": 1
9
9
  },
10
10
  "version": {
11
- "description": "Changes whenever the report or its history does",
12
- "type": "string"
11
+ "type": "string",
12
+ "description": "Changes whenever the report or its history does"
13
13
  },
14
14
  "generatedAtMs": {
15
15
  "type": "number"
@@ -37,7 +37,13 @@
37
37
  "type": "integer",
38
38
  "minimum": 0,
39
39
  "maximum": 9007199254740991
40
- }
40
+ },
41
+ "required": [
42
+ "passed",
43
+ "failed",
44
+ "running",
45
+ "not-run"
46
+ ]
41
47
  },
42
48
  "outcomes": {
43
49
  "type": "integer",
@@ -136,16 +142,18 @@
136
142
  "type": "integer",
137
143
  "minimum": 0,
138
144
  "maximum": 9007199254740991
139
- }
145
+ },
146
+ "required": [
147
+ "passed",
148
+ "failed",
149
+ "running",
150
+ "not-run"
151
+ ]
140
152
  },
141
153
  "avgMs": {
142
- "anyOf": [
143
- {
144
- "type": "number"
145
- },
146
- {
147
- "type": "null"
148
- }
154
+ "type": [
155
+ "number",
156
+ "null"
149
157
  ]
150
158
  }
151
159
  },
@@ -186,16 +194,18 @@
186
194
  "type": "integer",
187
195
  "minimum": 0,
188
196
  "maximum": 9007199254740991
189
- }
197
+ },
198
+ "required": [
199
+ "passed",
200
+ "failed",
201
+ "running",
202
+ "not-run"
203
+ ]
190
204
  },
191
205
  "avgMs": {
192
- "anyOf": [
193
- {
194
- "type": "number"
195
- },
196
- {
197
- "type": "null"
198
- }
206
+ "type": [
207
+ "number",
208
+ "null"
199
209
  ]
200
210
  }
201
211
  },
@@ -236,16 +246,18 @@
236
246
  "type": "integer",
237
247
  "minimum": 0,
238
248
  "maximum": 9007199254740991
239
- }
249
+ },
250
+ "required": [
251
+ "passed",
252
+ "failed",
253
+ "running",
254
+ "not-run"
255
+ ]
240
256
  },
241
257
  "avgMs": {
242
- "anyOf": [
243
- {
244
- "type": "number"
245
- },
246
- {
247
- "type": "null"
248
- }
258
+ "type": [
259
+ "number",
260
+ "null"
249
261
  ]
250
262
  }
251
263
  },
@@ -270,13 +282,9 @@
270
282
  "type": "string"
271
283
  },
272
284
  "specPath": {
273
- "anyOf": [
274
- {
275
- "type": "string"
276
- },
277
- {
278
- "type": "null"
279
- }
285
+ "type": [
286
+ "string",
287
+ "null"
280
288
  ]
281
289
  },
282
290
  "status": {
@@ -314,13 +322,9 @@
314
322
  "type": "string"
315
323
  },
316
324
  "specPath": {
317
- "anyOf": [
318
- {
319
- "type": "string"
320
- },
321
- {
322
- "type": "null"
323
- }
325
+ "type": [
326
+ "string",
327
+ "null"
324
328
  ]
325
329
  },
326
330
  "status": {
@@ -358,13 +362,9 @@
358
362
  "type": "string"
359
363
  },
360
364
  "specPath": {
361
- "anyOf": [
362
- {
363
- "type": "string"
364
- },
365
- {
366
- "type": "null"
367
- }
365
+ "type": [
366
+ "string",
367
+ "null"
368
368
  ]
369
369
  },
370
370
  "status": {
@@ -396,13 +396,9 @@
396
396
  "maximum": 9007199254740991
397
397
  },
398
398
  "lastRecordedAtMs": {
399
- "anyOf": [
400
- {
401
- "type": "number"
402
- },
403
- {
404
- "type": "null"
405
- }
399
+ "type": [
400
+ "number",
401
+ "null"
406
402
  ]
407
403
  },
408
404
  "history": {
@@ -553,7 +549,13 @@
553
549
  "type": "integer",
554
550
  "minimum": 0,
555
551
  "maximum": 9007199254740991
556
- }
552
+ },
553
+ "required": [
554
+ "passed",
555
+ "failed",
556
+ "running",
557
+ "not-run"
558
+ ]
557
559
  }
558
560
  },
559
561
  "required": [
@@ -650,10 +652,10 @@
650
652
  "additionalProperties": {}
651
653
  },
652
654
  "total": {
653
- "description": "Tests the query matched, before offset and limit",
654
655
  "type": "integer",
655
656
  "minimum": 0,
656
- "maximum": 9007199254740991
657
+ "maximum": 9007199254740991,
658
+ "description": "Tests the query matched, before offset and limit"
657
659
  },
658
660
  "offset": {
659
661
  "type": "integer",
@@ -671,8 +673,8 @@
671
673
  "type": "object",
672
674
  "properties": {
673
675
  "key": {
674
- "description": "The test's identity, `JSON.stringify([specPath, id])`. Pass it to `/api/reports/tests/history?key=`",
675
- "type": "string"
676
+ "type": "string",
677
+ "description": "The test's identity, `JSON.stringify([specPath, id])`. Pass it to `/api/reports/tests/history?key=`"
676
678
  },
677
679
  "id": {
678
680
  "type": "string"
@@ -681,17 +683,12 @@
681
683
  "type": "string"
682
684
  },
683
685
  "specPath": {
684
- "anyOf": [
685
- {
686
- "type": "string"
687
- },
688
- {
689
- "type": "null"
690
- }
686
+ "type": [
687
+ "string",
688
+ "null"
691
689
  ]
692
690
  },
693
691
  "spec": {
694
- "description": "The spec it belongs to: recorded by its layers, published in a spec set, or derived from the path",
695
692
  "anyOf": [
696
693
  {
697
694
  "type": "object",
@@ -720,17 +717,18 @@
720
717
  {
721
718
  "type": "null"
722
719
  }
723
- ]
720
+ ],
721
+ "description": "The spec it belongs to: recorded by its layers, published in a spec set, or derived from the path"
724
722
  },
725
723
  "status": {
726
- "description": "The worst current result across environments: failed, then running, then not-run, then passed",
727
724
  "type": "string",
728
725
  "enum": [
729
726
  "passed",
730
727
  "failed",
731
728
  "running",
732
729
  "not-run"
733
- ]
730
+ ],
731
+ "description": "The worst current result across environments: failed, then running, then not-run, then passed"
734
732
  },
735
733
  "environments": {
736
734
  "type": "array",
@@ -745,14 +743,13 @@
745
743
  }
746
744
  },
747
745
  "outcomes": {
748
- "description": "The current result per producer, environment and parameter set, newest first",
749
746
  "type": "array",
750
747
  "items": {
751
748
  "type": "object",
752
749
  "properties": {
753
750
  "at": {
754
- "description": "When it was recorded, epoch milliseconds",
755
- "type": "number"
751
+ "type": "number",
752
+ "description": "When it was recorded, epoch milliseconds"
756
753
  },
757
754
  "status": {
758
755
  "type": "string",
@@ -765,24 +762,16 @@
765
762
  },
766
763
  "durationMs": {
767
764
  "description": "How long it took, or null when the producer did not measure it",
768
- "anyOf": [
769
- {
770
- "type": "number"
771
- },
772
- {
773
- "type": "null"
774
- }
765
+ "type": [
766
+ "number",
767
+ "null"
775
768
  ]
776
769
  },
777
770
  "environment": {
778
771
  "description": "The client it checked, such as `desktop-web` or `ios`",
779
- "anyOf": [
780
- {
781
- "type": "string"
782
- },
783
- {
784
- "type": "null"
785
- }
772
+ "type": [
773
+ "string",
774
+ "null"
786
775
  ]
787
776
  },
788
777
  "producer": {
@@ -801,49 +790,37 @@
801
790
  }
802
791
  },
803
792
  "branch": {
804
- "anyOf": [
805
- {
806
- "type": "string"
807
- },
808
- {
809
- "type": "null"
810
- }
793
+ "type": [
794
+ "string",
795
+ "null"
811
796
  ]
812
797
  },
813
798
  "sha": {
814
- "anyOf": [
815
- {
816
- "type": "string"
817
- },
818
- {
819
- "type": "null"
820
- }
799
+ "type": [
800
+ "string",
801
+ "null"
821
802
  ]
822
803
  },
823
804
  "runUrl": {
824
- "anyOf": [
825
- {
826
- "type": "string"
827
- },
828
- {
829
- "type": "null"
830
- }
805
+ "type": [
806
+ "string",
807
+ "null"
831
808
  ]
832
809
  },
833
810
  "run": {
834
- "description": "The key of the run it belongs to, as `GET /api/reports/runs` lists it",
835
- "type": "string"
811
+ "type": "string",
812
+ "description": "The key of the run it belongs to, as `GET /api/reports/runs` lists it"
836
813
  },
837
814
  "layer": {
838
- "description": "The id of the layer that recorded it",
839
- "type": "string"
815
+ "type": "string",
816
+ "description": "The id of the layer that recorded it"
840
817
  },
841
818
  "backend": {
842
819
  "type": "string"
843
820
  },
844
821
  "detail": {
845
- "description": "Why it has its status, at most 500 characters",
846
- "type": "string"
822
+ "type": "string",
823
+ "description": "Why it has its status, at most 500 characters"
847
824
  },
848
825
  "evidence": {
849
826
  "type": "object",
@@ -925,7 +902,8 @@
925
902
  "detail"
926
903
  ],
927
904
  "additionalProperties": {}
928
- }
905
+ },
906
+ "description": "The current result per producer, environment and parameter set, newest first"
929
907
  },
930
908
  "stats": {
931
909
  "type": "object",
@@ -947,13 +925,9 @@
947
925
  },
948
926
  "passRate": {
949
927
  "description": "passed / (passed + failed), or null with no completed result",
950
- "anyOf": [
951
- {
952
- "type": "number"
953
- },
954
- {
955
- "type": "null"
956
- }
928
+ "type": [
929
+ "number",
930
+ "null"
957
931
  ]
958
932
  },
959
933
  "flaky": {
@@ -1017,43 +991,27 @@
1017
991
  ]
1018
992
  },
1019
993
  "firstSeenMs": {
1020
- "anyOf": [
1021
- {
1022
- "type": "number"
1023
- },
1024
- {
1025
- "type": "null"
1026
- }
994
+ "type": [
995
+ "number",
996
+ "null"
1027
997
  ]
1028
998
  },
1029
999
  "lastSeenMs": {
1030
- "anyOf": [
1031
- {
1032
- "type": "number"
1033
- },
1034
- {
1035
- "type": "null"
1036
- }
1000
+ "type": [
1001
+ "number",
1002
+ "null"
1037
1003
  ]
1038
1004
  },
1039
1005
  "lastPassedAtMs": {
1040
- "anyOf": [
1041
- {
1042
- "type": "number"
1043
- },
1044
- {
1045
- "type": "null"
1046
- }
1006
+ "type": [
1007
+ "number",
1008
+ "null"
1047
1009
  ]
1048
1010
  },
1049
1011
  "lastFailedAtMs": {
1050
- "anyOf": [
1051
- {
1052
- "type": "number"
1053
- },
1054
- {
1055
- "type": "null"
1056
- }
1012
+ "type": [
1013
+ "number",
1014
+ "null"
1057
1015
  ]
1058
1016
  },
1059
1017
  "runs": {