86 lines
3.7 KiB
Markdown
86 lines
3.7 KiB
Markdown
# M013 — View-Model-Konvention
|
|
|
|
**Block:** Querschnitt-Hülle Teil 2 (UI-Hot-Swap-Architektur)
|
|
**Architektur-Entscheidung:** Synchron im Loader, Zod-validiert
|
|
|
|
## Ziel
|
|
Naming-Pattern für View-Models, Discriminated-Unions für Loading/Error, Zod-Schema pro VM, ESLint-Rule gegen React-Imports im VM-Paket.
|
|
|
|
## Architektur-Bezug
|
|
Server bereitet VM einmal vor (synchron im Loader), UI rendert nur — kein client-seitiges Re-Compute.
|
|
|
|
## Abhängigkeiten
|
|
- **Vorbedingung:** M012
|
|
- **Wird benötigt von:** M014, M015, alle Module mit UI
|
|
|
|
## Out of Scope
|
|
- Action-Callbacks → M014
|
|
|
|
## Erfolgskriterium
|
|
Beispiel-VM (`KontaktDetailVM`) durchläuft kompletten Pfad: Loader baut, Zod validiert, UI rendert; React-Import in `packages/view-models/**` → Build-Fehler.
|
|
|
|
## Hinweise für Slice-Planung
|
|
- Naming-Konvention: `<Domain><Use>VM` (z.B. `KontaktListVM`, `KontaktDetailVM`)
|
|
- Discriminated-Union für Loading/Error/Success (`{state: 'loaded', data: ...}`)
|
|
- Zod-Schema neben Type für Runtime-Validierung
|
|
- Pure Functions: `toKontaktDetailVM(entity, ctx) → KontaktDetailVM`
|
|
|
|
|
|
---
|
|
|
|
## Definition of Done — verbindlich (siehe `AGENTS.md` + `docs/INTEGRATION-CONTRACTS.md`)
|
|
|
|
Dieses Milestone gilt **nur dann als erledigt**, wenn alle Punkte wahr sind. Bei Verstoß: PR-Block.
|
|
|
|
### Erreichbarkeit
|
|
- [ ] **Sidebar-Eintrag** in `packages/ui-hivegrid/src/app-shell/sidebar.config.ts` mit Permission-Gate (oder explizit dokumentiert, warum nur Inline-Verlinkung) — Gruppe gemäß `docs/INTEGRATION-CONTRACTS.md` §1
|
|
- [ ] **Route** unter korrektem URL-Pattern (INTEGRATION-CONTRACTS §3)
|
|
- [ ] **Breadcrumb** für Detail-Routes (§4)
|
|
- [ ] **Mobile-Tab-Bar-Eintrag** falls mobile-relevant (§13)
|
|
- [ ] **Customer-Portal-Sichtbarkeit** explizit konfiguriert (§14)
|
|
|
|
### Querschnitt-Wiring
|
|
- [ ] **Audit** läuft (auto via M001 oder manuell)
|
|
- [ ] **Activity-Stream** via `logActivity` bei relevanter Aktion (M045)
|
|
- [ ] **Notifications** via `notify()` (M011), nicht direkt
|
|
- [ ] **Search-Index** registriert in `indexed-entities.ts`, falls suchbar
|
|
- [ ] **Permission-Filter** via `withTenantScope()` + `withPermission()` (M004)
|
|
- [ ] **Feature-Flag-fähig** (M006) — Modul ohne Deploy abschaltbar
|
|
|
|
### Code-Layer-Disziplin (PR-Block)
|
|
- [ ] Loader baut View-Model; UI-Component empfängt nur VM + Actions
|
|
- [ ] Keine Prisma-/Server-Imports in `packages/ui-hivegrid/**`
|
|
- [ ] Subframe-Output via Adapter, nicht direkt importiert
|
|
- [ ] Alle UI-Texte als i18n-Keys (M003-Build-Lint blockt sonst)
|
|
|
|
### Tests
|
|
- [ ] **Unit-Test** für VM-Builder mit Zod-Schema-Validierung
|
|
- [ ] **Smoke-Test** `e2e/smoke/<modul>.spec.ts` (Login → Route → Hauptaktion → erwartetes UI)
|
|
- [ ] **Hot-Swap-Drill** grün (Smoke-Test gegen `packages/ui-mock` aus M017)
|
|
- [ ] **Visual-Regression-Snapshot** der Hauptansicht (M016)
|
|
|
|
### Klartext (User-facing)
|
|
- [ ] Fehler-Texte aus M002-Catalog (kein HTTP-Code im UI)
|
|
- [ ] Empty-State mit Klartext + nächster Aktion
|
|
- [ ] Loading-State mit Klartext (kein leerer Spinner)
|
|
- [ ] Permission-Denied → 404, nicht 403 (Bauprinzip A.5.3)
|
|
|
|
### Rollback-Pfad
|
|
- [ ] **Forward-Only-DB-Migration** mit Inverse-SQL als Kommentar
|
|
- [ ] **Atomic-Slice-Commits** (TC-Default)
|
|
- [ ] **Feature-Flag** vorhanden, um das Modul ohne Deploy auszuschalten
|
|
|
|
---
|
|
|
|
## Klick-Pfad zum Prüfen (für User)
|
|
|
|
Wenn dieses Milestone fertig ist, prüft der User die Funktion über folgenden Pfad:
|
|
|
|
1. Login als geeigneter User-Typ (siehe Erfolgskriterium oben)
|
|
2. Sidebar-Gruppe + Eintrag öffnen (gemäß INTEGRATION-CONTRACTS.md §1)
|
|
3. Hauptaktion ausführen
|
|
4. Erwartetes Ergebnis sichtbar (siehe Erfolgskriterium)
|
|
|
|
**Falls etwas nicht erreichbar ist:** Milestone ist trotz „grüner Tests" nicht fertig — siehe Erreichbarkeits-Checkliste oben.
|
|
|