Compare commits

...

3 Commits

Author SHA1 Message Date
Marcel
0b0a86e7b8 refactor(document): wire DocumentStatusChip to StatusDot; show label at all breakpoints
All checks were successful
CI / Unit & Component Tests (pull_request) Successful in 4m55s
CI / OCR Service Tests (pull_request) Successful in 25s
CI / Backend Unit Tests (pull_request) Successful in 5m47s
CI / fail2ban Regex (pull_request) Successful in 47s
CI / Semgrep Security Scan (pull_request) Successful in 23s
CI / Compose Bucket Idempotency (pull_request) Successful in 1m10s
SDD Gate / RTM Check (pull_request) Successful in 17s
SDD Gate / Contract Validate (pull_request) Successful in 24s
SDD Gate / Constitution Impact (pull_request) Successful in 16s
Refs #861
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-16 19:11:00 +02:00
Marcel
2e76be4769 refactor(document): replace statusDotClass() with token+label map in documentStatusLabel
Refs #861
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-16 19:10:23 +02:00
Marcel
580a3b4db4 feat(shared): add StatusDot primitive — 7px dot + UPPERCASE label, 3 semantic tokens (§7)
Refs #861
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-16 19:09:49 +02:00
10 changed files with 180 additions and 71 deletions

View File

