@5minds/node-red-contrib-processcube 0.3.3 → 0.3.5-feature-1092e6-lxhvslzu

package/nodered/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "node-red-contrib-processcube-sample",
+  "version": "1.0.0",
+  "description": "A sample for the processcube node-red contrib package",
+  "scripts": {
+    "start": "./node_modules/.bin/node-red node-red-contrib-processcube-flows.json"
+  },
+  "dependencies": {
+    "@5minds/node-red-contrib-processcube": "file:..",
+    "@5minds/node-red-dashboard-2-processcube-dynamic-form": "file:../../../../moellenbeck/reps/node-red-dashboard-2-ui-example",
+    "@flowfuse/node-red-dashboard": "^1.11.1",
+    "node-red": "^3.1.10",
+    "node-red-debugger": "^1.1.1",
+    "openapi-red": "^1.2.5"
+  }
+}

package/nodered/sample_fields.json

@@ -0,0 +1,159 @@
+{
+    "formFields": [
+        {
+            "id": "text_id",
+            "type": "text",
+            "required": false,
+            "label": "Text Label",
+            "value": "",
+            "title": "Some helpful text"
+        },
+        {
+            "id": "number_id",
+            "type": "number",
+            "required": true,
+            "label": "Number Label",
+            "title": "Some helpful text"
+        },
+        {
+            "id": "date_id",
+            "type": "date",
+            "required": true,
+            "label": "Date Label",
+            "title": "Some helpful text"
+        },
+        {
+            "id": "select_id",
+            "type": "select",
+            "required": true,
+            "label": "Select Label",
+            "options": [
+                {
+                    "id": "value_01",
+                    "name": "Value 01"
+                },
+                {
+                    "id": "value_02",
+                    "name": "Value 02"
+                }
+            ],
+            "title": "Choose an option"
+        },
+        {
+            "id": "boolean_id",
+            "type": "checkbox",
+            "required": false,
+            "label": "Boolean Label",
+            "title": "Check for Yes"
+        },
+        {
+            "id": "_flowNodeInstanceId",
+            "type": "hidden",
+            "value": "549abda6-911c-4b10-b8e3-f4d6383674b2"
+        }
+    ],
+    "userTask": {
+        "flowNodeInstanceId": "549abda6-911c-4b10-b8e3-f4d6383674b2",
+        "flowNodeId": "Activity_0ljiko7",
+        "flowNodeName": "Hello world",
+        "flowNodeLane": "Lane",
+        "flowNodeType": "bpmn:UserTask",
+        "previousFlowNodeInstanceId": "a678b21e-db08-48e8-b228-ffc48618022b",
+        "parentProcessInstanceId": null,
+        "processDefinitionId": "SampleUserTask_Definition",
+        "processModelId": "SampleUserTask_Process",
+        "processInstanceId": "251bfdd1-16fb-4f2b-98b3-7c28a49eec4d",
+        "correlationId": "3c6dadd7-a0fe-43c0-a8aa-9b1b87c149f5",
+        "state": "suspended",
+        "tokens": [],
+        "startToken": {},
+        "endToken": {},
+        "ownerId": "dummy_token",
+        "startedAt": "2024-06-09T20:47:27.494Z",
+        "assignedUserIds": null,
+        "actualOwnerId": null,
+        "finishedByUserId": null,
+        "userTaskConfig": {
+            "formFields": [
+                {
+                    "id": "text_id",
+                    "label": "Text Label",
+                    "type": "string"
+                },
+                {
+                    "id": "number_id",
+                    "label": "Number Label",
+                    "type": "long",
+                    "defaultValue": "undefined",
+                    "customForm": "{\"hint\":\"Sample\"}"
+                },
+                {
+                    "id": "date_id",
+                    "label": "Date Label",
+                    "type": "date"
+                },
+                {
+                    "id": "select_id",
+                    "label": "Select Label",
+                    "type": "enum",
+                    "enumValues": [
+                        {
+                            "id": "value_01",
+                            "name": "Value 01"
+                        },
+                        {
+                            "id": "value_02",
+                            "name": "Value 02"
+                        }
+                    ]
+                },
+                {
+                    "id": "boolean_id",
+                    "label": "Boolean Label",
+                    "type": "boolean"
+                }
+            ]
+        },
+        "userTaskConfigModel": {
+            "formFields": [
+                {
+                    "id": "text_id",
+                    "label": "Text Label",
+                    "type": "string"
+                },
+                {
+                    "id": "number_id",
+                    "label": "Number Label",
+                    "type": "long",
+                    "defaultValue": "${token.current.sample}",
+                    "customForm": "{\"hint\":\"Sample\"}"
+                },
+                {
+                    "id": "date_id",
+                    "label": "Date Label",
+                    "type": "date"
+                },
+                {
+                    "id": "select_id",
+                    "label": "Select Label",
+                    "type": "enum",
+                    "enumValues": [
+                        {
+                            "id": "value_01",
+                            "name": "Value 01"
+                        },
+                        {
+                            "id": "value_02",
+                            "name": "Value 02"
+                        }
+                    ]
+                },
+                {
+                    "id": "boolean_id",
+                    "label": "Boolean Label",
+                    "type": "boolean"
+                }
+            ]
+        }
+    }
+}

