Files
paper-doc/backend/app/schemas/template.py
T
govin 199e328b48 refactor: call a heading a title, and its use a placement
`template_field_library` and `template_field` were one word apart and meant
opposite kinds of thing — a catalogue of rows versus one row — and neither name
said what a row actually is. Every row of the library is a **heading**: a piece
of text like 「1. Introduction」 with a level and typography, which is what the
reader sees at the top of a paragraph; and every row of the join table is that
heading *placed* in a template, `sort` included.

    template_field_library  -> template_title
    template_field          -> template_title_placement
    field_id (the column)   -> title_id
    TemplateFieldLibrary    -> TemplateTitle
    TemplateField           -> TemplateTitlePlacement

The join table keeps its own name rather than becoming `_link`, because it is
not a bare link: it carries `sort`, the only place display order is stored, and
it deliberately allows the same title twice in one template. `_link` would
describe two foreign keys and hide the column the ordering rule rests on.

Carried through every level, because a half-renamed layer is how the confusing
pair got there in the first place: HTTP paths (`/template-field-library` ->
`/template-titles`), the template payload (`fields`/`field_id` ->
`placements`/`title_id`, and `field_count` -> `placement_count`), the Pydantic
schemas, the CRUD modules, the seed script, the frontend API module and types,
and `docs/OVERVIEW.md`, which now states the naming rules outright.

Two deliberate exceptions:

* `paper_template_filed_sort` is untouched — it is a column of the paper module
  and is spelled as the feature was specified.
* The MCP tools keep their agent-facing names (`field_list`, `field_ids`, and
  the `fields`/`field_id` keys in their responses). Agents already call them by
  those names; the storage names they read underneath have changed.

The migration renames in place (data preserved: 4 templates, 45 titles, 63
placements) and is written to tolerate a database where part of it already ran,
which is not hypothetical — the first attempt renamed the tables and then failed
on the column, because Alembic's MySQL dialect wants an explicit type for
`alter_column` and will not rename a column without one. TiDB carries the
foreign key along with both the renamed table and the renamed column, rehearsed
against the cluster first, and it stays enforced.

Verified: seed re-runs clean, the paper smoke test's 45 checks and the MCP
smoke test's 47 pass, `vue-tsc` and the build are clean, and the UI was driven
in a headless browser through the template list, its preview drawer, the title
library page, the template form (which now posts `placements` with `title_id`)
and the paper document with no console errors.
2026-09-22 16:55:02 +08:00

127 lines
3.8 KiB
Python

"""Request/response schemas for templates (模板管理)."""
from datetime import datetime
from decimal import Decimal
from pydantic import BaseModel, ConfigDict, Field
from app.models.template import Template
from app.models.template_title_placement import TemplateTitlePlacement
from app.schemas.common import TypographyMixin
class TemplateTitlePlacementInput(BaseModel):
"""One placement of a library title inside a template.
The client sends the whole ordered selection on create and on update; the
server replaces the stored rows with it. ``sort`` is a plain ascending
integer and is the *only* thing that decides render order.
"""
title_id: int
sort: int = Field(default=0, ge=-1_000_000, le=1_000_000)
class TemplateTitlePlacementRead(TypographyMixin, BaseModel):
"""A template's placement, flattened with the library row it points at.
Persistence keeps the two apart — a placement row plus the library row it
references — but a client rendering an outline wants one flat record, so
the typography is denormalised into the response. That is also what keeps
the outline in sync: there is only ever one copy of a title's name and
styling, in the library.
"""
id: int
title_id: int
sort: int
name: str
level: int
font_size: Decimal
font_color: str
@classmethod
def from_model(cls, item: TemplateTitlePlacement) -> "TemplateTitlePlacementRead":
"""Flatten a placement row and its library row into one record."""
return cls(
id=item.id,
title_id=item.title_id,
sort=item.sort,
name=item.title.name,
level=item.title.level,
font_size=item.title.font_size,
font_color=item.title.font_color,
)
class TemplateBase(BaseModel):
"""Shared body of the create/update payloads."""
name: str = Field(min_length=1, max_length=255)
abstract: str | None = None
class TemplateCreate(TemplateBase):
"""Payload for ``POST /templates``.
The selection is free: any subset, any order, repeats allowed. The server
stores it as given and orders it by ``sort`` on read.
"""
placements: list[TemplateTitlePlacementInput] = Field(default_factory=list)
class TemplateUpdate(BaseModel):
"""Payload for ``PATCH /templates/{id}``.
``placements`` is a full replacement when present — omit it to leave the
selection untouched.
"""
name: str | None = Field(default=None, min_length=1, max_length=255)
abstract: str | None = None
placements: list[TemplateTitlePlacementInput] | None = None
class TemplateListItem(BaseModel):
"""A template as it appears in the list table — no placement rows."""
model_config = ConfigDict(from_attributes=True)
id: int
name: str
abstract: str | None
placement_count: int
created_at: datetime
updated_at: datetime
class TemplateRead(BaseModel):
"""A template with its outline, already ordered by ``sort``."""
model_config = ConfigDict(from_attributes=True)
id: int
name: str
abstract: str | None
#: The outline, ordered by ``sort`` — the ORM relationship sets that
#: ordering, so this list is display-ready with no client-side sorting.
placements: list[TemplateTitlePlacementRead]
created_at: datetime
updated_at: datetime
@classmethod
def from_model(cls, template: Template) -> "TemplateRead":
"""Build the response from a template and its placement rows."""
return cls(
id=template.id,
name=template.name,
abstract=template.abstract,
placements=[
TemplateTitlePlacementRead.from_model(item)
for item in template.placements
],
created_at=template.created_at,
updated_at=template.updated_at,
)