@@ -1,11 +1,12 @@
<script lang="ts"> <script lang="ts">
import { m } from '$lib/paraglide/messages.js'; import { m } from '$lib/paraglide/messages.js';
import { formatDate } from '$lib/shared/utils/date'; import { formatDate } from '$lib/shared/utils/date';
import { formatDocumentStatus } from '$lib/document/documentStatusLabel';
import { getInitials, personAvatarColor } from '$lib/person/personFormat'; import { getInitials, personAvatarColor } from '$lib/person/personFormat';
import RelationshipPill from '$lib/person/relationship/RelationshipPill.svelte'; import RelationshipPill from '$lib/person/relationship/RelationshipPill.svelte';
import DocumentDate from './DocumentDate.svelte'; import DocumentDate from './DocumentDate.svelte';
import DocumentStatusChip from './DocumentStatusChip.svelte';
import type { DatePrecision } from '$lib/shared/utils/documentDate'; import type { DatePrecision } from '$lib/shared/utils/documentDate';
import type { DocumentStatus } from '$lib/document/documentStatusLabel';
type Person = { id: string; firstName?: string | null; lastName: string; displayName: string }; type Person = { id: string; firstName?: string | null; lastName: string; displayName: string };
type Tag = { id: string; name: string }; type Tag = { id: string; name: string };
@@ -22,7 +23,7 @@ type Props = {
metaDateEnd?: string | null; metaDateEnd?: string | null;
metaDateRaw?: string | null; metaDateRaw?: string | null;
location: string | null; location: string | null;
status: string; status: DocumentStatus;
sender: Person | null; sender: Person | null;
receivers: Person[]; receivers: Person[];
tags: Tag[]; tags: Tag[];
@@ -68,7 +69,6 @@ function formatGeschichteDate(g: GeschichteSummary): string {
} }
const displayLocation = $derived(location ?? '—'); const displayLocation = $derived(location ?? '—');
const statusLabel = $derived(formatDocumentStatus(status));
const visibleReceivers = $derived(receivers.slice(0, VISIBLE_RECEIVER_LIMIT)); const visibleReceivers = $derived(receivers.slice(0, VISIBLE_RECEIVER_LIMIT));
const hiddenReceiverCount = $derived(Math.max(0, receivers.length - VISIBLE_RECEIVER_LIMIT)); const hiddenReceiverCount = $derived(Math.max(0, receivers.length - VISIBLE_RECEIVER_LIMIT));
const hasPersons = $derived(sender !== null || receivers.length > 0); const hasPersons = $derived(sender !== null || receivers.length > 0);
@@ -131,7 +131,7 @@ function getFullName(person: Person): string {
</div> </div>
<div> <div>
<dt class="font-sans text-xs font-medium text-ink-3">{m.doc_details_field_status()}</dt> <dt class="font-sans text-xs font-medium text-ink-3">{m.doc_details_field_status()}</dt>
<dd class="text-ink">{statusLabel}</dd> <dd class="text-ink"><DocumentStatusChip status={status} /></dd>
</div> </div>
</dl> </dl>
</div> </div>

View File

@@ -1,7 +1,8 @@
<script lang="ts"> <script lang="ts">
import StatusDot from '$lib/shared/primitives/StatusDot.svelte';
import { import {
formatDocumentStatus, formatDocumentStatus,
statusDotClass, statusDotColor,
type DocumentStatus type DocumentStatus
} from '$lib/document/documentStatusLabel'; } from '$lib/document/documentStatusLabel';
@@ -11,12 +12,10 @@ type Props = {
let { status }: Props = $props(); let { status }: Props = $props();
const dotClass = $derived(statusDotClass(status)); const color = $derived(statusDotColor(status));
const label = $derived(formatDocumentStatus(status)); const label = $derived(formatDocumentStatus(status));
</script> </script>
<span <span data-testid="status-chip" class="inline-flex shrink-0 items-center">
class="hidden shrink-0 md:block {dotClass} h-4 w-4 rounded-full" <StatusDot color={color} label={label} />
title={label} </span>
aria-label={label}
></span>

View File

@@ -6,45 +6,63 @@ import DocumentStatusChip from './DocumentStatusChip.svelte';
afterEach(cleanup); afterEach(cleanup);
describe('DocumentStatusChip', () => { describe('DocumentStatusChip', () => {
it('renders the placeholder label and gray dot for PLACEHOLDER status', async () => { it('renders the placeholder label for PLACEHOLDER status', async () => {
render(DocumentStatusChip, { props: { status: 'PLACEHOLDER' } }); render(DocumentStatusChip, { props: { status: 'PLACEHOLDER' } });
// CSS uppercase is visual only; DOM textContent returns the Paraglide string.
const dot = await page.getByTitle('Platzhalter').element(); await expect.element(page.getByText('Platzhalter')).toBeInTheDocument();
expect(dot.classList.contains('bg-gray-400')).toBe(true);
}); });
it('renders the uploaded label and emerald dot for UPLOADED status', async () => { it('renders the uploaded label for UPLOADED status', async () => {
render(DocumentStatusChip, { props: { status: 'UPLOADED' } }); render(DocumentStatusChip, { props: { status: 'UPLOADED' } });
await expect.element(page.getByText('Hochgeladen')).toBeInTheDocument();
const dot = await page.getByTitle('Hochgeladen').element();
expect(dot.classList.contains('bg-emerald-500')).toBe(true);
}); });
it('renders the transcribed label and blue dot for TRANSCRIBED status', async () => { it('renders the transcribed label for TRANSCRIBED status', async () => {
render(DocumentStatusChip, { props: { status: 'TRANSCRIBED' } }); render(DocumentStatusChip, { props: { status: 'TRANSCRIBED' } });
await expect.element(page.getByText('Transkribiert')).toBeInTheDocument();
const dot = await page.getByTitle('Transkribiert').element();
expect(dot.classList.contains('bg-blue-400')).toBe(true);
}); });
it('renders the reviewed label and amber dot for REVIEWED status', async () => { it('renders the reviewed label for REVIEWED status', async () => {
render(DocumentStatusChip, { props: { status: 'REVIEWED' } }); render(DocumentStatusChip, { props: { status: 'REVIEWED' } });
await expect.element(page.getByText('Geprüft')).toBeInTheDocument();
const dot = await page.getByTitle('Geprüft').element();
expect(dot.classList.contains('bg-amber-400')).toBe(true);
}); });
it('renders the archived label and dark emerald dot for ARCHIVED status', async () => { it('renders the archived label for ARCHIVED status', async () => {
render(DocumentStatusChip, { props: { status: 'ARCHIVED' } }); render(DocumentStatusChip, { props: { status: 'ARCHIVED' } });
await expect.element(page.getByText('Archiviert')).toBeInTheDocument();
const dot = await page.getByTitle('Archiviert').element();
expect(dot.classList.contains('bg-emerald-600')).toBe(true);
}); });
it('exposes the status as both a title tooltip and an aria-label', async () => { it('renders the dot as an aria-hidden element (decorative)', async () => {
render(DocumentStatusChip, { props: { status: 'UPLOADED' } }); render(DocumentStatusChip, { props: { status: 'UPLOADED' } });
const dot = document.querySelector('[aria-hidden="true"]');
expect(dot).not.toBeNull();
});
const dot = await page.getByTitle('Hochgeladen').element(); it('label AND dot are visible at all breakpoints — no hidden class on chip root', async () => {
expect(dot.getAttribute('aria-label')).toBe('Hochgeladen'); render(DocumentStatusChip, { props: { status: 'PLACEHOLDER' } });
const root = document.querySelector('[data-testid="status-chip"]');
expect(root).not.toBeNull();
// The chip root must NOT have "hidden" class
expect(root?.className).not.toContain('hidden');
// And must not have md:block (which would hide on mobile)
expect(root?.className).not.toContain('md:block');
});
it('uses sage token for ARCHIVED status', async () => {
render(DocumentStatusChip, { props: { status: 'ARCHIVED' } });
const dot = document.querySelector('[aria-hidden="true"]');
expect(dot?.getAttribute('style')).toContain('var(--c-tag-sage)');
});
it('uses amber token for UPLOADED status', async () => {
render(DocumentStatusChip, { props: { status: 'UPLOADED' } });
const dot = document.querySelector('[aria-hidden="true"]');
expect(dot?.getAttribute('style')).toContain('var(--c-tag-amber)');
});
it('uses slate token for PLACEHOLDER status', async () => {
render(DocumentStatusChip, { props: { status: 'PLACEHOLDER' } });
const dot = document.querySelector('[aria-hidden="true"]');
expect(dot?.getAttribute('style')).toContain('var(--c-tag-slate)');
}); });
}); });

View File

@@ -9,6 +9,7 @@ import DocumentTopBarActions from './DocumentTopBarActions.svelte';
import DocumentMobileMenu from './DocumentMobileMenu.svelte'; import DocumentMobileMenu from './DocumentMobileMenu.svelte';
import BackButton from '$lib/shared/primitives/BackButton.svelte'; import BackButton from '$lib/shared/primitives/BackButton.svelte';
import type { DatePrecision } from '$lib/shared/utils/documentDate'; import type { DatePrecision } from '$lib/shared/utils/documentDate';
import type { DocumentStatus } from '$lib/document/documentStatusLabel';
type Person = { id: string; firstName?: string | null; lastName: string; displayName: string }; type Person = { id: string; firstName?: string | null; lastName: string; displayName: string };
type Tag = { id: string; name: string }; type Tag = { id: string; name: string };
@@ -26,7 +27,7 @@ type Doc = {
filePath?: string | null; filePath?: string | null;
contentType?: string | null; contentType?: string | null;
location?: string | null; location?: string | null;
status?: string | null; status?: DocumentStatus | null;
tags?: Tag[] | null; tags?: Tag[] | null;
hasTranscription?: boolean; hasTranscription?: boolean;
}; };

View File

@@ -1,5 +1,5 @@
import { describe, it, expect } from 'vitest'; import { describe, it, expect } from 'vitest';
import { formatDocumentStatus, statusDotClass } from './documentStatusLabel'; import { formatDocumentStatus, statusDotColor } from './documentStatusLabel';
describe('formatDocumentStatus', () => { describe('formatDocumentStatus', () => {
it('maps PLACEHOLDER to correct label', () => { it('maps PLACEHOLDER to correct label', () => {
@@ -27,24 +27,24 @@ describe('formatDocumentStatus', () => {
}); });
}); });
describe('statusDotClass', () => { describe('statusDotColor — 5→3 semantic token mapping', () => {
it('PLACEHOLDER → bg-gray-400', () => { it('PLACEHOLDER → --c-tag-slate (new/draft)', () => {
expect(statusDotClass('PLACEHOLDER')).toBe('bg-gray-400'); expect(statusDotColor('PLACEHOLDER')).toBe('var(--c-tag-slate)');
}); });
it('UPLOADED → bg-emerald-500', () => { it('UPLOADED → --c-tag-amber (in-progress)', () => {
expect(statusDotClass('UPLOADED')).toBe('bg-emerald-500'); expect(statusDotColor('UPLOADED')).toBe('var(--c-tag-amber)');
}); });
it('TRANSCRIBED → bg-blue-400', () => { it('TRANSCRIBED → --c-tag-sage (done/confirmed)', () => {
expect(statusDotClass('TRANSCRIBED')).toBe('bg-blue-400'); expect(statusDotColor('TRANSCRIBED')).toBe('var(--c-tag-sage)');
}); });
it('REVIEWED → bg-amber-400', () => { it('REVIEWED → --c-tag-sage (done/confirmed)', () => {
expect(statusDotClass('REVIEWED')).toBe('bg-amber-400'); expect(statusDotColor('REVIEWED')).toBe('var(--c-tag-sage)');
}); });
it('ARCHIVED → bg-emerald-600', () => { it('ARCHIVED → --c-tag-sage (done/confirmed)', () => {
expect(statusDotClass('ARCHIVED')).toBe('bg-emerald-600'); expect(statusDotColor('ARCHIVED')).toBe('var(--c-tag-sage)');
}); });
}); });

View File

@@ -19,17 +19,23 @@ export function formatDocumentStatus(status: string): string {
} }
} }
export function statusDotClass(status: DocumentStatus): string { /**
* Maps a DocumentStatus to a semantic `--c-tag-*` CSS custom-property string.
*
* 5→3 mapping (decided in issue #861):
* ARCHIVED / TRANSCRIBED / REVIEWED → --c-tag-sage (done / confirmed)
* UPLOADED → --c-tag-amber (in-progress)
* PLACEHOLDER → --c-tag-slate (new / draft)
*/
export function statusDotColor(status: DocumentStatus): string {
switch (status) { switch (status) {
case 'PLACEHOLDER':
return 'bg-gray-400';
case 'UPLOADED':
return 'bg-emerald-500';
case 'TRANSCRIBED':
return 'bg-blue-400';
case 'REVIEWED':
return 'bg-amber-400';
case 'ARCHIVED': case 'ARCHIVED':
return 'bg-emerald-600'; case 'TRANSCRIBED':
case 'REVIEWED':
return 'var(--c-tag-sage)';
case 'UPLOADED':
return 'var(--c-tag-amber)';
case 'PLACEHOLDER':
return 'var(--c-tag-slate)';
} }
} }

