Files
breadcrumb-the-shire/docs/reference-extension-readiness.md
fs c7b8fd516a feat: extend module platform with UI slots, runtime components, CLI tooling and {{userId}} search support
Completes the generic module platform that enables modules to contribute
UI elements, runtime JS components, and search resources without any
core hardcoding.

New generic UI slot types:
- topbar.right_item: module-contributed topbar buttons
- layout.body_end_template: module-contributed dialog/overlay templates
- layout.head_style: module-contributed global CSS
- runtime.component: declarative JS component registration with phase ordering

New infrastructure:
- ModuleAutoloader: PSR-4 autoloading for module-local PHP classes
- ModuleRuntimePageBuilder: symlinks module pages into runtime directory
- ModuleRuntimeAssetPublisher: publishes module CSS/JS to web/modules/
- ModulePermissionSynchronizer: syncs module permissions to DB
- CLI scripts: module-runtime-sync, module-build, module-migrate,
  module-permissions-sync, module-assets-sync
- {{userId}} placeholder in SearchDataService for user-scoped search queries
- Component runtime with phased initialization (early/default/late)
- AppContainer.protectExistingBindings() to prevent module→core overwrites
- Architecture tests: ModuleStructureContractTest, CoreTemplateIsolationTest,
  FrontendComponentRuntimeContractTest, AppContainerIsolationContractTest

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-18 22:19:56 +01:00

58 lines
2.1 KiB
Markdown

# Extension-Readiness (Module-System V1.1)
Letzte Aktualisierung: 2026-03-18
## Ziel
Verbindliche Vorbedingungen fuer weitere eigenstaendige Module auf dem bestehenden Modul-System festhalten.
## Kanonische Quelle
Normativer Manifest- und Runtime-Contract: `/docs/reference-module-manifest-contract.md`.
Diese Readiness-Doku ist bewusst kurz und verweist fuer Felddefinitionen/Guards immer auf den Manifest-Contract.
## Readiness-Checkliste vor Modul 2+
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.
3. **Security + Scope absichern**
- AuthZ/RBAC serverseitig pruefen.
- Tenant-Scope serverseitig pruefen.
- POST-Mutationen mit CSRF absichern.
4. **Runtime-Hygiene absichern**
- `php bin/module-runtime-sync.php` 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 fuer neue Logik ergaenzen.
- `phpunit` und `phpstan` als Pflicht-Gates gruen.
6. **Daten- und Betriebsfaehigkeit**
- Schema-/Datenaenderungen fuer Bestandsinstallationen idempotent in `db/updates/*.sql`.
- Logs/Audit ohne unredacted PII/Secrets.
## Derzeit Out of Scope
- Eigener DB-Server oder Netzwerk-Microservice je Modul.
- Externe Drittanbieter-Module mit Legacy-Kompatibilitaet.
## Verfuegbare Core-Services fuer Module
JS-seitig:
- Confirm-Dialog (`confirmDialog`)
- Async-Flash (`showAsyncFlash`)
- DOM-Utilities (`app-dom.js`)
- CSRF-Metadaten über `data-csrf-key` / `data-csrf-token`
PHP-seitig:
- Guard (`MintyPHP\\Support\\Guard`)
- SessionStore (`MintyPHP\\Http\\SessionStoreInterface`)
- Flash (`MintyPHP\\Support\\Flash`)
- DI-Container (`MintyPHP\\App\\AppContainer`)
- Modul-Contracts (`LayoutContextProvider`, `SessionProvider`, `SearchResourceProvider`)