Files
faunosteo/CHANGELOG.md
T

17 KiB
Raw Blame History

Changelog

All notable changes to Faunosteo are documented here. Format: Keep a Changelog. Versions follow Semantic Versioning.

[Unreleased]

[0.2.0] — 2026-10-11

Added (SaaS migration, plan Steps 3–6)

  • Autonomous PDF archives (Step 6) — new @faunosteo/pdf engine (packages/pdf): the PDF is rendered from explicit inputs (report, sheet snapshot, branding, labels, locale, rasterizer, export date), with no network and no browser DOM; the attachment becomes a report archive envelope v1 (osteo-report.json) carrying the Report v3, a lean but valid snapshot of the anatomical sheet (views, annotations, geometry, colours, relations, the finding paths used with their ancestor labels, the SVG drawing), the branding used at export and the FR/EN label dictionary, so an old bilan is reproduced identically after any catalog, wording or logo change. Layered reading keeps the report even when the wrapper or the snapshot is refused (closed reasons), v2 and bare v3 PDFs still import, a PDF whose attachment was stripped is recognised. Imported archives are kept in the session; a bilan reopened on a different sheet is rebased on a working copy with unresolved items flagged and their labels kept, and the import message says so. SVG assets go through an allowlist sanitiser with size and complexity caps checked at import and at export; a WinAnsi guard keeps any text from crashing the export. Pages unchanged (frozen by 39 goldens). docs/PDF-FORMAT.md written for real.

  • Bounded attachment import and bundled branding (Step 6 closure) — the PDF attachment is extracted by a bounded byte scan (no pdf-lib parse on import, 16 KiB inflate slices, shared 16 MiB candidate budget, JSON depth pre-check, export without object streams); the logos and identity used at export are bundled with the app.

  • Supabase foundation — local stack (supabase/config.toml), migrations (schemas private / audit, profiles, platform roles with audited RPCs), pgTAP suite run on PGlite (pnpm test:run) and on the real stack (pnpm db:test), @faunosteo/supabase typed client + generated types. No UI change.

  • Anatomical sheet model — @faunosteo/domain: canonical sheet document (views tree, annotations with stable ids and explicit laterality, ordered vertebral regions, typed finding categories, explicit annotation → finding zone links, FR/EN labels) with integrity validation; tables species, anatomical_sheets, anatomical_sheet_versions (published rows immutable, one draft per sheet, deletion preconditions), anatomical_sheet_assets; lifecycle RPCs (create, draft, publish, deprecate, delete, fork with provenance, archive, assets) audited and under RLS. Spec: docs/development/ANATOMICAL_SHEET_MODEL.md.

  • Application on the canonical sheet (Step 5) — the editor renders the bundled reference sheet (curated equine draft, SHEET_BUNDLE=draft; a default build carries no sheet): markers drawn from the document with the legacy look (@faunosteo/anatomy/render), head view as a crop of the same drawing, zone interaction service, pickers on the sheet's regions (usual count, extension to the documented range) and finding zones. Report document v3 (packages/domain/report): zones by annotation and view ids, findings by zone and path, severity codes, exact sheet reference; v2 PDFs and drafts migrate through the generated report-migration-map.json, unresolved items kept with their labels. Removed: species registry, label matchers, SVG convention parser, /editors, /svg-editor, pathology-editor.html, scaffold:species; the legacy sources now live under supabase/seed/anatomical-sheets/equine/legacy-sources/. Archive check tool pnpm report:compare (attachment vs its v3 reading, unresolved items flagged); the 612 legacy catalog leaves are tested through the migration in both packages.

  • Equine sheet curation (Step 4c) — document schema v2 (references registry, review_status on findings and annotations, configurable vertebral count_range; migration 20261010100000, pgTAP 008); @faunosteo/anatomy curation pipeline: authored changeset (curation/changes.json, levels A/B/C, before/after records) applied to the legacy baseline → working draft with CHANGELOG.md, REVIEW-REPORT.md (10 sections for the osteopath) and before/after review drawings; one cleaned SVG asset, head view as a crop. Content: research-backed audit of the horse sheet (44 changes, 48 verifiable references): sphenoid zone restructured, NAV terminology, FR/EN translations, vertebral ranges, ten SVG points relocated, carpus zone added, veterinary red flags, legal disclaimer anchored on R. 243-6 / R. 243-8, osteopathic-model status on unvalidated concepts, 11 questions for the professional. Still a private DRAFT, not published. Docker resources prefixed faunosteo_ (Compose project and container).

  • Equine import (Step 4b) — @faunosteo/anatomy deterministic importer: Horse.svg + Horse_head.svg + pathologies.json → canonical document, legacy id map, French import report, idempotent seed creating the official sheet faunosteo-cheval as a private DRAFT (never published by code). Storage bucket anatomical-sheet-assets (content-addressed SVGs, read through the sheet, operator upload script).

