Files
webref/backend/app/boards/schemas.py
Danilo Reyes c68a6a7d01 phase 14
2025-11-02 15:05:18 -06:00

155 lines
5.0 KiB
Python

"""Board Pydantic schemas for request/response validation."""
from datetime import datetime
from uuid import UUID
from pydantic import BaseModel, ConfigDict, Field, field_validator
class ViewportState(BaseModel):
"""Viewport state for canvas position and zoom."""
x: float = Field(default=0, description="Horizontal pan position")
y: float = Field(default=0, description="Vertical pan position")
zoom: float = Field(default=1.0, ge=0.1, le=5.0, description="Zoom level (0.1 to 5.0)")
rotation: float = Field(default=0, ge=0, le=360, description="Canvas rotation in degrees (0 to 360)")
class BoardCreate(BaseModel):
"""Schema for creating a new board."""
title: str = Field(..., min_length=1, max_length=255, description="Board title")
description: str | None = Field(default=None, description="Optional board description")
class ViewportStateUpdate(BaseModel):
"""Schema for updating viewport state only."""
x: float = Field(..., description="Horizontal pan position")
y: float = Field(..., description="Vertical pan position")
zoom: float = Field(..., ge=0.1, le=5.0, description="Zoom level (0.1 to 5.0)")
rotation: float = Field(..., ge=0, le=360, description="Canvas rotation in degrees (0 to 360)")
class BoardUpdate(BaseModel):
"""Schema for updating board metadata."""
title: str | None = Field(None, min_length=1, max_length=255, description="Board title")
description: str | None = Field(None, description="Board description")
viewport_state: ViewportState | None = Field(None, description="Viewport state")
class BoardSummary(BaseModel):
"""Summary schema for board list view."""
model_config = ConfigDict(from_attributes=True)
id: UUID
title: str
description: str | None = None
image_count: int = Field(default=0, description="Number of images on board")
thumbnail_url: str | None = Field(default=None, description="URL to board thumbnail")
created_at: datetime
updated_at: datetime
class BoardDetail(BaseModel):
"""Detailed schema for single board view with all data."""
model_config = ConfigDict(from_attributes=True)
id: UUID
user_id: UUID
title: str
description: str | None = None
viewport_state: ViewportState
created_at: datetime
updated_at: datetime
is_deleted: bool = False
@field_validator("viewport_state", mode="before")
@classmethod
def convert_viewport_state(cls, v):
"""Convert dict to ViewportState if needed."""
if isinstance(v, dict):
return ViewportState(**v)
return v
class GroupCreate(BaseModel):
"""Schema for creating a new group."""
name: str = Field(..., min_length=1, max_length=255, description="Group name")
color: str = Field(..., pattern=r"^#[0-9A-Fa-f]{6}$", description="Hex color code (#RRGGBB)")
annotation: str | None = Field(None, max_length=10000, description="Optional text annotation")
image_ids: list[UUID] = Field(..., min_items=1, description="List of image IDs to include in group")
class GroupUpdate(BaseModel):
"""Schema for updating group metadata."""
name: str | None = Field(None, min_length=1, max_length=255, description="Group name")
color: str | None = Field(None, pattern=r"^#[0-9A-Fa-f]{6}$", description="Hex color code")
annotation: str | None = Field(None, max_length=10000, description="Text annotation")
class GroupResponse(BaseModel):
"""Response schema for group with member count."""
model_config = ConfigDict(from_attributes=True)
id: UUID
board_id: UUID
name: str
color: str
annotation: str | None = None
member_count: int = Field(default=0, description="Number of images in group")
created_at: datetime
updated_at: datetime
class ShareLinkCreate(BaseModel):
"""Schema for creating a new share link."""
permission_level: str = Field(..., pattern=r"^(view-only|view-comment)$", description="Permission level")
expires_at: datetime | None = Field(None, description="Optional expiration datetime")
class ShareLinkResponse(BaseModel):
"""Response schema for share link."""
model_config = ConfigDict(from_attributes=True)
id: UUID
board_id: UUID
token: str
permission_level: str
created_at: datetime
expires_at: datetime | None = None
last_accessed_at: datetime | None = None
access_count: int = 0
is_revoked: bool = False
class CommentCreate(BaseModel):
"""Schema for creating a new comment."""
author_name: str = Field(..., min_length=1, max_length=100, description="Commenter name")
content: str = Field(..., min_length=1, max_length=5000, description="Comment text")
position: dict | None = Field(None, description="Optional canvas position {x, y}")
class CommentResponse(BaseModel):
"""Response schema for comment."""
model_config = ConfigDict(from_attributes=True)
id: UUID
board_id: UUID
share_link_id: UUID | None = None
author_name: str
content: str
position: dict | None = None
created_at: datetime
is_deleted: bool = False