@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/effective-delta.schema.json CHANGED
@@ -4,11 +4,10 @@
4
4
  "type": "object",
5
5
  "properties": {
6
6
  "version": {
7
- "description": "Changes exactly when the report does",
8
- "type": "string"
7
+ "type": "string",
8
+ "description": "Changes exactly when the report does"
9
9
  },
10
10
  "layers": {
11
- "description": "Layers that are new or changed since `base`, whole",
12
11
  "type": "array",
13
12
  "items": {
14
13
  "type": "object",
@@ -22,12 +21,12 @@
22
21
  "type": "object",
23
22
  "properties": {
24
23
  "kind": {
25
- "description": "The kind of the part holding the check. Part of the slot",
26
- "type": "string"
24
+ "type": "string",
25
+ "description": "The kind of the part holding the check. Part of the slot"
27
26
  },
28
27
  "id": {
29
- "description": "The check id. Part of the slot",
30
- "type": "string"
28
+ "type": "string",
29
+ "description": "The check id. Part of the slot"
31
30
  },
32
31
  "title": {
33
32
  "type": "string"
@@ -43,18 +42,14 @@
43
42
  },
44
43
  "specPath": {
45
44
  "description": "The spec the check belongs to, `specs/<path>`, or null",
46
- "anyOf": [
47
- {
48
- "type": "string"
49
- },
50
- {
51
- "type": "null"
52
- }
45
+ "type": [
46
+ "string",
47
+ "null"
53
48
  ]
54
49
  },
55
50
  "detail": {
56
- "description": "Why it has this status; empty when there is nothing to add",
57
- "type": "string"
51
+ "type": "string",
52
+ "description": "Why it has this status; empty when there is nothing to add"
58
53
  },
59
54
  "measurements": {
60
55
  "type": "array",
@@ -83,13 +78,9 @@
83
78
  }
84
79
  },
85
80
  "testId": {
86
- "anyOf": [
87
- {
88
- "type": "string"
89
- },
90
- {
91
- "type": "null"
92
- }
81
+ "type": [
82
+ "string",
83
+ "null"
93
84
  ]
94
85
  },
95
86
  "variant": {
@@ -102,13 +93,9 @@
102
93
  }
103
94
  },
104
95
  "durationMs": {
105
- "anyOf": [
106
- {
107
- "type": "number"
108
- },
109
- {
110
- "type": "null"
111
- }
96
+ "type": [
97
+ "number",
98
+ "null"
112
99
  ]
113
100
  },
114
101
  "evidence": {
@@ -190,96 +177,76 @@
190
177
  }
191
178
  },
192
179
  "fingerprints": {
193
- "description": "Spec path to the fingerprint the layer recorded for it",
194
180
  "type": "object",
195
181
  "propertyNames": {
196
182
  "type": "string"
197
183
  },
198
184
  "additionalProperties": {
199
185
  "type": "string"
200
- }
186
+ },
187
+ "description": "Spec path to the fingerprint the layer recorded for it"
201
188
  },
202
189
  "layer": {
203
190
  "type": "object",
204
191
  "properties": {
205
192
  "id": {
206
- "description": "The layer id: 64 lowercase hex digits, the SHA-256 of its content",
207
- "type": "string"
193
+ "type": "string",
194
+ "description": "The layer id: 64 lowercase hex digits, the SHA-256 of its content"
208
195
  },
209
196
  "backend": {
210
- "description": "The backend it was read from; the one that sorts first when several hold it",
211
- "type": "string"
197
+ "type": "string",
198
+ "description": "The backend it was read from; the one that sorts first when several hold it"
212
199
  },
213
200
  "producer": {
214
- "description": "The suite or tool that made it. Part of the slot",
215
- "type": "string"
201
+ "type": "string",
202
+ "description": "The suite or tool that made it. Part of the slot"
216
203
  },
217
204
  "packageDir": {
218
- "anyOf": [
219
- {
220
- "type": "string"
221
- },
222
- {
223
- "type": "null"
224
- }
205
+ "type": [
206
+ "string",
207
+ "null"
225
208
  ]
226
209
  },
227
210
  "recordedAtMs": {
228
- "description": "When the checks ran, epoch milliseconds. The newest completed result wins its slot",
229
- "type": "number"
211
+ "type": "number",
212
+ "description": "When the checks ran, epoch milliseconds. The newest completed result wins its slot"
230
213
  },
231
214
  "sha": {
232
215
  "description": "The commit it was recorded at. Provenance only",
233
- "anyOf": [
234
- {
235
- "type": "string"
236
- },
237
- {
238
- "type": "null"
239
- }
216
+ "type": [
217
+ "string",
218
+ "null"
240
219
  ]
241
220
  },
242
221
  "branch": {
243
222
  "description": "The branch it was recorded on. Provenance only",
244
- "anyOf": [
245
- {
246
- "type": "string"
247
- },
248
- {
249
- "type": "null"
250
- }
223
+ "type": [
224
+ "string",
225
+ "null"
251
226
  ]
252
227
  },
253
228
  "environment": {
254
229
  "description": "The client it checked, such as `ios`. Part of the slot",
255
- "anyOf": [
256
- {
257
- "type": "string"
258
- },
259
- {
260
- "type": "null"
261
- }
230
+ "type": [
231
+ "string",
232
+ "null"
262
233
  ]
263
234
  },
264
235
  "runUrl": {
265
- "anyOf": [
266
- {
267
- "type": "string"
268
- },
269
- {
270
- "type": "null"
271
- }
236
+ "type": [
237
+ "string",
238
+ "null"
272
239
  ]
273
240
  },
274
241
  "parameters": {
275
- "description": "Other choices that make a result its own slot",
276
242
  "type": "object",
277
243
  "propertyNames": {
278
244
  "type": "string"
279
245
  },
280
246
  "additionalProperties": {
281
247
  "type": "string"
282
- }
248
+ },
249
+ "description": "Other choices that make a result its own slot"
283
250
  },
284
251
  "freshness": {
285
252
  "description": "`modified`: recorded from a checkout with uncommitted changes. `unknown`: origin not captured. Absent: clean",
@@ -290,13 +257,13 @@
290
257
  ]
291
258
  },
292
259
  "recording": {
293
- "description": "Where recorded timelines are read from, or null",
294
260
  "anyOf": [
295
261
  {},
296
262
  {
297
263
  "type": "null"
298
264
  }
299
- ]
265
+ ],
266
+ "description": "Where recorded timelines are read from, or null"
300
267
  },
301
268
  "live": {
302
269
  "type": "boolean"
@@ -316,7 +283,13 @@
316
283
  "type": "integer",
317
284
  "minimum": 0,
318
285
  "maximum": 9007199254740991
319
- }
286
+ },
287
+ "required": [
288
+ "passed",
289
+ "failed",
290
+ "running",
291
+ "not-run"
292
+ ]
320
293
  },
321
294
  "execution": {
322
295
  "type": "string"
@@ -410,7 +383,8 @@
410
383
  "layer"
411
384
  ],
412
385
  "additionalProperties": {}
413
- }
386
+ },
387
+ "description": "Layers that are new or changed since `base`, whole"
414
388
  },
415
389
  "backends": {
416
390
  "type": "array",
@@ -424,12 +398,12 @@
424
398
  "type": "string"
425
399
  },
426
400
  "live": {
427
- "description": "Always false on a server",
428
- "type": "boolean"
401
+ "type": "boolean",
402
+ "description": "Always false on a server"
429
403
  },
430
404
  "available": {
431
- "description": "False when the backend could not be read; its results are then unknown, never passed",
432
- "type": "boolean"
405
+ "type": "boolean",
406
+ "description": "False when the backend could not be read; its results are then unknown, never passed"
433
407
  }
434
408
  },
435
409
  "required": [
@@ -442,37 +416,37 @@
442
416
  }
443
417
  },