Changed (SaaS migration, plan Step 2)

  • pnpm workspace — the application moved to apps/app (@faunosteo/app) with git mv; root commands (pnpm typecheck|test:run|lint|build|dev) delegate to the packages. packages/ reserved, empty. CI workflow added (.gitea/workflows/ci.yml).
  • Node 24 LTS / pnpm 10.13.1 — declared in .nvmrc, .node-version, engines, packageManager; engine-strict on; Dockerfile builds on node:24-alpine and copies apps/app/dist.

Added (SaaS migration, plan Steps 0–1)

  • Implementation plan — docs/development/ (27-step plan, migration map, domain map, architecture, strategies, open questions).
  • Characterisation suite — 91 tests on the real SVGs, catalog and PDF pipeline; two golden Report v2 fixtures (CHARACTERIZATION_REPORT.md).

Added

  • Laterality & bilaterality — LateralSideSchema (left/right) + Bone.lateral, data-anno-lateral parsed from the SVG; LateralityPicker modal in the zone-click flow, side shown in zone badges and PDF labels; bilateral zones get a separate findings picker per side.
  • SVG anatomy editor — /svg-editor route, the vanilla annotation tool wrapped in React (BDR-017).
  • Standalone pathology editor — public/pathology-editor.html, a zero-dependency JSON tree editor with SVG zone selection (BDR-020/021/022).
  • Welcome screen — tabbed editor entry with a project SVG picker; /editors listing page.
  • Footer branding — global footer with copyright, "Powered by ZenQuality" and the "Paws in Harmony" partnership logo, on both the site and the exported PDF.
  • gitflow socle — main/develop model + versioned pre-commit hook.

Changed

  • Unified AppHeader across every route (logo brand + tagline).
  • Responsive mobile — full phone/tablet adaptation across all components.
  • Project renamed Zoosteo → Faunosteo across the whole codebase.

Removed

  • canvg dependency — PDF SVG rasterization now uses the browser's native Image/canvas pipeline (src/pdf/render/svgToPng.ts) instead of the canvg library.

Fixed

  • pathology-editor.html 404 in production — it lived at the repo root, Vite never bundled it into dist/; moved to public/ so it ships (LRN-029).
  • Docker species caching — Cache-Control: no-cache header added for /species/ assets so an updated catalog is served fresh.
  • nginx runner base image pinned to nginx:1.31-alpine (was the floating nginx:alpine tag).

Security

  • Docker container runs fully as non-root (USER nginx) — PORT must now be >=1024 (default 8080 unaffected).
  • Supply-chain guard — .npmrc gained minimum-release-age=1440, blocking install of package versions published less than 24h ago.
  • User-imported SVGs sanitized — the SVG editor and the standalone pathology editor now strip <script>/<foreignObject> nodes, on* event-handler attributes, and javascript: hrefs before inserting an imported SVG into the DOM.

[0.1.0] — 2026-05-21

First public release. Single-praticien web app for veterinary osteopathy bilans on animal anatomy SVGs. Static SPA, no backend, no auth; the exported PDF is the long-term record, with the full report JSON embedded as a native PDF attachment so re-importing the PDF restores the session for a follow-up.