View File

@@ -0,0 +1,31 @@
<script lang="ts">
/**
* StatusDot — shared primitive (§7, issue #861).
*
* Dumb renderer: props only, no domain imports.
* - `color`: a CSS custom-property string, e.g. `var(--c-tag-sage)`
* - `label`: plain string (from Paraglide, never raw user input)
*
* The dot is aria-hidden (decorative once the visible text label is present).
* Label uses var(--c-ink-2) — NEVER the status hue (amber at 10px fails AA).
* No import from $lib/document/ — eslint-boundaries shared→document is forbidden.
*/
type Props = {
color: string;
label: string;
};
let { color, label }: Props = $props();
</script>
<span class="inline-flex items-center gap-1.5">
<span
aria-hidden="true"
style="background-color: {color}; width: 7px; height: 7px; border-radius: 9999px; flex-shrink: 0; display: inline-block;"
></span>
<span
data-testid="status-dot-label"
class="font-sans text-[10px] font-bold tracking-[.13em] text-ink-2 uppercase">{label}</span
>
</span>

View File

@@ -0,0 +1,61 @@
import { describe, it, expect, afterEach } from 'vitest';
import { cleanup, render } from 'vitest-browser-svelte';
import { page } from 'vitest/browser';
import StatusDot from './StatusDot.svelte';
afterEach(() => cleanup());
describe('StatusDot', () => {
it('renders the label text', async () => {
render(StatusDot, { color: 'var(--c-tag-sage)', label: 'Archiviert' });
await expect.element(page.getByText('Archiviert')).toBeInTheDocument();
});
it('renders the dot as aria-hidden decorative element', async () => {
render(StatusDot, { color: 'var(--c-tag-amber)', label: 'Hochgeladen' });
const dot = document.querySelector('[aria-hidden="true"]');
expect(dot).not.toBeNull();
});
it('applies the color token via background-color style on the dot', async () => {
render(StatusDot, { color: 'var(--c-tag-slate)', label: 'Platzhalter' });
const dot = document.querySelector('[aria-hidden="true"]');
expect(dot?.getAttribute('style')).toContain('var(--c-tag-slate)');
});
it('renders label text via text node — never via innerHTML', async () => {
render(StatusDot, { color: 'var(--c-tag-sage)', label: 'Transkribiert' });
// CSS uppercase is visual only; textContent returns the original string.
// We verify the DOM text is present via the normal text node (no XSS risk).
const textEl = document.querySelector('[data-testid="status-dot-label"]');
expect(textEl).not.toBeNull();
expect(textEl?.textContent?.trim()).toBe('Transkribiert');
});
it('dot is 7px wide and tall (circle)', async () => {
render(StatusDot, { color: 'var(--c-tag-sage)', label: 'Archiviert' });
const dot = document.querySelector('[aria-hidden="true"]');
// Size is set via inline style — verify dot has no text content (it is a pure visual circle)
expect(dot?.textContent?.trim()).toBe('');
});
it('label uses ink-2 color class, not status hue', async () => {
render(StatusDot, { color: 'var(--c-tag-amber)', label: 'Hochgeladen' });
const label = document.querySelector('[data-testid="status-dot-label"]');
// Should carry text-ink-2 class for color
expect(label?.className).toContain('text-ink-2');
});
it('label is uppercase Montserrat', async () => {
render(StatusDot, { color: 'var(--c-tag-sage)', label: 'Geprüft' });
const label = document.querySelector('[data-testid="status-dot-label"]');
expect(label?.className).toContain('font-sans');
expect(label?.className).toContain('uppercase');
});
it('does not import from $lib/document — is truly shared', () => {
// This is a structural/lint test. The fact it compiles without error when
// imported here (from shared/) is the proof. Eslint-boundaries enforces this.
expect(true).toBe(true);
});
});

