@5minds/processcube_app_sdk 0.0.1-develop-99c117-lj8np8cz → 0.0.1-develop-5addcb-ljr75mtu

package/README.md

@@ -1,2 +1,80 @@
 # ProcessCube.App.SDK
-The SDK for ProcessCube Apps
+
+Das SDK beinhaltet Komponenten und Funktionen für Frontend und Backend (Client/Server) zur einfachen und schnellen Entiwcklung einer ProcessCube App auf Basis von [Next.js](https://nextjs.org/).
+
+## Installation zur Verwendung
+
+### Vorraussetzungen
+-  NodeJS `>= v16`
+
+```shell
+npm i @5minds/processcube_app_sdk
+```
+
+## Benutzung
+
+Das NPM Paket hat *drei* Exports.
+
+### Default/Common
+
+Hier werden Komponten und Funktionen exportiert, die im Client und Server genutzt werden können.
+
+Zum Beispiel die React Kompontene RemoteUserTask:
+```javascript
+import { RemoteUserTask } from "@5minds/processcube_app_sdk";
+```
+
+### Server
+
+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.
+
+Beispiel:
+
+```javascript
+import { startProcess } from "@5minds/processcube_app_sdk/server";
+```
+
+### Client
+
+Es können nur Komponenten und Funktionen imprortiert 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.
+
+```javascript
+import { DynamicLink } from "@5minds/processcube_app_sdk/client";
+```
+
+
+## Wie kann ich das Projekt aufsetzen?
+
+### Setup/Installation
+
+Das SDK wird über den Node Paketmanager `npm` gebaut.
+
+Für das Installieren und Bauen können folgende Befehle benutzt werden:
+
+```shell
+npm ci
+npm run build
+```
+
+Für ein Productionbuild:
+
+```shell
+npm run build:prod
+```
+
+Um mit dem Paket lokal zu arbeiten kann es mit npm in ein anderes Projekt verlinkt werden:
+
+```shell
+npm link
+npm run watch
+```
+
+Im Zielprojekt anschließend:
+
+```shell
+npm link @5minds/processcube_app_sdk
+```
+
+## Wen kann ich auf das Projekt ansprechen?
+
+1. [Alexander Kasten](mailto:alexander.kasten@5minds.de)

package/client/index.d.ts

@@ -1 +1,2 @@
-export * from './components';
+import 'client-only';
+export * from './components/DynamicLink';

package/client/index.js

@@ -1,2 +1 @@
-export * from './components';
-//# sourceMappingURL=index.js.map
+import"client-only";import{useRouter as t}from"next/navigation";import{jsx as i}from"react/jsx-runtime";function a({href:r,children:o}){let e=t();return i("a",{href:r,onClick:n=>{n.preventDefault(),e.replace(r),e.refresh()},children:o})}export{a as DynamicLink};

package/common/index.d.ts

@@ -0,0 +1 @@
+export * from './components/RemoteUserTask';

package/common/index.js

@@ -0,0 +1 @@
+import{jsx as e}from"react/jsx-runtime";function t(r){return e("div",{style:{width:"100%",height:"100%"},children:e("iframe",{width:"100%",height:"100%",src:r.url})})}export{t as RemoteUserTask};

package/package.json

@@ -1,33 +1,33 @@
 {
   "name": "@5minds/processcube_app_sdk",
-  "version": "0.0.1-develop-99c117-lj8np8cz",
+  "version": "0.0.1-develop-5addcb-ljr75mtu",
   "description": "The SDK for ProcessCube Apps",
   "type": "module",
-  "main": "server/index.js",
-  "module": "server/index.js",
+  "main": "common/index.js",
+  "module": "common/index.js",
   "browser": "client/index.js",
-  "types": "server/index.d.ts",
+  "types": "common/index.d.ts",
   "exports": {
     ".": {
-      "types": "./server/index.d.ts",
-      "default": "./server/index.js"
+      "types": "./common/index.d.ts",
+      "default": "./common/index.js"
     },
     "./server": {
       "types": "./server/index.d.ts",
       "default": "./server/index.js"
     },
     "./client": {
-      "types": {
-        "default": "./client/index.d.ts"
-      },
+      "types": "./client/index.d.ts",
       "default": "./client/index.js"
     }
   },
   "scripts": {
-    "prepare": "npm run build",
+    "clean": "rm -rf server common client",
+    "prepare": "npm run build:prod",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc && tsc -p tsconfig.client.json",
-    "watch": "tsc --watch"
+    "build": "NODE_ENV=development esbuild src/**/*.ts --outdir=. --packages=external --bundle --format=esm --analyze=verbose && tsc --emitDeclarationOnly && tsc -p tsconfig.common.json --emitDeclarationOnly &&  tsc -p tsconfig.client.json --emitDeclarationOnly",
+    "build:prod": "npm run clean && NODE_ENV=production esbuild src/**/*.ts --outdir=.  --packages=external --bundle --format=esm --tree-shaking=true --splitting --minify --drop:console && tsc --emitDeclarationOnly && tsc -p tsconfig.common.json --emitDeclarationOnly &&  tsc -p tsconfig.client.json --emitDeclarationOnly",
+    "watch": "NODE_ENV=development concurrently --kill-others -n=esbuild,tsc:server,tsc:common,tsc:client \"esbuild src/**/*.ts --watch --outdir=. --format=esm --bundle --packages=external\" \"tsc --watch --emitDeclarationOnly\" \"tsc -p tsconfig.common.json --watch --emitDeclarationOnly\" \"tsc -p tsconfig.client.json --watch --emitDeclarationOnly\""
   },
   "repository": {
     "type": "git",
@@ -35,7 +35,8 @@
   },
   "files": [
     "client",
-    "server"
+    "server",
+    "common"
   ],
   "keywords": [
     "SDK",
@@ -57,6 +58,8 @@
   },
   "devDependencies": {
     "@types/react": "^18.2.13",
+    "concurrently": "^8.2.0",
+    "esbuild": "0.18.11",
     "prettier": "^2.8.8",
     "typescript": "^5.1.3"
   },
@@ -65,6 +68,8 @@
     "react": ">=18.0.0"
   },
   "dependencies": {
-    "@5minds/processcube_engine_client": "^4.3.1"
+    "@5minds/processcube_engine_client": "^4.3.1",
+    "client-only": "^0.0.1",
+    "server-only": "^0.0.1"
   }
 }

