modsetter--surfsense/surfsense_backend/app/schemas/reports.py

"""Report schemas for API responses."""

from datetime import datetime
from typing import Any

from pydantic import BaseModel


class ReportBase(BaseModel):
    """Base report schema."""

    title: str
    content: str | None = None
    report_style: str | None = None
    workspace_id: int


class ReportRead(BaseModel):
    """Schema for reading a report (list view, no content)."""

    id: int
    title: str
    report_style: str | None = None
    report_metadata: dict[str, Any] | None = None
    report_group_id: int | None = None
    content_type: str = "markdown"
    thread_id: int | None = None
    created_at: datetime

    class Config:
        from_attributes = True


class ReportVersionInfo(BaseModel):
    """Lightweight version entry for the version switcher UI."""

    id: int
    created_at: datetime

    class Config:
        from_attributes = True


class ReportContentRead(BaseModel):
    """Schema for reading a report with full content (Markdown or Typst)."""

    id: int
    title: str
    content: str | None = None
    content_type: str = "markdown"
    report_metadata: dict[str, Any] | None = None
    report_group_id: int | None = None
    versions: list[ReportVersionInfo] = []

    class Config:
        from_attributes = True


class ReportContentUpdate(BaseModel):
    """Schema for updating a report's Markdown content."""

    content: str