@crvouga/atlas 0.0.0-stage → 0.2.0

package/dist/schema/src/manifest.d.ts

@@ -0,0 +1,457 @@
+import { z } from 'zod/v4';
+/** Manifest schema versions this package describes. Readers accept these and try newer ones. */
+export declare const MANIFEST_SCHEMA_VERSIONS: readonly [1];
+export declare const LATEST_MANIFEST_SCHEMA_VERSION = 1;
+export declare const MEDIA_STATES: readonly ["ready", "processing", "failed"];
+/**
+ * Proposed: the runner marks media it has promised but not finished writing, so a viewer can
+ * show "still processing" instead of a broken image. Absent means ready.
+ */
+export declare const MediaStateSchema: z.ZodEnum<{
+    failed: "failed";
+    ready: "ready";
+    processing: "processing";
+}>;
+export declare const TIMELINE_KINDS: readonly ["tap", "type", "system", "screen", "toast", "note", "time", "notification"];
+export declare const SystemCallSchema: z.ZodObject<{
+    source: z.ZodOptional<z.ZodString>;
+    endpoint: z.ZodOptional<z.ZodString>;
+    eventType: z.ZodOptional<z.ZodString>;
+    payload: z.ZodOptional<z.ZodUnknown>;
+    responseStatus: z.ZodOptional<z.ZodNumber>;
+    response: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$strip>;
+/** Proposed `kind: time`: a clock jump, with the dates before and after. */
+export declare const TimeJumpSchema: z.ZodObject<{
+    from: z.ZodString;
+    to: z.ZodString;
+    fired: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        at: z.ZodString;
+        label: z.ZodString;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/** Proposed `kind: notification`: a push, email or text the member received. */
+export declare const NotificationSchema: z.ZodObject<{
+    channel: z.ZodOptional<z.ZodEnum<{
+        push: "push";
+        email: "email";
+        sms: "sms";
+        "in-app": "in-app";
+    }>>;
+    title: z.ZodOptional<z.ZodString>;
+    body: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const TimelineEntrySchema: z.ZodObject<{
+    atMs: z.ZodNumber;
+    kind: z.ZodEnum<{
+        type: "type";
+        time: "time";
+        system: "system";
+        tap: "tap";
+        screen: "screen";
+        toast: "toast";
+        note: "note";
+        notification: "notification";
+    }>;
+    label: z.ZodString;
+    x: z.ZodOptional<z.ZodNumber>;
+    y: z.ZodOptional<z.ZodNumber>;
+    text: z.ZodOptional<z.ZodString>;
+    system: z.ZodOptional<z.ZodObject<{
+        source: z.ZodOptional<z.ZodString>;
+        endpoint: z.ZodOptional<z.ZodString>;
+        eventType: z.ZodOptional<z.ZodString>;
+        payload: z.ZodOptional<z.ZodUnknown>;
+        responseStatus: z.ZodOptional<z.ZodNumber>;
+        response: z.ZodOptional<z.ZodUnknown>;
+    }, z.core.$strip>>;
+    time: z.ZodOptional<z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodString;
+        fired: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            at: z.ZodString;
+            label: z.ZodString;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    notification: z.ZodOptional<z.ZodObject<{
+        channel: z.ZodOptional<z.ZodEnum<{
+            push: "push";
+            email: "email";
+            sms: "sms";
+            "in-app": "in-app";
+        }>>;
+        title: z.ZodOptional<z.ZodString>;
+        body: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    client: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type TimelineEntry = z.infer<typeof TimelineEntrySchema>;
+/** A CloudEvents 1.0 event (JSON format), as an event source observed it. */
+export declare const CloudEventSchema: z.ZodObject<{
+    specversion: z.ZodLiteral<"1.0">;
+    id: z.ZodString;
+    source: z.ZodString;
+    type: z.ZodString;
+    time: z.ZodOptional<z.ZodString>;
+    subject: z.ZodOptional<z.ZodString>;
+    datacontenttype: z.ZodOptional<z.ZodString>;
+    data: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$loose>;
+export type CloudEvent = z.infer<typeof CloudEventSchema>;
+export declare const BusinessEventsSchema: z.ZodObject<{
+    expected: z.ZodArray<z.ZodString>;
+    observed: z.ZodArray<z.ZodString>;
+    missing: z.ZodArray<z.ZodString>;
+    noSignal: z.ZodArray<z.ZodString>;
+    events: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        specversion: z.ZodLiteral<"1.0">;
+        id: z.ZodString;
+        source: z.ZodString;
+        type: z.ZodString;
+        time: z.ZodOptional<z.ZodString>;
+        subject: z.ZodOptional<z.ZodString>;
+        datacontenttype: z.ZodOptional<z.ZodString>;
+        data: z.ZodOptional<z.ZodUnknown>;
+    }, z.core.$loose>>>;
+}, z.core.$strip>;
+export type BusinessEvents = z.infer<typeof BusinessEventsSchema>;
+export declare const CheckResultSchema: z.ZodObject<{
+    check: z.ZodString;
+    passed: z.ZodBoolean;
+    expected: z.ZodOptional<z.ZodString>;
+    actual: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type CheckResult = z.infer<typeof CheckResultSchema>;
+export declare const RecognizerSchema: z.ZodObject<{
+    matched: z.ZodBoolean;
+    signals: z.ZodArray<z.ZodObject<{
+        signal: z.ZodString;
+        expected: z.ZodString;
+        visible: z.ZodBoolean;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const RunInfoSchema: z.ZodObject<{
+    id: z.ZodString;
+    startedAt: z.ZodString;
+    durationMs: z.ZodNumber;
+    commit: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    branch: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    environment: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    mode: z.ZodEnum<{
+        fast: "fast";
+        showcase: "showcase";
+    }>;
+    specVersion: z.ZodString;
+    specDirectory: z.ZodOptional<z.ZodString>;
+    approvals: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+    scope: z.ZodOptional<z.ZodObject<{
+        chart: z.ZodOptional<z.ZodString>;
+        start: z.ZodOptional<z.ZodString>;
+        state: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    finishedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    progress: z.ZodOptional<z.ZodObject<{
+        totalPaths: z.ZodNumber;
+        completedPaths: z.ZodNumber;
+        activePaths: z.ZodArray<z.ZodString>;
+        updatedAt: z.ZodString;
+    }, z.core.$strip>>;
+    workers: z.ZodOptional<z.ZodNumber>;
+    shard: z.ZodOptional<z.ZodObject<{
+        index: z.ZodNumber;
+        count: z.ZodNumber;
+    }, z.core.$strip>>;
+    reused: z.ZodOptional<z.ZodObject<{
+        from: z.ZodString;
+        paths: z.ZodNumber;
+    }, z.core.$strip>>;
+    mergedFrom: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+export type RunInfo = z.infer<typeof RunInfoSchema>;
+export declare const ManifestChartSchema: z.ZodObject<{
+    id: z.ZodString;
+    file: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    parentState: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    handOffs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, z.core.$strip>;
+export declare const MapNodeSchema: z.ZodObject<{
+    id: z.ZodString;
+    parent: z.ZodNullable<z.ZodString>;
+    chart: z.ZodString;
+    type: z.ZodEnum<{
+        parallel: "parallel";
+        final: "final";
+        atomic: "atomic";
+        compound: "compound";
+    }>;
+    initial: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    inScope: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export declare const MapEdgeSchema: z.ZodObject<{
+    id: z.ZodString;
+    source: z.ZodString;
+    target: z.ZodString;
+    event: z.ZodString;
+    kind: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodEnum<{
+        time: "time";
+        user: "user";
+        system: "system";
+        "hand-off": "hand-off";
+    }>>;
+    inScope: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export declare const StateRecordSchema: z.ZodObject<{
+    name: z.ZodString;
+    chart: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    description: z.ZodOptional<z.ZodString>;
+    snapshot: z.ZodOptional<z.ZodString>;
+    confidence: z.ZodOptional<z.ZodEnum<{
+        confirmed: "confirmed";
+        assumed: "assumed";
+    }>>;
+    source: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    expectedEvents: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    client: z.ZodOptional<z.ZodString>;
+    seeds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    status: z.ZodEnum<{
+        passed: "passed";
+        failed: "failed";
+        flaky: "flaky";
+        "not-reached": "not-reached";
+    }>;
+    screenshot: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        png: z.ZodString;
+        webp: z.ZodOptional<z.ZodString>;
+        client: z.ZodOptional<z.ZodString>;
+        also: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            png: z.ZodString;
+            webp: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+            client: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>>;
+    screenshotState: z.ZodOptional<z.ZodEnum<{
+        failed: "failed";
+        ready: "ready";
+        processing: "processing";
+    }>>;
+    thumbnail: z.ZodOptional<z.ZodString>;
+    screenshotsByPath: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        png: z.ZodString;
+        webp: z.ZodOptional<z.ZodString>;
+        client: z.ZodOptional<z.ZodString>;
+        also: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            png: z.ZodString;
+            webp: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+            client: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>>;
+    recognizer: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        matched: z.ZodBoolean;
+        signals: z.ZodArray<z.ZodObject<{
+            signal: z.ZodString;
+            expected: z.ZodString;
+            visible: z.ZodBoolean;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    looksLike: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    businessEvents: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        expected: z.ZodArray<z.ZodString>;
+        observed: z.ZodArray<z.ZodString>;
+        missing: z.ZodArray<z.ZodString>;
+        noSignal: z.ZodArray<z.ZodString>;
+        events: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            specversion: z.ZodLiteral<"1.0">;
+            id: z.ZodString;
+            source: z.ZodString;
+            type: z.ZodString;
+            time: z.ZodOptional<z.ZodString>;
+            subject: z.ZodOptional<z.ZodString>;
+            datacontenttype: z.ZodOptional<z.ZodString>;
+            data: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$loose>>>;
+    }, z.core.$strip>>>;
+    checks: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        check: z.ZodString;
+        passed: z.ZodBoolean;
+        expected: z.ZodOptional<z.ZodString>;
+        actual: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    reachedBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+export type StateRecord = z.infer<typeof StateRecordSchema>;
+export declare const ClipSchema: z.ZodObject<{
+    video: z.ZodString;
+    poster: z.ZodOptional<z.ZodString>;
+    durationMs: z.ZodOptional<z.ZodNumber>;
+    captions: z.ZodOptional<z.ZodString>;
+    client: z.ZodOptional<z.ZodString>;
+    state: z.ZodOptional<z.ZodEnum<{
+        failed: "failed";
+        ready: "ready";
+        processing: "processing";
+    }>>;
+}, z.core.$strip>;
+export type Clip = z.infer<typeof ClipSchema>;
+export declare const TransitionRecordSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    source: z.ZodString;
+    target: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    event: z.ZodString;
+    kind: z.ZodOptional<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodEnum<{
+        time: "time";
+        user: "user";
+        system: "system";
+        "hand-off": "hand-off";
+    }>>>;
+    how: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    client: z.ZodOptional<z.ZodString>;
+    status: z.ZodEnum<{
+        passed: "passed";
+        failed: "failed";
+        flaky: "flaky";
+        "not-reached": "not-reached";
+    }>;
+    clip: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        video: z.ZodString;
+        poster: z.ZodOptional<z.ZodString>;
+        durationMs: z.ZodOptional<z.ZodNumber>;
+        captions: z.ZodOptional<z.ZodString>;
+        client: z.ZodOptional<z.ZodString>;
+        state: z.ZodOptional<z.ZodEnum<{
+            failed: "failed";
+            ready: "ready";
+            processing: "processing";
+        }>>;
+    }, z.core.$strip>>>;
+    timeline: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+    reason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    reachedBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+export type TransitionRecord = z.infer<typeof TransitionRecordSchema>;
+export declare const PathStepSchema: z.ZodObject<{
+    transition: z.ZodOptional<z.ZodString>;
+    event: z.ZodString;
+    status: z.ZodOptional<z.ZodEnum<{
+        passed: "passed";
+        failed: "failed";
+        flaky: "flaky";
+        "not-reached": "not-reached";
+    }>>;
+    reason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export declare const PathRecordSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    kind: z.ZodEnum<{
+        journey: "journey";
+        generated: "generated";
+    }>;
+    description: z.ZodOptional<z.ZodString>;
+    status: z.ZodEnum<{
+        passed: "passed";
+        failed: "failed";
+        flaky: "flaky";
+        "not-reached": "not-reached";
+    }>;
+    progress: z.ZodOptional<z.ZodEnum<{
+        complete: "complete";
+        running: "running";
+        queued: "queued";
+    }>>;
+    attempts: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        status: z.ZodString;
+        error: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        stoppedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        trace: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        traces: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, z.core.$strip>>>;
+    steps: z.ZodArray<z.ZodUnknown>;
+    stoppedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    key: z.ZodOptional<z.ZodString>;
+    start: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    seed: z.ZodOptional<z.ZodString>;
+    journeys: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    durationMs: z.ZodOptional<z.ZodNumber>;
+    setupMs: z.ZodOptional<z.ZodNumber>;
+    reusedFrom: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type PathRecord = z.infer<typeof PathRecordSchema>;
+/** A journey's result, composed from the paths it is cut into (one per seeded stretch). */
+export declare const JourneyRecordSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    status: z.ZodUnion<readonly [z.ZodEnum<{
+        passed: "passed";
+        failed: "failed";
+        flaky: "flaky";
+        "not-reached": "not-reached";
+    }>, z.ZodLiteral<"not-run">]>;
+    paths: z.ZodArray<z.ZodString>;
+    stoppedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type JourneyRecord = z.infer<typeof JourneyRecordSchema>;
+/** A configuration the implementation can put the system in directly, and what checks it. */
+export declare const SeedRecordSchema: z.ZodObject<{
+    name: z.ZodString;
+    at: z.ZodArray<z.ZodString>;
+    how: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    shows: z.ZodOptional<z.ZodString>;
+    for: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    blocked: z.ZodOptional<z.ZodString>;
+    paths: z.ZodArray<z.ZodString>;
+    verifiedBy: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type SeedRecord = z.infer<typeof SeedRecordSchema>;
+/** Other formats the run wrote, relative to the manifest: JUnit XML, CTRF JSON, Mermaid. */
+export declare const ReportsSchema: z.ZodObject<{
+    junit: z.ZodOptional<z.ZodString>;
+    ctrf: z.ZodOptional<z.ZodString>;
+    mermaid: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const PrivacySchema: z.ZodObject<{
+    passed: z.ZodBoolean;
+    findings: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * The top level of `runs/<run-id>/manifest.json`. Sections are `unknown` here so a reader can
+ * validate each record on its own and keep the valid ones; the record schemas above are the
+ * contract for each entry.
+ */
+export declare const ManifestEnvelopeSchema: z.ZodObject<{
+    schemaVersion: z.ZodNumber;
+    run: z.ZodUnknown;
+    charts: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+    map: z.ZodOptional<z.ZodObject<{
+        nodes: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+        edges: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+    }, z.core.$strip>>;
+    states: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    transitions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    paths: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+    journeys: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+    seeds: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+    coverage: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        states: z.ZodOptional<z.ZodObject<{
+            total: z.ZodNumber;
+            passed: z.ZodNumber;
+            failed: z.ZodNumber;
+            flaky: z.ZodNumber;
+            notReached: z.ZodNumber;
+        }, z.core.$strip>>;
+        transitions: z.ZodOptional<z.ZodObject<{
+            total: z.ZodNumber;
+            passed: z.ZodNumber;
+            failed: z.ZodNumber;
+            flaky: z.ZodNumber;
+            notReached: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    privacy: z.ZodOptional<z.ZodUnknown>;
+    reports: z.ZodOptional<z.ZodObject<{
+        junit: z.ZodOptional<z.ZodString>;
+        ctrf: z.ZodOptional<z.ZodString>;
+        mermaid: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;