Plugin-SDK: Oberflächen für Kunden-Plugins, Generator, Doku (0.20.0)
Some checks failed
CI / PHP 8.3 / mariadb:10.6 (pull_request) Successful in 3m46s
CI / PHP 8.4 / mariadb:10.6 (pull_request) Successful in 3m49s
CI / PHP 8.3 / mariadb:11.4 (pull_request) Successful in 4m7s
CI / PHP 8.4 / mariadb:11.4 (pull_request) Successful in 4m8s
CI / PHP 8.3 / mysql:8.0 (pull_request) Failing after 5m51s
CI / PHP 8.4 / mysql:8.0 (pull_request) Failing after 6m29s
CI / PHP 8.3 / mysql:8.4 (pull_request) Failing after 6m12s
CI / Build-Artefakte aktuell (pull_request) Successful in 1m11s
CI / PHP 8.4 / mysql:8.4 (pull_request) Failing after 5m33s
Some checks failed
CI / PHP 8.3 / mariadb:10.6 (pull_request) Successful in 3m46s
CI / PHP 8.4 / mariadb:10.6 (pull_request) Successful in 3m49s
CI / PHP 8.3 / mariadb:11.4 (pull_request) Successful in 4m7s
CI / PHP 8.4 / mariadb:11.4 (pull_request) Successful in 4m8s
CI / PHP 8.3 / mysql:8.0 (pull_request) Failing after 5m51s
CI / PHP 8.4 / mysql:8.0 (pull_request) Failing after 6m29s
CI / PHP 8.3 / mysql:8.4 (pull_request) Failing after 6m12s
CI / Build-Artefakte aktuell (pull_request) Successful in 1m11s
CI / PHP 8.4 / mysql:8.4 (pull_request) Failing after 5m33s
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
46b7b05f94
commit
ea2200cb3e
353 changed files with 2151 additions and 1542 deletions
|
|
@ -486,7 +486,7 @@ Kantinenplan, Ideenbox, Urlaubsanträge.
|
|||
| **4b – Formulare & Umstieg** ✅ | Formular-Plugin (visueller Baukasten im Portal, Bedingungen, Uploads, anonyme Formulare, Mail + Backend, Ergebnis-Rechte je Formular und Rolle, CSV, Löschfristen; eingebunden per Pagebuilder-Block und unter Beiträgen, kein eigener Menüpunkt); WordPress-Import (Beiträge, Kategorien, Bilder, Seiten); E-Mail-Versand im Admin; anpassbare Startseite mit eigenen Kacheln; Geburtstage (optionales Plugin) |
|
||||
| **5 – Branding & Theming** ✅ | Vollständige Seite „Erscheinungsbild“: Logo-Varianten, Farben inkl. Farbtreue & Kontrastprüfung, Schriften, Form, Login-Seite, E-Mails, Live-Vorschau, Entwurf/Veröffentlichen, Export/Import |
|
||||
| **6 – Weitere Plugins & IdPs** ✅ | ✅ Organigramm (aus Vorgesetzten, im Admin pflegbar), ✅ Downloads (Ordner mit vererbten Rechten und Sichtbarkeit, Versionen, Suche, Favoriten, Pagebuilder-Block – früher „Dokumente“); ✅ Qualitätsmanagement (Kategorien, farbige Ordner mit Symbolen, Einführung, Ansprechpartner, Versionen mit Stand und Archiv, Volltextsuche inkl. OCR-Anbindung, PDF-Betrachter, Rollen-Ausschluss; vorbereitet: Wiedervorlage, Lesebestätigung); ✅ Speiseplan (Wochenbilder, PDF → Bild, A4-Druck); ✅ „Gemeinsam feiern, erinnern und willkommen heißen“ (Personalnachrichten je Monat); ✅ Monatsspruch als erstes separat installierbares Plugin (eigenes Repo); ✅ OIDC generisch, LDAP/AD, SAML 2 (als Plugins auf gemeinsamem Treiber-Unterbau); ✅ IT-Service über OpenNIT; ✅ Mediathek mit Verwendungsnachweis; ✅ globale Suche; ✅ Kommentare unter Neuigkeiten; ✅ Rollen-Ausschluss für Inhalte und Module; ✅ Lasttest 5.000 Personen (docs/LASTTEST.md) |
|
||||
| **7 – Plugin-SDK öffentlich** | Doku, Generator, Beispiel-Plugins (kein Plugin-Verzeichnis) |
|
||||
| **7 – Plugin-SDK öffentlich** ✅ | Vorkompilierte Oberflächen für Kunden-Plugins (Import Map mit `vue`, `@inertiajs/vue3`, `@inhaus/ui`), Generator `inhaus:make-plugin` mit Build-Voreinstellung und Paketier-Skript, Tailwind mit Design-Tokens und Präfix `ih:`, Doku in docs/PLUGINS.md (kein Plugin-Verzeichnis) |
|
||||
| **8 – Mobil** | REST-API (Sanctum), Web-Push, native App |
|
||||
|
||||
Begründung für Phase 1: Ohne Self-Updater erreicht jede spätere Version
|
||||
|
|
|
|||
104
docs/PLUGINS.md
104
docs/PLUGINS.md
|
|
@ -156,18 +156,100 @@ $this->app->make(Blocks::class)->add(BlockType::make('mein-plugin.liste', 'Meine
|
|||
Absturz –, wird es automatisch deaktiviert; der Grund steht auf der Plugins-Seite.
|
||||
- `INHAUS_DISALLOW_FILE_MODS=true` in der `.env` verbietet Hochladen und Löschen.
|
||||
|
||||
## Kacheln ohne eigene Oberfläche
|
||||
## Eigene Oberflächen mit dem Plugin-SDK
|
||||
|
||||
Kunden-Plugins können (bis zum Plugin-SDK) keine eigenen Vue-Komponenten mitbringen, aber
|
||||
die allgemeinen Kacheln des Kerns mit Inhalt füllen:
|
||||
Mitgelieferte Plugins werden mit dem Kern gebaut. Kunden-Plugins bringen ihre
|
||||
Vue-Komponenten **vorkompiliert** mit (`dist/`). Vue, Inertia und die
|
||||
Portal-Bausteine liefert das Portal über eine Import Map. Alle Plugins
|
||||
nutzen also dieselbe Vue-Instanz, dieselben Farben und dasselbe
|
||||
Erscheinungsbild. Auf dem Kundenserver wird dafür weder Node noch ein Build
|
||||
gebraucht.
|
||||
|
||||
### Neues Plugin anlegen
|
||||
|
||||
```bash
|
||||
php artisan inhaus:make-plugin mav-kalender --name="MAV-Kalender" --author="MAV"
|
||||
cd plugins/mav-kalender
|
||||
npm install
|
||||
npm run build # erzeugt dist/ – danach unter Administration → Plugins aktivieren
|
||||
npm run dev # baut bei jeder Änderung neu (Seite neu laden)
|
||||
npm run package # baut und erzeugt mav-kalender-1.0.0.zip zum Hochladen
|
||||
```
|
||||
|
||||
Mit `--path=…` legen Sie das Plugin außerhalb des Portals an, etwa als eigenes
|
||||
Repository. Dann laden Sie das ZIP unter „Plugins“ hoch. Das Gerüst enthält:
|
||||
|
||||
- `plugin.json` und die Einstiegsklasse mit einem Menüpunkt und einer Startseiten-Kachel;
|
||||
- einen Controller mit Route;
|
||||
- eine Seite `resources/js/pages/Index.vue` und eine Kachel `resources/js/widgets/Hello.vue`;
|
||||
- `resources/css/style.css`;
|
||||
- `inhaus-sdk/`: die Build-Voreinstellung und die Design-Tokens, kopiert aus dem Portal.
|
||||
|
||||
### Komponenten-Arten
|
||||
|
||||
Name in PHP: immer `slug::Name`. Die Datei ergibt sich aus Art und Name:
|
||||
|
||||
| Art | Datei | Angemeldet über |
|
||||
|---|---|---|
|
||||
| Seite | `resources/js/pages/Name.vue` | `Inertia::render('slug::Name', [...])` |
|
||||
| Startseiten-Kachel | `resources/js/widgets/Name.vue` | `Widgets::add($key, 'slug::Name', …)` |
|
||||
| Pagebuilder-Block | `resources/js/blocks/Name.vue` | `BlockType::make(…, 'slug::Name')` |
|
||||
| Abschnitt „Profil bearbeiten“ | `resources/js/profile/Name.vue` | `ProfileSections::add(…)` |
|
||||
| Bereich im öffentlichen Profil | `resources/js/profile-panels/Name.vue` | `ProfilePanels::add(…)` |
|
||||
| Redaktions-Liste | `resources/js/editorial/Name.vue` | `Editorial::add(…)` |
|
||||
|
||||
Welche Dateien es gibt, verzeichnet `dist/inhaus.json`. Das Portal liest diese
|
||||
Datei und liefert Dateien unter `/plugin-assets/<slug>/<version>/…` aus –
|
||||
ausschließlich aus `dist/` aktiver Kunden-Plugins und nur bestimmte Dateitypen
|
||||
(JS, CSS, Bilder, Schriften). Die Version steht in der Adresse, Browser
|
||||
speichern die Dateien deshalb dauerhaft zwischen. Nach einer Änderung also die
|
||||
Version in `plugin.json` erhöhen.
|
||||
|
||||
### Was Plugins importieren dürfen
|
||||
|
||||
- `vue` – die Vue-Instanz des Portals (`ref`, `computed`, `onMounted` …).
|
||||
- `@inertiajs/vue3` – `router`, `usePage`, `useForm`, `Link`, `Head` …
|
||||
- `@inhaus/ui` – die Bausteine des Portals:
|
||||
- **Layout und Rahmen:** `AppLayout`, `PageHeader`, `Panel`, `EmptyState`.
|
||||
- **Formulare:** `FormField`, `NativeSelect`, `RichTextEditor`, `Button`, `Badge`,
|
||||
`Input`, `Textarea`, `Label`, `Checkbox`, `Switch`.
|
||||
- **Darstellung:** `Skeleton`, `Separator`, `PersonAvatar`, `AppIcon`
|
||||
(alle Lucide-Symbole des Portals), `FileIcon`.
|
||||
- **Mehrteilige Bausteine:** `Dialog…`, `DropdownMenu…`, `Tabs…`, `Tooltip…`, `Accordion…`.
|
||||
- **Hilfsfunktionen:** `http` / `HttpError` (JSON-Aufrufe mit CSRF), `formatDate`,
|
||||
`formatShortDate`, `formatTime`, `formatRelative`, `formatMonthYear`, `colorFor`, `toast`.
|
||||
|
||||
Diese Liste ist die öffentliche Schnittstelle (`resources/js/sdk/ui.js`): Was
|
||||
dort steht, bleibt innerhalb einer Hauptversion erhalten. Andere Pakete (etwa
|
||||
Lucide) bündelt der Build ins Plugin.
|
||||
|
||||
Seiten legen sich selbst ins Portal-Layout:
|
||||
|
||||
```vue
|
||||
<script setup>
|
||||
import { AppLayout, PageHeader, Panel } from '@inhaus/ui';
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<AppLayout title="MAV-Kalender">
|
||||
<PageHeader title="MAV-Kalender" />
|
||||
<Panel title="Nächste Sitzungen">…</Panel>
|
||||
</AppLayout>
|
||||
</template>
|
||||
```
|
||||
|
||||
### Styling
|
||||
|
||||
Tailwind steht mit den Design-Tokens des Portals zur Verfügung (`bg-card`,
|
||||
`text-brand-text`, `rounded-xl` …), jedoch mit dem Präfix **`ih:`**:
|
||||
`ih:grid ih:gap-6 ih:lg:grid-cols-2`. Das Präfix verhindert, dass die Klassen
|
||||
eines Plugins die des Portals überschreiben. Farben, Ecken und die Schrift
|
||||
folgen damit automatisch dem Erscheinungsbild. Die Portal-Bausteine selbst
|
||||
bringen ihr Styling mit.
|
||||
|
||||
### Kacheln ohne eigene Oberfläche
|
||||
|
||||
Wer keinen Build möchte, füllt die allgemeinen Kacheln des Kerns mit Inhalt:
|
||||
|
||||
- `core::Quote` – Spruch/Zitat: `title`, `text`, `source`, `note`, `link` (`{label, url}`).
|
||||
Beispiel: das Plugin „Monatsspruch“ (eigenes Repository `inhaus-plugin-monatsspruch`).
|
||||
|
||||
## Derzeit noch nicht für Kunden-Plugins
|
||||
|
||||
Vue-Seiten und Startseiten-Kacheln werden beim Build des Kerns mitkompiliert –
|
||||
das geht nur für mitgelieferte Plugins. Für Kunden-Plugins folgt mit dem
|
||||
öffentlichen Plugin-SDK (Phase 7) ein Weg über vorkompilierte ES-Module und
|
||||
eine Import-Map. Bis dahin können Kunden-Plugins Blade-Seiten, Admin-Seiten,
|
||||
Hooks, Rechte und Menüpunkte beitragen.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue