@crvouga/atlas 0.4.0 → 0.5.0

package/dist/reports/src/reports-explorer-route.d.ts

@@ -1,8 +1,28 @@
+/**
+ * @module Explorer routes
+ *
+ * Two read-only routes that give the explorer one commit's spec inventory, latest evidence parts and spec text, drawn
+ * from the checkout (when the commit is the one checked out), this machine's store and the shared store. A shared store
+ * that cannot be read degrades to a notice when anything local is available.
+ */
 import type { WorkspaceReports } from './explorer-types.js';
 import type { ReportsStores } from './reports-store.js';
+/** The stores plus an optional provider of the current checkout. */
 export type ReportsExplorerDeps = ReportsStores & {
+    /** The checkout the host is serving. Only composition roots provide it; its content is never CI evidence. */
     readonly workspace?: () => Promise<WorkspaceReports>;
 };
+/**
+ * Builds the Hono app for `GET /:sha/explorer` and `GET /:sha/spec`.
+ *
+ * `/:sha/explorer` answers `{ inventory, parts, notice? }` for a 40-hex sha. The inventory is the checkout's when `sha`
+ * is the workspace's, else the local store's, else the shared store's. The parts are the shared store's followed by the
+ * checkout's (or the local store's), reduced to the latest part per producer. If the shared store fails but something
+ * local exists, it answers with a `notice`; with nothing local it throws. 404 for a
+ * bad sha, 503 `reports_unavailable` when there is no shared store and nothing local. `/:sha/spec?path=` answers a
+ * spec's text (`text/plain`) from the workspace, else the local store, else the shared store, or 404 for a bad sha,
+ * a path that is not a spec path, or a missing file. Both are `no-store`.
+ */
 export declare function createReportsExplorerApp(deps: ReportsExplorerDeps): import("hono/hono-base").HonoBase<import("hono/types").BlankEnv, {
     "/:sha/explorer": {
         $get: {
@@ -46,6 +66,266 @@ export declare function createReportsExplorerApp(deps: ReportsExplorerDeps): imp
                     }[];
                 } | null;
                 parts: readonly {
+                    tags?: string[] | undefined;
+                    attachments?: {
+                        [x: string]: import("hono/utils/types").JSONValue;
+                        name: string;
+                        id?: string | undefined;
+                        role?: string | undefined;
+                        contentType?: string | undefined;
+                        bundleKey?: string | undefined;
+                        uri?: string | undefined;
+                        text?: string | undefined;
+                        bytes?: number | undefined;
+                        sha256?: string | undefined;
+                        width?: number | undefined;
+                        height?: number | undefined;
+                        durationMs?: number | undefined;
+                        description?: string | undefined;
+                        at?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                            step?: string | undefined;
+                            offsetMs?: number | undefined;
+                        } | undefined;
+                        poster?: string | undefined;
+                        captions?: string[] | undefined;
+                        extensions?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                        } | undefined;
+                    }[] | undefined;
+                    attempts?: {
+                        [x: string]: import("hono/utils/types").JSONValue;
+                        index: number;
+                        status: "passed" | "failed" | "running" | "not-run";
+                        durationMs?: number | undefined;
+                        startedAtMs?: number | undefined;
+                        detail?: string | undefined;
+                        steps?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                            name: string;
+                            id?: string | undefined;
+                            parentId?: string | undefined;
+                            kind?: string | undefined;
+                            status?: string | undefined;
+                            offsetMs?: number | undefined;
+                            durationMs?: number | undefined;
+                            detail?: string | undefined;
+                            attachments?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                name: string;
+                                id?: string | undefined;
+                                role?: string | undefined;
+                                contentType?: string | undefined;
+                                bundleKey?: string | undefined;
+                                uri?: string | undefined;
+                                text?: string | undefined;
+                                bytes?: number | undefined;
+                                sha256?: string | undefined;
+                                width?: number | undefined;
+                                height?: number | undefined;
+                                durationMs?: number | undefined;
+                                description?: string | undefined;
+                                at?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                    step?: string | undefined;
+                                    offsetMs?: number | undefined;
+                                } | undefined;
+                                poster?: string | undefined;
+                                captions?: string[] | undefined;
+                                extensions?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                } | undefined;
+                            }[] | undefined;
+                            annotations?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                type: string;
+                                message: string;
+                                level?: string | undefined;
+                                at?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                    step?: string | undefined;
+                                    offsetMs?: number | undefined;
+                                } | undefined;
+                                source?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                    file?: string | undefined;
+                                    line?: number | undefined;
+                                    column?: number | undefined;
+                                } | undefined;
+                                links?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                    url: string;
+                                    name?: string | undefined;
+                                    rel?: string | undefined;
+                                }[] | undefined;
+                                extensions?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                } | undefined;
+                            }[] | undefined;
+                            extensions?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                            } | undefined;
+                        }[] | undefined;
+                        attachments?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                            name: string;
+                            id?: string | undefined;
+                            role?: string | undefined;
+                            contentType?: string | undefined;
+                            bundleKey?: string | undefined;
+                            uri?: string | undefined;
+                            text?: string | undefined;
+                            bytes?: number | undefined;
+                            sha256?: string | undefined;
+                            width?: number | undefined;
+                            height?: number | undefined;
+                            durationMs?: number | undefined;
+                            description?: string | undefined;
+                            at?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                step?: string | undefined;
+                                offsetMs?: number | undefined;
+                            } | undefined;
+                            poster?: string | undefined;
+                            captions?: string[] | undefined;
+                            extensions?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                            } | undefined;
+                        }[] | undefined;
+                        annotations?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                            type: string;
+                            message: string;
+                            level?: string | undefined;
+                            at?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                step?: string | undefined;
+                                offsetMs?: number | undefined;
+                            } | undefined;
+                            source?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                file?: string | undefined;
+                                line?: number | undefined;
+                                column?: number | undefined;
+                            } | undefined;
+                            links?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                url: string;
+                                name?: string | undefined;
+                                rel?: string | undefined;
+                            }[] | undefined;
+                            extensions?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                            } | undefined;
+                        }[] | undefined;
+                        extensions?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                        } | undefined;
+                    }[] | undefined;
+                    steps?: {
+                        [x: string]: import("hono/utils/types").JSONValue;
+                        name: string;
+                        id?: string | undefined;
+                        parentId?: string | undefined;
+                        kind?: string | undefined;
+                        status?: string | undefined;
+                        offsetMs?: number | undefined;
+                        durationMs?: number | undefined;
+                        detail?: string | undefined;
+                        attachments?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                            name: string;
+                            id?: string | undefined;
+                            role?: string | undefined;
+                            contentType?: string | undefined;
+                            bundleKey?: string | undefined;
+                            uri?: string | undefined;
+                            text?: string | undefined;
+                            bytes?: number | undefined;
+                            sha256?: string | undefined;
+                            width?: number | undefined;
+                            height?: number | undefined;
+                            durationMs?: number | undefined;
+                            description?: string | undefined;
+                            at?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                step?: string | undefined;
+                                offsetMs?: number | undefined;
+                            } | undefined;
+                            poster?: string | undefined;
+                            captions?: string[] | undefined;
+                            extensions?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                            } | undefined;
+                        }[] | undefined;
+                        annotations?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                            type: string;
+                            message: string;
+                            level?: string | undefined;
+                            at?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                step?: string | undefined;
+                                offsetMs?: number | undefined;
+                            } | undefined;
+                            source?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                file?: string | undefined;
+                                line?: number | undefined;
+                                column?: number | undefined;
+                            } | undefined;
+                            links?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                url: string;
+                                name?: string | undefined;
+                                rel?: string | undefined;
+                            }[] | undefined;
+                            extensions?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                            } | undefined;
+                        }[] | undefined;
+                        extensions?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                        } | undefined;
+                    }[] | undefined;
+                    extensions?: {
+                        [x: string]: import("hono/utils/types").JSONValue;
+                    } | undefined;
+                    links?: {
+                        [x: string]: import("hono/utils/types").JSONValue;
+                        url: string;
+                        name?: string | undefined;
+                        rel?: string | undefined;
+                    }[] | undefined;
+                    annotations?: {
+                        [x: string]: import("hono/utils/types").JSONValue;
+                        type: string;
+                        message: string;
+                        level?: string | undefined;
+                        at?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                            step?: string | undefined;
+                            offsetMs?: number | undefined;
+                        } | undefined;
+                        source?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                            file?: string | undefined;
+                            line?: number | undefined;
+                            column?: number | undefined;
+                        } | undefined;
+                        links?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                            url: string;
+                            name?: string | undefined;
+                            rel?: string | undefined;
+                        }[] | undefined;
+                        extensions?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                        } | undefined;
+                    }[] | undefined;
+                    labels?: {
+                        [x: string]: string;
+                    } | undefined;
                     readonly freshness?: "unknown" | "modified" | undefined;
                     readonly parameters?: {
                         readonly [x: string]: string;
@@ -56,6 +336,266 @@ export declare function createReportsExplorerApp(deps: ReportsExplorerDeps): imp
                     readonly title: string;
                     readonly recordedAtMs: number;
                     readonly checks: readonly {
+                        tags?: string[] | undefined;
+                        attachments?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                            name: string;
+                            id?: string | undefined;
+                            role?: string | undefined;
+                            contentType?: string | undefined;
+                            bundleKey?: string | undefined;
+                            uri?: string | undefined;
+                            text?: string | undefined;
+                            bytes?: number | undefined;
+                            sha256?: string | undefined;
+                            width?: number | undefined;
+                            height?: number | undefined;
+                            durationMs?: number | undefined;
+                            description?: string | undefined;
+                            at?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                step?: string | undefined;
+                                offsetMs?: number | undefined;
+                            } | undefined;
+                            poster?: string | undefined;
+                            captions?: string[] | undefined;
+                            extensions?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                            } | undefined;
+                        }[] | undefined;
+                        attempts?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                            index: number;
+                            status: "passed" | "failed" | "running" | "not-run";
+                            durationMs?: number | undefined;
+                            startedAtMs?: number | undefined;
+                            detail?: string | undefined;
+                            steps?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                name: string;
+                                id?: string | undefined;
+                                parentId?: string | undefined;
+                                kind?: string | undefined;
+                                status?: string | undefined;
+                                offsetMs?: number | undefined;
+                                durationMs?: number | undefined;
+                                detail?: string | undefined;
+                                attachments?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                    name: string;
+                                    id?: string | undefined;
+                                    role?: string | undefined;
+                                    contentType?: string | undefined;
+                                    bundleKey?: string | undefined;
+                                    uri?: string | undefined;
+                                    text?: string | undefined;
+                                    bytes?: number | undefined;
+                                    sha256?: string | undefined;
+                                    width?: number | undefined;
+                                    height?: number | undefined;
+                                    durationMs?: number | undefined;
+                                    description?: string | undefined;
+                                    at?: {
+                                        [x: string]: import("hono/utils/types").JSONValue;
+                                        step?: string | undefined;
+                                        offsetMs?: number | undefined;
+                                    } | undefined;
+                                    poster?: string | undefined;
+                                    captions?: string[] | undefined;
+                                    extensions?: {
+                                        [x: string]: import("hono/utils/types").JSONValue;
+                                    } | undefined;
+                                }[] | undefined;
+                                annotations?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                    type: string;
+                                    message: string;
+                                    level?: string | undefined;
+                                    at?: {
+                                        [x: string]: import("hono/utils/types").JSONValue;
+                                        step?: string | undefined;
+                                        offsetMs?: number | undefined;
+                                    } | undefined;
+                                    source?: {
+                                        [x: string]: import("hono/utils/types").JSONValue;
+                                        file?: string | undefined;
+                                        line?: number | undefined;
+                                        column?: number | undefined;
+                                    } | undefined;
+                                    links?: {
+                                        [x: string]: import("hono/utils/types").JSONValue;
+                                        url: string;
+                                        name?: string | undefined;
+                                        rel?: string | undefined;
+                                    }[] | undefined;
+                                    extensions?: {
+                                        [x: string]: import("hono/utils/types").JSONValue;
+                                    } | undefined;
+                                }[] | undefined;
+                                extensions?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                } | undefined;
+                            }[] | undefined;
+                            attachments?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                name: string;
+                                id?: string | undefined;
+                                role?: string | undefined;
+                                contentType?: string | undefined;
+                                bundleKey?: string | undefined;
+                                uri?: string | undefined;
+                                text?: string | undefined;
+                                bytes?: number | undefined;
+                                sha256?: string | undefined;
+                                width?: number | undefined;
+                                height?: number | undefined;
+                                durationMs?: number | undefined;
+                                description?: string | undefined;
+                                at?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                    step?: string | undefined;
+                                    offsetMs?: number | undefined;
+                                } | undefined;
+                                poster?: string | undefined;
+                                captions?: string[] | undefined;
+                                extensions?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                } | undefined;
+                            }[] | undefined;
+                            annotations?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                type: string;
+                                message: string;
+                                level?: string | undefined;
+                                at?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                    step?: string | undefined;
+                                    offsetMs?: number | undefined;
+                                } | undefined;
+                                source?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                    file?: string | undefined;
+                                    line?: number | undefined;
+                                    column?: number | undefined;
+                                } | undefined;
+                                links?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                    url: string;
+                                    name?: string | undefined;
+                                    rel?: string | undefined;
+                                }[] | undefined;
+                                extensions?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                } | undefined;
+                            }[] | undefined;
+                            extensions?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                            } | undefined;
+                        }[] | undefined;
+                        steps?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                            name: string;
+                            id?: string | undefined;
+                            parentId?: string | undefined;
+                            kind?: string | undefined;
+                            status?: string | undefined;
+                            offsetMs?: number | undefined;
+                            durationMs?: number | undefined;
+                            detail?: string | undefined;
+                            attachments?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                name: string;
+                                id?: string | undefined;
+                                role?: string | undefined;
+                                contentType?: string | undefined;
+                                bundleKey?: string | undefined;
+                                uri?: string | undefined;
+                                text?: string | undefined;
+                                bytes?: number | undefined;
+                                sha256?: string | undefined;
+                                width?: number | undefined;
+                                height?: number | undefined;
+                                durationMs?: number | undefined;
+                                description?: string | undefined;
+                                at?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                    step?: string | undefined;
+                                    offsetMs?: number | undefined;
+                                } | undefined;
+                                poster?: string | undefined;
+                                captions?: string[] | undefined;
+                                extensions?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                } | undefined;
+                            }[] | undefined;
+                            annotations?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                type: string;
+                                message: string;
+                                level?: string | undefined;
+                                at?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                    step?: string | undefined;
+                                    offsetMs?: number | undefined;
+                                } | undefined;
+                                source?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                    file?: string | undefined;
+                                    line?: number | undefined;
+                                    column?: number | undefined;
+                                } | undefined;
+                                links?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                    url: string;
+                                    name?: string | undefined;
+                                    rel?: string | undefined;
+                                }[] | undefined;
+                                extensions?: {
+                                    [x: string]: import("hono/utils/types").JSONValue;
+                                } | undefined;
+                            }[] | undefined;
+                            extensions?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                            } | undefined;
+                        }[] | undefined;
+                        extensions?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                        } | undefined;
+                        links?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                            url: string;
+                            name?: string | undefined;
+                            rel?: string | undefined;
+                        }[] | undefined;
+                        annotations?: {
+                            [x: string]: import("hono/utils/types").JSONValue;
+                            type: string;
+                            message: string;
+                            level?: string | undefined;
+                            at?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                step?: string | undefined;
+                                offsetMs?: number | undefined;
+                            } | undefined;
+                            source?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                file?: string | undefined;
+                                line?: number | undefined;
+                                column?: number | undefined;
+                            } | undefined;
+                            links?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                                url: string;
+                                name?: string | undefined;
+                                rel?: string | undefined;
+                            }[] | undefined;
+                            extensions?: {
+                                [x: string]: import("hono/utils/types").JSONValue;
+                            } | undefined;
+                        }[] | undefined;
+                        labels?: {
+                            [x: string]: string;
+                        } | undefined;
                         readonly id: string;
                         readonly title: string;
                         readonly status: import('./explorer-types.js').EvidenceStatus;
