@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/publish-result.schema.json CHANGED
@@ -8,27 +8,23 @@
8
8
  "const": true
9
9
  },
10
10
  "store": {
11
- "description": "Where it was written: a folder, `s3://…` or a server URL",
12
- "type": "string"
11
+ "type": "string",
12
+ "description": "Where it was written: a folder, `s3://…` or a server URL"
13
13
  },
14
14
  "layer": {
15
15
  "type": "object",
16
16
  "properties": {
17
17
  "id": {
18
- "description": "The layer id: 64 hex digits, the SHA-256 of its content. Publishing the same input again gives the same id",
19
- "type": "string"
18
+ "type": "string",
19
+ "description": "The layer id: 64 hex digits, the SHA-256 of its content. Publishing the same input again gives the same id"
20
20
  },
21
21
  "producer": {
22
22
  "type": "string"
23
23
  },
24
24
  "environment": {
25
- "anyOf": [
26
- {
27
- "type": "string"
28
- },
29
- {
30
- "type": "null"
31
- }
25
+ "type": [
26
+ "string",
27
+ "null"
32
28
  ]
33
29
  },
34
30
  "checks": {
@@ -47,16 +43,16 @@
47
43
  "maximum": 9007199254740991
48
44
  },
49
45
  "notRun": {
50
- "description": "Skipped, pending or otherwise not run",
51
46
  "type": "integer",
52
47
  "minimum": 0,
53
- "maximum": 9007199254740991
48
+ "maximum": 9007199254740991,
49
+ "description": "Skipped, pending or otherwise not run"
54
50
  },
55
51
  "linkedToSpec": {
56
- "description": "Checks that were matched to a spec file. The rest still count, but belong to no spec",
57
52
  "type": "integer",
58
53
  "minimum": 0,
59
- "maximum": 9007199254740991
54
+ "maximum": 9007199254740991,
55
+ "description": "Checks that were matched to a spec file. The rest still count, but belong to no spec"
60
56
  },
61
57
  "freshness": {
62
58
  "description": "Set when the checkout had uncommitted changes (`modified`) or no git origin (`unknown`)",
@@ -104,13 +100,9 @@
104
100
  "maximum": 9007199254740991
105
101
  },
106
102
  "branch": {
107
- "anyOf": [
108
- {
109
- "type": "string"
110
- },
111
- {
112
- "type": "null"
113
- }
103
+ "type": [
104
+ "string",
105
+ "null"
114
106
  ]
115
107
  }
116
108
  },
@@ -151,11 +143,11 @@
151
143
  "additionalProperties": {}
152
144
  },
153
145
  "warnings": {
154
- "description": "What was skipped and why, such as an attachment file that could not be read. Never fatal",
155
146
  "type": "array",
156
147
  "items": {
157
148
  "type": "string"
158
- }
149
+ },
150
+ "description": "What was skipped and why, such as an attachment file that could not be read. Never fatal"
159
151
  }
160
152
  },