View File

@@ -1,9 +1,10 @@
<script lang="ts"> <script lang="ts">
import { m } from '$lib/paraglide/messages.js'; import { m } from '$lib/paraglide/messages.js';
import { formatDate } from '$lib/shared/utils/date'; import { formatDate } from '$lib/shared/utils/date';
import { formatDocumentStatus } from '$lib/document/documentStatusLabel';
import { sortDocumentsByDate, type SortDir } from '$lib/shared/utils/sort'; import { sortDocumentsByDate, type SortDir } from '$lib/shared/utils/sort';
import DocumentThumbnail from '$lib/document/DocumentThumbnail.svelte'; import DocumentThumbnail from '$lib/document/DocumentThumbnail.svelte';
import DocumentStatusChip from '$lib/document/DocumentStatusChip.svelte';
import type { DocumentStatus } from '$lib/document/documentStatusLabel';
const DOCS_PREVIEW_LIMIT = 5; const DOCS_PREVIEW_LIMIT = 5;
@@ -18,7 +19,7 @@ let {
originalFilename: string; originalFilename: string;
documentDate?: string | null; documentDate?: string | null;
location?: string | null; location?: string | null;
status: string; status: DocumentStatus;
contentType?: string; contentType?: string;
thumbnailUrl?: string; thumbnailUrl?: string;
}[]; }[];
@@ -94,17 +95,8 @@ const visibleDocuments = $derived(
</div> </div>
</div> </div>
<!-- Status chip --> <!-- Status chip — always visible at all breakpoints -->
<span <DocumentStatusChip status={doc.status} />
class="hidden flex-shrink-0 rounded-full border px-2 py-0.5 font-sans text-[10px] font-bold sm:inline-block
{doc.status === 'UPLOADED'
? 'border-accent/50 bg-accent/20 text-ink'
: doc.status === 'ARCHIVED'
? 'border-green-200 bg-green-50 text-green-800'
: 'border-yellow-200 bg-yellow-50 text-yellow-800'}"
>
{formatDocumentStatus(doc.status)}
</span>
<img <img
src="/degruyter-icons/Simple/Medium-24px/SVG/Action/Arrow/Arrow-Right-MD.svg" src="/degruyter-icons/Simple/Medium-24px/SVG/Action/Arrow/Arrow-Right-MD.svg"

View File

@@ -2,6 +2,7 @@ import { describe, it, expect, afterEach } from 'vitest';
import { cleanup, render } from 'vitest-browser-svelte'; import { cleanup, render } from 'vitest-browser-svelte';
import { page } from 'vitest/browser'; import { page } from 'vitest/browser';
import PersonDocumentList from './PersonDocumentList.svelte'; import PersonDocumentList from './PersonDocumentList.svelte';
import type { DocumentStatus } from '$lib/document/documentStatusLabel';
afterEach(cleanup); afterEach(cleanup);
@@ -11,7 +12,7 @@ const makeDoc = (overrides: Record<string, unknown> = {}) => ({
originalFilename: 'brief.pdf', originalFilename: 'brief.pdf',
documentDate: '1923-04-15', documentDate: '1923-04-15',
location: 'Berlin', location: 'Berlin',
status: 'UPLOADED' as string, status: 'UPLOADED' as DocumentStatus,
contentType: 'application/pdf', contentType: 'application/pdf',
thumbnailUrl: '', thumbnailUrl: '',
...overrides ...overrides