@@ -67,6 +607,7 @@ export declare function createReportsExplorerApp(deps: ReportsExplorerDeps): imp
                             readonly unit: string;
                             readonly limit?: number | undefined;
                         }[];
+                        readonly durationMs?: number | undefined;
                     }[];
                 }[];
             };

package/dist/reports/src/reports-explorer-route.js

@@ -3,6 +3,17 @@ import { latestParts, readParts, } from './report-parts.js';
 import { isSpecPath, readInventory, readSpecDocument, } from './spec-inventory.js';
 import { Hono } from 'hono';
 const NO_STORE = { 'cache-control': 'no-store' };
+/**
+ * Builds the Hono app for `GET /:sha/explorer` and `GET /:sha/spec`.
+ *
+ * `/:sha/explorer` answers `{ inventory, parts, notice? }` for a 40-hex sha. The inventory is the checkout's when `sha`
+ * is the workspace's, else the local store's, else the shared store's. The parts are the shared store's followed by the
+ * checkout's (or the local store's), reduced to the latest part per producer. If the shared store fails but something
+ * local exists, it answers with a `notice`; with nothing local it throws. 404 for a
+ * bad sha, 503 `reports_unavailable` when there is no shared store and nothing local. `/:sha/spec?path=` answers a
+ * spec's text (`text/plain`) from the workspace, else the local store, else the shared store, or 404 for a bad sha,
+ * a path that is not a spec path, or a missing file. Both are `no-store`.
+ */
 export function createReportsExplorerApp(deps) {
     return new Hono()
         .get('/:sha/explorer', async (c) => {

package/dist/reports/src/reports-list-route.d.ts

@@ -1,5 +1,14 @@
 import type { Context } from 'hono';
 import type { ReportsExplorerDeps } from './reports-explorer-route.js';
+/**
+ * Returns the handler for `GET /`: `{ commits, cursor, evidenceVersions?, workspace?, notice? }`.
+ *
+ * `commits` are the shared store's, 30 per page, continued with `?cursor=`. `evidenceVersions` (first page only) are
+ * the distinct versions found in the shared and local stores. 503 `reports_unavailable` when there is no shared
+ * store, no workspace and no local store. With no shared store it answers no commits and a notice; when listing the
+ * shared store throws and there is a workspace, it answers from the local store with a notice, otherwise the error
+ * propagates. Always `no-store`.
+ */
 export declare function reportsListRoute(deps: ReportsExplorerDeps): (c: Context) => Promise<(Response & import("hono").TypedResponse<{
     error: string;
 }, 503, "json">) | (Response & import("hono").TypedResponse<{

package/dist/reports/src/reports-list-route.js

@@ -1,6 +1,15 @@
 import { listExplorerVersions } from './explorer-versions.js';
 import { listCommits } from './read.js';
 const NO_STORE = { 'cache-control': 'no-store' };
+/**
+ * Returns the handler for `GET /`: `{ commits, cursor, evidenceVersions?, workspace?, notice? }`.
+ *
+ * `commits` are the shared store's, 30 per page, continued with `?cursor=`. `evidenceVersions` (first page only) are
+ * the distinct versions found in the shared and local stores. 503 `reports_unavailable` when there is no shared
+ * store, no workspace and no local store. With no shared store it answers no commits and a notice; when listing the
+ * shared store throws and there is a workspace, it answers from the local store with a notice, otherwise the error
+ * propagates. Always `no-store`.
+ */
 export function reportsListRoute(deps) {
     return async (c) => {
         const workspace = await deps.workspace?.();