161
153
  "required": [
package/packages/schema/schemas/ready.schema.json CHANGED
@@ -4,36 +4,36 @@
4
4
  "type": "object",
5
5
  "properties": {
6
6
  "ready": {
7
- "description": "True once the first pass over the backends is done and at least one backend answers",
8
- "type": "boolean"
7
+ "type": "boolean",
8
+ "description": "True once the first pass over the backends is done and at least one backend answers"
9
9
  },
10
10
  "layers": {
11
- "description": "Distinct layers read",
12
11
  "type": "integer",
13
12
  "minimum": 0,
14
- "maximum": 9007199254740991
13
+ "maximum": 9007199254740991,
14
+ "description": "Distinct layers read"
15
15
  },
16
16
  "slots": {
17
- "description": "Distinct checks (slots) the report holds a winner for",
18
17
  "type": "integer",
19
18
  "minimum": 0,
20
- "maximum": 9007199254740991
19
+ "maximum": 9007199254740991,
20
+ "description": "Distinct checks (slots) the report holds a winner for"
21
21
  },
22
22
  "holding": {
23
- "description": "Layers that still hold at least one winner",
24
23
  "type": "integer",
25
24
  "minimum": 0,
26
- "maximum": 9007199254740991
25
+ "maximum": 9007199254740991,
26
+ "description": "Layers that still hold at least one winner"
27
27
  },
28
28
  "failed": {
29
- "description": "Layers or backends that could not be read right now",
30
29
  "type": "integer",
31
30
  "minimum": 0,
32
- "maximum": 9007199254740991
31
+ "maximum": 9007199254740991,
32
+ "description": "Layers or backends that could not be read right now"
33
33
  },
34
34
  "refreshedAt": {
35
- "description": "When a pass over the backends last finished, epoch milliseconds; 0 before the first",
36
- "type": "number"
35
+ "type": "number",
36
+ "description": "When a pass over the backends last finished, epoch milliseconds; 0 before the first"
37
37
  },
38
38
  "backends": {
39
39
  "type": "array",
package/packages/schema/schemas/report-event.schema.json CHANGED
@@ -4,8 +4,8 @@
4
4
  "type": "object",
5
5
  "properties": {
6
6
  "version": {
7
- "description": "The report version after these layers",
8
- "type": "string"
7
+ "type": "string",
8
+ "description": "The report version after these layers"
9
9
  },
10
10
  "totalLayers": {
11
11
  "type": "integer",
@@ -13,7 +13,6 @@
13
13
  "maximum": 9007199254740991
14
14
  },
15
15
  "added": {
16
- "description": "At most the 20 newest of the layers that arrived",
17
16
  "type": "array",
18
17
  "items": {
19
18
  "type": "object",
@@ -25,33 +24,21 @@
25
24
  "type": "string"
26
25
  },
27
26
  "environment": {
28
- "anyOf": [
29
- {
30
- "type": "string"
31
- },
32
- {
33
- "type": "null"
34
- }
27
+ "type": [
28
+ "string",
29
+ "null"
35
30
  ]
36
31
  },
37
32
  "branch": {
38
- "anyOf": [
39
- {
40
- "type": "string"
41
- },
42
- {
43
- "type": "null"
44
- }
33
+ "type": [
34
+ "string",
35
+ "null"
45
36
  ]
46
37
  },
47
38
  "sha": {
48
- "anyOf": [
49
- {
50
- "type": "string"
51
- },
52
- {
53
- "type": "null"
54
- }
39
+ "type": [
40
+ "string",
41
+ "null"
55
42
  ]
56
43
  },
57
44
  "recordedAtMs": {
@@ -72,7 +59,13 @@
72
59
  "type": "integer",
73
60
  "minimum": 0,
74
61
  "maximum": 9007199254740991
75
- }
62
+ },
63
+ "required": [
64
+ "passed",
65
+ "failed",
66
+ "running",
67
+ "not-run"
68
+ ]
76
69
  }
77
70
  },
78
71
  "required": [
@@ -81,13 +74,14 @@
81
74
  "recordedAtMs"
82
75
  ],
83
76
  "additionalProperties": {}
84
- }
77
+ },
78
+ "description": "At most the 20 newest of the layers that arrived"
85
79
  },
86
80
  "addedTotal": {
87
- "description": "How many layers arrived, including those not listed",
88
81
  "type": "integer",
89
82
  "minimum": 0,
90
- "maximum": 9007199254740991
83
+ "maximum": 9007199254740991,
84
+ "description": "How many layers arrived, including those not listed"
91
85
  }
92
86
  },
93
87
  "required": [
package/packages/schema/schemas/report-run.schema.json CHANGED
@@ -14,37 +14,25 @@
14
14
  "type": "object",
15
15
  "properties": {
16
16
  "key": {
17
- "description": "The run URL, or `branch@sha`. Pass it to `/api/reports/runs/detail?key=` or `/api/reports/tests?run=`",
18
- "type": "string"
17
+ "type": "string",
18
+ "description": "The run URL, or `branch@sha`. Pass it to `/api/reports/runs/detail?key=` or `/api/reports/tests?run=`"
19
19
  },
20
20
  "runUrl": {
21
- "anyOf": [
22
- {
23
- "type": "string"
24
- },
25
- {
26
- "type": "null"
27
- }
21
+ "type": [
22
+ "string",
23
+ "null"
28
24
  ]
29
25
  },
30
26
  "branch": {
31
- "anyOf": [
32
- {
33
- "type": "string"
34
- },
35
- {
36
- "type": "null"
37
- }
27
+ "type": [
28
+ "string",
29
+ "null"
38
30
  ]
39
31
  },
40
32
  "sha": {
41
- "anyOf": [
42
- {
43
- "type": "string"
44
- },
45
- {
46
- "type": "null"
47
- }
33
+ "type": [
34
+ "string",
35
+ "null"
48
36
  ]
49
37
  },
50
38
  "startedAtMs": {
@@ -93,16 +81,18 @@
93
81
  "type": "integer",
94
82
  "minimum": 0,
95
83
  "maximum": 9007199254740991
96
- }
84
+ },
85
+ "required": [
86
+ "passed",
87
+ "failed",
88
+ "running",
89
+ "not-run"
90
+ ]
97
91
  },
98
92
  "totalDurationMs": {
99
- "anyOf": [
100
- {
101
- "type": "number"
102
- },
103
- {
104
- "type": "null"
105
- }
93
+ "type": [
94
+ "number",
95
+ "null"
106
96
  ]
107
97
  },
108
98
  "failing": {
@@ -117,13 +107,9 @@
117
107
  "type": "string"
118
108
  },
119
109
  "environment": {
120
- "anyOf": [
121
- {
122
- "type": "string"
123
- },
124
- {
125
- "type": "null"
126
- }
110
+ "type": [
111
+ "string",
112
+ "null"
127
113
  ]
128
114
  },
129
115
  "detail": {
@@ -173,23 +159,15 @@
173
159
  "type": "string"
174
160
  },
175
161
  "specPath": {
176
- "anyOf": [
177
- {
178
- "type": "string"
179
- },
180
- {
181
- "type": "null"
182
- }
162
+ "type": [
163
+ "string",
164
+ "null"
183
165
  ]
184
166
  },
185
167
  "environment": {
186
- "anyOf": [
187
- {
188
- "type": "string"
189
- },
190
- {
191
- "type": "null"
192
- }
168
+ "type": [
169
+ "string",
170
+ "null"
193
171
  ]
194
172
  },
195
173
  "producer": {
@@ -205,13 +183,9 @@
205
183
  ]
206
184
  },
207
185
  "durationMs": {
208
- "anyOf": [
209
- {
210
- "type": "number"
211
- },
212
- {
213
- "type": "null"
214
- }
186
+ "type": [
187
+ "number",
188
+ "null"
215
189
  ]
216
190
  },
217
191
  "at": {
package/packages/schema/schemas/report-runs.schema.json CHANGED
@@ -21,37 +21,25 @@
21
21
  "type": "object",
22
22
  "properties": {
23
23
  "key": {
24
- "description": "The run URL, or `branch@sha`. Pass it to `/api/reports/runs/detail?key=` or `/api/reports/tests?run=`",
25
- "type": "string"
24
+ "type": "string",
25
+ "description": "The run URL, or `branch@sha`. Pass it to `/api/reports/runs/detail?key=` or `/api/reports/tests?run=`"
26
26
  },
27
27
  "runUrl": {
28
- "anyOf": [
29
- {
30
- "type": "string"
31
- },
32
- {
33
- "type": "null"
34
- }
28
+ "type": [
29
+ "string",
30
+ "null"
35
31
  ]
36
32
  },
37
33
  "branch": {
38
- "anyOf": [
39
- {
40
- "type": "string"
41
- },
42
- {
43
- "type": "null"
44
- }
34
+ "type": [
35
+ "string",
36
+ "null"
45
37
  ]
46
38
  },
47
39
  "sha": {
48
- "anyOf": [
49
- {
50
- "type": "string"
51
- },
52
- {
53
- "type": "null"
54
- }
40
+ "type": [
41
+ "string",
42
+ "null"
55
43
  ]
56
44
  },
57
45
  "startedAtMs": {
@@ -100,16 +88,18 @@
100
88
  "type": "integer",
101
89
  "minimum": 0,
102
90
  "maximum": 9007199254740991
103
- }
91
+ },
92
+ "required": [
93
+ "passed",
94
+ "failed",
95
+ "running",
96
+ "not-run"
97
+ ]
104
98
  },
105
99
  "totalDurationMs": {
106
- "anyOf": [
107
- {
108
- "type": "number"
109
- },
110
- {
111
- "type": "null"
112
- }
100
+ "type": [
101
+ "number",
102
+ "null"
113
103
  ]
114
104
  },
115
105
  "failing": {
@@ -124,13 +114,9 @@
124
114
  "type": "string"
125
115
  },
126
116
  "environment": {
127
- "anyOf": [
128
- {
129
- "type": "string"
130
- },
131
- {
132
- "type": "null"
133
- }
117
+ "type": [
118
+ "string",
119
+ "null"
134
120
  ]
135
121
  },
136
122
  "detail": {
package/packages/schema/schemas/report-status.schema.json CHANGED
@@ -11,11 +11,11 @@
11
11
  "type": "boolean"
12
12
  },
13
13
  "reasons": {
14
- "description": "Why `ok` is false, in words. Empty when it is true",
15
14
  "type": "array",
16
15
  "items": {
17
16
  "type": "string"
18
- }
17
+ },
18
+ "description": "Why `ok` is false, in words. Empty when it is true"
19
19
  },
20
20
  "checks": {
21
21
  "type": "object",
@@ -98,10 +98,10 @@
98
98
  }
99
99
  },
100
100
  "layers": {
101
- "description": "Distinct layers read, across all backends",
102
101
  "type": "integer",
103
102
  "minimum": 0,
104
- "maximum": 9007199254740991
103
+ "maximum": 9007199254740991,
104
+ "description": "Distinct layers read, across all backends"
105
105
  },
106
106
  "backends": {
107
107
  "type": "array",
@@ -126,34 +126,29 @@
126
126
  }
127
127
  },
128
128
  "notices": {
129
- "description": "What could not be read. Any notice fails the gate: unknown is not passed",
130
129
  "type": "array",
131
130
  "items": {
132
131
  "type": "string"
133
- }
132
+ },
133
+ "description": "What could not be read. Any notice fails the gate: unknown is not passed"
134
134
  },
135
135
  "specsWithoutEvidence": {
136
- "description": "Specs of the outline with no result at all. The outline is `--specs <dir>`, or else the specs the layers recorded",
137
136
  "type": "array",
138
137
  "items": {
139
138
  "type": "string"
140
- }
139
+ },
140
+ "description": "Specs of the outline with no result at all. The outline is `--specs <dir>`, or else the specs the layers recorded"
141
141
  },
142
142
  "specs": {
143
- "description": "The outcome of each spec, so a dashboard needs nothing else",
144
143
  "type": "array",
145
144
  "items": {
146
145
  "type": "object",
147
146
  "properties": {
148
147
  "path": {
149
148
  "description": "Null for checks that name no spec in the outline",
150
- "anyOf": [
151
- {
152
- "type": "string"
153
- },
154
- {
155
- "type": "null"
156
- }
149
+ "type": [
150
+ "string",
151
+ "null"
157
152
  ]
158
153
  },
159
154
  "title": {
@@ -251,22 +246,18 @@
251
246
  "byEnvironment"
252
247
  ],
253
248
  "additionalProperties": {}
254
- }
249
+ },
250
+ "description": "The outcome of each spec, so a dashboard needs nothing else"
255
251
  },
256
252
  "failing": {
257
- "description": "Each slot whose newest completed result failed, or that is still running",
258
253
  "type": "array",
259
254
  "items": {
260
255
  "type": "object",
261
256
  "properties": {
262
257
  "spec": {
263
- "anyOf": [
264
- {
265
- "type": "string"
266
- },
267
- {
268
- "type": "null"
269
- }
258
+ "type": [
259
+ "string",
260
+ "null"
270
261
  ]
271
262
  },
272
263
  "check": {
@@ -283,36 +274,24 @@
283
274
  ]
284
275
  },
285
276
  "environment": {
286
- "anyOf": [
287
- {
288
- "type": "string"
289
- },
290
- {
291
- "type": "null"
292
- }
277
+ "type": [
278
+ "string",
279
+ "null"
293
280
  ]
294
281
  },
295
282
  "producer": {
296
283
  "type": "string"
297
284
  },
298
285
  "branch": {
299
- "anyOf": [
300
- {
301
- "type": "string"
302
- },
303
- {
304
- "type": "null"
305
- }
286
+ "type": [
287
+ "string",
288
+ "null"
306
289
  ]
307
290
  },
308
291
  "sha": {
309
- "anyOf": [
310
- {
311
- "type": "string"
312
- },
313
- {
314
- "type": "null"
315
- }
292
+ "type": [
293
+ "string",
294
+ "null"
316
295
  ]
317
296
  },
318
297
  "layer": {
@@ -322,13 +301,9 @@
322
301
  "type": "string"
323
302
  },
324
303
  "runUrl": {
325
- "anyOf": [
326
- {
327
- "type": "string"
328
- },
329
- {
330
- "type": "null"
331
- }
304
+ "type": [
305
+ "string",
306
+ "null"
332
307
  ]
333
308
  },
334
309
  "detail": {
@@ -350,7 +325,8 @@
350
325
  "detail"
351
326
  ],
352
327
  "additionalProperties": {}
353
- }
328
+ },
329
+ "description": "Each slot whose newest completed result failed, or that is still running"
354
330
  }
355
331
  },
356
332
  "required": [
package/packages/schema/schemas/run-info.schema.json CHANGED
@@ -15,23 +15,15 @@
15
15
  "minimum": 0
16
16
  },
17
17
  "commit": {
18
- "anyOf": [
19
- {
20
- "type": "string"
21
- },
22
- {
23
- "type": "null"
24
- }
18
+ "type": [
19
+ "string",
20
+ "null"
25
21
  ]
26
22
  },
27
23
  "branch": {
28
- "anyOf": [
29
- {
30
- "type": "string"
31
- },
32
- {
33
- "type": "null"
34
- }
24
+ "type": [
25
+ "string",
26
+ "null"
35
27
  ]
36
28
  },
37
29
  "environment": {
@@ -75,13 +67,9 @@
75
67
  },
76
68
  "finishedAt": {
77
69
  "description": "Null while the run is still going; absent in older reports",
78
- "anyOf": [
79
- {
80
- "type": "string"
81
- },
82
- {
83
- "type": "null"
84
- }
70
+ "type": [
71
+ "string",
72
+ "null"
85
73
  ]
86
74
  },
87
75
  "progress": {