fee519b8a9
All checks were successful
CI / Unit & Component Tests (pull_request) Successful in 5m28s
CI / OCR Service Tests (pull_request) Successful in 26s
CI / Backend Unit Tests (pull_request) Successful in 6m25s
CI / fail2ban Regex (pull_request) Successful in 48s
CI / Semgrep Security Scan (pull_request) Successful in 25s
CI / Compose Bucket Idempotency (pull_request) Successful in 1m10s
SDD Gate / RTM Check (pull_request) Successful in 18s
SDD Gate / Contract Validate (pull_request) Successful in 28s
SDD Gate / Constitution Impact (pull_request) Successful in 17s
Route tables (CLAUDE.md + frontend/CLAUDE.md), the document/timeline.ts -> $lib/shared/utils/monthBuckets move (document + shared READMEs), GLOSSARY Lebensweg entry, the c4 l3-frontend people-stories diagram, and the RTM rows REQ-001..027 for feature zeitstrahl-global-view (#779), all marked Done. Refs #779 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
5.7 KiB
5.7 KiB
shared (frontend)
Cross-domain utilities and UI primitives. Any file here is consumed by two or more domain folders and has no domain identity of its own.
Admission criteria (what belongs here)
A file belongs in shared/ if it meets all three conditions:
- No domain identity — it does not represent a
Document,Person,Tag, etc. - Consumed by ≥ 2 domain folders — or is framework infrastructure that every domain depends on.
- Generic — could work in a different SvelteKit project with zero business-logic changes.
If any condition fails, the file belongs in the domain folder of its primary consumer.
What this folder owns
| Sub-folder / file | Purpose |
|---|---|
api.server.ts |
Typed openapi-fetch client factory — the standard entry point for all backend API calls in server-side load functions and actions |
errors.ts |
Mirror of the backend ErrorCode enum + getErrorMessage() → Paraglide i18n key mapping |
types.ts |
Cross-domain TypeScript interfaces |
utils.ts |
Pure utility functions (date formatting, sorting, debounce) |
utils/monthBuckets.ts |
Pure month-bucket math (boundaries, sequences, gap-fill, year aggregation, axis ticks) shared by the document/ density chart and the timeline/ density strip — moved up from document/timeline.ts so timeline/ need not import document/ |
primitives/Sparkline.svelte |
Fixed-series bar sparkline (one bar per value) — used by the timeline density strip |
relativeTime.ts |
Human-relative time formatting ("2 days ago") |
primitives/ |
Generic UI components: BackButton.svelte, form inputs, pagination, layout shells |
discussion/ |
Comment/mention editor shared by document/ and geschichte/ |
dashboard/ |
Family Pulse widget and recent-activity components assembled in the / route |
hooks/ |
Svelte 5 reactive hooks: useTypeahead, useUnsavedWarning |
services/ |
Generic client-side service helpers |
actions/ |
Shared SvelteKit form action utilities |
server/ |
Server-only shared utilities (load function helpers) |
help/ |
Coach marks and empty-state components used across multiple domains |
What does NOT belong here
- Components owned by one domain — move to that domain's folder.
- Domain-specific business logic — even if shared, it belongs in the owning domain's public surface.
Adding to shared/
If you need to add a file here, confirm it meets all three admission criteria. If it's domain-adjacent, check whether the owning domain should export it as part of its public surface instead.