Files
breadcrumb-the-shire/docs/reference-extension-readiness.md

58 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

# Extension-Readiness (Module-System V1.1)
2026-03-09 18:30:52 +01:00
Letzte Aktualisierung: 2026-03-18
2026-03-09 18:30:52 +01:00
## Ziel
Verbindliche Vorbedingungen für weitere eigenstaendige Module auf dem bestehenden Modul-System festhalten.
2026-03-09 18:30:52 +01:00
## Kanonische Quelle
Normativer Manifest- und Runtime-Contract: `/docs/reference-module-manifest-contract.md`.
Diese Readiness-Doku ist bewusst kurz und verweist für Felddefinitionen/Guards immer auf den Manifest-Contract.
## Readiness-Checkliste vor Modul 2+
2026-03-09 18:30:52 +01:00
1. **Modulgrenzen klarziehen**
- Betroffene Schichten benoennen (`pages -> Service -> Repository`).
- Keine Modul-spezifischen Hardcodings im Core-Layout/Core-Routing.
2. **Manifest-Contract einhalten**
- `module.php` validiert gegen den kanonischen Contract (`permissions`, `scheduler_jobs`, `ui_slots`, `routes`).
- Route-/Slot-/Layout-Guards laufen fail-fast.
2026-03-09 18:30:52 +01:00
3. **Security + Scope absichern**
- AuthZ/RBAC serverseitig prüfen.
- Tenant-Scope serverseitig prüfen.
2026-03-09 18:30:52 +01:00
- POST-Mutationen mit CSRF absichern.
4. **Runtime-Hygiene absichern**
- `php bin/console module:sync` laeuft reproduzierbar mit standardisierter Step-Summary.
- Keine First-party CLI-Warnings/Notices/Deprecations; Vendor-Rauschen wird nur gezaehlt/reportet.
5. **Testbarkeit und Gates**
- Architektur- und Domain-Tests für neue Logik ergaenzen.
- `phpunit` und `phpstan` als Pflicht-Gates gruen.
6. **Daten- und Betriebsfaehigkeit**
- Schema-/Datenänderungen für Bestandsinstallationen idempotent in `db/updates/*.sql`.
2026-03-09 18:30:52 +01:00
- Logs/Audit ohne unredacted PII/Secrets.
## Derzeit Out of Scope
- Eigener DB-Server oder Netzwerk-Microservice je Modul.
- Externe Drittanbieter-Module mit Legacy-Kompatibilitaet.
## Verfügbare Core-Services für Module
2026-03-09 18:30:52 +01:00
JS-seitig:
2026-03-09 18:30:52 +01:00
- Confirm-Dialog (`confirmDialog`)
- Async-Flash (`showAsyncFlash`)
- DOM-Utilities (`app-dom.js`)
- CSRF-Metadaten über `data-csrf-key` / `data-csrf-token`
2026-03-09 18:30:52 +01:00
PHP-seitig:
2026-03-09 18:30:52 +01:00
- Guard (`MintyPHP\\Support\\Guard`)
- SessionStore (`MintyPHP\\Http\\SessionStoreInterface`)
- Flash (`MintyPHP\\Support\\Flash`)
- DI-Container (`MintyPHP\\App\\AppContainer`)
- Modul-Contracts (`LayoutContextProvider`, `SessionProvider`, `SearchResourceProvider`)