446 lines
26 KiB
Markdown
446 lines
26 KiB
Markdown
# Faunosteo — CLAUDE.md
|
||
|
||
# Generated by scaffolder 2026-05-18. Single source of truth for Claude in this repo.
|
||
# Global rules: ~/.claude/CLAUDE.md — this file extends or overrides them.
|
||
|
||
---
|
||
|
||
## Project overview
|
||
|
||
Single-praticien French web app for veterinary osteopathy bilans on animal anatomy SVGs.
|
||
Practitioner clicks anatomical zones, builds observations with pathologies/severity,
|
||
writes conclusion, and exports an A4 PDF. PDF carries the full JSON state as a native
|
||
attachment so importing it restores the session for a follow-up.
|
||
SPA deployed via Docker + nginx on Scaleway VPS. Backend foundation on Supabase
|
||
(PostgreSQL + Auth + RLS) since Step 3 of the SaaS plan: profiles, platform roles and
|
||
audit log exist; Step 4 added the canonical anatomical sheet model (`packages/domain`,
|
||
tables `species`, `anatomical_sheets` / `_versions` / `_assets`). Step 5 moved the
|
||
application onto that model: the editor renders the bundled reference sheet (the
|
||
curated equine DRAFT, `SHEET_BUNDLE=draft`), writes Report v3 and imports v2 PDFs
|
||
through a generated migration map. Step 6 made the PDF an autonomous archive: the
|
||
`packages/pdf` engine renders from explicit inputs (report, sheet snapshot, branding,
|
||
labels, rasterizer) with no network and no DOM, and the attachment is an envelope v1
|
||
carrying the report, a lean sheet snapshot, the branding and the labels used, so an old
|
||
bilan is reproduced identically after any catalog, wording or logo change
|
||
(`docs/PDF-FORMAT.md`). The Supabase client is still unused by the UI.
|
||
MVP species: equine only. Open-source MIT.
|
||
|
||
---
|
||
|
||
## Stack
|
||
|
||
| Concern | Choice | Version |
|
||
|---|---|---|
|
||
| Runtime | Node.js | 24 LTS (`.nvmrc`, `engines` >=22.12 <25) |
|
||
| Package manager | pnpm | 10.13.1 (`packageManager`, root devDependency) |
|
||
| Build | Vite + @vitejs/plugin-react-swc | 7.x |
|
||
| UI | React | 19 |
|
||
| Language | TypeScript strict | 5.x |
|
||
| Styling | Tailwind CSS v4 CSS-first (no postcss config) | 4.x |
|
||
| State | Zustand | 5 |
|
||
| Validation | Zod | 3 |
|
||
| PDF | pdf-lib | 1.17 |
|
||
| SVG raster | native Image/canvas (no dependency) | — |
|
||
| Animation | motion | 11 |
|
||
| Tests | vitest + happy-dom + @testing-library/react | 3.x |
|
||
| Backend | Supabase (PostgreSQL 17, GoTrue, PostgREST) — CLI pinned as root devDependency | CLI 2.120 |
|
||
| DB client | @supabase/supabase-js (packages/supabase) | 2.x |
|
||
| SQL tests | pgTAP under supabase/tests, run by `supabase test db` and by PGlite (Dockerless) | PGlite 0.3 |
|
||
| Deploy | Docker multi-stage → nginx:alpine | — |
|
||
|
||
---
|
||
|
||
## Build commands
|
||
|
||
pnpm workspace: `apps/app` = the private application, `packages/domain` = pure
|
||
Zod domain model (anatomical sheet document), `packages/supabase` = Supabase
|
||
access layer (see `docs/development/WORKSPACE.md`). Every command
|
||
below runs from the repository root and delegates to the packages.
|
||
|
||
```bash
|
||
# Development
|
||
pnpm dev
|
||
|
||
# Production build (typecheck + vite build)
|
||
pnpm build
|
||
|
||
# Type-check only (no emit)
|
||
pnpm typecheck
|
||
|
||
# Preview production build
|
||
pnpm preview
|
||
|
||
# Tests (watch)
|
||
pnpm test
|
||
|
||
# Tests (CI / single run)
|
||
pnpm test:run
|
||
|
||
# Lint (0 warnings allowed)
|
||
pnpm lint
|
||
|
||
# Format
|
||
pnpm format
|
||
|
||
# Supabase local stack (Docker) — docs/development/SUPABASE.md
|
||
pnpm db:start # start stack, apply migrations + seed
|
||
pnpm db:reset # replay from zero
|
||
pnpm db:test # pgTAP on the real stack
|
||
pnpm db:types # regenerate packages/supabase/src/database.types.ts
|
||
pnpm db:types:check # CI diff
|
||
|
||
# Reference sheet in the app: the dev server bundles the curated draft; a build does not
|
||
pnpm build:preview # SHEET_BUNDLE=draft build (manual validation, preview deployments)
|
||
pnpm preview:draft # same, then serves it
|
||
pnpm import:equine # regenerate legacy-import/ and draft/ (document, migration map, review drawings)
|
||
pnpm report:compare <pdf|dir>... # archive check: attachment vs its v3 reading, unresolved items flagged (docs/PDF-FORMAT.md)
|
||
```
|
||
|
||
## Docker commands
|
||
|
||
```bash
|
||
# Build image
|
||
docker build -t faunosteo .
|
||
|
||
# Build an image that embeds the reference DRAFT sheet (preview only, never the default)
|
||
docker build --build-arg SHEET_BUNDLE=draft -t faunosteo .
|
||
|
||
# Run with compose (reads .env for APP_* vars)
|
||
docker compose up --build
|
||
|
||
# Stop
|
||
docker compose down
|
||
```
|
||
|
||
Naming convention: every Docker resource Faunosteo owns is prefixed `faunosteo_`
|
||
when the name is configurable (container `faunosteo_app`, Compose project
|
||
`faunosteo`); the Supabase CLI imposes `supabase_<service>_faunosteo`, documented
|
||
as a limit in DEPLOY.md "Docker resource naming". Never rename a resource that
|
||
holds data without keeping its volume.
|
||
|
||
Note: no global pnpm needed. `corepack enable` once (reads `packageManager`),
|
||
or call `corepack pnpm <cmd>`. Root scripts resolve `node_modules/.bin/pnpm`.
|
||
|
||
---
|
||
|
||
## Test commands
|
||
|
||
```bash
|
||
pnpm test:run # vitest run — all tests, single pass, CI-safe
|
||
pnpm test # vitest watch — dev loop
|
||
```
|
||
|
||
Test files live in `apps/app/tests/unit/*.test.ts(x)`; golden fixtures in
|
||
`apps/app/tests/fixtures/`. The 612 legacy catalog leaves run through the v2 → v3 migration
|
||
in both `packages/anatomy` (against the draft document) and the app (sheet index + PDF roundtrip). Setup: `apps/app/tests/setup.ts` imports
|
||
@testing-library/jest-dom. Suites run on the bundled reference sheet (`tests/helpers/sheet.ts`); frozen v2 fixtures under `tests/fixtures/`.
|
||
SQL: `supabase/tests/*.sql` (pgTAP) run by `packages/supabase/tests/db/pgtap.test.ts`
|
||
on PGlite (part of `pnpm test:run`) and by `pnpm db:test` on the real stack.
|
||
|
||
---
|
||
|
||
## Lint / format commands
|
||
|
||
```bash
|
||
pnpm lint # ESLint 9 flat config — max-warnings 0
|
||
pnpm format # Prettier write
|
||
```
|
||
|
||
---
|
||
|
||
## Folder structure
|
||
|
||
```
|
||
faunosteo/
|
||
├─ apps/app/ ← @faunosteo/app (everything below until packages/)
|
||
├─ public/ ← logos only (no anatomy asset: the sheet is bundled)
|
||
├─ vite/sheet-bundle.ts ← Vite plugin: `virtual:faunosteo-sheet` (SHEET_BUNDLE=draft|none)
|
||
├─ scripts/compare-reports.ts ← `pnpm report:compare`: archive PDF vs v3 reading (pure part in scripts/compare/report.ts)
|
||
├─ src/
|
||
│ ├─ app/
|
||
│ │ ├─ App.tsx ← root router
|
||
│ │ ├─ routes/{Home,NewReport,Editor,NotFound}Route.tsx
|
||
│ │ └─ providers/ConfigProvider.tsx ← AppConfig context
|
||
│ ├─ config/env.ts ← runtime config resolution
|
||
│ ├─ sheets/{provider,useSheet}.ts ← SheetProvider interface, bundled implementation, per-species hook
|
||
│ ├─ services/
|
||
│ │ ├─ sheetIndex.ts ← read-only lookups over the loaded sheet (ids, never labels)
|
||
│ │ └─ zoneInteraction.ts ← pure click decision + observation reducers (zones, sides, vertebrae)
|
||
│ ├─ i18n/
|
||
│ │ ├─ types.ts ← Locale type + Dict type
|
||
│ │ ├─ fr.ts + en.ts ← translation dicts (flat key → string)
|
||
│ │ ├─ index.ts ← getDict(locale)
|
||
│ │ └─ useT.ts ← useT() hook (reads localeStore)
|
||
│ ├─ state/
|
||
│ │ ├─ reportStore.ts ← Zustand store (Report v3) + persistence.ts (sessionStorage adapter, v2 draft migration)
|
||
│ │ ├─ localeStore.ts ← locale Zustand store (persisted to localStorage)
|
||
│ │ └─ practitionerCache.ts ← localStorage prefill
|
||
│ ├─ anatomy/drawing.ts ← sanitised asset + generated annotation layer → inline <svg> per view
|
||
│ ├─ components/
|
||
│ │ ├─ ui/{Button,Card,Dialog,Input,Label,Select,Textarea,Badge,Chip}.tsx
|
||
│ │ ├─ canvas/{AnatomyCanvas,DetailModal}.tsx
|
||
│ │ ├─ observation/{ObservationList,ObservationCard,ObservationPickers,FindingsTreePicker,
|
||
│ │ │ VertebraPicker,SeveritySelector,LateralityPicker,
|
||
│ │ │ FreeTextFindingInput}.tsx
|
||
│ │ ├─ report/{ReportHeader,PractitionerForm,AnimalForm,EditInfosDialog,DisclaimerDialog,
|
||
│ │ │ ConclusionPanel,NextAppointmentPicker}.tsx
|
||
│ │ └─ brand/{Brand,AppHeader,Footer,LanguageSwitcher}.tsx
|
||
│ ├─ pdf/ ← app side of @faunosteo/pdf (engine in packages/pdf)
|
||
│ │ ├─ export.ts + import.ts ← exportReportToPdf (sheet snapshot + branding + browser rasterizer → engine), importReportFromPdf (ArchiveReadOutcome, ImportError kinds)
|
||
│ │ └─ branding.ts + browserRasterizer.ts ← public/ logos → Branding; Image/canvas Rasterizer adapter
|
||
│ ├─ lib/{dates,id,assert,supabase}.ts ← supabase.ts: getSupabaseClient() | null
|
||
│ ├─ styles/{index,tokens}.css ← Tailwind v4 CSS-first
|
||
│ └─ main.tsx
|
||
├─ tests/
|
||
│ ├─ setup.ts
|
||
│ └─ unit/*.test.ts
|
||
├─ docker/
|
||
│ ├─ entrypoint.sh ← injects env.js at container start
|
||
│ └─ nginx.conf ← SPA fallback + PORT envsubst
|
||
├─ docs/
|
||
│ ├─ ANNOTATION-RENDERING.md ← annotation layer contract (attributes, styles, colours)
|
||
│ ├─ PDF-FORMAT.md
|
||
│ ├─ faunosteo-audit/ ← audit of the current system (frozen at 83e40af)
|
||
│ ├─ development/ ← SaaS implementation plan, WORKSPACE.md
|
||
│ └─ history/superpowers/{specs,plans}/ ← 2026-05 design records (docs/superpowers is purged by gitflow finish)
|
||
├─ eslint.config.js, index.html, package.json (@faunosteo/app)
|
||
├─ tsconfig*.json, vite.config.ts, vitest.config.ts
|
||
│ (end of apps/app)
|
||
├─ packages/domain/ ← @faunosteo/domain (pure, no DOM, zod only): anatomical-sheet (document, integrity rules, sheet-index), report (v3, v2 migration, rebase), archive (sheet snapshot, envelope v1, branding, labels, layered reader)
|
||
│ ├─ src/anatomical-sheet/{schema,validate,create}.ts ← canonical sheet document + integrity rules
|
||
│ └─ tests/{fixtures/horse-slice.ts,*.test.ts}
|
||
├─ packages/anatomy/ ← @faunosteo/anatomy: legacy importer, curation pipeline, pure annotation-layer renderer + view composer (`./render`)
|
||
├─ packages/pdf/ ← @faunosteo/pdf: browser-free PDF engine — src/{export,read,text,branding}.ts, attachment/, svg/{parse,sanitize,view}.ts, render/, i18n/; tests reproduce the Step 6 goldens
|
||
│ ├─ src/legacy/{svg,catalog,regions,ids,report,importer}.ts, src/cli/import-equine.ts
|
||
│ ├─ src/curation/{schema,targets,fields,ops,rename,apply,types,assets,labels,stats,changelog,review-report,overlay,seed,sources,pipeline}.ts ← changeset → draft
|
||
│ └─ tests/ ← counts preserved, special cases, determinism, curation ops, golden artifacts
|
||
├─ packages/supabase/ ← @faunosteo/supabase
|
||
│ ├─ src/{index,client,database.types,anatomical-sheets}.ts ← typed client, generated types, publish gate
|
||
│ └─ tests/{client,anatomical-sheets}.test.ts, tests/db/ ← PGlite harness, shim, pgTAP runner, schema↔types test
|
||
├─ supabase/
|
||
│ ├─ config.toml, seed.sql ← CLI config (public schema only), local dev accounts
|
||
│ ├─ migrations/*.sql ← forward-only; foundation, profiles, platform_roles, anatomical_sheets, storage, sheet_document_schema_v2
|
||
│ ├─ seed/anatomical-sheets/equine/
|
||
│ │ ├─ legacy-sources/ ← the historical Horse.svg, Horse_head.svg, pathologies.json, vertebrae.ts (importer input, never edited)
|
||
│ │ ├─ legacy-import/ ← GENERATED baseline: document, id map, IMPORT-REPORT, SVG copies (no SQL)
|
||
│ │ ├─ curation/{changes,references}.json ← AUTHORED changeset + references registry (never generated)
|
||
│ │ └─ draft/ ← GENERATED working revision: document, cleaned horse.svg, sheet-ref, report-migration-map, CHANGELOG, REVIEW-REPORT, review/*.svg, equine_draft.sql
|
||
│ └─ tests/*.sql ← pgTAP: allowed + denied paths per policy
|
||
├─ packages/README.md ← shared packages index
|
||
├─ .gitea/workflows/ci.yml ← CI: install, typecheck, test, lint, build, docker
|
||
├─ .claude/{tasks/TODO.md,memory/,audits/}
|
||
├─ Dockerfile, docker-compose.yml, docker/
|
||
├─ .env.example, .editorconfig, .nvmrc, .node-version, .npmrc, .prettierrc.json
|
||
├─ package.json (workspace root), pnpm-workspace.yaml, pnpm-lock.yaml
|
||
├─ CLAUDE.md, README.md, DEPLOY.md, CHANGELOG.md, LICENSE
|
||
```
|
||
|
||
---
|
||
|
||
## Architecture
|
||
|
||
```
|
||
User interaction
|
||
→ React routes (BrowserRouter)
|
||
→ Zustand store (reportStore)
|
||
→ Components read store via selectors (no prop drilling)
|
||
|
||
Sheet loading
|
||
→ useSheet(speciesId) → SheetProvider (bundled: virtual:faunosteo-sheet, SHEET_BUNDLE=draft)
|
||
→ Zod-validated document + assets + migration map → buildSheetIndex()
|
||
|
||
SVG interaction
|
||
→ AnatomyCanvas builds the view: sanitised asset + renderAnnotationLayer() (markers from the document)
|
||
→ delegated click on [data-anno-id] → decideZoneClick() (services/zoneInteraction, pure)
|
||
→ open_view → DetailModal (same drawing, view_box crop, or the view's own asset)
|
||
→ open_vertebra_picker / open_laterality_picker → pickers → reducers (ensureZone, addSides, syncVertebrae)
|
||
→ toggle / remove_both_sides → updateObservation() in store
|
||
|
||
PDF export (app side: apps/app/src/pdf, engine: packages/pdf)
|
||
→ exportReportToPdf(report, index, { locale })
|
||
→ buildSheetSnapshot(index.sheet, report) + loadBranding() (4 public/ files, each may fail alone) + defaultPdfLabels
|
||
→ exportReportArchive({ report, sheet, branding, labels, locale, rasterizer: browserRasterizer, exportedAt })
|
||
assertSnapshot (caps, integrity, sheet invariant) → fonts (WinAnsi StandardFonts, safeText guard)
|
||
→ per observation: composeHighlightedViewSvg (xmldom: sanitise allowlist → composeViewSvg highlight) → rasterizer → page
|
||
→ conclusion page, footer, envelope v1 attached as osteo-report.json, Keywords faunosteo-archive/1
|
||
→ { pdf, envelope, warnings } → browser download
|
||
→ exportFromEnvelope(envelope, …) re-exports an archive from its own snapshot, branding and labels (no sheet)
|
||
|
||
PDF import
|
||
→ importReportFromPdf(bytes, migrationMap) → readReportArchive (engine)
|
||
→ attachment osteo-report* first → layered reading: report (v3 as is, v2 migrated, else incompatible_version),
|
||
envelope metadata tolerant, snapshot/branding/labels strict → archive kept or snapshotRejected (closed reason)
|
||
→ rebaseReportOnSheet(report, index, archivedSnapshot) when the loaded sheet differs (unresolved flags, labels kept)
|
||
→ hydrateImport({ report, archive }) → one alert (archive_ok / snapshot_rejected / rebased / migrated) → navigate /editor
|
||
|
||
Runtime config
|
||
→ Docker entrypoint writes env.js (window.__APP_CONFIG__)
|
||
→ index.html loads env.js before bundle
|
||
→ src/config/env.ts reads window.__APP_CONFIG__ → VITE_APP_* → defaults
|
||
→ ConfigProvider exposes via React context
|
||
→ appConfig.supabase (url + anon key) or null → lib/supabase.ts lazy client
|
||
|
||
Database (Supabase)
|
||
→ schemas: public (exposed, RLS on every table) / private (helpers, triggers) / audit (append-only)
|
||
→ auth.users insert → private.handle_new_auth_user() → public.profiles row
|
||
→ platform roles: public.profile_roles written only by grant_platform_role / revoke_platform_role
|
||
(security definer, actor checked via private.is_platform_*; every call logged by private.log_event)
|
||
→ tests: supabase/tests/*.sql (pgTAP) via PGlite in CI check job and `supabase test db`
|
||
```
|
||
|
||
---
|
||
|
||
## Project conventions
|
||
|
||
### Language split
|
||
- UI strings: bilingual FR/EN — all user-facing text goes through the i18n system (see below)
|
||
- Code: English (variable names, function names, comments, docs)
|
||
- Never mix: no French variable names, no raw French/English string literals in JSX — use `useT()`
|
||
|
||
### i18n
|
||
- All user-facing strings live in `src/i18n/fr.ts` and `src/i18n/en.ts` (flat `Record<string, string>`)
|
||
- Key convention: `<area>.<key>` — e.g. `common.cancel`, `home.new_report.title`, `pdf.subject`
|
||
- Both dicts must share the exact same key set; a key missing in one dict logs a warning in DEV
|
||
- Get the translate function in any component: `const t = useT()` then `t('common.cancel')`
|
||
- `src/state/localeStore.ts` holds current `Locale` (`'fr' | 'en'`), persisted to `localStorage` key `osteo:locale`; default: navigator-detected `fr`/`en`, or `'fr'` if no match
|
||
- Zone and finding names shown in the editor and the PDF come from the sheet document (`{ fr, en }` labels) and from the report's snapshots, not from the dict
|
||
- PDF static labels (section headings, metadata) live in the engine (`packages/pdf/src/i18n`, `defaultPdfLabels`, 25 keys) and are archived in the envelope; the app dicts hold no `pdf.*` key
|
||
|
||
### Identity strings
|
||
- NEVER hardcode APP_SITE_NAME, APP_BRAND_NAME, APP_FOOTER_NAME, APP_TAGLINE
|
||
- Always read from ConfigProvider via useConfig()
|
||
- src/config/env.ts is the only place with defaults
|
||
|
||
### Annotation rendering
|
||
- docs/ANNOTATION-RENDERING.md is the source of truth: the drawing carries no annotation element, the app draws
|
||
the markers from the document (`@faunosteo/anatomy/render`), with the attributes listed there
|
||
- Never rely on element id, className or a label for click targeting or behaviour — always `data-anno-id`
|
||
and the annotation's fields (`laterality`, `vertebral_region_code`, `opens_view_id`)
|
||
- Marker look (radii, opacities, strokes) is renderer style; colours are document data (`color` on categories
|
||
and annotations); no graphic redesign without prior validation
|
||
|
||
### Schemas
|
||
- `packages/domain/src/report/*.ts` are the report data contracts (v3 current, v2 input only); never change
|
||
without bumping the version on a breaking change (additive optional fields keep it)
|
||
- All user-provided data goes through Zod parse before hitting the store
|
||
- Report version 3: zones by `(annotationId, viewId)`, findings by `(findingZoneId, path)`, severities
|
||
`mild|moderate|severe`, `sheet` reference; v2 is migrated through `report-migration-map.json`
|
||
(`migrateReportV2ToV3`, never throws on content, `unresolved: true` marks what the sheet no longer holds);
|
||
v1 and unknown versions are refused with a typed error
|
||
|
||
### Stores
|
||
- No direct store mutation outside Zustand actions
|
||
- No business logic in components — delegate to store actions
|
||
- sessionStorage keys: osteo:draft (auto-saved on every change, v3; a v2 draft is migrated and a stale draft rebased on restore once the sheet is loaded) and osteo:archive (the imported archive envelope, written only on import / new report / reset, never on edits)
|
||
- localStorage key: osteo:lastPractitioner (practitioner prefill cache)
|
||
|
||
### PDF
|
||
- A4 portrait: 595.28 × 841.89 pt
|
||
- No raw URLs in PDF output — abbreviated citations only
|
||
- JSON attachment filename must start with osteo-report; content = report archive envelope v1 (report v3 + sheet snapshot + branding + labels); import accepts bare v2 (migrated), bare v3 and envelope v1; a bad snapshot never loses the report
|
||
- The engine (`packages/pdf`) has no DOM lib, no fetch, no Node-only global (lint-enforced); rasterisation is an injected adapter; every SVG it receives is sanitised by allowlist with caps
|
||
- Page layout is frozen by the Step 6 goldens: any visible change needs a user decision and a golden regeneration
|
||
- Fonts are StandardFonts (Helvetica/TimesRoman, WinAnsi encoding) — TTF Inter/Fraunces planned but not yet embedded. Any non-Latin-1 glyph in PDF text must use an ASCII surrogate until the TTF migration lands (e.g. `(!)` instead of `⚠`).
|
||
|
||
### Anatomical sheet content
|
||
- The findings catalog, the vertebral regions and the markers are the canonical sheet document; every content
|
||
change goes through `supabase/seed/anatomical-sheets/equine/curation/changes.json` (see the sheet model section)
|
||
- The curated draft is the reference content in development (`SHEET_BUNDLE=draft`); it is not medically
|
||
validated and a production build carries no sheet unless that flag is set on purpose
|
||
|
||
### Database (Supabase)
|
||
- Platform roles (`platform_role`: owner/admin/moderator/support) are NOT professional
|
||
statuses (practitioner/student/professor come from verification, cabinet roles from
|
||
organization_members). Never add a professional status to `platform_role`.
|
||
- Every `public` table: RLS enabled, `revoke all` from API roles then exact grants,
|
||
separate policies per command, no `using (true)` for anon/authenticated (test-enforced).
|
||
- Writes that change privileges or sensitive state go through a security-definer RPC
|
||
that checks `auth.uid()` and calls `private.log_event()`. Never a direct table policy.
|
||
- Helpers in `private` are `security definer`, `set search_path = ''`, EXECUTE revoked
|
||
from public and granted only to the roles that evaluate them.
|
||
- A migration is never edited once applied. Each migration ships its pgTAP file with
|
||
allowed AND denied cases, and a regenerated `database.types.ts`.
|
||
- The browser holds the anon key only. The `service_role` key value never appears in env.js, .env.example or code;
|
||
operator scripts under `packages/*/scripts/` read it from the environment and are never bundled.
|
||
- pgTAP files run on PGlite and on the real image: scope counts to fixture ids, pin `collate "C"` on text ordering.
|
||
|
||
### Anatomical sheet model (packages/domain + migration 20261008110000)
|
||
- `docs/development/ANATOMICAL_SHEET_MODEL.md` is the source of truth: document shape, issue codes, tables, RPCs.
|
||
- Ids are stable slugs never derived from labels; labels are `{ fr, en }` objects. Annotation → findings is the
|
||
explicit `finding_zone_id`; vertebral regions are ordered data with free codes. No label matching at runtime.
|
||
- A published version is immutable (trigger, every role). Change = new draft (`create_sheet_draft`) then
|
||
`publish_sheet_version`. Integrity rule codes are shared by `validateSheetDocument` (TS) and
|
||
`private.sheet_document_issues` (SQL); add a rule on both sides and in the spec table.
|
||
- Document schema change → bump `SHEET_DOCUMENT_SCHEMA_VERSION`, extend the SQL CHECK on `document_schema_version`.
|
||
- Official equine sheet = generated seed `draft/` (`pnpm import:equine`, never edit `legacy-import/` or `draft/` by hand;
|
||
the golden test fails on drift). Every content change goes through `curation/changes.json` (traced in CHANGELOG.md).
|
||
It is a DRAFT until a platform admin publishes it after business review of `REVIEW-REPORT.md`.
|
||
- Sheet SVG bytes live in Storage bucket `anatomical-sheet-assets` as `<sha256>.svg`; uploads are an operator task
|
||
(`pnpm assets:upload <seed dir>` with the service key in env), never from the browser.
|
||
|
||
### Component stubs
|
||
- Scaffold stubs render <div>ComponentName placeholder</div>
|
||
- Replace stub body entirely when implementing — no partial edits on stubs
|
||
|
||
---
|
||
|
||
## Exceptions to global rules
|
||
|
||
- **React SPA**: explicit exception — this is a practitioner tool, not a public website.
|
||
No indexing needed. SPA is correct. (See BDR-001)
|
||
- **No API versioning**: no hand-written HTTP API. Supabase exposes tables/RPC through
|
||
PostgREST; breaking changes are handled by new migrations and RPC names, not URL versions.
|
||
- **80-char line limit**: relaxed to 100 for TypeScript generics and long Zod chains.
|
||
|
||
---
|
||
|
||
## Key dependencies
|
||
|
||
| Package | Purpose |
|
||
|---|---|
|
||
| react 19 | UI framework, automatic memo + concurrent rendering |
|
||
| react-dom 19 | DOM renderer |
|
||
| react-router-dom 7 | Client-side routing (BrowserRouter) |
|
||
| vite 7 | Build tool, HMR, ESM-native |
|
||
| @vitejs/plugin-react-swc | Fast React transform via SWC |
|
||
| typescript 5 | Type safety, strict mode |
|
||
| tailwindcss 4 | CSS-first utility framework |
|
||
| zustand 5 | Lightweight global state |
|
||
| zod 3 | Schema validation + type inference |
|
||
| pdf-lib 1.17 | Pure-JS PDF generation + native attachments |
|
||
| motion 11 | Animations (modals, toasts, observation cards) |
|
||
| vitest 3 | Test runner |
|
||
| happy-dom | DOM environment for tests |
|
||
| @testing-library/react | Component testing utilities |
|
||
| @testing-library/jest-dom | Custom DOM matchers |
|
||
| eslint 9 | Linting (flat config) |
|
||
| @supabase/supabase-js 2 | Typed client (packages/supabase) |
|
||
| supabase (CLI) 2.120 | Local stack, migrations, pgTAP runner, type generation |
|
||
| @electric-sql/pglite 0.3 | PostgreSQL 17 in WASM: runs the pgTAP suite without Docker |
|
||
| prettier 3 | Code formatting |
|
||
|
||
---
|
||
|
||
## Workflow expectations
|
||
|
||
- Run `pnpm typecheck && pnpm test:run` before every commit.
|
||
- Domain schema changes (`packages/domain/src/report/*.ts`) require updating all callers + bumping version if breaking.
|
||
- Annotation rendering changes require updating docs/ANNOTATION-RENDERING.md first.
|
||
- Never modify the legacy sources under `supabase/seed/anatomical-sheets/equine/legacy-sources/` — they are the
|
||
importer's input (the user's historical files).
|
||
- Ask before any change to `readReportArchive`, `readArchiveDocument`, `readAttachedDocument` or `rebaseReportOnSheet` — they handle user data; archive readers never drop a schema version (envelope v1, Report v2/v3, sheet document v2).
|
||
- After PDF roundtrip tests fail: check attachment bytes, then the layered reader (report first, envelope metadata, snapshot/branding/labels), then DecompressionStream inflation. Goldens under `apps/app/tests/fixtures/goldens/step6` are never regenerated without a user decision.
|
||
- Node 24 / pnpm 10.13.1: `corepack enable` or `corepack pnpm`; never a global install.
|
||
- SQL change: `pnpm --filter @faunosteo/supabase test:run` (PGlite) before commit; `pnpm db:reset && pnpm db:test`
|
||
on the real stack when Docker is available; regenerate types (`pnpm db:types`).
|
||
|
||
## Commit message convention
|
||
|
||
Conventional Commits format. Subject ≤72 chars, imperative mood, no trailing period.
|
||
Allowed scopes: `schema`, `store`, `anatomy`, `pdf`, `editor`, `home`, `new`, `ui`, `config`, `species`, `i18n`, `docker`, `docs`, `tests`, `chore`, `app`, `workspace`, `ci`, `supabase`, `domain`, `worker`, `public-web`.
|
||
|
||
Examples:
|
||
- `test(schema): cover Report version literal`
|
||
- `feat(store): implement addObservation`
|
||
- `feat(anatomy): parse data-anno-id from SVG`
|