"""Pydantic models for the documentation cross-coverage scanner."""

from pydantic import BaseModel, ConfigDict, Field


class SurfaceResult(BaseModel):
    """Result of a single documentation surface check for a command."""

    model_config = ConfigDict(frozen=True, extra="forbid")

    surface: str = Field(
        ...,
        description=(
            "Surface name (manpage, index_entry, operator_runbook, governance_runbook, docstring)"
        ),
    )
    passed: bool = Field(..., description="Whether the surface check passed")
    detail: str = Field(..., description="Explanation of the check result")


class CommandCoverage(BaseModel):
    """Documentation coverage results for a single CLI command."""

    model_config = ConfigDict(frozen=True, extra="forbid")

    command: str = Field(..., description="CLI command name as discovered (e.g. 'adr status')")
    surfaces: list[SurfaceResult] = Field(
        ..., description="Results for all five documentation surfaces"
    )
    all_passed: bool = Field(..., description="True when all surfaces pass")


class OrphanedDoc(BaseModel):
    """A documentation reference that points to a removed command."""

    model_config = ConfigDict(frozen=True, extra="forbid")

    surface: str = Field(..., description="Which surface has the orphan")
    reference: str = Field(..., description="The orphaned reference (file path or key)")
    detail: str = Field(..., description="Explanation of why this is orphaned")


class CoverageReport(BaseModel):
    """Aggregate documentation coverage report across all CLI commands."""

    model_config = ConfigDict(frozen=True, extra="forbid")

    commands_discovered: int = Field(..., description="Total CLI commands found by AST scanning")
    commands_fully_covered: int = Field(..., description="Commands with all five surfaces passing")
    commands_with_gaps: int = Field(..., description="Commands missing at least one surface")
    coverage: list[CommandCoverage] = Field(..., description="Per-command coverage results")
    orphaned: list[OrphanedDoc] = Field(
        ..., description="Documentation referencing removed commands"
    )
    passed: bool = Field(..., description="True only when no gaps and no orphans")


class GapItem(BaseModel):
    """A single documentation gap: a required surface that is missing."""

    model_config = ConfigDict(frozen=True, extra="forbid")

    command: str = Field(..., description="CLI command name")
    surface: str = Field(..., description="Missing surface name")
    detail: str = Field(..., description="Explanation of what is missing")


class OrphanedDocItem(BaseModel):
    """Serialisable orphaned doc entry for the gap report."""

    model_config = ConfigDict(frozen=True, extra="forbid")

    surface: str = Field(..., description="Which surface has the orphan")
    reference: str = Field(..., description="The orphaned reference (file path or key)")
    detail: str = Field(..., description="Explanation of why this is orphaned")


class DocCoverageGapReport(BaseModel):
    """Manifest-aware gap report produced by the doc-coverage chore runner."""

    model_config = ConfigDict(frozen=True, extra="forbid")

    passed: bool = Field(..., description="True when no gaps, no undeclared, no orphans")
    commands_discovered: int = Field(..., description="Total commands found by AST scanning")
    commands_checked: int = Field(..., description="Commands with manifest entries")
    commands_with_gaps: int = Field(..., description="Commands missing required surfaces")
    gaps: list[GapItem] = Field(..., description="Individual documentation gaps")
    undeclared_commands: list[str] = Field(
        ..., description="Commands discovered but not declared in manifest"
    )
    orphaned_docs: list[OrphanedDocItem] = Field(
        ..., description="Documentation referencing removed commands"
    )