package/package.json

@@ -1,9 +1,10 @@
 {
     "name": "@5minds/node-red-contrib-processcube",
-    "version": "0.3.3",
+    "version": "0.3.5-feature-1092e6-lxhvslzu",
     "license": "MIT",
     "description": "Node-RED nodes for ProcessCube",
-    "authors": [{
+    "authors": [
+        {
             "name": "Martin Moellenbeck",
             "email": "Martin.Moellenbeck@5Minds.de"
         },
@@ -31,6 +32,8 @@
             "externaltaskOutput": "externaltask-output.js",
             "externaltaskError": "externaltask-error.js",
             "processStart": "process-start.js",
+            "UserTaskInput": "usertask-input.js",
+            "UserTaskOutput": "usertask-output.js",
             "processcubeEngineConfig": "processcube-engine-config.js"
         }
     },

package/processes/SampleUserTask.bpmn

@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:camunda="http://camunda.org/schema/1.0/bpmn" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" id="SampleUserTask_Definition" targetNamespace="http://bpmn.io/schema/bpmn" exporter="5Minds Studio" exporterVersion="1">
+  <bpmn:collaboration id="Collaboration_1cidyxu" name="">
+    <bpmn:participant id="Participant_0px403d" name="SampleUserTask" processRef="SampleUserTask_Process" />
+  </bpmn:collaboration>
+  <bpmn:process id="SampleUserTask_Process" name="SampleUserTask" isExecutable="true">
+    <bpmn:laneSet>
+      <bpmn:lane id="Lane_1xzf0d3" name="Lane">
+        <bpmn:flowNodeRef>StartEvent_1</bpmn:flowNodeRef>
+        <bpmn:flowNodeRef>Event_1eeiwx4</bpmn:flowNodeRef>
+        <bpmn:flowNodeRef>Activity_0ljiko7</bpmn:flowNodeRef>
+      </bpmn:lane>
+    </bpmn:laneSet>
+    <bpmn:startEvent id="StartEvent_1" name="Start">
+      <bpmn:extensionElements>
+        <camunda:properties>
+          <camunda:property name="studio.defaultCustomStartToken" value="{&#10;    &#34;sample&#34;: &#34;hello&#34;&#10;}" />
+        </camunda:properties>
+      </bpmn:extensionElements>
+      <bpmn:outgoing>Flow_1h0giih</bpmn:outgoing>
+    </bpmn:startEvent>
+    <bpmn:sequenceFlow id="Flow_1h0giih" sourceRef="StartEvent_1" targetRef="Activity_0ljiko7" />
+    <bpmn:endEvent id="Event_1eeiwx4">
+      <bpmn:incoming>Flow_1laqnja</bpmn:incoming>
+    </bpmn:endEvent>
+    <bpmn:sequenceFlow id="Flow_1laqnja" sourceRef="Activity_0ljiko7" targetRef="Event_1eeiwx4" />
+    <bpmn:userTask id="Activity_0ljiko7" name="Hello world">
+      <bpmn:extensionElements>
+        <camunda:formData>
+          <camunda:formField id="text_id" label="Text Label" type="string" />
+          <camunda:formField id="number_id" label="Number Label" type="long" defaultValue="${token.current.sample}" customForm="{&#34;hint&#34;:&#34;Sample&#34;}" />
+          <camunda:formField id="date_id" label="Date Label" type="date" />
+          <camunda:formField id="select_id" label="Select Label" type="enum">
+            <camunda:value id="value_01" name="Value 01" />
+            <camunda:value id="value_02" name="Value 02" />
+          </camunda:formField>
+          <camunda:formField id="boolean_id" label="Boolean Label" type="boolean" />
+          <camunda:formField id="customer_01" label="Custom_01" type="v-text-field" />
+        </camunda:formData>
+      </bpmn:extensionElements>
+      <bpmn:incoming>Flow_1h0giih</bpmn:incoming>
+      <bpmn:outgoing>Flow_1laqnja</bpmn:outgoing>
+    </bpmn:userTask>
+  </bpmn:process>
+  <bpmndi:BPMNDiagram id="BPMNDiagram_1">
+    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Collaboration_1cidyxu">
+      <bpmndi:BPMNShape id="Participant_0px403d_di" bpmnElement="Participant_0px403d" isHorizontal="true">
+        <dc:Bounds x="5" y="4" width="435" height="346" />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="Lane_1xzf0d3_di" bpmnElement="Lane_1xzf0d3" isHorizontal="true">
+        <dc:Bounds x="35" y="4" width="405" height="346" />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="StartEvent_1_di" bpmnElement="StartEvent_1">
+        <dc:Bounds x="92" y="152" width="36" height="36" />
+        <bpmndi:BPMNLabel>
+          <dc:Bounds x="98" y="195" width="24" height="14" />
+        </bpmndi:BPMNLabel>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="Event_1eeiwx4_di" bpmnElement="Event_1eeiwx4">
+        <dc:Bounds x="332" y="152" width="36" height="36" />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="Activity_1uodwbi_di" bpmnElement="Activity_0ljiko7">
+        <dc:Bounds x="180" y="130" width="100" height="80" />
+        <bpmndi:BPMNLabel />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNEdge id="Flow_1h0giih_di" bpmnElement="Flow_1h0giih">
+        <di:waypoint x="128" y="170" />
+        <di:waypoint x="180" y="170" />
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNEdge id="Flow_1laqnja_di" bpmnElement="Flow_1laqnja">
+        <di:waypoint x="280" y="170" />
+        <di:waypoint x="332" y="170" />
+      </bpmndi:BPMNEdge>
+    </bpmndi:BPMNPlane>
+  </bpmndi:BPMNDiagram>
+</bpmn:definitions>

package/usertask-input.html

@@ -0,0 +1,31 @@
+<script type="text/javascript">
+    RED.nodes.registerType('usertask-input',{
+        category: 'ProcessCube',
+        color: '#00aed7',
+        defaults: {
+            name: {value: ""},
+            engine: {value: "", type: "processcube-engine-config"}
+        },
+        inputs: 0,
+        outputs: 1,
+        icon: "font-awesome/fa-envelope-open",
+        label: function() {
+            return this.name || "usertask-input";
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="usertask-input">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-engine"><i class="fa fa-tag"></i> Engine-URL</label>
+        <input type="text" id="node-input-engine" placeholder="http://engine:8000">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="usertask-input">
+    <p>A node which subscribes to an User Task of https://processcube.io</p>
+</script>

package/usertask-input.js

@@ -0,0 +1,64 @@
+const process = require('process');
+const EventEmitter = require('node:events');
+
+const engine_client = require('@5minds/processcube_engine_client');
+
+function showStatus(node, msgCounter) {
+    if (msgCounter >= 1) {
+        node.status({fill: "blue", shape: "dot", text: `handling tasks ${msgCounter}`});
+    } else {
+        node.status({fill: "blue", shape: "ring", text: `subcribed ${msgCounter}`});
+    }
+}
+
+module.exports = function(RED) {
+    function UserTaskInput(config) {
+        RED.nodes.createNode(this,config);
+        var node = this;
+        var msgCounter = 0;
+        var flowContext = node.context().flow;
+        var nodeContext = node.context();
+
+        this.engine = this.server = RED.nodes.getNode(config.engine);
+
+        const engineUrl = this.engine?.url || process.env.ENGINE_URL || 'http://engine:8000';
+
+        var client = nodeContext.get('client');
+
+        if (!client) {
+            nodeContext.set('client', new engine_client.EngineClient(engineUrl));
+            client = nodeContext.get('client');
+        }   
+
+        var eventEmitter = flowContext.get('emitter');
+
+        if (!eventEmitter) {
+            flowContext.set('emitter', new EventEmitter());
+            eventEmitter = flowContext.get('emitter');
+        }
+
+        client.userTasks.onUserTaskWaiting((userTaskWaitingNotification) => {
+            console.log(`UserTask with id ${userTaskWaitingNotification.flowNodeInstanceId} is waiting.`);
+
+            // Abschließend mit - client.userTasks.finishUserTask(waitingUserTask?.flowNodeInstanceId, sampleResult)
+
+            // flowNodeInstanceId
+            // processModelName
+            // flowNodeId
+            client.userTasks.query({
+                flowNodeInstanceId: userTaskWaitingNotification.flowNodeInstanceId,
+                processModelId: userTaskWaitingNotification.processModelId,
+                flowNodeId: userTaskWaitingNotification.flowNodeId,
+            }).then((matchingFlowNodes) => {
+                if (matchingFlowNodes && matchingFlowNodes.userTasks && matchingFlowNodes.userTasks.length == 1) {
+                    userTask = matchingFlowNodes.userTasks[0];
+
+                    node.send({ payload: {userTask: userTask }, "_flowNodeInstanceId": userTaskWaitingNotification.flowNodeInstanceId});
+                } else {
+                    node.send({ payload: matchingFlowNodes.userTasks });
+                }
+            });
+        });
+    }
+    RED.nodes.registerType("usertask-input", UserTaskInput);
+}

package/usertask-output.html

@@ -0,0 +1,31 @@
+<script type="text/javascript">
+    RED.nodes.registerType('usertask-output',{
+        category: 'ProcessCube',
+        color: '#00aed7',
+        defaults: {
+            name: {value: ""},
+            engine: {value: "", type: "processcube-engine-config"}
+        },
+        inputs: 1,
+        outputs: 0,
+        icon: "font-awesome/fa-envelope",
+        label: function() {
+            return this.name || "usertask-output";
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="usertask-output">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-engine"><i class="fa fa-tag"></i> Engine-URL</label>
+        <input type="text" id="node-input-engine" placeholder="http://engine:8000">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="usertask-output">
+    <p>A node which send the result to an User Task of https://processcube.io</p>
+</script>

package/usertask-output.js

@@ -0,0 +1,45 @@
+const process = require('process');
+const EventEmitter = require('node:events');
+
+const engine_client = require('@5minds/processcube_engine_client');
+
+module.exports = function(RED) {
+    function UserTaskOutput(config) {
+
+        RED.nodes.createNode(this, config);
+
+        var node = this;
+        var flowContext = node.context().flow;
+        var nodeContext = node.context();
+
+        this.engine = this.server = RED.nodes.getNode(config.engine);
+
+        const engineUrl = this.engine?.url || process.env.ENGINE_URL || 'http://engine:8000';
+
+        var client = nodeContext.get('client');
+
+        if (!client) {
+            nodeContext.set('client', new engine_client.EngineClient(engineUrl));
+            client = nodeContext.get('client');
+        }   
+
+        var eventEmitter = flowContext.get('emitter');
+
+        if (!eventEmitter) {
+            flowContext.set('emitter', new EventEmitter());
+            eventEmitter = flowContext.get('emitter');
+        }
+
+        node.on('input', function(msg) {
+            console.log(`Try to finsih UserTask with id ${msg._flowNodeInstanceId}.`);
+
+            const flowNodeInstanceId = msg._flowNodeInstanceId;
+
+            client.userTasks.finishUserTask(flowNodeInstanceId, msg.payload).then(() => {
+                console.log(`UserTask with id ${flowNodeInstanceId} finished.`);
+            });
+        });     
+    }
+
+    RED.nodes.registerType("usertask-output", UserTaskOutput);
+}