@crvouga/atlas 1.2.0 → 1.4.0

package/dist/schema/src/api.js

@@ -14,7 +14,7 @@
  * @see docs/server.md
  */
 import { z } from 'zod/v4';
-import { CheckSchema, LayerRunSchema } from './layer.js';
+import { CheckSchema, EvidenceScopeSchema, LayerRunSchema } from './layer.js';
 /** One of the statuses a check has in a report: `passed`, `failed`, `running` (not finished) or `not-run`. Closed. */
 export const EvidenceStatusSchema = z.enum(['passed', 'failed', 'running', 'not-run']);
 /**
@@ -70,7 +70,8 @@ export const VideoRefSchema = z.looseObject({
     step: z.string().optional().describe('The name of the step that holds it'),
     tags: z.array(z.string()).optional().describe('The normalized tags of this attachment itself. Absent when it has none (and in documents of older servers)'),
     recording: z.string().optional().describe('What identifies the bytes; references with the same value are one recording. Absent when it cannot be played'),
-    available: z.boolean().describe('False when the reference names no bytes (no bundle key, address or inline text)')
+    available: z.boolean().describe('False when the reference names no bytes (no bundle key, address or inline text)'),
+    scope: EvidenceScopeSchema.optional().describe('What this recording shows as its producer declared it: its own `scope`, else its attempt\'s, check\'s, part\'s or layer\'s. Absent: the scope is unknown, never live, physical or audible')
 });
 /** Video references as counts: how many are referenced, how many distinct recordings can be played, how many cannot. */
 export const VideoCountsSchema = z.looseObject({
@@ -189,7 +190,9 @@ export const CheckDetailSchema = z.looseObject({
     layer: z.string(),
     kind: z.string(),
     check: CheckSchema,
-    run: z.looseObject({}).describe('What the run as a whole carries: its logs, links, labels, annotations and extensions')
+    run: z.looseObject({}).describe('What the run as a whole carries: its logs, links, labels, annotations, scope and extensions'),
+    parts: z.array(z.looseObject({ kind: z.string(), id: z.string(), title: z.string() })).optional().describe('Without `check` only: the parts of the layer that carry files or links of their own, each with what it carries. Absent when none'),
+    inheritedScope: EvidenceScopeSchema.optional().describe('The scope the check inherits: its part\'s declaration, else its layer\'s. Absent when neither declared one: unknown, not live or physical')
 });
 /** `GET /api/store?prefix=…`: one page of keys under `layers/`, in code-unit order. */
 export const StoreListingSchema = z.looseObject({
@@ -295,6 +298,7 @@ export const TestSummarySchema = z.looseObject({
     tags: z.array(z.string()),
     artifactTags: z.array(z.string()).optional().describe('Normalized tags of the attachments of its current results, such as `demo` (shown `#demo`). Not inherited from a check or run, unlike `tags`'),
     inheritedArtifactTags: z.array(z.string()).optional().describe('Normalized tags its attachments inherit from their check and run, apart from `artifactTags`: what `?artifactTag=…&inherited=1` also matches'),
+    scopeProfiles: z.array(z.array(z.string())).optional().describe('The scope tokens each distinct playable recording of its current results declares (`device:physical`, `audio:silent`); `["unknown"]` for a recording that declared none. What `?scope=` matches, one recording at a time. Absent when it has no playable recording'),
     labels: z.record(z.string(), z.string()),
     evidence: z.looseObject({ attachments: z.number().int().nonnegative(), steps: z.number().int().nonnegative(), attempts: z.number().int().nonnegative(), roles: z.array(z.string()) }),
     lastRecordedAtMs: z.number(),
@@ -321,7 +325,7 @@ export const TestCatalogSchema = z.looseObject({
     facets: z.looseObject({
         statuses: z.array(FacetValueSchema), environments: z.array(FacetValueSchema), producers: z.array(FacetValueSchema), domains: z.array(FacetValueSchema),
         specs: z.array(CatalogSpecSchema.extend({ tests: z.number().int().nonnegative(), counts: StatusCountsSchema })),
-        tags: z.array(FacetValueSchema), artifactTags: z.array(FacetValueSchema).optional(), branches: z.array(FacetValueSchema), labels: z.record(z.string(), z.array(FacetValueSchema))
+        tags: z.array(FacetValueSchema), artifactTags: z.array(FacetValueSchema).optional(), scopes: z.array(FacetValueSchema).optional().describe('Scope tokens of recordings (`device:simulator`, `unknown`) with the number of tests that have a recording stating each'), branches: z.array(FacetValueSchema), labels: z.record(z.string(), z.array(FacetValueSchema))
     }),
     total: z.number().int().nonnegative().describe('Tests the query matched, before offset and limit'),
     offset: z.number().int().nonnegative(),
@@ -398,6 +402,7 @@ export const ReportRunSchema = z.looseObject({
     totalDurationMs: z.number().nullable(),
     failing: z.array(z.looseObject({ key: z.string(), title: z.string(), environment: z.string().nullable(), detail: z.string() })),
     videos: VideoCountsSchema.optional().describe('Its videos, from its layers and the last result of each test. Absent when it has none or the report carries no video information'),
+    attachments: z.number().int().positive().optional().describe('Files attached to the run itself, in its layers, not to a check. Absent when there are none'),
     artifactTags: z.array(z.string()).optional().describe('The normalized tags of the attachments of its results, sorted and distinct. Absent when none is tagged, and in reports of older servers'),
     tags: z.array(z.string()).optional().describe('The tags of its checks and layers, which its attachments inherit (what `inherited=1` also matches). Absent when none'),
     types: z.array(z.string()).optional().describe('The media types (roles) of its attachments, sorted and distinct; `video` only for a playable recording. Absent when it has no attachment'),
@@ -454,5 +459,12 @@ export const RunDetailSchema = z.looseObject({
         key: z.string(), id: z.string(), title: z.string(), specPath: z.string().nullable(), environment: z.string().nullable(), producer: z.string(),
         status: EvidenceStatusSchema, durationMs: z.number().nullable(), at: z.number(), layer: z.string(), detail: z.string(),
         videos: z.array(VideoRefSchema).optional().describe('Every video its evidence references, with who holds it')
-    }))
+    })),
+    layers: z.array(z.looseObject({
+        id: z.string().describe('The layer id; read its files with `/api/reports/evidence/detail/{backend}/{id}`'),
+        backend: z.string(), producer: z.string(), environment: z.string().nullable(), recordedAtMs: z.number(),
+        checks: z.number().int().nonnegative().describe('How many checks the layer recorded. Zero means evidence only, not a pass'),
+        attachments: z.number().int().nonnegative().describe('Files the layer carries as a whole, not those of its checks'),
+        videos: VideoCountsSchema.optional()
+    })).optional().describe('Every layer of the run, oldest first. Absent from an older server')
 });