@5minds/processcube_app_sdk 0.0.1-develop-cc091c-lmfwrwfs → 0.0.1-develop-2eab7f-lmfx2t9c
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 +11 -8
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# ProcessCube.App.SDK
|
|
2
2
|
|
|
3
|
-
Das SDK beinhaltet Komponenten und Funktionen für Frontend und Backend (Client/Server) zur einfachen und schnellen
|
|
3
|
+
Das SDK beinhaltet Komponenten und Funktionen für Frontend und Backend (Client/Server) zur einfachen und schnellen Entwicklung einer ProcessCube App auf Basis von [Next.js](https://nextjs.org/).
|
|
4
4
|
|
|
5
5
|
## Installation zur Verwendung
|
|
6
6
|
|
|
7
|
-
###
|
|
7
|
+
### Voraussetzungen
|
|
8
8
|
|
|
9
|
-
- NodeJS `>=
|
|
9
|
+
- NodeJS `>= v18`
|
|
10
10
|
|
|
11
11
|
```shell
|
|
12
12
|
npm i @5minds/processcube_app_sdk
|
|
@@ -18,9 +18,9 @@ Das NPM Paket hat *drei* Exports.
|
|
|
18
18
|
|
|
19
19
|
### Default/Common
|
|
20
20
|
|
|
21
|
-
Hier werden
|
|
21
|
+
Hier werden Komponenten und Funktionen exportiert, die im Client und Server genutzt werden können.
|
|
22
22
|
|
|
23
|
-
Zum Beispiel die React
|
|
23
|
+
Zum Beispiel die React Komponente RemoteUserTask:
|
|
24
24
|
|
|
25
25
|
```javascript
|
|
26
26
|
import { RemoteUserTask } from "@5minds/processcube_app_sdk";
|
|
@@ -28,7 +28,7 @@ import { RemoteUserTask } from "@5minds/processcube_app_sdk";
|
|
|
28
28
|
|
|
29
29
|
### Server
|
|
30
30
|
|
|
31
|
-
Hier steht alles ausschließlich für eine
|
|
31
|
+
Hier steht alles ausschließlich für eine serverseitige Umgebung zur Verfügung. Dazu zählen Funktionen, die mit der Engine arbeiten, oder React Komponenten, die Serverseitig gerendert werden können.
|
|
32
32
|
|
|
33
33
|
Beispiel:
|
|
34
34
|
|
|
@@ -40,7 +40,7 @@ Um die Engine URL anzupassen, die von den exportierten Funktionen genutzt wird,
|
|
|
40
40
|
|
|
41
41
|
### Client
|
|
42
42
|
|
|
43
|
-
Es können nur Komponenten und Funktionen importiert werden, die im Browser funktionieren. Zum Beispiel React Komponenten, die einen
|
|
43
|
+
Es können nur Komponenten und Funktionen importiert werden, die im Browser funktionieren. Zum Beispiel React Komponenten, die einen clientseitigen Router und dessen React Hooks nutzen oder Funktionen, die auf `window` oder generell globale Browser APIs zugreifen möchten.
|
|
44
44
|
|
|
45
45
|
```javascript
|
|
46
46
|
import { DynamicLink } from "@5minds/processcube_app_sdk/client";
|
|
@@ -65,7 +65,7 @@ Für ein Productionbuild:
|
|
|
65
65
|
npm run build:prod
|
|
66
66
|
```
|
|
67
67
|
|
|
68
|
-
Um mit dem Paket lokal zu arbeiten kann es mit npm in ein anderes Projekt verlinkt werden:
|
|
68
|
+
Um mit dem Paket lokal zu arbeiten, kann es mit npm in ein anderes Projekt verlinkt werden:
|
|
69
69
|
|
|
70
70
|
```shell
|
|
71
71
|
npm link
|
|
@@ -81,3 +81,6 @@ npm link @5minds/processcube_app_sdk
|
|
|
81
81
|
## Wen kann ich auf das Projekt ansprechen?
|
|
82
82
|
|
|
83
83
|
1. [Alexander Kasten](mailto:alexander.kasten@5minds.de)
|
|
84
|
+
2. [Matthias Danne](mailto:matthias.danne@5minds.de)
|
|
85
|
+
3. [Jeremy Hill](mailto:jeremy.hill@5minds.de)
|
|
86
|
+
4. [Marius Jahn](mailto:marius.jahn@5minds.de)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@5minds/processcube_app_sdk",
|
|
3
|
-
"version": "0.0.1-develop-
|
|
3
|
+
"version": "0.0.1-develop-2eab7f-lmfx2t9c",
|
|
4
4
|
"description": "The SDK for ProcessCube Apps",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "common/index.cjs",
|
|
@@ -79,7 +79,7 @@
|
|
|
79
79
|
"@5minds/processcube_engine_client": "^4.3.1",
|
|
80
80
|
"@5minds/processcube_engine_sdk": "^3.3.1",
|
|
81
81
|
"client-only": "^0.0.1",
|
|
82
|
-
"esbuild": "^0.
|
|
82
|
+
"esbuild": "^0.19.0",
|
|
83
83
|
"jwt-decode": "^3.1.2",
|
|
84
84
|
"only-server": "^0.0.1",
|
|
85
85
|
"openid-client": "^5.4.3"
|