@5minds/processcube_app_sdk 8.6.0 → 8.6.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -38
- package/build/client/index.cjs +11 -11
- package/build/client/index.mjs +10 -10
- package/package.json +1 -2
- package/build/client/index.css +0 -1
package/README.md
CHANGED
|
@@ -43,7 +43,7 @@ graph TD
|
|
|
43
43
|
|
|
44
44
|
### Export-Map
|
|
45
45
|
|
|
46
|
-
Das Paket hat drei Einstiegspunkte — jeder mit ESM- und CJS-Support
|
|
46
|
+
Das Paket hat drei Einstiegspunkte — jeder mit ESM- und CJS-Support. Komponenten-CSS wird beim Import automatisch vom Consumer-Bundler aufgelöst.
|
|
47
47
|
|
|
48
48
|
```mermaid
|
|
49
49
|
graph LR
|
|
@@ -51,21 +51,19 @@ graph LR
|
|
|
51
51
|
I1["import _ from<br/>'@5minds/processcube_app_sdk'"]
|
|
52
52
|
I2["import _ from<br/>'@5minds/processcube_app_sdk/server'"]
|
|
53
53
|
I3["import _ from<br/>'@5minds/processcube_app_sdk/client'"]
|
|
54
|
-
I4["import<br/>'…/client/components/*.css'"]
|
|
55
54
|
end
|
|
56
55
|
|
|
57
56
|
I1 --> Common["common/index.mjs<br/><small>.cjs</small>"]
|
|
58
57
|
I2 --> Server["server/index.mjs<br/><small>.cjs</small>"]
|
|
59
|
-
I3 --> Client["client/index.mjs<br/><small>.cjs</small>"]
|
|
60
|
-
I4 --> CSS["components/*.css"]
|
|
58
|
+
I3 --> Client["client/index.mjs<br/><small>.cjs + CSS auto-import</small>"]
|
|
61
59
|
```
|
|
62
60
|
|
|
63
|
-
| Import-Pfad | Inhalt
|
|
64
|
-
| ------------------------------------ |
|
|
65
|
-
| `@5minds/processcube_app_sdk` | Gemeinsame Typen, `RemoteUserTask`, `hasClaim`, Auth-Callbacks
|
|
66
|
-
| `@5minds/processcube_app_sdk/server` | Engine-Funktionen, Server Actions, Auth, Authority Client, External Tasks
|
|
67
|
-
| `@5minds/processcube_app_sdk/client` | React-Komponenten (BPMNViewer, DynamicUi, ProcessInstanceInspector, …)
|
|
68
|
-
| `…/client/
|
|
61
|
+
| Import-Pfad | Inhalt | Umgebung |
|
|
62
|
+
| ------------------------------------ | -------------------------------------------------------------------------------------------------------- | --------------- |
|
|
63
|
+
| `@5minds/processcube_app_sdk` | Gemeinsame Typen, `RemoteUserTask`, `hasClaim`, Auth-Callbacks | Client + Server |
|
|
64
|
+
| `@5minds/processcube_app_sdk/server` | Engine-Funktionen, Server Actions, Auth, Authority Client, External Tasks | Nur Server |
|
|
65
|
+
| `@5minds/processcube_app_sdk/client` | React-Komponenten (BPMNViewer, DynamicUi, ProcessInstanceInspector, …). CSS wird automatisch mitgeladen. | Nur Client |
|
|
66
|
+
| `…/client/styles` | Tailwind-Basisstyles (optional, nur wenn separat benötigt) | CSS-Import |
|
|
69
67
|
|
|
70
68
|
## Installation
|
|
71
69
|
|
|
@@ -111,22 +109,15 @@ export default nextConfig;
|
|
|
111
109
|
|
|
112
110
|
### CSS einbinden
|
|
113
111
|
|
|
114
|
-
|
|
112
|
+
Komponenten-CSS wird automatisch geladen — beim Import einer Client-Komponente wird das zugehörige Stylesheet vom Consumer-Bundler (webpack/turbopack) mit aufgelöst. Ein manueller CSS-Import ist in den meisten Fällen nicht nötig.
|
|
113
|
+
|
|
114
|
+
Falls die Tailwind-Basisstyles (Resets, Utilities) separat benötigt werden:
|
|
115
115
|
|
|
116
116
|
```typescript
|
|
117
117
|
// app/layout.tsx
|
|
118
118
|
import '@5minds/processcube_app_sdk/client/styles';
|
|
119
119
|
```
|
|
120
120
|
|
|
121
|
-
Alternativ können einzelne Komponenten-Stylesheets importiert werden:
|
|
122
|
-
|
|
123
|
-
```typescript
|
|
124
|
-
import '@5minds/processcube_app_sdk/client/components/ProcessInstanceInspector/ProcessInstanceInspector.css';
|
|
125
|
-
import '@5minds/processcube_app_sdk/client/components/BPMNViewer.css';
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
> **Hinweis:** Die `DynamicUi`-Komponente importiert ihr CSS automatisch. Ein separater CSS-Import ist dafür nicht nötig.
|
|
129
|
-
|
|
130
121
|
### Umgebungsvariablen
|
|
131
122
|
|
|
132
123
|
Erstelle eine `.env.local` im Projekt-Root:
|
|
@@ -726,16 +717,18 @@ Alle Client-Komponenten werden aus `@5minds/processcube_app_sdk/client` importie
|
|
|
726
717
|
|
|
727
718
|
### Übersicht
|
|
728
719
|
|
|
729
|
-
| Komponente | Beschreibung |
|
|
730
|
-
| ---------------------------- | ------------------------------------------------------- |
|
|
731
|
-
| **BPMNViewer** | BPMN-Diagramm-Rendering mit Overlays und Markern |
|
|
732
|
-
| **ProcessInstanceInspector** | Interaktive Prozessinstanz-Ansicht mit Token-Inspektion |
|
|
733
|
-
| **DynamicUi** | Dynamischer Formular-Builder aus UserTask-Schemas |
|
|
734
|
-
| **ProcessModelInspector** | Prozessmodell mit Heatmap-Visualisierung |
|
|
735
|
-
| **DocumentationViewer** | Markdown-Dokumentation mit Syntax-Highlighting |
|
|
736
|
-
| **SplitterLayout** | Größenveränderbares Panel-Layout |
|
|
737
|
-
| **DropdownMenu** | Dropdown-Menü (Headless UI) |
|
|
738
|
-
| **RemoteUserTask** | iFrame-basierte Remote User Task (Common) |
|
|
720
|
+
| Komponente | Beschreibung |
|
|
721
|
+
| ---------------------------- | ------------------------------------------------------- |
|
|
722
|
+
| **BPMNViewer** | BPMN-Diagramm-Rendering mit Overlays und Markern |
|
|
723
|
+
| **ProcessInstanceInspector** | Interaktive Prozessinstanz-Ansicht mit Token-Inspektion |
|
|
724
|
+
| **DynamicUi** | Dynamischer Formular-Builder aus UserTask-Schemas |
|
|
725
|
+
| **ProcessModelInspector** | Prozessmodell mit Heatmap-Visualisierung |
|
|
726
|
+
| **DocumentationViewer** | Markdown-Dokumentation mit Syntax-Highlighting |
|
|
727
|
+
| **SplitterLayout** | Größenveränderbares Panel-Layout |
|
|
728
|
+
| **DropdownMenu** | Dropdown-Menü (Headless UI) |
|
|
729
|
+
| **RemoteUserTask** | iFrame-basierte Remote User Task (Common) |
|
|
730
|
+
|
|
731
|
+
> **CSS:** Alle Komponenten laden ihr Stylesheet automatisch. Ein manueller CSS-Import ist nicht nötig.
|
|
739
732
|
|
|
740
733
|
### BPMNViewer
|
|
741
734
|
|
|
@@ -745,7 +738,6 @@ Rendert BPMN-Diagramme und bietet eine Ref-API für Overlays, Marker und Heatmap
|
|
|
745
738
|
'use client';
|
|
746
739
|
|
|
747
740
|
import { BPMNViewerNextJS, BPMNViewerFunctions } from '@5minds/processcube_app_sdk/client';
|
|
748
|
-
import '@5minds/processcube_app_sdk/client/components/BPMNViewer.css';
|
|
749
741
|
import { useRef } from 'react';
|
|
750
742
|
|
|
751
743
|
export default function DiagramPage({ xml }: { xml: string }) {
|
|
@@ -793,8 +785,6 @@ Interaktive Ansicht einer Prozessinstanz mit BPMN-Diagramm, Token-Inspektion, Re
|
|
|
793
785
|
'use client';
|
|
794
786
|
|
|
795
787
|
import { ProcessInstanceInspectorNextJS } from '@5minds/processcube_app_sdk/client';
|
|
796
|
-
import '@5minds/processcube_app_sdk/client/components/ProcessInstanceInspector/ProcessInstanceInspector.css';
|
|
797
|
-
import '@5minds/processcube_app_sdk/client/components/BPMNViewer.css';
|
|
798
788
|
|
|
799
789
|
export default function InspectorPage({ processInstanceId }: { processInstanceId: string }) {
|
|
800
790
|
return (
|
|
@@ -833,8 +823,6 @@ export default function InspectorPage({ processInstanceId }: { processInstanceId
|
|
|
833
823
|
|
|
834
824
|
Rendert dynamische Formulare basierend auf UserTask-FormField-Definitionen. Unterstützt 25+ Feldtypen und Custom Fields.
|
|
835
825
|
|
|
836
|
-
Die Komponente importiert ihr CSS automatisch — ein separater CSS-Import ist nicht nötig.
|
|
837
|
-
|
|
838
826
|
```typescript
|
|
839
827
|
'use client';
|
|
840
828
|
|
|
@@ -901,7 +889,6 @@ Rendert Markdown-Dokumentation.
|
|
|
901
889
|
|
|
902
890
|
```typescript
|
|
903
891
|
import { DocumentationViewer } from '@5minds/processcube_app_sdk/client';
|
|
904
|
-
import '@5minds/processcube_app_sdk/client/components/DocumentationViewer.css';
|
|
905
892
|
|
|
906
893
|
<DocumentationViewer documentation="# Titel\n\nBeschreibung..." />
|
|
907
894
|
```
|
|
@@ -916,7 +903,6 @@ Größenveränderbares Zwei-Panel-Layout.
|
|
|
916
903
|
|
|
917
904
|
```typescript
|
|
918
905
|
import { SplitterLayout } from '@5minds/processcube_app_sdk/client';
|
|
919
|
-
import '@5minds/processcube_app_sdk/client/components/SplitterLayout.css';
|
|
920
906
|
|
|
921
907
|
<SplitterLayout vertical={false} primaryIndex={0} secondaryMinSize={200}>
|
|
922
908
|
<div>Linkes Panel</div>
|
|
@@ -943,7 +929,6 @@ Dropdown-Menü basierend auf Headless UI.
|
|
|
943
929
|
|
|
944
930
|
```typescript
|
|
945
931
|
import { DropdownMenu, DropdownMenuItem } from '@5minds/processcube_app_sdk/client';
|
|
946
|
-
import '@5minds/processcube_app_sdk/client/components/DropdownMenu.css';
|
|
947
932
|
|
|
948
933
|
<DropdownMenu>
|
|
949
934
|
<DropdownMenuItem title="Bearbeiten" onClick={() => {}} />
|