444
418
  "notices": {
445
- "description": "What could not be read. A gate treats any notice as unknown, never as passed",
446
419
  "type": "array",
447
420
  "items": {
448
421
  "type": "string"
449
- }
422
+ },
423
+ "description": "What could not be read. A gate treats any notice as unknown, never as passed"
450
424
  },
451
425
  "totalLayers": {
452
- "description": "Every layer read, whether or not it still wins anything",
453
426
  "type": "integer",
454
427
  "minimum": 0,
455
- "maximum": 9007199254740991
428
+ "maximum": 9007199254740991,
429
+ "description": "Every layer read, whether or not it still wins anything"
456
430
  },
457
431
  "active": {
458
- "description": "Always empty on a server; kept for viewers written for live spec runs",
459
432
  "type": "array",
460
- "items": {}
433
+ "items": {},
434
+ "description": "Always empty on a server; kept for viewers written for live spec runs"
461
435
  },
462
436
  "delta": {
463
437
  "type": "boolean",
464
438
  "const": true
465
439
  },
466
440
  "base": {
467
- "description": "The version this applies to",
468
- "type": "string"
441
+ "type": "string",
442
+ "description": "The version this applies to"
469
443
  },
470
444
  "removed": {
471
- "description": "Ids of layers that no longer hold a winner",
472
445
  "type": "array",
473
446
  "items": {
474
447
  "type": "string"
475
- }
448
+ },
449
+ "description": "Ids of layers that no longer hold a winner"
476
450
  }
477
451
  },
478
452
  "required": [
package/packages/schema/schemas/effective-evidence.schema.json CHANGED
@@ -4,8 +4,8 @@
4
4
  "type": "object",
5
5
  "properties": {
6
6
  "version": {
7
- "description": "Changes exactly when the report does",
8
- "type": "string"
7
+ "type": "string",
8
+ "description": "Changes exactly when the report does"
9
9
  },
10
10
  "layers": {
11
11
  "type": "array",
@@ -21,12 +21,12 @@
21
21
  "type": "object",
22
22
  "properties": {
23
23
  "kind": {
24
- "description": "The kind of the part holding the check. Part of the slot",
25
- "type": "string"
24
+ "type": "string",
25
+ "description": "The kind of the part holding the check. Part of the slot"
26
26
  },
27
27
  "id": {
28
- "description": "The check id. Part of the slot",
29
- "type": "string"
28
+ "type": "string",
29
+ "description": "The check id. Part of the slot"
30
30
  },
31
31
  "title": {
32
32
  "type": "string"
@@ -42,18 +42,14 @@
42
42
  },
43
43
  "specPath": {
44
44
  "description": "The spec the check belongs to, `specs/<path>`, or null",
45
- "anyOf": [
46
- {
47
- "type": "string"
48
- },
49
- {
50
- "type": "null"
51
- }
45
+ "type": [
46
+ "string",
47
+ "null"
52
48
  ]
53
49
  },
54
50
  "detail": {
55
- "description": "Why it has this status; empty when there is nothing to add",
56
- "type": "string"
51
+ "type": "string",
52
+ "description": "Why it has this status; empty when there is nothing to add"
57
53
  },
58
54
  "measurements": {
59
55
  "type": "array",
@@ -82,13 +78,9 @@
82
78
  }
83
79
  },
84
80
  "testId": {
85
- "anyOf": [
86
- {
87
- "type": "string"
88
- },
89
- {
90
- "type": "null"
91
- }
81
+ "type": [
82
+ "string",
83
+ "null"
92
84
  ]
93
85
  },
94
86
  "variant": {
@@ -101,13 +93,9 @@
101
93
  }
102
94
  },
103
95
  "durationMs": {
104
- "anyOf": [
105
- {
106
- "type": "number"
107
- },
108
- {
109
- "type": "null"
110
- }
96
+ "type": [
97
+ "number",
98
+ "null"
111
99
  ]
112
100
  },
113
101
  "evidence": {
@@ -189,96 +177,76 @@
189
177
  }
190
178
  },
191
179
  "fingerprints": {
192
- "description": "Spec path to the fingerprint the layer recorded for it",
193
180
  "type": "object",
194
181
  "propertyNames": {
195
182
  "type": "string"
196
183
  },
197
184
  "additionalProperties": {
198
185
  "type": "string"
199
- }
186
+ },
187
+ "description": "Spec path to the fingerprint the layer recorded for it"
200
188
  },
201
189
  "layer": {
202
190
  "type": "object",
203
191
  "properties": {
204
192
  "id": {
205
- "description": "The layer id: 64 lowercase hex digits, the SHA-256 of its content",
206
- "type": "string"
193
+ "type": "string",
194
+ "description": "The layer id: 64 lowercase hex digits, the SHA-256 of its content"
207
195
  },
208
196
  "backend": {
209
- "description": "The backend it was read from; the one that sorts first when several hold it",
210
- "type": "string"
197
+ "type": "string",
198
+ "description": "The backend it was read from; the one that sorts first when several hold it"
211
199
  },
212
200
  "producer": {
213
- "description": "The suite or tool that made it. Part of the slot",
214
- "type": "string"
201
+ "type": "string",
202
+ "description": "The suite or tool that made it. Part of the slot"
215
203
  },
216
204
  "packageDir": {
217
- "anyOf": [
218
- {
219
- "type": "string"
220
- },
221
- {
222
- "type": "null"
223
- }
205
+ "type": [
206
+ "string",
207
+ "null"
224
208
  ]
225
209
  },
226
210
  "recordedAtMs": {
227
- "description": "When the checks ran, epoch milliseconds. The newest completed result wins its slot",
228
- "type": "number"
211
+ "type": "number",
212
+ "description": "When the checks ran, epoch milliseconds. The newest completed result wins its slot"
229
213
  },
230
214
  "sha": {
231
215
  "description": "The commit it was recorded at. Provenance only",
232
- "anyOf": [
233
- {
234
- "type": "string"
235
- },
236
- {
237
- "type": "null"
238
- }
216
+ "type": [
217
+ "string",
218
+ "null"
239
219
  ]
240
220
  },
241
221
  "branch": {
242
222
  "description": "The branch it was recorded on. Provenance only",
243
- "anyOf": [
244
- {
245
- "type": "string"
246
- },
247
- {
248
- "type": "null"
249
- }
223
+ "type": [
224
+ "string",
225
+ "null"
250
226
  ]
251
227
  },
252
228
  "environment": {
253
229
  "description": "The client it checked, such as `ios`. Part of the slot",
254
- "anyOf": [
255
- {
256
- "type": "string"
257
- },
258
- {
259
- "type": "null"
260
- }
230
+ "type": [
231
+ "string",
232
+ "null"
261
233
  ]
262
234
  },
263
235
  "runUrl": {
264
- "anyOf": [
265
- {
266
- "type": "string"
267
- },
268
- {
269
- "type": "null"
270
- }
236
+ "type": [
237
+ "string",
238
+ "null"
271
239
  ]
272
240
  },
273
241
  "parameters": {
274
- "description": "Other choices that make a result its own slot",
275
242
  "type": "object",
276
243
  "propertyNames": {
277
244
  "type": "string"
278
245
  },
279
246
  "additionalProperties": {
280
247
  "type": "string"
281
- }
248
+ },
249
+ "description": "Other choices that make a result its own slot"
282
250
  },
283
251
  "freshness": {
284
252
  "description": "`modified`: recorded from a checkout with uncommitted changes. `unknown`: origin not captured. Absent: clean",
@@ -289,13 +257,13 @@
289
257
  ]
290
258
  },
291
259
  "recording": {
292
- "description": "Where recorded timelines are read from, or null",
293
260
  "anyOf": [
294
261
  {},
295
262
  {
296
263
  "type": "null"
297
264
  }
298
- ]
265
+ ],
266
+ "description": "Where recorded timelines are read from, or null"
299
267
  },
300
268
  "live": {
301
269
  "type": "boolean"
@@ -315,7 +283,13 @@
315
283
  "type": "integer",
316
284
  "minimum": 0,
317
285
  "maximum": 9007199254740991
318
- }
286
+ },
287
+ "required": [
288
+ "passed",
289
+ "failed",
290
+ "running",
291
+ "not-run"
292
+ ]
319
293
  },
320
294
  "execution": {
321
295
  "type": "string"
@@ -423,12 +397,12 @@
423
397
  "type": "string"
424
398
  },
425
399
  "live": {
426
- "description": "Always false on a server",
427
- "type": "boolean"
400
+ "type": "boolean",
401
+ "description": "Always false on a server"
428
402
  },
429
403
  "available": {
430
- "description": "False when the backend could not be read; its results are then unknown, never passed",
431
- "type": "boolean"
404
+ "type": "boolean",
405
+ "description": "False when the backend could not be read; its results are then unknown, never passed"
432
406
  }
433
407
  },
434
408
  "required": [
@@ -441,22 +415,22 @@
441
415
  }
442
416
  },
443
417
  "notices": {
444
- "description": "What could not be read. A gate treats any notice as unknown, never as passed",
445
418
  "type": "array",
446
419
  "items": {
447
420
  "type": "string"
448
- }
421
+ },
422
+ "description": "What could not be read. A gate treats any notice as unknown, never as passed"
449
423
  },
450
424
  "totalLayers": {
451
- "description": "Every layer read, whether or not it still wins anything",
452
425
  "type": "integer",
453
426
  "minimum": 0,
454
- "maximum": 9007199254740991
427
+ "maximum": 9007199254740991,
428
+ "description": "Every layer read, whether or not it still wins anything"
455
429
  },
456
430
  "active": {
457
- "description": "Always empty on a server; kept for viewers written for live spec runs",
458
431
  "type": "array",
459
- "items": {}
432
+ "items": {},
433
+ "description": "Always empty on a server; kept for viewers written for live spec runs"
460
434
  }
461
435
  },
462
436
  "required": [