refactor(anatomy): rename SVG data attrs (bone → anno) per new convention
User updated the clickable-zone convention in the source SVGs:
data-bone-id → data-anno-id
data-bone-fr → data-anno-name-fr
data-bone-en → data-anno-name-en
data-category → data-anno-category
data-opens-detail → data-anno-opens-detail
Bulk-renamed across:
- public/species/equine/Horse.svg + Horse_head.svg (86 anno-attrs each)
- src/anatomy/svgConvention.ts (parser + getBoneIdFromEvent)
- src/anatomy/types.ts (doc strings)
- src/components/canvas/AnatomyCanvas.tsx (querySelector + delegated click)
- src/styles/index.css (`[data-bone-id]` selectors → `[data-anno-id]`)
- src/domain/species/types.ts + schema/observation.ts (doc strings)
- docs/{ANATOMY-SVG-CONVENTION,ADDING-A-SPECIES,superpowers/specs,plans}.md
- CLAUDE.md + .claude/{memory/learnings,tasks/TODO}.md
- tests/unit/{anatomy.svgConvention,anatomy.svgLoader,components.AnatomyCanvas}.test.tsx
Internal TS type names and field names (Bone, boneId, parseSvgBones,
getBoneIdFromEvent) are kept intentionally — they're the application's
logical shape and the persisted JSON contract. ObservationZone.boneId is
the identifier seen in already-exported PDFs; renaming it would break
re-import of those PDFs. Only the SVG-side attribute names change.
90/90 tests pass, lint clean, build clean.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
1 parent
e8c29c1fdf
commit
1109e33383
18 files changed
+308
-308
No files matched your search
@@ -34,7 +34,7 @@ Allowed scopes: `schema`, `store`, `anatomy`, `pdf`, `editor`, `home`, `new`, `u
|
||||
Examples:
|
||||
- `test(schema): cover Report version literal`
|
||||
- `feat(store): implement addObservation`
|
||||
- `feat(anatomy): parse data-bone-id from SVG`
|
||||
- `feat(anatomy): parse data-anno-id from SVG`
|
||||
```
|
||||
|
||||
- [ ] **Step 2:** Commit
|
||||
@@ -453,19 +453,19 @@ function svgFromString(s: string): SVGSVGElement {
|
||||
|
||||
const FIXTURE = `
|
||||
<svg xmlns="http://www.w3.org/2000/svg">
|
||||
<circle data-bone-id="epaule" data-bone-fr="Épaule" data-bone-en="Shoulder"
|
||||
data-category="articulation" class="bone osteo articulation hitbox bone-epaule" />
|
||||
<circle data-bone-id="epaule" data-bone-fr="Épaule" data-bone-en="Shoulder"
|
||||
data-category="articulation" class="bone osteo articulation visible bone-epaule" />
|
||||
<polygon data-bone-id="cervical-vertebrae-spine-zone" data-bone-fr="Vertèbres cervicales"
|
||||
data-bone-en="Cervical Vertebrae" data-category="spine-zone"
|
||||
<circle data-anno-id="epaule" data-anno-name-fr="Épaule" data-anno-name-en="Shoulder"
|
||||
data-anno-category="articulation" class="bone osteo articulation hitbox bone-epaule" />
|
||||
<circle data-anno-id="epaule" data-anno-name-fr="Épaule" data-anno-name-en="Shoulder"
|
||||
data-anno-category="articulation" class="bone osteo articulation visible bone-epaule" />
|
||||
<polygon data-anno-id="cervical-vertebrae-spine-zone" data-anno-name-fr="Vertèbres cervicales"
|
||||
data-anno-name-en="Cervical Vertebrae" data-anno-category="spine-zone"
|
||||
class="bone osteo spine-zone bone-cervical-vertebrae" />
|
||||
<polygon data-bone-id="zone-head" data-bone-fr="Crane" data-bone-en="Head"
|
||||
data-category="head" data-opens-detail="head" />
|
||||
<polygon data-anno-id="zone-head" data-anno-name-fr="Crane" data-anno-name-en="Head"
|
||||
data-anno-category="head" data-anno-opens-detail="head" />
|
||||
</svg>`
|
||||
|
||||
describe('parseSvgBones', () => {
|
||||
it('groups hitbox + visible by data-bone-id', () => {
|
||||
it('groups hitbox + visible by data-anno-id', () => {
|
||||
const map = parseSvgBones(svgFromString(FIXTURE))
|
||||
const epaule = map.get('epaule')
|
||||
expect(epaule).toBeDefined()
|
||||
@@ -488,16 +488,16 @@ describe('parseSvgBones', () => {
|
||||
})
|
||||
|
||||
describe('parseSvgBones validation', () => {
|
||||
it('throws on missing data-bone-fr', () => {
|
||||
it('throws on missing data-anno-name-fr', () => {
|
||||
const bad = `<svg xmlns="http://www.w3.org/2000/svg">
|
||||
<circle data-bone-id="x" data-bone-en="X" data-category="os" />
|
||||
<circle data-anno-id="x" data-anno-name-en="X" data-anno-category="os" />
|
||||
</svg>`
|
||||
expect(() => parseSvgBones(svgFromString(bad))).toThrow(SvgConventionError)
|
||||
})
|
||||
|
||||
it('throws on unknown category', () => {
|
||||
const bad = `<svg xmlns="http://www.w3.org/2000/svg">
|
||||
<circle data-bone-id="x" data-bone-fr="X" data-bone-en="X" data-category="bogus" />
|
||||
<circle data-anno-id="x" data-anno-name-fr="X" data-anno-name-en="X" data-anno-category="bogus" />
|
||||
</svg>`
|
||||
expect(() => parseSvgBones(svgFromString(bad))).toThrow(SvgConventionError)
|
||||
})
|
||||
@@ -554,36 +554,36 @@ function classList(el: Element): string[] {
|
||||
}
|
||||
|
||||
export function validateBoneElement(el: Element): void {
|
||||
const boneId = el.getAttribute('data-bone-id') ?? ''
|
||||
for (const attr of ['data-bone-fr', 'data-bone-en', 'data-category']) {
|
||||
const boneId = el.getAttribute('data-anno-id') ?? ''
|
||||
for (const attr of ['data-anno-name-fr', 'data-anno-name-en', 'data-anno-category']) {
|
||||
if (!el.getAttribute(attr)) {
|
||||
throw new SvgConventionError(
|
||||
`Element data-bone-id="${boneId}" missing attribute ${attr}`,
|
||||
`Element data-anno-id="${boneId}" missing attribute ${attr}`,
|
||||
boneId,
|
||||
attr,
|
||||
)
|
||||
}
|
||||
}
|
||||
const cat = el.getAttribute('data-category') ?? ''
|
||||
const cat = el.getAttribute('data-anno-category') ?? ''
|
||||
if (!isValidCategory(cat)) {
|
||||
throw new SvgConventionError(
|
||||
`Element data-bone-id="${boneId}" has unknown data-category="${cat}"`,
|
||||
`Element data-anno-id="${boneId}" has unknown data-anno-category="${cat}"`,
|
||||
boneId,
|
||||
'data-category',
|
||||
'data-anno-category',
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
export function parseSvgBones(svgRoot: SVGSVGElement): Map<string, Bone> {
|
||||
const map = new Map<string, Bone>()
|
||||
const all = svgRoot.querySelectorAll<Element>('[data-bone-id]')
|
||||
const all = svgRoot.querySelectorAll<Element>('[data-anno-id]')
|
||||
all.forEach((el) => {
|
||||
validateBoneElement(el)
|
||||
const id = el.getAttribute('data-bone-id') as string
|
||||
const fr = el.getAttribute('data-bone-fr') as string
|
||||
const en = el.getAttribute('data-bone-en') as string
|
||||
const category = el.getAttribute('data-category') as BoneCategory
|
||||
const opensDetail = el.getAttribute('data-opens-detail') ?? undefined
|
||||
const id = el.getAttribute('data-anno-id') as string
|
||||
const fr = el.getAttribute('data-anno-name-fr') as string
|
||||
const en = el.getAttribute('data-anno-name-en') as string
|
||||
const category = el.getAttribute('data-anno-category') as BoneCategory
|
||||
const opensDetail = el.getAttribute('data-anno-opens-detail') ?? undefined
|
||||
const classes = classList(el)
|
||||
const isHitbox = classes.includes('hitbox')
|
||||
|
||||
@@ -610,7 +610,7 @@ export function parseSvgBones(svgRoot: SVGSVGElement): Map<string, Bone> {
|
||||
export function getBoneIdFromEvent(event: Event): string | null {
|
||||
let node = event.target as Element | null
|
||||
while (node && node.nodeType === 1) {
|
||||
const id = node.getAttribute?.('data-bone-id')
|
||||
const id = node.getAttribute?.('data-anno-id')
|
||||
if (id) return id
|
||||
node = node.parentElement
|
||||
}
|
||||
@@ -710,7 +710,7 @@ git commit -m "test(anatomy): cover real Horse.svg + Horse_head.svg parsing"
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { loadSvg } from '@/anatomy/svgLoader'
|
||||
|
||||
const SVG = '<svg xmlns="http://www.w3.org/2000/svg"><g data-bone-id="x"/></svg>'
|
||||
const SVG = '<svg xmlns="http://www.w3.org/2000/svg"><g data-anno-id="x"/></svg>'
|
||||
|
||||
describe('loadSvg', () => {
|
||||
beforeEach(() => {
|
||||
@@ -1682,8 +1682,8 @@ body {
|
||||
.svg-canvas [data-state='current'] { fill: var(--color-accent) !important; fill-opacity: 0.85 !important; }
|
||||
.svg-canvas [data-state='linked'] { stroke-dasharray: 4 3; stroke: var(--color-accent); fill-opacity: 0.35 !important; }
|
||||
.svg-canvas [data-state='multi'] { fill: var(--color-accent) !important; fill-opacity: 0.65 !important; stroke: var(--color-ink); stroke-width: 1.5; }
|
||||
.svg-canvas [data-bone-id] { cursor: pointer; }
|
||||
.svg-canvas [data-bone-id]:hover { filter: brightness(1.05); }
|
||||
.svg-canvas [data-anno-id] { cursor: pointer; }
|
||||
.svg-canvas [data-anno-id]:hover { filter: brightness(1.05); }
|
||||
```
|
||||
|
||||
- [ ] **Step 3:** Verify build
|
||||
@@ -1771,10 +1771,10 @@ vi.mock('@/anatomy/svgLoader', () => ({
|
||||
loadSvg: vi.fn(async () => {
|
||||
const doc = new DOMParser().parseFromString(
|
||||
`<svg xmlns="http://www.w3.org/2000/svg">
|
||||
<circle data-bone-id="epaule" data-bone-fr="Épaule" data-bone-en="Shoulder"
|
||||
data-category="articulation" class="bone osteo articulation hitbox bone-epaule" />
|
||||
<circle data-bone-id="epaule" data-bone-fr="Épaule" data-bone-en="Shoulder"
|
||||
data-category="articulation" class="bone osteo articulation visible bone-epaule" />
|
||||
<circle data-anno-id="epaule" data-anno-name-fr="Épaule" data-anno-name-en="Shoulder"
|
||||
data-anno-category="articulation" class="bone osteo articulation hitbox bone-epaule" />
|
||||
<circle data-anno-id="epaule" data-anno-name-fr="Épaule" data-anno-name-en="Shoulder"
|
||||
data-anno-category="articulation" class="bone osteo articulation visible bone-epaule" />
|
||||
</svg>`,
|
||||
'image/svg+xml',
|
||||
)
|
||||
@@ -1788,7 +1788,7 @@ describe('AnatomyCanvas', () => {
|
||||
it('renders the loaded SVG inline', async () => {
|
||||
render(<AnatomyCanvas src="/x.svg" boneStates={new Map()} onZoneClick={() => {}} />)
|
||||
await waitFor(() =>
|
||||
expect(document.querySelector('[data-bone-id="epaule"]')).not.toBeNull(),
|
||||
expect(document.querySelector('[data-anno-id="epaule"]')).not.toBeNull(),
|
||||
)
|
||||
})
|
||||
|
||||
@@ -1796,7 +1796,7 @@ describe('AnatomyCanvas', () => {
|
||||
const onZoneClick = vi.fn()
|
||||
render(<AnatomyCanvas src="/x.svg" boneStates={new Map()} onZoneClick={onZoneClick} />)
|
||||
await waitFor(() => screen.getByTestId('anatomy-canvas'))
|
||||
;(document.querySelector('[data-bone-id="epaule"]') as Element).dispatchEvent(
|
||||
;(document.querySelector('[data-anno-id="epaule"]') as Element).dispatchEvent(
|
||||
new Event('click', { bubbles: true }),
|
||||
)
|
||||
await waitFor(() => expect(onZoneClick).toHaveBeenCalledWith('epaule'))
|
||||
@@ -1854,9 +1854,9 @@ export default function AnatomyCanvas({
|
||||
useEffect(() => {
|
||||
const c = containerRef.current
|
||||
if (!c) return
|
||||
const all = c.querySelectorAll<Element>('[data-bone-id]')
|
||||
const all = c.querySelectorAll<Element>('[data-anno-id]')
|
||||
all.forEach((el) => {
|
||||
const id = el.getAttribute('data-bone-id') as string
|
||||
const id = el.getAttribute('data-anno-id') as string
|
||||
const state = boneStates.get(id)
|
||||
if (state && state !== 'default') el.setAttribute('data-state', state)
|
||||
else el.removeAttribute('data-state')
|
||||
@@ -4224,7 +4224,7 @@ git commit -m "test(qa): document MVP manual QA checklist outcome"
|
||||
- Modify: `docs/ADDING-A-SPECIES.md`
|
||||
|
||||
- [ ] **Step 1:** Rewrite from the placeholder, covering:
|
||||
1. SVG convention (refer to `docs/ANATOMY-SVG-CONVENTION.md`): `data-bone-id`, `data-bone-fr`, `data-bone-en`, `data-category`, optional `data-opens-detail`.
|
||||
1. SVG convention (refer to `docs/ANATOMY-SVG-CONVENTION.md`): `data-anno-id`, `data-anno-name-fr`, `data-anno-name-en`, `data-anno-category`, optional `data-anno-opens-detail`.
|
||||
2. Where to drop the SVG: `public/species/<id>/<Main>.svg` + any detail SVGs.
|
||||
3. Create the species manifest at `src/domain/species/<id>/index.ts` with `id`, `labelFr`, `mainSvg`, `details`, `vertebralFormula`, and a `pathologies` lazy import.
|
||||
4. Wire the manifest into `src/domain/species/registry.ts`.
|
||||
|
||||
@@ -84,7 +84,7 @@ type Severity = 'légère' | 'modérée' | 'sévère';
|
||||
type Vertebra = { region: 'C' | 'T' | 'L' | 'S' | 'Cd'; index: number };
|
||||
|
||||
type ObservationZone = {
|
||||
boneId: string; // matches data-bone-id from SVG
|
||||
boneId: string; // matches data-anno-id from SVG
|
||||
detailSourceId?: string; // when this zone came from a detail pop-up SVG
|
||||
vertebrae?: Vertebra[]; // when boneId is a spine-zone
|
||||
};
|
||||
@@ -139,9 +139,9 @@ All JSON carries `version: 1`. Future migrations bump the version.
|
||||
|
||||
## SVG convention (source of truth)
|
||||
|
||||
A clickable zone is any element carrying `data-bone-id`. Required data
|
||||
attributes: `data-bone-id`, `data-bone-fr`, `data-bone-en`, `data-category`.
|
||||
Optional: `data-opens-detail="<id>"`.
|
||||
A clickable zone is any element carrying `data-anno-id`. Required data
|
||||
attributes: `data-anno-id`, `data-anno-name-fr`, `data-anno-name-en`, `data-anno-category`.
|
||||
Optional: `data-anno-opens-detail="<id>"`.
|
||||
|
||||
Categories: `articulation` · `charniere` · `spine-zone` · `os` · `os-overlay`
|
||||
· `head` · `cadran-crane`.
|
||||
@@ -149,29 +149,29 @@ Categories: `articulation` · `charniere` · `spine-zone` · `os` · `os-overlay
|
||||
Two rendering patterns are tolerated in the SVG:
|
||||
|
||||
1. **hitbox + visible twin** (articulation, charniere, os-overlay, head):
|
||||
two elements share the same `data-bone-id`. One has `class*="hitbox"`,
|
||||
two elements share the same `data-anno-id`. One has `class*="hitbox"`,
|
||||
transparent fill, `pointer-events: all`. The other has `class*="visible"`,
|
||||
colored fill, `pointer-events: none`.
|
||||
2. **single element** (spine-zone, head zone): one polygon carries everything;
|
||||
`pointer-events: all` and `cursor: pointer` directly.
|
||||
|
||||
Parser strategy (`src/anatomy/svgConvention.ts`):
|
||||
- Walk all elements with `data-bone-id`.
|
||||
- Group by `data-bone-id` → one logical `Bone`.
|
||||
- Walk all elements with `data-anno-id`.
|
||||
- Group by `data-anno-id` → one logical `Bone`.
|
||||
- Bone fields: `id`, `fr`, `en`, `category`, `opensDetail?`, `hitboxEls[]`,
|
||||
`visibleEls[]`.
|
||||
- Validate: must have `data-bone-fr`, `data-bone-en`, `data-category` (in
|
||||
- Validate: must have `data-anno-name-fr`, `data-anno-name-en`, `data-anno-category` (in
|
||||
the allowed enum). Throws structured `SvgConventionError` on missing
|
||||
attributes.
|
||||
|
||||
Click handling: a single delegated listener on the root `<svg>` walks up
|
||||
from `event.target` to the nearest element with `data-bone-id`. If
|
||||
`data-opens-detail` is present → open the detail modal mapped via the
|
||||
from `event.target` to the nearest element with `data-anno-id`. If
|
||||
`data-anno-opens-detail` is present → open the detail modal mapped via the
|
||||
species manifest. If the bone's category is `spine-zone` → open the
|
||||
vertebra picker. Otherwise add the bone to the current observation.
|
||||
|
||||
Colorization: when the current observation contains a bone, all elements
|
||||
matching that `data-bone-id` get a `data-state` attribute toggled by JS:
|
||||
matching that `data-anno-id` get a `data-state` attribute toggled by JS:
|
||||
`current` (solid accent), `linked` (faded dashed border, "in another
|
||||
observation"), `multi` (striped pattern, "in ≥2 observations").
|
||||
|
||||
@@ -193,7 +193,7 @@ export const equine = {
|
||||
};
|
||||
```
|
||||
|
||||
When a zone with `data-opens-detail="head"` is clicked, the canvas
|
||||
When a zone with `data-anno-opens-detail="head"` is clicked, the canvas
|
||||
emits a `requestDetail({id: 'head'})` event handled by `DetailModal`, which
|
||||
loads `/species/equine/Horse_head.svg` and renders it inline. Clicks inside
|
||||
the modal add zones with `detailSourceId: 'head'` to the current
|
||||
@@ -202,7 +202,7 @@ persisted in the report.
|
||||
|
||||
## Vertebra picker
|
||||
|
||||
Triggered when a clicked bone has `data-category="spine-zone"`. Modal with
|
||||
Triggered when a clicked bone has `data-anno-category="spine-zone"`. Modal with
|
||||
region tabs (Cervicales C1–C7, Thoraciques T1–T18, Lombaires L1–L6,
|
||||
Sacrales S1–S5, Caudales Cd1–Cd18). Each region renders chips in a grid;
|
||||
multi-select; ≥40 px touch targets; per-region "Tout cocher / décocher".
|
||||
@@ -341,7 +341,7 @@ port.
|
||||
| SVG injection | Fetch text → DOMParser → inline render (consistent + CSS-controllable + sandboxing irrelevant since assets are local). |
|
||||
| Vertebra picker UX | Region tabs + chip grid, multi-select, ≥40 px touch targets. |
|
||||
| Multi-obs zone overlay | current / linked / multi states; striped pattern + tooltip. |
|
||||
| Detail SVG trigger | `data-opens-detail` → modal with inline detail SVG, clicks add to current obs. |
|
||||
| Detail SVG trigger | `data-anno-opens-detail` → modal with inline detail SVG, clicks add to current obs. |
|
||||
| SVG → PDF | canvg → canvas @ 2× → PNG → `embedPng`. |
|
||||
| Pathology sources in PDF | Abbreviated citation list below each obs, no raw URLs. |
|
||||
| Brand env vars | Runtime `window.__APP_CONFIG__` + Vite-define fallback. |
|
||||
|
||||
Reference in new issue
Block a user