@5minds/node-red-contrib-processcube 2.0.0-feature-629c78-m2dq1ygt → 7.6.0-develop-51b534-mjy4rzoh

package/README.md

@@ -1,60 +1,5 @@
-# ProcessCube Node-RED Integration
+# Some Nodes to integrate the ProcessCube Engine into the ProcessCube LowCode component (Node-RED)
 
-This repository contains Node-RED flows for integrating the ProcessCube system. The flows include nodes for starting processes and handling external tasks.
+This repository contains some nodes to integrate the ProcessCube Engine into the ProcessCube LowCode component (Node-RED).
 
-## Prerequisites
-
-Before running the Node-RED flows, make sure you have the following prerequisites installed:
-
-- Docker
-- Docker Compose
-
-## Installation
-
-To install and run the Node-RED flows, follow these steps:
-
-1. Clone this repository to your local machine:
-
-    ```bash
-    git clone https://github.com/5minds/processcube_nodered.git
-    ```
-
-2. Change to the project directory:
-
-    ```bash
-    cd processcube_nodered
-    ```
-
-3. Build the Docker containers:
-
-    ```bash
-    docker-compose build
-    ```
-
-4. Start the Docker containers:
-
-    ```bash
-    docker-compose up -d
-    ```
-
-## Usage
-
-Once the Docker containers are running, you can access the ProcessCube Node-RED interface using the following URLs:
-
-- Engine: [http://localhost:8000](http://localhost:8000)
-- Node-RED: [http://localhost:1880](http://localhost:1880)
-
-In the Node-RED interface, you will find pre-configured flows for starting processes and handling external tasks. You can customize these flows to fit your specific requirements.
-
-## Contributing
-
-If you would like to contribute to this project, please follow these guidelines:
-
-1. Fork the repository on GitHub.
-2. Create a new branch for your feature or bug fix.
-3. Commit your changes and push the branch to your fork.
-4. Submit a pull request to the main repository.
-
-## License
-
-This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
+Details see @ [ProcessCub.io - LowCode Integration Nodes](https://processcube.io/docs/node-red/integration-nodes) and [ProcessCub.io - LowCode Event Nodes](https://processcube.io/docs/node-red/event-nodes).

package/check-authorization.html

@@ -0,0 +1,138 @@
+<script type="text/javascript">
+    RED.nodes.registerType('check-authorization', {
+        category: 'ProcessCube',
+        color: '#02AFD6',
+        defaults: {
+            name: { value: '' },
+            options: {
+                value: [{ claim: '' }],
+            },
+        },
+        inputs: 1,
+        outputs: 2,
+        outputLabels: function (index) {
+            if (index === 0) {
+                return 'Authorized'
+            } else {
+                return 'Unauthorized'
+            }
+        },
+        icon: 'font-awesome/fa-sign-in',
+        label: function () {
+            return this.name || 'check-authorization';
+        },
+        oneditprepare: function () {
+            $('#node-input-size').elementSizer({
+                width: '#node-input-width',
+                height: '#node-input-height',
+                group: '#node-input-group',
+            });
+
+            function generateOption(i, option) {
+                const container = $('<li/>', {
+                    style: 'background: var(--red-ui-secondary-background, #fff); margin:0; padding:8px 0px 0px;',
+                });
+
+                const row = $('<div/>').appendTo(container);
+
+                $('<input/>', {
+                    class: 'node-input-option-claim',
+                    type: 'text',
+                    style: 'margin-left:7px; width:calc(85%);',
+                    placeholder: 'Claim',
+                    value: option.claim,
+                })
+                    .appendTo(row)
+                    .typedInput({
+                        type: 'str',
+                        types: ['str'],
+                    });
+
+                // Create delete button for the option
+                const finalSpan = $('<span/>', {
+                    style: 'float:right; margin-right:8px;',
+                }).appendTo(row);
+                const deleteButton = $('<a/>', {
+                    href: '#',
+                    class: 'editor-button editor-button-small',
+                    style: 'margin-top:7px; margin-left:5px;',
+                }).appendTo(finalSpan);
+                $('<i/>', { class: 'fa fa-remove' }).appendTo(deleteButton);
+
+                deleteButton.click(function () {
+                    container.css({
+                        background: 'var(--red-ui-secondary-background-inactive, #fee)',
+                    });
+                    container.fadeOut(300, function () {
+                        $(this).remove();
+                    });
+                });
+
+                $('#node-input-option-container').append(container);
+            }
+
+            $('#node-input-add-option').click(function () {
+                generateOption($('#node-input-option-container').children().length + 1, {});
+                $('#node-input-option-container-div').scrollTop(
+                    $('#node-input-option-container-div').get(0).scrollHeight
+                );
+            });
+
+            for (let i = 0; i < this.options.length; i++) {
+                const option = this.options[i];
+                generateOption(i + 1, option);
+            }
+
+            $('#node-input-option-container').sortable({
+                axis: 'y',
+                handle: '.node-input-option-handle',
+                cursor: 'move',
+            });
+        },
+        oneditsave: function () {
+            const options = $('#node-input-option-container').children();
+            const node = this;
+            node.options = [];
+            options.each(function (i) {
+                const option = $(this);
+                const o = {
+                    claim: option.find('.node-input-option-claim').val(),
+                };
+
+                node.options.push(o);
+            });
+        },
+    });
+</script>
+
+<script type="text/html" data-template-name="check-authorization">
+    <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 form-row-flex node-input-option-container-row" style="margin-bottom: 0px;width: 100%">
+        <label for="node-input-width" style="vertical-align:top"><i class="fa fa-list-alt"></i> Claims</label>
+        <div id="node-input-option-container-div" style="box-sizing:border-box; border-radius:5px; height:257px; padding:5px; border:1px solid var(--red-ui-form-input-border-color, #ccc); overflow-y:scroll; display:inline-block; width: 70%;">
+            <ol id="node-input-option-container" style="list-style-type:none; margin:0;"></ol>
+        </div>
+    </div>
+    <!-- Add Claim Button -->
+    <div class="form-row">
+        <a href="#" class="editor-button editor-button-small" id="node-input-add-option" style="margin-top:4px; margin-left:103px;"><i class="fa fa-plus"></i> <span>action</span></a>
+    </div>
+</script>
+
+<script type="text/markdown" data-help-name="check-authorization">
+A Node that checks if a user has the specified claims
+
+## Configs
+
+: name (string): name of the node
+: claims (list of strings): the claims the user needs to be authorized
+
+### References
+
+-  [The ProcessCube&copy; Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
+-  [ProcessCube&copy; LowCode Integration](https://processcube.io/docs/node-red) - LowCode integration in ProcessCube&copy;
+</script>

package/check-authorization.js

@@ -0,0 +1,27 @@
+module.exports = function (RED) {
+    function CheckAuthorization(config) {
+        RED.nodes.createNode(this, config);
+        const node = this;
+
+        const claimsToCheck = (config.options || []).map((option) => option.claim);
+
+        node.on('input', function (msg) {
+            if (!msg._client || !msg._client.user || typeof msg._client.user.claims !== "object") {
+                node.error("Invalid client claims in the input message", msg);
+                return;
+            }
+
+            const userClaims = msg._client.user.claims;
+
+            const isAuthorized = claimsToCheck.every((claim) => claim in userClaims);
+
+            if (isAuthorized) {
+                node.send([msg, undefined]);
+            } else {
+                node.send([undefined, msg]);
+            }
+        });
+    }
+
+    RED.nodes.registerType('check-authorization', CheckAuthorization);
+};

package/dataobject-instance-query.html

@@ -0,0 +1,141 @@
+<script type="text/javascript">
+    RED.nodes.registerType('dataobject-instance-query', {
+        category: 'ProcessCube',
+        color: '#02AFD6',
+        defaults: {
+            name: { value: '' },
+            engine: { value: '', type: 'processcube-engine-config' },
+            query: { value: 'payload' },
+            query_type: { value: 'msg' },
+            onlyNewest: { value: true },
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: 'data-object-query.svg',
+        label: function () {
+            return this.name || 'dataobject-instance-query';
+        },
+        oneditprepare: function () {
+            $('#node-input-query').typedInput({
+                default: 'msg',
+                types: ['msg', 'json'],
+            });
+
+            $('#node-input-query').typedInput('value', this.query);
+            $('#node-input-query').typedInput('type', this.query_type);
+        },
+        oneditsave: function () {
+            (this.query = $('#node-input-query').typedInput('value')),
+            (this.query_type = $('#node-input-query').typedInput('type'));
+        },
+    });
+</script>
+
+<script type="text/html" data-template-name="dataobject-instance-query">
+    <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>
+    <div class="form-row">
+        <label for="node-input-query"><i class="fa fa-tag"></i> Query</label>
+        <input type="text" id="node-input-query" />
+    </div>
+    <div class="form-row">
+      <label for="node-input-onlyNewest"><i class="fa fa-hand"></i>Only current instance per dataObject</label>
+      <input type="checkbox" id="node-input-onlyNewest" title="Applys a client-side filter, that returns just the newest instance per dataObject">
+    </div>
+</script>
+
+<script type="text/markdown" data-help-name="dataobject-instance-query">
+A node to query dataobject instances on the ProcessCube Engine.
+
+## Inputs
+
+: msg (Object | JSON) : The selected field of the *msg*, eg *payload*, will be used as the input for the query or can be directly set as JSON.
+: query (Object) : The query that was used.
+
+## Outputs
+
+: dataObjectInstances (Array) : The dataobject instances that matched the query.
+: totalCount (number) : The number of matches.
+
+### Query fields
+
+**Summary**:
+
+**Description**: Gets all DataObjectInstances that match the given query.
+
+#### Parameters:
+- Name: `offset` Required: `false`
+  - Type: number
+  - Description: The index of the first DataObjectInstance to include in the result set.
+- Name: `limit` Required: `false`
+  - Type: number
+  - Description: The maximum number of DataObjectInstances to return.
+- Name: `dataObjectId` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: myDataObjectId_12345678
+    - Array&lt;string&gt;: myDataObjectId_12345678,myDataObjectId_87654321
+    - object:
+  - Description: Filter by the ID of the DataObject.
+- Name: `flowNodeInstanceId` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: myFlowNodeInstanceId_12345678
+    - Array&lt;string&gt;: myFlowNodeInstanceId_12345678,myFlowNodeInstanceId_87654321
+    - object:
+  - Description: Filter by the ID of the FlowNodeInstance that wrote to the DataObject.
+- Name: `processInstanceId` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: myProcessInstance_12345678
+    - Array&lt;string&gt;: myProcessInstance_12345678,myProcessInstance_87654321
+    - object:
+  - Description: Filter by the ID of the ProcessInstances.
+- Name: `processDefinitionId` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: myProcess_12345678
+    - Array&lt;string&gt;: myProcess_12345678,myProcess_87654321
+    - object:
+  - Description: Filter by the ID of the ProcessDefinition that the DataObjectInstances belong to.
+- Name: `processModelId` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: myProcessModel_12345678
+    - Array&lt;string&gt;: myProcessModel_12345678,myProcessModel_87654321
+    - object:
+  - Description: Filter by the ID of the ProcessModel that the DataObjectInstances belong to.
+- Name: `embeddedProcessModelId` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: myProcessModel_12345678
+    - Array&lt;string&gt;: myProcessModel_12345678,myProcessModel_87654321
+    - object:
+  - Description: Filter by the ID of the EmbeededProcessModel that the DataObjectInstances belong to.
+- Name: `createdAt` Required: ``
+  - Type: Array&lt;string&gt; | string
+    - string: 2021-01-01T00:00:00.000Z
+    - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
+  - Description: The created date of the DataObjectInstances to include in the results.
+
+### Only current instance per dataObject
+
+When checked, an additional filter is applied to the result of the query.
+For each `dataObjectId`+`processInstanceId` in the result set, only the instance with the newest `createdAt` timestamp will be returned.
+Therefore, it creates a list containing only the current values of each dataObject.
+
+**Note**: This is not guranteed to work as described above. Since this is a client-side filter, that is applied after executing the server side query, there are some limitations.
+Depending on your query, you might not load all instances of an dataObject. I.e. when setting a limit or offset. Or when querying such an amount of instances, that the engine applies an automatic limit.
+In these cases, this filter will still be applied and return the newest instance from the result set, but that might not be the actual newest value for this dataObject, which would be available in the engines database.
+To avoid thoses problems, make sure to write strict queries, which are guranteed to have a small result set, that can be retrieved in one request.
+The `totalCount` property will, as well, not work as expected. Since this is a value created by the engine, it will not line up with the actual amount of instances, that are returned.
+
+**Note**: This feature will be removed in a future version.
+Due to the problems described above, this functionality should rather be provided by the engines interface.
+As soon as the engine supports querying for the newest dataObject values, this filter becomes obsolete and you should instead alter your query to apply this filter server-side.
+
+### References
+
+-  [The ProcessCube&copy; Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
+-  [ProcessCube&copy; LowCode Integration](https://processcube.io/docs/node-red) - LowCode integration in ProcessCube&copy;
+</script>

package/dataobject-instance-query.js

@@ -0,0 +1,45 @@
+module.exports = function (RED) {
+    function DataobjectInstanceQuery(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+
+        node.on('input', function (msg) {
+            let query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg);
+
+            node.engine = RED.nodes.getNode(config.engine);
+            const client = node.engine.engineClient;
+            const isUser = !!msg._client?.user && !!msg._client.user.accessToken;
+            const userIdentity = isUser ? { userId: msg._client.user.id, token: msg._client.user.accessToken } : null;
+
+            if (!client) {
+                node.error('No engine configured.', msg);
+                return;
+            }
+
+            client.dataObjectInstances
+                .query(query, { identity: userIdentity })
+                .then((matchingInstances) => {
+                    msg.payload = matchingInstances;
+
+                    if (config.onlyNewest) {
+                      const newestInstances = {};
+
+                      matchingInstances.dataObjectInstances.forEach(instance => {
+                        newestInstances[instance.processInstanceId] ??= {};
+                        if (!newestInstances[instance.processInstanceId][instance.dataObjectId] || newestInstances[instance.processInstanceId][instance.dataObjectId].createdAt < instance.createdAt) {
+                          newestInstances[instance.processInstanceId][instance.dataObjectId]  = instance;
+                        }
+                      })
+
+                      msg.payload.dataObjectInstances = Object.values(newestInstances).flatMap(v => Object.values(v));
+                    }
+
+                    node.send(msg);
+                })
+                .catch((error) => {
+                    node.error(`Dataobject Instance Query failed: ${error.message}`, msg);
+                });
+        });
+    }
+    RED.nodes.registerType('dataobject-instance-query', DataobjectInstanceQuery);
+};

package/endevent-finished-listener.js

@@ -4,48 +4,37 @@ module.exports = function (RED) {
         var node = this;
         node.engine = RED.nodes.getNode(config.engine);
 
+        let subscription = null;
+
         const register = async () => {
             const client = node.engine.engineClient;
 
             if (!client) {
-                node.error('No engine configured.');
+                node.error('No engine configured.', {});
                 return;
             }
-    
-            let currentIdentity = node.engine.identity;
-            let subscription = await client.events.onEndEventFinished(
-                (endEventFinished) => {
+
+            try {
+                subscription = await client.events.onEndEventFinished((endEventFinished) => {
                     node.send({
                         payload: endEventFinished,
                     });
-                },
-                { identity: currentIdentity },
-            );
-
-            node.engine.registerOnIdentityChanged(async (identity) => {
-                client.events.removeSubscription(subscription, currentIdentity);
-                
-                currentIdentity = identity;
-
-                subscription = await client.events.onEndEventFinished(
-                    (endEventFinished) => {
-                        node.send({
-                            payload: endEventFinished
-                        });
-                    },
-                    { identity: currentIdentity },
-                );
-            });
+                });
+            } catch (error) {
+                node.error(error, {});
+            }
 
             node.on('close', async () => {
                 if (node.engine && node.engine.engineClient && client) {
-                    client.events.removeSubscription(subscription, currentIdentity);
+                    client.events.removeSubscription(subscription);
                 }
             });
         };
 
         if (node.engine) {
-            register();
+            register().catch((error) => {
+                node.error(error, {});
+            });
         }
     }
     RED.nodes.registerType('endevent-finished-listener', EndEventFinishedListener);

package/examples/Check-Authorization-Sample.json

@@ -0,0 +1,109 @@
+[
+    {
+        "id": "3cb65f6178d62207",
+        "type": "tab",
+        "label": "Flow 1",
+        "disabled": false,
+        "info": "",
+        "env": []
+    },
+    {
+        "id": "466e6c33e4389342",
+        "type": "processcube-engine-config",
+        "name": "",
+        "url": "http://engine:8000",
+        "urlType": "str",
+        "clientId": "external_task_worker",
+        "clientIdType": "str",
+        "clientSecret": "external_task_worker_secret",
+        "clientSecretType": "str"
+    },
+    {
+        "id": "bf6699e3fcef19f7",
+        "type": "check-authorization",
+        "z": "3cb65f6178d62207",
+        "name": "",
+        "engine": "466e6c33e4389342",
+        "options": [
+            {
+                "claim": "gender"
+            },
+            {
+                "claim": "notavalidclaim"
+            }
+        ],
+        "x": 460,
+        "y": 280,
+        "wires": [
+            [
+                "5d331a2c7a214465"
+            ],
+            [
+                "931f5bf8a9c528cd"
+            ]
+        ]
+    },
+    {
+        "id": "5d331a2c7a214465",
+        "type": "debug",
+        "z": "3cb65f6178d62207",
+        "name": "debug 1",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 660,
+        "y": 260,
+        "wires": []
+    },
+    {
+        "id": "e3c38e3f6c38f58d",
+        "type": "inject",
+        "z": "3cb65f6178d62207",
+        "name": "",
+        "props": [
+            {
+                "p": "_client",
+                "v": "{\"user\":{\"id\":\"e54f73d2-b003-4454-ae50-dbd7c41e8bff\",\"displayName\":\"admin\",\"username\":\"admin\",\"profileUrl\":\"\",\"emails\":[{\"value\":\"admin@admin.de\"}],\"claims\":{\"sub\":\"e54f73d2-b003-4454-ae50-dbd7c41e8bff\",\"company\":\"\",\"locale\":\"\",\"website\":\"\",\"picture\":\"\",\"gender\":\"\",\"family_name\":\"\",\"zoneinfo\":\"\",\"preferred_username\":\"\",\"name\":\"admin\",\"nickname\":\"\",\"email\":\"admin@admin.de\",\"middle_name\":\"\",\"given_name\":\"\",\"updated_at\":null,\"email_verified\":true,\"birthdate\":\"\",\"profile\":\"\",\"jti\":\"zvImE0Nm96kxGJEjbyrh2\",\"iat\":1738847665,\"exp\":1738851265,\"scope\":\"openid profile email lanes\",\"client_id\":\"PassportTestClient\",\"iss\":\"http://authority:11560/\",\"aud\":\"PassportTestClient\"}}}",
+                "vt": "json"
+            },
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "user data",
+        "payloadType": "str",
+        "x": 240,
+        "y": 280,
+        "wires": [
+            [
+                "bf6699e3fcef19f7"
+            ]
+        ]
+    },
+    {
+        "id": "931f5bf8a9c528cd",
+        "type": "debug",
+        "z": "3cb65f6178d62207",
+        "name": "debug 2",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "false",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 660,
+        "y": 300,
+        "wires": []
+    }
+]