From fc3fec7654b1d14f6b97248af3c20584ec708d41 Mon Sep 17 00:00:00 2001 From: bchanot Date: Thu, 12 Nov 2026 20:01:47 +0100 Subject: [PATCH] refactor(editor): rename the reference panel's place to citations MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Frees the name « references » for the fifth tab (R2.1). The panel's data-place, PlaceName and ids become citations; no visible change. EditorTarget, move kind, i18n keys and domain fields keep their names (removed in R2.1). R-24 (no assertion removed or weakened): unit editor-route, no-loss, references-panel, route-recovery ids editor-references-* -> editor-citations-*; keep-alive inPlace/place('references') -> 'citations'; focus-request ownedBy 'references' -> 'citations'. e2e support openReferences / closeReferences, crossing 204/271, journeys 247, layout 234/305, deselect 229, shell 135 -> place 'citations'; crossing 205 searchbox and structures 95 « citée 0 fois » -> libraryRoot(page) (new helper). Gates: typecheck, lint, test:run (app 1382), build, e2e:ui 251 passed, e2e:shell 7 specs 63 passed / 63 skipped on db:sandbox (editor-equine not listed); full-row guard: no pre-existing row changed in any table. --- apps/app/e2e/shell/editor-deselect.spec.ts | 2 +- apps/app/e2e/shell/editor-shell-crossing.spec.ts | 7 ++++--- apps/app/e2e/shell/editor-shell-journeys.spec.ts | 2 +- apps/app/e2e/shell/editor-shell-layout.spec.ts | 4 ++-- apps/app/e2e/shell/editor-shell.spec.ts | 2 +- apps/app/e2e/shell/editor-structures.spec.ts | 4 ++-- apps/app/e2e/support/editor.ts | 9 +++++++-- .../src/components/editor/EditorWorkspace.tsx | 4 ++-- apps/app/src/components/editor/HeaderActions.tsx | 2 +- .../editor/references/ReferencesPanel.tsx | 8 ++++---- apps/app/src/editor/focusRequest.ts | 4 ++-- apps/app/src/editor/useEditorNavigation.ts | 2 +- .../app/tests/unit/editor-focus-request.test.tsx | 2 +- apps/app/tests/unit/editor-keep-alive.test.tsx | 16 ++++++++-------- apps/app/tests/unit/editor-no-loss.test.tsx | 2 +- .../tests/unit/editor-references-panel.test.tsx | 2 +- .../tests/unit/editor-route-recovery.test.tsx | 4 ++-- apps/app/tests/unit/editor-route.test.tsx | 10 +++++----- 18 files changed, 46 insertions(+), 40 deletions(-) diff --git a/apps/app/e2e/shell/editor-deselect.spec.ts b/apps/app/e2e/shell/editor-deselect.spec.ts index 1cb52600..bdc31716 100644 --- a/apps/app/e2e/shell/editor-deselect.spec.ts +++ b/apps/app/e2e/shell/editor-deselect.spec.ts @@ -226,7 +226,7 @@ test.describe('deselect and D6b (editor, mouse and keyboard)', () => { // The references panel: it closes, the selection stays, a second Escape deselects. await openReferences(page, dict) await page.keyboard.press('Escape') - await expect(place(page, 'references')).toHaveCount(0) + await expect(place(page, 'citations')).toHaveCount(0) await expectKept(page, POINT) await box(page).focus() await page.keyboard.press('Escape') diff --git a/apps/app/e2e/shell/editor-shell-crossing.spec.ts b/apps/app/e2e/shell/editor-shell-crossing.spec.ts index 3d6c6f44..9bd2324e 100644 --- a/apps/app/e2e/shell/editor-shell-crossing.spec.ts +++ b/apps/app/e2e/shell/editor-shell-crossing.spec.ts @@ -10,6 +10,7 @@ import { editorActor, geometryField, historyButton, + libraryRoot, openEditor, openReferences, openSection, @@ -201,8 +202,8 @@ test.describe('editor shell, width crossing (H)', () => { dict['editor.reference.add'], 'annotations', ) - await expect(place(page, 'references')).toBeVisible() - await expect(place(page, 'references').getByRole('searchbox')).toBeVisible() + await expect(place(page, 'citations')).toBeVisible() + await expect(libraryRoot(page).getByRole('searchbox')).toBeVisible() }) test('the annotation edit body keeps its tool and its pending creation', async ({ @@ -268,7 +269,7 @@ test.describe('editor shell, width crossing (H)', () => { await page.locator('#reference-new-citation').fill('Smith 1999') await cross(page, NARROW) await expectReadOnly(page) - await expect(place(page, 'references')).toBeVisible() + await expect(place(page, 'citations')).toBeVisible() await expect(saveLine(page)).toHaveText(UNSAVED_LINE) await cross(page, WIDE) await expect(page.locator('#reference-new-citation')).toHaveValue( diff --git a/apps/app/e2e/shell/editor-shell-journeys.spec.ts b/apps/app/e2e/shell/editor-shell-journeys.spec.ts index 357a0e48..0be1260b 100644 --- a/apps/app/e2e/shell/editor-shell-journeys.spec.ts +++ b/apps/app/e2e/shell/editor-shell-journeys.spec.ts @@ -244,7 +244,7 @@ test.describe('editor shell journeys (H)', () => { await selectTab(page, dict, 'verification') await goTo('Barone, Ostéologie') - await expect(place(page, 'references')).toBeVisible() + await expect(place(page, 'citations')).toBeVisible() await focusKey('ref-a') await closeReferences(page, dict) }) diff --git a/apps/app/e2e/shell/editor-shell-layout.spec.ts b/apps/app/e2e/shell/editor-shell-layout.spec.ts index 3274c506..9b852e51 100644 --- a/apps/app/e2e/shell/editor-shell-layout.spec.ts +++ b/apps/app/e2e/shell/editor-shell-layout.spec.ts @@ -231,7 +231,7 @@ function focusKind(page: Page): Promise { return page.evaluate((undoName) => { const el = document.activeElement if (!el) return 'other' - if (el.closest('[data-place="references"]')) return 'panel' + if (el.closest('[data-place="citations"]')) return 'panel' if (el.getAttribute('role') === 'tab') return 'tab' if (el.closest('[data-testid="history-buttons"]')) { return el.getAttribute('aria-label') === undoName ? 'undo' : 'redo' @@ -302,7 +302,7 @@ test.describe('editor shell keyboard order (H)', () => { }) expect(order).toEqual(['header', 'tab', 'undo', 'redo', 'panel']) await page.keyboard.press('Escape') - await expect(page.locator('[data-place="references"]:visible')).toHaveCount( + await expect(page.locator('[data-place="citations"]:visible')).toHaveCount( 0, ) const after = await walk(page, 'side') diff --git a/apps/app/e2e/shell/editor-shell.spec.ts b/apps/app/e2e/shell/editor-shell.spec.ts index b37472e9..767a7ee2 100644 --- a/apps/app/e2e/shell/editor-shell.spec.ts +++ b/apps/app/e2e/shell/editor-shell.spec.ts @@ -132,7 +132,7 @@ test.describe('editor shell, kept places (B2a)', () => { .click() const header = page.locator('main header').first() const tabs = page.getByRole('tablist') - const panel = place(page, 'references') + const panel = place(page, 'citations') const targets = [ page.getByRole('button', { name: dict['common.save'], exact: true }), page.getByRole('button', { diff --git a/apps/app/e2e/shell/editor-structures.spec.ts b/apps/app/e2e/shell/editor-structures.spec.ts index bca3a8a1..fd1ac04c 100644 --- a/apps/app/e2e/shell/editor-structures.spec.ts +++ b/apps/app/e2e/shell/editor-structures.spec.ts @@ -6,11 +6,11 @@ import { bareShape, closeReferences, editorActor, + libraryRoot, openEditor, openReferences, openSection, pickAnnotation, - place, pointOf, revisionText, saveDraft, @@ -92,7 +92,7 @@ test.describe('editor structures (A4)', () => { ) await expect(citations).toHaveCount(2) await expect( - place(page, 'references').getByText('citée 0 fois'), + libraryRoot(page).getByText('citée 0 fois'), ).toHaveCount(2) await page .getByRole('searchbox', { name: dict['editor.references.search'] }) diff --git a/apps/app/e2e/support/editor.ts b/apps/app/e2e/support/editor.ts index 6edc1969..c8565bcd 100644 --- a/apps/app/e2e/support/editor.ts +++ b/apps/app/e2e/support/editor.ts @@ -373,6 +373,11 @@ export async function openSection( await expect(place(page, `annotations.${section}`)).toBeVisible() } +/** Where the references library shows: today the citations panel (R2.1 moves it to its tab). */ +export function libraryRoot(page: Page): Locator { + return place(page, 'citations') +} + /** Opens the references panel from the header button. */ export async function openReferences(page: Page, dict: Dict) { const toggle = page.getByRole('button', { @@ -381,14 +386,14 @@ export async function openReferences(page: Page, dict: Dict) { }) if ((await toggle.getAttribute('aria-expanded')) !== 'true') await toggle.click() - await expect(place(page, 'references')).toBeVisible() + await expect(place(page, 'citations')).toBeVisible() } export async function closeReferences(page: Page, dict: Dict) { await page .getByRole('button', { name: dict['editor.references.close'] }) .click() - await expect(place(page, 'references')).toHaveCount(0) + await expect(place(page, 'citations')).toHaveCount(0) } /** The revision the server holds for the draft. */ diff --git a/apps/app/src/components/editor/EditorWorkspace.tsx b/apps/app/src/components/editor/EditorWorkspace.tsx index c528bd1a..12c55f48 100644 --- a/apps/app/src/components/editor/EditorWorkspace.tsx +++ b/apps/app/src/components/editor/EditorWorkspace.tsx @@ -89,13 +89,13 @@ function Places({ nav, readOnly, reloadSheet }: PlacesProps) {
{state.referencesMounted && ( props.onToggleReferences(event.currentTarget)} > diff --git a/apps/app/src/components/editor/references/ReferencesPanel.tsx b/apps/app/src/components/editor/references/ReferencesPanel.tsx index 7e34978c..619c3eeb 100644 --- a/apps/app/src/components/editor/references/ReferencesPanel.tsx +++ b/apps/app/src/components/editor/references/ReferencesPanel.tsx @@ -69,7 +69,7 @@ function PanelHeader({ onClose }: { onClose: () => void }) { return (

diff --git a/apps/app/src/editor/focusRequest.ts b/apps/app/src/editor/focusRequest.ts index 0e98da2a..c81011ba 100644 --- a/apps/app/src/editor/focusRequest.ts +++ b/apps/app/src/editor/focusRequest.ts @@ -19,10 +19,10 @@ export type FocusOutcome = 'found' | 'kept' | 'none' export type PlaceName = | EditorTabId | `annotations.${AnnotationSection}` - | 'references' + | 'citations' export function placeOf(target: EditorTarget): PlaceName { - if (target.place === 'references') return 'references' + if (target.place === 'references') return 'citations' if (target.tab !== 'annotations') return target.tab return `annotations.${target.section ?? 'drawing'}` } diff --git a/apps/app/src/editor/useEditorNavigation.ts b/apps/app/src/editor/useEditorNavigation.ts index 8acc2d90..48b696ea 100644 --- a/apps/app/src/editor/useEditorNavigation.ts +++ b/apps/app/src/editor/useEditorNavigation.ts @@ -198,7 +198,7 @@ function referencesBack(opener: HTMLElement | null): HTMLElement | null { /** Where the focus lands after a programmatic move; never `body`. */ function landingOf(move: Move, state: NavigationState): HTMLElement | null { - if (move.kind === 'references') return headingOf('references') + if (move.kind === 'references') return headingOf('citations') const place = state.focus ? placeOf(state.focus.target) : shownPlace(state) return headingOf(place) ?? tabButton(state.tab) } diff --git a/apps/app/tests/unit/editor-focus-request.test.tsx b/apps/app/tests/unit/editor-focus-request.test.tsx index 41dbb6d8..a5f449c9 100644 --- a/apps/app/tests/unit/editor-focus-request.test.tsx +++ b/apps/app/tests/unit/editor-focus-request.test.tsx @@ -223,7 +223,7 @@ describe('ownedBy', () => { expect(ownedBy(view, 'annotations.drawing')).toBeUndefined() expect(ownedBy(view, 'general')).toBeUndefined() const ref = request({ kind: 'reference', id: 'ref-a' }) - expect(ownedBy(ref, 'references')).toBe(ref) + expect(ownedBy(ref, 'citations')).toBe(ref) expect(ownedBy(ref, 'findings')).toBeUndefined() expect(ownedBy(undefined, 'general')).toBeUndefined() }) diff --git a/apps/app/tests/unit/editor-keep-alive.test.tsx b/apps/app/tests/unit/editor-keep-alive.test.tsx index 8182204d..a1d13e80 100644 --- a/apps/app/tests/unit/editor-keep-alive.test.tsx +++ b/apps/app/tests/unit/editor-keep-alive.test.tsx @@ -178,12 +178,12 @@ describe('text typed in a place that is left', () => { it('the reference add form survives closing and reopening the panel', async () => { const user = await mount() await user.click(referencesButton()) - const field = inPlace('references').getByLabelText('Citation', { + const field = inPlace('citations').getByLabelText('Citation', { selector: '#reference-new-citation', }) await user.type(field, 'Smith 1999') await user.click(referencesButton()) - expect(place('references')).not.toBeVisible() + expect(place('citations')).not.toBeVisible() await user.click(referencesButton()) expect(field).toHaveValue('Smith 1999') expect(store.getState().unsaved).toBe(false) @@ -311,7 +311,7 @@ describe('a field still focused while a place is left', () => { const before = store.getState().documentText await user.click(tab(/Vérification/)) await user.click(referencesButton()) - const field = inPlace('references').getByLabelText('Citation', { + const field = inPlace('citations').getByLabelText('Citation', { selector: '#reference-ref-1-citation', }) await user.click(field) @@ -325,7 +325,7 @@ describe('a field still focused while a place is left', () => { JSON.parse(store.getState().documentText).references[0].citation, ).toBe('Doe 2023') expect(store.getState().unsaved).toBe(true) - expect(place('references')).not.toBeVisible() + expect(place('citations')).not.toBeVisible() act(() => void store.getState().undoStep()) expect(store.getState().documentText).toBe(before) }) @@ -333,13 +333,13 @@ describe('a field still focused while a place is left', () => { it('Escape in a reference field commits the text before the panel hides', async () => { const user = await mount(referenceText()) await user.click(referencesButton()) - const field = inPlace('references').getByLabelText('Citation', { + const field = inPlace('citations').getByLabelText('Citation', { selector: '#reference-ref-1-citation', }) await user.click(field) fireEvent.change(field, { target: { value: 'Doe 2021' } }) await user.keyboard('{Escape}') - expect(place('references')).not.toBeVisible() + expect(place('citations')).not.toBeVisible() const doc: AnatomicalSheetDocument = JSON.parse( store.getState().documentText, ) @@ -350,13 +350,13 @@ describe('a field still focused while a place is left', () => { it('the header toggle (no focus move) closes the panel after committing', async () => { const user = await mount(referenceText()) await user.click(referencesButton()) - const field = inPlace('references').getByLabelText('Citation', { + const field = inPlace('citations').getByLabelText('Citation', { selector: '#reference-ref-1-citation', }) await user.click(field) fireEvent.change(field, { target: { value: 'Doe 2022' } }) fireEvent.click(referencesButton()) - expect(place('references')).not.toBeVisible() + expect(place('citations')).not.toBeVisible() expect( JSON.parse(store.getState().documentText).references[0].citation, ).toBe('Doe 2022') diff --git a/apps/app/tests/unit/editor-no-loss.test.tsx b/apps/app/tests/unit/editor-no-loss.test.tsx index ee3f4d75..66eac932 100644 --- a/apps/app/tests/unit/editor-no-loss.test.tsx +++ b/apps/app/tests/unit/editor-no-loss.test.tsx @@ -293,7 +293,7 @@ describe('the guards of a width change', () => { it('the references search, shown in both modes, keeps its focus and its text', async () => { const user = await mount() await user.click(button('Références')) - const panel = screen.getByTestId('editor-references-panel') + const panel = screen.getByTestId('editor-citations-panel') const search = within(panel).getByRole('searchbox', { name: 'Rechercher une référence', }) diff --git a/apps/app/tests/unit/editor-references-panel.test.tsx b/apps/app/tests/unit/editor-references-panel.test.tsx index b59b0843..0dcfbd6f 100644 --- a/apps/app/tests/unit/editor-references-panel.test.tsx +++ b/apps/app/tests/unit/editor-references-panel.test.tsx @@ -83,7 +83,7 @@ function sheetText(): string { const ready = () => screen.findByRole('heading', { level: 1, name: 'Brouillon, version 4' }) const header = () => screen.getByRole('button', { name: 'Références' }) -const panel = () => screen.getByTestId('editor-references-panel') +const panel = () => screen.getByTestId('editor-citations-panel') const cards = () => within(panel()).getAllByRole('listitem') const search = () => within(panel()).getByRole('searchbox', { name: 'Rechercher une référence' }) diff --git a/apps/app/tests/unit/editor-route-recovery.test.tsx b/apps/app/tests/unit/editor-route-recovery.test.tsx index ce402666..bea26853 100644 --- a/apps/app/tests/unit/editor-route-recovery.test.tsx +++ b/apps/app/tests/unit/editor-route-recovery.test.tsx @@ -91,9 +91,9 @@ describe('the blocking offer', () => { expect(useLeaveGuardStore.getState().armed).toBe(true) // consultation: tabs still switch await user.click(screen.getByRole('button', { name: 'Références' })) - expect(screen.getByTestId('editor-references-panel')).toHaveAttribute( + expect(screen.getByTestId('editor-citations-panel')).toHaveAttribute( 'aria-labelledby', - 'editor-references-title', + 'editor-citations-title', ) // editing: refused by the store, no save offered expect(commitMove(40)).toMatchObject({ diff --git a/apps/app/tests/unit/editor-route.test.tsx b/apps/app/tests/unit/editor-route.test.tsx index 90149827..405b50c9 100644 --- a/apps/app/tests/unit/editor-route.test.tsx +++ b/apps/app/tests/unit/editor-route.test.tsx @@ -173,9 +173,9 @@ describe('references panel', () => { mountDraft() await ready() expect(button()).toHaveAttribute('aria-expanded', 'false') - expect(screen.queryByTestId('editor-references-panel')).toBeNull() + expect(screen.queryByTestId('editor-citations-panel')).toBeNull() await user.click(button()) - const panel = screen.getByTestId('editor-references-panel') + const panel = screen.getByTestId('editor-citations-panel') expect(panel).toBeVisible() expect(button()).toHaveAttribute('aria-expanded', 'true') expect(document.activeElement).toBe( @@ -197,11 +197,11 @@ describe('references panel', () => { mountDraft() await ready() await user.click(button()) - const panel = screen.getByTestId('editor-references-panel') + const panel = screen.getByTestId('editor-citations-panel') await user.keyboard('{Escape}') expect(panel).not.toBeVisible() await user.click(button()) - expect(screen.getByTestId('editor-references-panel')).toBe(panel) + expect(screen.getByTestId('editor-citations-panel')).toBe(panel) expect(panel).toBeVisible() }) @@ -210,7 +210,7 @@ describe('references panel', () => { mountDraft({ width: 800 }) await ready() await user.click(button()) - const panel = screen.getByTestId('editor-references-panel') + const panel = screen.getByTestId('editor-citations-panel') expect(within(panel).queryByRole('textbox')).toBeNull() expect( within(panel).queryByRole('button', { name: 'Ajouter la référence' }),