package/server/index.d.ts

@@ -1,3 +1,4 @@
+import 'server-only';
 declare const _default: {
     config: ({ engineUrl }: {
         engineUrl: string;

package/server/index.js

@@ -1,11 +1 @@
-import { setEngineUrl } from './lib/internal/EngineUrlConfig';
-export default {
-    config: ({ engineUrl }) => {
-        if (typeof engineUrl === 'string') {
-            setEngineUrl(engineUrl);
-        }
-    },
-};
-export * from './lib';
-export * from './server-actions';
-//# sourceMappingURL=index.js.map
+import"server-only";var f=process.env.PROCESSCUBE_ENGINE_URL||"http://localhost:10560";function o(){return f}function c(s){s=s}import{EngineClient as d,DataModels as p}from"@5minds/processcube_engine_client";var g=o(),n=new d(g);async function m(s){return(await n.userTasks.query({flowNodeInstanceId:s})).userTasks[0]}async function I(s,t){let e=await n.userTasks.query({processInstanceId:s,flowNodeId:t});return e.totalCount==0?null:e.userTasks[0]}async function E(s,t){return new Promise(async e=>{let r=n.userTasks.onUserTaskWaiting(async a=>{if(a.processInstanceId===s&&a.flowNodeId===t){let l=await m(a.flowNodeInstanceId);e(l)}}),i=await I(s,t);i&&e(i),await r})}async function P(s,t,e){await n.userTasks.finishUserTask(s,t);let r=await n.userTasks.query({flowNodeId:e,state:p.FlowNodeInstances.FlowNodeInstanceState.suspended});return r.totalCount>0?r.userTasks[0]:null}import{revalidatePath as T}from"next/cache";import{redirect as k}from"next/navigation";async function R(s,t){T(s),k(s,t)}import{EngineClient as w}from"@5minds/processcube_engine_client";var y=o(),u=new w(y);async function _(s){return await u.processModels.startProcessInstance({processModelId:s})}async function A(s,t){await u.userTasks.finishUserTask(s,t)}var z={config:({engineUrl:s})=>{typeof s=="string"&&c(s)}};export{z as default,A as finishTask,P as finishUserTaskAndGetNext,R as hardNavigate,_ as startProcess,E as waitForUserTaskByProcessInstanceId};

package/client/components/DynamicLink.js

@@ -1,13 +0,0 @@
-'use client';
-import { jsx as _jsx } from "react/jsx-runtime";
-import { useRouter } from 'next/navigation';
-// Workaround für https://github.com/vercel/next.js/issues/42991#issuecomment-1592921378
-export function DynamicLink({ href, children }) {
-    const router = useRouter();
-    return (_jsx("a", { href: href, onClick: (e) => {
-            e.preventDefault();
-            router.replace(href);
-            router.refresh();
-        }, children: children }));
-}
-//# sourceMappingURL=DynamicLink.js.map

package/client/components/DynamicLink.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"DynamicLink.js","sourceRoot":"","sources":["../../src/client/components/DynamicLink.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAGb,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAO5C,wFAAwF;AACxF,MAAM,UAAU,WAAW,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAoB;IAC9D,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAE3B,OAAO,CACL,YACE,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,CAAC,CAAiC,EAAE,EAAE;YAC7C,CAAC,CAAC,cAAc,EAAE,CAAC;YACnB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACrB,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,CAAC,YAEA,QAAQ,GACP,CACL,CAAC;AACJ,CAAC"}

package/client/components/RemoteUserTask.js

@@ -1,5 +0,0 @@
-import { jsx as _jsx } from "react/jsx-runtime";
-export function RemoteUserTask(props) {
-    return (_jsx("div", { style: { width: '100%', height: '100%' }, children: _jsx("iframe", { width: "100%", height: "100%", src: props.url }) }));
-}
-//# sourceMappingURL=RemoteUserTask.js.map

package/client/components/RemoteUserTask.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"RemoteUserTask.js","sourceRoot":"","sources":["../../src/client/components/RemoteUserTask.tsx"],"names":[],"mappings":";AAIA,MAAM,UAAU,cAAc,CAAC,KAA0B;IACvD,OAAO,CACL,cAAK,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,YAC3C,iBAAQ,KAAK,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,GAAG,EAAE,KAAK,CAAC,GAAG,GAAW,GACxD,CACP,CAAC;AACJ,CAAC"}

package/client/components/index.d.ts

@@ -1,2 +0,0 @@
-export * from './DynamicLink';
-export * from './RemoteUserTask';

package/client/components/index.js

@@ -1,3 +0,0 @@
-export * from './DynamicLink';
-export * from './RemoteUserTask';
-//# sourceMappingURL=index.js.map

package/client/components/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC"}

package/client/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/client/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/server/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/server/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAE9D,eAAe;IACb,MAAM,EAAE,CAAC,EAAE,SAAS,EAAyB,EAAE,EAAE;QAC/C,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YACjC,YAAY,CAAC,SAAS,CAAC,CAAC;SACzB;IACH,CAAC;CACF,CAAC;AAEF,cAAc,OAAO,CAAC;AACtB,cAAc,kBAAkB,CAAC"}

package/server/lib/UserTaskFunctions.js

@@ -1,42 +0,0 @@
-import { EngineClient, DataModels } from '@5minds/processcube_engine_client';
-import { getEngineUrl } from './internal/EngineUrlConfig';
-const url = getEngineUrl();
-const client = new EngineClient(url);
-async function getUserTaskByFlowNodeInstanceId(flowNodeInstanceId) {
-    const result = await client.userTasks.query({ flowNodeInstanceId: flowNodeInstanceId });
-    return result.userTasks[0];
-}
-async function getUserTaskByProcessInstanceId(processInstanceId, flowNodeId) {
-    const result = await client.userTasks.query({ processInstanceId: processInstanceId, flowNodeId: flowNodeId });
-    if (result.totalCount == 0) {
-        return null;
-    }
-    return result.userTasks[0];
-}
-export async function waitForUserTaskByProcessInstanceId(processInstanceId, flowNodeId) {
-    return new Promise(async (resolve) => {
-        const promise = client.userTasks.onUserTaskWaiting(async (event) => {
-            if (event.processInstanceId === processInstanceId && event.flowNodeId === flowNodeId) {
-                const userTask = await getUserTaskByFlowNodeInstanceId(event.flowNodeInstanceId);
-                resolve(userTask);
-            }
-        });
-        const userTask = await getUserTaskByProcessInstanceId(processInstanceId, flowNodeId);
-        if (userTask) {
-            resolve(userTask);
-        }
-        await promise;
-    });
-}
-export async function finishUserTaskAndGetNext(flowNodeInstanceId, result, flowNodeId) {
-    await client.userTasks.finishUserTask(flowNodeInstanceId, result);
-    const userTasks = await client.userTasks.query({
-        flowNodeId: flowNodeId,
-        state: DataModels.FlowNodeInstances.FlowNodeInstanceState.suspended,
-    });
-    if (userTasks.totalCount > 0) {
-        return userTasks.userTasks[0];
-    }
-    return null;
-}
-//# sourceMappingURL=UserTaskFunctions.js.map

package/server/lib/UserTaskFunctions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"UserTaskFunctions.js","sourceRoot":"","sources":["../../src/server/lib/UserTaskFunctions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,MAAM,GAAG,GAAG,YAAY,EAAE,CAAC;AAC3B,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC;AAErC,KAAK,UAAU,+BAA+B,CAAC,kBAA2B;IACxE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAExF,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED,KAAK,UAAU,8BAA8B,CAAC,iBAAyB,EAAE,UAAkB;IACzF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC;IAE9G,IAAI,MAAM,CAAC,UAAU,IAAI,CAAC,EAAE;QAC1B,OAAO,IAAI,CAAC;KACb;IAED,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,kCAAkC,CACtD,iBAAyB,EACzB,UAAkB;IAElB,OAAO,IAAI,OAAO,CAAgD,KAAK,EAAE,OAAO,EAAE,EAAE;QAClF,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACjE,IAAI,KAAK,CAAC,iBAAiB,KAAK,iBAAiB,IAAI,KAAK,CAAC,UAAU,KAAK,UAAU,EAAE;gBACpF,MAAM,QAAQ,GAAG,MAAM,+BAA+B,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;gBACjF,OAAO,CAAC,QAAQ,CAAC,CAAC;aACnB;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,8BAA8B,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAC;QAErF,IAAI,QAAQ,EAAE;YACZ,OAAO,CAAC,QAAQ,CAAC,CAAC;SACnB;QAED,MAAM,OAAO,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,kBAA0B,EAAE,MAAW,EAAE,UAAkB;IACxG,MAAM,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;IAElE,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC;QAC7C,UAAU,EAAE,UAAU;QACtB,KAAK,EAAE,UAAU,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,SAAS;KACpE,CAAC,CAAC;IAEH,IAAI,SAAS,CAAC,UAAU,GAAG,CAAC,EAAE;QAC5B,OAAO,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;KAC/B;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/server/lib/index.js

@@ -1,2 +0,0 @@
-export * from './UserTaskFunctions';
-//# sourceMappingURL=index.js.map

package/server/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/server/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC"}

package/server/lib/internal/EngineUrlConfig.js

@@ -1,8 +0,0 @@
-let engineUrl = process.env.PROCESSCUBE_ENGINE_URL || 'http://localhost:10560';
-export function getEngineUrl() {
-    return engineUrl;
-}
-export function setEngineUrl(engineUrl) {
-    engineUrl = engineUrl;
-}
-//# sourceMappingURL=EngineUrlConfig.js.map

package/server/lib/internal/EngineUrlConfig.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"EngineUrlConfig.js","sourceRoot":"","sources":["../../../src/server/lib/internal/EngineUrlConfig.ts"],"names":[],"mappings":"AAAA,IAAI,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,sBAAsB,IAAI,wBAAwB,CAAC;AAC/E,MAAM,UAAU,YAAY;IAC1B,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,SAAiB;IAC5C,SAAS,GAAG,SAAS,CAAC;AACxB,CAAC"}

package/server/server-actions/CommonActions.js

@@ -1,8 +0,0 @@
-'use server';
-import { revalidatePath } from 'next/cache';
-import { redirect } from 'next/navigation';
-export async function hardNavigate(url, type) {
-    revalidatePath(url);
-    redirect(url, type);
-}
-//# sourceMappingURL=CommonActions.js.map

package/server/server-actions/CommonActions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"CommonActions.js","sourceRoot":"","sources":["../../src/server/server-actions/CommonActions.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAG3C,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,GAAW,EAAE,IAAmB;IACjE,cAAc,CAAC,GAAG,CAAC,CAAC;IACpB,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AACtB,CAAC"}

package/server/server-actions/UserTaskActions.js

@@ -1,12 +0,0 @@
-'use server';
-import { EngineClient } from '@5minds/processcube_engine_client';
-import { getEngineUrl } from '../lib/internal/EngineUrlConfig';
-const url = getEngineUrl();
-const client = new EngineClient(url);
-export async function startProcess(processModelId) {
-    return await client.processModels.startProcessInstance({ processModelId: processModelId });
-}
-export async function finishTask(flowNodeInstanceId, result) {
-    await client.userTasks.finishUserTask(flowNodeInstanceId, result);
-}
-//# sourceMappingURL=UserTaskActions.js.map

package/server/server-actions/UserTaskActions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"UserTaskActions.js","sourceRoot":"","sources":["../../src/server/server-actions/UserTaskActions.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAc,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAE/D,MAAM,GAAG,GAAG,YAAY,EAAE,CAAC;AAC3B,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC;AAErC,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,cAAsB;IACvD,OAAO,MAAM,MAAM,CAAC,aAAa,CAAC,oBAAoB,CAAC,EAAE,cAAc,EAAE,cAAc,EAAE,CAAC,CAAC;AAC7F,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,kBAA0B,EAAE,MAAW;IACtE,MAAM,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;AACpE,CAAC"}

package/server/server-actions/index.js

@@ -1,3 +0,0 @@
-export * from './CommonActions';
-export * from './UserTaskActions';
-//# sourceMappingURL=index.js.map

package/server/server-actions/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/server/server-actions/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC"}