Added

  • Anatomy canvas — inline SVG with clickable zones, hitbox+visible twin pattern, delegated click listener, async-mount safe.
  • Detail popups — click a zone (e.g. head) to open a secondary SVG with finer-grained zones. Independent bones map, fallback lookup across main + detail.
  • Vertebra picker — region tabs (C/T/L/S/Cd) with multi-select chip grid; region tab preselected from the clicked zone label.
  • Hierarchical findings tree — per-zone picker with breadcrumb drill-down, leaf toggle, vet-referral badge, count badges on intermediate nodes, scope-disclaimer modal shown once per session.
  • Bilingual UI (FR / EN) — full i18n via flat dict + useT() hook, language switcher in every header, locale persisted to localStorage, default auto-detected from the browser.
  • PDF export — A4 portrait with rasterized anatomy SVGs (canvg @ 2×), structured per-zone observation sections (CONSTATS — <ZONE>
    • CONSTATS LIBRES), severity pill, conclusion page, locale-aware static labels. Inter-item separator rendered as accent-coloured bold bullet.
  • PDF import — Zod-validated re-import of a previously exported PDF restores the entire session. Typed ImportError (discriminant + foundVersion) with i18n-resolved user-facing messages.
  • Practitioner cache — last-used practitioner block prefilled via localStorage.
  • Runtime identity — APP_SITE_NAME / APP_BRAND_NAME / APP_FOOTER_NAME / APP_TAGLINE injected into env.js at container start; no rebuild required for brand changes.
  • Species auto-discovery — drop a src/domain/species/<id>/index.ts default-exporting a SpeciesManifest and the species appears in the picker. pnpm scaffold:species writes a valid skeleton.
  • Findings catalog v2.0 — full equine catalog authored by the domain expert: 26 zones (9 head + 17 body), 792 nodes, 612 leaves, 41 vet-referral leaves. Schema documented in docs/PATHOLOGIES-FORMAT.md with the 3 standardized categories per zone, 5 taxonomy patterns for dysfunctions, structural authoring rules (depth ≤ 4, ≥ 2 children per intermediate, sibling-scoped ID uniqueness), and the legal-scope disclaimer.
  • Fuzzy zone matcher — SVG data-anno-name-fr / -en ↔ JSON zone.name_fr / name_en bridged via normalize + Levenshtein (EN-first, FR fallback). Tolerant of case, accents, and minor typos.
  • Docker delivery — multi-stage Dockerfile (node:20 → nginx:alpine), docker-compose.yml, entrypoint.sh runtime env injection, nginx SPA fallback + env.js no-cache rule. Production deploy guide in DEPLOY.md.
  • Documentation — README.md, CLAUDE.md (project conventions for Claude), docs/ANATOMY-SVG-CONVENTION.md (SVG data-* contract), docs/ADDING-A-SPECIES.md (recipe for a new species), docs/PATHOLOGIES-FORMAT.md (findings JSON authoring contract), docs/PDF-FORMAT.md (PDF layout placeholder), and project-state notes under .claude/{tasks,memory,audits}/.

Changed

  • Report schema v1 → v2: Observation carries hierarchical findings: Finding[] (zone + path + snapshotted FR/EN label + vet flag) and freeTextFindings: string[]; old pathologyIds / freeTextPathologies removed. ReportSchema.version bumped 1 → 2. v1 PDFs are not migrated — they hard-fail import with a version-specific message (no install base to justify a migration shim).
  • Catalog v1.2 → v2.0 contract: requires_vet_referral boolean is now the sole source of truth for the vet-orientation flag. Generic "orienter vers vétérinaire" wording purged from description_fr on 25 leaves where the boolean alone sufficed. 16 leaves carrying a clinical differential (cause neuro/sinusale/ ligamentaire/etc.) keep their description_fr. Consumers relying on description_fr.includes('vétérinaire') must migrate — all in-tree consumers already key off the boolean.
  • PDF locale = render preference, not a schema field. Finding snapshots already carry both FR and EN labels (labelFrSnapshot / labelEnSnapshot), so exportReportToPdf(report, { locale }) picks the right snapshot at render time without a schema bump.
  • PDF date format — locale-aware via formatDate(iso, locale), replacing the FR-only formatDateFr helper.

