agent-scenario-loop 0.1.0

package/dist/runner/live-proof-summary.d.ts

@@ -0,0 +1,263 @@
+type LiveProofPlatform = 'android' | 'ios';
+type LiveProofProfilePointer = {
+    healthStatus?: string;
+    label: string;
+    runDir: string;
+    runId: string;
+    scenarioId: string;
+    verdictStatus?: string;
+};
+type LiveProofInteractionProofPointer = {
+    captures?: LiveProofInteractionProofCaptures;
+    healthStatus?: string;
+    label: string;
+    runDir: string;
+    runId: string;
+    runnerId: string;
+    scenarioId: string;
+    warnings?: LiveProofInteractionProofWarnings;
+    verdictStatus?: string;
+};
+type LiveProofSkippedInteractionProofPointer = {
+    label: string;
+    nextAction: {
+        code: string;
+        summary: string;
+    };
+    reason: string;
+    runId: string;
+    runnerId: string;
+    scenarioId: string;
+};
+type LiveProofInteractionProofCaptures = {
+    screenshots: string[];
+};
+type LiveProofInteractionProofWarning = {
+    code: string;
+    message: string;
+    name: string;
+    nextAction?: {
+        code: string;
+        summary: string;
+    };
+};
+type LiveProofInteractionProofWarnings = {
+    checks: LiveProofInteractionProofWarning[];
+    count: number;
+};
+type LiveProofComparisonPointer = {
+    baselineDir: string | null;
+    comparisonDir: string | null;
+    label: string;
+    metricSummary?: LiveProofComparisonMetricSummary;
+    reason: string | null;
+    runId: string;
+    scenarioId: string;
+    status: 'better' | 'worse' | 'unchanged' | 'mixed' | 'inconclusive' | 'skipped';
+    summaryPath: string | null;
+};
+type LiveProofComparisonMetricStatus = 'better' | 'worse' | 'unchanged' | 'inconclusive';
+type LiveProofComparisonMetricSummary = {
+    counts: Record<LiveProofComparisonMetricStatus, number>;
+    notableMetrics: Array<{
+        baseline: number | boolean | null;
+        current: number | boolean | null;
+        delta: number | null;
+        name: string;
+        status: Exclude<LiveProofComparisonMetricStatus, 'unchanged'>;
+        unit: string;
+    }>;
+};
+type LiveProofArtifact = {
+    comparisons: LiveProofComparisonPointer[];
+    comparisonCounts: LiveProofComparisonCounts;
+    comparisonStatus: LiveProofComparisonStatus;
+    nextAction: LiveProofNextAction;
+    outputDir: string;
+    platform: LiveProofPlatform;
+    interactionProofs?: Array<LiveProofInteractionProofPointer & {
+        summaryPath: string;
+    }>;
+    skippedInteractionProofs?: LiveProofSkippedInteractionProofPointer[];
+    preflight: {
+        healthStatus: string;
+        runDir: string;
+        runId: string;
+        summaryPath: string;
+        verdictStatus: string;
+    };
+    profiles: Array<LiveProofProfilePointer & {
+        summaryPath: string;
+    }>;
+    runId: string;
+    schemaVersion: '1.0.0';
+    status: 'passed' | 'failed';
+    summary: string;
+};
+type LiveProofComparisonStatus = ('baseline_missing' | 'improved' | 'inconclusive' | 'mixed' | 'not_compared' | 'regressed' | 'unchanged');
+type LiveProofComparisonCounts = {
+    better: number;
+    inconclusive: number;
+    mixed: number;
+    skipped: number;
+    unchanged: number;
+    worse: number;
+};
+type LiveProofNextAction = {
+    code: 'establish_baseline' | 'inspect_failed_run' | 'inspect_inconclusive' | 'inspect_mixed' | 'inspect_regressions' | 'inspect_summary';
+    summary: string;
+};
+type LiveProofSummaryResult = {
+    liveProofDir: string;
+    liveProofPath: string;
+    summaryPath: string;
+};
+type WriteLiveProofSummaryOptions = {
+    comparisons: LiveProofComparisonPointer[];
+    interactionProofs?: LiveProofInteractionProofPointer[];
+    outputDir: string;
+    platform: LiveProofPlatform;
+    preflightDir: string;
+    preflightRunId: string;
+    profiles: LiveProofProfilePointer[];
+    runId: string;
+    skippedInteractionProofs?: LiveProofSkippedInteractionProofPointer[];
+};
+/**
+ * Reads the profile run status fields that agents need at the aggregate entrypoint.
+ *
+ * @param {string} runDir
+ * @returns {{healthStatus: string, verdictStatus: string}}
+ */
+declare function readProfileRunStatus(runDir: string): {
+    healthStatus: string;
+    verdictStatus: string;
+};
+/**
+ * Reads capture inventory from a sidecar interaction proof when available.
+ *
+ * @param {string} runDir
+ * @returns {LiveProofInteractionProofCaptures | null}
+ */
+declare function readInteractionProofCaptures(runDir: string): LiveProofInteractionProofCaptures | null;
+/**
+ * Reads warning checks from a sidecar interaction proof health artifact.
+ *
+ * @param {string} runDir
+ * @returns {LiveProofInteractionProofWarnings | null}
+ */
+declare function readInteractionProofWarnings(runDir: string): LiveProofInteractionProofWarnings | null;
+/**
+ * Builds a compact summary sentence for an aggregate live proof.
+ *
+ * @param {{platform: string, profileCount: number, comparisonCount: number}} options
+ * @returns {string}
+ */
+declare function buildLiveProofSummary({ comparisonCount, comparisonStatus, failedInteractionProofCount, failedProfileCount, interactionProofCount, interactionWarningCount, platform, profileCount, skippedInteractionProofCount, status, }: {
+    comparisonCount: number;
+    comparisonStatus: LiveProofComparisonStatus;
+    failedInteractionProofCount?: number;
+    failedProfileCount?: number;
+    interactionProofCount?: number;
+    interactionWarningCount?: number;
+    platform: string;
+    profileCount: number;
+    skippedInteractionProofCount?: number;
+    status?: 'failed' | 'passed';
+}): string;
+/**
+ * Collapses per-scenario comparison results into one batch status.
+ *
+ * @param {LiveProofComparisonPointer[]} comparisons
+ * @returns {LiveProofComparisonStatus}
+ */
+declare function buildLiveProofComparisonStatus(comparisons: LiveProofComparisonPointer[]): LiveProofComparisonStatus;
+/**
+ * Counts per-scenario comparison outcomes for agent-readable aggregate summaries.
+ *
+ * @param {LiveProofComparisonPointer[]} comparisons
+ * @returns {LiveProofComparisonCounts}
+ */
+declare function buildLiveProofComparisonCounts(comparisons: LiveProofComparisonPointer[]): LiveProofComparisonCounts;
+/**
+ * Builds the next action an agent should take after reading the batch proof.
+ *
+ * @param {LiveProofComparisonStatus} comparisonStatus
+ * @returns {LiveProofNextAction}
+ */
+declare function buildLiveProofNextAction(comparisonStatus: LiveProofComparisonStatus, status?: 'failed' | 'passed'): LiveProofNextAction;
+/**
+ * Reports whether a referenced run is healthy enough to trust as proof.
+ *
+ * @param {{healthStatus?: string, verdictStatus?: string}} status
+ * @returns {boolean}
+ */
+declare function isTrustedLiveRunStatus(status: {
+    healthStatus?: string;
+    verdictStatus?: string;
+}): boolean;
+/**
+ * Derives the aggregate live-proof status from the linked evidence pointers.
+ *
+ * @param {{preflight: {healthStatus?: string, verdictStatus?: string}, profiles: Array<{healthStatus?: string, verdictStatus?: string}>, interactionProofs: Array<{healthStatus?: string, verdictStatus?: string}>, skippedInteractionProofCount?: number}} options
+ * @returns {'failed' | 'passed'}
+ */
+declare function buildLiveProofStatus({ interactionProofs, preflight, profiles, skippedInteractionProofCount, }: {
+    interactionProofs: Array<{
+        healthStatus?: string;
+        verdictStatus?: string;
+    }>;
+    preflight: {
+        healthStatus?: string;
+        verdictStatus?: string;
+    };
+    profiles: Array<{
+        healthStatus?: string;
+        verdictStatus?: string;
+    }>;
+    skippedInteractionProofCount?: number;
+}): 'failed' | 'passed';
+/**
+ * Formats compact metric counts and highlights for one comparison pointer.
+ *
+ * @param {LiveProofComparisonPointer} comparison
+ * @returns {string}
+ */
+declare function formatComparisonMetricSummary(comparison: LiveProofComparisonPointer): string;
+/**
+ * Formats sidecar capture inventory for aggregate markdown.
+ *
+ * @param {LiveProofInteractionProofPointer} proof
+ * @returns {string}
+ */
+declare function formatInteractionProofCaptures(proof: LiveProofInteractionProofPointer): string;
+/**
+ * Formats sidecar warnings for aggregate markdown.
+ *
+ * @param {LiveProofInteractionProofPointer} proof
+ * @returns {string}
+ */
+declare function formatInteractionProofWarnings(proof: LiveProofInteractionProofPointer): string;
+/**
+ * Formats sidecar warning details for aggregate markdown.
+ *
+ * @param {LiveProofInteractionProofPointer} proof
+ * @returns {string[]}
+ */
+declare function formatInteractionProofWarningDetails(proof: LiveProofInteractionProofPointer): string[];
+/**
+ * Builds markdown for the aggregate live proof entrypoint.
+ *
+ * @param {LiveProofArtifact} artifact
+ * @returns {string}
+ */
+declare function buildLiveProofMarkdown(artifact: LiveProofArtifact): string;
+/**
+ * Writes schema-validated aggregate live proof artifacts.
+ *
+ * @param {WriteLiveProofSummaryOptions} options
+ * @returns {Promise<LiveProofSummaryResult>}
+ */
+declare function writeLiveProofSummary({ comparisons, interactionProofs, outputDir, platform, preflightDir, preflightRunId, profiles, runId, skippedInteractionProofs, }: WriteLiveProofSummaryOptions): Promise<LiveProofSummaryResult>;
+export { buildLiveProofComparisonCounts, buildLiveProofComparisonStatus, buildLiveProofMarkdown, buildLiveProofNextAction, buildLiveProofSummary, buildLiveProofStatus, formatComparisonMetricSummary, formatInteractionProofCaptures, formatInteractionProofWarningDetails, formatInteractionProofWarnings, isTrustedLiveRunStatus, readInteractionProofCaptures, readInteractionProofWarnings, readProfileRunStatus, writeLiveProofSummary, };
+export type { LiveProofArtifact, LiveProofComparisonCounts, LiveProofComparisonMetricSummary, LiveProofComparisonPointer, LiveProofComparisonStatus, LiveProofInteractionProofCaptures, LiveProofInteractionProofPointer, LiveProofNextAction, LiveProofPlatform, LiveProofProfilePointer, LiveProofSkippedInteractionProofPointer, LiveProofSummaryResult, WriteLiveProofSummaryOptions, };