humanish 0.88.2 → 0.89.0

package/dist/study-analysis-validation.d.ts

@@ -0,0 +1,448 @@
+import { z } from "zod";
+import { type StudyAnalysisArtifact, type StudyAnalysisCorrection, type StudyAnalysisInput, type StudyAnalysisResult } from "./study-analysis.js";
+export declare const studyAnalysisResultSchema: z.ZodObject<{
+    summary: z.ZodString;
+    participants: z.ZodArray<z.ZodObject<{
+        streamId: z.ZodString;
+        summary: z.ZodString;
+        intent: z.ZodString;
+        outcome: z.ZodEnum<{
+            blocked: "blocked";
+            abandoned: "abandoned";
+            completed: "completed";
+            unknown: "unknown";
+            interrupted: "interrupted";
+        }>;
+        outcomeReason: z.ZodString;
+        evidenceIds: z.ZodArray<z.ZodString>;
+        feedback: z.ZodArray<z.ZodObject<{
+            evidenceId: z.ZodString;
+            text: z.ZodString;
+        }, z.core.$strict>>;
+        limitations: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>>;
+    findings: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        summary: z.ZodString;
+        impact: z.ZodEnum<{
+            blocked_task: "blocked_task";
+            friction: "friction";
+            recovery: "recovery";
+            uncertain: "uncertain";
+        }>;
+        affectedStreamIds: z.ZodArray<z.ZodString>;
+        exposedStreamIds: z.ZodArray<z.ZodString>;
+        exposureReason: z.ZodString;
+        recovery: z.ZodEnum<{
+            unknown: "unknown";
+            recovered: "recovered";
+            not_observed: "not_observed";
+        }>;
+        confidence: z.ZodEnum<{
+            low: "low";
+            medium: "medium";
+            high: "high";
+        }>;
+        observations: z.ZodArray<z.ZodObject<{
+            claim: z.ZodString;
+            basis: z.ZodEnum<{
+                action: "action";
+                visual: "visual";
+                participant_statement: "participant_statement";
+                inference: "inference";
+            }>;
+            evidenceIds: z.ZodArray<z.ZodString>;
+            limitation: z.ZodString;
+        }, z.core.$strict>>;
+        nextStep: z.ZodString;
+        priorityReason: z.ZodString;
+    }, z.core.$strict>>;
+    limitations: z.ZodArray<z.ZodString>;
+}, z.core.$strict>;
+export declare const studyAnalysisResultJsonSchema: z.core.ZodStandardJSONSchemaPayload<z.ZodObject<{
+    summary: z.ZodString;
+    participants: z.ZodArray<z.ZodObject<{
+        streamId: z.ZodString;
+        summary: z.ZodString;
+        intent: z.ZodString;
+        outcome: z.ZodEnum<{
+            blocked: "blocked";
+            abandoned: "abandoned";
+            completed: "completed";
+            unknown: "unknown";
+            interrupted: "interrupted";
+        }>;
+        outcomeReason: z.ZodString;
+        evidenceIds: z.ZodArray<z.ZodString>;
+        feedback: z.ZodArray<z.ZodObject<{
+            evidenceId: z.ZodString;
+            text: z.ZodString;
+        }, z.core.$strict>>;
+        limitations: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>>;
+    findings: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        summary: z.ZodString;
+        impact: z.ZodEnum<{
+            blocked_task: "blocked_task";
+            friction: "friction";
+            recovery: "recovery";
+            uncertain: "uncertain";
+        }>;
+        affectedStreamIds: z.ZodArray<z.ZodString>;
+        exposedStreamIds: z.ZodArray<z.ZodString>;
+        exposureReason: z.ZodString;
+        recovery: z.ZodEnum<{
+            unknown: "unknown";
+            recovered: "recovered";
+            not_observed: "not_observed";
+        }>;
+        confidence: z.ZodEnum<{
+            low: "low";
+            medium: "medium";
+            high: "high";
+        }>;
+        observations: z.ZodArray<z.ZodObject<{
+            claim: z.ZodString;
+            basis: z.ZodEnum<{
+                action: "action";
+                visual: "visual";
+                participant_statement: "participant_statement";
+                inference: "inference";
+            }>;
+            evidenceIds: z.ZodArray<z.ZodString>;
+            limitation: z.ZodString;
+        }, z.core.$strict>>;
+        nextStep: z.ZodString;
+        priorityReason: z.ZodString;
+    }, z.core.$strict>>;
+    limitations: z.ZodArray<z.ZodString>;
+}, z.core.$strict>>;
+export declare const studyAnalysisCoverageSchema: z.ZodObject<{
+    includedStreamIds: z.ZodArray<z.ZodString>;
+    omittedStreamIds: z.ZodArray<z.ZodString>;
+    evidenceCount: z.ZodNumber;
+    captureCount: z.ZodNumber;
+    complete: z.ZodBoolean;
+    omissions: z.ZodArray<z.ZodString>;
+}, z.core.$strict>;
+export declare const studyAnalysisEvidenceSchema: z.ZodObject<{
+    id: z.ZodString;
+    streamId: z.ZodString;
+    eventId: z.ZodString;
+    kind: z.ZodString;
+    text: z.ZodString;
+    quoteEligible: z.ZodBoolean;
+    at: z.ZodNullable<z.ZodString>;
+    elapsedMs: z.ZodNullable<z.ZodNumber>;
+    frame: z.ZodNullable<z.ZodNumber>;
+    capture: z.ZodNullable<z.ZodObject<{
+        eventId: z.ZodString;
+        path: z.ZodString;
+        sha256: z.ZodString;
+        mimeType: z.ZodEnum<{
+            "image/png": "image/png";
+            "image/jpeg": "image/jpeg";
+            "image/webp": "image/webp";
+        }>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export declare const studyAnalysisParticipantProvenanceSchema: z.ZodObject<{
+    actorStatus: z.ZodNullable<z.ZodEnum<{
+        incomplete: "incomplete";
+        blocked: "blocked";
+        passed: "passed";
+        abandoned: "abandoned";
+        timed_out: "timed_out";
+        failed: "failed";
+    }>>;
+    completionReason: z.ZodNullable<z.ZodEnum<{
+        timed_out: "timed_out";
+        goal_satisfied: "goal_satisfied";
+        turn_completed: "turn_completed";
+        gave_up: "gave_up";
+        blocked_approval: "blocked_approval";
+        budget_reached: "budget_reached";
+        actor_error: "actor_error";
+        step_failed: "step_failed";
+        harness_error: "harness_error";
+    }>>;
+    stopCause: z.ZodNullable<z.ZodEnum<{
+        provider_output_limit: "provider_output_limit";
+        provider_token_limit: "provider_token_limit";
+        time_limit: "time_limit";
+        spend_limit: "spend_limit";
+        study_spend_limit: "study_spend_limit";
+        adapter_limit: "adapter_limit";
+        provider_incomplete: "provider_incomplete";
+        provider_status: "provider_status";
+        harness_aborted: "harness_aborted";
+    }>>;
+    goalSource: z.ZodNullable<z.ZodEnum<{
+        participant_report: "participant_report";
+        condition_matched: "condition_matched";
+        unavailable: "unavailable";
+    }>>;
+    declaredOutcome: z.ZodNullable<z.ZodEnum<{
+        reached: "reached";
+        not_reached: "not_reached";
+        blocked: "blocked";
+    }>>;
+    taskOutcomes: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        taskId: z.ZodString;
+        completed: z.ZodBoolean;
+        observable: z.ZodBoolean;
+        inputsObserved: z.ZodNullable<z.ZodBoolean>;
+        turn: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+export declare const studyAnalysisArtifactSchema: z.ZodObject<{
+    schema: z.ZodLiteral<"humanish.study-analysis.v1">;
+    id: z.ZodString;
+    runId: z.ZodString;
+    status: z.ZodEnum<{
+        failed: "failed";
+        cancelled: "cancelled";
+        complete: "complete";
+        partial: "partial";
+    }>;
+    createdAt: z.ZodString;
+    completedAt: z.ZodString;
+    sourceRunSha256: z.ZodString;
+    inputDigest: z.ZodString;
+    configDigest: z.ZodString;
+    config: z.ZodObject<{
+        model: z.ZodString;
+        question: z.ZodNullable<z.ZodString>;
+        maxCostUsd: z.ZodNumber;
+        timeoutMs: z.ZodNumber;
+        maxOutputTokens: z.ZodNumber;
+    }, z.core.$strict>;
+    promptVersion: z.ZodString;
+    provider: z.ZodLiteral<"openai">;
+    usage: z.ZodObject<{
+        cacheWriteInputTokens: z.ZodNullable<z.ZodNumber>;
+        cachedInputTokens: z.ZodNullable<z.ZodNumber>;
+        usageComplete: z.ZodBoolean;
+        dispatched: z.ZodBoolean;
+        ratesAsOf: z.ZodNullable<z.ZodString>;
+        estimatedAdmissionUsd: z.ZodNullable<z.ZodNumber>;
+        inputTokens: z.ZodNullable<z.ZodNumber>;
+        outputTokens: z.ZodNullable<z.ZodNumber>;
+        estimatedCostUsd: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strict>;
+    participants: z.ZodArray<z.ZodObject<{
+        streamId: z.ZodString;
+        label: z.ZodString;
+        assignment: z.ZodNullable<z.ZodString>;
+        recordedStatus: z.ZodString;
+        recordedReason: z.ZodNullable<z.ZodString>;
+        provenance: z.ZodObject<{
+            actorStatus: z.ZodNullable<z.ZodEnum<{
+                incomplete: "incomplete";
+                blocked: "blocked";
+                passed: "passed";
+                abandoned: "abandoned";
+                timed_out: "timed_out";
+                failed: "failed";
+            }>>;
+            completionReason: z.ZodNullable<z.ZodEnum<{
+                timed_out: "timed_out";
+                goal_satisfied: "goal_satisfied";
+                turn_completed: "turn_completed";
+                gave_up: "gave_up";
+                blocked_approval: "blocked_approval";
+                budget_reached: "budget_reached";
+                actor_error: "actor_error";
+                step_failed: "step_failed";
+                harness_error: "harness_error";
+            }>>;
+            stopCause: z.ZodNullable<z.ZodEnum<{
+                provider_output_limit: "provider_output_limit";
+                provider_token_limit: "provider_token_limit";
+                time_limit: "time_limit";
+                spend_limit: "spend_limit";
+                study_spend_limit: "study_spend_limit";
+                adapter_limit: "adapter_limit";
+                provider_incomplete: "provider_incomplete";
+                provider_status: "provider_status";
+                harness_aborted: "harness_aborted";
+            }>>;
+            goalSource: z.ZodNullable<z.ZodEnum<{
+                participant_report: "participant_report";
+                condition_matched: "condition_matched";
+                unavailable: "unavailable";
+            }>>;
+            declaredOutcome: z.ZodNullable<z.ZodEnum<{
+                reached: "reached";
+                not_reached: "not_reached";
+                blocked: "blocked";
+            }>>;
+            taskOutcomes: z.ZodNullable<z.ZodArray<z.ZodObject<{
+                taskId: z.ZodString;
+                completed: z.ZodBoolean;
+                observable: z.ZodBoolean;
+                inputsObserved: z.ZodNullable<z.ZodBoolean>;
+                turn: z.ZodNullable<z.ZodNumber>;
+            }, z.core.$strict>>>;
+        }, z.core.$strict>;
+    }, z.core.$strict>>;
+    coverage: z.ZodObject<{
+        includedStreamIds: z.ZodArray<z.ZodString>;
+        omittedStreamIds: z.ZodArray<z.ZodString>;
+        evidenceCount: z.ZodNumber;
+        captureCount: z.ZodNumber;
+        complete: z.ZodBoolean;
+        omissions: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>;
+    evidence: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        streamId: z.ZodString;
+        eventId: z.ZodString;
+        kind: z.ZodString;
+        text: z.ZodString;
+        quoteEligible: z.ZodBoolean;
+        at: z.ZodNullable<z.ZodString>;
+        elapsedMs: z.ZodNullable<z.ZodNumber>;
+        frame: z.ZodNullable<z.ZodNumber>;
+        capture: z.ZodNullable<z.ZodObject<{
+            eventId: z.ZodString;
+            path: z.ZodString;
+            sha256: z.ZodString;
+            mimeType: z.ZodEnum<{
+                "image/png": "image/png";
+                "image/jpeg": "image/jpeg";
+                "image/webp": "image/webp";
+            }>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    result: z.ZodNullable<z.ZodObject<{
+        summary: z.ZodString;
+        participants: z.ZodArray<z.ZodObject<{
+            streamId: z.ZodString;
+            summary: z.ZodString;
+            intent: z.ZodString;
+            outcome: z.ZodEnum<{
+                blocked: "blocked";
+                abandoned: "abandoned";
+                completed: "completed";
+                unknown: "unknown";
+                interrupted: "interrupted";
+            }>;
+            outcomeReason: z.ZodString;
+            evidenceIds: z.ZodArray<z.ZodString>;
+            feedback: z.ZodArray<z.ZodObject<{
+                evidenceId: z.ZodString;
+                text: z.ZodString;
+            }, z.core.$strict>>;
+            limitations: z.ZodArray<z.ZodString>;
+        }, z.core.$strict>>;
+        findings: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodString;
+            summary: z.ZodString;
+            impact: z.ZodEnum<{
+                blocked_task: "blocked_task";
+                friction: "friction";
+                recovery: "recovery";
+                uncertain: "uncertain";
+            }>;
+            affectedStreamIds: z.ZodArray<z.ZodString>;
+            exposedStreamIds: z.ZodArray<z.ZodString>;
+            exposureReason: z.ZodString;
+            recovery: z.ZodEnum<{
+                unknown: "unknown";
+                recovered: "recovered";
+                not_observed: "not_observed";
+            }>;
+            confidence: z.ZodEnum<{
+                low: "low";
+                medium: "medium";
+                high: "high";
+            }>;
+            observations: z.ZodArray<z.ZodObject<{
+                claim: z.ZodString;
+                basis: z.ZodEnum<{
+                    action: "action";
+                    visual: "visual";
+                    participant_statement: "participant_statement";
+                    inference: "inference";
+                }>;
+                evidenceIds: z.ZodArray<z.ZodString>;
+                limitation: z.ZodString;
+            }, z.core.$strict>>;
+            nextStep: z.ZodString;
+            priorityReason: z.ZodString;
+        }, z.core.$strict>>;
+        limitations: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>>;
+    error: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export declare const studyAnalysisCorrectionSchema: z.ZodObject<{
+    schema: z.ZodLiteral<"humanish.study-analysis-correction.v1">;
+    id: z.ZodString;
+    analysisId: z.ZodString;
+    analysisSha256: z.ZodString;
+    findingId: z.ZodString;
+    findingSha256: z.ZodString;
+    createdAt: z.ZodString;
+    status: z.ZodEnum<{
+        confirmed: "confirmed";
+        dismissed: "dismissed";
+        amended: "amended";
+    }>;
+    reason: z.ZodString;
+    replacementClaim: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+/** Stable hashing is independent of object insertion order and excludes no fields implicitly. */
+export declare function hashStudyAnalysisValue(value: unknown): string;
+export declare function digestStudyAnalysisInput(input: Pick<StudyAnalysisInput, "runId" | "sourceRunSha256" | "participants" | "coverage" | "evidence">): string;
+export declare function checkAnalysisResult(input: StudyAnalysisInput, value: unknown): {
+    ok: true;
+    result: StudyAnalysisResult;
+} | {
+    ok: false;
+    errors: string[];
+};
+export declare function validateAnalysisResult(input: StudyAnalysisInput, value: unknown): StudyAnalysisResult;
+export declare function validateStudyAnalysisArtifact(value: unknown): StudyAnalysisArtifact;
+export declare function validateStudyAnalysisCorrection(value: unknown): StudyAnalysisCorrection;
+/** Accounting survives a stale source without retaining generated or participant text. */
+export declare const studyAnalysisExecutionReceiptSchema: z.ZodObject<{
+    usage: z.ZodObject<{
+        cacheWriteInputTokens: z.ZodNullable<z.ZodNumber>;
+        cachedInputTokens: z.ZodNullable<z.ZodNumber>;
+        usageComplete: z.ZodBoolean;
+        dispatched: z.ZodBoolean;
+        ratesAsOf: z.ZodNullable<z.ZodString>;
+        estimatedAdmissionUsd: z.ZodNullable<z.ZodNumber>;
+        inputTokens: z.ZodNullable<z.ZodNumber>;
+        outputTokens: z.ZodNullable<z.ZodNumber>;
+        estimatedCostUsd: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strict>;
+    provider: z.ZodLiteral<"openai">;
+    error: z.ZodNullable<z.ZodString>;
+    status: z.ZodEnum<{
+        failed: "failed";
+        cancelled: "cancelled";
+        complete: "complete";
+        partial: "partial";
+    }>;
+    id: z.ZodString;
+    completedAt: z.ZodString;
+    runId: z.ZodString;
+    createdAt: z.ZodString;
+    sourceRunSha256: z.ZodString;
+    inputDigest: z.ZodString;
+    configDigest: z.ZodString;
+    promptVersion: z.ZodString;
+    schema: z.ZodLiteral<"humanish.analysis-execution.v1">;
+    model: z.ZodString;
+    maxCostUsd: z.ZodNumber;
+}, z.core.$strict>;
+export type StudyAnalysisExecutionReceipt = z.infer<typeof studyAnalysisExecutionReceiptSchema>;
+export declare function validateStudyAnalysisExecutionReceipt(value: unknown): StudyAnalysisExecutionReceipt;
+/** Validate the packet before any paid request, including typed-library callers. */
+export declare function validateStudyAnalysisInputMetadata(input: StudyAnalysisInput): void;