Compare commits
37 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 3aff10557c | |||
| e8fe24f755 | |||
| fc170ccf10 | |||
| 3ae9d87e6e | |||
| 3dbede6bc2 | |||
| ba238ca962 | |||
| 7cabebc338 | |||
| 74cde67a54 | |||
| 900f85f8ac | |||
| 00a7ce772e | |||
| 71dee23028 | |||
| 91716e628a | |||
| 002af9d1f8 | |||
| d8d8035850 | |||
| 704b159d48 | |||
| c1bddb47c4 | |||
| a21ab85576 | |||
| 7ddf6967ce | |||
| 404cf67f35 | |||
| 50d2512123 | |||
| c689b8c0e9 | |||
| acdaf8d07f | |||
| 77c56f7a9d | |||
| 030472c2da | |||
| f1eb6a9ba5 | |||
| 285a1323ad | |||
| da3e078fbc | |||
| 0def81ab42 | |||
| 546680017d | |||
| 3efb7e175d | |||
| 56076c4daa | |||
| aeb1b084d9 | |||
| 6e02ac874f | |||
| dd131ee740 | |||
| cad5a980c5 | |||
| 17bfd3e9d8 | |||
| d90aa75468 |
@@ -7,7 +7,9 @@ on:
|
||||
|
||||
jobs:
|
||||
web:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: aceofba-cluster
|
||||
container:
|
||||
image: ghcr.io/catthehacker/ubuntu:act-22.04
|
||||
defaults:
|
||||
run:
|
||||
working-directory: web
|
||||
@@ -18,12 +20,13 @@ jobs:
|
||||
version: 11
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20
|
||||
node-version: 22
|
||||
cache: pnpm
|
||||
cache-dependency-path: web/pnpm-lock.yaml
|
||||
- run: pnpm install --frozen-lockfile
|
||||
- run: pnpm typecheck
|
||||
- run: pnpm lint
|
||||
- run: pnpm exec playwright install --with-deps chromium
|
||||
- run: pnpm test
|
||||
- run: pnpm build
|
||||
- run: pnpm check:size
|
||||
|
||||
@@ -0,0 +1,256 @@
|
||||
# Accessibility Defect Bundle — Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Fix five remaining a11y defects — label-id collision, unnamed drawer/breadcrumb, untranslated combobox strings (Task 1); invalid table-row semantics, missing pill focus ring, unannounced table load/error states (Task 2).
|
||||
|
||||
**Architecture:** Task 1 is a labelling/i18n cluster across four small components plus 5 new i18n keys. Task 2 reworks the objects-table data rows to use a real `<Link>` with `aria-current`, restores `focusRing` on the filter pills, and adds `aria-busy` + a live `<caption>` + `role="alert"` for load/error announcement.
|
||||
|
||||
**Tech Stack:** React 19 + TS + pnpm, React Router 7, Base UI, react-i18next, Vitest 4 (jsdom) + RTL + MSW.
|
||||
|
||||
**Conventions:** pnpm; **no `any`/`eslint-disable`/`@ts-ignore`**; no codename; en/sv parity; app source double-quote+semicolon; `components/ui/*` untouched; token classes only (`focusRing` is token-based). Run a single test pass.
|
||||
|
||||
**Spec:** `docs/superpowers/specs/2026-06-08-a11y-defect-bundle-design.md`
|
||||
|
||||
**Key facts:**
|
||||
- Existing i18n keys: `common.noMatches` ("No matches"), `common.loading` ("Loading"), `nav.objects`, `objects.loadError` ("Could not load objects"), `actions.closeDetail`. NEW keys to add (en/sv): `common.clear`, `common.open`, `nav.breadcrumb`, `objects.detailTitle`, `objects.tableLabel`.
|
||||
- `lib/focus-ring.ts` exports `focusRing` (a class string). Imported elsewhere as `import { focusRing } from "../lib/focus-ring";`.
|
||||
- `components/label-editor.test.tsx`, `objects/options-combobox.test.tsx`, `shell/breadcrumb.test.tsx` exist. `objects/object-detail-drawer.test.tsx` does NOT.
|
||||
- `objects/objects-table.test.tsx`: imports `renderApp`, `objectsPage` (from `../test/fixtures`), `ObjectsTable`, `ObjectDetail`, `i18n`, `Routes`/`Route`. Its `tree()` mounts `ObjectsTable` at `/objects` and `ObjectDetail` at `/objects/:id` as siblings. Fixtures: `objectsPage.items[0]` = `{ object_number: "LM-0042", object_name: "Amphora", … }`, `[1]` = `"LM-0043"`/`"Bronze fibula"`. The "clicking a row deep-links…" test clicks the **name** ("Amphora"), which stays plain text — it survives unchanged.
|
||||
- `combobox.tsx` wrapper: `ComboboxClear`/`ComboboxTrigger` pass `aria-label` through to Base UI; `ComboboxEmpty` renders children. Do NOT modify `components/ui/combobox.tsx`.
|
||||
- `object-detail-drawer.tsx`: `DrawerContent` spreads `...props` onto the Base UI `Drawer.Popup`, so `aria-label` passes through.
|
||||
|
||||
---
|
||||
|
||||
# Task 1: Labelling + i18n cluster (label-editor, combobox, breadcrumb, drawer)
|
||||
|
||||
**Files:** Modify `web/src/i18n/en.json`, `web/src/i18n/sv.json`, `web/src/components/label-editor.tsx`, `web/src/objects/options-combobox.tsx`, `web/src/shell/breadcrumb.tsx`, `web/src/objects/object-detail-drawer.tsx`; tests `web/src/components/label-editor.test.tsx`, `web/src/objects/options-combobox.test.tsx`, `web/src/shell/breadcrumb.test.tsx`.
|
||||
|
||||
- [ ] **Step 1: Add the 5 i18n keys (both locales, parity).** In `web/src/i18n/en.json`, add to the relevant blocks: under `common` → `"clear": "Clear", "open": "Open"`; under `nav` → `"breadcrumb": "Breadcrumb"`; under `objects` → `"detailTitle": "Object detail", "tableLabel": "Objects"`. In `web/src/i18n/sv.json`, the same keys: `common.clear` = `"Rensa"`, `common.open` = `"Öppna"`, `nav.breadcrumb` = `"Brödsmulor"`, `objects.detailTitle` = `"Objektdetalj"`, `objects.tableLabel` = `"Objekt"`. (Valid JSON; mind commas. Place each new key beside its existing siblings in the same nested object.)
|
||||
|
||||
- [ ] **Step 2: `label-editor.tsx` — `useId()`.** Add `useId` to the React import (`import { useId } from "react";`). Inside the component, add `const inputId = useId();` and change the two lines to:
|
||||
```tsx
|
||||
<Label htmlFor={inputId}>{t("labels.label")}</Label>
|
||||
<Input id={inputId} value={current} onChange={(e) => set(e.target.value)} />
|
||||
```
|
||||
|
||||
- [ ] **Step 3: `options-combobox.tsx` — translate.** Add `import { useTranslation } from "react-i18next";` and `const { t } = useTranslation();` at the top of the component body. Change:
|
||||
```tsx
|
||||
<ComboboxClear aria-label={t("common.clear")} />
|
||||
<ComboboxTrigger aria-label={t("common.open")} />
|
||||
```
|
||||
and
|
||||
```tsx
|
||||
<ComboboxEmpty>{t("common.noMatches")}</ComboboxEmpty>
|
||||
```
|
||||
|
||||
- [ ] **Step 4: `breadcrumb.tsx` — translate the nav label.** Add `import { useTranslation } from "react-i18next";` and `const { t } = useTranslation();` inside `Breadcrumb` (before the `if (trail.length === 0)` guard). Change `<nav aria-label="Breadcrumb" …>` to `<nav aria-label={t("nav.breadcrumb")} …>`.
|
||||
|
||||
- [ ] **Step 5: `object-detail-drawer.tsx` — name the dialog.** Change `<DrawerContent>` to `<DrawerContent aria-label={t("objects.detailTitle")}>` (the `t` from `useTranslation` is already in scope in this file).
|
||||
|
||||
- [ ] **Step 6: Tests.**
|
||||
- **`label-editor.test.tsx`** — append (reuse the file's existing render harness / providers, e.g. `renderApp` or whatever wraps `useConfig`; read the top of the file first):
|
||||
```tsx
|
||||
test("each LabelEditor instance gets a unique input id", () => {
|
||||
renderApp(
|
||||
<>
|
||||
<LabelEditor value={[]} onChange={() => {}} />
|
||||
<LabelEditor value={[]} onChange={() => {}} />
|
||||
</>,
|
||||
);
|
||||
const inputs = screen.getAllByLabelText(/label/i);
|
||||
expect(inputs).toHaveLength(2);
|
||||
expect(inputs[0].id).not.toBe("");
|
||||
expect(inputs[0].id).not.toBe(inputs[1].id);
|
||||
});
|
||||
```
|
||||
(If `LabelEditor` needs config context that `renderApp` doesn't provide, mirror the wrapper the existing tests in this file use. Keep existing tests green.)
|
||||
- **`options-combobox.test.tsx`** — append (mirror the file's existing render of `OptionsCombobox`):
|
||||
```tsx
|
||||
test("the clear and open controls and empty text are translated", async () => {
|
||||
// render OptionsCombobox with empty options so the empty state is reachable,
|
||||
// using the same harness the other tests in this file use.
|
||||
// …render…
|
||||
expect(screen.getByRole("button", { name: /open/i })).toBeInTheDocument();
|
||||
});
|
||||
```
|
||||
(Adapt to the existing test's setup. The key assertion: the open/clear controls have accessible names from `t()`. If the existing test already opens the popup, also assert `screen.getByText("No matches")`.)
|
||||
- **`breadcrumb.test.tsx`** — append:
|
||||
```tsx
|
||||
test("the breadcrumb nav has a translated accessible name", () => {
|
||||
// render Breadcrumb with a non-empty trail using the file's existing harness
|
||||
// (it needs a BreadcrumbContext provider with a trail).
|
||||
expect(screen.getByRole("navigation", { name: /breadcrumb/i })).toBeInTheDocument();
|
||||
});
|
||||
```
|
||||
(Mirror the existing breadcrumb test's provider setup; if the file already renders a trail, just add the `getByRole("navigation", { name })` assertion.)
|
||||
|
||||
- [ ] **Step 7: Verify (vitest ONCE), typecheck, lint:**
|
||||
```bash
|
||||
cd web && pnpm vitest run src/components/label-editor.test.tsx src/objects/options-combobox.test.tsx src/shell/breadcrumb.test.tsx src/i18n && pnpm typecheck && pnpm lint
|
||||
```
|
||||
Expected: green (incl. i18n parity covering the 5 new keys). Keep all existing tests in those files green.
|
||||
|
||||
- [ ] **Step 8: Commit**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git add web/src/i18n/en.json web/src/i18n/sv.json web/src/components/label-editor.tsx web/src/objects/options-combobox.tsx web/src/shell/breadcrumb.tsx web/src/objects/object-detail-drawer.tsx web/src/components/label-editor.test.tsx web/src/objects/options-combobox.test.tsx web/src/shell/breadcrumb.test.tsx
|
||||
git commit -m "fix(web): a11y labelling — useId, named drawer/breadcrumb, translated combobox (#62)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Task 2: objects-table — real-link rows, pill focus ring, announced load/error
|
||||
|
||||
**Files:** Modify `web/src/objects/objects-table.tsx`, `web/src/objects/objects-table.test.tsx`.
|
||||
|
||||
- [ ] **Step 1: Import `focusRing`.** Add `import { focusRing } from "../lib/focus-ring";` to `objects-table.tsx`. (`Link` is already imported from `react-router-dom`.)
|
||||
|
||||
- [ ] **Step 2: Filter pills — add the focus ring.** In the `toolbar`, change the pill `className` to:
|
||||
```tsx
|
||||
className={`${focusRing} rounded-md px-2 py-1 ${active ? "bg-primary text-primary-foreground" : "border"}`}
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Rows — real link + `aria-current`, plain `<tr>`.** Replace the data-row `<tr>` (the `role="link"` one) with:
|
||||
```tsx
|
||||
<tr
|
||||
key={object.id}
|
||||
onClick={() => navigate(`/objects/${object.id}?${params}`)}
|
||||
className={`cursor-pointer border-b text-sm ${
|
||||
selected ? "bg-primary/10" : "hover:bg-muted"
|
||||
}`}
|
||||
>
|
||||
<td className="px-3 py-2 text-muted-foreground">
|
||||
<Link
|
||||
to={`/objects/${object.id}?${params}`}
|
||||
aria-current={selected ? "page" : undefined}
|
||||
onClick={(event) => event.stopPropagation()}
|
||||
className={`${focusRing} rounded-sm hover:underline`}
|
||||
>
|
||||
{object.object_number}
|
||||
</Link>
|
||||
</td>
|
||||
<td className="px-3 py-2 font-medium">{object.object_name}</td>
|
||||
<td className="px-3 py-2">
|
||||
<VisibilityBadge visibility={object.visibility} />
|
||||
</td>
|
||||
<td className="px-3 py-2 text-muted-foreground">{object.current_location ?? "—"}</td>
|
||||
<td className="px-3 py-2 text-right tabular-nums">{object.number_of_objects}</td>
|
||||
<td className="px-3 py-2 text-muted-foreground">{formatUpdated(object.updated_at)}</td>
|
||||
</tr>
|
||||
```
|
||||
(Drops `role="link"`, `tabIndex={0}`, `aria-selected`, and `onKeyDown` from the `<tr>`; the object-number cell now holds the `<Link>`. Every other cell is unchanged.)
|
||||
|
||||
- [ ] **Step 4: Error cell — `role="alert"`.** In the `isError` branch, change the error `<td>` to:
|
||||
```tsx
|
||||
<td colSpan={6} role="alert" className="px-3 py-6 text-center text-sm text-destructive">
|
||||
{t("objects.loadError")}
|
||||
</td>
|
||||
```
|
||||
|
||||
- [ ] **Step 5: Table — `aria-busy` + live caption.** Change the `<table>` element and add the caption as its first child:
|
||||
```tsx
|
||||
<table className="w-full border-collapse" aria-busy={isLoading || undefined}>
|
||||
<caption className="sr-only" aria-live="polite">
|
||||
{isLoading ? t("common.loading") : t("objects.tableLabel")}
|
||||
</caption>
|
||||
{columns}
|
||||
{body}
|
||||
</table>
|
||||
```
|
||||
|
||||
- [ ] **Step 6: Tests — extend `objects-table.test.tsx`.** Add a nested-route helper (so `ObjectsTable` is mounted WITH a `:id` param, mirroring the real `ObjectsPage` nesting) and the new assertions. Add near the existing `tree()`:
|
||||
```tsx
|
||||
function nestedTree() {
|
||||
return (
|
||||
<Routes>
|
||||
<Route
|
||||
path="/objects"
|
||||
element={
|
||||
<>
|
||||
<ObjectsTable />
|
||||
<Outlet />
|
||||
</>
|
||||
}
|
||||
>
|
||||
<Route path=":id" element={<div>detail pane</div>} />
|
||||
</Route>
|
||||
</Routes>
|
||||
);
|
||||
}
|
||||
```
|
||||
(Add `Outlet` to the `react-router-dom` import.) Then add these tests:
|
||||
```tsx
|
||||
test("the object number cell is a real link", async () => {
|
||||
renderApp(tree(), { route: "/objects" });
|
||||
expect(await screen.findByRole("link", { name: "LM-0042" })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
test("the selected row's link is marked aria-current=page", async () => {
|
||||
// objectsPage.items[0] has object_number "LM-0042"; read its id from the fixture.
|
||||
const first = objectsPage.items[0];
|
||||
renderApp(nestedTree(), { route: `/objects/${first.id}` });
|
||||
const link = await screen.findByRole("link", { name: first.object_number });
|
||||
expect(link).toHaveAttribute("aria-current", "page");
|
||||
// a different row's link is not current
|
||||
const other = await screen.findByRole("link", { name: objectsPage.items[1].object_number });
|
||||
expect(other).not.toHaveAttribute("aria-current");
|
||||
});
|
||||
|
||||
test("the table is marked aria-busy while loading", async () => {
|
||||
server.use(
|
||||
http.get("/api/admin/objects", async () => {
|
||||
await delay(50);
|
||||
return HttpResponse.json(objectsPage);
|
||||
}),
|
||||
);
|
||||
renderApp(tree(), { route: "/objects" });
|
||||
expect(screen.getByRole("table")).toHaveAttribute("aria-busy", "true");
|
||||
await screen.findByRole("link", { name: "LM-0042" });
|
||||
expect(screen.getByRole("table")).not.toHaveAttribute("aria-busy");
|
||||
});
|
||||
|
||||
test("a failed objects fetch is announced via role=alert", async () => {
|
||||
server.use(http.get("/api/admin/objects", () => new HttpResponse(null, { status: 500 })));
|
||||
renderApp(tree(), { route: "/objects" });
|
||||
expect(await screen.findByRole("alert")).toHaveTextContent(/could not load/i);
|
||||
});
|
||||
```
|
||||
(Add `delay` to the `msw` import: `import { delay, http, HttpResponse } from "msw";`. The existing "clicking a row deep-links…" test clicks "Amphora" — the name cell, still plain text + whole-row `onClick` — so it stays green. If `objectsPage.items[0]` doesn't carry an `id`, read `src/test/fixtures.ts` to use the correct id field.)
|
||||
|
||||
- [ ] **Step 7: FULL FRONTEND GATE (run tests EXACTLY ONCE):**
|
||||
```bash
|
||||
cd web && pnpm typecheck && pnpm lint && pnpm test && pnpm build && pnpm check:size && pnpm check:colors
|
||||
```
|
||||
All green. Report test totals, largest chunk (gz), and the `check:colors` line.
|
||||
|
||||
- [ ] **Step 8: Codename + status:**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git grep -in 'biggus\|dickus' -- web/src; echo "codename-exit=$?"
|
||||
git status --short
|
||||
```
|
||||
Expected: no matches (`codename-exit=1`).
|
||||
|
||||
- [ ] **Step 9: Manual smoke (recommended).** `pnpm dev`: tab into the objects table — the visibility pills show a focus ring; Tab reaches each row's object-number link (Enter opens; Cmd/middle-click opens a new tab); the open object's row link is `aria-current`; a slow/failed load is announced.
|
||||
|
||||
- [ ] **Step 10: Commit**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git add web/src/objects/objects-table.tsx web/src/objects/objects-table.test.tsx
|
||||
git commit -m "fix(web): objects-table a11y — real-link rows, pill focus ring, announced load/error (#62)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Self-Review (completed)
|
||||
|
||||
**Spec coverage:** AC1 LabelEditor useId (T1 S2); AC2 row real-link + aria-current + plain tr + pill focusRing (T2 S2-S3); AC3 aria-busy + live caption + role=alert (T2 S4-S5); AC4 drawer + breadcrumb names + combobox translation (T1 S3-S5); AC5 gate/parity/codename (T2 S7-S8, T1 S1/S7). ✓
|
||||
|
||||
**Placeholder scan:** every code step shows full code; tests give concrete role/name assertions; the two "mirror the existing harness" notes (label-editor/options-combobox/breadcrumb tests) point at named existing files to copy from, not vague TODOs; the fixture-id note names the exact field to read. No TBD. ✓
|
||||
|
||||
**Type/consistency:** `focusRing` (string) imported once in T2 and used on pills + row link; `aria-current={selected ? "page" : undefined}` consistent; the 5 i18n keys added in T1 S1 are consumed in T1 S3-S5 (`common.clear/open`, `nav.breadcrumb`, `objects.detailTitle`) and T2 S5 (`objects.tableLabel`). ✓
|
||||
|
||||
## Notes
|
||||
- No new dependency. `components/ui/*` untouched (combobox/drawer wrappers unchanged; only props passed from callers). `check:colors` stays green — `focusRing` uses `ring-ring` tokens, no raw palette.
|
||||
- The combobox wrapper's own raw-palette internals and the segmented-control extraction are #66, not here.
|
||||
@@ -0,0 +1,211 @@
|
||||
# Design-Kit Consistency — Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Add three shared helpers (`useLang`, `segmentClass`, `rowStateClass`), adopt them across the duplicated sites, and apply behavior-preserving kit one-offs (delete dead Card, sidebar focusRing, login PageTitle, field-list Badge, size-4, icon dismiss buttons).
|
||||
|
||||
**Architecture:** Task 1 creates the helpers + deletes Card (additive/safe). Task 2 adopts the 3 helpers across 6 + 3 + 4 sites. Task 3 applies the one-off cleanups + full gate. Behavior-preserving throughout; `check:colors`/`check:size`/existing component tests are the guards.
|
||||
|
||||
**Tech Stack:** React 19 + TS + pnpm, Tailwind v4 (token classes + `cn`), react-i18next, Base UI, Vitest 4 + RTL.
|
||||
|
||||
**Conventions:** pnpm; **no `any`/`eslint-disable`/`@ts-ignore`**; no codename; double-quote+semicolon; token classes only (`check:colors`). `tsconfig` has `noUnusedLocals`, so remove any destructure that becomes unused.
|
||||
|
||||
**Spec:** `docs/superpowers/specs/2026-06-08-design-kit-consistency-design.md`
|
||||
|
||||
**Key facts (verified current):**
|
||||
- `lib/focus-ring.ts` exports `focusRing = "outline-none focus-visible:ring-3 focus-visible:ring-ring/50"`. `cn` is `@/lib/utils`.
|
||||
- `Button` (`@/components/ui/button`) has sizes incl. `icon-sm`. `Badge` (`@/components/ui/badge`) has a `secondary` variant. `PageTitle` (`@/components/ui/page-title`) is an `<h1>` styled `text-2xl font-semibold tracking-tight`.
|
||||
- `components/ui/card.tsx` has ZERO importers and no `card.stories`.
|
||||
- `useLang` sites (each currently `const lang = i18n.language.startsWith("sv") ? "sv" : "en";`): `objects/object-detail.tsx:59`, `objects/field-input.tsx:32`, `vocab/vocabulary-terms.tsx:13`, `vocab/vocabulary-list.tsx:17`, `fields/field-list.tsx:27`, `authorities/authorities-page.tsx:19`.
|
||||
- `segmentClass` sites: `objects/objects-table.tsx:174` (`` className={`${focusRing} rounded-md px-2 py-1 ${active ? "bg-primary text-primary-foreground" : "border"}`} ``), `search/search-panel.tsx:76` (`className={cn("rounded-md px-2 py-0.5", focusRing, active ? "bg-primary text-primary-foreground" : "border")}`), `authorities/authorities-page.tsx:41` (`cn("rounded-md px-3 py-1 text-sm", focusRing, isActive ? "bg-primary text-primary-foreground" : "border")`).
|
||||
- `rowStateClass` sites: `objects/objects-table.tsx:252` (`selected ? "bg-primary/10" : "hover:bg-muted"`), `vocab/vocabulary-list.tsx:113` (`isActive ? "bg-primary/10" : "hover:bg-muted"`), `search/search-result-row.tsx:15` (`isActive ? "bg-primary/10" : "hover:bg-muted"`), `fields/field-list.tsx:86` (`def.key === selectedKey ? "bg-primary/10" : ""` — note the missing idle hover).
|
||||
|
||||
---
|
||||
|
||||
# Task 1: Create helpers + delete dead Card
|
||||
|
||||
**Files:** Create `web/src/lib/use-lang.ts`, `web/src/lib/class-recipes.ts`, `web/src/lib/class-recipes.test.ts`; Delete `web/src/components/ui/card.tsx`.
|
||||
|
||||
- [ ] **Step 1: `web/src/lib/use-lang.ts`:**
|
||||
```ts
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
/** The instance's active UI language, narrowed to the two supported locales. */
|
||||
export function useLang(): "sv" | "en" {
|
||||
const { i18n } = useTranslation();
|
||||
return i18n.language.startsWith("sv") ? "sv" : "en";
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2: `web/src/lib/class-recipes.ts`:**
|
||||
```ts
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
import { focusRing } from "./focus-ring";
|
||||
|
||||
/** Segmented-control / filter-pill item. Unifies the active/inactive token recipe +
|
||||
* focus ring; callers pass their contextual padding/size via `className`. */
|
||||
export function segmentClass(active: boolean, className?: string): string {
|
||||
return cn("rounded-md", focusRing, active ? "bg-primary text-primary-foreground" : "border", className);
|
||||
}
|
||||
|
||||
/** Selected vs idle row background for master-detail / list rows. */
|
||||
export function rowStateClass(active: boolean): string {
|
||||
return active ? "bg-primary/10" : "hover:bg-muted";
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 3: `web/src/lib/class-recipes.test.ts`** (write + run):
|
||||
```ts
|
||||
import { expect, test } from "vitest";
|
||||
|
||||
import { rowStateClass, segmentClass } from "./class-recipes";
|
||||
|
||||
test("segmentClass active uses the primary tokens + focus ring", () => {
|
||||
const cls = segmentClass(true, "px-2 py-1");
|
||||
expect(cls).toContain("bg-primary");
|
||||
expect(cls).toContain("text-primary-foreground");
|
||||
expect(cls).toContain("focus-visible:ring-ring/50");
|
||||
expect(cls).toContain("px-2");
|
||||
});
|
||||
|
||||
test("segmentClass inactive uses border, not the primary fill", () => {
|
||||
const cls = segmentClass(false);
|
||||
expect(cls).toContain("border");
|
||||
expect(cls).not.toContain("bg-primary");
|
||||
});
|
||||
|
||||
test("rowStateClass toggles selected vs idle-hover", () => {
|
||||
expect(rowStateClass(true)).toBe("bg-primary/10");
|
||||
expect(rowStateClass(false)).toBe("hover:bg-muted");
|
||||
});
|
||||
```
|
||||
Run: `cd web && pnpm vitest run src/lib/class-recipes.test.ts` → 3 passing.
|
||||
|
||||
- [ ] **Step 4: Delete the dead Card component:**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git rm web/src/components/ui/card.tsx
|
||||
```
|
||||
(Confirm no references first: `git grep -n "components/ui/card\"" web/src` returns nothing.)
|
||||
|
||||
- [ ] **Step 5: Verify + lint:**
|
||||
```bash
|
||||
cd web && pnpm vitest run src/lib/class-recipes.test.ts && pnpm typecheck && pnpm lint
|
||||
```
|
||||
Expected: green (Card had no importers, so its deletion can't break typecheck/lint).
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git add web/src/lib/use-lang.ts web/src/lib/class-recipes.ts web/src/lib/class-recipes.test.ts
|
||||
git rm -q web/src/components/ui/card.tsx 2>/dev/null; git add -A web/src/components/ui
|
||||
git commit -m "feat(web): useLang + segmentClass/rowStateClass helpers; delete dead Card (#66)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Task 2: Adopt the helpers across the duplicated sites
|
||||
|
||||
**Files:** Modify `objects/object-detail.tsx`, `objects/field-input.tsx`, `vocab/vocabulary-terms.tsx`, `vocab/vocabulary-list.tsx`, `fields/field-list.tsx`, `authorities/authorities-page.tsx`, `objects/objects-table.tsx`, `search/search-panel.tsx`, `search/search-result-row.tsx`.
|
||||
|
||||
- [ ] **Step 1: Adopt `useLang()` in the 6 components.** In each of `objects/object-detail.tsx`, `objects/field-input.tsx`, `vocab/vocabulary-terms.tsx`, `vocab/vocabulary-list.tsx`, `fields/field-list.tsx`, `authorities/authorities-page.tsx`: add `import { useLang } from "../lib/use-lang";` and replace `const lang = i18n.language.startsWith("sv") ? "sv" : "en";` with `const lang = useLang();`. Then, if `i18n` is no longer referenced anywhere else in that component, change `const { t, i18n } = useTranslation();` to `const { t } = useTranslation();` (the `noUnusedLocals` typecheck will fail otherwise — so this removal is required wherever `i18n` becomes unused). Note `authorities/authorities-page.tsx` also imports `focusRing` and uses `cn` — leave those.
|
||||
|
||||
- [ ] **Step 2: Adopt `segmentClass` at the 3 segmented sites.**
|
||||
- `objects/objects-table.tsx`: add `import { segmentClass } from "../lib/class-recipes";`; change the pill `className` (currently `` `${focusRing} rounded-md px-2 py-1 ${active ? "bg-primary text-primary-foreground" : "border"}` ``) to `className={segmentClass(active, "px-2 py-1")}`. If `focusRing` is now unused in this file, remove its import. (The object-number `<Link>` also uses `focusRing` — if so, KEEP the import.)
|
||||
- `search/search-panel.tsx`: add the import; change `className={cn("rounded-md px-2 py-0.5", focusRing, active ? "bg-primary text-primary-foreground" : "border")}` to `className={segmentClass(active, "px-2 py-0.5")}`. Remove now-unused `focusRing`/`cn` imports if they're unused elsewhere in the file.
|
||||
- `authorities/authorities-page.tsx`: add the import; change the NavLink className callback body `cn("rounded-md px-3 py-1 text-sm", focusRing, isActive ? "bg-primary text-primary-foreground" : "border")` to `segmentClass(isActive, "px-3 py-1 text-sm")`. Remove now-unused `focusRing`/`cn` imports if unused elsewhere.
|
||||
|
||||
- [ ] **Step 3: Adopt `rowStateClass` at the 4 selected-row sites.** Add `import { rowStateClass } from "…/lib/class-recipes";` (or extend the existing class-recipes import) to each:
|
||||
- `objects/objects-table.tsx`: in the row `className`, change `${selected ? "bg-primary/10" : "hover:bg-muted"}` to `${rowStateClass(selected)}`.
|
||||
- `vocab/vocabulary-list.tsx`: change `${isActive ? "bg-primary/10" : "hover:bg-muted"}` to `${rowStateClass(isActive)}`.
|
||||
- `search/search-result-row.tsx`: change `${isActive ? "bg-primary/10" : "hover:bg-muted"}` to `${rowStateClass(isActive)}`.
|
||||
- `fields/field-list.tsx`: change `${def.key === selectedKey ? "bg-primary/10" : ""}` to `${rowStateClass(def.key === selectedKey)}` (this ADDS the `hover:bg-muted` idle hover the others have — an intended consistency fix).
|
||||
|
||||
- [ ] **Step 4: Verify (vitest ONCE for the affected suites), typecheck, lint:**
|
||||
```bash
|
||||
cd web && pnpm vitest run src/objects src/vocab src/fields src/authorities src/search && pnpm typecheck && pnpm lint
|
||||
```
|
||||
Expected: green. These are class-string-equivalent changes (segmentClass/rowStateClass produce the same token sets; `cn` ordering is irrelevant to Tailwind), so the existing component tests pass unchanged. `field-list`'s row now also carries `hover:bg-muted` (additive). If a test asserted the exact old className string, update it to match the new equivalent (unlikely — tests query by role/text).
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git add web/src/objects/object-detail.tsx web/src/objects/field-input.tsx web/src/vocab/vocabulary-terms.tsx web/src/vocab/vocabulary-list.tsx web/src/fields/field-list.tsx web/src/authorities/authorities-page.tsx web/src/objects/objects-table.tsx web/src/search/search-panel.tsx web/src/search/search-result-row.tsx
|
||||
git commit -m "refactor(web): adopt useLang + segmentClass/rowStateClass across sites (#66)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Task 3: One-off kit cleanups + full gate
|
||||
|
||||
**Files:** Modify `shell/sidebar.tsx`, `auth/login-page.tsx`, `fields/field-list.tsx`, `shell/theme-switch.tsx`, `shell/user-menu.tsx`, `shell/header-search.tsx`, `objects/objects-page.tsx`, `objects/object-detail-drawer.tsx`.
|
||||
|
||||
- [ ] **Step 1: `shell/sidebar.tsx`** — use the `focusRing` constant. Add `import { focusRing } from "../lib/focus-ring";` (if not already imported). At the two `cn(...)` sites (lines ~46 and ~88) replace the literal `"focus-visible:ring-3 focus-visible:ring-ring/50"` entry with `focusRing`. (Both are inside `cn(...)` lists, so just swap the string for the constant.)
|
||||
|
||||
- [ ] **Step 2: `auth/login-page.tsx`** — use `PageTitle`. Add `import { PageTitle } from "@/components/ui/page-title";` and change `<h1 className="text-2xl font-semibold">{app_name}</h1>` to `<PageTitle>{app_name}</PageTitle>`.
|
||||
|
||||
- [ ] **Step 3: `fields/field-list.tsx`** — type-tag → `Badge`. Add `import { Badge } from "@/components/ui/badge";` and change the type-tag `<span className="rounded-md bg-muted px-1.5 py-0.5 text-xs text-muted-foreground">{…}</span>` (line ~97) to `<Badge variant="secondary">{…}</Badge>` (keep the inner expression/children unchanged).
|
||||
|
||||
- [ ] **Step 4: Icon sizing → `size-4`** in the 3 app-source sites: `shell/theme-switch.tsx:39` (`<Icon className="h-4 w-4" …>` → `className="size-4"`), `shell/user-menu.tsx:27` (`<CircleUser className="h-4 w-4" …>` → `size-4`), `shell/header-search.tsx:23` (the search icon's `… h-4 w-4 …` → replace `h-4 w-4` with `size-4`, keeping the other classes). Do NOT touch `components/ui/select.tsx`.
|
||||
|
||||
- [ ] **Step 5: Icon dismiss buttons → kit Button.**
|
||||
- `objects/objects-page.tsx:54`: add `import { Button } from "@/components/ui/button";` (if absent) and change the `<button type="button" onClick={closeDetail} aria-label={t("actions.closeDetail")} className="rounded-md p-1 text-muted-foreground hover:bg-muted hover:text-foreground"><X className="size-4" aria-hidden="true" /></button>` to:
|
||||
```tsx
|
||||
<Button
|
||||
variant="ghost"
|
||||
size="icon-sm"
|
||||
onClick={closeDetail}
|
||||
aria-label={t("actions.closeDetail")}
|
||||
>
|
||||
<X className="size-4" aria-hidden="true" />
|
||||
</Button>
|
||||
```
|
||||
- `objects/object-detail-drawer.tsx:31-36`: add `import { Button } from "@/components/ui/button";` and render the `DrawerClose` AS the kit Button via the render prop:
|
||||
```tsx
|
||||
<DrawerClose
|
||||
aria-label={t("actions.closeDetail")}
|
||||
render={<Button variant="ghost" size="icon-sm" />}
|
||||
>
|
||||
<X className="size-4" aria-hidden="true" />
|
||||
</DrawerClose>
|
||||
```
|
||||
(This mirrors the `AlertDialogTrigger render={<Button … />}` pattern in `components/delete-confirm-dialog.tsx`; the `DrawerClose` keeps its close-on-click behaviour and the `aria-label`.)
|
||||
|
||||
- [ ] **Step 6: FULL FRONTEND GATE (run tests EXACTLY ONCE):**
|
||||
```bash
|
||||
cd web && pnpm typecheck && pnpm lint && pnpm test && pnpm build && pnpm check:size && pnpm check:colors
|
||||
```
|
||||
All green. Report test totals, largest chunk (gz) from check:size (should be ≤ the prior ~216.5 KB — the Card delete only removes dead code), and the `check:colors` line. The existing `user-menu`, `objects-table`, `object-detail`/drawer, `login-page`, sidebar, `field-list`, search tests must pass unchanged (the icon buttons keep their `aria-label`s; the drawer still closes; login still renders an `<h1>` via PageTitle).
|
||||
|
||||
- [ ] **Step 7: Codename + status:**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git grep -in 'biggus\|dickus' -- web/src; echo "codename-exit=$?"
|
||||
git status --short
|
||||
```
|
||||
Expected: no matches (`codename-exit=1`).
|
||||
|
||||
- [ ] **Step 8: Manual smoke (recommended).** `pnpm dev`: the visibility pills / authority tabs / search facets look unchanged and keep their focus rings; the selected list rows (objects, vocab, search, fields) highlight identically and field rows now have a hover; the object-detail close buttons (wide pane + drawer) work; the login title and field-list type tag look right.
|
||||
|
||||
- [ ] **Step 9: Commit**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git add web/src/shell/sidebar.tsx web/src/auth/login-page.tsx web/src/fields/field-list.tsx web/src/shell/theme-switch.tsx web/src/shell/user-menu.tsx web/src/shell/header-search.tsx web/src/objects/objects-page.tsx web/src/objects/object-detail-drawer.tsx
|
||||
git commit -m "refactor(web): kit consistency — focusRing, PageTitle, Badge, size-4, icon buttons (#66)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Self-Review (completed)
|
||||
|
||||
**Spec coverage:** AC1 `useLang` + 6 sites (T1 S1, T2 S1); AC2 `segmentClass`/`rowStateClass` + adoption + field-list hover fix (T1 S2-S3, T2 S2-S3); AC3 Card deleted (T1 S4); AC4 one-offs — sidebar focusRing, login PageTitle, field-list Badge, size-4, icon buttons (T3 S1-S5); AC5 gate/check:size/codename (T3 S6-S7). ✓
|
||||
|
||||
**Placeholder scan:** every edit gives the exact before string + after code; helper bodies are complete; the test has concrete assertions. The "remove `i18n` if unused" instructions are concrete (driven by `noUnusedLocals`). No TBD. ✓
|
||||
|
||||
**Type/consistency:** `useLang()` (T1) returns `"sv" | "en"` consumed as `const lang` (T2 S1); `segmentClass(active, className?)` / `rowStateClass(active)` (T1) called with the exact args in T2 S2-S3; `Button size="icon-sm"`, `Badge variant="secondary"`, `PageTitle` all confirmed to exist. ✓
|
||||
|
||||
## Notes
|
||||
- No new dependency, no new i18n keys. `check:colors` stays green — `segmentClass`/`rowStateClass` and all edits use tokens (`bg-primary`, `border`, `ring-ring`, `bg-muted`). Card deletion only removes dead code.
|
||||
- `cn()` (tailwind-merge) makes class ordering irrelevant, so the helper outputs are visually identical to the prior inline strings (except field-list's intended added hover).
|
||||
- The `<SegmentedControl>` component and the form-spacing scale are deferred (out of scope).
|
||||
@@ -0,0 +1,421 @@
|
||||
# Consistent, Status-Aware Mutation Error Feedback — Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Replace the generic, inconsistent mutation-error feedback with one status-aware mapping rendered consistently inline across every create/edit/delete surface.
|
||||
|
||||
**Architecture:** A shared `errorMessageKey(error)` maps `InUseError`/`HttpError(status)` → i18n keys (single source of truth). A shared `<MutationError error>` renders the inline alert. Mutations throw `HttpError(status)` so the status reaches the helper. All inline sites adopt the helper/component; the two non-suppressed update mutations suppress the toast and show inline like their siblings.
|
||||
|
||||
**Tech Stack:** React 19 + TS + pnpm, TanStack Query v5, openapi-fetch, react-i18next, Vitest 4 (jsdom) + RTL + MSW. Test runner: `pnpm test` (single pass).
|
||||
|
||||
**Conventions:** pnpm; **no `any`/`eslint-disable`/`@ts-ignore`**; no codename; en/sv parity; app source double-quote+semicolon; `ui/` files untouched; token classes only. Run a single test pass.
|
||||
|
||||
**Spec:** `docs/superpowers/specs/2026-06-08-mutation-error-feedback-design.md`
|
||||
|
||||
**Key facts:**
|
||||
- `HttpError`/`InUseError`/`FieldRejection` are exported from `web/src/api/queries.ts` (lines 6, 13, 20). `HttpError(status)` carries `.status`; `InUseError(count)` carries `.count`.
|
||||
- `web/src/api/query-client.ts:11-23` `mutationErrorMessage(error, meta)` currently special-cases `InUseError`, `HttpError 503 → search.unavailable`, `meta.errorMessage`, else `toast.error`. The `MutationCache.onError` skips when `meta.suppressErrorToast`.
|
||||
- **16 of 18 mutations already `suppressErrorToast`.** Only `useUpdateTerm` (`queries.ts:444`) and `useUpdateAuthority` (`:521`) do not — they have `meta: { successMessage: "toast.saved" }`.
|
||||
- The 16 **mutation** `throw new Error("…")` sites: `queries.ts:184,203,230,248,279,306,331,382,441,458,475,492,518,535,562,579`. `useCreateObject` (`:184`) and `useCreateVocabulary` (`:279`) destructure `{ data, error }` (no `response`) — add `response`. Lines `38,73,90,105,152,169,264` are **query** fetch errors and `:121` is the login map — **do not change these**. `useSearch` (`:360`) already throws `HttpError`.
|
||||
- Inline generic-error sites (all render `{X.isError && <p role="alert" className="text-xs text-destructive">{t("form.rejected")}</p>}`): `authorities-page.tsx:144-148` (`create`), `vocabulary-terms.tsx:119-123` (`addTerm`), `vocabulary-list.tsx:57-61` (`create`) + `:109-113` (`renameVocabulary`), `field-form.tsx:201-205` (`failed = isEdit ? update.isError : create.isError`, line 98). `delete-confirm-dialog.tsx:40` sets `err instanceof InUseError ? actions.inUse : form.rejected`. `object-new-page.tsx:36-39` and `object-edit-form.tsx:86-88` set `t("form.rejected")` in a catch else.
|
||||
- `objects.loadError` ("Could not load objects") already exists in both locales. `term-row.tsx`/`authority-row.tsx` Edit-button `onClick` currently does `setLabels(...); setUri(...); setEditing(true);`.
|
||||
- Test env: jsdom project, MSW `onUnhandledRequest:"error"`. `renderApp` (`src/test/render.tsx`) mounts `ui` at `path:"*"` in a memory router. `src/api/mutation-feedback.test.tsx` exists (tests toast wiring via `makeQueryClient` + `ToastRegion` + `renderHook`).
|
||||
|
||||
---
|
||||
|
||||
# Task 1: Shared helper + `<MutationError>` + i18n + query-client rewire
|
||||
|
||||
**Files:** Create `web/src/api/error-message.ts`, `web/src/api/error-message.test.ts`, `web/src/components/mutation-error.tsx`, `web/src/components/mutation-error.test.tsx`; Modify `web/src/api/query-client.ts`, `web/src/api/mutation-feedback.test.tsx`, `web/src/i18n/en.json`, `web/src/i18n/sv.json`.
|
||||
|
||||
- [ ] **Step 1: Add the 5 i18n keys (both locales, parity).** Add a new top-level `"errors"` object to `web/src/i18n/en.json`:
|
||||
```json
|
||||
"errors": {
|
||||
"forbidden": "You don't have permission to do that.",
|
||||
"notFound": "That item no longer exists.",
|
||||
"conflict": "That conflicts with existing data.",
|
||||
"validation": "Some values weren't accepted.",
|
||||
"server": "The server had a problem. Please try again."
|
||||
},
|
||||
```
|
||||
and to `web/src/i18n/sv.json`:
|
||||
```json
|
||||
"errors": {
|
||||
"forbidden": "Du har inte behörighet att göra det.",
|
||||
"notFound": "Objektet finns inte längre.",
|
||||
"conflict": "Det står i konflikt med befintliga data.",
|
||||
"validation": "Vissa värden godtogs inte.",
|
||||
"server": "Servern hade ett problem. Försök igen."
|
||||
},
|
||||
```
|
||||
(Valid JSON — mind commas. Place it consistently in both files, e.g. before `toast`.)
|
||||
|
||||
- [ ] **Step 2: Create `web/src/api/error-message.ts`:**
|
||||
```ts
|
||||
import { HttpError, InUseError } from "./queries";
|
||||
|
||||
/** Maps a caught mutation error to an i18n key (+ interpolation opts). The single
|
||||
* source of truth shared by the global toast fallback and every inline display. */
|
||||
export function errorMessageKey(error: unknown): { key: string; opts?: Record<string, unknown> } {
|
||||
if (error instanceof InUseError) return { key: "actions.inUse", opts: { count: error.count } };
|
||||
if (error instanceof HttpError) return { key: statusKey(error.status) };
|
||||
return { key: "toast.error" };
|
||||
}
|
||||
|
||||
function statusKey(status: number): string {
|
||||
if (status === 403) return "errors.forbidden";
|
||||
if (status === 404) return "errors.notFound";
|
||||
if (status === 409) return "errors.conflict";
|
||||
if (status === 422) return "errors.validation";
|
||||
if (status >= 500) return "errors.server";
|
||||
return "toast.error";
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Create `web/src/api/error-message.test.ts`** (write + run):
|
||||
```ts
|
||||
import { expect, test } from "vitest";
|
||||
|
||||
import { errorMessageKey } from "./error-message";
|
||||
import { HttpError, InUseError } from "./queries";
|
||||
|
||||
test("maps HTTP statuses to specific keys", () => {
|
||||
expect(errorMessageKey(new HttpError(403))).toEqual({ key: "errors.forbidden" });
|
||||
expect(errorMessageKey(new HttpError(404))).toEqual({ key: "errors.notFound" });
|
||||
expect(errorMessageKey(new HttpError(409))).toEqual({ key: "errors.conflict" });
|
||||
expect(errorMessageKey(new HttpError(422))).toEqual({ key: "errors.validation" });
|
||||
expect(errorMessageKey(new HttpError(500))).toEqual({ key: "errors.server" });
|
||||
expect(errorMessageKey(new HttpError(502))).toEqual({ key: "errors.server" });
|
||||
});
|
||||
|
||||
test("an unmapped status falls back to the generic key", () => {
|
||||
expect(errorMessageKey(new HttpError(418))).toEqual({ key: "toast.error" });
|
||||
});
|
||||
|
||||
test("InUseError carries the count", () => {
|
||||
expect(errorMessageKey(new InUseError(3))).toEqual({ key: "actions.inUse", opts: { count: 3 } });
|
||||
});
|
||||
|
||||
test("a bare Error or unknown maps to the generic key", () => {
|
||||
expect(errorMessageKey(new Error("boom"))).toEqual({ key: "toast.error" });
|
||||
expect(errorMessageKey(null)).toEqual({ key: "toast.error" });
|
||||
});
|
||||
```
|
||||
Run: `cd web && pnpm vitest run src/api/error-message.test.ts` → 4 passing.
|
||||
|
||||
- [ ] **Step 4: Create `web/src/components/mutation-error.tsx`:**
|
||||
```tsx
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import { errorMessageKey } from "../api/error-message";
|
||||
|
||||
/** Renders a caught mutation error as an inline alert, or nothing when error is falsy.
|
||||
* Replaces the duplicated `<p role="alert" className="text-xs text-destructive">` markup. */
|
||||
export function MutationError({ error }: { error: unknown }) {
|
||||
const { t } = useTranslation();
|
||||
if (!error) return null;
|
||||
const { key, opts } = errorMessageKey(error);
|
||||
return (
|
||||
<p role="alert" className="text-xs text-destructive">
|
||||
{t(key, opts)}
|
||||
</p>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 5: Create `web/src/components/mutation-error.test.tsx`** (write + run):
|
||||
```tsx
|
||||
import { expect, test } from "vitest";
|
||||
import { render, screen } from "@testing-library/react";
|
||||
|
||||
import "../i18n";
|
||||
import { MutationError } from "./mutation-error";
|
||||
import { HttpError, InUseError } from "../api/queries";
|
||||
|
||||
test("renders the status-specific message for an HttpError", () => {
|
||||
render(<MutationError error={new HttpError(403)} />);
|
||||
expect(screen.getByRole("alert")).toHaveTextContent(/permission/i);
|
||||
});
|
||||
|
||||
test("renders the in-use count for an InUseError", () => {
|
||||
render(<MutationError error={new InUseError(2)} />);
|
||||
expect(screen.getByRole("alert")).toHaveTextContent(/2/);
|
||||
});
|
||||
|
||||
test("renders nothing when there is no error", () => {
|
||||
const { container } = render(<MutationError error={null} />);
|
||||
expect(container).toBeEmptyDOMElement();
|
||||
});
|
||||
```
|
||||
Run: `cd web && pnpm vitest run src/components/mutation-error.test.tsx` → 3 passing.
|
||||
|
||||
- [ ] **Step 6: Rewire `web/src/api/query-client.ts`.** Change the import line `import { HttpError, InUseError } from "./queries";` to `import { errorMessageKey } from "./error-message";`, and replace the whole `mutationErrorMessage` function body with:
|
||||
```ts
|
||||
function mutationErrorMessage(
|
||||
error: unknown,
|
||||
meta: MutationMeta | undefined,
|
||||
): string {
|
||||
if (meta?.errorMessage) return i18n.t(meta.errorMessage);
|
||||
const { key, opts } = errorMessageKey(error);
|
||||
return i18n.t(key, opts);
|
||||
}
|
||||
```
|
||||
(Leave the `MutationCache` `onError`/`onSuccess` wiring unchanged.)
|
||||
|
||||
- [ ] **Step 7: Rework the obsolete toast test in `web/src/api/mutation-feedback.test.tsx`.** The "a non-suppressed mutation failing shows the catch-all error toast" test uses `useUpdateTerm`, which will suppress in Task 3 — decouple it now by driving the `MutationCache` fallback with a synthetic non-suppressed mutation. Add `useMutation` to the `@tanstack/react-query` import and `HttpError` to the queries import, then replace that single test with:
|
||||
```tsx
|
||||
test("a non-suppressed mutation failing shows the status-mapped error toast", async () => {
|
||||
const { result, unmount } = renderHook(
|
||||
() =>
|
||||
useMutation({
|
||||
mutationFn: async () => {
|
||||
throw new HttpError(500);
|
||||
},
|
||||
}),
|
||||
{ wrapper: makeWrapper() },
|
||||
);
|
||||
|
||||
await expect(result.current.mutateAsync()).rejects.toThrow();
|
||||
|
||||
await waitFor(() => {
|
||||
expect(
|
||||
within(document.body).getByText(i18n.t("errors.server")),
|
||||
).toBeInTheDocument();
|
||||
});
|
||||
|
||||
unmount();
|
||||
});
|
||||
```
|
||||
(Keep the other two tests — success toast via `useUpdateTerm`, and suppressed `useDeleteVocabulary` adds no toast — unchanged. Imports: add `useMutation`; add `HttpError` from `./queries`.)
|
||||
|
||||
- [ ] **Step 8: Verify (vitest ONCE for the touched files), then typecheck + lint:**
|
||||
```bash
|
||||
cd web && pnpm vitest run src/api/error-message.test.ts src/components/mutation-error.test.tsx src/api/mutation-feedback.test.tsx src/i18n && pnpm typecheck && pnpm lint
|
||||
```
|
||||
Expected: all green (helper 4, component 3, feedback 3, i18n parity covering the 5 new keys).
|
||||
|
||||
- [ ] **Step 9: Commit**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git add web/src/api/error-message.ts web/src/api/error-message.test.ts web/src/components/mutation-error.tsx web/src/components/mutation-error.test.tsx web/src/api/query-client.ts web/src/api/mutation-feedback.test.tsx web/src/i18n/en.json web/src/i18n/sv.json
|
||||
git commit -m "feat(web): shared status-aware error-message helper + MutationError component (#63)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Task 2: Make mutation errors load-bearing (throw `HttpError(status)`)
|
||||
|
||||
**Files:** Modify `web/src/api/queries.ts`.
|
||||
|
||||
- [ ] **Step 1: Convert the 16 mutation throws to `HttpError`.** In `web/src/api/queries.ts`, at each of these lines replace `throw new Error("…")` with `throw new HttpError(response.status)` — keeping every surrounding `InUseError` (409) and `FieldRejection` (422) branch exactly as-is:
|
||||
- `:203` `useUpdateObject` — `if (response.status !== 204) throw new HttpError(response.status);`
|
||||
- `:230` `useSetFields` — the final fallback after the 204/422 checks: `throw new HttpError(response.status);`
|
||||
- `:248` `useDeleteObject` — `throw new HttpError(response.status);`
|
||||
- `:306` `useAddTerm` — `if (response.status !== 201) throw new HttpError(response.status);`
|
||||
- `:331` `useCreateAuthority` — `throw new HttpError(response.status);`
|
||||
- `:382` `useCreateFieldDefinition` — `if (response.status !== 201 || !data) throw new HttpError(response.status);`
|
||||
- `:441` `useUpdateTerm` — `throw new HttpError(response.status);`
|
||||
- `:458` `useDeleteTerm` — the post-409 fallback: `if (response.status !== 204) throw new HttpError(response.status);`
|
||||
- `:475` `useRenameVocabulary` — `throw new HttpError(response.status);`
|
||||
- `:492` `useDeleteVocabulary` — post-409 fallback: `throw new HttpError(response.status);`
|
||||
- `:518` `useUpdateAuthority` — `throw new HttpError(response.status);`
|
||||
- `:535` `useDeleteAuthority` — post-409 fallback: `throw new HttpError(response.status);`
|
||||
- `:562` `useUpdateFieldDefinition` — `throw new HttpError(response.status);`
|
||||
- `:579` `useDeleteFieldDefinition` — post-409 fallback: `throw new HttpError(response.status);`
|
||||
|
||||
- [ ] **Step 2: The two POSTs that don't destructure `response`.** For `useCreateObject` (`:184`) and `useCreateVocabulary` (`:279`), change `const { data, error } = await api.POST(...)` to `const { data, error, response } = await api.POST(...)` and replace `if (error || !data) throw new Error("…")` with `if (error || !data) throw new HttpError(response.status);`.
|
||||
|
||||
- [ ] **Step 3: Do NOT touch** the query fetch errors (`:38,73,90,105,152,169,264`) or the login map (`:121`) — they keep `throw new Error(...)` (consumed by component `isError`/login mapping, not the toast). `HttpError` is already imported in this file (it's defined here), so no import change.
|
||||
|
||||
- [ ] **Step 4: Verify (vitest ONCE), typecheck, lint:**
|
||||
```bash
|
||||
cd web && pnpm vitest run src/api/queries.test.ts src/api/mutation-feedback.test.tsx && pnpm typecheck && pnpm lint
|
||||
```
|
||||
Expected: green. `HttpError` extends `Error`, so any `.rejects.toThrow()` assertions still pass (no test asserts the old message strings). If `queries.test.ts` asserts a specific thrown type/message that now differs, update it to assert `HttpError`/status (do not weaken).
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git add web/src/api/queries.ts
|
||||
git commit -m "feat(web): mutations throw HttpError(status) so failures are status-aware (#63)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Task 3: Edit-row consistency + delete-dialog adoption
|
||||
|
||||
**Files:** Modify `web/src/api/queries.ts`, `web/src/vocab/term-row.tsx`, `web/src/authorities/authority-row.tsx`, `web/src/components/delete-confirm-dialog.tsx`, and their tests / `web/src/api/mutation-feedback.test.tsx` consumers.
|
||||
|
||||
- [ ] **Step 1: Suppress the two update toasts.** In `web/src/api/queries.ts`, change `useUpdateTerm`'s meta (`:444`) from `meta: { successMessage: "toast.saved" }` to `meta: { successMessage: "toast.saved", suppressErrorToast: true }`, and the same for `useUpdateAuthority` (`:521`).
|
||||
|
||||
- [ ] **Step 2: Inline error + reset in `web/src/vocab/term-row.tsx`.** Add the import `import { MutationError } from "../components/mutation-error";`. In the editing view, add `<MutationError error={updateTerm.error} />` immediately after the save/cancel `<div className="flex gap-2">…</div>` (still inside the `<li>`). In the non-editing view's Edit `<Button>` `onClick`, add `updateTerm.reset();` as the first statement (before `setLabels(...)`):
|
||||
```tsx
|
||||
onClick={() => {
|
||||
updateTerm.reset();
|
||||
setLabels(term.labels as LabelInput[]);
|
||||
setUri(term.external_uri ?? "");
|
||||
setEditing(true);
|
||||
}}
|
||||
```
|
||||
|
||||
- [ ] **Step 2b: Same for `web/src/authorities/authority-row.tsx`.** Import `MutationError`; add `<MutationError error={updateAuthority.error} />` after the save/cancel `<div className="flex gap-2">…</div>`; add `updateAuthority.reset();` as the first statement in the Edit button's `onClick`.
|
||||
|
||||
- [ ] **Step 3: Status-aware delete dialog (`web/src/components/delete-confirm-dialog.tsx`).** Add `import { errorMessageKey } from "../api/error-message";`, remove the now-unused `import { InUseError } from "../api/queries";`, and change the `catch` block (lines ~37-41) from the `err instanceof InUseError ? … : t("form.rejected")` line to:
|
||||
```tsx
|
||||
} catch (err) {
|
||||
// Keep the dialog open; show the blocking reason. Never let the rejected
|
||||
// mutation escape as an unhandled rejection.
|
||||
const { key, opts } = errorMessageKey(err);
|
||||
setMessage(t(key, opts));
|
||||
return;
|
||||
}
|
||||
```
|
||||
(`errorMessageKey` already maps `InUseError` → `actions.inUse` with the count, so the in-use message is preserved and a 403/404 delete now shows a specific message.)
|
||||
|
||||
- [ ] **Step 4: Tests.** Add a failing-update test to `web/src/vocab/term-row.tsx`'s area — create `web/src/vocab/term-row.test.tsx` if absent (check first), else extend. Render a `TermRow` inside `renderApp` with the `makeQueryClient` toast wrapper is overkill — use the existing `renderApp` and MSW. Concretely:
|
||||
```tsx
|
||||
import { expect, test } from "vitest";
|
||||
import { screen, waitFor, within } from "@testing-library/react";
|
||||
import userEvent from "@testing-library/user-event";
|
||||
import { http, HttpResponse } from "msw";
|
||||
|
||||
import { server } from "../test/server";
|
||||
import { renderApp } from "../test/render";
|
||||
import { TermRow } from "./term-row";
|
||||
|
||||
const term = { id: "t1", external_uri: null, labels: [{ lang: "en", label: "Bronze" }] };
|
||||
|
||||
test("a failed term update shows an inline error and keeps the row editable", async () => {
|
||||
server.use(
|
||||
http.patch("/api/admin/vocabularies/:id/terms/:term_id", () => new HttpResponse(null, { status: 403 })),
|
||||
);
|
||||
renderApp(<ul><TermRow vocabularyId="v1" term={term as never} lang="en" /></ul>);
|
||||
|
||||
await userEvent.click(screen.getByRole("button", { name: /edit/i }));
|
||||
await userEvent.click(screen.getByRole("button", { name: /save/i }));
|
||||
|
||||
expect(await screen.findByRole("alert")).toHaveTextContent(/permission/i);
|
||||
// still editable: the save button is still present (editor did not close)
|
||||
expect(screen.getByRole("button", { name: /save/i })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
test("re-entering edit after a failure clears the stale error", async () => {
|
||||
server.use(
|
||||
http.patch("/api/admin/vocabularies/:id/terms/:term_id", () => new HttpResponse(null, { status: 403 })),
|
||||
);
|
||||
renderApp(<ul><TermRow vocabularyId="v1" term={term as never} lang="en" /></ul>);
|
||||
|
||||
await userEvent.click(screen.getByRole("button", { name: /edit/i }));
|
||||
await userEvent.click(screen.getByRole("button", { name: /save/i }));
|
||||
expect(await screen.findByRole("alert")).toBeInTheDocument();
|
||||
await userEvent.click(screen.getByRole("button", { name: /cancel/i }));
|
||||
await userEvent.click(screen.getByRole("button", { name: /edit/i }));
|
||||
|
||||
expect(screen.queryByRole("alert")).toBeNull();
|
||||
});
|
||||
```
|
||||
(Adjust the `lang`/`term` cast to match `TermView`. If a `term-row.test.tsx` already exists, append these and keep existing tests green. The `mutation-feedback.test.tsx` test #1 — `useUpdateTerm` success → `toast.saved` — still passes since suppress only affects errors; confirm it stays green.)
|
||||
|
||||
- [ ] **Step 5: Verify (vitest ONCE):**
|
||||
```bash
|
||||
cd web && pnpm vitest run src/vocab/term-row.test.tsx src/authorities src/components/delete-confirm-dialog.test.tsx src/api/mutation-feedback.test.tsx && pnpm typecheck && pnpm lint
|
||||
```
|
||||
Expected: green (new row tests pass; delete-dialog story/test still green; authority tests green). If `delete-confirm-dialog.test.tsx` doesn't exist, drop it from the command.
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git add web/src/api/queries.ts web/src/vocab/term-row.tsx web/src/authorities/authority-row.tsx web/src/components/delete-confirm-dialog.tsx web/src/vocab/term-row.test.tsx
|
||||
git commit -m "feat(web): inline status-aware errors on term/authority edit rows + delete dialog (#63)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Task 4: Create/rename/object form adoption + fetch fix + full gate
|
||||
|
||||
**Files:** Modify `web/src/authorities/authorities-page.tsx`, `web/src/vocab/vocabulary-terms.tsx`, `web/src/vocab/vocabulary-list.tsx`, `web/src/fields/field-form.tsx`, `web/src/objects/object-new-page.tsx`, `web/src/objects/object-edit-form.tsx` (+ a test).
|
||||
|
||||
- [ ] **Step 1: Adopt `<MutationError>` at the create/rename inline sites.** In each file, add `import { MutationError } from "../components/mutation-error";` (path `../components/mutation-error` from these dirs) and replace the `{X.isError && <p role="alert" className="text-xs text-destructive">{t("form.rejected")}</p>}` block with `<MutationError error={X.error} />`:
|
||||
- `authorities-page.tsx:144-148` → `<MutationError error={create.error} />`
|
||||
- `vocabulary-terms.tsx:119-123` → `<MutationError error={addTerm.error} />`
|
||||
- `vocabulary-list.tsx:57-61` → `<MutationError error={create.error} />`; and `:109-113` → `<MutationError error={renameVocabulary.error} />`
|
||||
- `field-form.tsx:201-205` → `<MutationError error={isEdit ? update.error : create.error} />`; then delete the now-unused `const failed = isEdit ? update.isError : create.isError;` (`:98`). Keep `const pending = …` and the `{error && …form.required}` validation block.
|
||||
|
||||
- [ ] **Step 2: Object create/edit catch-else via the helper.** In `web/src/objects/object-new-page.tsx`, add `import { errorMessageKey } from "../api/error-message";` and change the create catch (`:36-39`) from `} catch { setError(t("form.rejected")); return false; }` to:
|
||||
```tsx
|
||||
} catch (e) {
|
||||
const { key, opts } = errorMessageKey(e);
|
||||
setError(t(key, opts));
|
||||
return false;
|
||||
}
|
||||
```
|
||||
In `web/src/objects/object-edit-form.tsx`, add the same import and change the non-`FieldRejection` else (`:86-88`) from `setError(t("form.rejected"));` to:
|
||||
```tsx
|
||||
} else {
|
||||
const { key, opts } = errorMessageKey(e);
|
||||
setError(t(key, opts));
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Fetch-error fix in `web/src/objects/object-edit-form.tsx`.** Change `const { data: object, isLoading } = useObject(id!);` to `const { data: object, isLoading, isError } = useObject(id!);` and insert, between the `isLoading` and `!object` guards:
|
||||
```tsx
|
||||
if (isError) return <p className="p-4 text-sm text-destructive">{t("objects.loadError")}</p>;
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Test the fetch fix + one create-form adoption.** Add to `web/src/objects/object-edit-form.test.tsx` (create if absent):
|
||||
```tsx
|
||||
test("renders a load error (not 'not found') when the object fetch fails", async () => {
|
||||
server.use(http.get("/api/admin/objects/:id", () => new HttpResponse(null, { status: 500 })));
|
||||
renderApp(<Routes><Route path="/objects/:id/edit" element={<ObjectEditForm />} /></Routes>, {
|
||||
route: "/objects/abc/edit",
|
||||
});
|
||||
expect(await screen.findByText(/could not load/i)).toBeInTheDocument();
|
||||
expect(screen.queryByText(/not found/i)).toBeNull();
|
||||
});
|
||||
```
|
||||
(Use the file's existing imports/harness; add `http`/`HttpResponse` from `msw`, `Routes`/`Route`, `server`, `renderApp`, `ObjectEditForm` as needed. If the file exists, append and keep its tests green.) Also add to `web/src/authorities/authorities-page.test.tsx` (or the nearest existing authorities test) a case asserting a failed create shows the status message:
|
||||
```tsx
|
||||
test("a failed create shows a status-aware inline error", async () => {
|
||||
server.use(http.post("/api/admin/authorities", () => new HttpResponse(null, { status: 403 })));
|
||||
// …render the authorities page, fill a label, submit…
|
||||
expect(await screen.findByText(/permission/i)).toBeInTheDocument();
|
||||
});
|
||||
```
|
||||
(Wire the render/fill/submit to match the existing authorities test harness; if that harness isn't readily reusable, cover the create-error path through `field-form` or skip this second assertion — the `MutationError` component test already proves the rendering, and `error-message.test.ts` proves the mapping. Do NOT add a brittle test just to hit a number.)
|
||||
|
||||
- [ ] **Step 5: FULL FRONTEND GATE (run tests EXACTLY ONCE):**
|
||||
```bash
|
||||
cd web && pnpm typecheck && pnpm lint && pnpm test && pnpm build && pnpm check:size && pnpm check:colors
|
||||
```
|
||||
All green. Report test totals, largest chunk (gz), and the `check:colors` line.
|
||||
|
||||
- [ ] **Step 6: Codename + status:**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git grep -in 'biggus\|dickus' -- web/src; echo "codename-exit=$?"
|
||||
git status --short
|
||||
```
|
||||
Expected: no matches (`codename-exit=1`).
|
||||
|
||||
- [ ] **Step 7: Manual smoke (recommended).** With the stack + server + `pnpm dev`: cause a failing save (e.g. stop the server, or a 409 on a duplicate) on a term/authority edit row → inline status message appears at the row, row stays editable; a failed create shows the inline message; loading an edit form whose object 500s shows "Could not load objects" not "not found."
|
||||
|
||||
- [ ] **Step 8: Commit**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git add web/src/authorities/authorities-page.tsx web/src/vocab/vocabulary-terms.tsx web/src/vocab/vocabulary-list.tsx web/src/fields/field-form.tsx web/src/objects/object-new-page.tsx web/src/objects/object-edit-form.tsx web/src/objects/object-edit-form.test.tsx web/src/authorities/authorities-page.test.tsx
|
||||
git commit -m "feat(web): adopt MutationError across create/object forms; distinguish edit-form fetch error (#63)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Self-Review (completed)
|
||||
|
||||
**Spec coverage:** AC1 `errorMessageKey` + unit test (T1 S2-S3); AC2 `<MutationError>` + adoption at delete-dialog (T3 S3), create/rename forms (T4 S1), object-form `formError` via helper (T4 S2), edit rows (T3 S2); AC3 16 throws → `HttpError` + query-client rewire (T2, T1 S6); AC4 update suppress + inline + reset (T3 S1-S2); AC5 edit-form fetch error (T4 S3); AC6 gate + parity + codename (T4 S5-S6, T1 S1). ✓
|
||||
|
||||
**Placeholder scan:** every code step shows complete code; tests have concrete assertions and exact statuses (403/500); the one soft spot (T4 S4 second assertion) is explicitly bounded with "don't add a brittle test to hit a number," and the mapping/rendering are already proven by T1's two test files. No TODO/TBD. ✓
|
||||
|
||||
**Type/consistency:** `errorMessageKey(error: unknown): { key: string; opts? }` defined in T1, consumed identically by `query-client.ts`, `MutationError`, `delete-confirm-dialog`, `object-new-page`, `object-edit-form`. `HttpError(status)` (T2) feeds `errorMessageKey`'s `instanceof HttpError` branch. `suppressErrorToast` added (T3 S1) matches the sibling mutations' meta shape. `objects.loadError` pre-exists. ✓
|
||||
|
||||
## Notes
|
||||
- No new dependency. `ui/*` untouched. en/sv parity preserved (5 new `errors.*` keys, guarded by the #60 parity test).
|
||||
- After Task 2 (before Task 3), `useUpdateTerm`/`useUpdateAuthority` are still non-suppressed and now throw `HttpError`, so a failed update shows a status-mapped **toast** — a transient mid-milestone state; Task 3 moves it inline. Each commit is independently green.
|
||||
- Error classes stay in `queries.ts`; relocating them to `api/errors.ts` is tracked in #65.
|
||||
@@ -0,0 +1,344 @@
|
||||
# Split queries.ts — Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Extract the 4 error classes to `api/errors.ts`, add a `keys` query-key factory in `api/query-keys.ts` (and invalidate `["search"]` on object writes), then split `queries.ts` into `api/queries/{auth,objects,field-defs,vocab,authorities,search}.ts` behind a stable `api/queries/index.ts` barrel — behavior-preserving except the search invalidation.
|
||||
|
||||
**Architecture:** Three ordered, individually-green tasks. Task 1 extracts errors (queries.ts re-exports them). Task 2 adds the key factory + search invalidation (still monolithic). Task 3 moves the now-final hook bodies into domain modules behind a barrel that keeps `../api/queries` stable for all ~30 consumers.
|
||||
|
||||
**Tech Stack:** React 19 + TS + pnpm, TanStack Query v5, openapi-fetch, Vitest 4 (jsdom) + RTL + MSW.
|
||||
|
||||
**Conventions:** pnpm; **no `any`/`eslint-disable`/`@ts-ignore`**; no codename; double-quote+semicolon. Run a single test pass per task. Behavior-preserving except the one search-invalidation change.
|
||||
|
||||
**Spec:** `docs/superpowers/specs/2026-06-08-split-queries-design.md`
|
||||
|
||||
**Key facts:**
|
||||
- `web/src/api/queries.ts` (584 lines) currently defines 4 error classes (`HttpError` :6, `FieldRejection` :13, `InUseError` :20, `VisibilityError` :394) + `type ObjectListParams` (:46) + all hooks.
|
||||
- Error-class importers (non-test): `api/error-message.ts` (`HttpError, InUseError`), `objects/object-edit-form.tsx` + `objects/object-new-page.tsx` (`FieldRejection`), `objects/publish-control.tsx` (`VisibilityError`), `search/search-panel.tsx` (`HttpError`) — all via `../api/queries`. Tests: `mutation-error.test.tsx`, `labelled-record-row.test.tsx`, `error-message.test.ts` import error classes from `../api/queries`.
|
||||
- ~30 files import hooks from `../api/queries`. Query-layer test suites: `queries.test.ts`, `queries.authoring.test.tsx`, `queries.fields.test.tsx`, `queries.search.test.tsx`, `queries.visibility.test.tsx`, `queries.vocab.test.tsx`, `mutation-feedback.test.tsx`.
|
||||
- Key literals: `["me"]`, `["config"]` (in `config/config-provider.tsx:10`), `["objects", params]`, `["objects"]`, `["object", id]`, `["field-definitions"]`, `["terms", vocabularyId]`, `["authorities", kind]`, `["vocabularies"]`, `["search", term, visibility]`.
|
||||
- `useTerms`/`useAuthorities` key on a `string | null | undefined` arg (enabled-gated), so `keys.terms`/`keys.authorities` must accept that union.
|
||||
|
||||
---
|
||||
|
||||
# Task 1: Extract error classes → `api/errors.ts`
|
||||
|
||||
**Files:** Create `web/src/api/errors.ts`; Modify `web/src/api/queries.ts`, `web/src/api/error-message.ts`.
|
||||
|
||||
- [ ] **Step 1: Create `web/src/api/errors.ts`** (move the 4 classes verbatim):
|
||||
```ts
|
||||
export class HttpError extends Error {
|
||||
constructor(public readonly status: number) {
|
||||
super(`HTTP ${status}`);
|
||||
this.name = "HttpError";
|
||||
}
|
||||
}
|
||||
|
||||
export class FieldRejection extends Error {
|
||||
constructor(public readonly field: string, public readonly code: string) {
|
||||
super(`field rejected: ${field}`);
|
||||
this.name = "FieldRejection";
|
||||
}
|
||||
}
|
||||
|
||||
export class InUseError extends Error {
|
||||
constructor(public readonly count: number) {
|
||||
super(`in use: ${count}`);
|
||||
this.name = "InUseError";
|
||||
}
|
||||
}
|
||||
|
||||
/** Error carrying the HTTP status so callers can branch 422-gate vs 409-illegal. */
|
||||
export class VisibilityError extends Error {
|
||||
constructor(public status: number) {
|
||||
super(`visibility change failed (${status})`);
|
||||
this.name = "VisibilityError";
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Update `web/src/api/queries.ts`.** DELETE the 4 class definitions (lines ~6-25 `HttpError`/`FieldRejection`/`InUseError`, and ~393-399 `VisibilityError`). At the top of the file (after the existing `import` lines), add an import for use + a re-export for compatibility:
|
||||
```ts
|
||||
import { HttpError, FieldRejection, InUseError, VisibilityError } from "./errors";
|
||||
|
||||
export { HttpError, FieldRejection, InUseError, VisibilityError } from "./errors";
|
||||
```
|
||||
(The `import` binds them for the throw sites in this file; the `export … from` re-exports them so every consumer importing from `../api/queries` keeps working. Everything else in `queries.ts` is unchanged.)
|
||||
|
||||
- [ ] **Step 3: Repoint `web/src/api/error-message.ts`.** Change `import { HttpError, InUseError } from "./queries";` to `import { HttpError, InUseError } from "./errors";`. (This is the decoupling: the toast path no longer transitively loads the hook module.)
|
||||
|
||||
- [ ] **Step 4: Verify (vitest ONCE for the affected suites), typecheck, lint:**
|
||||
```bash
|
||||
cd web && pnpm vitest run src/api/error-message.test.ts src/api/mutation-feedback.test.tsx src/api/queries.test.ts src/components/mutation-error.test.tsx src/components/labelled-record-row.test.tsx && pnpm typecheck && pnpm lint
|
||||
```
|
||||
Expected: green. The error classes are now sourced from `errors.ts` but re-exported, so all importers resolve. If typecheck flags an unused import in `queries.ts`, ensure each of the 4 classes is actually thrown somewhere in the file (they are: `HttpError` many sites, `FieldRejection` in `useSetFields`, `InUseError` in the delete mutations, `VisibilityError` in `useSetVisibility`) — keep all four in the import.
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git add web/src/api/errors.ts web/src/api/queries.ts web/src/api/error-message.ts
|
||||
git commit -m "refactor(web): extract API error classes to api/errors.ts (#65)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Task 2: Query-key factory + search invalidation
|
||||
|
||||
**Files:** Create `web/src/api/query-keys.ts`, `web/src/api/query-keys.test.ts`, `web/src/api/search-invalidation.test.tsx`; Modify `web/src/api/queries.ts`, `web/src/config/config-provider.tsx`.
|
||||
|
||||
- [ ] **Step 1: Create `web/src/api/query-keys.ts`:**
|
||||
```ts
|
||||
export type ObjectListParams = {
|
||||
limit: number;
|
||||
offset: number;
|
||||
sort?: string;
|
||||
order?: "asc" | "desc";
|
||||
visibility?: string;
|
||||
q?: string;
|
||||
};
|
||||
|
||||
/** Central query-key factory — the single source of truth for cache keys, so
|
||||
* query/invalidate/setQueryData sites can't drift. */
|
||||
export const keys = {
|
||||
me: () => ["me"] as const,
|
||||
config: () => ["config"] as const,
|
||||
objects: () => ["objects"] as const,
|
||||
objectsPage: (params: ObjectListParams) => ["objects", params] as const,
|
||||
object: (id: string) => ["object", id] as const,
|
||||
fieldDefinitions: () => ["field-definitions"] as const,
|
||||
vocabularies: () => ["vocabularies"] as const,
|
||||
terms: (vocabularyId: string | null | undefined) => ["terms", vocabularyId] as const,
|
||||
authorities: (kind: string | null | undefined) => ["authorities", kind] as const,
|
||||
search: () => ["search"] as const,
|
||||
searchResults: (term: string, visibility: string | null) => ["search", term, visibility] as const,
|
||||
};
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Create `web/src/api/query-keys.test.ts`** (write + run):
|
||||
```ts
|
||||
import { expect, test } from "vitest";
|
||||
|
||||
import { keys } from "./query-keys";
|
||||
|
||||
test("the key factory produces the expected arrays", () => {
|
||||
expect(keys.me()).toEqual(["me"]);
|
||||
expect(keys.config()).toEqual(["config"]);
|
||||
expect(keys.objects()).toEqual(["objects"]);
|
||||
const p = { limit: 50, offset: 0 };
|
||||
expect(keys.objectsPage(p)).toEqual(["objects", p]);
|
||||
expect(keys.object("x")).toEqual(["object", "x"]);
|
||||
expect(keys.fieldDefinitions()).toEqual(["field-definitions"]);
|
||||
expect(keys.vocabularies()).toEqual(["vocabularies"]);
|
||||
expect(keys.terms("v1")).toEqual(["terms", "v1"]);
|
||||
expect(keys.authorities("person")).toEqual(["authorities", "person"]);
|
||||
expect(keys.search()).toEqual(["search"]);
|
||||
expect(keys.searchResults("q", null)).toEqual(["search", "q", null]);
|
||||
});
|
||||
|
||||
test("objects() is a prefix of objectsPage() so invalidation matches", () => {
|
||||
const prefix = keys.objects();
|
||||
const full = keys.objectsPage({ limit: 50, offset: 0 });
|
||||
expect(full.slice(0, prefix.length)).toEqual(prefix);
|
||||
});
|
||||
```
|
||||
Run: `cd web && pnpm vitest run src/api/query-keys.test.ts`.
|
||||
|
||||
- [ ] **Step 3: Replace every key literal in `web/src/api/queries.ts` with `keys.*`.** Add `import { keys, type ObjectListParams } from "./query-keys";` and DELETE the local `export type ObjectListParams = {…};` block (now imported). Substitutions (every occurrence):
|
||||
- `queryKey: ["me"]` → `queryKey: keys.me()`; `qc.invalidateQueries({ queryKey: ["me"] })` → `keys.me()`; `qc.setQueryData(["me"], null)` → `qc.setQueryData(keys.me(), null)`
|
||||
- `queryKey: ["objects", params]` → `keys.objectsPage(params)`
|
||||
- `["objects"]` (invalidations) → `keys.objects()`
|
||||
- `["object", id]` → `keys.object(id)`
|
||||
- `["field-definitions"]` → `keys.fieldDefinitions()`
|
||||
- `["terms", vocabularyId]` → `keys.terms(vocabularyId)`
|
||||
- `["authorities", kind]` → `keys.authorities(kind)`
|
||||
- `["vocabularies"]` → `keys.vocabularies()`
|
||||
- `queryKey: ["search", term, visibility]` → `keys.searchResults(term, visibility)`
|
||||
Re-export the type so consumers importing `ObjectListParams` from `../api/queries` keep working: add `export type { ObjectListParams } from "./query-keys";` near the top.
|
||||
|
||||
- [ ] **Step 4: Add search invalidation (`web/src/api/queries.ts`).** In each of these `onSuccess` handlers add `void qc.invalidateQueries({ queryKey: keys.search() });`:
|
||||
- `useUpdateObject` onSuccess (after the `objects`/`object` invalidations)
|
||||
- `useDeleteObject` onSuccess (alongside the `objects` invalidation — convert it to a block: `onSuccess: () => { void qc.invalidateQueries({ queryKey: keys.objects() }); void qc.invalidateQueries({ queryKey: keys.search() }); }`)
|
||||
- `useSetVisibility` onSuccess (after the `object`/`objects` invalidations)
|
||||
|
||||
- [ ] **Step 5: Update `web/src/config/config-provider.tsx`.** Add `import { keys } from "../api/query-keys";` and change `queryKey: ["config"]` → `queryKey: keys.config()`.
|
||||
|
||||
- [ ] **Step 6: Create `web/src/api/search-invalidation.test.tsx`** (write + run) — proves the new behavior:
|
||||
```tsx
|
||||
import { expect, test } from "vitest";
|
||||
import { renderHook, waitFor } from "@testing-library/react";
|
||||
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
||||
import { http, HttpResponse } from "msw";
|
||||
import type { ReactNode } from "react";
|
||||
|
||||
import { server } from "../test/server";
|
||||
import { useSetVisibility } from "./queries";
|
||||
import { keys } from "./query-keys";
|
||||
|
||||
test("changing an object's visibility invalidates the active search query", async () => {
|
||||
server.use(
|
||||
http.post("/api/admin/objects/:id/visibility", () => new HttpResponse(null, { status: 204 })),
|
||||
);
|
||||
const qc = new QueryClient({ defaultOptions: { queries: { retry: false } } });
|
||||
qc.setQueryData(keys.searchResults("amphora", null), { pages: [], pageParams: [] });
|
||||
|
||||
const wrapper = ({ children }: { children: ReactNode }) => (
|
||||
<QueryClientProvider client={qc}>{children}</QueryClientProvider>
|
||||
);
|
||||
const { result } = renderHook(() => useSetVisibility(), { wrapper });
|
||||
|
||||
await result.current.mutateAsync({ id: "o1", visibility: "public" });
|
||||
|
||||
await waitFor(() =>
|
||||
expect(qc.getQueryState(keys.searchResults("amphora", null))?.isInvalidated).toBe(true),
|
||||
);
|
||||
});
|
||||
```
|
||||
Run: `cd web && pnpm vitest run src/api/search-invalidation.test.tsx`. (If `isInvalidated` is flaky, assert `qc.getQueryState(keys.searchResults("amphora", null))` exists and was marked stale via `isInvalidated`; the mutation's `onSuccess` runs the invalidation synchronously after the 204.)
|
||||
|
||||
- [ ] **Step 7: Verify (vitest ONCE for the query suites), typecheck, lint:**
|
||||
```bash
|
||||
cd web && pnpm vitest run src/api/query-keys.test.ts src/api/search-invalidation.test.tsx src/api/queries.test.ts src/api/queries.authoring.test.tsx src/api/queries.fields.test.tsx src/api/queries.search.test.tsx src/api/queries.visibility.test.tsx src/api/queries.vocab.test.tsx src/config && pnpm typecheck && pnpm lint
|
||||
```
|
||||
Expected: green. The key arrays are identical to before, so all existing query tests pass unchanged.
|
||||
|
||||
- [ ] **Step 8: Commit**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git add web/src/api/query-keys.ts web/src/api/query-keys.test.ts web/src/api/search-invalidation.test.tsx web/src/api/queries.ts web/src/config/config-provider.tsx
|
||||
git commit -m "refactor(web): central query-key factory + invalidate search on object writes (#65)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Task 3: Split queries.ts into `api/queries/` domain modules
|
||||
|
||||
**Files:** Create `web/src/api/queries/{index,auth,objects,field-defs,vocab,authorities,search}.ts`; Delete `web/src/api/queries.ts`.
|
||||
|
||||
**Approach:** Move each hook (and its local `type X = components[...]` aliases) VERBATIM from the current `queries.ts` into its domain module — the bodies already use `keys.*` and the `errors.ts` classes after Tasks 1-2. Only the relative import paths change (`./client`→`../client`, `./schema`→`../schema`, `./errors`, `./query-keys`). Then add the barrel and delete `queries.ts`.
|
||||
|
||||
- [ ] **Step 1: `web/src/api/queries/auth.ts`** — header + move `useMe`, `useLogin`, `useLogout`:
|
||||
```ts
|
||||
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
||||
|
||||
import { api } from "../client";
|
||||
import type { components } from "../schema";
|
||||
import { keys } from "../query-keys";
|
||||
|
||||
type UserView = components["schemas"]["UserView"];
|
||||
type LoginRequest = components["schemas"]["LoginRequest"];
|
||||
```
|
||||
(These three throw only plain `Error` — no `errors.ts` import needed here.)
|
||||
|
||||
- [ ] **Step 2: `web/src/api/queries/objects.ts`** — header + move `useObjectsPage`, `useObject`, `useCreateObject`, `useUpdateObject`, `useSetFields`, `useDeleteObject`, `useSetVisibility`:
|
||||
```ts
|
||||
import { keepPreviousData, useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
||||
|
||||
import { api } from "../client";
|
||||
import type { components } from "../schema";
|
||||
import { HttpError, FieldRejection, VisibilityError } from "../errors";
|
||||
import { keys, type ObjectListParams } from "../query-keys";
|
||||
|
||||
type ObjectCreateRequest = components["schemas"]["ObjectCreateRequest"];
|
||||
type ObjectUpdateRequest = components["schemas"]["ObjectUpdateRequest"];
|
||||
type Visibility = "draft" | "internal" | "public";
|
||||
```
|
||||
(`ObjectListParams` now comes from `query-keys`. `useObjectsPage`/`useObject` query fns throw plain `Error`; the mutations use the imported error classes.)
|
||||
|
||||
- [ ] **Step 3: `web/src/api/queries/field-defs.ts`** — header + move `useFieldDefinitions`, `useCreateFieldDefinition`, `useUpdateFieldDefinition`, `useDeleteFieldDefinition`:
|
||||
```ts
|
||||
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
||||
|
||||
import { api } from "../client";
|
||||
import type { components } from "../schema";
|
||||
import { HttpError, InUseError } from "../errors";
|
||||
import { keys } from "../query-keys";
|
||||
|
||||
type NewFieldDefinitionRequest = components["schemas"]["NewFieldDefinitionRequest"];
|
||||
type LabelInput = components["schemas"]["LabelInput"];
|
||||
```
|
||||
|
||||
- [ ] **Step 4: `web/src/api/queries/vocab.ts`** — header + move `useVocabularies`, `useCreateVocabulary`, `useRenameVocabulary`, `useDeleteVocabulary`, `useTerms`, `useAddTerm`, `useUpdateTerm`, `useDeleteTerm`:
|
||||
```ts
|
||||
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
||||
|
||||
import { api } from "../client";
|
||||
import type { components } from "../schema";
|
||||
import { HttpError, InUseError } from "../errors";
|
||||
import { keys } from "../query-keys";
|
||||
|
||||
type NewVocabularyRequest = components["schemas"]["NewVocabularyRequest"];
|
||||
type LabelInput = components["schemas"]["LabelInput"];
|
||||
```
|
||||
|
||||
- [ ] **Step 5: `web/src/api/queries/authorities.ts`** — header + move `useAuthorities`, `useCreateAuthority`, `useUpdateAuthority`, `useDeleteAuthority`:
|
||||
```ts
|
||||
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
||||
|
||||
import { api } from "../client";
|
||||
import type { components } from "../schema";
|
||||
import { HttpError, InUseError } from "../errors";
|
||||
import { keys } from "../query-keys";
|
||||
|
||||
type LabelInput = components["schemas"]["LabelInput"];
|
||||
```
|
||||
|
||||
- [ ] **Step 6: `web/src/api/queries/search.ts`** — header + move the `SEARCH_PAGE` const and `useSearch`:
|
||||
```ts
|
||||
import { keepPreviousData, useInfiniteQuery } from "@tanstack/react-query";
|
||||
|
||||
import { api } from "../client";
|
||||
import { HttpError } from "../errors";
|
||||
import { keys } from "../query-keys";
|
||||
|
||||
const SEARCH_PAGE = 20;
|
||||
```
|
||||
|
||||
- [ ] **Step 7: `web/src/api/queries/index.ts`** (barrel):
|
||||
```ts
|
||||
export * from "./auth";
|
||||
export * from "./objects";
|
||||
export * from "./field-defs";
|
||||
export * from "./vocab";
|
||||
export * from "./authorities";
|
||||
export * from "./search";
|
||||
export * from "../errors";
|
||||
export type { ObjectListParams } from "../query-keys";
|
||||
```
|
||||
|
||||
- [ ] **Step 8: Delete the old monolith:** `git rm web/src/api/queries.ts` (every hook has been moved; the barrel + modules now provide the same exports). Confirm no hook/type was dropped: each of the 24 hooks + `ObjectListParams` + the 4 error classes is exported via the barrel.
|
||||
|
||||
- [ ] **Step 9: FULL FRONTEND GATE (run tests EXACTLY ONCE):**
|
||||
```bash
|
||||
cd web && pnpm typecheck && pnpm lint && pnpm test && pnpm build && pnpm check:size && pnpm check:colors
|
||||
```
|
||||
All green. The `../api/queries` import path now resolves to `api/queries/index.ts`, so all ~30 consumers + the query-layer test suites resolve unchanged. If typecheck reports a missing export, a hook landed in the wrong module or an import path is off — fix the module, do NOT edit consumers/tests. Report test totals, largest chunk (gz), and the `check:colors` line.
|
||||
|
||||
- [ ] **Step 10: Codename + status:**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git grep -in 'biggus\|dickus' -- web/src; echo "codename-exit=$?"
|
||||
git status --short
|
||||
```
|
||||
Expected: no matches (`codename-exit=1`); `web/src/api/queries.ts` shows as deleted, the 7 new files added.
|
||||
|
||||
- [ ] **Step 11: Commit**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git add web/src/api/queries/ && git rm -q web/src/api/queries.ts 2>/dev/null; git add -A web/src/api
|
||||
git commit -m "refactor(web): split queries.ts into api/queries/ domain modules behind a barrel (#65)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Self-Review (completed)
|
||||
|
||||
**Spec coverage:** AC1 errors extracted + error-message repointed + barrel re-export (T1, T3 S7); AC2 directory split + queries.ts deleted + stable path (T3); AC3 key factory used everywhere incl. config-provider (T2 S3/S5); AC4 search invalidation on the 3 object mutations (T2 S4); AC5 existing tests unchanged + gate (T1 S4, T2 S7, T3 S9). ✓
|
||||
|
||||
**Placeholder scan:** every new file shown in full or as a precise header + verbatim-move instruction; the move tasks name the exact hook list per module; tests have concrete assertions. No TBD. ✓
|
||||
|
||||
**Type/consistency:** `keys` (T2) is the same object consumed in T3's modules; `ObjectListParams` defined in `query-keys.ts` (T2), imported by `objects.ts` (T3 S2) and re-exported by the barrel (T3 S7); error classes from `errors.ts` (T1) imported by `objects/field-defs/vocab/authorities/search` modules (T3) and re-exported by the barrel; `keys.terms`/`keys.authorities` accept `string | null | undefined` to match the enabled-gated query usage. ✓
|
||||
|
||||
## Notes
|
||||
- No new dependency, no new i18n keys, `components/ui/*` untouched. `check:size` should be unchanged (pure reorg + one invalidate call). Barrel keeps `../api/queries` stable → zero consumer churn.
|
||||
- The error classes are intentionally importable from both `../api/errors` (canonical) and `../api/queries` (compat re-export). Repointing the 4 component importers to `../api/errors` is a deferred cosmetic follow-up.
|
||||
- `auth.ts` needs no `errors.ts` import (its throws are plain `Error`); every other module imports the error classes it throws.
|
||||
@@ -0,0 +1,726 @@
|
||||
# Unify Vocabulary + Authority CRUD — Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Collapse the duplicated Vocabulary-terms + Authorities CRUD (~280 lines across 4 files) into three shared components, with the rows and pages reduced to thin adapters — behavior-preserving.
|
||||
|
||||
**Architecture:** Build `LabelledRecordRow`, `LabelledRecordCreateForm`, and `FilteredRecordList<T>` in `src/components/` (Tasks 1-3, additive — existing app untouched, all existing tests stay green). Then rewire `term-row`/`authority-row` and `authorities-page`/`vocabulary-terms` onto them (Task 4) and run the full gate. Variance (mutation hooks, arg shapes, i18n keys, page chrome) lives entirely in the adapters.
|
||||
|
||||
**Tech Stack:** React 19 + TS + pnpm, TanStack Query v5, react-i18next, Base UI, Vitest 4 (jsdom) + RTL.
|
||||
|
||||
**Conventions:** pnpm; **no `any`/`eslint-disable`/`@ts-ignore`**; no codename; double-quote+semicolon; token classes only; `components/ui/*` untouched. Run a single test pass per task.
|
||||
|
||||
**Spec:** `docs/superpowers/specs/2026-06-08-unify-record-crud-design.md`
|
||||
|
||||
**Key facts:**
|
||||
- Types: `type LabelView = components["schemas"]["LabelView"]`, `type LabelInput = components["schemas"]["LabelInput"]`. `labelText(labels: LabelView[], lang)` (`lib/labels`), `byLabel(lang)` returns a comparator over `{ labels: LabelView[] }` (`lib/sort`).
|
||||
- Shared building blocks (in `src/components/`): `label-editor` (`LabelEditor`, uses `useId` since #62, needs `useConfig` which defaults to `DEFAULTS` — works under `renderApp`), `delete-confirm-dialog` (`DeleteConfirmDialog` — props `description`, `onConfirm: () => Promise<void>`), `mutation-error` (`MutationError` — prop `error: unknown`), `external-uri-link` (`ExternalUriLink` — prop `uri`).
|
||||
- UI kit: `Button`, `Input`, `Label` from `@/components/ui/*`; `ListSkeleton` from `@/components/ui/skeletons` (props `className`, `rows`).
|
||||
- Test harness: `renderApp(ui, { route })` from `../test/render` (wraps QueryClient + memory router + i18n; NO ConfigProvider, but `useConfig` falls back to defaults). `HttpError` is exported from `../api/queries`.
|
||||
- Existing tests that MUST stay green unchanged: `vocab/term-row.test.tsx`, `authorities/authorities.test.tsx`, `vocab/vocabularies.test.tsx`.
|
||||
- Current `term-row.tsx`/`authority-row.tsx` are twins; `authorities-page.tsx` has a kind `<nav>` + `PageTitle` + `Navigate` guard + breadcrumb; `vocabulary-terms.tsx` has a `vocab.terms` caption + breadcrumb. Both pages render the filter input ALWAYS, then `isLoading ? <ListSkeleton/> : <ul>…</ul>`.
|
||||
|
||||
---
|
||||
|
||||
# Task 1: `LabelledRecordRow`
|
||||
|
||||
**Files:** Create `web/src/components/labelled-record-row.tsx`, `web/src/components/labelled-record-row.test.tsx`.
|
||||
|
||||
- [ ] **Step 1: Create `web/src/components/labelled-record-row.tsx`:**
|
||||
```tsx
|
||||
import { useId, useState } from "react";
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import type { components } from "../api/schema";
|
||||
import { LabelEditor } from "./label-editor";
|
||||
import { DeleteConfirmDialog } from "./delete-confirm-dialog";
|
||||
import { MutationError } from "./mutation-error";
|
||||
import { ExternalUriLink } from "./external-uri-link";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { Label } from "@/components/ui/label";
|
||||
import { labelText } from "../lib/labels";
|
||||
|
||||
type LabelView = components["schemas"]["LabelView"];
|
||||
type LabelInput = components["schemas"]["LabelInput"];
|
||||
|
||||
export type RecordLike = { id: string; labels: LabelView[]; external_uri: string | null };
|
||||
|
||||
/** One labelled record (term/authority): a display row with edit + delete, or an
|
||||
* inline editor. All variance (mutation hooks, arg shapes, delete-confirm key) is
|
||||
* supplied by the caller via callbacks/state — see term-row.tsx / authority-row.tsx. */
|
||||
export function LabelledRecordRow({
|
||||
record,
|
||||
lang,
|
||||
deleteConfirmKey,
|
||||
savePending,
|
||||
saveError,
|
||||
onEditOpen,
|
||||
onSave,
|
||||
onDelete,
|
||||
}: {
|
||||
record: RecordLike;
|
||||
lang: string;
|
||||
deleteConfirmKey: string;
|
||||
savePending: boolean;
|
||||
saveError: unknown;
|
||||
onEditOpen: () => void;
|
||||
onSave: (labels: LabelInput[], uri: string | null, done: () => void) => void;
|
||||
onDelete: () => Promise<void>;
|
||||
}) {
|
||||
const { t } = useTranslation();
|
||||
const uriId = useId();
|
||||
|
||||
const [editing, setEditing] = useState(false);
|
||||
const [labels, setLabels] = useState<LabelInput[]>(record.labels as LabelInput[]);
|
||||
const [uri, setUri] = useState(record.external_uri ?? "");
|
||||
|
||||
if (editing) {
|
||||
return (
|
||||
<li className="space-y-2 border-b py-2">
|
||||
<LabelEditor value={labels} onChange={setLabels} />
|
||||
<div className="space-y-1">
|
||||
<Label htmlFor={uriId}>{t("labels.externalUri")}</Label>
|
||||
<Input
|
||||
id={uriId}
|
||||
type="url"
|
||||
placeholder={t("labels.uriPlaceholder")}
|
||||
value={uri}
|
||||
onChange={(e) => setUri(e.target.value)}
|
||||
/>
|
||||
</div>
|
||||
<div className="flex gap-2">
|
||||
<Button
|
||||
type="button"
|
||||
size="sm"
|
||||
disabled={savePending}
|
||||
onClick={() => onSave(labels, uri.trim() || null, () => setEditing(false))}
|
||||
>
|
||||
{t("actions.save")}
|
||||
</Button>
|
||||
<Button type="button" variant="ghost" size="sm" onClick={() => setEditing(false)}>
|
||||
{t("form.cancel")}
|
||||
</Button>
|
||||
</div>
|
||||
<MutationError error={saveError} />
|
||||
</li>
|
||||
);
|
||||
}
|
||||
|
||||
return (
|
||||
<li className="flex items-center gap-2 border-b py-1 text-sm">
|
||||
<div className="flex-1">
|
||||
<div>{labelText(record.labels, lang)}</div>
|
||||
{record.external_uri && <ExternalUriLink uri={record.external_uri} />}
|
||||
</div>
|
||||
<Button
|
||||
type="button"
|
||||
variant="ghost"
|
||||
size="sm"
|
||||
onClick={() => {
|
||||
onEditOpen();
|
||||
setLabels(record.labels as LabelInput[]);
|
||||
setUri(record.external_uri ?? "");
|
||||
setEditing(true);
|
||||
}}
|
||||
>
|
||||
{t("actions.edit")}
|
||||
</Button>
|
||||
<DeleteConfirmDialog description={t(deleteConfirmKey)} onConfirm={onDelete} />
|
||||
</li>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Create `web/src/components/labelled-record-row.test.tsx`** (write + run). Type the test record as `RecordLike` (import it) — no `any`/`never`:
|
||||
```tsx
|
||||
import { expect, test, vi } from "vitest";
|
||||
import { screen, within } from "@testing-library/react";
|
||||
import userEvent from "@testing-library/user-event";
|
||||
|
||||
import { renderApp } from "../test/render";
|
||||
import { LabelledRecordRow, type RecordLike } from "./labelled-record-row";
|
||||
import { HttpError } from "../api/queries";
|
||||
|
||||
const record: RecordLike = { id: "r1", external_uri: null, labels: [{ lang: "en", label: "Bronze" }] };
|
||||
|
||||
test("edit → save calls onSave and closes via done()", async () => {
|
||||
const onSave = vi.fn((_labels: unknown, _uri: unknown, done: () => void) => done());
|
||||
renderApp(
|
||||
<ul>
|
||||
<LabelledRecordRow
|
||||
record={record}
|
||||
lang="en"
|
||||
deleteConfirmKey="actions.confirmDeleteTerm"
|
||||
savePending={false}
|
||||
saveError={null}
|
||||
onEditOpen={() => {}}
|
||||
onSave={onSave}
|
||||
onDelete={async () => {}}
|
||||
/>
|
||||
</ul>,
|
||||
);
|
||||
await userEvent.click(screen.getByRole("button", { name: /edit/i }));
|
||||
await userEvent.click(screen.getByRole("button", { name: /save/i }));
|
||||
expect(onSave).toHaveBeenCalled();
|
||||
expect(screen.queryByRole("button", { name: /save/i })).toBeNull();
|
||||
});
|
||||
|
||||
test("a save error renders inline and the row stays editable", async () => {
|
||||
renderApp(
|
||||
<ul>
|
||||
<LabelledRecordRow
|
||||
record={record}
|
||||
lang="en"
|
||||
deleteConfirmKey="actions.confirmDeleteTerm"
|
||||
savePending={false}
|
||||
saveError={new HttpError(403)}
|
||||
onEditOpen={() => {}}
|
||||
onSave={() => {}}
|
||||
onDelete={async () => {}}
|
||||
/>
|
||||
</ul>,
|
||||
);
|
||||
await userEvent.click(screen.getByRole("button", { name: /edit/i }));
|
||||
expect(screen.getByRole("alert")).toHaveTextContent(/permission/i);
|
||||
expect(screen.getByRole("button", { name: /save/i })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
test("confirming delete invokes onDelete", async () => {
|
||||
const onDelete = vi.fn(async () => {});
|
||||
renderApp(
|
||||
<ul>
|
||||
<LabelledRecordRow
|
||||
record={record}
|
||||
lang="en"
|
||||
deleteConfirmKey="actions.confirmDeleteTerm"
|
||||
savePending={false}
|
||||
saveError={null}
|
||||
onEditOpen={() => {}}
|
||||
onSave={() => {}}
|
||||
onDelete={onDelete}
|
||||
/>
|
||||
</ul>,
|
||||
);
|
||||
// open the confirm dialog (trigger button is labelled "Delete")
|
||||
await userEvent.click(screen.getByRole("button", { name: /delete/i }));
|
||||
// the dialog renders in a portal on document.body with a confirm "Delete" action
|
||||
const dialog = within(document.body);
|
||||
const confirmButtons = await dialog.findAllByRole("button", { name: /delete/i });
|
||||
await userEvent.click(confirmButtons[confirmButtons.length - 1]);
|
||||
expect(onDelete).toHaveBeenCalled();
|
||||
});
|
||||
```
|
||||
Run: `cd web && pnpm vitest run src/components/labelled-record-row.test.tsx`. (If the delete-dialog DOM differs, mirror the portal/confirm pattern used in `web/src/shell/user-menu.test.tsx` / the delete-confirm-dialog story — the key assertion is that confirming calls `onDelete`. Don't weaken the save/error assertions.)
|
||||
|
||||
- [ ] **Step 3: Verify + lint:** `cd web && pnpm vitest run src/components/labelled-record-row.test.tsx && pnpm typecheck && pnpm lint` — all green.
|
||||
|
||||
- [ ] **Step 4: Commit**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git add web/src/components/labelled-record-row.tsx web/src/components/labelled-record-row.test.tsx
|
||||
git commit -m "feat(web): shared LabelledRecordRow component (#64)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Task 2: `LabelledRecordCreateForm`
|
||||
|
||||
**Files:** Create `web/src/components/labelled-record-create-form.tsx`, `web/src/components/labelled-record-create-form.test.tsx`.
|
||||
|
||||
- [ ] **Step 1: Create `web/src/components/labelled-record-create-form.tsx`:**
|
||||
```tsx
|
||||
import { useId, useState, type FormEvent, type ReactNode } from "react";
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import type { components } from "../api/schema";
|
||||
import { LabelEditor } from "./label-editor";
|
||||
import { MutationError } from "./mutation-error";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { Label } from "@/components/ui/label";
|
||||
|
||||
type LabelInput = components["schemas"]["LabelInput"];
|
||||
|
||||
/** Create form for a labelled record (term/authority): single-language label +
|
||||
* optional external URI, with required-label validation and a status-aware error.
|
||||
* `onCreate` performs the mutation and is handed a `reset` to clear the inputs on success. */
|
||||
export function LabelledRecordCreateForm({
|
||||
heading,
|
||||
submitLabel,
|
||||
pending,
|
||||
error,
|
||||
onCreate,
|
||||
}: {
|
||||
heading: ReactNode;
|
||||
submitLabel: string;
|
||||
pending: boolean;
|
||||
error: unknown;
|
||||
onCreate: (labels: LabelInput[], uri: string | null, reset: () => void) => void;
|
||||
}) {
|
||||
const { t } = useTranslation();
|
||||
const uriId = useId();
|
||||
|
||||
const [labels, setLabels] = useState<LabelInput[]>([]);
|
||||
const [uri, setUri] = useState("");
|
||||
const [requiredError, setRequiredError] = useState(false);
|
||||
|
||||
const onSubmit = (event: FormEvent) => {
|
||||
event.preventDefault();
|
||||
|
||||
if (!labels.some((l) => l.label)) {
|
||||
setRequiredError(true);
|
||||
return;
|
||||
}
|
||||
|
||||
setRequiredError(false);
|
||||
onCreate(labels, uri.trim() || null, () => {
|
||||
setLabels([]);
|
||||
setUri("");
|
||||
});
|
||||
};
|
||||
|
||||
return (
|
||||
<form onSubmit={onSubmit} className="space-y-2 border-t pt-3">
|
||||
<div className="text-sm font-medium">{heading}</div>
|
||||
<LabelEditor value={labels} onChange={setLabels} />
|
||||
<div className="space-y-1">
|
||||
<Label htmlFor={uriId}>{t("labels.externalUri")}</Label>
|
||||
<Input
|
||||
id={uriId}
|
||||
type="url"
|
||||
placeholder={t("labels.uriPlaceholder")}
|
||||
value={uri}
|
||||
onChange={(e) => setUri(e.target.value)}
|
||||
/>
|
||||
</div>
|
||||
{requiredError && (
|
||||
<p role="alert" className="text-xs text-destructive">
|
||||
{t("form.required")}
|
||||
</p>
|
||||
)}
|
||||
<MutationError error={error} />
|
||||
<Button type="submit" size="sm" disabled={pending}>
|
||||
{submitLabel}
|
||||
</Button>
|
||||
</form>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Create `web/src/components/labelled-record-create-form.test.tsx`** (write + run):
|
||||
```tsx
|
||||
import { expect, test, vi } from "vitest";
|
||||
import { screen } from "@testing-library/react";
|
||||
import userEvent from "@testing-library/user-event";
|
||||
|
||||
import { renderApp } from "../test/render";
|
||||
import { LabelledRecordCreateForm } from "./labelled-record-create-form";
|
||||
|
||||
test("submitting with empty labels shows the required error and does not call onCreate", async () => {
|
||||
const onCreate = vi.fn();
|
||||
renderApp(
|
||||
<LabelledRecordCreateForm heading="New" submitLabel="Create" pending={false} error={null} onCreate={onCreate} />,
|
||||
);
|
||||
await userEvent.click(screen.getByRole("button", { name: /create/i }));
|
||||
expect(screen.getByRole("alert")).toBeInTheDocument(); // form.required (MutationError is null → no alert)
|
||||
expect(onCreate).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
test("a valid submit calls onCreate and the reset clears the inputs", async () => {
|
||||
const onCreate = vi.fn((_labels: unknown, _uri: unknown, reset: () => void) => reset());
|
||||
renderApp(
|
||||
<LabelledRecordCreateForm heading="New" submitLabel="Create" pending={false} error={null} onCreate={onCreate} />,
|
||||
);
|
||||
const labelInput = screen.getByLabelText(/^label$/i) as HTMLInputElement;
|
||||
await userEvent.type(labelInput, "Bronze");
|
||||
await userEvent.click(screen.getByRole("button", { name: /create/i }));
|
||||
expect(onCreate).toHaveBeenCalled();
|
||||
expect((screen.getByLabelText(/^label$/i) as HTMLInputElement).value).toBe("");
|
||||
});
|
||||
```
|
||||
Run: `cd web && pnpm vitest run src/components/labelled-record-create-form.test.tsx`. (The required-error `<p role="alert">` is the only alert when `error={null}`; `LabelEditor`'s label is "Label".)
|
||||
|
||||
- [ ] **Step 3: Verify + lint:** `cd web && pnpm vitest run src/components/labelled-record-create-form.test.tsx && pnpm typecheck && pnpm lint`.
|
||||
|
||||
- [ ] **Step 4: Commit**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git add web/src/components/labelled-record-create-form.tsx web/src/components/labelled-record-create-form.test.tsx
|
||||
git commit -m "feat(web): shared LabelledRecordCreateForm component (#64)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Task 3: `FilteredRecordList<T>`
|
||||
|
||||
**Files:** Create `web/src/components/filtered-record-list.tsx`, `web/src/components/filtered-record-list.test.tsx`.
|
||||
|
||||
- [ ] **Step 1: Create `web/src/components/filtered-record-list.tsx`:**
|
||||
```tsx
|
||||
import { Fragment, useState, type ReactNode } from "react";
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import type { components } from "../api/schema";
|
||||
import { byLabel } from "../lib/sort";
|
||||
import { labelText } from "../lib/labels";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { ListSkeleton } from "@/components/ui/skeletons";
|
||||
|
||||
type LabelView = components["schemas"]["LabelView"];
|
||||
|
||||
/** Filterable, alphabetically-sorted list of labelled records with the standard
|
||||
* loading / error / empty / no-matches states. The filter input stays visible
|
||||
* during load (matching the prior page behaviour). */
|
||||
export function FilteredRecordList<T extends { id: string; labels: LabelView[] }>({
|
||||
records,
|
||||
lang,
|
||||
isLoading,
|
||||
isError,
|
||||
loadErrorText,
|
||||
emptyText,
|
||||
renderRow,
|
||||
}: {
|
||||
records: T[] | undefined;
|
||||
lang: string;
|
||||
isLoading: boolean;
|
||||
isError: boolean;
|
||||
loadErrorText: string;
|
||||
emptyText: string;
|
||||
renderRow: (record: T) => ReactNode;
|
||||
}) {
|
||||
const { t } = useTranslation();
|
||||
const [filter, setFilter] = useState("");
|
||||
|
||||
const q = filter.trim().toLowerCase();
|
||||
const rows = [...(records ?? [])]
|
||||
.filter((r) => !q || labelText(r.labels, lang).toLowerCase().includes(q))
|
||||
.sort(byLabel(lang));
|
||||
|
||||
return (
|
||||
<>
|
||||
<div className="mb-3">
|
||||
<Input
|
||||
aria-label={t("common.filter")}
|
||||
placeholder={t("common.filter")}
|
||||
value={filter}
|
||||
onChange={(e) => setFilter(e.target.value)}
|
||||
/>
|
||||
</div>
|
||||
{isLoading ? (
|
||||
<ListSkeleton className="mb-4" rows={5} />
|
||||
) : (
|
||||
<ul className="mb-4">
|
||||
{isError && <li className="text-sm text-destructive">{loadErrorText}</li>}
|
||||
{!isError && records?.length === 0 && (
|
||||
<li className="text-sm text-muted-foreground">{emptyText}</li>
|
||||
)}
|
||||
{!isError && records && records.length > 0 && rows.length === 0 && (
|
||||
<li className="text-sm text-muted-foreground">{t("common.noMatches")}</li>
|
||||
)}
|
||||
{rows.map((r) => (
|
||||
<Fragment key={r.id}>{renderRow(r)}</Fragment>
|
||||
))}
|
||||
</ul>
|
||||
)}
|
||||
</>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Create `web/src/components/filtered-record-list.test.tsx`** (write + run):
|
||||
```tsx
|
||||
import { expect, test } from "vitest";
|
||||
import { screen } from "@testing-library/react";
|
||||
import userEvent from "@testing-library/user-event";
|
||||
|
||||
import { renderApp } from "../test/render";
|
||||
import { FilteredRecordList } from "./filtered-record-list";
|
||||
import { labelText } from "../lib/labels";
|
||||
|
||||
type Rec = { id: string; labels: { lang: string; label: string }[] };
|
||||
const recs: Rec[] = [
|
||||
{ id: "a", labels: [{ lang: "en", label: "Alpha" }] },
|
||||
{ id: "b", labels: [{ lang: "en", label: "Beta" }] },
|
||||
];
|
||||
const row = (r: Rec) => <li>{labelText(r.labels, "en")}</li>;
|
||||
|
||||
test("filtering narrows the rendered rows", async () => {
|
||||
renderApp(
|
||||
<FilteredRecordList records={recs} lang="en" isLoading={false} isError={false}
|
||||
loadErrorText="LoadErr" emptyText="EmptyMsg" renderRow={row} />,
|
||||
);
|
||||
expect(screen.getByText("Alpha")).toBeInTheDocument();
|
||||
expect(screen.getByText("Beta")).toBeInTheDocument();
|
||||
await userEvent.type(screen.getByLabelText(/filter/i), "alph");
|
||||
expect(screen.getByText("Alpha")).toBeInTheDocument();
|
||||
expect(screen.queryByText("Beta")).toBeNull();
|
||||
});
|
||||
|
||||
test("empty records show the empty text", () => {
|
||||
renderApp(
|
||||
<FilteredRecordList records={[]} lang="en" isLoading={false} isError={false}
|
||||
loadErrorText="LoadErr" emptyText="EmptyMsg" renderRow={row} />,
|
||||
);
|
||||
expect(screen.getByText("EmptyMsg")).toBeInTheDocument();
|
||||
});
|
||||
|
||||
test("non-empty records with a non-matching filter show no-matches", async () => {
|
||||
renderApp(
|
||||
<FilteredRecordList records={recs} lang="en" isLoading={false} isError={false}
|
||||
loadErrorText="LoadErr" emptyText="EmptyMsg" renderRow={row} />,
|
||||
);
|
||||
await userEvent.type(screen.getByLabelText(/filter/i), "zzz");
|
||||
expect(screen.getByText(/no matches/i)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
test("an error shows the load-error text", () => {
|
||||
renderApp(
|
||||
<FilteredRecordList records={undefined} lang="en" isLoading={false} isError={true}
|
||||
loadErrorText="LoadErr" emptyText="EmptyMsg" renderRow={row} />,
|
||||
);
|
||||
expect(screen.getByText("LoadErr")).toBeInTheDocument();
|
||||
});
|
||||
```
|
||||
Run: `cd web && pnpm vitest run src/components/filtered-record-list.test.tsx`.
|
||||
|
||||
- [ ] **Step 3: Verify + lint:** `cd web && pnpm vitest run src/components/filtered-record-list.test.tsx && pnpm typecheck && pnpm lint`.
|
||||
|
||||
- [ ] **Step 4: Commit**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git add web/src/components/filtered-record-list.tsx web/src/components/filtered-record-list.test.tsx
|
||||
git commit -m "feat(web): shared FilteredRecordList component (#64)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Task 4: Wire the adapters + pages, then full gate
|
||||
|
||||
**Files:** Modify `web/src/vocab/term-row.tsx`, `web/src/authorities/authority-row.tsx`, `web/src/authorities/authorities-page.tsx`, `web/src/vocab/vocabulary-terms.tsx`.
|
||||
|
||||
- [ ] **Step 1: Rewrite `web/src/vocab/term-row.tsx`** (keep the `<TermRow vocabularyId term lang />` API):
|
||||
```tsx
|
||||
import type { components } from "../api/schema";
|
||||
import { useUpdateTerm, useDeleteTerm } from "../api/queries";
|
||||
import { LabelledRecordRow } from "../components/labelled-record-row";
|
||||
|
||||
type TermView = components["schemas"]["TermView"];
|
||||
|
||||
export function TermRow({ vocabularyId, term, lang }: { vocabularyId: string; term: TermView; lang: string }) {
|
||||
const update = useUpdateTerm();
|
||||
const del = useDeleteTerm();
|
||||
|
||||
return (
|
||||
<LabelledRecordRow
|
||||
record={term}
|
||||
lang={lang}
|
||||
deleteConfirmKey="actions.confirmDeleteTerm"
|
||||
savePending={update.isPending}
|
||||
saveError={update.error}
|
||||
onEditOpen={() => update.reset()}
|
||||
onSave={(labels, uri, done) =>
|
||||
update.mutate({ vocabularyId, termId: term.id, external_uri: uri, labels }, { onSuccess: done })}
|
||||
onDelete={() => del.mutateAsync({ vocabularyId, termId: term.id })}
|
||||
/>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Rewrite `web/src/authorities/authority-row.tsx`** (keep `<AuthorityRow authority kind lang />`):
|
||||
```tsx
|
||||
import type { components } from "../api/schema";
|
||||
import { useUpdateAuthority, useDeleteAuthority } from "../api/queries";
|
||||
import { LabelledRecordRow } from "../components/labelled-record-row";
|
||||
|
||||
type AuthorityView = components["schemas"]["AuthorityView"];
|
||||
|
||||
export function AuthorityRow({ authority, kind, lang }: { authority: AuthorityView; kind: string; lang: string }) {
|
||||
const update = useUpdateAuthority();
|
||||
const del = useDeleteAuthority();
|
||||
|
||||
return (
|
||||
<LabelledRecordRow
|
||||
record={authority}
|
||||
lang={lang}
|
||||
deleteConfirmKey="actions.confirmDeleteAuthority"
|
||||
savePending={update.isPending}
|
||||
saveError={update.error}
|
||||
onEditOpen={() => update.reset()}
|
||||
onSave={(labels, uri, done) =>
|
||||
update.mutate({ id: authority.id, kind, external_uri: uri, labels }, { onSuccess: done })}
|
||||
onDelete={() => del.mutateAsync({ id: authority.id, kind })}
|
||||
/>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Rewrite `web/src/authorities/authorities-page.tsx`** to use the shared list + form. Keep the `PageTitle`, kind `<nav>`, `Navigate` guard, `useDocumentTitle`, `useBreadcrumb`. Remove the local `labels`/`uri`/`error`/`filter` state, the `onCreate` handler, and now-unused imports (`useState`, `FormEvent`, `LabelEditor`, `MutationError`, `Input`, `Label`, `ListSkeleton`, `byLabel`, `labelText`). New file:
|
||||
```tsx
|
||||
import { NavLink, Navigate, useParams } from "react-router-dom";
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import { useAuthorities, useCreateAuthority } from "../api/queries";
|
||||
import { FilteredRecordList } from "../components/filtered-record-list";
|
||||
import { LabelledRecordCreateForm } from "../components/labelled-record-create-form";
|
||||
import { PageTitle } from "@/components/ui/page-title";
|
||||
import { AuthorityRow } from "./authority-row";
|
||||
import { focusRing } from "../lib/focus-ring";
|
||||
import { useDocumentTitle } from "../lib/use-document-title";
|
||||
import { useBreadcrumb } from "../shell/use-breadcrumb";
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
const KINDS = ["person", "organisation", "place"] as const;
|
||||
|
||||
export function AuthoritiesPage() {
|
||||
const { t, i18n } = useTranslation();
|
||||
const { kind } = useParams();
|
||||
const lang = i18n.language.startsWith("sv") ? "sv" : "en";
|
||||
|
||||
const isValidKind = (KINDS as readonly string[]).includes(kind ?? "");
|
||||
const currentKind = isValidKind ? (kind as string) : "person";
|
||||
|
||||
const { data: authorities, isLoading, isError } = useAuthorities(currentKind);
|
||||
const create = useCreateAuthority();
|
||||
|
||||
useDocumentTitle(t("nav.authorities"));
|
||||
useBreadcrumb([{ label: t("nav.authorities") }]);
|
||||
|
||||
if (!isValidKind) return <Navigate to="/authorities/person" replace />;
|
||||
|
||||
return (
|
||||
<div className="overflow-auto p-4">
|
||||
<PageTitle className="mb-3">{t("nav.authorities")}</PageTitle>
|
||||
<nav aria-label={t("nav.authorities")} className="mb-3 flex gap-2">
|
||||
{KINDS.map((k) => (
|
||||
<NavLink
|
||||
key={k}
|
||||
to={`/authorities/${k}`}
|
||||
className={({ isActive }) =>
|
||||
cn("rounded-md px-3 py-1 text-sm", focusRing, isActive ? "bg-primary text-primary-foreground" : "border")
|
||||
}
|
||||
>
|
||||
{t(`authorities.${k}`)}
|
||||
</NavLink>
|
||||
))}
|
||||
</nav>
|
||||
|
||||
<FilteredRecordList
|
||||
records={authorities}
|
||||
lang={lang}
|
||||
isLoading={isLoading}
|
||||
isError={isError}
|
||||
loadErrorText={t("authorities.loadError")}
|
||||
emptyText={t("authorities.empty")}
|
||||
renderRow={(a) => <AuthorityRow authority={a} kind={currentKind} lang={lang} />}
|
||||
/>
|
||||
|
||||
<LabelledRecordCreateForm
|
||||
heading={`${t("authorities.new")} · ${t(`authorities.${currentKind}`)}`}
|
||||
submitLabel={t("authorities.create")}
|
||||
pending={create.isPending}
|
||||
error={create.error}
|
||||
onCreate={(labels, uri, reset) =>
|
||||
create.mutate({ kind: currentKind, external_uri: uri, labels }, { onSuccess: reset })}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
(Note: the original passed `kind: kind as string` to `create.mutate`; `currentKind` is equivalent here since the `isValidKind` guard already returned otherwise — use `currentKind`.)
|
||||
|
||||
- [ ] **Step 4: Rewrite `web/src/vocab/vocabulary-terms.tsx`** to use the shared list + form. Keep the `vocab.terms` caption + breadcrumb + the `useVocabularies` lookup. Remove the local form/list state + now-unused imports:
|
||||
```tsx
|
||||
import { useParams } from "react-router-dom";
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import { useTerms, useAddTerm, useVocabularies } from "../api/queries";
|
||||
import { useBreadcrumb } from "../shell/use-breadcrumb";
|
||||
import { FilteredRecordList } from "../components/filtered-record-list";
|
||||
import { LabelledRecordCreateForm } from "../components/labelled-record-create-form";
|
||||
import { TermRow } from "./term-row";
|
||||
|
||||
export function VocabularyTerms() {
|
||||
const { t, i18n } = useTranslation();
|
||||
const { id } = useParams();
|
||||
const lang = i18n.language.startsWith("sv") ? "sv" : "en";
|
||||
|
||||
const { data: terms, isLoading, isError } = useTerms(id);
|
||||
const addTerm = useAddTerm();
|
||||
|
||||
const { data: vocabularies } = useVocabularies();
|
||||
const vocabKey = vocabularies?.find((v) => v.id === id)?.key;
|
||||
|
||||
useBreadcrumb(
|
||||
vocabKey
|
||||
? [{ label: t("nav.vocabularies"), to: "/vocabularies" }, { label: vocabKey }]
|
||||
: [{ label: t("nav.vocabularies"), to: "/vocabularies" }],
|
||||
);
|
||||
|
||||
if (!id) return null;
|
||||
|
||||
return (
|
||||
<div className="overflow-auto p-4">
|
||||
<div className="mb-2 label-caption">{t("vocab.terms")}</div>
|
||||
|
||||
<FilteredRecordList
|
||||
records={terms}
|
||||
lang={lang}
|
||||
isLoading={isLoading}
|
||||
isError={isError}
|
||||
loadErrorText={t("vocab.loadError")}
|
||||
emptyText={t("vocab.noTerms")}
|
||||
renderRow={(term) => <TermRow vocabularyId={id} term={term} lang={lang} />}
|
||||
/>
|
||||
|
||||
<LabelledRecordCreateForm
|
||||
heading={t("vocab.addTerm")}
|
||||
submitLabel={t("vocab.addTerm")}
|
||||
pending={addTerm.isPending}
|
||||
error={addTerm.error}
|
||||
onCreate={(labels, uri, reset) =>
|
||||
addTerm.mutate({ vocabularyId: id, external_uri: uri, labels }, { onSuccess: reset })}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
(Note: `useTerms(id)` and `if (!id) return null` — `id` is `string | undefined`; the hooks accept it, and the `!id` guard runs after the hooks, matching the original order. `renderRow`/`onCreate` use the narrowed `id` inside JSX where `!id` already returned — but to satisfy TS, `id` is `string` after the guard since the guard is before the `return` JSX. Confirm typecheck is clean; if TS still widens, the original already used `id` directly in the same spot, so it resolves.)
|
||||
|
||||
- [ ] **Step 5: FULL FRONTEND GATE (run tests EXACTLY ONCE):**
|
||||
```bash
|
||||
cd web && pnpm typecheck && pnpm lint && pnpm test && pnpm build && pnpm check:size && pnpm check:colors
|
||||
```
|
||||
All green. The existing `term-row.test.tsx`, `authorities.test.tsx`, `vocabularies.test.tsx` MUST pass unchanged (behavior-preserving). Report test totals, largest chunk (gz), and the `check:colors` line. If an existing test fails, the refactor changed behavior — fix the adapter/page to match, do NOT edit the test.
|
||||
|
||||
- [ ] **Step 6: Codename + status:**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git grep -in 'biggus\|dickus' -- web/src; echo "codename-exit=$?"
|
||||
git status --short
|
||||
```
|
||||
Expected: no matches (`codename-exit=1`).
|
||||
|
||||
- [ ] **Step 7: Manual smoke (recommended).** `pnpm dev`: on Authorities and Vocabulary-terms — filter narrows the list; create with an empty label shows the required error; create/edit/delete work; a failed save shows the inline message and keeps the row editable; the authorities kind-tabs + breadcrumbs are unchanged.
|
||||
|
||||
- [ ] **Step 8: Commit**
|
||||
```bash
|
||||
cd /Users/olsson/Laboratory/biggus-dickus
|
||||
git add web/src/vocab/term-row.tsx web/src/authorities/authority-row.tsx web/src/authorities/authorities-page.tsx web/src/vocab/vocabulary-terms.tsx
|
||||
git commit -m "refactor(web): term/authority rows + pages adopt shared CRUD components (#64)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Self-Review (completed)
|
||||
|
||||
**Spec coverage:** AC1 three components with the prop shapes (T1-T3); AC2 rows + pages de-duplicated (T4 S1-S4); AC3 existing tests green + 3 new component tests (T1-T3 tests, T4 S5); AC4 behavior preserved — edit/save/delete/create/validation/filter/4-states/kind-nav/breadcrumb (T4 + the existing-test guard); AC5 gate/check:size/no-new-keys/codename (T4 S5-S6). ✓
|
||||
|
||||
**Placeholder scan:** every component + adapter shown in full; tests have concrete assertions; the two soft spots (delete-dialog portal DOM in T1; `id` narrowing in T4) name the exact mitigation/precedent. No TBD. ✓
|
||||
|
||||
**Type/consistency:** `RecordLike = { id; labels: LabelView[]; external_uri }` (T1) is the row's `record`; `TermView`/`AuthorityView` structurally satisfy it (both have those fields). `onSave(labels: LabelInput[], uri: string | null, done)` (T1) matches the adapters' `update.mutate({…, external_uri: uri, labels}, { onSuccess: done })` (T4). `LabelledRecordCreateForm.onCreate(labels, uri, reset)` (T2) matches `create.mutate({…}, { onSuccess: reset })` (T4). `FilteredRecordList<T extends { id; labels: LabelView[] }>` (T3) consumed with `authorities`/`terms` (T4). ✓
|
||||
|
||||
## Notes
|
||||
- No new dependency, no new i18n keys, `components/ui/*` untouched. Net code reduction → `check:size` should not grow.
|
||||
- `TermRow`/`AuthorityRow` keep their public props so `term-row.test.tsx` stays valid unchanged.
|
||||
- `vocabulary-list.tsx` (key-based vocabularies) is deliberately NOT touched.
|
||||
@@ -0,0 +1,163 @@
|
||||
# Accessibility Defect Bundle — Design
|
||||
|
||||
**Date:** 2026-06-08
|
||||
**Status:** Approved (brainstorming) — ready for implementation planning.
|
||||
**Issue:** #62 (label-id collision, invalid table row semantics, unnamed drawer, unannounced table states, last untranslated strings).
|
||||
|
||||
## Context
|
||||
|
||||
A frontend deep audit (post the #52 a11y pass, which is verified correct) found five remaining
|
||||
accessibility gaps. They are independent, low-risk fixes; no new dependency. The #52 work (focus ring,
|
||||
skip link, route focus, authority nav links, lang group, `<html lang>` sync) stays untouched.
|
||||
|
||||
## Components
|
||||
|
||||
### 1. `components/label-editor.tsx` — id collision → `useId()`
|
||||
`LabelEditor` hardcodes `<Label htmlFor="label">` + `<Input id="label">` (`:35-36`). It renders
|
||||
simultaneously in the create form **and** any inline-edit row (authorities + vocab), so two `id="label"`
|
||||
inputs coexist and every `<label for="label">` resolves to the first — the second editor's label points
|
||||
at the wrong field (WCAG 1.3.1 / 4.1.1 / 4.1.2). Fix with React's `useId()` (zero call-site changes):
|
||||
```tsx
|
||||
import { useId } from "react";
|
||||
// …
|
||||
const inputId = useId();
|
||||
<Label htmlFor={inputId}>{t("labels.label")}</Label>
|
||||
<Input id={inputId} value={current} onChange={(e) => set(e.target.value)} />
|
||||
```
|
||||
|
||||
### 2. `objects/objects-table.tsx` — rows: real link + `aria-current`
|
||||
The data rows are `<tr role="link" tabIndex={0} aria-selected={selected} onClick onKeyDown>` (`:247-259`).
|
||||
`aria-selected` is invalid on `role="link"` (AT ignores it). Decision (brainstorming): make the
|
||||
object-**number** cell a real React Router `<Link>` and keep the whole row clickable. The `<tr>` becomes a
|
||||
plain row:
|
||||
```tsx
|
||||
<tr
|
||||
key={object.id}
|
||||
onClick={() => navigate(`/objects/${object.id}?${params}`)}
|
||||
className={`cursor-pointer border-b text-sm ${selected ? "bg-primary/10" : "hover:bg-muted"}`}
|
||||
>
|
||||
<td className="px-3 py-2 text-muted-foreground">
|
||||
<Link
|
||||
to={`/objects/${object.id}?${params}`}
|
||||
aria-current={selected ? "page" : undefined}
|
||||
onClick={(event) => event.stopPropagation()}
|
||||
className={`${focusRing} rounded-sm hover:underline`}
|
||||
>
|
||||
{object.object_number}
|
||||
</Link>
|
||||
</td>
|
||||
{/* …other cells unchanged… */}
|
||||
</tr>
|
||||
```
|
||||
- Native anchor ⇒ keyboard focus + Enter activation + SR "link" + middle-click / open-in-new-tab, all free.
|
||||
- `event.stopPropagation()` on the link prevents the row `onClick` from double-navigating when the link
|
||||
itself is clicked.
|
||||
- The whole-row `onClick` stays, so clicking any non-link cell still opens the object (preserves current
|
||||
UX; the existing "clicking a row …" test clicks the object-**name** cell and still passes).
|
||||
- Selection is conveyed by `aria-current="page"` on the link (announced when focused); the visual
|
||||
highlight stays on the `<tr>` via the className.
|
||||
- Drop `role="link"`, `tabIndex`, `onKeyDown`, and `aria-selected` from the `<tr>`.
|
||||
|
||||
### 2b. `objects/objects-table.tsx` — filter pills: restore `focusRing`
|
||||
The visibility pills (`:168-177`) lack the keyboard focus ring their siblings (`search-panel`,
|
||||
`authorities-page`) have. Import `focusRing` from `../lib/focus-ring` and append it to the pill className:
|
||||
```tsx
|
||||
className={`${focusRing} rounded-md px-2 py-1 ${active ? "bg-primary text-primary-foreground" : "border"}`}
|
||||
```
|
||||
|
||||
### 3. `objects/objects-table.tsx` — announce loading / error
|
||||
Loading renders bare `<Skeleton>` rows and the error a plain `<td>` — neither is announced (WCAG 4.1.3).
|
||||
- Add `aria-busy={isLoading || undefined}` to the `<table>`.
|
||||
- Add an `sr-only` live `<caption>` that announces loading and settles to the table name (also gives the
|
||||
table an accessible name):
|
||||
```tsx
|
||||
<table className="w-full border-collapse" aria-busy={isLoading || undefined}>
|
||||
<caption className="sr-only" aria-live="polite">
|
||||
{isLoading ? t("common.loading") : t("objects.tableLabel")}
|
||||
</caption>
|
||||
{columns}
|
||||
{body}
|
||||
</table>
|
||||
```
|
||||
- Add `role="alert"` to the error `<td>` (`:223`) so a load failure is announced assertively:
|
||||
```tsx
|
||||
<td colSpan={6} role="alert" className="px-3 py-6 text-center text-sm text-destructive">
|
||||
{t("objects.loadError")}
|
||||
</td>
|
||||
```
|
||||
|
||||
### 4. `objects/object-detail-drawer.tsx` — name the drawer dialog
|
||||
The Base UI drawer (a modal dialog) has no accessible name. `DrawerContent` spreads props onto the Popup,
|
||||
so pass an `aria-label`:
|
||||
```tsx
|
||||
<DrawerContent aria-label={t("objects.detailTitle")}>
|
||||
```
|
||||
(No change to `components/ui/drawer.tsx`.)
|
||||
|
||||
### 5. Last untranslated strings
|
||||
- `objects/options-combobox.tsx` (`:47-52`): add `import { useTranslation } from "react-i18next";` +
|
||||
`const { t } = useTranslation();`, then `aria-label={t("common.clear")}` on `ComboboxClear`,
|
||||
`aria-label={t("common.open")}` on `ComboboxTrigger`, and `<ComboboxEmpty>{t("common.noMatches")}</ComboboxEmpty>`
|
||||
(`common.noMatches` already exists).
|
||||
- `shell/breadcrumb.tsx` (`:10`): add `useTranslation`; `<nav aria-label={t("nav.breadcrumb")}>`.
|
||||
|
||||
### i18n (en + sv parity — 5 new keys)
|
||||
`common.noMatches` and `common.loading` already exist. New keys:
|
||||
| key | en | sv |
|
||||
|-----|----|----|
|
||||
| `common.clear` | Clear | Rensa |
|
||||
| `common.open` | Open | Öppna |
|
||||
| `nav.breadcrumb` | Breadcrumb | Brödsmulor |
|
||||
| `objects.detailTitle` | Object detail | Objektdetalj |
|
||||
| `objects.tableLabel` | Objects | Objekt |
|
||||
|
||||
## Data flow / accessibility
|
||||
No data-flow changes. Tab order in the objects table becomes: filter input → visibility pills (now with
|
||||
ring) → New button → each row's object-number link → pagination. The selected row's link carries
|
||||
`aria-current="page"`. Loading politely announces via the caption; a load error asserts via the alert
|
||||
cell. The drawer and breadcrumb gain accessible names; every combobox control is named in the active
|
||||
locale.
|
||||
|
||||
## Error handling / edges
|
||||
- `aria-busy={isLoading || undefined}` omits the attribute when not loading (no `aria-busy="false"` noise).
|
||||
- `event.stopPropagation()` on the row link means a plain click on the number navigates once (link), not
|
||||
twice; modifier/middle clicks open a new tab natively (React Router `<Link>` respects them).
|
||||
- `aria-current` is omitted (not `"false"`) when the row isn't selected.
|
||||
- The `<caption>` is `sr-only` — no visual change to the table.
|
||||
- `useId()` ids are SSR/StrictMode stable and unique per instance.
|
||||
|
||||
## Testing
|
||||
- **`label-editor`**: render two `LabelEditor`s together; assert their inputs have **different** ids and
|
||||
each `<label>` is associated with its own input (e.g. `getAllByLabelText` returns two distinct nodes).
|
||||
- **`objects-table`**: (a) a data row exposes a `link` named by the object number
|
||||
(`getByRole("link", { name: <object_number> })`); (b) the row matching the selected `:id` has the link
|
||||
with `aria-current="page"`; (c) clicking a row still deep-links (existing test stays green); (d) the
|
||||
loading state sets `aria-busy` on the table; (e) an errored fetch renders `role="alert"`. Update any
|
||||
existing assertion that referenced `aria-selected`/the row as a link.
|
||||
- **`options-combobox`**: the clear/open controls are named via `t()` and the empty text is translated
|
||||
(assert the English defaults render; the parity test guards sv).
|
||||
- **`breadcrumb`**: the `<nav>` accessible name comes from `t("nav.breadcrumb")`.
|
||||
- **`object-detail-drawer`**: the open drawer dialog has an accessible name (`getByRole("dialog", { name })`
|
||||
or equivalent for the Base UI popup).
|
||||
- **Gate:** `typecheck`/`lint`/`test`/`build`/`check:size`/`check:colors` green; en/sv parity (5 new keys,
|
||||
guarded by the #60 parity test); no codename; no new dependency. `focusRing` is token-based so
|
||||
`check:colors` stays green.
|
||||
|
||||
## Acceptance criteria
|
||||
1. `LabelEditor` uses `useId()`; two instances never share an input id.
|
||||
2. Objects-table data rows expose a real `<Link>` (object-number cell) with `aria-current="page"` on the
|
||||
selected row; no `role="link"`/`aria-selected` on the `<tr>`; whole-row click still navigates; the
|
||||
filter pills show the keyboard focus ring.
|
||||
3. The table sets `aria-busy` while loading and exposes a polite live caption; a load error renders
|
||||
`role="alert"`.
|
||||
4. The object-detail drawer dialog and the breadcrumb `<nav>` have accessible names; the combobox
|
||||
clear/open/empty strings are translated.
|
||||
5. `typecheck`/`lint`/`test`/`build`/`check:colors` green; `check:size` reported; en/sv parity (5 new
|
||||
keys); no codename; no new dependency.
|
||||
|
||||
## Out of scope → follow-ups
|
||||
- The combobox wrapper's raw palette utilities (`text-neutral-*`, `bg-indigo-50`, `bg-white`) inside
|
||||
`components/ui/combobox.tsx`, and the segmented-control extraction → design-kit issue **#66**.
|
||||
- A full ARIA grid for the objects table (sortable/selectable grid semantics) — the navigation-table +
|
||||
real-link pattern is the correct, simpler choice here.
|
||||
- Automated axe/CI a11y scanning.
|
||||
@@ -0,0 +1,122 @@
|
||||
# Design-Kit Consistency — Design
|
||||
|
||||
**Date:** 2026-06-08
|
||||
**Status:** Approved (brainstorming) — ready for implementation planning.
|
||||
**Issue:** #66 (dead Card, duplicated segmented-control + selected-row recipes, `useLang`/`focusRing` drift, misc kit one-offs).
|
||||
|
||||
## Context
|
||||
|
||||
A frontend deep audit found subtler design-system inconsistencies the `check:colors` guard doesn't catch
|
||||
(the app is already hex-free + token-based + dark-mode-clean). These are duplicated class recipes and
|
||||
non-adoption of the `ui/*` kit. All fixes are behavior-preserving; `check:colors`/`check:size`/the existing
|
||||
component tests are the guards. State re-verified against the current code (post #62/#64).
|
||||
|
||||
## Components
|
||||
|
||||
### New shared helpers
|
||||
|
||||
**`lib/use-lang.ts`** — `useLang(): "sv" | "en"`
|
||||
```ts
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
/** The instance's active UI language, narrowed to the two supported locales. */
|
||||
export function useLang(): "sv" | "en" {
|
||||
const { i18n } = useTranslation();
|
||||
return i18n.language.startsWith("sv") ? "sv" : "en";
|
||||
}
|
||||
```
|
||||
Replaces the inline `const lang = i18n.language.startsWith("sv") ? "sv" : "en";` in **6** components:
|
||||
`objects/object-detail.tsx`, `objects/field-input.tsx`, `vocab/vocabulary-terms.tsx`,
|
||||
`vocab/vocabulary-list.tsx`, `fields/field-list.tsx`, `authorities/authorities-page.tsx`. Each switches to
|
||||
`const lang = useLang();` and drops the now-unused `i18n` from its `useTranslation()` destructure where
|
||||
`i18n` is otherwise unused. (Left untouched: `shell/lang-switch.tsx` — derives from a different `locale`
|
||||
var; `i18n/index.ts` — the infra `languageChanged` handler.)
|
||||
|
||||
**`lib/class-recipes.ts`** — two shared class helpers
|
||||
```ts
|
||||
import { cn } from "@/lib/utils";
|
||||
import { focusRing } from "./focus-ring";
|
||||
|
||||
/** Segmented-control / filter-pill item. Unifies the active/inactive token recipe +
|
||||
* focus ring; callers pass their contextual padding/size via `className`. */
|
||||
export function segmentClass(active: boolean, className?: string): string {
|
||||
return cn("rounded-md", focusRing, active ? "bg-primary text-primary-foreground" : "border", className);
|
||||
}
|
||||
|
||||
/** Selected vs idle row background for master-detail / list rows. */
|
||||
export function rowStateClass(active: boolean): string {
|
||||
return active ? "bg-primary/10" : "hover:bg-muted";
|
||||
}
|
||||
```
|
||||
- **`segmentClass`** is adopted at the 3 segmented sites, each keeping its contextual padding:
|
||||
- `objects/objects-table.tsx:174` → `segmentClass(active, "px-2 py-1")`
|
||||
- `search/search-panel.tsx:76` → `segmentClass(active, "px-2 py-0.5")`
|
||||
- `authorities/authorities-page.tsx:41` (NavLink) → `segmentClass(isActive, "px-3 py-1 text-sm")`
|
||||
This DRYs the bug-prone recipe (the active/inactive token pair + `focusRing` — the part that drifted and
|
||||
caused the #62 missing-ring bug); contextual sizing is intentionally preserved per site.
|
||||
- **`rowStateClass`** is adopted at the 4 selected-row sites:
|
||||
- `objects/objects-table.tsx:252` → `rowStateClass(selected)`
|
||||
- `vocab/vocabulary-list.tsx:113` → `rowStateClass(isActive)`
|
||||
- `search/search-result-row.tsx:15` → `rowStateClass(isActive)`
|
||||
- `fields/field-list.tsx:86` → `rowStateClass(def.key === selectedKey)` — **fixes** this site, which
|
||||
currently uses `… ? "bg-primary/10" : ""` (dropping the `hover:bg-muted` idle hover the others have).
|
||||
|
||||
### One-off cleanups
|
||||
- **Delete `components/ui/card.tsx`** — zero importers (no app/test/story references; no `card.stories`).
|
||||
- **`shell/sidebar.tsx:46,88`** — replace the raw `focus-visible:ring-3 focus-visible:ring-ring/50`
|
||||
string (inside the existing `cn(...)`) with the imported `focusRing` constant (adds `outline-none`,
|
||||
matching every other call site).
|
||||
- **`auth/login-page.tsx:49`** — `<h1 className="text-2xl font-semibold">{app_name}</h1>` →
|
||||
`<PageTitle>{app_name}</PageTitle>` (`PageTitle` is `text-2xl font-semibold tracking-tight`, restoring
|
||||
the missing `tracking-tight`). Import `PageTitle` from `@/components/ui/page-title`.
|
||||
- **`fields/field-list.tsx:97`** — the hand-rolled type-tag `<span className="rounded-md bg-muted px-1.5
|
||||
py-0.5 text-xs text-muted-foreground">` → `<Badge variant="secondary">` (from `@/components/ui/badge`).
|
||||
- **Icon sizing** — `h-4 w-4` → `size-4` in the 3 **app-source** sites: `shell/theme-switch.tsx:39`,
|
||||
`shell/user-menu.tsx:27`, `shell/header-search.tsx:23`. (Leave `components/ui/select.tsx` — kit-internal.)
|
||||
- **Icon dismiss buttons** → kit `Button variant="ghost" size="icon-sm"`:
|
||||
- `objects/objects-page.tsx:54` (plain `<button onClick={closeDetail} aria-label={…}>`) → `<Button
|
||||
variant="ghost" size="icon-sm" onClick={closeDetail} aria-label={t("actions.closeDetail")}><X
|
||||
className="size-4" aria-hidden="true" /></Button>` (import `Button`).
|
||||
- `objects/object-detail-drawer.tsx:33` (Base UI `<DrawerClose>`) → keep `DrawerClose` for its
|
||||
close-on-click semantics, render it AS the kit Button via the render prop:
|
||||
`<DrawerClose aria-label={t("actions.closeDetail")} render={<Button variant="ghost" size="icon-sm" />}><X
|
||||
className="size-4" aria-hidden="true" /></DrawerClose>` (mirrors the `AlertDialogTrigger render={<Button/>}`
|
||||
pattern in `delete-confirm-dialog.tsx`; import `Button`).
|
||||
|
||||
## Error handling / edges
|
||||
- `segmentClass`/`rowStateClass` are pure string builders — no runtime concerns. `cn()` (tailwind-merge)
|
||||
resolves any padding/utility overlap predictably.
|
||||
- `<Badge variant="secondary">` shifts the type-tag from `bg-muted`/`text-muted-foreground` to the
|
||||
`secondary` token pair — a deliberate, minor visual adoption of the kit; still token-based (check:colors
|
||||
clean).
|
||||
- The drawer `DrawerClose render={<Button/>}` keeps Base UI's close behaviour (Base UI merges its props
|
||||
onto the rendered Button); the `aria-label` stays on `DrawerClose`.
|
||||
- `useLang` returns the same `"sv" | "en"` the inline code produced — no behaviour change.
|
||||
|
||||
## Testing
|
||||
- **`lib/class-recipes.test.ts`** (new): `segmentClass(true)` contains `bg-primary` + `text-primary-foreground`
|
||||
and the focus-ring utility; `segmentClass(false)` contains `border` (not `bg-primary`); both contain a
|
||||
passed `className`; `rowStateClass(true)` === `"bg-primary/10"`, `rowStateClass(false)` === `"hover:bg-muted"`.
|
||||
- **Behavior guard:** the existing component tests must stay green unchanged — `objects-table.test.tsx`,
|
||||
`authorities.test.tsx`, `vocabularies.test.tsx`, `field-list` / `search` tests, `login-page.test.tsx`,
|
||||
`breadcrumb`/sidebar, `object-detail`/drawer, `user-menu.test.tsx`. (The login `PageTitle` still renders an
|
||||
`<h1>`; the icon buttons keep their `aria-label`s; the drawer close still closes.)
|
||||
- **Gate:** `typecheck`/`lint`/`test`/`build`/`check:size`/`check:colors` green; no new dependency; no new
|
||||
i18n keys; no codename. `check:size` unchanged-or-smaller (Card deletion removes dead code).
|
||||
|
||||
## Acceptance criteria
|
||||
1. `useLang()` exists and replaces the inline lang derivation in the 6 listed components; `lang-switch` and
|
||||
`i18n/index.ts` are untouched.
|
||||
2. `segmentClass`/`rowStateClass` exist (unit-tested) and are adopted at the 3 segmented + 4 selected-row
|
||||
sites; `field-list`'s selected row gains the `hover:bg-muted` idle hover.
|
||||
3. `components/ui/card.tsx` is deleted (no remaining references).
|
||||
4. The one-offs are applied: sidebar uses `focusRing`; login uses `PageTitle`; field-list type-tag uses
|
||||
`Badge`; the 3 app-source icons use `size-4`; both icon dismiss buttons use `Button variant="ghost"
|
||||
size="icon-sm"`.
|
||||
5. All existing tests pass unchanged; `typecheck`/`lint`/`build`/`check:colors` green; `check:size`
|
||||
unchanged-or-smaller; no new dependency; no new i18n keys; no codename.
|
||||
|
||||
## Out of scope → follow-ups
|
||||
- A full `<SegmentedControl>`/`<ToggleGroup>` component (the button-vs-NavLink interaction split makes a
|
||||
class helper the better fit); the form `space-y-*` scale (too subjective — churn risk).
|
||||
- Standardizing icon sizing inside `components/ui/*` (kit-internal style, separate from app-source).
|
||||
@@ -0,0 +1,213 @@
|
||||
# Consistent, Status-Aware Mutation Error Feedback — Design
|
||||
|
||||
**Date:** 2026-06-08
|
||||
**Status:** Approved (brainstorming) — ready for implementation planning.
|
||||
**Issue:** #63 (silent update failures + dead/unreachable mutation error strings).
|
||||
|
||||
## Context
|
||||
|
||||
A frontend deep audit flagged the TanStack Query mutation layer for inconsistent error feedback.
|
||||
Grounding in the code refined the picture:
|
||||
|
||||
- **The update mutations are not silent — they're inconsistent.** `useUpdateTerm` (`queries.ts:444`) and
|
||||
`useUpdateAuthority` (`:521`) are the **only 2 of 18 mutations** without `meta.suppressErrorToast`, so on
|
||||
failure they fire the global `MutationCache` error toast while the row stays in edit mode. The matching
|
||||
**create** and **delete** actions on the same screens suppress the toast and show an **inline** message
|
||||
instead. So within one screen, create-failure → inline, delete-failure → inline, edit-failure → a
|
||||
disconnected global toast.
|
||||
- **Once the 2 update mutations also suppress (the consistency fix), all 18 mutations suppress** → the
|
||||
global error toast becomes vestigial. Therefore status differentiation only delivers value at the
|
||||
**inline** error sites, which today all render a generic `t("form.rejected")` ("Could not be saved").
|
||||
- **The generic error strings are dead.** 16 mutations `throw new Error("update failed" | …)`, but
|
||||
`mutationErrorMessage` (`query-client.ts:11-23`) never reads `.message` — it falls back to
|
||||
`t("toast.error")`. The bespoke strings are unreachable.
|
||||
- **`object-edit-form` mislabels a fetch failure.** `objects/object-edit-form.tsx:17` destructures only
|
||||
`{ data, isLoading }` from `useObject`; a non-404 fetch error (network/500) falls through to the
|
||||
"object not found" branch. (The **submit** path already handles `FieldRejection` and a generic else
|
||||
correctly.)
|
||||
|
||||
### Decisions (from brainstorming)
|
||||
1. Differentiate errors **by HTTP status**, surfaced via one shared mapping.
|
||||
2. Because all mutations suppress the toast, apply status-aware messages at **all inline error sites**
|
||||
(via one shared `<MutationError>` component), not the (now-vestigial) toast. Half-applying would
|
||||
create a new inline inconsistency.
|
||||
3. Make `useUpdateTerm`/`useUpdateAuthority` consistent with their create/delete siblings (suppress +
|
||||
inline).
|
||||
4. Fix the `object-edit-form` fetch mislabel.
|
||||
|
||||
## Components
|
||||
|
||||
### `web/src/api/error-message.ts` (new) — single source of truth
|
||||
```ts
|
||||
import { HttpError, InUseError } from "./queries";
|
||||
|
||||
/** Maps a caught mutation error to an i18n key (+ interpolation opts). Used by
|
||||
* both the global toast fallback and every inline error display. */
|
||||
export function errorMessageKey(error: unknown): { key: string; opts?: Record<string, unknown> } {
|
||||
if (error instanceof InUseError) return { key: "actions.inUse", opts: { count: error.count } };
|
||||
if (error instanceof HttpError) return { key: statusKey(error.status) };
|
||||
return { key: "toast.error" };
|
||||
}
|
||||
|
||||
function statusKey(status: number): string {
|
||||
if (status === 403) return "errors.forbidden";
|
||||
if (status === 404) return "errors.notFound";
|
||||
if (status === 409) return "errors.conflict";
|
||||
if (status === 422) return "errors.validation";
|
||||
if (status >= 500) return "errors.server";
|
||||
return "toast.error";
|
||||
}
|
||||
```
|
||||
Returns a key+opts (not a resolved string) so callers render with their own `t` (reactive to language).
|
||||
`InUseError` is checked first so 409-with-count keeps its richer message. (No circular import:
|
||||
`queries.ts` does not import this module; `query-client.ts` imports both.)
|
||||
|
||||
### `web/src/components/mutation-error.tsx` (new) — shared inline display
|
||||
```tsx
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import { errorMessageKey } from "../api/error-message";
|
||||
|
||||
/** Renders a caught mutation error as an inline alert, or nothing when error is falsy.
|
||||
* Replaces the duplicated `<p role="alert" className="text-xs text-destructive">` markup. */
|
||||
export function MutationError({ error }: { error: unknown }) {
|
||||
const { t } = useTranslation();
|
||||
if (!error) return null;
|
||||
const { key, opts } = errorMessageKey(error);
|
||||
return (
|
||||
<p role="alert" className="text-xs text-destructive">
|
||||
{t(key, opts)}
|
||||
</p>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### `web/src/api/query-client.ts` (rewire)
|
||||
`mutationErrorMessage` becomes:
|
||||
```ts
|
||||
function mutationErrorMessage(error: unknown, meta: MutationMeta | undefined): string {
|
||||
if (meta?.errorMessage) return i18n.t(meta.errorMessage);
|
||||
const { key, opts } = errorMessageKey(error);
|
||||
return i18n.t(key, opts);
|
||||
}
|
||||
```
|
||||
This keeps the toast path as a one-source-of-truth fallback (for any future non-suppressed mutation) and
|
||||
drops the old special-cases (`InUseError` and `503 → search.unavailable` now flow through
|
||||
`errorMessageKey`; no mutation throws 503, and the search **query**'s own inline 503 handling in
|
||||
`search-panel.tsx` is untouched). Import moves from `{ HttpError, InUseError }` to `{ errorMessageKey }`.
|
||||
|
||||
### `web/src/api/queries.ts` (load-bearing errors)
|
||||
Replace the 16 **mutation** `throw new Error("…")` with `throw new HttpError(response.status)`, preserving
|
||||
the existing `InUseError` (409) and `FieldRejection` (422 on `setFields`) branches. Two POSTs
|
||||
(`useCreateObject` `:184`, `useCreateVocabulary` `:279`) destructure only `{ data, error }` — add
|
||||
`response` so the status is available. **Query** fetch errors (`:38,73,90,105,152,169,264`) and the login
|
||||
`"invalid"/"network"` mapping (`:121`) are NOT changed (they're consumed by component `isError`/login
|
||||
mapping, not the mutation toast). `useUpdateObject`'s 422 maps to the generic `errors.validation`;
|
||||
surfacing a *structured* core-field rejection there is uncertain backend behavior → out of scope.
|
||||
|
||||
### Inline-site adoption — replace generic `form.rejected` with `<MutationError>`
|
||||
- `web/src/components/delete-confirm-dialog.tsx:33-42` — the `confirm` catch currently sets
|
||||
`err instanceof InUseError ? t("actions.inUse", {count}) : t("form.rejected")`. Replace with
|
||||
`const { key, opts } = errorMessageKey(err); setMessage(t(key, opts));` — `errorMessageKey` already
|
||||
handles `InUseError`, so the dialog simplifies and a 403/404 delete now reads a specific message. (The
|
||||
dialog keeps its own `message` state because it must stay open on failure; it does not render
|
||||
`<MutationError>` directly.)
|
||||
- `web/src/authorities/authorities-page.tsx:144-148` — replace the `{create.isError && <p…>form.rejected}`
|
||||
with `<MutationError error={create.error} />`.
|
||||
- `web/src/vocab/vocabulary-terms.tsx:119-123` — `<MutationError error={addTerm.error} />`.
|
||||
- `web/src/vocab/vocabulary-list.tsx:57-61` (create) and `:109-113` (rename) — `<MutationError error={create.error} />`
|
||||
and `<MutationError error={renameVocabulary.error} />`.
|
||||
- `web/src/fields/field-form.tsx:202-204` — replace the `{failed && <p…>form.rejected}` with
|
||||
`<MutationError error={isEdit ? update.error : create.error} />`.
|
||||
- **Object create/edit:** `object-new-page.tsx` and `object-edit-form.tsx` keep the `FieldRejection`
|
||||
field-specific branch; in the non-`FieldRejection` else, replace `setError(t("form.rejected"))` with
|
||||
`const { key, opts } = errorMessageKey(e); setError(t(key, opts));` (these set a string passed to
|
||||
`ObjectForm`'s `formError` prop, so they use `errorMessageKey` directly, not `<MutationError>`).
|
||||
|
||||
### Edit-row consistency — `term-row.tsx`, `authority-row.tsx`, `queries.ts`
|
||||
- Add `suppressErrorToast: true` to `useUpdateTerm` (`:444`) and `useUpdateAuthority` (`:521`) meta.
|
||||
- In each row's edit view, render `<MutationError error={updateTerm.error} />` (resp. `updateAuthority.error`)
|
||||
below the save/cancel buttons.
|
||||
- Call `updateTerm.reset()` (resp. `updateAuthority.reset()`) inside the Edit button's `onClick` (alongside
|
||||
the existing `setLabels`/`setUri`/`setEditing`) so a stale error from a prior failed save doesn't linger
|
||||
when re-entering edit mode. On a failed save the row already stays editable (the `onSuccess`
|
||||
`setEditing(false)` doesn't fire), preserving the user's input.
|
||||
|
||||
### `web/src/objects/object-edit-form.tsx` (fetch fix)
|
||||
```tsx
|
||||
const { data: object, isLoading, isError } = useObject(id!);
|
||||
if (isLoading) return <FormSkeleton />;
|
||||
if (isError) return <p className="p-4 text-sm text-destructive">{t("objects.loadError")}</p>;
|
||||
if (!object) return <p className="p-4 text-sm text-muted-foreground">{t("objects.notFound")}</p>;
|
||||
```
|
||||
`objects.loadError` ("Could not load objects") already exists in both locales.
|
||||
|
||||
### i18n (en + sv parity — 5 new keys under `errors`)
|
||||
| key | en | sv |
|
||||
|-----|----|----|
|
||||
| `errors.forbidden` | You don't have permission to do that. | Du har inte behörighet att göra det. |
|
||||
| `errors.notFound` | That item no longer exists. | Objektet finns inte längre. |
|
||||
| `errors.conflict` | That conflicts with existing data. | Det står i konflikt med befintliga data. |
|
||||
| `errors.validation` | Some values weren't accepted. | Vissa värden godtogs inte. |
|
||||
| `errors.server` | The server had a problem. Please try again. | Servern hade ett problem. Försök igen. |
|
||||
|
||||
## Data flow
|
||||
mutation rejects → `HttpError(status)` (or `InUseError`/`FieldRejection`) → caught by the component (or
|
||||
the `MutationCache` fallback) → `errorMessageKey(error)` → `{key, opts}` → `t(key, opts)` rendered inline
|
||||
via `<MutationError>` (or as a `formError` string / dialog message). One mapping, one component, every
|
||||
surface.
|
||||
|
||||
## Error handling / edges
|
||||
- **All mutations suppress** after this change → the `MutationCache.onError` toast path is a dormant
|
||||
fallback; kept (not deleted) so a future non-suppressed mutation still gets a sensible message.
|
||||
- **401** isn't in the status map → falls to `toast.error`; the `client.ts` middleware still redirects to
|
||||
login (unchanged). A brief generic toast before redirect is pre-existing, not worsened.
|
||||
- **Network error with no response:** openapi-fetch may reject before a `response` exists; those paths
|
||||
keep throwing a generic `Error` → `errorMessageKey` returns `toast.error`. (Only status-bearing
|
||||
failures get differentiated.)
|
||||
- **Language reactivity:** `<MutationError>` and the object-form `formError` re-render with the active
|
||||
locale because they call `t` at render (the `formError` string is recomputed on the next failed submit;
|
||||
acceptable — error strings are transient).
|
||||
- **Stale row error:** cleared via `mutation.reset()` on re-edit.
|
||||
|
||||
## Testing
|
||||
- **`web/src/api/error-message.test.ts`** (unit): each status → expected key (403/404/409/422/500/502);
|
||||
`InUseError(3)` → `{ key: "actions.inUse", opts: { count: 3 } }`; a bare `Error`/unknown →
|
||||
`{ key: "toast.error" }`.
|
||||
- **`web/src/components/mutation-error.test.tsx`**: renders the mapped text for an `HttpError(403)`;
|
||||
renders nothing for `null`/`undefined`; renders the in-use count for `InUseError`.
|
||||
- **`web/src/api/mutation-feedback.test.tsx`** (rework): the "non-suppressed → catch-all toast" test is
|
||||
obsolete (all mutations now suppress). Replace it with a test that a suppressed mutation failing adds
|
||||
**no** toast (keep the existing delete case), plus assert the success-toast case still works. The
|
||||
status→message behavior is covered by `error-message.test.ts`.
|
||||
- **`term-row` / `authority-row`** (extend existing or via `mutation-feedback`): a failed update renders
|
||||
the inline `MutationError` text and the row stays editable; a successful update closes the editor;
|
||||
re-entering edit after a failure shows no stale error.
|
||||
- **`object-edit-form`**: a `useObject` fetch error (mock `/api/admin/objects/{id}` → 500) renders
|
||||
`objects.loadError`, not `objects.notFound`.
|
||||
- **Inline adoption**: at least one create-form test (e.g. authorities) asserts a failed create shows the
|
||||
status-aware message via `MutationError` (e.g. 403 → `errors.forbidden`).
|
||||
- **Gate:** `typecheck`/`lint`/`test`/`build`/`check:size`/`check:colors` green; en/sv parity (the #60
|
||||
parity test guards the 5 new keys); no codename; no new dependency.
|
||||
|
||||
## Acceptance criteria
|
||||
1. A shared `errorMessageKey(error)` maps `InUseError` and `HttpError` (by status: 403/404/409/422/≥500)
|
||||
to i18n keys, with a `toast.error` fallback; unit-tested.
|
||||
2. A shared `<MutationError error>` component renders the mapped inline alert (or nothing) and replaces
|
||||
the duplicated `form.rejected` markup at every inline mutation-error site (delete dialog via the helper
|
||||
directly, create/rename forms, edit rows, object-form `formError` via the helper).
|
||||
3. The 16 mutation throws use `HttpError(status)` (queries unchanged); `query-client.ts` routes the toast
|
||||
fallback through `errorMessageKey`.
|
||||
4. `useUpdateTerm`/`useUpdateAuthority` suppress the toast and show an inline error at the row, staying
|
||||
editable on failure and clearing stale errors on re-edit.
|
||||
5. `object-edit-form` distinguishes a fetch error (`objects.loadError`) from "not found."
|
||||
6. `typecheck`/`lint`/`test`/`build`/`check:colors` green; `check:size` reported; en/sv parity (5 new
|
||||
keys); no codename; no new dependency.
|
||||
|
||||
## Out of scope → follow-ups
|
||||
- Structured field-level rejection on **core-object** update 422 (uncertain backend shape).
|
||||
- The broader `queries.ts` split + relocating the error classes to `api/errors.ts` (tracked in **#65** —
|
||||
`error-message.ts` imports the classes from `queries.ts` for now).
|
||||
- Toast-based error surfacing (deliberately superseded by inline; the toast path remains only as a
|
||||
fallback).
|
||||
- Retry affordances / optimistic updates.
|
||||
@@ -0,0 +1,146 @@
|
||||
# Split queries.ts: Errors + Query-Key Factory + Domain Modules — Design
|
||||
|
||||
**Date:** 2026-06-08
|
||||
**Status:** Approved (brainstorming) — ready for implementation planning.
|
||||
**Issue:** #65 (split the 584-line `queries.ts`, extract the error classes, add a query-key factory, decide the search-invalidation gap).
|
||||
|
||||
## Context
|
||||
|
||||
`web/src/api/queries.ts` is 584 lines spanning 8 domains (error classes, auth, objects, fields-on-object,
|
||||
field-definitions, vocab, terms, authorities, search). No hook crosses a domain boundary, so a split is
|
||||
low-risk. Three concrete problems:
|
||||
|
||||
- **Toast path drags in the hook module.** After #63, `query-client.ts` imports `errorMessageKey` from
|
||||
`error-message.ts`, which imports `{ HttpError, InUseError }` from `./queries` — so the toast wiring
|
||||
transitively loads all the hooks. Extracting the error classes breaks that chain.
|
||||
- **No query-key factory.** ~20 key literals (`["objects", params]`, `["object", id]`,
|
||||
`["terms", vocabularyId]`, …) plus `config-provider.tsx`'s `["config"]` are hand-written and
|
||||
typo-prone.
|
||||
- **Object writes don't invalidate `["search"]`.** `useUpdateObject`/`useDeleteObject`/`useSetVisibility`
|
||||
invalidate `["objects"]`/`["object", id]` but never the search index, so the search panel keeps stale
|
||||
hits until the user re-searches. **Decision (brainstorming): invalidate** — conventional
|
||||
eventually-consistent behaviour; the query is `enabled` only with a term, so it's a no-op when not
|
||||
searching.
|
||||
|
||||
**Constraint:** ~30 files import from `../api/queries`. The public import path must stay stable (a
|
||||
barrel), so the refactor touches the data layer only — feature files don't change.
|
||||
|
||||
## Components
|
||||
|
||||
### `api/errors.ts` (new) — canonical home for the 4 error classes
|
||||
Move `HttpError`, `FieldRejection`, `InUseError`, `VisibilityError` here verbatim (no behaviour change).
|
||||
`error-message.ts` changes its import from `./queries` to `./errors` — this is the decoupling: the toast
|
||||
path (`query-client → error-message → errors`) no longer loads the hook module. The barrel (below)
|
||||
**re-exports** the error classes (`export * from "../errors"`), so the existing importers that pull them
|
||||
from `../api/queries` — `object-edit-form.tsx`, `object-new-page.tsx`, `publish-control.tsx`,
|
||||
`search-panel.tsx`, and the tests `mutation-error.test.tsx` / `labelled-record-row.test.tsx` /
|
||||
`error-message.test.ts` — keep working unchanged.
|
||||
|
||||
### `api/query-keys.ts` (new) — one key factory
|
||||
```ts
|
||||
export type ObjectListParams = {
|
||||
limit: number;
|
||||
offset: number;
|
||||
sort?: string;
|
||||
order?: "asc" | "desc";
|
||||
visibility?: string;
|
||||
q?: string;
|
||||
};
|
||||
|
||||
export const keys = {
|
||||
me: () => ["me"] as const,
|
||||
config: () => ["config"] as const,
|
||||
objects: () => ["objects"] as const, // family prefix (invalidation)
|
||||
objectsPage: (p: ObjectListParams) => ["objects", p] as const,
|
||||
object: (id: string) => ["object", id] as const,
|
||||
fieldDefinitions: () => ["field-definitions"] as const,
|
||||
vocabularies: () => ["vocabularies"] as const,
|
||||
terms: (vocabularyId: string) => ["terms", vocabularyId] as const,
|
||||
authorities: (kind: string) => ["authorities", kind] as const,
|
||||
search: () => ["search"] as const, // family prefix (invalidation)
|
||||
searchResults: (term: string, visibility: string | null) => ["search", term, visibility] as const,
|
||||
};
|
||||
```
|
||||
- Every `queryKey:` / `invalidateQueries` / `setQueryData` site in the query modules **and**
|
||||
`config-provider.tsx`'s `["config"]` routes through `keys.*` — producing the identical arrays, so
|
||||
cache behaviour is unchanged. (`keys.objects()` prefix-matches `keys.objectsPage(p)` exactly as
|
||||
`["objects"]` matches `["objects", params]` today.)
|
||||
- `ObjectListParams` lives here (it *is* part of the key); `objects.ts` imports it from here — one
|
||||
direction, no import cycle. (It moves out of `queries.ts`'s objects section.)
|
||||
|
||||
### `api/queries/` (new directory) — split by domain + barrel
|
||||
```
|
||||
api/
|
||||
client.ts (unchanged)
|
||||
errors.ts (new)
|
||||
query-keys.ts (new)
|
||||
query-client.ts (unchanged — already imports only error-message)
|
||||
error-message.ts (one-line change: import errors from ./errors)
|
||||
queries/
|
||||
index.ts barrel: `export * from "./auth"; … ; export * from "../errors";`
|
||||
auth.ts useMe, useLogin, useLogout
|
||||
objects.ts useObjectsPage, useObject, useCreateObject, useUpdateObject, useSetFields, useDeleteObject, useSetVisibility
|
||||
field-defs.ts useFieldDefinitions, useCreateFieldDefinition, useUpdateFieldDefinition, useDeleteFieldDefinition
|
||||
vocab.ts useVocabularies, useCreateVocabulary, useRenameVocabulary, useDeleteVocabulary, useTerms, useAddTerm, useUpdateTerm, useDeleteTerm
|
||||
authorities.ts useAuthorities, useCreateAuthority, useUpdateAuthority, useDeleteAuthority
|
||||
search.ts useSearch, SEARCH_PAGE
|
||||
```
|
||||
`api/queries.ts` is deleted; `import { … } from "../api/queries"` resolves to `api/queries/index.ts`.
|
||||
Each module imports `api` from `../client`, types from `../schema`, error classes from `../errors`, and
|
||||
`keys` from `../query-keys`. The hook bodies are moved verbatim (only their key literals → `keys.*`).
|
||||
|
||||
### `api/query-client.ts`
|
||||
No change needed — after #63 it imports only `errorMessageKey`. (Once `error-message.ts` points at
|
||||
`./errors`, the `query-client → error-message → queries` hook dependency is gone.)
|
||||
|
||||
### Search invalidation (`objects.ts`)
|
||||
`useUpdateObject`, `useDeleteObject`, `useSetVisibility` add
|
||||
`void qc.invalidateQueries({ queryKey: keys.search() })` alongside their existing object invalidations.
|
||||
|
||||
## Data flow / behaviour
|
||||
Identical to today except: after an object update/delete/visibility-change, an active search query
|
||||
refetches (eventually-consistent with the Meilisearch reindex). All keys, hooks, error classes, and
|
||||
endpoints are otherwise unchanged.
|
||||
|
||||
## Error handling / edges
|
||||
- The barrel re-exporting errors means the classes are importable from both `../api/errors` (canonical)
|
||||
and `../api/queries` (compat) — intentional, to avoid churning ~6 importers + tests.
|
||||
- `as const` keys are readonly tuples; TanStack Query accepts readonly arrays as keys — no type issue.
|
||||
- No import cycle: `query-keys.ts` exports `ObjectListParams` + `keys` and imports nothing from
|
||||
`queries/`; `objects.ts` imports both from `query-keys.ts`.
|
||||
- The search query stays `enabled: term.length > 0`, so invalidating `["search"]` is a no-op when no
|
||||
search is active.
|
||||
|
||||
## Testing
|
||||
- **Behavior guard (must pass unchanged):** `queries.test.ts`, `queries.authoring.test.tsx`,
|
||||
`queries.fields.test.tsx`, `queries.search.test.tsx`, `queries.visibility.test.tsx`,
|
||||
`queries.vocab.test.tsx`, `mutation-feedback.test.tsx`, `error-message.test.ts`,
|
||||
`mutation-error.test.tsx`, `labelled-record-row.test.tsx` — all import from `../api/queries` (the
|
||||
barrel) and from the re-exported error classes; they must not need edits. The full app suite is the
|
||||
integration guard.
|
||||
- **New `query-keys.test.ts`:** assert the factory arrays — e.g. `keys.objects()` → `["objects"]`,
|
||||
`keys.objectsPage(p)` → `["objects", p]`, `keys.object("x")` → `["object", "x"]`,
|
||||
`keys.searchResults("q", null)` → `["search", "q", null]`.
|
||||
- **Search-invalidation assertion:** extend `queries.visibility.test.tsx` (or `.authoring`) to seed an
|
||||
active `["search", …]` query in the cache, run an object update/delete/set-visibility, and assert the
|
||||
search query is invalidated (e.g. its `isInvalidated`/refetch fires).
|
||||
- **Gate:** `typecheck`/`lint`/`test`/`build`/`check:size`/`check:colors` green; no new dependency; no new
|
||||
i18n keys; no codename; `check:size` unchanged (pure reorg + one invalidate call).
|
||||
|
||||
## Acceptance criteria
|
||||
1. `api/errors.ts` holds the 4 error classes; `error-message.ts` imports them from `./errors`; the barrel
|
||||
re-exports them so every existing importer (components + tests) still resolves.
|
||||
2. `queries.ts` is split into `api/queries/{auth,objects,field-defs,vocab,authorities,search}.ts` +
|
||||
`index.ts`; `api/queries.ts` is deleted; the `../api/queries` import path is unchanged for all ~30
|
||||
consumers.
|
||||
3. A `keys` factory in `api/query-keys.ts` is used by every `queryKey`/invalidate/setQueryData site,
|
||||
including `config-provider.tsx`.
|
||||
4. `useUpdateObject`/`useDeleteObject`/`useSetVisibility` invalidate `keys.search()`.
|
||||
5. All existing tests pass unchanged; `typecheck`/`lint`/`build`/`check:colors` green; `check:size`
|
||||
unchanged; no new dependency; no new i18n keys; no codename.
|
||||
|
||||
## Out of scope → follow-ups
|
||||
- No hook signature/behaviour changes beyond the search invalidation; no endpoint changes.
|
||||
- `staleTime` / `keepPreviousData` choices stay as-is (intentional per #63's note).
|
||||
- Repointing the 4 component error-importers from the barrel to `../api/errors` (the re-export keeps them
|
||||
working; a later cosmetic cleanup could do it).
|
||||
@@ -0,0 +1,182 @@
|
||||
# Unify Vocabulary + Authority CRUD — Design
|
||||
|
||||
**Date:** 2026-06-08
|
||||
**Status:** Approved (brainstorming) — ready for implementation planning.
|
||||
**Issue:** #64 (the duplicated Vocabulary-terms + Authorities CRUD surfaces).
|
||||
|
||||
## Context
|
||||
|
||||
The Vocabulary-terms and Authorities admin surfaces are two copies of one feature ("a labelled record
|
||||
with an optional external URI: filterable list + inline-edit rows + create form"). The duplication spans
|
||||
four files and ~280 lines:
|
||||
|
||||
- `vocab/term-row.tsx` and `authorities/authority-row.tsx` are byte-for-byte twins except: the mutation
|
||||
hooks (`useUpdateTerm`/`useDeleteTerm` vs `useUpdateAuthority`/`useDeleteAuthority`), the record type
|
||||
(`TermView` vs `AuthorityView`), the URI-input id prefix (`term-uri-` / `auth-uri-`), the mutate-arg
|
||||
shape (`{ vocabularyId, termId, … }` vs `{ id, kind, … }`), and the delete-confirm i18n key.
|
||||
- `authorities/authorities-page.tsx` and `vocab/vocabulary-terms.tsx` share the filter input, the
|
||||
4-state list (loading→skeleton / error / empty / no-matches / rows), and the create form
|
||||
(`LabelEditor` + URI input + `labels.some()` validation + `MutationError` + submit). They differ in the
|
||||
i18n keys, the create-form heading, and (authorities only) the kind-tabs `<nav>` + `PageTitle` +
|
||||
`Navigate` guard.
|
||||
|
||||
A fix to inline-edit behaviour must currently be made in two places and silently drifts. (These files
|
||||
already share `LabelEditor`, `ExternalUriLink`, `DeleteConfirmDialog`, and `MutationError`.)
|
||||
|
||||
`vocabulary-list.tsx` (vocabularies are `key`-based, not labelled records) and the `objects` RHF surface
|
||||
are intentionally **not** unified — different shapes.
|
||||
|
||||
### Decisions (from brainstorming)
|
||||
Full unification — three shared components in `src/components/`, with `TermRow`/`AuthorityRow` and the
|
||||
two pages reduced to thin adapters. All variance is pushed into props; no generics on the row (the adapter
|
||||
owns the mutate-arg shape). Behavior-preserving — existing tests are the guard.
|
||||
|
||||
## Components
|
||||
|
||||
### `components/labelled-record-row.tsx` (new) — `LabelledRecordRow`
|
||||
Owns `editing` / `labels` / `uri` state. Renders the display row (`labelText` + `ExternalUriLink` + Edit
|
||||
button + `DeleteConfirmDialog`) or the edit view (`LabelEditor` + URI `<Input>` + Save/Cancel +
|
||||
`MutationError`).
|
||||
```ts
|
||||
type RecordLike = { id: string; labels: LabelView[]; external_uri: string | null };
|
||||
|
||||
function LabelledRecordRow(props: {
|
||||
record: RecordLike;
|
||||
lang: string;
|
||||
deleteConfirmKey: string; // i18n key for the confirm prompt
|
||||
savePending: boolean; // update.isPending
|
||||
saveError: unknown; // update.error
|
||||
onEditOpen: () => void; // adapter calls update.reset()
|
||||
onSave: (labels: LabelInput[], uri: string | null, done: () => void) => void;
|
||||
onDelete: () => Promise<void>;
|
||||
}): JSX.Element;
|
||||
```
|
||||
- Edit button onClick: `onEditOpen(); setLabels(record.labels as LabelInput[]); setUri(record.external_uri ?? ""); setEditing(true);` (preserves the #63 reset-on-edit-open behaviour).
|
||||
- Save: `onSave(labels, uri.trim() || null, () => setEditing(false))`; Save disabled while `savePending`;
|
||||
`<MutationError error={saveError} />` below the buttons.
|
||||
- The URI input id uses `useId()` (replaces the `term-uri-${id}` / `auth-uri-${id}` scheme).
|
||||
- `record.labels` is `LabelView[]`; cast to `LabelInput[]` for `LabelEditor` (same cast the current rows do).
|
||||
|
||||
### `components/labelled-record-create-form.tsx` (new) — `LabelledRecordCreateForm`
|
||||
Owns its own `labels` / `uri` / `requiredError` state. Renders `heading` + `LabelEditor` + URI `<Input>`
|
||||
(id via `useId()`) + the `form.required` validation alert + `<MutationError error={error} />` + submit.
|
||||
```ts
|
||||
function LabelledRecordCreateForm(props: {
|
||||
heading: ReactNode;
|
||||
submitLabel: string;
|
||||
pending: boolean; // create.isPending
|
||||
error: unknown; // create.error
|
||||
onCreate: (labels: LabelInput[], uri: string | null, reset: () => void) => void;
|
||||
}): JSX.Element;
|
||||
```
|
||||
- Submit: `if (!labels.some((l) => l.label)) { setRequiredError(true); return; } setRequiredError(false);
|
||||
onCreate(labels, uri.trim() || null, () => { setLabels([]); setUri(""); });`
|
||||
- Submit button disabled while `pending`.
|
||||
|
||||
### `components/filtered-record-list.tsx` (new) — `FilteredRecordList<T>`
|
||||
Owns the `filter` state. Renders the filter `<Input>` **always**, then (loading → `<ListSkeleton>` else the
|
||||
`<ul>`), so the filter stays visible during load (matches current behaviour).
|
||||
```ts
|
||||
function FilteredRecordList<T extends { id: string; labels: LabelView[] }>(props: {
|
||||
records: T[] | undefined;
|
||||
lang: string;
|
||||
isLoading: boolean;
|
||||
isError: boolean;
|
||||
loadErrorText: string;
|
||||
emptyText: string;
|
||||
renderRow: (record: T) => ReactNode;
|
||||
}): JSX.Element;
|
||||
```
|
||||
- `const q = filter.trim().toLowerCase(); const rows = [...(records ?? [])].filter((r) => !q ||
|
||||
labelText(r.labels, lang).toLowerCase().includes(q)).sort(byLabel(lang));`
|
||||
- List states (preserving the current logic exactly): `isError` → `loadErrorText`; `!isError &&
|
||||
records?.length === 0` → `emptyText`; `!isError && records && records.length > 0 && rows.length === 0`
|
||||
→ `t("common.noMatches")`; else `rows.map(renderRow)`.
|
||||
- Filter input uses `aria-label={t("common.filter")}` + `placeholder={t("common.filter")}` (unchanged).
|
||||
|
||||
### Adapters
|
||||
|
||||
**`vocab/term-row.tsx`** keeps its public API `<TermRow vocabularyId term lang />` (its #63 test stays
|
||||
valid). Body:
|
||||
```tsx
|
||||
const update = useUpdateTerm();
|
||||
const del = useDeleteTerm();
|
||||
return (
|
||||
<LabelledRecordRow
|
||||
record={term}
|
||||
lang={lang}
|
||||
deleteConfirmKey="actions.confirmDeleteTerm"
|
||||
savePending={update.isPending}
|
||||
saveError={update.error}
|
||||
onEditOpen={() => update.reset()}
|
||||
onSave={(labels, uri, done) =>
|
||||
update.mutate({ vocabularyId, termId: term.id, external_uri: uri, labels }, { onSuccess: done })}
|
||||
onDelete={() => del.mutateAsync({ vocabularyId, termId: term.id })}
|
||||
/>
|
||||
);
|
||||
```
|
||||
**`authorities/authority-row.tsx`** keeps `<AuthorityRow authority kind lang />`; analogous with
|
||||
`useUpdateAuthority`/`useDeleteAuthority`, `deleteConfirmKey="actions.confirmDeleteAuthority"`, save arg
|
||||
`{ id: authority.id, kind, external_uri: uri, labels }`, delete `{ id: authority.id, kind }`.
|
||||
|
||||
**`authorities/authorities-page.tsx`** keeps the `PageTitle`, kind `<nav>`, `Navigate` guard, breadcrumb,
|
||||
and `useDocumentTitle`. Replaces the inline filter/list with `<FilteredRecordList records={authorities}
|
||||
lang={lang} isLoading={isLoading} isError={isError} loadErrorText={t("authorities.loadError")}
|
||||
emptyText={t("authorities.empty")} renderRow={(a) => <AuthorityRow authority={a} kind={currentKind}
|
||||
lang={lang} />} />`, and the inline form with `<LabelledRecordCreateForm heading={`${t("authorities.new")} ·
|
||||
${t(\`authorities.${currentKind}\`)}`} submitLabel={t("authorities.create")} pending={create.isPending}
|
||||
error={create.error} onCreate={(labels, uri, reset) => create.mutate({ kind, external_uri: uri, labels },
|
||||
{ onSuccess: reset })} />`. (Drops the now-unused local `labels`/`uri`/`error`/`filter` state and the
|
||||
`onCreate` handler.)
|
||||
|
||||
**`vocab/vocabulary-terms.tsx`** keeps its `vocab.terms` caption + breadcrumb. Uses `<FilteredRecordList
|
||||
records={terms} … loadErrorText={t("vocab.loadError")} emptyText={t("vocab.noTerms")} renderRow={(term) =>
|
||||
<TermRow vocabularyId={id} term={term} lang={lang} />} />` and `<LabelledRecordCreateForm
|
||||
heading={t("vocab.addTerm")} submitLabel={t("vocab.addTerm")} pending={addTerm.isPending}
|
||||
error={addTerm.error} onCreate={(labels, uri, reset) => addTerm.mutate({ vocabularyId: id, external_uri:
|
||||
uri, labels }, { onSuccess: reset })} />`.
|
||||
|
||||
## Data flow
|
||||
No change to the query/mutation layer. Each page owns its data hooks + the page-specific chrome (nav,
|
||||
headings, breadcrumb) and hands records + render callbacks to the shared list, mutate callbacks to the
|
||||
shared create form, and per-row mutate callbacks (via the row adapters) to the shared row.
|
||||
|
||||
## Error handling / edges
|
||||
- Inline save errors and create errors still render via `<MutationError>` (status-aware, from #63),
|
||||
unchanged.
|
||||
- The `form.required` validation (empty labels) stays in the create form.
|
||||
- Reset-on-edit-open (`update.reset()`) preserved so a stale save error doesn't linger.
|
||||
- The empty-vs-no-matches distinction is computed from the **raw** `records` length (empty) vs the
|
||||
**filtered** `rows` length (no matches), exactly as today.
|
||||
- `useId()` keeps URI-input ids unique across simultaneously-mounted rows/forms.
|
||||
|
||||
## Testing
|
||||
- **Behavior guard:** existing tests stay green unchanged — `vocab/term-row.test.tsx`,
|
||||
`authorities/authorities.test.tsx` (page filter/create/list), `vocab/vocabularies.test.tsx`
|
||||
(out-of-scope list, must not break). Same public component APIs + DOM.
|
||||
- **New focused tests** for the three components:
|
||||
- `labelled-record-row.test.tsx`: display → click Edit → Save calls `onSave` and closes on `done`; a
|
||||
failed save (passing `saveError`) shows the inline error and the row stays editable; Delete invokes
|
||||
`onDelete`.
|
||||
- `labelled-record-create-form.test.tsx`: submit with empty labels shows `form.required` and does NOT
|
||||
call `onCreate`; a valid submit calls `onCreate` and the `reset` clears the inputs.
|
||||
- `filtered-record-list.test.tsx`: typing in the filter narrows the rendered rows; `records=[]` →
|
||||
`emptyText`; non-empty records + non-matching filter → `common.noMatches`; `isError` → `loadErrorText`;
|
||||
`isLoading` → skeleton.
|
||||
- **Gate:** `typecheck`/`lint`/`test`/`build`/`check:size`/`check:colors` green; no new i18n keys; en/sv
|
||||
parity unaffected; no codename; no new dependency. `check:size` should not grow (net code reduction).
|
||||
|
||||
## Acceptance criteria
|
||||
1. `LabelledRecordRow`, `LabelledRecordCreateForm`, `FilteredRecordList<T>` exist in `src/components/` with
|
||||
the prop shapes above; `TermRow`/`AuthorityRow` and the two pages are adapters over them.
|
||||
2. `term-row.tsx` + `authority-row.tsx` no longer duplicate the row body; `authorities-page.tsx` +
|
||||
`vocabulary-terms.tsx` no longer duplicate the filter/list/create-form body.
|
||||
3. All existing tests pass unchanged; the three new components have focused tests.
|
||||
4. No behavior change: inline edit/save/delete, create + validation, filtering, the 4 list states, the
|
||||
authorities kind-nav, and breadcrumbs all work as before.
|
||||
5. `typecheck`/`lint`/`test`/`build`/`check:colors` green; `check:size` reported (not increased); no new
|
||||
i18n keys; no codename; no new dependency.
|
||||
|
||||
## Out of scope → follow-ups
|
||||
- `vocabulary-list.tsx` (key-based vocabularies) and the `objects` table/detail/RHF surface.
|
||||
- A field-definition "position"/ordering concept; server-side filtering for large vocabularies (#43).
|
||||
@@ -0,0 +1,26 @@
|
||||
import { expect, test } from "vitest";
|
||||
|
||||
import { errorMessageKey } from "./error-message";
|
||||
import { HttpError, InUseError } from "./queries";
|
||||
|
||||
test("maps HTTP statuses to specific keys", () => {
|
||||
expect(errorMessageKey(new HttpError(403))).toEqual({ key: "errors.forbidden" });
|
||||
expect(errorMessageKey(new HttpError(404))).toEqual({ key: "errors.notFound" });
|
||||
expect(errorMessageKey(new HttpError(409))).toEqual({ key: "errors.conflict" });
|
||||
expect(errorMessageKey(new HttpError(422))).toEqual({ key: "errors.validation" });
|
||||
expect(errorMessageKey(new HttpError(500))).toEqual({ key: "errors.server" });
|
||||
expect(errorMessageKey(new HttpError(502))).toEqual({ key: "errors.server" });
|
||||
});
|
||||
|
||||
test("an unmapped status falls back to the generic key", () => {
|
||||
expect(errorMessageKey(new HttpError(418))).toEqual({ key: "toast.error" });
|
||||
});
|
||||
|
||||
test("InUseError carries the count", () => {
|
||||
expect(errorMessageKey(new InUseError(3))).toEqual({ key: "actions.inUse", opts: { count: 3 } });
|
||||
});
|
||||
|
||||
test("a bare Error or unknown maps to the generic key", () => {
|
||||
expect(errorMessageKey(new Error("boom"))).toEqual({ key: "toast.error" });
|
||||
expect(errorMessageKey(null)).toEqual({ key: "toast.error" });
|
||||
});
|
||||
@@ -0,0 +1,18 @@
|
||||
import { HttpError, InUseError } from "./errors";
|
||||
|
||||
/** Maps a caught mutation error to an i18n key (+ interpolation opts). The single
|
||||
* source of truth shared by the global toast fallback and every inline display. */
|
||||
export function errorMessageKey(error: unknown): { key: string; opts?: Record<string, unknown> } {
|
||||
if (error instanceof InUseError) return { key: "actions.inUse", opts: { count: error.count } };
|
||||
if (error instanceof HttpError) return { key: statusKey(error.status) };
|
||||
return { key: "toast.error" };
|
||||
}
|
||||
|
||||
function statusKey(status: number): string {
|
||||
if (status === 403) return "errors.forbidden";
|
||||
if (status === 404) return "errors.notFound";
|
||||
if (status === 409) return "errors.conflict";
|
||||
if (status === 422) return "errors.validation";
|
||||
if (status >= 500) return "errors.server";
|
||||
return "toast.error";
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
export class HttpError extends Error {
|
||||
constructor(public readonly status: number) {
|
||||
super(`HTTP ${status}`);
|
||||
this.name = "HttpError";
|
||||
}
|
||||
}
|
||||
|
||||
export class FieldRejection extends Error {
|
||||
constructor(public readonly field: string, public readonly code: string) {
|
||||
super(`field rejected: ${field}`);
|
||||
this.name = "FieldRejection";
|
||||
}
|
||||
}
|
||||
|
||||
export class InUseError extends Error {
|
||||
constructor(public readonly count: number) {
|
||||
super(`in use: ${count}`);
|
||||
this.name = "InUseError";
|
||||
}
|
||||
}
|
||||
|
||||
/** Error carrying the HTTP status so callers can branch 422-gate vs 409-illegal. */
|
||||
export class VisibilityError extends Error {
|
||||
constructor(public status: number) {
|
||||
super(`visibility change failed (${status})`);
|
||||
this.name = "VisibilityError";
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
import { afterEach, describe, expect, test } from "vitest";
|
||||
import { renderHook, waitFor, within } from "@testing-library/react";
|
||||
import { QueryClientProvider } from "@tanstack/react-query";
|
||||
import { QueryClientProvider, useMutation } from "@tanstack/react-query";
|
||||
import { http, HttpResponse } from "msw";
|
||||
import type { ReactNode } from "react";
|
||||
|
||||
@@ -8,7 +8,7 @@ import i18n from "../i18n";
|
||||
import { ToastRegion } from "../components/ui/toast";
|
||||
import { server } from "../test/server";
|
||||
import { makeQueryClient } from "./query-client";
|
||||
import { useDeleteVocabulary, useUpdateTerm } from "./queries";
|
||||
import { HttpError, useDeleteVocabulary, useUpdateTerm } from "./queries";
|
||||
|
||||
// The toast manager is a module-scope singleton shared across renders, so each
|
||||
// test mounts a fresh region and tears it down afterwards to keep toasts from
|
||||
@@ -59,30 +59,22 @@ describe("mutation feedback toasts", () => {
|
||||
unmount();
|
||||
});
|
||||
|
||||
test("a non-suppressed mutation failing shows the catch-all error toast", async () => {
|
||||
server.use(
|
||||
http.patch(
|
||||
"/api/admin/vocabularies/:id/terms/:term_id",
|
||||
() => new HttpResponse(null, { status: 500 }),
|
||||
),
|
||||
test("a non-suppressed mutation failing shows the status-mapped error toast", async () => {
|
||||
const { result, unmount } = renderHook(
|
||||
() =>
|
||||
useMutation({
|
||||
mutationFn: async () => {
|
||||
throw new HttpError(500);
|
||||
},
|
||||
}),
|
||||
{ wrapper: makeWrapper() },
|
||||
);
|
||||
|
||||
const { result, unmount } = renderHook(() => useUpdateTerm(), {
|
||||
wrapper: makeWrapper(),
|
||||
});
|
||||
|
||||
await expect(
|
||||
result.current.mutateAsync({
|
||||
vocabularyId: "v1",
|
||||
termId: "t1",
|
||||
external_uri: null,
|
||||
labels: [{ lang: "en", label: "Bronze" }],
|
||||
}),
|
||||
).rejects.toThrow();
|
||||
await expect(result.current.mutateAsync()).rejects.toThrow();
|
||||
|
||||
await waitFor(() => {
|
||||
expect(
|
||||
within(document.body).getByText(i18n.t("toast.error")),
|
||||
within(document.body).getByText(i18n.t("errors.server")),
|
||||
).toBeInTheDocument();
|
||||
});
|
||||
|
||||
|
||||
@@ -1,584 +0,0 @@
|
||||
import { keepPreviousData, useInfiniteQuery, useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
||||
|
||||
import { api } from "./client";
|
||||
import type { components } from "./schema";
|
||||
|
||||
export class HttpError extends Error {
|
||||
constructor(public readonly status: number) {
|
||||
super(`HTTP ${status}`);
|
||||
this.name = "HttpError";
|
||||
}
|
||||
}
|
||||
|
||||
export class FieldRejection extends Error {
|
||||
constructor(public readonly field: string, public readonly code: string) {
|
||||
super(`field rejected: ${field}`);
|
||||
this.name = "FieldRejection";
|
||||
}
|
||||
}
|
||||
|
||||
export class InUseError extends Error {
|
||||
constructor(public readonly count: number) {
|
||||
super(`in use: ${count}`);
|
||||
this.name = "InUseError";
|
||||
}
|
||||
}
|
||||
|
||||
type UserView = components["schemas"]["UserView"];
|
||||
type LoginRequest = components["schemas"]["LoginRequest"];
|
||||
|
||||
export function useMe() {
|
||||
return useQuery({
|
||||
queryKey: ["me"],
|
||||
queryFn: async (): Promise<UserView | null> => {
|
||||
const { data, response } = await api.GET("/api/admin/me");
|
||||
|
||||
if (response.status === 401) return null;
|
||||
|
||||
if (!data) throw new Error("failed to load session");
|
||||
|
||||
return data;
|
||||
},
|
||||
retry: false,
|
||||
});
|
||||
}
|
||||
|
||||
export type ObjectListParams = {
|
||||
limit: number;
|
||||
offset: number;
|
||||
sort?: string;
|
||||
order?: "asc" | "desc";
|
||||
visibility?: string;
|
||||
q?: string;
|
||||
};
|
||||
|
||||
export function useObjectsPage(params: ObjectListParams) {
|
||||
return useQuery({
|
||||
queryKey: ["objects", params],
|
||||
placeholderData: keepPreviousData,
|
||||
queryFn: async () => {
|
||||
const { data, error } = await api.GET("/api/admin/objects", {
|
||||
params: {
|
||||
query: {
|
||||
limit: params.limit,
|
||||
offset: params.offset,
|
||||
sort: params.sort,
|
||||
order: params.order,
|
||||
visibility: params.visibility,
|
||||
q: params.q,
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
if (error || !data) throw new Error("failed to load objects");
|
||||
|
||||
return data;
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
export function useObject(id: string) {
|
||||
return useQuery({
|
||||
queryKey: ["object", id],
|
||||
queryFn: async () => {
|
||||
const { data, response } = await api.GET("/api/admin/objects/{id}", {
|
||||
params: { path: { id } },
|
||||
});
|
||||
|
||||
if (response.status === 404) return null;
|
||||
|
||||
if (!data) throw new Error("failed to load object");
|
||||
|
||||
return data;
|
||||
},
|
||||
// A 404 resolves to null rather than erroring, so don't retry it.
|
||||
retry: false,
|
||||
});
|
||||
}
|
||||
|
||||
export function useFieldDefinitions() {
|
||||
return useQuery({
|
||||
queryKey: ["field-definitions"],
|
||||
queryFn: async () => {
|
||||
const { data, error } = await api.GET("/api/admin/field-definitions");
|
||||
|
||||
if (error || !data) throw new Error("failed to load field definitions");
|
||||
|
||||
return data;
|
||||
},
|
||||
staleTime: 5 * 60 * 1000,
|
||||
});
|
||||
}
|
||||
|
||||
export function useLogin() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async (body: LoginRequest) => {
|
||||
const { response } = await api.POST("/api/admin/login", { body });
|
||||
|
||||
if (response.status !== 204) {
|
||||
throw new Error(response.status === 401 ? "invalid" : "network");
|
||||
}
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: ["me"] }),
|
||||
meta: { suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useLogout() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async () => {
|
||||
await api.POST("/api/admin/logout");
|
||||
},
|
||||
onSuccess: () => qc.setQueryData(["me"], null),
|
||||
});
|
||||
}
|
||||
|
||||
type ObjectCreateRequest = components["schemas"]["ObjectCreateRequest"];
|
||||
type ObjectUpdateRequest = components["schemas"]["ObjectUpdateRequest"];
|
||||
|
||||
export function useTerms(vocabularyId: string | null | undefined) {
|
||||
return useQuery({
|
||||
queryKey: ["terms", vocabularyId],
|
||||
enabled: !!vocabularyId,
|
||||
queryFn: async () => {
|
||||
const { data, error } = await api.GET("/api/admin/vocabularies/{id}/terms", {
|
||||
params: { path: { id: vocabularyId! } },
|
||||
});
|
||||
|
||||
if (error || !data) throw new Error("failed to load terms");
|
||||
|
||||
return data;
|
||||
},
|
||||
staleTime: 5 * 60 * 1000,
|
||||
});
|
||||
}
|
||||
|
||||
export function useAuthorities(kind: string | null | undefined) {
|
||||
return useQuery({
|
||||
queryKey: ["authorities", kind],
|
||||
enabled: !!kind,
|
||||
queryFn: async () => {
|
||||
const { data, error } = await api.GET("/api/admin/authorities", {
|
||||
params: { query: { kind: kind! } },
|
||||
});
|
||||
|
||||
if (error || !data) throw new Error("failed to load authorities");
|
||||
|
||||
return data;
|
||||
},
|
||||
staleTime: 5 * 60 * 1000,
|
||||
});
|
||||
}
|
||||
|
||||
export function useCreateObject() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async (body: ObjectCreateRequest) => {
|
||||
const { data, error } = await api.POST("/api/admin/objects", { body });
|
||||
|
||||
if (error || !data) throw new Error("create failed");
|
||||
|
||||
return data;
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: ["objects"] }),
|
||||
meta: { successMessage: "toast.created", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useUpdateObject() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({ id, body }: { id: string; body: ObjectUpdateRequest }) => {
|
||||
const { response } = await api.PUT("/api/admin/objects/{id}", {
|
||||
params: { path: { id } },
|
||||
body,
|
||||
});
|
||||
|
||||
if (response.status !== 204) throw new Error("update failed");
|
||||
},
|
||||
onSuccess: (_d, { id }) => {
|
||||
void qc.invalidateQueries({ queryKey: ["objects"] });
|
||||
void qc.invalidateQueries({ queryKey: ["object", id] });
|
||||
},
|
||||
meta: { successMessage: "toast.saved", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useSetFields() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({ id, fields }: { id: string; fields: Record<string, unknown> }) => {
|
||||
const { response, error } = await api.PUT("/api/admin/objects/{id}/fields", {
|
||||
params: { path: { id } },
|
||||
body: fields as Record<string, never>,
|
||||
});
|
||||
|
||||
if (response.status === 204) return;
|
||||
|
||||
if (response.status === 422 && error && typeof error === "object" && "field" in error) {
|
||||
const detail = error as { field: string; code: string };
|
||||
throw new FieldRejection(detail.field, detail.code);
|
||||
}
|
||||
|
||||
throw new Error("set fields failed");
|
||||
},
|
||||
onSuccess: (_d, { id }) => {
|
||||
void qc.invalidateQueries({ queryKey: ["object", id] });
|
||||
},
|
||||
meta: { suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useDeleteObject() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async (id: string) => {
|
||||
const { response } = await api.DELETE("/api/admin/objects/{id}", {
|
||||
params: { path: { id } },
|
||||
});
|
||||
|
||||
if (response.status !== 204) throw new Error("delete failed");
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: ["objects"] }),
|
||||
meta: { successMessage: "toast.deleted", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
type NewVocabularyRequest = components["schemas"]["NewVocabularyRequest"];
|
||||
type LabelInput = components["schemas"]["LabelInput"];
|
||||
|
||||
export function useVocabularies() {
|
||||
return useQuery({
|
||||
queryKey: ["vocabularies"],
|
||||
queryFn: async () => {
|
||||
const { data, error } = await api.GET("/api/admin/vocabularies");
|
||||
|
||||
if (error || !data) throw new Error("failed to load vocabularies");
|
||||
|
||||
return data;
|
||||
},
|
||||
staleTime: 5 * 60 * 1000,
|
||||
});
|
||||
}
|
||||
|
||||
export function useCreateVocabulary() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async (body: NewVocabularyRequest) => {
|
||||
const { data, error } = await api.POST("/api/admin/vocabularies", { body });
|
||||
|
||||
if (error || !data) throw new Error("create vocabulary failed");
|
||||
|
||||
return data;
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: ["vocabularies"] }),
|
||||
meta: { successMessage: "toast.created", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useAddTerm() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({
|
||||
vocabularyId,
|
||||
external_uri,
|
||||
labels,
|
||||
}: {
|
||||
vocabularyId: string;
|
||||
external_uri: string | null;
|
||||
labels: LabelInput[];
|
||||
}) => {
|
||||
const { response } = await api.POST("/api/admin/vocabularies/{id}/terms", {
|
||||
params: { path: { id: vocabularyId } },
|
||||
body: { external_uri, labels },
|
||||
});
|
||||
|
||||
if (response.status !== 201) throw new Error("add term failed");
|
||||
},
|
||||
onSuccess: (_result, { vocabularyId }) =>
|
||||
qc.invalidateQueries({ queryKey: ["terms", vocabularyId] }),
|
||||
meta: { successMessage: "toast.created", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useCreateAuthority() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({
|
||||
kind,
|
||||
external_uri,
|
||||
labels,
|
||||
}: {
|
||||
kind: string;
|
||||
external_uri: string | null;
|
||||
labels: LabelInput[];
|
||||
}) => {
|
||||
const { response } = await api.POST("/api/admin/authorities", {
|
||||
body: { kind, external_uri, labels },
|
||||
});
|
||||
|
||||
if (response.status !== 201) throw new Error("create authority failed");
|
||||
},
|
||||
onSuccess: (_result, { kind }) =>
|
||||
qc.invalidateQueries({ queryKey: ["authorities", kind] }),
|
||||
meta: { successMessage: "toast.created", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
const SEARCH_PAGE = 20;
|
||||
|
||||
export function useSearch(q: string, visibility: string | null) {
|
||||
const term = q.trim();
|
||||
|
||||
return useInfiniteQuery({
|
||||
queryKey: ["search", term, visibility],
|
||||
enabled: term.length > 0,
|
||||
initialPageParam: 0,
|
||||
queryFn: async ({ pageParam }) => {
|
||||
const { data, error, response } = await api.GET("/api/admin/search", {
|
||||
params: {
|
||||
query: {
|
||||
q: term,
|
||||
...(visibility ? { visibility } : {}),
|
||||
offset: pageParam,
|
||||
limit: SEARCH_PAGE,
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
if (error || !data) throw new HttpError(response.status);
|
||||
|
||||
return data;
|
||||
},
|
||||
placeholderData: keepPreviousData,
|
||||
getNextPageParam: (lastPage, allPages) => {
|
||||
const loaded = allPages.reduce((n, page) => n + page.hits.length, 0);
|
||||
|
||||
return loaded < lastPage.estimated_total ? loaded : undefined;
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
type NewFieldDefinitionRequest = components["schemas"]["NewFieldDefinitionRequest"];
|
||||
|
||||
export function useCreateFieldDefinition() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async (body: NewFieldDefinitionRequest) => {
|
||||
const { data, response } = await api.POST("/api/admin/field-definitions", { body });
|
||||
|
||||
if (response.status !== 201 || !data) throw new Error("failed to create field definition");
|
||||
|
||||
return data;
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: ["field-definitions"] }),
|
||||
meta: { successMessage: "toast.created", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
type Visibility = "draft" | "internal" | "public";
|
||||
|
||||
/** Error carrying the HTTP status so callers can branch 422-gate vs 409-illegal. */
|
||||
export class VisibilityError extends Error {
|
||||
constructor(public status: number) {
|
||||
super(`visibility change failed (${status})`);
|
||||
this.name = "VisibilityError";
|
||||
}
|
||||
}
|
||||
|
||||
export function useSetVisibility() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({ id, visibility }: { id: string; visibility: Visibility }) => {
|
||||
const { response } = await api.POST("/api/admin/objects/{id}/visibility", {
|
||||
params: { path: { id } },
|
||||
body: { visibility },
|
||||
});
|
||||
|
||||
if (response.status !== 204) throw new VisibilityError(response.status);
|
||||
},
|
||||
onSuccess: (_result, { id }) => {
|
||||
void qc.invalidateQueries({ queryKey: ["object", id] });
|
||||
void qc.invalidateQueries({ queryKey: ["objects"] });
|
||||
},
|
||||
meta: { successMessage: "toast.published", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useUpdateTerm() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({
|
||||
vocabularyId,
|
||||
termId,
|
||||
external_uri,
|
||||
labels,
|
||||
}: {
|
||||
vocabularyId: string;
|
||||
termId: string;
|
||||
external_uri: string | null;
|
||||
labels: LabelInput[];
|
||||
}) => {
|
||||
const { response } = await api.PATCH("/api/admin/vocabularies/{id}/terms/{term_id}", {
|
||||
params: { path: { id: vocabularyId, term_id: termId } },
|
||||
body: { external_uri, labels },
|
||||
});
|
||||
|
||||
if (response.status !== 204) throw new Error("update term failed");
|
||||
},
|
||||
onSuccess: (_d, { vocabularyId }) => qc.invalidateQueries({ queryKey: ["terms", vocabularyId] }),
|
||||
meta: { successMessage: "toast.saved" },
|
||||
});
|
||||
}
|
||||
|
||||
export function useDeleteTerm() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({ vocabularyId, termId }: { vocabularyId: string; termId: string }) => {
|
||||
const { error, response } = await api.DELETE("/api/admin/vocabularies/{id}/terms/{term_id}", {
|
||||
params: { path: { id: vocabularyId, term_id: termId } },
|
||||
});
|
||||
|
||||
if (response.status === 409) throw new InUseError((error as { count?: number })?.count ?? 0);
|
||||
if (response.status !== 204) throw new Error("delete term failed");
|
||||
},
|
||||
onSuccess: (_d, { vocabularyId }) => qc.invalidateQueries({ queryKey: ["terms", vocabularyId] }),
|
||||
meta: { successMessage: "toast.deleted", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useRenameVocabulary() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({ id, key }: { id: string; key: string }) => {
|
||||
const { response } = await api.PATCH("/api/admin/vocabularies/{id}", {
|
||||
params: { path: { id } },
|
||||
body: { key },
|
||||
});
|
||||
|
||||
if (response.status !== 204) throw new Error("rename failed");
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: ["vocabularies"] }),
|
||||
meta: { successMessage: "toast.renamed", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useDeleteVocabulary() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async (id: string) => {
|
||||
const { error, response } = await api.DELETE("/api/admin/vocabularies/{id}", {
|
||||
params: { path: { id } },
|
||||
});
|
||||
|
||||
if (response.status === 409) throw new InUseError((error as { count?: number })?.count ?? 0);
|
||||
if (response.status !== 204) throw new Error("delete vocabulary failed");
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: ["vocabularies"] }),
|
||||
meta: { successMessage: "toast.deleted", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useUpdateAuthority() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({
|
||||
id,
|
||||
external_uri,
|
||||
labels,
|
||||
}: {
|
||||
id: string;
|
||||
kind: string;
|
||||
external_uri: string | null;
|
||||
labels: LabelInput[];
|
||||
}) => {
|
||||
const { response } = await api.PATCH("/api/admin/authorities/{id}", {
|
||||
params: { path: { id } },
|
||||
body: { external_uri, labels },
|
||||
});
|
||||
|
||||
if (response.status !== 204) throw new Error("update authority failed");
|
||||
},
|
||||
onSuccess: (_d, { kind }) => qc.invalidateQueries({ queryKey: ["authorities", kind] }),
|
||||
meta: { successMessage: "toast.saved" },
|
||||
});
|
||||
}
|
||||
|
||||
export function useDeleteAuthority() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({ id }: { id: string; kind: string }) => {
|
||||
const { error, response } = await api.DELETE("/api/admin/authorities/{id}", {
|
||||
params: { path: { id } },
|
||||
});
|
||||
|
||||
if (response.status === 409) throw new InUseError((error as { count?: number })?.count ?? 0);
|
||||
if (response.status !== 204) throw new Error("delete authority failed");
|
||||
},
|
||||
onSuccess: (_d, { kind }) => qc.invalidateQueries({ queryKey: ["authorities", kind] }),
|
||||
meta: { successMessage: "toast.deleted", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useUpdateFieldDefinition() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({
|
||||
key,
|
||||
required,
|
||||
group,
|
||||
labels,
|
||||
}: {
|
||||
key: string;
|
||||
required: boolean;
|
||||
group: string | null;
|
||||
labels: LabelInput[];
|
||||
}) => {
|
||||
const { response } = await api.PATCH("/api/admin/field-definitions/{key}", {
|
||||
params: { path: { key } },
|
||||
body: { required, group, labels },
|
||||
});
|
||||
|
||||
if (response.status !== 204) throw new Error("update field failed");
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: ["field-definitions"] }),
|
||||
meta: { successMessage: "toast.saved", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useDeleteFieldDefinition() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async (key: string) => {
|
||||
const { error, response } = await api.DELETE("/api/admin/field-definitions/{key}", {
|
||||
params: { path: { key } },
|
||||
});
|
||||
|
||||
if (response.status === 409) throw new InUseError((error as { count?: number })?.count ?? 0);
|
||||
if (response.status !== 204) throw new Error("delete field failed");
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: ["field-definitions"] }),
|
||||
meta: { successMessage: "toast.deleted", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
||||
|
||||
import { api } from "../client";
|
||||
import type { components } from "../schema";
|
||||
import { keys } from "../query-keys";
|
||||
|
||||
type UserView = components["schemas"]["UserView"];
|
||||
type LoginRequest = components["schemas"]["LoginRequest"];
|
||||
|
||||
export function useMe() {
|
||||
return useQuery({
|
||||
queryKey: keys.me(),
|
||||
queryFn: async (): Promise<UserView | null> => {
|
||||
const { data, response } = await api.GET("/api/admin/me");
|
||||
|
||||
if (response.status === 401) return null;
|
||||
|
||||
if (!data) throw new Error("failed to load session");
|
||||
|
||||
return data;
|
||||
},
|
||||
retry: false,
|
||||
});
|
||||
}
|
||||
|
||||
export function useLogin() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async (body: LoginRequest) => {
|
||||
const { response } = await api.POST("/api/admin/login", { body });
|
||||
|
||||
if (response.status !== 204) {
|
||||
throw new Error(response.status === 401 ? "invalid" : "network");
|
||||
}
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: keys.me() }),
|
||||
meta: { suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useLogout() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async () => {
|
||||
await api.POST("/api/admin/logout");
|
||||
},
|
||||
onSuccess: () => qc.setQueryData(keys.me(), null),
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,93 @@
|
||||
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
||||
|
||||
import { api } from "../client";
|
||||
import type { components } from "../schema";
|
||||
import { HttpError, InUseError } from "../errors";
|
||||
import { keys } from "../query-keys";
|
||||
|
||||
type LabelInput = components["schemas"]["LabelInput"];
|
||||
|
||||
export function useAuthorities(kind: string | null | undefined) {
|
||||
return useQuery({
|
||||
queryKey: keys.authorities(kind),
|
||||
enabled: !!kind,
|
||||
queryFn: async () => {
|
||||
const { data, error } = await api.GET("/api/admin/authorities", {
|
||||
params: { query: { kind: kind! } },
|
||||
});
|
||||
|
||||
if (error || !data) throw new Error("failed to load authorities");
|
||||
|
||||
return data;
|
||||
},
|
||||
staleTime: 5 * 60 * 1000,
|
||||
});
|
||||
}
|
||||
|
||||
export function useCreateAuthority() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({
|
||||
kind,
|
||||
external_uri,
|
||||
labels,
|
||||
}: {
|
||||
kind: string;
|
||||
external_uri: string | null;
|
||||
labels: LabelInput[];
|
||||
}) => {
|
||||
const { response } = await api.POST("/api/admin/authorities", {
|
||||
body: { kind, external_uri, labels },
|
||||
});
|
||||
|
||||
if (response.status !== 201) throw new HttpError(response.status);
|
||||
},
|
||||
onSuccess: (_result, { kind }) =>
|
||||
qc.invalidateQueries({ queryKey: keys.authorities(kind) }),
|
||||
meta: { successMessage: "toast.created", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useUpdateAuthority() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({
|
||||
id,
|
||||
external_uri,
|
||||
labels,
|
||||
}: {
|
||||
id: string;
|
||||
kind: string;
|
||||
external_uri: string | null;
|
||||
labels: LabelInput[];
|
||||
}) => {
|
||||
const { response } = await api.PATCH("/api/admin/authorities/{id}", {
|
||||
params: { path: { id } },
|
||||
body: { external_uri, labels },
|
||||
});
|
||||
|
||||
if (response.status !== 204) throw new HttpError(response.status);
|
||||
},
|
||||
onSuccess: (_d, { kind }) => qc.invalidateQueries({ queryKey: keys.authorities(kind) }),
|
||||
meta: { successMessage: "toast.saved", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useDeleteAuthority() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({ id }: { id: string; kind: string }) => {
|
||||
const { error, response } = await api.DELETE("/api/admin/authorities/{id}", {
|
||||
params: { path: { id } },
|
||||
});
|
||||
|
||||
if (response.status === 409) throw new InUseError((error as { count?: number })?.count ?? 0);
|
||||
if (response.status !== 204) throw new HttpError(response.status);
|
||||
},
|
||||
onSuccess: (_d, { kind }) => qc.invalidateQueries({ queryKey: keys.authorities(kind) }),
|
||||
meta: { successMessage: "toast.deleted", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,83 @@
|
||||
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
||||
|
||||
import { api } from "../client";
|
||||
import type { components } from "../schema";
|
||||
import { HttpError, InUseError } from "../errors";
|
||||
import { keys } from "../query-keys";
|
||||
|
||||
type NewFieldDefinitionRequest = components["schemas"]["NewFieldDefinitionRequest"];
|
||||
type LabelInput = components["schemas"]["LabelInput"];
|
||||
|
||||
export function useFieldDefinitions() {
|
||||
return useQuery({
|
||||
queryKey: keys.fieldDefinitions(),
|
||||
queryFn: async () => {
|
||||
const { data, error } = await api.GET("/api/admin/field-definitions");
|
||||
|
||||
if (error || !data) throw new Error("failed to load field definitions");
|
||||
|
||||
return data;
|
||||
},
|
||||
staleTime: 5 * 60 * 1000,
|
||||
});
|
||||
}
|
||||
|
||||
export function useCreateFieldDefinition() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async (body: NewFieldDefinitionRequest) => {
|
||||
const { data, response } = await api.POST("/api/admin/field-definitions", { body });
|
||||
|
||||
if (response.status !== 201 || !data) throw new HttpError(response.status);
|
||||
|
||||
return data;
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: keys.fieldDefinitions() }),
|
||||
meta: { successMessage: "toast.created", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useUpdateFieldDefinition() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({
|
||||
key,
|
||||
required,
|
||||
group,
|
||||
labels,
|
||||
}: {
|
||||
key: string;
|
||||
required: boolean;
|
||||
group: string | null;
|
||||
labels: LabelInput[];
|
||||
}) => {
|
||||
const { response } = await api.PATCH("/api/admin/field-definitions/{key}", {
|
||||
params: { path: { key } },
|
||||
body: { required, group, labels },
|
||||
});
|
||||
|
||||
if (response.status !== 204) throw new HttpError(response.status);
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: keys.fieldDefinitions() }),
|
||||
meta: { successMessage: "toast.saved", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useDeleteFieldDefinition() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async (key: string) => {
|
||||
const { error, response } = await api.DELETE("/api/admin/field-definitions/{key}", {
|
||||
params: { path: { key } },
|
||||
});
|
||||
|
||||
if (response.status === 409) throw new InUseError((error as { count?: number })?.count ?? 0);
|
||||
if (response.status !== 204) throw new HttpError(response.status);
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: keys.fieldDefinitions() }),
|
||||
meta: { successMessage: "toast.deleted", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
export * from "./auth";
|
||||
export * from "./objects";
|
||||
export * from "./field-defs";
|
||||
export * from "./vocab";
|
||||
export * from "./authorities";
|
||||
export * from "./search";
|
||||
export * from "../errors";
|
||||
export type { ObjectListParams } from "../query-keys";
|
||||
@@ -0,0 +1,157 @@
|
||||
import { keepPreviousData, useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
||||
|
||||
import { api } from "../client";
|
||||
import type { components } from "../schema";
|
||||
import { HttpError, FieldRejection, VisibilityError } from "../errors";
|
||||
import { keys, type ObjectListParams } from "../query-keys";
|
||||
|
||||
type ObjectCreateRequest = components["schemas"]["ObjectCreateRequest"];
|
||||
type ObjectUpdateRequest = components["schemas"]["ObjectUpdateRequest"];
|
||||
type Visibility = "draft" | "internal" | "public";
|
||||
|
||||
export function useObjectsPage(params: ObjectListParams) {
|
||||
return useQuery({
|
||||
queryKey: keys.objectsPage(params),
|
||||
placeholderData: keepPreviousData,
|
||||
queryFn: async () => {
|
||||
const { data, error } = await api.GET("/api/admin/objects", {
|
||||
params: {
|
||||
query: {
|
||||
limit: params.limit,
|
||||
offset: params.offset,
|
||||
sort: params.sort,
|
||||
order: params.order,
|
||||
visibility: params.visibility,
|
||||
q: params.q,
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
if (error || !data) throw new Error("failed to load objects");
|
||||
|
||||
return data;
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
export function useObject(id: string) {
|
||||
return useQuery({
|
||||
queryKey: keys.object(id),
|
||||
queryFn: async () => {
|
||||
const { data, response } = await api.GET("/api/admin/objects/{id}", {
|
||||
params: { path: { id } },
|
||||
});
|
||||
|
||||
if (response.status === 404) return null;
|
||||
|
||||
if (!data) throw new Error("failed to load object");
|
||||
|
||||
return data;
|
||||
},
|
||||
// A 404 resolves to null rather than erroring, so don't retry it.
|
||||
retry: false,
|
||||
});
|
||||
}
|
||||
|
||||
export function useCreateObject() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async (body: ObjectCreateRequest) => {
|
||||
const { data, error, response } = await api.POST("/api/admin/objects", { body });
|
||||
|
||||
if (error || !data) throw new HttpError(response.status);
|
||||
|
||||
return data;
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: keys.objects() }),
|
||||
meta: { successMessage: "toast.created", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useUpdateObject() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({ id, body }: { id: string; body: ObjectUpdateRequest }) => {
|
||||
const { response } = await api.PUT("/api/admin/objects/{id}", {
|
||||
params: { path: { id } },
|
||||
body,
|
||||
});
|
||||
|
||||
if (response.status !== 204) throw new HttpError(response.status);
|
||||
},
|
||||
onSuccess: (_d, { id }) => {
|
||||
void qc.invalidateQueries({ queryKey: keys.objects() });
|
||||
void qc.invalidateQueries({ queryKey: keys.object(id) });
|
||||
void qc.invalidateQueries({ queryKey: keys.search() });
|
||||
},
|
||||
meta: { successMessage: "toast.saved", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useSetFields() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({ id, fields }: { id: string; fields: Record<string, unknown> }) => {
|
||||
const { response, error } = await api.PUT("/api/admin/objects/{id}/fields", {
|
||||
params: { path: { id } },
|
||||
body: fields as Record<string, never>,
|
||||
});
|
||||
|
||||
if (response.status === 204) return;
|
||||
|
||||
if (response.status === 422 && error && typeof error === "object" && "field" in error) {
|
||||
const detail = error as { field: string; code: string };
|
||||
throw new FieldRejection(detail.field, detail.code);
|
||||
}
|
||||
|
||||
throw new HttpError(response.status);
|
||||
},
|
||||
onSuccess: (_d, { id }) => {
|
||||
void qc.invalidateQueries({ queryKey: keys.object(id) });
|
||||
},
|
||||
meta: { suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useDeleteObject() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async (id: string) => {
|
||||
const { response } = await api.DELETE("/api/admin/objects/{id}", {
|
||||
params: { path: { id } },
|
||||
});
|
||||
|
||||
if (response.status !== 204) throw new HttpError(response.status);
|
||||
},
|
||||
onSuccess: () => {
|
||||
void qc.invalidateQueries({ queryKey: keys.objects() });
|
||||
void qc.invalidateQueries({ queryKey: keys.search() });
|
||||
},
|
||||
meta: { successMessage: "toast.deleted", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useSetVisibility() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({ id, visibility }: { id: string; visibility: Visibility }) => {
|
||||
const { response } = await api.POST("/api/admin/objects/{id}/visibility", {
|
||||
params: { path: { id } },
|
||||
body: { visibility },
|
||||
});
|
||||
|
||||
if (response.status !== 204) throw new VisibilityError(response.status);
|
||||
},
|
||||
onSuccess: (_result, { id }) => {
|
||||
void qc.invalidateQueries({ queryKey: keys.object(id) });
|
||||
void qc.invalidateQueries({ queryKey: keys.objects() });
|
||||
void qc.invalidateQueries({ queryKey: keys.search() });
|
||||
},
|
||||
meta: { successMessage: "toast.published", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
import { keepPreviousData, useInfiniteQuery } from "@tanstack/react-query";
|
||||
|
||||
import { api } from "../client";
|
||||
import { HttpError } from "../errors";
|
||||
import { keys } from "../query-keys";
|
||||
|
||||
const SEARCH_PAGE = 20;
|
||||
|
||||
export function useSearch(q: string, visibility: string | null) {
|
||||
const term = q.trim();
|
||||
|
||||
return useInfiniteQuery({
|
||||
queryKey: keys.searchResults(term, visibility),
|
||||
enabled: term.length > 0,
|
||||
initialPageParam: 0,
|
||||
queryFn: async ({ pageParam }) => {
|
||||
const { data, error, response } = await api.GET("/api/admin/search", {
|
||||
params: {
|
||||
query: {
|
||||
q: term,
|
||||
...(visibility ? { visibility } : {}),
|
||||
offset: pageParam,
|
||||
limit: SEARCH_PAGE,
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
if (error || !data) throw new HttpError(response.status);
|
||||
|
||||
return data;
|
||||
},
|
||||
placeholderData: keepPreviousData,
|
||||
getNextPageParam: (lastPage, allPages) => {
|
||||
const loaded = allPages.reduce((n, page) => n + page.hits.length, 0);
|
||||
|
||||
return loaded < lastPage.estimated_total ? loaded : undefined;
|
||||
},
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,160 @@
|
||||
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
||||
|
||||
import { api } from "../client";
|
||||
import type { components } from "../schema";
|
||||
import { HttpError, InUseError } from "../errors";
|
||||
import { keys } from "../query-keys";
|
||||
|
||||
type NewVocabularyRequest = components["schemas"]["NewVocabularyRequest"];
|
||||
type LabelInput = components["schemas"]["LabelInput"];
|
||||
|
||||
export function useVocabularies() {
|
||||
return useQuery({
|
||||
queryKey: keys.vocabularies(),
|
||||
queryFn: async () => {
|
||||
const { data, error } = await api.GET("/api/admin/vocabularies");
|
||||
|
||||
if (error || !data) throw new Error("failed to load vocabularies");
|
||||
|
||||
return data;
|
||||
},
|
||||
staleTime: 5 * 60 * 1000,
|
||||
});
|
||||
}
|
||||
|
||||
export function useCreateVocabulary() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async (body: NewVocabularyRequest) => {
|
||||
const { data, error, response } = await api.POST("/api/admin/vocabularies", { body });
|
||||
|
||||
if (error || !data) throw new HttpError(response.status);
|
||||
|
||||
return data;
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: keys.vocabularies() }),
|
||||
meta: { successMessage: "toast.created", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useRenameVocabulary() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({ id, key }: { id: string; key: string }) => {
|
||||
const { response } = await api.PATCH("/api/admin/vocabularies/{id}", {
|
||||
params: { path: { id } },
|
||||
body: { key },
|
||||
});
|
||||
|
||||
if (response.status !== 204) throw new HttpError(response.status);
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: keys.vocabularies() }),
|
||||
meta: { successMessage: "toast.renamed", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useDeleteVocabulary() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async (id: string) => {
|
||||
const { error, response } = await api.DELETE("/api/admin/vocabularies/{id}", {
|
||||
params: { path: { id } },
|
||||
});
|
||||
|
||||
if (response.status === 409) throw new InUseError((error as { count?: number })?.count ?? 0);
|
||||
if (response.status !== 204) throw new HttpError(response.status);
|
||||
},
|
||||
onSuccess: () => qc.invalidateQueries({ queryKey: keys.vocabularies() }),
|
||||
meta: { successMessage: "toast.deleted", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useTerms(vocabularyId: string | null | undefined) {
|
||||
return useQuery({
|
||||
queryKey: keys.terms(vocabularyId),
|
||||
enabled: !!vocabularyId,
|
||||
queryFn: async () => {
|
||||
const { data, error } = await api.GET("/api/admin/vocabularies/{id}/terms", {
|
||||
params: { path: { id: vocabularyId! } },
|
||||
});
|
||||
|
||||
if (error || !data) throw new Error("failed to load terms");
|
||||
|
||||
return data;
|
||||
},
|
||||
staleTime: 5 * 60 * 1000,
|
||||
});
|
||||
}
|
||||
|
||||
export function useAddTerm() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({
|
||||
vocabularyId,
|
||||
external_uri,
|
||||
labels,
|
||||
}: {
|
||||
vocabularyId: string;
|
||||
external_uri: string | null;
|
||||
labels: LabelInput[];
|
||||
}) => {
|
||||
const { response } = await api.POST("/api/admin/vocabularies/{id}/terms", {
|
||||
params: { path: { id: vocabularyId } },
|
||||
body: { external_uri, labels },
|
||||
});
|
||||
|
||||
if (response.status !== 201) throw new HttpError(response.status);
|
||||
},
|
||||
onSuccess: (_result, { vocabularyId }) =>
|
||||
qc.invalidateQueries({ queryKey: keys.terms(vocabularyId) }),
|
||||
meta: { successMessage: "toast.created", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useUpdateTerm() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({
|
||||
vocabularyId,
|
||||
termId,
|
||||
external_uri,
|
||||
labels,
|
||||
}: {
|
||||
vocabularyId: string;
|
||||
termId: string;
|
||||
external_uri: string | null;
|
||||
labels: LabelInput[];
|
||||
}) => {
|
||||
const { response } = await api.PATCH("/api/admin/vocabularies/{id}/terms/{term_id}", {
|
||||
params: { path: { id: vocabularyId, term_id: termId } },
|
||||
body: { external_uri, labels },
|
||||
});
|
||||
|
||||
if (response.status !== 204) throw new HttpError(response.status);
|
||||
},
|
||||
onSuccess: (_d, { vocabularyId }) => qc.invalidateQueries({ queryKey: keys.terms(vocabularyId) }),
|
||||
meta: { successMessage: "toast.saved", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
|
||||
export function useDeleteTerm() {
|
||||
const qc = useQueryClient();
|
||||
|
||||
return useMutation({
|
||||
mutationFn: async ({ vocabularyId, termId }: { vocabularyId: string; termId: string }) => {
|
||||
const { error, response } = await api.DELETE("/api/admin/vocabularies/{id}/terms/{term_id}", {
|
||||
params: { path: { id: vocabularyId, term_id: termId } },
|
||||
});
|
||||
|
||||
if (response.status === 409) throw new InUseError((error as { count?: number })?.count ?? 0);
|
||||
if (response.status !== 204) throw new HttpError(response.status);
|
||||
},
|
||||
onSuccess: (_d, { vocabularyId }) => qc.invalidateQueries({ queryKey: keys.terms(vocabularyId) }),
|
||||
meta: { successMessage: "toast.deleted", suppressErrorToast: true },
|
||||
});
|
||||
}
|
||||
@@ -6,20 +6,15 @@ import {
|
||||
|
||||
import i18n from "../i18n";
|
||||
import { toastManager } from "../toast/toast-manager";
|
||||
import { HttpError, InUseError } from "./queries";
|
||||
import { errorMessageKey } from "./error-message";
|
||||
|
||||
function mutationErrorMessage(
|
||||
error: unknown,
|
||||
meta: MutationMeta | undefined,
|
||||
): string {
|
||||
if (meta?.errorMessage) return i18n.t(meta.errorMessage);
|
||||
if (error instanceof InUseError) {
|
||||
return i18n.t("actions.inUse", { count: error.count });
|
||||
}
|
||||
if (error instanceof HttpError && error.status === 503) {
|
||||
return i18n.t("search.unavailable");
|
||||
}
|
||||
return i18n.t("toast.error");
|
||||
const { key, opts } = errorMessageKey(error);
|
||||
return i18n.t(key, opts);
|
||||
}
|
||||
|
||||
/** Builds the app's QueryClient, including the MutationCache that bridges every
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
import { expect, test } from "vitest";
|
||||
|
||||
import { keys } from "./query-keys";
|
||||
|
||||
test("the key factory produces the expected arrays", () => {
|
||||
expect(keys.me()).toEqual(["me"]);
|
||||
expect(keys.config()).toEqual(["config"]);
|
||||
expect(keys.objects()).toEqual(["objects"]);
|
||||
const p = { limit: 50, offset: 0 };
|
||||
expect(keys.objectsPage(p)).toEqual(["objects", p]);
|
||||
expect(keys.object("x")).toEqual(["object", "x"]);
|
||||
expect(keys.fieldDefinitions()).toEqual(["field-definitions"]);
|
||||
expect(keys.vocabularies()).toEqual(["vocabularies"]);
|
||||
expect(keys.terms("v1")).toEqual(["terms", "v1"]);
|
||||
expect(keys.authorities("person")).toEqual(["authorities", "person"]);
|
||||
expect(keys.search()).toEqual(["search"]);
|
||||
expect(keys.searchResults("q", null)).toEqual(["search", "q", null]);
|
||||
});
|
||||
|
||||
test("objects() is a prefix of objectsPage() so invalidation matches", () => {
|
||||
const prefix = keys.objects();
|
||||
const full = keys.objectsPage({ limit: 50, offset: 0 });
|
||||
expect(full.slice(0, prefix.length)).toEqual(prefix);
|
||||
});
|
||||
@@ -0,0 +1,24 @@
|
||||
export type ObjectListParams = {
|
||||
limit: number;
|
||||
offset: number;
|
||||
sort?: string;
|
||||
order?: "asc" | "desc";
|
||||
visibility?: string;
|
||||
q?: string;
|
||||
};
|
||||
|
||||
/** Central query-key factory — the single source of truth for cache keys, so
|
||||
* query/invalidate/setQueryData sites can't drift. */
|
||||
export const keys = {
|
||||
me: () => ["me"] as const,
|
||||
config: () => ["config"] as const,
|
||||
objects: () => ["objects"] as const,
|
||||
objectsPage: (params: ObjectListParams) => ["objects", params] as const,
|
||||
object: (id: string) => ["object", id] as const,
|
||||
fieldDefinitions: () => ["field-definitions"] as const,
|
||||
vocabularies: () => ["vocabularies"] as const,
|
||||
terms: (vocabularyId: string | null | undefined) => ["terms", vocabularyId] as const,
|
||||
authorities: (kind: string | null | undefined) => ["authorities", kind] as const,
|
||||
search: () => ["search"] as const,
|
||||
searchResults: (term: string, visibility: string | null) => ["search", term, visibility] as const,
|
||||
};
|
||||
@@ -0,0 +1,28 @@
|
||||
import { expect, test } from "vitest";
|
||||
import { renderHook, waitFor } from "@testing-library/react";
|
||||
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
||||
import { http, HttpResponse } from "msw";
|
||||
import type { ReactNode } from "react";
|
||||
|
||||
import { server } from "../test/server";
|
||||
import { useSetVisibility } from "./queries";
|
||||
import { keys } from "./query-keys";
|
||||
|
||||
test("changing an object's visibility invalidates the active search query", async () => {
|
||||
server.use(
|
||||
http.post("/api/admin/objects/:id/visibility", () => new HttpResponse(null, { status: 204 })),
|
||||
);
|
||||
const qc = new QueryClient({ defaultOptions: { queries: { retry: false } } });
|
||||
qc.setQueryData(keys.searchResults("amphora", null), { pages: [], pageParams: [] });
|
||||
|
||||
const wrapper = ({ children }: { children: ReactNode }) => (
|
||||
<QueryClientProvider client={qc}>{children}</QueryClientProvider>
|
||||
);
|
||||
const { result } = renderHook(() => useSetVisibility(), { wrapper });
|
||||
|
||||
await result.current.mutateAsync({ id: "o1", visibility: "public" });
|
||||
|
||||
await waitFor(() =>
|
||||
expect(qc.getQueryState(keys.searchResults("amphora", null))?.isInvalidated).toBe(true),
|
||||
);
|
||||
});
|
||||
@@ -7,6 +7,7 @@ import { useConfig } from "../config/config-context";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { Label } from "@/components/ui/label";
|
||||
import { PageTitle } from "@/components/ui/page-title";
|
||||
|
||||
/** Accept only a single-leading-slash local path; reject protocol-relative
|
||||
* ("//host") and absolute URLs to avoid an open redirect. */
|
||||
@@ -46,7 +47,7 @@ export function LoginPage() {
|
||||
return (
|
||||
<div className="flex min-h-screen items-center justify-center p-4">
|
||||
<form onSubmit={onSubmit} className="w-full max-w-sm space-y-4">
|
||||
<h1 className="text-2xl font-semibold">{app_name}</h1>
|
||||
<PageTitle>{app_name}</PageTitle>
|
||||
{sessionExpired && (
|
||||
<p className="text-sm text-muted-foreground">{t("auth.sessionExpired")}</p>
|
||||
)}
|
||||
|
||||
@@ -1,31 +1,22 @@
|
||||
import { useState, type FormEvent } from "react";
|
||||
import { NavLink, Navigate, useParams } from "react-router-dom";
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import type { components } from "../api/schema";
|
||||
import { useAuthorities, useCreateAuthority } from "../api/queries";
|
||||
import { LabelEditor } from "../components/label-editor";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { Label } from "@/components/ui/label";
|
||||
import { FilteredRecordList } from "../components/filtered-record-list";
|
||||
import { LabelledRecordCreateForm } from "../components/labelled-record-create-form";
|
||||
import { PageTitle } from "@/components/ui/page-title";
|
||||
import { ListSkeleton } from "@/components/ui/skeletons";
|
||||
import { AuthorityRow } from "./authority-row";
|
||||
import { byLabel } from "../lib/sort";
|
||||
import { labelText } from "../lib/labels";
|
||||
import { focusRing } from "../lib/focus-ring";
|
||||
import { useLang } from "../lib/use-lang";
|
||||
import { segmentClass } from "../lib/class-recipes";
|
||||
import { useDocumentTitle } from "../lib/use-document-title";
|
||||
import { useBreadcrumb } from "../shell/use-breadcrumb";
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
type LabelInput = components["schemas"]["LabelInput"];
|
||||
|
||||
const KINDS = ["person", "organisation", "place"] as const;
|
||||
|
||||
export function AuthoritiesPage() {
|
||||
const { t, i18n } = useTranslation();
|
||||
const { t } = useTranslation();
|
||||
const { kind } = useParams();
|
||||
const lang = i18n.language.startsWith("sv") ? "sv" : "en";
|
||||
const lang = useLang();
|
||||
|
||||
const isValidKind = (KINDS as readonly string[]).includes(kind ?? "");
|
||||
const currentKind = isValidKind ? (kind as string) : "person";
|
||||
@@ -33,36 +24,11 @@ export function AuthoritiesPage() {
|
||||
const { data: authorities, isLoading, isError } = useAuthorities(currentKind);
|
||||
const create = useCreateAuthority();
|
||||
|
||||
const [labels, setLabels] = useState<LabelInput[]>([]);
|
||||
const [error, setError] = useState(false);
|
||||
const [filter, setFilter] = useState("");
|
||||
const [uri, setUri] = useState("");
|
||||
|
||||
useDocumentTitle(t("nav.authorities"));
|
||||
useBreadcrumb([{ label: t("nav.authorities") }]);
|
||||
|
||||
if (!isValidKind) return <Navigate to="/authorities/person" replace />;
|
||||
|
||||
const onCreate = (event: FormEvent) => {
|
||||
event.preventDefault();
|
||||
|
||||
if (!labels.some((l) => l.label)) {
|
||||
setError(true);
|
||||
return;
|
||||
}
|
||||
|
||||
setError(false);
|
||||
create.mutate(
|
||||
{ kind: kind as string, external_uri: uri.trim() || null, labels },
|
||||
{
|
||||
onSuccess: () => {
|
||||
setLabels([]);
|
||||
setUri("");
|
||||
},
|
||||
},
|
||||
);
|
||||
};
|
||||
|
||||
return (
|
||||
<div className="overflow-auto p-4">
|
||||
<PageTitle className="mb-3">{t("nav.authorities")}</PageTitle>
|
||||
@@ -71,86 +37,31 @@ export function AuthoritiesPage() {
|
||||
<NavLink
|
||||
key={k}
|
||||
to={`/authorities/${k}`}
|
||||
className={({ isActive }) =>
|
||||
cn("rounded-md px-3 py-1 text-sm", focusRing, isActive ? "bg-primary text-primary-foreground" : "border")
|
||||
}
|
||||
className={({ isActive }) => segmentClass(isActive, "px-3 py-1 text-sm")}
|
||||
>
|
||||
{t(`authorities.${k}`)}
|
||||
</NavLink>
|
||||
))}
|
||||
</nav>
|
||||
|
||||
<div className="mb-3">
|
||||
<Input
|
||||
aria-label={t("common.filter")}
|
||||
placeholder={t("common.filter")}
|
||||
value={filter}
|
||||
onChange={(e) => setFilter(e.target.value)}
|
||||
/>
|
||||
</div>
|
||||
<FilteredRecordList
|
||||
records={authorities}
|
||||
lang={lang}
|
||||
isLoading={isLoading}
|
||||
isError={isError}
|
||||
loadErrorText={t("authorities.loadError")}
|
||||
emptyText={t("authorities.empty")}
|
||||
renderRow={(a) => <AuthorityRow authority={a} kind={currentKind} lang={lang} />}
|
||||
/>
|
||||
|
||||
{isLoading ? (
|
||||
<ListSkeleton className="mb-4" rows={5} />
|
||||
) : (
|
||||
(() => {
|
||||
const q = filter.trim().toLowerCase();
|
||||
const rows = [...(authorities ?? [])]
|
||||
.filter((a) => !q || labelText(a.labels, lang).toLowerCase().includes(q))
|
||||
.sort(byLabel(lang));
|
||||
|
||||
return (
|
||||
<ul className="mb-4">
|
||||
{isError && (
|
||||
<li className="text-sm text-destructive">{t("authorities.loadError")}</li>
|
||||
)}
|
||||
{!isError && authorities?.length === 0 && (
|
||||
<li className="text-sm text-muted-foreground">{t("authorities.empty")}</li>
|
||||
)}
|
||||
{!isError && authorities && authorities.length > 0 && rows.length === 0 && (
|
||||
<li className="text-sm text-muted-foreground">{t("common.noMatches")}</li>
|
||||
)}
|
||||
{rows.map((a) => (
|
||||
<AuthorityRow key={a.id} authority={a} kind={currentKind} lang={lang} />
|
||||
))}
|
||||
</ul>
|
||||
);
|
||||
})()
|
||||
)}
|
||||
|
||||
<form onSubmit={onCreate} className="space-y-2 border-t pt-3">
|
||||
<div className="text-sm font-medium">
|
||||
{t("authorities.new")} · {t(`authorities.${currentKind}`)}
|
||||
</div>
|
||||
|
||||
<LabelEditor value={labels} onChange={setLabels} />
|
||||
|
||||
<div className="space-y-1">
|
||||
<Label htmlFor="auth-create-uri">{t("labels.externalUri")}</Label>
|
||||
<Input
|
||||
id="auth-create-uri"
|
||||
type="url"
|
||||
placeholder={t("labels.uriPlaceholder")}
|
||||
value={uri}
|
||||
onChange={(e) => setUri(e.target.value)}
|
||||
/>
|
||||
</div>
|
||||
|
||||
{error && (
|
||||
<p role="alert" className="text-xs text-destructive">
|
||||
{t("form.required")}
|
||||
</p>
|
||||
)}
|
||||
|
||||
{create.isError && (
|
||||
<p role="alert" className="text-xs text-destructive">
|
||||
{t("form.rejected")}
|
||||
</p>
|
||||
)}
|
||||
|
||||
<Button type="submit" size="sm" disabled={create.isPending}>
|
||||
{t("authorities.create")}
|
||||
</Button>
|
||||
</form>
|
||||
<LabelledRecordCreateForm
|
||||
heading={`${t("authorities.new")} · ${t(`authorities.${currentKind}`)}`}
|
||||
submitLabel={t("authorities.create")}
|
||||
pending={create.isPending}
|
||||
error={create.error}
|
||||
onCreate={(labels, uri, reset) =>
|
||||
create.mutate({ kind: currentKind, external_uri: uri, labels }, { onSuccess: reset })}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -1,87 +1,24 @@
|
||||
import { useState } from "react";
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import type { components } from "../api/schema";
|
||||
import { useUpdateAuthority, useDeleteAuthority } from "../api/queries";
|
||||
import { LabelEditor } from "../components/label-editor";
|
||||
import { DeleteConfirmDialog } from "../components/delete-confirm-dialog";
|
||||
import { ExternalUriLink } from "../components/external-uri-link";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { Label } from "@/components/ui/label";
|
||||
import { labelText } from "../lib/labels";
|
||||
import { LabelledRecordRow } from "../components/labelled-record-row";
|
||||
|
||||
type AuthorityView = components["schemas"]["AuthorityView"];
|
||||
type LabelInput = components["schemas"]["LabelInput"];
|
||||
|
||||
export function AuthorityRow({ authority, kind, lang }: { authority: AuthorityView; kind: string; lang: string }) {
|
||||
const { t } = useTranslation();
|
||||
|
||||
const updateAuthority = useUpdateAuthority();
|
||||
const deleteAuthority = useDeleteAuthority();
|
||||
|
||||
const [editing, setEditing] = useState(false);
|
||||
const [labels, setLabels] = useState<LabelInput[]>(authority.labels as LabelInput[]);
|
||||
const [uri, setUri] = useState(authority.external_uri ?? "");
|
||||
|
||||
if (editing) {
|
||||
return (
|
||||
<li className="space-y-2 border-b py-2">
|
||||
<LabelEditor value={labels} onChange={setLabels} />
|
||||
<div className="space-y-1">
|
||||
<Label htmlFor={`auth-uri-${authority.id}`}>{t("labels.externalUri")}</Label>
|
||||
<Input
|
||||
id={`auth-uri-${authority.id}`}
|
||||
type="url"
|
||||
placeholder={t("labels.uriPlaceholder")}
|
||||
value={uri}
|
||||
onChange={(e) => setUri(e.target.value)}
|
||||
/>
|
||||
</div>
|
||||
<div className="flex gap-2">
|
||||
<Button
|
||||
type="button"
|
||||
size="sm"
|
||||
disabled={updateAuthority.isPending}
|
||||
onClick={() =>
|
||||
updateAuthority.mutate(
|
||||
{ id: authority.id, kind, external_uri: uri.trim() || null, labels },
|
||||
{ onSuccess: () => setEditing(false) },
|
||||
)
|
||||
}
|
||||
>
|
||||
{t("actions.save")}
|
||||
</Button>
|
||||
<Button type="button" variant="ghost" size="sm" onClick={() => setEditing(false)}>
|
||||
{t("form.cancel")}
|
||||
</Button>
|
||||
</div>
|
||||
</li>
|
||||
);
|
||||
}
|
||||
const update = useUpdateAuthority();
|
||||
const del = useDeleteAuthority();
|
||||
|
||||
return (
|
||||
<li className="flex items-center gap-2 border-b py-1 text-sm">
|
||||
<div className="flex-1">
|
||||
<div>{labelText(authority.labels, lang)}</div>
|
||||
{authority.external_uri && <ExternalUriLink uri={authority.external_uri} />}
|
||||
</div>
|
||||
<Button
|
||||
type="button"
|
||||
variant="ghost"
|
||||
size="sm"
|
||||
onClick={() => {
|
||||
setLabels(authority.labels as LabelInput[]);
|
||||
setUri(authority.external_uri ?? "");
|
||||
setEditing(true);
|
||||
}}
|
||||
>
|
||||
{t("actions.edit")}
|
||||
</Button>
|
||||
<DeleteConfirmDialog
|
||||
description={t("actions.confirmDeleteAuthority")}
|
||||
onConfirm={() => deleteAuthority.mutateAsync({ id: authority.id, kind })}
|
||||
/>
|
||||
</li>
|
||||
<LabelledRecordRow
|
||||
record={{ ...authority, external_uri: authority.external_uri ?? null }}
|
||||
lang={lang}
|
||||
deleteConfirmKey="actions.confirmDeleteAuthority"
|
||||
savePending={update.isPending}
|
||||
saveError={update.error}
|
||||
onEditOpen={() => update.reset()}
|
||||
onSave={(labels, uri, done) =>
|
||||
update.mutate({ id: authority.id, kind, external_uri: uri, labels }, { onSuccess: done })}
|
||||
onDelete={() => del.mutateAsync({ id: authority.id, kind })}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { useState } from "react";
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import { InUseError } from "../api/queries";
|
||||
import { errorMessageKey } from "../api/error-message";
|
||||
import {
|
||||
AlertDialog,
|
||||
AlertDialogTrigger,
|
||||
@@ -37,7 +37,8 @@ export function DeleteConfirmDialog({
|
||||
} catch (err) {
|
||||
// Keep the dialog open; show the blocking reason. Never let the rejected
|
||||
// mutation escape as an unhandled rejection.
|
||||
setMessage(err instanceof InUseError ? t("actions.inUse", { count: err.count }) : t("form.rejected"));
|
||||
const { key, opts } = errorMessageKey(err);
|
||||
setMessage(t(key, opts));
|
||||
return;
|
||||
}
|
||||
setOpen(false);
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
import { expect, test } from "vitest";
|
||||
import { screen } from "@testing-library/react";
|
||||
import userEvent from "@testing-library/user-event";
|
||||
|
||||
import { renderApp } from "../test/render";
|
||||
import { FilteredRecordList } from "./filtered-record-list";
|
||||
import { labelText } from "../lib/labels";
|
||||
|
||||
type Rec = { id: string; labels: { lang: string; label: string }[] };
|
||||
const recs: Rec[] = [
|
||||
{ id: "a", labels: [{ lang: "en", label: "Alpha" }] },
|
||||
{ id: "b", labels: [{ lang: "en", label: "Beta" }] },
|
||||
];
|
||||
const row = (r: Rec) => <li>{labelText(r.labels, "en")}</li>;
|
||||
|
||||
test("filtering narrows the rendered rows", async () => {
|
||||
renderApp(
|
||||
<FilteredRecordList records={recs} lang="en" isLoading={false} isError={false}
|
||||
loadErrorText="LoadErr" emptyText="EmptyMsg" renderRow={row} />,
|
||||
);
|
||||
expect(screen.getByText("Alpha")).toBeInTheDocument();
|
||||
expect(screen.getByText("Beta")).toBeInTheDocument();
|
||||
await userEvent.type(screen.getByLabelText(/filter/i), "alph");
|
||||
expect(screen.getByText("Alpha")).toBeInTheDocument();
|
||||
expect(screen.queryByText("Beta")).toBeNull();
|
||||
});
|
||||
|
||||
test("empty records show the empty text", () => {
|
||||
renderApp(
|
||||
<FilteredRecordList records={[]} lang="en" isLoading={false} isError={false}
|
||||
loadErrorText="LoadErr" emptyText="EmptyMsg" renderRow={row} />,
|
||||
);
|
||||
expect(screen.getByText("EmptyMsg")).toBeInTheDocument();
|
||||
});
|
||||
|
||||
test("non-empty records with a non-matching filter show no-matches", async () => {
|
||||
renderApp(
|
||||
<FilteredRecordList records={recs} lang="en" isLoading={false} isError={false}
|
||||
loadErrorText="LoadErr" emptyText="EmptyMsg" renderRow={row} />,
|
||||
);
|
||||
await userEvent.type(screen.getByLabelText(/filter/i), "zzz");
|
||||
expect(screen.getByText(/no matches/i)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
test("an error shows the load-error text", () => {
|
||||
renderApp(
|
||||
<FilteredRecordList records={undefined} lang="en" isLoading={false} isError={true}
|
||||
loadErrorText="LoadErr" emptyText="EmptyMsg" renderRow={row} />,
|
||||
);
|
||||
expect(screen.getByText("LoadErr")).toBeInTheDocument();
|
||||
});
|
||||
@@ -0,0 +1,68 @@
|
||||
import { Fragment, useState, type ReactNode } from "react";
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import type { components } from "../api/schema";
|
||||
import { byLabel } from "../lib/sort";
|
||||
import { labelText } from "../lib/labels";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { ListSkeleton } from "@/components/ui/skeletons";
|
||||
|
||||
type LabelView = components["schemas"]["LabelView"];
|
||||
|
||||
/** Filterable, alphabetically-sorted list of labelled records with the standard
|
||||
* loading / error / empty / no-matches states. The filter input stays visible
|
||||
* during load (matching the prior page behaviour). */
|
||||
export function FilteredRecordList<T extends { id: string; labels: LabelView[] }>({
|
||||
records,
|
||||
lang,
|
||||
isLoading,
|
||||
isError,
|
||||
loadErrorText,
|
||||
emptyText,
|
||||
renderRow,
|
||||
}: {
|
||||
records: T[] | undefined;
|
||||
lang: string;
|
||||
isLoading: boolean;
|
||||
isError: boolean;
|
||||
loadErrorText: string;
|
||||
emptyText: string;
|
||||
renderRow: (record: T) => ReactNode;
|
||||
}) {
|
||||
const { t } = useTranslation();
|
||||
const [filter, setFilter] = useState("");
|
||||
|
||||
const q = filter.trim().toLowerCase();
|
||||
const rows = [...(records ?? [])]
|
||||
.filter((r) => !q || labelText(r.labels, lang).toLowerCase().includes(q))
|
||||
.sort(byLabel(lang));
|
||||
|
||||
return (
|
||||
<>
|
||||
<div className="mb-3">
|
||||
<Input
|
||||
aria-label={t("common.filter")}
|
||||
placeholder={t("common.filter")}
|
||||
value={filter}
|
||||
onChange={(e) => setFilter(e.target.value)}
|
||||
/>
|
||||
</div>
|
||||
{isLoading ? (
|
||||
<ListSkeleton className="mb-4" rows={5} />
|
||||
) : (
|
||||
<ul className="mb-4">
|
||||
{isError && <li className="text-sm text-destructive">{loadErrorText}</li>}
|
||||
{!isError && records?.length === 0 && (
|
||||
<li className="text-sm text-muted-foreground">{emptyText}</li>
|
||||
)}
|
||||
{!isError && records && records.length > 0 && rows.length === 0 && (
|
||||
<li className="text-sm text-muted-foreground">{t("common.noMatches")}</li>
|
||||
)}
|
||||
{rows.map((r) => (
|
||||
<Fragment key={r.id}>{renderRow(r)}</Fragment>
|
||||
))}
|
||||
</ul>
|
||||
)}
|
||||
</>
|
||||
);
|
||||
}
|
||||
@@ -85,3 +85,16 @@ test("no hint when only the default-language label exists", () => {
|
||||
renderApp(<Harness initial={[{ lang: "sv", label: "Brons" }]} />);
|
||||
expect(screen.queryByText(/other languages/i)).not.toBeInTheDocument();
|
||||
});
|
||||
|
||||
test("each LabelEditor instance gets a unique input id", () => {
|
||||
renderApp(
|
||||
<>
|
||||
<LabelEditor value={[]} onChange={() => {}} />
|
||||
<LabelEditor value={[]} onChange={() => {}} />
|
||||
</>,
|
||||
);
|
||||
const inputs = screen.getAllByLabelText(/label/i);
|
||||
expect(inputs).toHaveLength(2);
|
||||
expect(inputs[0].id).not.toBe("");
|
||||
expect(inputs[0].id).not.toBe(inputs[1].id);
|
||||
});
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import { useId } from "react";
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import type { components } from "../api/schema";
|
||||
@@ -19,6 +20,7 @@ export function LabelEditor({
|
||||
onChange: (labels: LabelInput[]) => void;
|
||||
}) {
|
||||
const { t } = useTranslation();
|
||||
const inputId = useId();
|
||||
const { default_language } = useConfig();
|
||||
|
||||
const current = value.find((l) => l.lang === default_language)?.label ?? "";
|
||||
@@ -32,8 +34,8 @@ export function LabelEditor({
|
||||
|
||||
return (
|
||||
<div className="space-y-1">
|
||||
<Label htmlFor="label">{t("labels.label")}</Label>
|
||||
<Input id="label" value={current} onChange={(e) => set(e.target.value)} />
|
||||
<Label htmlFor={inputId}>{t("labels.label")}</Label>
|
||||
<Input id={inputId} value={current} onChange={(e) => set(e.target.value)} />
|
||||
{hasOtherLanguages && (
|
||||
<p className="text-xs text-muted-foreground">{t("labels.otherLanguages")}</p>
|
||||
)}
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
import { expect, test, vi } from "vitest";
|
||||
import { screen } from "@testing-library/react";
|
||||
import userEvent from "@testing-library/user-event";
|
||||
|
||||
import { renderApp } from "../test/render";
|
||||
import { LabelledRecordCreateForm } from "./labelled-record-create-form";
|
||||
|
||||
test("submitting with empty labels shows the required error and does not call onCreate", async () => {
|
||||
const onCreate = vi.fn();
|
||||
renderApp(
|
||||
<LabelledRecordCreateForm heading="New" submitLabel="Create" pending={false} error={null} onCreate={onCreate} />,
|
||||
);
|
||||
await userEvent.click(screen.getByRole("button", { name: /create/i }));
|
||||
expect(screen.getByRole("alert")).toBeInTheDocument();
|
||||
expect(onCreate).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
test("a valid submit calls onCreate and the reset clears the inputs", async () => {
|
||||
const onCreate = vi.fn((_labels: unknown, _uri: unknown, reset: () => void) => reset());
|
||||
renderApp(
|
||||
<LabelledRecordCreateForm heading="New" submitLabel="Create" pending={false} error={null} onCreate={onCreate} />,
|
||||
);
|
||||
const labelInput = screen.getByLabelText(/^label$/i) as HTMLInputElement;
|
||||
await userEvent.type(labelInput, "Bronze");
|
||||
await userEvent.click(screen.getByRole("button", { name: /create/i }));
|
||||
expect(onCreate).toHaveBeenCalled();
|
||||
expect((screen.getByLabelText(/^label$/i) as HTMLInputElement).value).toBe("");
|
||||
});
|
||||
@@ -0,0 +1,76 @@
|
||||
import { useId, useState, type FormEvent, type ReactNode } from "react";
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import type { components } from "../api/schema";
|
||||
import { LabelEditor } from "./label-editor";
|
||||
import { MutationError } from "./mutation-error";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { Label } from "@/components/ui/label";
|
||||
|
||||
type LabelInput = components["schemas"]["LabelInput"];
|
||||
|
||||
/** Create form for a labelled record (term/authority): single-language label +
|
||||
* optional external URI, with required-label validation and a status-aware error.
|
||||
* `onCreate` performs the mutation and is handed a `reset` to clear the inputs on success. */
|
||||
export function LabelledRecordCreateForm({
|
||||
heading,
|
||||
submitLabel,
|
||||
pending,
|
||||
error,
|
||||
onCreate,
|
||||
}: {
|
||||
heading: ReactNode;
|
||||
submitLabel: string;
|
||||
pending: boolean;
|
||||
error: unknown;
|
||||
onCreate: (labels: LabelInput[], uri: string | null, reset: () => void) => void;
|
||||
}) {
|
||||
const { t } = useTranslation();
|
||||
const uriId = useId();
|
||||
|
||||
const [labels, setLabels] = useState<LabelInput[]>([]);
|
||||
const [uri, setUri] = useState("");
|
||||
const [requiredError, setRequiredError] = useState(false);
|
||||
|
||||
const onSubmit = (event: FormEvent) => {
|
||||
event.preventDefault();
|
||||
|
||||
if (!labels.some((l) => l.label)) {
|
||||
setRequiredError(true);
|
||||
return;
|
||||
}
|
||||
|
||||
setRequiredError(false);
|
||||
onCreate(labels, uri.trim() || null, () => {
|
||||
setLabels([]);
|
||||
setUri("");
|
||||
});
|
||||
};
|
||||
|
||||
return (
|
||||
<form onSubmit={onSubmit} className="space-y-2 border-t pt-3">
|
||||
<div className="text-sm font-medium">{heading}</div>
|
||||
<LabelEditor value={labels} onChange={setLabels} />
|
||||
<div className="space-y-1">
|
||||
<Label htmlFor={uriId}>{t("labels.externalUri")}</Label>
|
||||
<Input
|
||||
id={uriId}
|
||||
type="url"
|
||||
placeholder={t("labels.uriPlaceholder")}
|
||||
value={uri}
|
||||
onChange={(e) => setUri(e.target.value)}
|
||||
/>
|
||||
</div>
|
||||
{requiredError && (
|
||||
<p role="alert" className="text-xs text-destructive">
|
||||
{t("form.required")}
|
||||
</p>
|
||||
)}
|
||||
<MutationError error={error} />
|
||||
<Button type="submit" size="sm" disabled={pending}>
|
||||
{submitLabel}
|
||||
</Button>
|
||||
</form>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,74 @@
|
||||
import { expect, test, vi } from "vitest";
|
||||
import { screen, within } from "@testing-library/react";
|
||||
import userEvent from "@testing-library/user-event";
|
||||
|
||||
import { renderApp } from "../test/render";
|
||||
import { LabelledRecordRow, type RecordLike } from "./labelled-record-row";
|
||||
import { HttpError } from "../api/queries";
|
||||
|
||||
const record: RecordLike = { id: "r1", external_uri: null, labels: [{ lang: "en", label: "Bronze" }] };
|
||||
|
||||
test("edit → save calls onSave and closes via done()", async () => {
|
||||
const onSave = vi.fn((_labels: unknown, _uri: unknown, done: () => void) => done());
|
||||
renderApp(
|
||||
<ul>
|
||||
<LabelledRecordRow
|
||||
record={record}
|
||||
lang="en"
|
||||
deleteConfirmKey="actions.confirmDeleteTerm"
|
||||
savePending={false}
|
||||
saveError={null}
|
||||
onEditOpen={() => {}}
|
||||
onSave={onSave}
|
||||
onDelete={async () => {}}
|
||||
/>
|
||||
</ul>,
|
||||
);
|
||||
await userEvent.click(screen.getByRole("button", { name: /edit/i }));
|
||||
await userEvent.click(screen.getByRole("button", { name: /save/i }));
|
||||
expect(onSave).toHaveBeenCalled();
|
||||
expect(screen.queryByRole("button", { name: /save/i })).toBeNull();
|
||||
});
|
||||
|
||||
test("a save error renders inline and the row stays editable", async () => {
|
||||
renderApp(
|
||||
<ul>
|
||||
<LabelledRecordRow
|
||||
record={record}
|
||||
lang="en"
|
||||
deleteConfirmKey="actions.confirmDeleteTerm"
|
||||
savePending={false}
|
||||
saveError={new HttpError(403)}
|
||||
onEditOpen={() => {}}
|
||||
onSave={() => {}}
|
||||
onDelete={async () => {}}
|
||||
/>
|
||||
</ul>,
|
||||
);
|
||||
await userEvent.click(screen.getByRole("button", { name: /edit/i }));
|
||||
expect(screen.getByRole("alert")).toHaveTextContent(/permission/i);
|
||||
expect(screen.getByRole("button", { name: /save/i })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
test("confirming delete invokes onDelete", async () => {
|
||||
const onDelete = vi.fn(async () => {});
|
||||
renderApp(
|
||||
<ul>
|
||||
<LabelledRecordRow
|
||||
record={record}
|
||||
lang="en"
|
||||
deleteConfirmKey="actions.confirmDeleteTerm"
|
||||
savePending={false}
|
||||
saveError={null}
|
||||
onEditOpen={() => {}}
|
||||
onSave={() => {}}
|
||||
onDelete={onDelete}
|
||||
/>
|
||||
</ul>,
|
||||
);
|
||||
await userEvent.click(screen.getByRole("button", { name: /delete/i }));
|
||||
const dialog = within(document.body);
|
||||
const confirmButtons = await dialog.findAllByRole("button", { name: /delete/i });
|
||||
await userEvent.click(confirmButtons[confirmButtons.length - 1]);
|
||||
expect(onDelete).toHaveBeenCalled();
|
||||
});
|
||||
@@ -0,0 +1,102 @@
|
||||
import { useId, useState } from "react";
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import type { components } from "../api/schema";
|
||||
import { LabelEditor } from "./label-editor";
|
||||
import { DeleteConfirmDialog } from "./delete-confirm-dialog";
|
||||
import { MutationError } from "./mutation-error";
|
||||
import { ExternalUriLink } from "./external-uri-link";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { Label } from "@/components/ui/label";
|
||||
import { labelText } from "../lib/labels";
|
||||
|
||||
type LabelView = components["schemas"]["LabelView"];
|
||||
type LabelInput = components["schemas"]["LabelInput"];
|
||||
|
||||
export type RecordLike = { id: string; labels: LabelView[]; external_uri: string | null };
|
||||
|
||||
/** One labelled record (term/authority): a display row with edit + delete, or an
|
||||
* inline editor. All variance (mutation hooks, arg shapes, delete-confirm key) is
|
||||
* supplied by the caller via callbacks/state — see term-row.tsx / authority-row.tsx. */
|
||||
export function LabelledRecordRow({
|
||||
record,
|
||||
lang,
|
||||
deleteConfirmKey,
|
||||
savePending,
|
||||
saveError,
|
||||
onEditOpen,
|
||||
onSave,
|
||||
onDelete,
|
||||
}: {
|
||||
record: RecordLike;
|
||||
lang: string;
|
||||
deleteConfirmKey: string;
|
||||
savePending: boolean;
|
||||
saveError: unknown;
|
||||
onEditOpen: () => void;
|
||||
onSave: (labels: LabelInput[], uri: string | null, done: () => void) => void;
|
||||
onDelete: () => Promise<void>;
|
||||
}) {
|
||||
const { t } = useTranslation();
|
||||
const uriId = useId();
|
||||
|
||||
const [editing, setEditing] = useState(false);
|
||||
const [labels, setLabels] = useState<LabelInput[]>(record.labels as LabelInput[]);
|
||||
const [uri, setUri] = useState(record.external_uri ?? "");
|
||||
|
||||
if (editing) {
|
||||
return (
|
||||
<li className="space-y-2 border-b py-2">
|
||||
<LabelEditor value={labels} onChange={setLabels} />
|
||||
<div className="space-y-1">
|
||||
<Label htmlFor={uriId}>{t("labels.externalUri")}</Label>
|
||||
<Input
|
||||
id={uriId}
|
||||
type="url"
|
||||
placeholder={t("labels.uriPlaceholder")}
|
||||
value={uri}
|
||||
onChange={(e) => setUri(e.target.value)}
|
||||
/>
|
||||
</div>
|
||||
<div className="flex gap-2">
|
||||
<Button
|
||||
type="button"
|
||||
size="sm"
|
||||
disabled={savePending}
|
||||
onClick={() => onSave(labels, uri.trim() || null, () => setEditing(false))}
|
||||
>
|
||||
{t("actions.save")}
|
||||
</Button>
|
||||
<Button type="button" variant="ghost" size="sm" onClick={() => setEditing(false)}>
|
||||
{t("form.cancel")}
|
||||
</Button>
|
||||
</div>
|
||||
<MutationError error={saveError} />
|
||||
</li>
|
||||
);
|
||||
}
|
||||
|
||||
return (
|
||||
<li className="flex items-center gap-2 border-b py-1 text-sm">
|
||||
<div className="flex-1">
|
||||
<div>{labelText(record.labels, lang)}</div>
|
||||
{record.external_uri && <ExternalUriLink uri={record.external_uri} />}
|
||||
</div>
|
||||
<Button
|
||||
type="button"
|
||||
variant="ghost"
|
||||
size="sm"
|
||||
onClick={() => {
|
||||
onEditOpen();
|
||||
setLabels(record.labels as LabelInput[]);
|
||||
setUri(record.external_uri ?? "");
|
||||
setEditing(true);
|
||||
}}
|
||||
>
|
||||
{t("actions.edit")}
|
||||
</Button>
|
||||
<DeleteConfirmDialog description={t(deleteConfirmKey)} onConfirm={onDelete} />
|
||||
</li>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
import { expect, test } from "vitest";
|
||||
import { render, screen } from "@testing-library/react";
|
||||
|
||||
import "../i18n";
|
||||
import { MutationError } from "./mutation-error";
|
||||
import { HttpError, InUseError } from "../api/queries";
|
||||
|
||||
test("renders the status-specific message for an HttpError", () => {
|
||||
render(<MutationError error={new HttpError(403)} />);
|
||||
expect(screen.getByRole("alert")).toHaveTextContent(/permission/i);
|
||||
});
|
||||
|
||||
test("renders the in-use count for an InUseError", () => {
|
||||
render(<MutationError error={new InUseError(2)} />);
|
||||
expect(screen.getByRole("alert")).toHaveTextContent(/2/);
|
||||
});
|
||||
|
||||
test("renders nothing when there is no error", () => {
|
||||
const { container } = render(<MutationError error={null} />);
|
||||
expect(container).toBeEmptyDOMElement();
|
||||
});
|
||||
@@ -0,0 +1,16 @@
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import { errorMessageKey } from "../api/error-message";
|
||||
|
||||
/** Renders a caught mutation error as an inline alert, or nothing when error is falsy.
|
||||
* Replaces the duplicated `<p role="alert" className="text-xs text-destructive">` markup. */
|
||||
export function MutationError({ error }: { error: unknown }) {
|
||||
const { t } = useTranslation();
|
||||
if (!error) return null;
|
||||
const { key, opts } = errorMessageKey(error);
|
||||
return (
|
||||
<p role="alert" className="text-xs text-destructive">
|
||||
{t(key, opts)}
|
||||
</p>
|
||||
);
|
||||
}
|
||||
@@ -1,103 +0,0 @@
|
||||
import * as React from "react"
|
||||
|
||||
import { cn } from "@/lib/utils"
|
||||
|
||||
function Card({
|
||||
className,
|
||||
size = "default",
|
||||
...props
|
||||
}: React.ComponentProps<"div"> & { size?: "default" | "sm" }) {
|
||||
return (
|
||||
<div
|
||||
data-slot="card"
|
||||
data-size={size}
|
||||
className={cn(
|
||||
"group/card flex flex-col gap-4 overflow-hidden rounded-xl bg-card py-4 text-sm text-card-foreground ring-1 ring-foreground/10 has-data-[slot=card-footer]:pb-0 has-[>img:first-child]:pt-0 data-[size=sm]:gap-3 data-[size=sm]:py-3 data-[size=sm]:has-data-[slot=card-footer]:pb-0 *:[img:first-child]:rounded-t-xl *:[img:last-child]:rounded-b-xl",
|
||||
className
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
)
|
||||
}
|
||||
|
||||
function CardHeader({ className, ...props }: React.ComponentProps<"div">) {
|
||||
return (
|
||||
<div
|
||||
data-slot="card-header"
|
||||
className={cn(
|
||||
"group/card-header @container/card-header grid auto-rows-min items-start gap-1 rounded-t-xl px-4 group-data-[size=sm]/card:px-3 has-data-[slot=card-action]:grid-cols-[1fr_auto] has-data-[slot=card-description]:grid-rows-[auto_auto] [.border-b]:pb-4 group-data-[size=sm]/card:[.border-b]:pb-3",
|
||||
className
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
)
|
||||
}
|
||||
|
||||
function CardTitle({ className, ...props }: React.ComponentProps<"div">) {
|
||||
return (
|
||||
<div
|
||||
data-slot="card-title"
|
||||
className={cn(
|
||||
"text-base leading-snug font-medium group-data-[size=sm]/card:text-sm",
|
||||
className
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
)
|
||||
}
|
||||
|
||||
function CardDescription({ className, ...props }: React.ComponentProps<"div">) {
|
||||
return (
|
||||
<div
|
||||
data-slot="card-description"
|
||||
className={cn("text-sm text-muted-foreground", className)}
|
||||
{...props}
|
||||
/>
|
||||
)
|
||||
}
|
||||
|
||||
function CardAction({ className, ...props }: React.ComponentProps<"div">) {
|
||||
return (
|
||||
<div
|
||||
data-slot="card-action"
|
||||
className={cn(
|
||||
"col-start-2 row-span-2 row-start-1 self-start justify-self-end",
|
||||
className
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
)
|
||||
}
|
||||
|
||||
function CardContent({ className, ...props }: React.ComponentProps<"div">) {
|
||||
return (
|
||||
<div
|
||||
data-slot="card-content"
|
||||
className={cn("px-4 group-data-[size=sm]/card:px-3", className)}
|
||||
{...props}
|
||||
/>
|
||||
)
|
||||
}
|
||||
|
||||
function CardFooter({ className, ...props }: React.ComponentProps<"div">) {
|
||||
return (
|
||||
<div
|
||||
data-slot="card-footer"
|
||||
className={cn(
|
||||
"flex items-center rounded-b-xl border-t bg-muted/50 p-4 group-data-[size=sm]/card:p-3",
|
||||
className
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
)
|
||||
}
|
||||
|
||||
export {
|
||||
Card,
|
||||
CardHeader,
|
||||
CardFooter,
|
||||
CardTitle,
|
||||
CardAction,
|
||||
CardDescription,
|
||||
CardContent,
|
||||
}
|
||||
@@ -2,12 +2,13 @@ import { useEffect, type ReactNode } from "react";
|
||||
import { useQuery } from "@tanstack/react-query";
|
||||
|
||||
import { api } from "../api/client";
|
||||
import { keys } from "../api/query-keys";
|
||||
import i18n, { LOCALE_KEY } from "../i18n";
|
||||
import { ConfigContext, DEFAULTS, type ConfigView } from "./config-context";
|
||||
|
||||
export function ConfigProvider({ children }: { children: ReactNode }) {
|
||||
const { data } = useQuery({
|
||||
queryKey: ["config"],
|
||||
queryKey: keys.config(),
|
||||
queryFn: async (): Promise<ConfigView> => {
|
||||
const { data, error } = await api.GET("/api/config");
|
||||
|
||||
|
||||
@@ -8,6 +8,7 @@ import {
|
||||
useVocabularies,
|
||||
} from "../api/queries";
|
||||
import { LabelEditor } from "../components/label-editor";
|
||||
import { MutationError } from "../components/mutation-error";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { Label } from "@/components/ui/label";
|
||||
@@ -95,7 +96,6 @@ export function FieldForm({
|
||||
};
|
||||
|
||||
const pending = isEdit ? update.isPending : create.isPending;
|
||||
const failed = isEdit ? update.isError : create.isError;
|
||||
|
||||
return (
|
||||
<form onSubmit={onSubmit} className="space-y-3 overflow-auto p-4">
|
||||
@@ -198,11 +198,7 @@ export function FieldForm({
|
||||
{t("form.required")}
|
||||
</p>
|
||||
)}
|
||||
{failed && (
|
||||
<p role="alert" className="text-xs text-destructive">
|
||||
{t("form.rejected")}
|
||||
</p>
|
||||
)}
|
||||
<MutationError error={isEdit ? update.error : create.error} />
|
||||
|
||||
<Button type="submit" size="sm" disabled={pending}>
|
||||
{isEdit ? t("actions.save") : t("fields.create")}
|
||||
|
||||
@@ -3,6 +3,8 @@ import { useTranslation } from "react-i18next";
|
||||
|
||||
import type { components } from "../api/schema";
|
||||
import { useFieldDefinitions, useDeleteFieldDefinition } from "../api/queries";
|
||||
import { useLang } from "../lib/use-lang";
|
||||
import { rowStateClass } from "../lib/class-recipes";
|
||||
import { labelText } from "../lib/labels";
|
||||
import { byLabel, compareStrings } from "../lib/sort";
|
||||
import { focusRing } from "../lib/focus-ring";
|
||||
@@ -21,10 +23,10 @@ export function FieldList({
|
||||
selectedKey: string | null;
|
||||
onSelect: (def: FieldDefinitionView) => void;
|
||||
}) {
|
||||
const { t, i18n } = useTranslation();
|
||||
const { t } = useTranslation();
|
||||
const { data, isLoading, isError } = useFieldDefinitions();
|
||||
const deleteField = useDeleteFieldDefinition();
|
||||
const lang = i18n.language.startsWith("sv") ? "sv" : "en";
|
||||
const lang = useLang();
|
||||
const [filter, setFilter] = useState("");
|
||||
|
||||
if (isLoading) return <ListSkeleton rows={6} />;
|
||||
@@ -82,9 +84,9 @@ export function FieldList({
|
||||
{[...defs].sort(byLabel(lang)).map((def) => (
|
||||
<li
|
||||
key={def.key}
|
||||
className={`flex items-center gap-2 border-b px-3 py-2 text-sm ${
|
||||
def.key === selectedKey ? "bg-primary/10" : ""
|
||||
}`}
|
||||
className={`flex items-center gap-2 border-b px-3 py-2 text-sm ${rowStateClass(
|
||||
def.key === selectedKey,
|
||||
)}`}
|
||||
>
|
||||
<button
|
||||
type="button"
|
||||
@@ -94,9 +96,9 @@ export function FieldList({
|
||||
>
|
||||
<span className="font-medium">{labelText(def.labels, lang)}</span>
|
||||
<span className="text-xs text-muted-foreground">{def.key}</span>
|
||||
<span className="rounded-md bg-muted px-1.5 py-0.5 text-xs text-muted-foreground">
|
||||
<Badge variant="secondary">
|
||||
{t(`fields.types.${def.data_type}`)}
|
||||
</span>
|
||||
</Badge>
|
||||
{def.required && (
|
||||
<span
|
||||
className="text-xs text-destructive"
|
||||
|
||||
+10
-3
@@ -1,8 +1,8 @@
|
||||
{
|
||||
"common": { "yes": "Yes", "no": "No", "close": "Close", "loading": "Loading", "filter": "Filter…", "noMatches": "No matches", "language": "Language", "skipToContent": "Skip to content" },
|
||||
"nav": { "objects": "Objects", "vocabularies": "Vocabularies", "authorities": "Authorities", "fields": "Fields", "search": "Search", "collapseSidebar": "Collapse sidebar", "expandSidebar": "Expand sidebar" },
|
||||
"common": { "yes": "Yes", "no": "No", "close": "Close", "loading": "Loading", "filter": "Filter…", "noMatches": "No matches", "language": "Language", "skipToContent": "Skip to content", "clear": "Clear", "open": "Open" },
|
||||
"nav": { "objects": "Objects", "vocabularies": "Vocabularies", "authorities": "Authorities", "fields": "Fields", "search": "Search", "collapseSidebar": "Collapse sidebar", "expandSidebar": "Expand sidebar", "breadcrumb": "Breadcrumb" },
|
||||
"auth": { "email": "Email", "password": "Password", "signIn": "Sign in", "signOut": "Sign out", "invalid": "Invalid email or password", "networkError": "Could not reach the server", "sessionExpired": "Your session expired — please sign in again.", "signingOut": "Signing out…" },
|
||||
"objects": { "title": "Objects", "empty": "No objects yet", "loadError": "Could not load objects", "notFound": "Object not found", "prev": "Previous", "next": "Next", "of": "of", "new": "New object", "filter": "Filter objects…", "pageSize": "Per page", "columns": { "number": "Object №", "name": "Name", "visibility": "Visibility", "location": "Location", "count": "#", "updated": "Updated" }, "unknownRef": "(unknown)" },
|
||||
"objects": { "title": "Objects", "empty": "No objects yet", "loadError": "Could not load objects", "notFound": "Object not found", "prev": "Previous", "next": "Next", "of": "of", "new": "New object", "filter": "Filter objects…", "pageSize": "Per page", "columns": { "number": "Object №", "name": "Name", "visibility": "Visibility", "location": "Location", "count": "#", "updated": "Updated" }, "unknownRef": "(unknown)", "detailTitle": "Object detail", "tableLabel": "Objects" },
|
||||
"fieldsLabels": { "objectNumber": "Object number", "objectName": "Name", "count": "Number of objects", "briefDescription": "Brief description", "currentLocation": "Current location", "currentOwner": "Current owner", "recorder": "Recorder", "recordingDate": "Recording date", "visibility": "Visibility" },
|
||||
"visibility": { "draft": "Draft", "internal": "Internal", "public": "Public" },
|
||||
"form": { "selectPlaceholder": "— select —", "create": "Create object", "save": "Save", "cancel": "Cancel", "visibility": "Visibility", "draft": "Draft", "internal": "Internal", "required": "This field is required", "rejected": "The server rejected the changes — check required and referenced fields", "fieldRejected": "The field \"{{field}}\" was rejected — check its value", "createdButFieldRejected": "Object created, but a field was rejected — fix it below.", "flexibleHeading": "Catalogue fields", "saving": "Saving…", "createAnother": "Save & create another", "minCount": "Must be at least 1", "fieldError": { "type_mismatch": "Wrong type for this field", "unresolved": "Referenced value not found", "unknown": "Unknown field" }, "unsaved": { "title": "Discard unsaved changes?", "body": "You have unsaved changes that will be lost.", "stay": "Keep editing", "leave": "Discard" } },
|
||||
@@ -61,6 +61,13 @@
|
||||
"editLink": "Edit the record",
|
||||
"illegalError": "That visibility change isn't allowed."
|
||||
},
|
||||
"errors": {
|
||||
"forbidden": "You don't have permission to do that.",
|
||||
"notFound": "That item no longer exists.",
|
||||
"conflict": "That conflicts with existing data.",
|
||||
"validation": "Some values weren't accepted.",
|
||||
"server": "The server had a problem. Please try again."
|
||||
},
|
||||
"toast": {
|
||||
"created": "Created",
|
||||
"saved": "Saved",
|
||||
|
||||
+10
-3
@@ -1,8 +1,8 @@
|
||||
{
|
||||
"common": { "yes": "Ja", "no": "Nej", "close": "Stäng", "loading": "Laddar", "filter": "Filtrera…", "noMatches": "Inga träffar", "language": "Språk", "skipToContent": "Hoppa till innehåll" },
|
||||
"nav": { "objects": "Föremål", "vocabularies": "Vokabulär", "authorities": "Auktoriteter", "fields": "Fält", "search": "Sök", "collapseSidebar": "Fäll ihop sidofältet", "expandSidebar": "Fäll ut sidofältet" },
|
||||
"common": { "yes": "Ja", "no": "Nej", "close": "Stäng", "loading": "Laddar", "filter": "Filtrera…", "noMatches": "Inga träffar", "language": "Språk", "skipToContent": "Hoppa till innehåll", "clear": "Rensa", "open": "Öppna" },
|
||||
"nav": { "objects": "Föremål", "vocabularies": "Vokabulär", "authorities": "Auktoriteter", "fields": "Fält", "search": "Sök", "collapseSidebar": "Fäll ihop sidofältet", "expandSidebar": "Fäll ut sidofältet", "breadcrumb": "Brödsmulor" },
|
||||
"auth": { "email": "E-post", "password": "Lösenord", "signIn": "Logga in", "signOut": "Logga ut", "invalid": "Fel e-post eller lösenord", "networkError": "Kunde inte nå servern", "sessionExpired": "Din session har gått ut — logga in igen.", "signingOut": "Loggar ut…" },
|
||||
"objects": { "title": "Föremål", "empty": "Inga föremål ännu", "loadError": "Kunde inte ladda föremål", "notFound": "Föremålet hittades inte", "prev": "Föregående", "next": "Nästa", "of": "av", "new": "Nytt föremål", "filter": "Filtrera föremål…", "pageSize": "Per sida", "columns": { "number": "Föremålsnr", "name": "Namn", "visibility": "Synlighet", "location": "Plats", "count": "Antal", "updated": "Uppdaterad" }, "unknownRef": "(okänd)" },
|
||||
"objects": { "title": "Föremål", "empty": "Inga föremål ännu", "loadError": "Kunde inte ladda föremål", "notFound": "Föremålet hittades inte", "prev": "Föregående", "next": "Nästa", "of": "av", "new": "Nytt föremål", "filter": "Filtrera föremål…", "pageSize": "Per sida", "columns": { "number": "Föremålsnr", "name": "Namn", "visibility": "Synlighet", "location": "Plats", "count": "Antal", "updated": "Uppdaterad" }, "unknownRef": "(okänd)", "detailTitle": "Objektdetalj", "tableLabel": "Objekt" },
|
||||
"fieldsLabels": { "objectNumber": "Föremålsnummer", "objectName": "Namn", "count": "Antal föremål", "briefDescription": "Kort beskrivning", "currentLocation": "Nuvarande plats", "currentOwner": "Nuvarande ägare", "recorder": "Registrerad av", "recordingDate": "Registreringsdatum", "visibility": "Synlighet" },
|
||||
"visibility": { "draft": "Utkast", "internal": "Intern", "public": "Publik" },
|
||||
"form": { "selectPlaceholder": "— välj —", "create": "Skapa föremål", "save": "Spara", "cancel": "Avbryt", "visibility": "Synlighet", "draft": "Utkast", "internal": "Intern", "required": "Fältet är obligatoriskt", "rejected": "Servern avvisade ändringarna — kontrollera obligatoriska och refererade fält", "fieldRejected": "Fältet \"{{field}}\" avvisades — kontrollera värdet", "createdButFieldRejected": "Föremålet skapades, men ett fält avvisades — åtgärda nedan.", "flexibleHeading": "Katalogfält", "saving": "Sparar…", "createAnother": "Spara & skapa ny", "minCount": "Måste vara minst 1", "fieldError": { "type_mismatch": "Fel typ för detta fält", "unresolved": "Refererat värde hittades inte", "unknown": "Okänt fält" }, "unsaved": { "title": "Kasta osparade ändringar?", "body": "Du har osparade ändringar som går förlorade.", "stay": "Fortsätt redigera", "leave": "Kasta" } },
|
||||
@@ -61,6 +61,13 @@
|
||||
"editLink": "Redigera posten",
|
||||
"illegalError": "Den synlighetsändringen är inte tillåten."
|
||||
},
|
||||
"errors": {
|
||||
"forbidden": "Du har inte behörighet att göra det.",
|
||||
"notFound": "Objektet finns inte längre.",
|
||||
"conflict": "Det står i konflikt med befintliga data.",
|
||||
"validation": "Vissa värden godtogs inte.",
|
||||
"server": "Servern hade ett problem. Försök igen."
|
||||
},
|
||||
"toast": {
|
||||
"created": "Skapat",
|
||||
"saved": "Sparat",
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
import { expect, test } from "vitest";
|
||||
|
||||
import { rowStateClass, segmentClass } from "./class-recipes";
|
||||
|
||||
test("segmentClass active uses the primary tokens + focus ring", () => {
|
||||
const cls = segmentClass(true, "px-2 py-1");
|
||||
expect(cls).toContain("bg-primary");
|
||||
expect(cls).toContain("text-primary-foreground");
|
||||
expect(cls).toContain("focus-visible:ring-ring/50");
|
||||
expect(cls).toContain("px-2");
|
||||
});
|
||||
|
||||
test("segmentClass inactive uses border, not the primary fill", () => {
|
||||
const cls = segmentClass(false);
|
||||
expect(cls).toContain("border");
|
||||
expect(cls).not.toContain("bg-primary");
|
||||
});
|
||||
|
||||
test("rowStateClass toggles selected vs idle-hover", () => {
|
||||
expect(rowStateClass(true)).toBe("bg-primary/10");
|
||||
expect(rowStateClass(false)).toBe("hover:bg-muted");
|
||||
});
|
||||
@@ -0,0 +1,14 @@
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
import { focusRing } from "./focus-ring";
|
||||
|
||||
/** Segmented-control / filter-pill item. Unifies the active/inactive token recipe +
|
||||
* focus ring; callers pass their contextual padding/size via `className`. */
|
||||
export function segmentClass(active: boolean, className?: string): string {
|
||||
return cn("rounded-md", focusRing, active ? "bg-primary text-primary-foreground" : "border", className);
|
||||
}
|
||||
|
||||
/** Selected vs idle row background for master-detail / list rows. */
|
||||
export function rowStateClass(active: boolean): string {
|
||||
return active ? "bg-primary/10" : "hover:bg-muted";
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
/** The instance's active UI language, narrowed to the two supported locales. */
|
||||
export function useLang(): "sv" | "en" {
|
||||
const { i18n } = useTranslation();
|
||||
return i18n.language.startsWith("sv") ? "sv" : "en";
|
||||
}
|
||||
@@ -4,6 +4,7 @@ import { useTranslation } from "react-i18next";
|
||||
import type { components } from "../api/schema";
|
||||
import { useAuthorities, useTerms } from "../api/queries";
|
||||
import { useConfig } from "../config/config-context";
|
||||
import { useLang } from "../lib/use-lang";
|
||||
import { labelText } from "../lib/labels";
|
||||
import { OptionsCombobox } from "./options-combobox";
|
||||
import { Checkbox } from "@/components/ui/checkbox";
|
||||
@@ -27,9 +28,9 @@ export function FieldInput<TValues extends { fields: Record<string, unknown> }>(
|
||||
definition: FieldDefinitionView;
|
||||
form: FieldForm<TValues>;
|
||||
}) {
|
||||
const { t, i18n } = useTranslation();
|
||||
const { t } = useTranslation();
|
||||
const { default_language } = useConfig();
|
||||
const lang = i18n.language.startsWith("sv") ? "sv" : "en";
|
||||
const lang = useLang();
|
||||
const label = labelText(definition.labels, lang);
|
||||
const name = fieldPath<TValues>(definition.key);
|
||||
const placeholder = t("form.selectPlaceholder");
|
||||
|
||||
@@ -3,6 +3,7 @@ import { useTranslation } from "react-i18next";
|
||||
import { X } from "lucide-react";
|
||||
|
||||
import { Drawer, DrawerClose, DrawerContent } from "@/components/ui/drawer";
|
||||
import { Button } from "@/components/ui/button";
|
||||
|
||||
/**
|
||||
* Narrow-viewport object detail: the nested <Outlet/> inside a Base UI Drawer that
|
||||
@@ -26,11 +27,11 @@ export function ObjectDetailDrawer({
|
||||
}}
|
||||
swipeDirection="right"
|
||||
>
|
||||
<DrawerContent>
|
||||
<DrawerContent aria-label={t("objects.detailTitle")}>
|
||||
<div className="flex justify-end border-b p-2">
|
||||
<DrawerClose
|
||||
aria-label={t("actions.closeDetail")}
|
||||
className="rounded-md p-1 text-muted-foreground hover:bg-muted hover:text-foreground"
|
||||
render={<Button variant="ghost" size="icon-sm" />}
|
||||
>
|
||||
<X className="size-4" aria-hidden="true" />
|
||||
</DrawerClose>
|
||||
|
||||
@@ -4,6 +4,7 @@ import { useTranslation } from "react-i18next";
|
||||
|
||||
import type { components } from "../api/schema";
|
||||
import { useObject, useFieldDefinitions } from "../api/queries";
|
||||
import { useLang } from "../lib/use-lang";
|
||||
import { groupDefinitions } from "../lib/group-fields";
|
||||
import { formatDate } from "../lib/format-date";
|
||||
import { useDocumentTitle } from "../lib/use-document-title";
|
||||
@@ -49,14 +50,14 @@ export function ObjectDetail() {
|
||||
}
|
||||
|
||||
function ObjectDetailLoaded({ object }: { object: AdminObjectView }) {
|
||||
const { t, i18n } = useTranslation();
|
||||
const { t } = useTranslation();
|
||||
const { data: definitions } = useFieldDefinitions();
|
||||
|
||||
useDocumentTitle(object.object_number);
|
||||
useBreadcrumb([{ label: t("nav.objects"), to: "/objects" }, { label: object.object_number }]);
|
||||
|
||||
// Prefer the active locale's label, then English, then the raw key.
|
||||
const lang = i18n.language.startsWith("sv") ? "sv" : "en";
|
||||
const lang = useLang();
|
||||
const labelFor = (key: string) => {
|
||||
const labels = definitions?.find((d) => d.key === key)?.labels;
|
||||
const byLang = labels?.find((l) => l.lang === lang)?.label;
|
||||
|
||||
@@ -69,3 +69,15 @@ test("edit: prefilled, save -> PUT core + PUT fields -> back to detail", async (
|
||||
expect((putCore as { object_name: string }).object_name).toBe("Big amphora");
|
||||
expect((putFields as { inscription: string }).inscription).toBe("old");
|
||||
});
|
||||
|
||||
test("renders a load error (not 'not found') when the object fetch fails", async () => {
|
||||
server.use(http.get("/api/admin/objects/:id", () => new HttpResponse(null, { status: 500 })));
|
||||
renderApp(
|
||||
<Routes>
|
||||
<Route path="/objects/:id/edit" element={<ObjectEditForm />} />
|
||||
</Routes>,
|
||||
{ route: "/objects/abc/edit" },
|
||||
);
|
||||
expect(await screen.findByText(/could not load/i)).toBeInTheDocument();
|
||||
expect(screen.queryByText(/not found/i)).toBeNull();
|
||||
});
|
||||
|
||||
@@ -4,6 +4,7 @@ import { useTranslation } from "react-i18next";
|
||||
|
||||
import type { components } from "../api/schema";
|
||||
import { useObject, useUpdateObject, useSetFields, FieldRejection } from "../api/queries";
|
||||
import { errorMessageKey } from "../api/error-message";
|
||||
import { useBreadcrumb } from "../shell/use-breadcrumb";
|
||||
import { ObjectForm, type ObjectCore, type ObjectFormValues } from "./object-form";
|
||||
import { FormSkeleton } from "@/components/ui/skeletons";
|
||||
@@ -14,10 +15,12 @@ export function ObjectEditForm() {
|
||||
const { t } = useTranslation();
|
||||
const { id } = useParams();
|
||||
|
||||
const { data: object, isLoading } = useObject(id!);
|
||||
const { data: object, isLoading, isError } = useObject(id!);
|
||||
|
||||
if (isLoading) return <FormSkeleton />;
|
||||
|
||||
if (isError) return <p className="p-4 text-sm text-destructive">{t("objects.loadError")}</p>;
|
||||
|
||||
if (!object) return <p className="p-4 text-sm text-muted-foreground">{t("objects.notFound")}</p>;
|
||||
|
||||
return <ObjectEditFormLoaded object={object} id={id!} />;
|
||||
@@ -84,7 +87,8 @@ function ObjectEditFormLoaded({ object, id }: { object: AdminObjectView; id: str
|
||||
setFieldErrorCode(e.code);
|
||||
setError(t("form.fieldRejected", { field: e.field }));
|
||||
} else {
|
||||
setError(t("form.rejected"));
|
||||
const { key, opts } = errorMessageKey(e);
|
||||
setError(t(key, opts));
|
||||
}
|
||||
|
||||
return false;
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { expect, test } from "vitest";
|
||||
import { screen, waitFor } from "@testing-library/react";
|
||||
import userEvent from "@testing-library/user-event";
|
||||
import { delay, http, HttpResponse } from "msw";
|
||||
import { http, HttpResponse } from "msw";
|
||||
import { Routes, Route } from "react-router-dom";
|
||||
import { server } from "../test/server";
|
||||
import { renderApp } from "../test/render";
|
||||
@@ -72,11 +72,15 @@ test("partial create: fields PUT fails -> edit page shows the 'created' banner a
|
||||
|
||||
test("in-flight submit: button disabled + shows Saving…, create fires exactly once on double-click", async () => {
|
||||
let postCount = 0;
|
||||
let release!: () => void;
|
||||
const gate = new Promise<void>((resolve) => {
|
||||
release = resolve;
|
||||
});
|
||||
|
||||
server.use(
|
||||
http.post("/api/admin/objects", async () => {
|
||||
postCount += 1;
|
||||
await delay(50);
|
||||
await gate;
|
||||
return HttpResponse.json({ id: "new-id-3" }, { status: 201 });
|
||||
}),
|
||||
);
|
||||
@@ -91,9 +95,13 @@ test("in-flight submit: button disabled + shows Saving…, create fires exactly
|
||||
await userEvent.click(button);
|
||||
await userEvent.click(button);
|
||||
|
||||
await waitFor(() => expect(screen.getByText(/saving…/i)).toBeInTheDocument());
|
||||
// The mutation is held open by `gate`, so the pending state is observed
|
||||
// deterministically (no reliance on a timing window).
|
||||
expect(await screen.findByText(/saving…/i)).toBeInTheDocument();
|
||||
expect(screen.getByRole("button", { name: /saving…/i })).toBeDisabled();
|
||||
|
||||
release();
|
||||
|
||||
await waitFor(() => expect(screen.getByText("detail view")).toBeInTheDocument());
|
||||
expect(postCount).toBe(1);
|
||||
});
|
||||
|
||||
@@ -4,6 +4,7 @@ import { useTranslation } from "react-i18next";
|
||||
|
||||
import { ObjectForm, type ObjectFormValues } from "./object-form";
|
||||
import { useCreateObject, useSetFields, FieldRejection } from "../api/queries";
|
||||
import { errorMessageKey } from "../api/error-message";
|
||||
import { useDocumentTitle } from "../lib/use-document-title";
|
||||
import { useBreadcrumb } from "../shell/use-breadcrumb";
|
||||
import { PageTitle } from "@/components/ui/page-title";
|
||||
@@ -33,8 +34,9 @@ export function ObjectNewPage() {
|
||||
});
|
||||
|
||||
id = created.id;
|
||||
} catch {
|
||||
setError(t("form.rejected"));
|
||||
} catch (e) {
|
||||
const { key, opts } = errorMessageKey(e);
|
||||
setError(t(key, opts));
|
||||
return false;
|
||||
}
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@ import { ObjectsTable } from "./objects-table";
|
||||
import { useMediaQuery } from "../lib/use-media-query";
|
||||
import { useDocumentTitle } from "../lib/use-document-title";
|
||||
import { useBreadcrumb } from "../shell/use-breadcrumb";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { PageTitle } from "@/components/ui/page-title";
|
||||
|
||||
const ObjectDetailDrawer = lazy(() =>
|
||||
@@ -47,14 +48,14 @@ export function ObjectsPage() {
|
||||
{open && (
|
||||
<div className="flex h-full flex-col overflow-hidden border-l">
|
||||
<div className="flex justify-end border-b p-2">
|
||||
<button
|
||||
type="button"
|
||||
<Button
|
||||
variant="ghost"
|
||||
size="icon-sm"
|
||||
onClick={closeDetail}
|
||||
aria-label={t("actions.closeDetail")}
|
||||
className="rounded-md p-1 text-muted-foreground hover:bg-muted hover:text-foreground"
|
||||
>
|
||||
<X className="size-4" aria-hidden="true" />
|
||||
</button>
|
||||
</Button>
|
||||
</div>
|
||||
<div className="flex-1 overflow-auto">
|
||||
<Outlet />
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
import { beforeEach, expect, test } from "vitest";
|
||||
import { screen, waitFor, within } from "@testing-library/react";
|
||||
import userEvent from "@testing-library/user-event";
|
||||
import { http, HttpResponse } from "msw";
|
||||
import { Route, Routes } from "react-router-dom";
|
||||
import { delay, http, HttpResponse } from "msw";
|
||||
import { Outlet, Route, Routes } from "react-router-dom";
|
||||
|
||||
import { server } from "../test/server";
|
||||
import { renderApp } from "../test/render";
|
||||
@@ -24,6 +24,24 @@ function tree() {
|
||||
);
|
||||
}
|
||||
|
||||
function nestedTree() {
|
||||
return (
|
||||
<Routes>
|
||||
<Route
|
||||
path="/objects"
|
||||
element={
|
||||
<>
|
||||
<ObjectsTable />
|
||||
<Outlet />
|
||||
</>
|
||||
}
|
||||
>
|
||||
<Route path=":id" element={<div>detail pane</div>} />
|
||||
</Route>
|
||||
</Routes>
|
||||
);
|
||||
}
|
||||
|
||||
/** Capture the query string of every objects request so assertions can inspect URL → request flow. */
|
||||
function captureRequests() {
|
||||
const calls: URLSearchParams[] = [];
|
||||
@@ -134,3 +152,36 @@ test("clicking a row deep-links to /objects/:id preserving the query string", as
|
||||
|
||||
expect(await screen.findByRole("heading", { name: "Amphora" })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
test("the object number cell is a real link", async () => {
|
||||
renderApp(tree(), { route: "/objects" });
|
||||
expect(await screen.findByRole("link", { name: "LM-0042" })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
test("the selected row's link is marked aria-current=page", async () => {
|
||||
const first = objectsPage.items[0];
|
||||
renderApp(nestedTree(), { route: `/objects/${first.id}` });
|
||||
const link = await screen.findByRole("link", { name: first.object_number });
|
||||
expect(link).toHaveAttribute("aria-current", "page");
|
||||
const other = await screen.findByRole("link", { name: objectsPage.items[1].object_number });
|
||||
expect(other).not.toHaveAttribute("aria-current");
|
||||
});
|
||||
|
||||
test("the table is marked aria-busy while loading", async () => {
|
||||
server.use(
|
||||
http.get("/api/admin/objects", async () => {
|
||||
await delay(50);
|
||||
return HttpResponse.json(objectsPage);
|
||||
}),
|
||||
);
|
||||
renderApp(tree(), { route: "/objects" });
|
||||
expect(screen.getByRole("table")).toHaveAttribute("aria-busy", "true");
|
||||
await screen.findByRole("link", { name: "LM-0042" });
|
||||
expect(screen.getByRole("table")).not.toHaveAttribute("aria-busy");
|
||||
});
|
||||
|
||||
test("a failed objects fetch is announced via role=alert", async () => {
|
||||
server.use(http.get("/api/admin/objects", () => new HttpResponse(null, { status: 500 })));
|
||||
renderApp(tree(), { route: "/objects" });
|
||||
expect(await screen.findByRole("alert")).toHaveTextContent(/could not load/i);
|
||||
});
|
||||
|
||||
@@ -6,6 +6,8 @@ import { ChevronDown, ChevronUp, ChevronsUpDown } from "lucide-react";
|
||||
import type { components } from "../api/schema";
|
||||
import { useObjectsPage } from "../api/queries";
|
||||
import { useDebouncedValue } from "../lib/use-debounced-value";
|
||||
import { focusRing } from "../lib/focus-ring";
|
||||
import { segmentClass, rowStateClass } from "../lib/class-recipes";
|
||||
import { useConfig } from "../config/config-context";
|
||||
import { VisibilityBadge } from "./visibility-badge";
|
||||
import { Button, buttonVariants } from "@/components/ui/button";
|
||||
@@ -170,7 +172,7 @@ export function ObjectsTable() {
|
||||
type="button"
|
||||
aria-pressed={active}
|
||||
onClick={() => setVisibility(value)}
|
||||
className={`rounded-md px-2 py-1 ${active ? "bg-primary text-primary-foreground" : "border"}`}
|
||||
className={segmentClass(active, "px-2 py-1")}
|
||||
>
|
||||
{value === "all" ? t("search.all") : t(`visibility.${value}`)}
|
||||
</button>
|
||||
@@ -220,7 +222,7 @@ export function ObjectsTable() {
|
||||
body = (
|
||||
<tbody>
|
||||
<tr>
|
||||
<td colSpan={6} className="px-3 py-6 text-center text-sm text-destructive">
|
||||
<td colSpan={6} role="alert" className="px-3 py-6 text-center text-sm text-destructive">
|
||||
{t("objects.loadError")}
|
||||
</td>
|
||||
</tr>
|
||||
@@ -246,18 +248,19 @@ export function ObjectsTable() {
|
||||
return (
|
||||
<tr
|
||||
key={object.id}
|
||||
role="link"
|
||||
tabIndex={0}
|
||||
aria-selected={selected}
|
||||
onClick={() => navigate(`/objects/${object.id}?${params}`)}
|
||||
onKeyDown={(event) => {
|
||||
if (event.key === "Enter") navigate(`/objects/${object.id}?${params}`);
|
||||
}}
|
||||
className={`cursor-pointer border-b text-sm ${
|
||||
selected ? "bg-primary/10" : "hover:bg-muted"
|
||||
}`}
|
||||
className={`cursor-pointer border-b text-sm ${rowStateClass(selected)}`}
|
||||
>
|
||||
<td className="px-3 py-2 text-muted-foreground">{object.object_number}</td>
|
||||
<td className="px-3 py-2 text-muted-foreground">
|
||||
<Link
|
||||
to={`/objects/${object.id}?${params}`}
|
||||
aria-current={selected ? "page" : undefined}
|
||||
onClick={(event) => event.stopPropagation()}
|
||||
className={`${focusRing} rounded-sm hover:underline`}
|
||||
>
|
||||
{object.object_number}
|
||||
</Link>
|
||||
</td>
|
||||
<td className="px-3 py-2 font-medium">{object.object_name}</td>
|
||||
<td className="px-3 py-2">
|
||||
<VisibilityBadge visibility={object.visibility} />
|
||||
@@ -276,7 +279,10 @@ export function ObjectsTable() {
|
||||
<div className="flex h-full flex-col">
|
||||
{toolbar}
|
||||
<div className="flex-1 overflow-auto">
|
||||
<table className="w-full border-collapse">
|
||||
<table className="w-full border-collapse" aria-busy={isLoading || undefined}>
|
||||
<caption className="sr-only" aria-live="polite">
|
||||
{isLoading ? t("common.loading") : t("objects.tableLabel")}
|
||||
</caption>
|
||||
{columns}
|
||||
{body}
|
||||
</table>
|
||||
|
||||
@@ -2,6 +2,7 @@ import { describe, it, expect, vi } from "vitest";
|
||||
import { render, screen, within } from "@testing-library/react";
|
||||
import userEvent from "@testing-library/user-event";
|
||||
|
||||
import "../i18n";
|
||||
import { OptionsCombobox, type Option } from "./options-combobox";
|
||||
|
||||
const options: Option[] = [
|
||||
@@ -49,6 +50,11 @@ describe("OptionsCombobox", () => {
|
||||
expect(screen.getByDisplayValue("Wood")).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("gives the open control a translated accessible name", () => {
|
||||
setup();
|
||||
expect(screen.getByRole("button", { name: /open/i })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("clears the selection when the Clear button is clicked", async () => {
|
||||
const user = userEvent.setup();
|
||||
const { onChange } = setup("t1");
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import type { components } from "../api/schema";
|
||||
import { labelText } from "../lib/labels";
|
||||
import {
|
||||
@@ -32,6 +34,7 @@ export function OptionsCombobox({
|
||||
lang: string;
|
||||
placeholder: string;
|
||||
}) {
|
||||
const { t } = useTranslation();
|
||||
const selected = options.find((o) => o.id === value) ?? null;
|
||||
|
||||
return (
|
||||
@@ -44,12 +47,12 @@ export function OptionsCombobox({
|
||||
>
|
||||
<ComboboxInputGroup>
|
||||
<ComboboxInput id={id} placeholder={placeholder} />
|
||||
<ComboboxClear aria-label="Clear" />
|
||||
<ComboboxTrigger aria-label="Open" />
|
||||
<ComboboxClear aria-label={t("common.clear")} />
|
||||
<ComboboxTrigger aria-label={t("common.open")} />
|
||||
</ComboboxInputGroup>
|
||||
|
||||
<ComboboxPopup>
|
||||
<ComboboxEmpty>No matches.</ComboboxEmpty>
|
||||
<ComboboxEmpty>{t("common.noMatches")}</ComboboxEmpty>
|
||||
<ComboboxList>
|
||||
{(option: Option) => (
|
||||
<ComboboxItem key={option.id} value={option}>
|
||||
|
||||
@@ -4,9 +4,8 @@ import { useTranslation } from "react-i18next";
|
||||
|
||||
import { useSearch, HttpError } from "../api/queries";
|
||||
import { useDebouncedValue } from "../lib/use-debounced-value";
|
||||
import { focusRing } from "../lib/focus-ring";
|
||||
import { segmentClass } from "../lib/class-recipes";
|
||||
import { SearchResultRow } from "./search-result-row";
|
||||
import { cn } from "@/lib/utils";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { ListSkeleton } from "@/components/ui/skeletons";
|
||||
@@ -73,7 +72,7 @@ export function SearchPanel() {
|
||||
type="button"
|
||||
aria-pressed={active}
|
||||
onClick={() => setVisibility(value)}
|
||||
className={cn("rounded-md px-2 py-0.5", focusRing, active ? "bg-primary text-primary-foreground" : "border")}
|
||||
className={segmentClass(active, "px-2 py-0.5")}
|
||||
>
|
||||
{value === "all" ? t("search.all") : t(`visibility.${value}`)}
|
||||
</button>
|
||||
|
||||
@@ -2,6 +2,7 @@ import { NavLink } from "react-router-dom";
|
||||
|
||||
import type { components } from "../api/schema";
|
||||
import { VisibilityBadge } from "../objects/visibility-badge";
|
||||
import { rowStateClass } from "../lib/class-recipes";
|
||||
import { Highlight } from "./highlight";
|
||||
|
||||
type SearchHitView = components["schemas"]["SearchHitView"];
|
||||
@@ -12,7 +13,7 @@ export function SearchResultRow({ hit }: { hit: SearchHitView }) {
|
||||
<NavLink
|
||||
to={`/search/${hit.id}`}
|
||||
className={({ isActive }) =>
|
||||
`block border-b px-3 py-2 ${isActive ? "bg-primary/10" : "hover:bg-muted"}`
|
||||
`block border-b px-3 py-2 ${rowStateClass(isActive)}`
|
||||
}
|
||||
>
|
||||
<div className="text-sm font-semibold">{hit.object_name}</div>
|
||||
|
||||
@@ -26,6 +26,7 @@ test("renders the trail with a link on non-leaf crumbs", async () => {
|
||||
const link = await screen.findByRole("link", { name: "Objects" });
|
||||
expect(link).toHaveAttribute("href", "/objects");
|
||||
expect(screen.getByText("LM-0042")).toBeInTheDocument();
|
||||
expect(screen.getByRole("navigation", { name: /breadcrumb/i })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
test("a nested route sets the header breadcrumb inside AppShell", async () => {
|
||||
|
||||
@@ -1,13 +1,15 @@
|
||||
import { Fragment } from "react";
|
||||
import { useTranslation } from "react-i18next";
|
||||
import { Link } from "react-router-dom";
|
||||
|
||||
import { useBreadcrumbTrail } from "./breadcrumb-context";
|
||||
|
||||
export function Breadcrumb() {
|
||||
const { t } = useTranslation();
|
||||
const trail = useBreadcrumbTrail();
|
||||
if (trail.length === 0) return <div className="min-w-0 flex-1" />;
|
||||
return (
|
||||
<nav aria-label="Breadcrumb" className="flex min-w-0 flex-1 items-center gap-1 text-sm">
|
||||
<nav aria-label={t("nav.breadcrumb")} className="flex min-w-0 flex-1 items-center gap-1 text-sm">
|
||||
{trail.map((item, i) => {
|
||||
const last = i === trail.length - 1;
|
||||
return (
|
||||
|
||||
@@ -20,7 +20,7 @@ export function HeaderSearch() {
|
||||
<form onSubmit={onSubmit} className="hidden sm:block">
|
||||
<div className="relative">
|
||||
<Search
|
||||
className="pointer-events-none absolute top-1/2 left-2 h-4 w-4 -translate-y-1/2 text-muted-foreground"
|
||||
className="pointer-events-none absolute top-1/2 left-2 size-4 -translate-y-1/2 text-muted-foreground"
|
||||
aria-hidden
|
||||
/>
|
||||
<Input
|
||||
|
||||
@@ -13,6 +13,7 @@ import {
|
||||
import type { LucideIcon } from "lucide-react";
|
||||
|
||||
import { cn } from "@/lib/utils";
|
||||
import { focusRing } from "../lib/focus-ring";
|
||||
import { Tooltip } from "@/components/ui/tooltip";
|
||||
import { useMediaQuery } from "@/lib/use-media-query";
|
||||
import { useConfig } from "../config/config-context";
|
||||
@@ -43,7 +44,7 @@ function navLinkClass(collapsed: boolean) {
|
||||
return ({ isActive }: { isActive: boolean }) =>
|
||||
cn(
|
||||
"flex items-center gap-2 rounded-md px-2 py-1 outline-none",
|
||||
"focus-visible:ring-3 focus-visible:ring-ring/50",
|
||||
focusRing,
|
||||
collapsed && "justify-center",
|
||||
isActive && "bg-accent font-medium",
|
||||
);
|
||||
@@ -85,7 +86,8 @@ export function Sidebar() {
|
||||
title={t(collapsed ? "nav.expandSidebar" : "nav.collapseSidebar")}
|
||||
className={cn(
|
||||
"flex items-center justify-center rounded-md p-1 outline-none",
|
||||
"hover:bg-accent focus-visible:ring-3 focus-visible:ring-ring/50",
|
||||
"hover:bg-accent",
|
||||
focusRing,
|
||||
"disabled:pointer-events-none disabled:opacity-50",
|
||||
)}
|
||||
>
|
||||
|
||||
@@ -36,7 +36,7 @@ export function ThemeSwitch() {
|
||||
: "text-muted-foreground hover:text-foreground",
|
||||
)}
|
||||
>
|
||||
<Icon className="h-4 w-4" aria-hidden />
|
||||
<Icon className="size-4" aria-hidden />
|
||||
</button>
|
||||
);
|
||||
})}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { expect, test } from "vitest";
|
||||
import { screen, waitFor, within } from "@testing-library/react";
|
||||
import userEvent from "@testing-library/user-event";
|
||||
import { delay, http, HttpResponse } from "msw";
|
||||
import { http, HttpResponse } from "msw";
|
||||
import { server } from "../test/server";
|
||||
import { renderApp } from "../test/render";
|
||||
import { UserMenu } from "./user-menu";
|
||||
@@ -35,9 +35,13 @@ test("opens the menu showing email + role and signs out", async () => {
|
||||
});
|
||||
|
||||
test("shows a pending state on Sign out while logging out", async () => {
|
||||
let release!: () => void;
|
||||
const gate = new Promise<void>((resolve) => {
|
||||
release = resolve;
|
||||
});
|
||||
server.use(
|
||||
http.post("/api/admin/logout", async () => {
|
||||
await delay(50);
|
||||
await gate;
|
||||
return new HttpResponse(null, { status: 204 });
|
||||
}),
|
||||
);
|
||||
@@ -50,5 +54,10 @@ test("shows a pending state on Sign out while logging out", async () => {
|
||||
const menu = within(document.body);
|
||||
await userEvent.click(await menu.findByText("Sign out"));
|
||||
|
||||
// The logout is held open by `gate`, so the pending state is observed
|
||||
// deterministically (no reliance on a timing window).
|
||||
expect(await menu.findByText(/signing out/i)).toBeInTheDocument();
|
||||
|
||||
release();
|
||||
await waitFor(() => expect(menu.queryByText(/signing out/i)).toBeNull());
|
||||
});
|
||||
|
||||
@@ -24,7 +24,7 @@ export function UserMenu() {
|
||||
<MenuTrigger
|
||||
render={
|
||||
<Button variant="ghost" size="sm" className="max-w-44">
|
||||
<CircleUser className="h-4 w-4" aria-hidden />
|
||||
<CircleUser className="size-4" aria-hidden />
|
||||
<span className="truncate">{me.email}</span>
|
||||
</Button>
|
||||
}
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
import { expect, test } from "vitest";
|
||||
import { screen } from "@testing-library/react";
|
||||
import userEvent from "@testing-library/user-event";
|
||||
import { http, HttpResponse } from "msw";
|
||||
|
||||
import type { TermView } from "../test/fixtures";
|
||||
import { server } from "../test/server";
|
||||
import { renderApp } from "../test/render";
|
||||
import { TermRow } from "./term-row";
|
||||
|
||||
const term: TermView = {
|
||||
id: "t1",
|
||||
external_uri: null,
|
||||
labels: [{ lang: "en", label: "Bronze" }],
|
||||
};
|
||||
|
||||
test("a failed term update shows an inline error and keeps the row editable", async () => {
|
||||
server.use(
|
||||
http.patch("/api/admin/vocabularies/:id/terms/:term_id", () => new HttpResponse(null, { status: 403 })),
|
||||
);
|
||||
renderApp(
|
||||
<ul>
|
||||
<TermRow vocabularyId="v1" term={term} lang="en" />
|
||||
</ul>,
|
||||
);
|
||||
|
||||
await userEvent.click(screen.getByRole("button", { name: /edit/i }));
|
||||
await userEvent.click(screen.getByRole("button", { name: /save/i }));
|
||||
|
||||
expect(await screen.findByRole("alert")).toHaveTextContent(/permission/i);
|
||||
expect(screen.getByRole("button", { name: /save/i })).toBeInTheDocument();
|
||||
});
|
||||
|
||||
test("re-entering edit after a failure clears the stale error", async () => {
|
||||
server.use(
|
||||
http.patch("/api/admin/vocabularies/:id/terms/:term_id", () => new HttpResponse(null, { status: 403 })),
|
||||
);
|
||||
renderApp(
|
||||
<ul>
|
||||
<TermRow vocabularyId="v1" term={term} lang="en" />
|
||||
</ul>,
|
||||
);
|
||||
|
||||
await userEvent.click(screen.getByRole("button", { name: /edit/i }));
|
||||
await userEvent.click(screen.getByRole("button", { name: /save/i }));
|
||||
expect(await screen.findByRole("alert")).toBeInTheDocument();
|
||||
await userEvent.click(screen.getByRole("button", { name: /cancel/i }));
|
||||
await userEvent.click(screen.getByRole("button", { name: /edit/i }));
|
||||
|
||||
expect(screen.queryByRole("alert")).toBeNull();
|
||||
});
|
||||
+14
-71
@@ -1,81 +1,24 @@
|
||||
import { useState } from "react";
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import type { components } from "../api/schema";
|
||||
import { useUpdateTerm, useDeleteTerm } from "../api/queries";
|
||||
import { LabelEditor } from "../components/label-editor";
|
||||
import { DeleteConfirmDialog } from "../components/delete-confirm-dialog";
|
||||
import { ExternalUriLink } from "../components/external-uri-link";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { Label } from "@/components/ui/label";
|
||||
import { labelText } from "../lib/labels";
|
||||
import { LabelledRecordRow } from "../components/labelled-record-row";
|
||||
|
||||
type TermView = components["schemas"]["TermView"];
|
||||
type LabelInput = components["schemas"]["LabelInput"];
|
||||
|
||||
export function TermRow({ vocabularyId, term, lang }: { vocabularyId: string; term: TermView; lang: string }) {
|
||||
const { t } = useTranslation();
|
||||
|
||||
const updateTerm = useUpdateTerm();
|
||||
const deleteTerm = useDeleteTerm();
|
||||
|
||||
const [editing, setEditing] = useState(false);
|
||||
const [labels, setLabels] = useState<LabelInput[]>(term.labels as LabelInput[]);
|
||||
const [uri, setUri] = useState(term.external_uri ?? "");
|
||||
|
||||
if (editing) {
|
||||
return (
|
||||
<li className="space-y-2 border-b py-2">
|
||||
<LabelEditor value={labels} onChange={setLabels} />
|
||||
<div className="space-y-1">
|
||||
<Label htmlFor={`term-uri-${term.id}`}>{t("labels.externalUri")}</Label>
|
||||
<Input id={`term-uri-${term.id}`} type="url" placeholder={t("labels.uriPlaceholder")} value={uri} onChange={(e) => setUri(e.target.value)} />
|
||||
</div>
|
||||
<div className="flex gap-2">
|
||||
<Button
|
||||
type="button"
|
||||
size="sm"
|
||||
disabled={updateTerm.isPending}
|
||||
onClick={() =>
|
||||
updateTerm.mutate(
|
||||
{ vocabularyId, termId: term.id, external_uri: uri.trim() || null, labels },
|
||||
{ onSuccess: () => setEditing(false) },
|
||||
)
|
||||
}
|
||||
>
|
||||
{t("actions.save")}
|
||||
</Button>
|
||||
<Button type="button" variant="ghost" size="sm" onClick={() => setEditing(false)}>
|
||||
{t("form.cancel")}
|
||||
</Button>
|
||||
</div>
|
||||
</li>
|
||||
);
|
||||
}
|
||||
const update = useUpdateTerm();
|
||||
const del = useDeleteTerm();
|
||||
|
||||
return (
|
||||
<li className="flex items-center gap-2 border-b py-1 text-sm">
|
||||
<div className="flex-1">
|
||||
<div>{labelText(term.labels, lang)}</div>
|
||||
{term.external_uri && <ExternalUriLink uri={term.external_uri} />}
|
||||
</div>
|
||||
<Button
|
||||
type="button"
|
||||
variant="ghost"
|
||||
size="sm"
|
||||
onClick={() => {
|
||||
setLabels(term.labels as LabelInput[]);
|
||||
setUri(term.external_uri ?? "");
|
||||
setEditing(true);
|
||||
}}
|
||||
>
|
||||
{t("actions.edit")}
|
||||
</Button>
|
||||
<DeleteConfirmDialog
|
||||
description={t("actions.confirmDeleteTerm")}
|
||||
onConfirm={() => deleteTerm.mutateAsync({ vocabularyId, termId: term.id })}
|
||||
/>
|
||||
</li>
|
||||
<LabelledRecordRow
|
||||
record={{ ...term, external_uri: term.external_uri ?? null }}
|
||||
lang={lang}
|
||||
deleteConfirmKey="actions.confirmDeleteTerm"
|
||||
savePending={update.isPending}
|
||||
saveError={update.error}
|
||||
onEditOpen={() => update.reset()}
|
||||
onSave={(labels, uri, done) =>
|
||||
update.mutate({ vocabularyId, termId: term.id, external_uri: uri, labels }, { onSuccess: done })}
|
||||
onDelete={() => del.mutateAsync({ vocabularyId, termId: term.id })}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -3,17 +3,20 @@ import { NavLink } from "react-router-dom";
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import { useVocabularies, useCreateVocabulary, useRenameVocabulary, useDeleteVocabulary } from "../api/queries";
|
||||
import { useLang } from "../lib/use-lang";
|
||||
import { rowStateClass } from "../lib/class-recipes";
|
||||
import { byKey } from "../lib/sort";
|
||||
import { DeleteConfirmDialog } from "../components/delete-confirm-dialog";
|
||||
import { MutationError } from "../components/mutation-error";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { Label } from "@/components/ui/label";
|
||||
import { ListSkeleton } from "@/components/ui/skeletons";
|
||||
|
||||
export function VocabularyList() {
|
||||
const { t, i18n } = useTranslation();
|
||||
const { t } = useTranslation();
|
||||
|
||||
const lang = i18n.language.startsWith("sv") ? "sv" : "en";
|
||||
const lang = useLang();
|
||||
|
||||
const { data, isLoading, isError } = useVocabularies();
|
||||
|
||||
@@ -54,11 +57,7 @@ export function VocabularyList() {
|
||||
{t("vocab.create")}
|
||||
</Button>
|
||||
</div>
|
||||
{create.isError && (
|
||||
<p role="alert" className="text-xs text-destructive">
|
||||
{t("form.rejected")}
|
||||
</p>
|
||||
)}
|
||||
<MutationError error={create.error} />
|
||||
</form>
|
||||
<div className="border-b p-2">
|
||||
<Input
|
||||
@@ -106,18 +105,14 @@ export function VocabularyList() {
|
||||
<Button type="button" variant="ghost" size="sm" onClick={() => setEditingId(null)}>
|
||||
{t("form.cancel")}
|
||||
</Button>
|
||||
{renameVocabulary.isError && (
|
||||
<p role="alert" className="text-xs text-destructive">
|
||||
{t("form.rejected")}
|
||||
</p>
|
||||
)}
|
||||
<MutationError error={renameVocabulary.error} />
|
||||
</form>
|
||||
) : (
|
||||
<>
|
||||
<NavLink
|
||||
to={`/vocabularies/${v.id}`}
|
||||
className={({ isActive }) =>
|
||||
`block flex-1 px-3 py-2 text-sm ${isActive ? "bg-primary/10" : "hover:bg-muted"}`
|
||||
`block flex-1 px-3 py-2 text-sm ${rowStateClass(isActive)}`
|
||||
}
|
||||
>
|
||||
{v.key}
|
||||
|
||||
@@ -1,40 +1,21 @@
|
||||
import { useState, type FormEvent } from "react";
|
||||
import { useParams } from "react-router-dom";
|
||||
import { useTranslation } from "react-i18next";
|
||||
|
||||
import type { components } from "../api/schema";
|
||||
import { useTerms, useAddTerm, useVocabularies } from "../api/queries";
|
||||
import { byLabel } from "../lib/sort";
|
||||
import { labelText } from "../lib/labels";
|
||||
import { useLang } from "../lib/use-lang";
|
||||
import { useBreadcrumb } from "../shell/use-breadcrumb";
|
||||
import { LabelEditor } from "../components/label-editor";
|
||||
import { FilteredRecordList } from "../components/filtered-record-list";
|
||||
import { LabelledRecordCreateForm } from "../components/labelled-record-create-form";
|
||||
import { TermRow } from "./term-row";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { Label } from "@/components/ui/label";
|
||||
import { ListSkeleton } from "@/components/ui/skeletons";
|
||||
|
||||
type LabelInput = components["schemas"]["LabelInput"];
|
||||
|
||||
export function VocabularyTerms() {
|
||||
const { t, i18n } = useTranslation();
|
||||
|
||||
const { t } = useTranslation();
|
||||
const { id } = useParams();
|
||||
|
||||
const lang = i18n.language.startsWith("sv") ? "sv" : "en";
|
||||
const lang = useLang();
|
||||
|
||||
const { data: terms, isLoading, isError } = useTerms(id);
|
||||
|
||||
const addTerm = useAddTerm();
|
||||
|
||||
const [labels, setLabels] = useState<LabelInput[]>([]);
|
||||
|
||||
const [uri, setUri] = useState("");
|
||||
|
||||
const [filter, setFilter] = useState("");
|
||||
|
||||
const [error, setError] = useState(false);
|
||||
|
||||
const { data: vocabularies } = useVocabularies();
|
||||
const vocabKey = vocabularies?.find((v) => v.id === id)?.key;
|
||||
|
||||
@@ -46,85 +27,28 @@ export function VocabularyTerms() {
|
||||
|
||||
if (!id) return null;
|
||||
|
||||
const onAdd = (event: FormEvent) => {
|
||||
event.preventDefault();
|
||||
|
||||
if (!labels.some((l) => l.label)) {
|
||||
setError(true);
|
||||
return;
|
||||
}
|
||||
|
||||
setError(false);
|
||||
|
||||
addTerm.mutate(
|
||||
{ vocabularyId: id, external_uri: uri.trim() || null, labels },
|
||||
{ onSuccess: () => { setLabels([]); setUri(""); } },
|
||||
);
|
||||
};
|
||||
|
||||
const q = filter.trim().toLowerCase();
|
||||
const rows = [...(terms ?? [])]
|
||||
.filter((term) => !q || labelText(term.labels, lang).toLowerCase().includes(q))
|
||||
.sort(byLabel(lang));
|
||||
|
||||
return (
|
||||
<div className="overflow-auto p-4">
|
||||
<div className="mb-2 label-caption">
|
||||
{t("vocab.terms")}
|
||||
</div>
|
||||
<div className="mb-3">
|
||||
<Input
|
||||
aria-label={t("common.filter")}
|
||||
placeholder={t("common.filter")}
|
||||
value={filter}
|
||||
onChange={(e) => setFilter(e.target.value)}
|
||||
/>
|
||||
</div>
|
||||
{isLoading ? (
|
||||
<ListSkeleton className="mb-4" rows={5} />
|
||||
) : (
|
||||
<ul className="mb-4">
|
||||
{isError && (
|
||||
<li className="text-sm text-destructive">{t("vocab.loadError")}</li>
|
||||
)}
|
||||
{!isError && terms?.length === 0 && (
|
||||
<li className="text-sm text-muted-foreground">{t("vocab.noTerms")}</li>
|
||||
)}
|
||||
{!isError && terms && terms.length > 0 && rows.length === 0 && (
|
||||
<li className="text-sm text-muted-foreground">{t("common.noMatches")}</li>
|
||||
)}
|
||||
{rows.map((term) => (
|
||||
<TermRow key={term.id} vocabularyId={id} term={term} lang={lang} />
|
||||
))}
|
||||
</ul>
|
||||
)}
|
||||
<form onSubmit={onAdd} className="space-y-2 border-t pt-3">
|
||||
<div className="text-sm font-medium">{t("vocab.addTerm")}</div>
|
||||
<LabelEditor value={labels} onChange={setLabels} />
|
||||
<div className="space-y-1">
|
||||
<Label htmlFor="term-uri">{t("labels.externalUri")}</Label>
|
||||
<Input
|
||||
id="term-uri"
|
||||
type="url"
|
||||
placeholder={t("labels.uriPlaceholder")}
|
||||
value={uri}
|
||||
onChange={(e) => setUri(e.target.value)}
|
||||
/>
|
||||
</div>
|
||||
{error && (
|
||||
<p role="alert" className="text-xs text-destructive">
|
||||
{t("form.required")}
|
||||
</p>
|
||||
)}
|
||||
{addTerm.isError && (
|
||||
<p role="alert" className="text-xs text-destructive">
|
||||
{t("form.rejected")}
|
||||
</p>
|
||||
)}
|
||||
<Button type="submit" size="sm" disabled={addTerm.isPending}>
|
||||
{t("vocab.addTerm")}
|
||||
</Button>
|
||||
</form>
|
||||
<div className="mb-2 label-caption">{t("vocab.terms")}</div>
|
||||
|
||||
<FilteredRecordList
|
||||
records={terms}
|
||||
lang={lang}
|
||||
isLoading={isLoading}
|
||||
isError={isError}
|
||||
loadErrorText={t("vocab.loadError")}
|
||||
emptyText={t("vocab.noTerms")}
|
||||
renderRow={(term) => <TermRow vocabularyId={id} term={term} lang={lang} />}
|
||||
/>
|
||||
|
||||
<LabelledRecordCreateForm
|
||||
heading={t("vocab.addTerm")}
|
||||
submitLabel={t("vocab.addTerm")}
|
||||
pending={addTerm.isPending}
|
||||
error={addTerm.error}
|
||||
onCreate={(labels, uri, reset) =>
|
||||
addTerm.mutate({ vocabularyId: id, external_uri: uri, labels }, { onSuccess: reset })}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -28,6 +28,9 @@ export default defineConfig({
|
||||
extends: true,
|
||||
test: {
|
||||
environment: "jsdom",
|
||||
// The CI runner is heavily resource-constrained; lazy-loaded chunks
|
||||
// (e.g. the object-detail drawer) can exceed the 5s default.
|
||||
testTimeout: 20000,
|
||||
globals: true,
|
||||
setupFiles: ["./src/test/setup.ts"],
|
||||
environmentOptions: {
|
||||
@@ -46,6 +49,7 @@ export default defineConfig({
|
||||
})],
|
||||
test: {
|
||||
name: 'storybook',
|
||||
testTimeout: 20000,
|
||||
browser: {
|
||||
enabled: true,
|
||||
headless: true,
|
||||
|
||||
Reference in New Issue
Block a user