eCourt-note/.claude/rules/data-layer.md

8.7 KiB
Raw Blame History

paths
db/**
app/actions/**

Data Layer Rules (รายละเอียด: docs/PLAN.md §3, §4)

  • โครงสร้างตาราง/enum/JSONB union อ้าง §3 — หลังแก้ db/schema.ts ต้องรัน /sync-db
  • Enum/union ขยายตาม PLAN-FEAT.md §1 ทีละ task — ตอนนี้เพิ่มแล้ว: SHAPE + ShapeData (rect/ellipse เก็บ rect bbox, line/arrow เก็บ from/to ตาม D3), REDACTION + RedactionData ({ rect } — ดำทึบ ไม่มีสีให้เปลี่ยน), TEXTBOX + TextboxData (F17 — { position, text, color, fontSize, bold?, opacity?, align?, segments?, width? } position เป็นมุมซ้ายบนของกล่องเสมอ (align จัดข้อความในกล่องอย่างเดียวแบบ Smallpdf — กล่องไม่ขยับ), fontSize = % ของ width; bold/opacity(0–1)/align('left'|'center'|'right')/width (กล่องกว้างคงที่ % ของ width — สไตล์ Smallpdf: มี = กล่องกว้างคงที่ลากขอบปรับได้, ไม่มี = shrink-to-fit แถวเดิม) เป็น optional ไม่มี = ตัวปกติ/ทึบเต็ม/ชิดซ้าย/หุ้มข้อความ — bold ตอน export ต้องมี public/fonts/Sarabun-Bold.ttf ไม่งั้น fallback เป็น Regular; segments? = ตัวหนาเฉพาะส่วน (rich text — editor เป็น contentEditable + Ctrl/Cmd+B, เก็บเฉพาะเมื่อมี bold run) โดย field text เก็บข้อความรวม (concat) เสมอเพื่อค้นหา F14/preview sidebar และ export ใช้ wrapStyledText วาดแบบ run ผสม), STAMP + StampData (F18 — { label, position, scale, color? } scale = ความกว้างกรอบเป็น % ของ width, color optional ไม่มี = STAMP_COLOR), DrawData.widths? (F7 pressure, optional ยาวเท่า paths; Point define ที่ db/schema.ts แล้ว re-export จาก utils/coordinates.ts), DrawData.pen? ('pencil' | 'highlighter' — optional ไม่มี = pencil; ค่า preset ต่อ pen อยู่ที่ DRAW_PENS ใน utils/annotation-display.ts), DrawData.opacity? (0–1 optional — เส้นใหม่เก็บชัดเสมอ แถวเดิม fallback ตาม preset ของ pen ผ่าน effectiveDrawOpacity), HighlightData.style? ('highlight' | 'underline' | 'strikethrough' | 'squiggle' — optional ไม่มี = ไฮไลต์ทึบตามเดิม; เลือกจาก popup หลังคลุมดำ), HighlightData.opacity? (0–1 optional ไม่มี = ทึบเต็ม — ตั้งจาก dropdown ของ tool highlight ตอนสร้าง + แผง selection แก้ได้หลังสร้าง; export: ไฮไลต์ทึบคูณเข้าค่าเดิม 0.35 ส่วนเส้นทุกแบบใช้ตรง ๆ) — เพิ่ม type ใหม่ทุกครั้งต้องเติม case ใน validateAnnotationData ครบถ้วน (invariant #8)
  • column data ใช้ $type<AnnotationData>() (discriminated union ตาม enum type) — ห้าม any หรือ object type กว้าง — note?: string (โน้ตคำอธิบายของรายการ เช่น เหตุผลที่วาด — PLAN-FEAT.md §7 N1) มีในทุกชนิดยกเว้น COMMENT (มี message ทำหน้าที่นี้อยู่แล้ว) — validator vNote trim แล้ว ค่าว่าง = ไม่มีโน้ต; อ่านค่าผ่าน annotationNote() ใน utils/annotation-display.ts เท่านั้น (sidebar/สรุป/CSV ใช้ร่วม)
  • DTO (AnnotationDTO, BookmarkDTO): timestamp เป็น ISO string เสมอ ผ่าน mapper toDTO — ห้ามส่ง Date object ข้าม server→client
  • Server Actions: validate input ก่อนทุกครั้ง (type ถูกต้อง, ฟิลด์ครบ, pageIndex ≥ 0) ก่อนแตะ DB; เขียนด้วย DATABASE_URL ตรง ๆ + publish event ผ่าน lib/annotate-events.ts หลังเขียนสำเร็จ + revalidatePath หน้า viewer+summary ของ fileId นั้น (helper revalidateFilePages ในไฟล์เดียวกัน — invalidate Router Cache ฝั่ง client เพราะ force-dynamic ปิดแค่ฝั่ง server: ไม่งั้นกด back แล้วเข้าไฟล์ใหม่ได้ initial data เก่าจนต้อง hard refresh; action ใหม่ที่เขียน DB ต้องเรียกทุกครั้งเช่นเดียวกับ publish event)
  • db/index.ts: postgres.js + Drizzle, prepare: false เสมอ, DATABASE_URL ชี้ที่ plain PostgreSQL container judes-note-db (พอร์ต 54322 — ไม่ใช่ Supabase stack) และ pool ต้องเก็บบน globalThis — Next dev hot-reload re-evaluate module ได้บ่อย ถ้าสร้าง pool ใน module scope ตรง ๆ pool เก่าไม่ถูกปิดและสะสมจนชน max_connections ("too many clients already" — pattern เดียวกับ lib/annotate-events.ts)
  • FK file_id ของ annotations/bookmarks: ON DELETE CASCADE
  • Bookmarks ลำดับชั้น (N2): parent_id uuid NULL ไม่ทำ FK — ลบหัวข้อแม่ต้อง re-parent ลูกขึ้น root (update ... set parent_id = null) + delete ใน transaction เดียวกัน แล้ว publish update event ต่อลูก; จำกัด 3 ระดับ (BOOKMARK_MAX_DEPTH=3): create เช็ค depth(parent) < 3, ย้ายเช็ค depth(parent)+subtreeHeight ≤ 3 + ห้ามย้ายเข้า subtree ตัวเอง — helper lockedDepth/lockedSubtreeHeight/isDescendant ต้อง .for("update") ทุกแถวที่เดินผ่าน ใน tx เดียวกับ write (กัน race เกินความลึก/orphan) + note text NULL (ว่าง/whitespace = null) — validator vBookmarkNote
  • ตาราง annotation_replies (F9/D2): FK annotation_id → annotations CASCADE + index (annotation_id) — ไม่ใช้ parentId ในตารางเดิม; ลบ reply ได้เฉพาะเจ้าของ (guard userId เหมือน annotation); actions publish event table: "replies" หลังเขียนสำเร็จ
  • annotations.resolved (NOT NULL default false) + resolved_at (NULL) — F10/A5: setAnnotationResolved ใครก็ได้ toggle (D6 คลายคืนได้ ต่างจาก delete ที่จำกัดเจ้าของ) + publish update event; ไม่เข้า history undo ของ F2
  • ตาราง annotation_versions (F19/A7): annotation_id เป็น uuid ไม่ FK (D8 — snapshot ตอน delete ต้องรอดจาก CASCADE ของแม่) + file_id FK CASCADE + page_index (restore ต้องรู้หน้า) + kind text 'update' | 'delete' + index (file_id); updateAnnotation/deleteAnnotation snapshot row เดิม ก่อนเขียน/ลบ ใน transaction เดียวกัน; restoreVersion(versionId, userId) — เจ้าของเท่านั้น (D9): guard userId ทั้ง row ปัจจุบัน (ต้นทางยังอยู่) และ snapshot (ต้นทางถูกลบ) / ต้นทางยังอยู่ = เขียนกลับ row เดิม (snapshot ปัจจุบันก่อน) + publish update event / ต้นทางถูกลบ = สร้างใหม่ id ใหม่ + publish create event (ห้ามสร้างสำเนาใหม่ทุกกรณี — เคยทำให้เกิดรายการซ้ำบนหน้า)
  • ห้ามเพิ่มตาราง/column ที่ไม่มีในแผน (ดู out of scope §9) โดยไม่อัปเดต docs/PLAN.md ก่อน