Fixed

  • PDF export crashed WinAnsi cannot encode "⚠" (0x26a0) whenever an observation carried a requires_vet_referral finding — pdf/fonts.ts embeds StandardFonts.Helvetica which uses WinAnsi (cp1252, Latin-1 only). PDF vet-referral marker swapped ⚠ → (!) ; picker DOM keeps ⚠ (browsers render U+26A0 natively). Regression test added on widthOfTextAtSize + prefixed label. Follow-up tracked: switch PDF body to embedded TTF (Inter / Fraunces per CLAUDE.md spec) so future non-Latin-1 glyphs work without ASCII surrogates.
  • PDF import error messages localized via typed ImportError discriminant — the prior FR-only messages leaked through to the EN UI on import failure.
  • Detail-popup zone clicks silently dropped — main-only bones map did not know detail SVG ids; fallback lookup bones.get(id) ?? detailBones.get(id) added in the shared click handler.
  • PDF text overlap — drawText({ maxWidth }) wraps glyphs but not the cursor; caller now measures with widthOfTextAtSize and advances cursor per wrapped line.
  • PDF multi-SVG layout — observation pages with N SVGs overflowed page bounds. Now: pre-rasterize all, measure aspect, reserve text-area height, derive cell budget per row; single-SVG layout halved + centered.
  • PDF anatomy rasterization leaks — interaction-only attributes (data-anno-*, transparent hitboxes, faint default fills) stripped before raster, non-selected zones hidden, selected zones recoloured.
  • Zone highlight scoping — collapsed observations no longer leave faint tints on the canvas; highlights re-painted after async SVG mount so detail-popup zones colour correctly.
  • Hyoid label case — SVG data-anno-name-fr="hyoïde" → "Hyoïde" to match the JSON strict-equality rule across all 26 zones (fuzzy matcher still acts as safety net).
  • i18n key parity — fr/en dicts validated by a parity test (Object.keys(fr).sort() deep-equals Object.keys(en).sort()) so a missing translation fails CI instead of falling back to the key literal at runtime.

Known limitations

  • PDF body fonts are StandardFonts.Helvetica / TimesRoman (WinAnsi / Latin-1) instead of the planned TTF Inter / Fraunces. Any non-Latin-1 glyph in PDF text needs an ASCII surrogate until the TTF migration lands.
  • description_fr for sensitive vet-referral leaves and the scope_disclaimer are FR-only; vet-expert authoring is needed for the EN copy.
  • Only the equine species ships. The infrastructure (manifest + auto-discovery + scaffold script + schema) accepts any species — domain expert authoring is the gating step.
  • No backend, no accounts, no cloud sync. Each PDF is the long-term record for the corresponding bilan.

Pre-1.0 milestones (for reference)

These were never tagged but are reflected in git history on main.

  • Scaffold (2026-05-18) — initial skeleton from approved design spec: 80+ files (schemas, stubs, routes, stores, PDF modules, Docker infra), real Horse.svg + Horse_head.svg, pnpm/build/ typecheck/tests all green.
  • Editor polish (2026-05-19) — detail-popup click bridge, VertebraPicker auto-region, PDF rendering fixes (header rule clear, text-line wrapping, multi-SVG grid, halo glow), eyebrow + Times 22 title + accent severity pill.
  • Findings tree pivot (2026-05-20) — B0 schema (findings.ts Zod), B1 Report schema v2 (Observation.findings), B2 UI (FindingsTreePicker replaces flat PathologyPicker), B3 i18n FR/EN site + PDF, B5 stub cleanup. requires_vet_referral boolean introduced alongside the textual fallback.
  • Catalog v2.0 + WinAnsi hotfix (2026-05-21) — full 26-zone horse catalog landed, requires_vet_referral becomes the sole source of truth, PDF vet marker swapped to a WinAnsi-safe surrogate. Docs refreshed, DEPLOY.md + CHANGELOG.md written, repo pushed to https://git.bchanot.fr/bchanot/faunosteo.git.