@yiaany/ghostapi 0.1.7 → 0.1.8

package/dist/evidence/report.d.ts

@@ -0,0 +1,143 @@
+import { type GhostApiPolicy } from "../policy/index.js";
+import type { ProxyEvent } from "../server/eventsStore.js";
+import { type ContractDiff } from "../contracts/index.js";
+export type EvidenceFindingSeverity = "pass" | "warning" | "fail";
+export type EvidenceFinding = {
+    id: string;
+    severity: EvidenceFindingSeverity;
+    message: string;
+    count?: number;
+};
+export type EvidenceReport = {
+    schemaVersion: 1;
+    artifact: {
+        generatedAt: string;
+        logicalHash: string;
+        canonicalization: "json-stable-sorted-keys-v1";
+    };
+    run: {
+        id: string;
+        status: "unknown" | "preparing" | "running" | "failed-to-start" | "finished";
+        startedAt?: string;
+        finishedAt?: string;
+        exitCode?: number;
+    };
+    ghostapi: {
+        version: string;
+    };
+    enforcement: {
+        capability: string;
+        mode: "linux-network-namespace" | "proxy-guidance" | "unknown";
+        isolated: boolean;
+        degraded: boolean;
+    };
+    policy: {
+        hash?: string;
+        requiredScenarios: string[];
+    };
+    coverage: {
+        providers: string[];
+        scenarios: string[];
+    };
+    contractDrift?: {
+        baselineHash?: string;
+        candidateHash?: string;
+        breaking: number;
+        nonBreaking: number;
+        uncertain: number;
+    };
+    egress: {
+        allowedAttempts: Array<{
+            provider: string;
+            method: string;
+            path: string;
+            statusCode: number;
+            source: string;
+        }>;
+        blockedAttempts: Array<{
+            host: string;
+            reason: string;
+        }>;
+        productionAttempts: number;
+    };
+    secrets: {
+        categories: string[];
+        matches: number;
+    };
+    retriesAndFailures: {
+        retryCount: number;
+        failureCount: number;
+        failures: Array<{
+            provider: string;
+            method: string;
+            path: string;
+            statusCode: number;
+        }>;
+    };
+    findings: EvidenceFinding[];
+    warnings: string[];
+    summary: {
+        passed: boolean;
+        failCount: number;
+        warningCount: number;
+    };
+};
+export type EvidenceGenerateOptions = {
+    projectRoot?: string;
+    policyPath?: string;
+    runPath?: string;
+    outPath?: string;
+    contractBaselinePath?: string;
+    contractCandidatePath?: string;
+    generatedAt?: string;
+    ghostApiVersion?: string;
+};
+export type EvidenceCompareResult = {
+    equal: boolean;
+    leftHash: string;
+    rightHash: string;
+    differences: string[];
+};
+type RunEvidence = {
+    schemaVersion?: unknown;
+    runId?: unknown;
+    backend?: unknown;
+    status?: unknown;
+    policy?: {
+        policyHash?: unknown;
+        requiredScenarios?: unknown;
+    };
+    events?: Array<{
+        type?: unknown;
+        timestamp?: unknown;
+        exitCode?: unknown;
+    }>;
+    output?: {
+        secretMatches?: unknown;
+        limitExceeded?: unknown;
+        timedOut?: unknown;
+    };
+};
+export declare class EvidenceReportError extends Error {
+    constructor(message: string);
+}
+export declare function generateEvidenceReport(options?: EvidenceGenerateOptions): Promise<{
+    report: EvidenceReport;
+    path: string;
+}>;
+export declare function buildEvidenceReport(input: {
+    events: ProxyEvent[];
+    policy?: GhostApiPolicy;
+    policyHash?: string;
+    requiredScenarios?: string[];
+    runEvidence?: RunEvidence | null;
+    contractDiff?: ContractDiff;
+    generatedAt: string;
+    ghostApiVersion?: string;
+}): EvidenceReport;
+export declare function loadEvidenceReport(path: string, projectRoot?: string): Promise<EvidenceReport>;
+export declare function validateEvidenceReport(value: unknown): EvidenceReport;
+export declare function formatEvidenceReport(report: EvidenceReport): string;
+export declare function compareEvidenceReports(left: EvidenceReport, right: EvidenceReport): EvidenceCompareResult;
+export declare function formatEvidenceCompare(result: EvidenceCompareResult): string;
+export {};