@5minds/node-red-contrib-processcube 0.14.0 → 0.15.0-develop-2d3c96-lz098cox

package/.prettierrc.json

@@ -0,0 +1,6 @@
+{
+    "singleQuote": true,
+    "printWidth": 120,
+    "arrowParens": "always",
+    "tabWidth": 4
+}

package/externaltask-error.html

@@ -1,45 +1,45 @@
 <script type="text/javascript">
-    RED.nodes.registerType('externaltask-error',{
+    RED.nodes.registerType('externaltask-error', {
         category: 'ProcessCube',
         color: '#F6A923',
         defaults: {
-            name: {value:""},
-            error: {value:""}
+            name: { value: '' },
+            error: { value: '' },
         },
         inputs: 1,
         outputs: 1,
-        icon: "font-awesome/fa-exclamation-triangle",
-        label: function() {
-            return this.name || "externaltask-error";
-        }
+        icon: 'font-awesome/fa-exclamation-triangle',
+        label: function () {
+            return this.name || 'externaltask-error';
+        },
     });
 </script>
 
 <script type="text/html" data-template-name="externaltask-error">
     <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">
+        <input type="text" id="node-input-name" placeholder="Name" />
     </div>
     <div class="form-row">
         <label for="node-input-error"><i class="fa fa-tag"></i> Error Code</label>
-        <input type="text" id="node-input-error" placeholder="Error Code of ExternalTask">
+        <input type="text" id="node-input-error" placeholder="Error Code of ExternalTask" />
     </div>
 </script>
 
 <script type="text/markdown" data-help-name="externaltask-error">
-Used for reporting errors in the processing of external tasks. The error 
-code `Error` in the configuration is forwarded to the ProcessCube engine for 
-handling within *Error-Boundary-Events*.
+    Used for reporting errors in the processing of external tasks. The error
+    code `Error` in the configuration is forwarded to the ProcessCube engine for
+    handling within _Error-Boundary-Events_.
 
-## Inputs
+    ## Inputs
 
-: msg (Object)        : Passed as `ErrorDetails` to the engine
-: Error (string)      : From the configuration
-: Message (string)    : The caught exception message
-: StackTrace (string) : The stack trace of the exception
+    : msg (Object) : Passed as `ErrorDetails` to the engine
+    : Error (string) : From the configuration
+    : Message (string) : The caught exception message
+    : StackTrace (string) : The stack trace of the exception
 
-### References
+    ### References
 
-- [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
-- [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
-</script>
+    -   [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
+    -   [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
+</script>

package/externaltask-error.js

@@ -1,19 +1,18 @@
-module.exports = function(RED) {
+module.exports = function (RED) {
     function ExternalTaskError(config) {
-        RED.nodes.createNode(this,config);
+        RED.nodes.createNode(this, config);
         var node = this;
 
         var flowContext = node.context().flow;
-        var eventEmitter = flowContext.get('emitter');       
-
-        node.on('input', function(msg) {
+        var eventEmitter = flowContext.get('emitter');
 
+        node.on('input', function (msg) {
             const flowNodeInstanceId = msg.flowNodeInstanceId;
 
             let msgError = msg.error;
 
             if (msgError === undefined) {
-                msgError.message = "An error occurred";
+                msgError.message = 'An error occurred';
             }
 
             const error = new Error(msgError.message);
@@ -24,9 +23,9 @@ module.exports = function(RED) {
             msg.errorMessage = msgError.message;
 
             eventEmitter.emit(`handle-${flowNodeInstanceId}`, error, true);
-            
+
             node.send(msg);
-        });     
+        });
     }
-    RED.nodes.registerType("externaltask-error", ExternalTaskError);
-}
+    RED.nodes.registerType('externaltask-error', ExternalTaskError);
+};

package/externaltask-input.html

@@ -1,53 +1,53 @@
 <script type="text/javascript">
-    RED.nodes.registerType('externaltask-input',{
+    RED.nodes.registerType('externaltask-input', {
         category: 'ProcessCube',
         color: '#02AFD6',
         defaults: {
-            name: {value: ""},
-            engine: {value: "", type: "processcube-engine-config"},
-            topic: {value: ""}
+            name: { value: '' },
+            engine: { value: '', type: 'processcube-engine-config' },
+            topic: { value: '' },
         },
         inputs: 0,
         outputs: 1,
-        icon: "font-awesome/fa-envelope-open",
-        label: function() {
-            return this.name||"externaltask-input";
-        }
+        icon: 'font-awesome/fa-envelope-open',
+        label: function () {
+            return this.name || 'externaltask-input';
+        },
     });
 </script>
 
 <script type="text/html" data-template-name="externaltask-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">
+        <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</label>
-        <input type="text" id="node-input-engine" placeholder="Engine">
+        <input type="text" id="node-input-engine" placeholder="Engine" />
     </div>
     <div class="form-row">
         <label for="node-input-topic"><i class="fa fa-tag"></i> Topic</label>
-        <input type="text" id="node-input-topic" placeholder="Topic of ExternalTask">
+        <input type="text" id="node-input-topic" placeholder="Topic of ExternalTask" />
     </div>
 </script>
 
 <script type="text/markdown" data-help-name="externaltask-input">
-Waiting for external tasks that correspond to the `Topic` configured in 
-the connected ProcessCube Engine for processing.
+    Waiting for external tasks that correspond to the `Topic` configured in
+    the connected ProcessCube Engine for processing.
 
-## Outputs
+    ## Outputs
 
-: payload (string)   : Defines the input of the external task token
-: task (object)      : The external task object
-: flowNodeInstanceId : The Id of the external task, which is needed to complete the task
+    : payload (string) : Defines the input of the external task token
+    : task (object) : The external task object
+    : flowNodeInstanceId : The Id of the external task, which is needed to complete the task
 
-### Details
+    ### Details
 
-- To finish the external task the `externaltask-output` node is required.
-- For handling a error while executing a flow as external task the `externaltask-error` node is required.
+    -   To finish the external task the `externaltask-output` node is required.
+    -   For handling a error while executing a flow as external task the `externaltask-error` node is required.
 
-### References
+    ### References
 
-- [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; Plattform
-- [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED Integration in ProcessCube&copy;
-</script>
+    -   [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; Plattform
+    -   [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED Integration in ProcessCube&copy;
+</script>

package/externaltask-input.js

@@ -2,20 +2,20 @@ const EventEmitter = require('node:events');
 
 function showStatus(node, msgCounter) {
     if (msgCounter >= 1) {
-        node.status({fill: "blue", shape: "dot", text: `handling tasks ${msgCounter}.`});
+        node.status({ fill: 'blue', shape: 'dot', text: `handling tasks ${msgCounter}.` });
     } else {
-        node.status({fill: "blue", shape: "ring", text: `subcribed.`});
+        node.status({ fill: 'blue', shape: 'ring', text: `subcribed.` });
     }
 }
 
 const started_external_tasks = {};
 
-module.exports = function(RED) {
+module.exports = function (RED) {
     function ExternalTaskInput(config) {
-        RED.nodes.createNode(this,config);
+        RED.nodes.createNode(this, config);
         var node = this;
         var flowContext = node.context().flow;
-      
+
         this.engine = this.server = RED.nodes.getNode(config.engine);
 
         const client = this.engine.getEngineClient();
@@ -27,10 +27,8 @@ module.exports = function(RED) {
             eventEmitter = flowContext.get('emitter');
         }
 
-        client.externalTasks.subscribeToExternalTaskTopic(
-            config.topic,
-            async (payload, externalTask) => {
-
+        client.externalTasks
+            .subscribeToExternalTaskTopic(config.topic, async (payload, externalTask) => {
                 const saveHandleCallback = (data, callback) => {
                     try {
                         callback(data);
@@ -38,13 +36,14 @@ module.exports = function(RED) {
                         node.error(`Error in callback 'saveHandleCallback': ${error.message}`);
                     }
                 };
-                
-                return await new Promise((resolve, reject) => {
 
+                return await new Promise((resolve, reject) => {
                     const handleFinishTask = (msg) => {
                         let result = RED.util.encodeObject(msg.payload);
 
-                        node.log(`handle event for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* ${externalTask.processInstanceId} with result ${result} on msg._msgid ${msg._msgid}.`);
+                        node.log(
+                            `handle event for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* ${externalTask.processInstanceId} with result ${result} on msg._msgid ${msg._msgid}.`,
+                        );
 
                         if (externalTask.flowNodeInstanceId) {
                             delete started_external_tasks[externalTask.flowNodeInstanceId];
@@ -52,14 +51,14 @@ module.exports = function(RED) {
 
                         showStatus(node, Object.keys(started_external_tasks).length);
 
-
                         //resolve(result);
-                        saveHandleCallback(result, resolve)
+                        saveHandleCallback(result, resolve);
                     };
 
                     const handleErrorTask = (msg) => {
-
-                        node.log(`handle error event for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}' on *msg._msgid* '${msg._msgid}'.`);
+                        node.log(
+                            `handle error event for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}' on *msg._msgid* '${msg._msgid}'.`,
+                        );
 
                         if (externalTask.flowNodeInstanceId) {
                             delete started_external_tasks[externalTask.flowNodeInstanceId];
@@ -67,8 +66,7 @@ module.exports = function(RED) {
 
                         showStatus(node, Object.keys(started_external_tasks).length);
 
-
-                        // TODO: with reject, the default error handling is proceed 
+                        // TODO: with reject, the default error handling is proceed
                         // SEE: https://github.com/5minds/ProcessCube.Engine.Client.ts/blob/develop/src/ExternalTaskWorker.ts#L180
                         // reject(result);
                         //resolve(msg);
@@ -76,7 +74,9 @@ module.exports = function(RED) {
                     };
 
                     eventEmitter.once(`handle-${externalTask.flowNodeInstanceId}`, (msg, isError = false) => {
-                        node.log(`handle event for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}' with *msg._msgid* '${msg._msgid}' and *isError* '${isError}'`);
+                        node.log(
+                            `handle event for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}' with *msg._msgid* '${msg._msgid}' and *isError* '${isError}'`,
+                        );
 
                         if (isError) {
                             handleErrorTask(msg);
@@ -93,21 +93,23 @@ module.exports = function(RED) {
                         _msgid: RED.util.generateId(),
                         task: RED.util.encodeObject(externalTask),
                         payload: payload,
-                        flowNodeInstanceId: externalTask.flowNodeInstanceId
+                        flowNodeInstanceId: externalTask.flowNodeInstanceId,
                     };
-                    
-                    node.log(`Received *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}' with *msg._msgid* '${msg._msgid}'`);
-                    
+
+                    node.log(
+                        `Received *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}' with *msg._msgid* '${msg._msgid}'`,
+                    );
+
                     node.send(msg);
                 });
-            },
-            ).then(async externalTaskWorker => {
-                node.status({fill: "blue", shape: "ring", text: "subcribed"});
+            })
+            .then(async (externalTaskWorker) => {
+                node.status({ fill: 'blue', shape: 'ring', text: 'subcribed' });
 
                 externalTaskWorker.identity = node.server.identity;
                 node.server.registerOnIdentityChanged((identity) => {
                     externalTaskWorker.identity = identity;
-                }); 
+                });
 
                 // export type WorkerErrorHandler = (errorType: 'fetchAndLock' | 'extendLock' | 'processExternalTask' | 'finishExternalTask', error: Error, externalTask?: ExternalTask<any>) => void;
                 externalTaskWorker.onWorkerError((errorType, error, externalTask) => {
@@ -115,8 +117,10 @@ module.exports = function(RED) {
                         case 'extendLock':
                         case 'finishExternalTask':
                         case 'processExternalTask':
-                            node.error(`Worker error ${errorType} for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}': ${error.message}`);
-                    
+                            node.error(
+                                `Worker error ${errorType} for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}': ${error.message}`,
+                            );
+
                             if (externalTask) {
                                 delete started_external_tasks[externalTask.flowNodeInstanceId];
                             }
@@ -135,18 +139,18 @@ module.exports = function(RED) {
                     node.error(`Worker start 'externalTaskWorker.start' failed: ${error.message}`);
                 }
 
-                node.on("close", () => {
+                node.on('close', () => {
                     try {
                         externalTaskWorker.stop();
                     } catch {
                         node.error('Client close failed');
                     }
                 });
-            }
-        ).catch((error) => {
-            node.error(`Error in subscribeToExternalTaskTopic: ${error.message}`);
-        });
+            })
+            .catch((error) => {
+                node.error(`Error in subscribeToExternalTaskTopic: ${error.message}`);
+            });
     }
 
-    RED.nodes.registerType("externaltask-input", ExternalTaskInput);
-}
+    RED.nodes.registerType('externaltask-input', ExternalTaskInput);
+};

package/externaltask-output.html

@@ -1,36 +1,36 @@
 <script type="text/javascript">
-    RED.nodes.registerType('externaltask-output',{
+    RED.nodes.registerType('externaltask-output', {
         category: 'ProcessCube',
         color: '#02AFD6',
         defaults: {
-            name: {value:""}
+            name: { value: '' },
         },
         inputs: 1,
         outputs: 0,
-        icon: "font-awesome/fa-envelope",
-        label: function() {
-            return this.name||"externaltask-output";
-        }
+        icon: 'font-awesome/fa-envelope',
+        label: function () {
+            return this.name || 'externaltask-output';
+        },
     });
 </script>
 
 <script type="text/html" data-template-name="externaltask-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">
+        <input type="text" id="node-input-name" placeholder="Name" />
     </div>
 </script>
 
 <script type="text/markdown" data-help-name="externaltask-output">
-Used to complete the external task. The `msg.payload` is returned to the ProcessCube 
-engine as the result of the external task.
+    Used to complete the external task. The `msg.payload` is returned to the ProcessCube
+    engine as the result of the external task.
 
-## Inputs
+    ## Inputs
 
-: payload (Object) : Returned to the ProcessCube engine as the result of the external task
+    : payload (Object) : Returned to the ProcessCube engine as the result of the external task
 
-### References
+    ### References
 
-- [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
-- [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
-</script>
+    -   [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
+    -   [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
+</script>

package/externaltask-output.js

@@ -1,21 +1,20 @@
-module.exports = function(RED) {
+module.exports = function (RED) {
     function ExternalTaskOutput(config) {
-        RED.nodes.createNode(this,config);
+        RED.nodes.createNode(this, config);
         var node = this;
 
         var flowContext = node.context().flow;
         var eventEmitter = flowContext.get('emitter');
 
-        node.on('input', function(msg) {
-            
+        node.on('input', function (msg) {
             const flowNodeInstanceId = msg.flowNodeInstanceId;
 
             if (!flowNodeInstanceId) {
-               node.error('Error: The message did not contain the required external task id.', msg);
-            }  
+                node.error('Error: The message did not contain the required external task id.', msg);
+            }
 
             eventEmitter.emit(`handle-${flowNodeInstanceId}`, msg, false);
-        });     
+        });
     }
-    RED.nodes.registerType("externaltask-output", ExternalTaskOutput);
-}
+    RED.nodes.registerType('externaltask-output', ExternalTaskOutput);
+};

package/message-event-trigger.html

@@ -1,41 +1,41 @@
 <script type="text/javascript">
-    RED.nodes.registerType('message-event-trigger',{
+    RED.nodes.registerType('message-event-trigger', {
         category: 'ProcessCube',
         color: '#02AFD6',
         defaults: {
-            name: {value: ""},
-            engine: {value: "", type: "processcube-engine-config"},
-            messagename: {value: "", required: true},
-            processInstanceId: {value:""}
+            name: { value: '' },
+            engine: { value: '', type: 'processcube-engine-config' },
+            messagename: { value: '', required: true },
+            processInstanceId: { value: '' },
         },
         inputs: 1,
         outputs: 1,
-        icon: "font-awesome/fa-envelope-open",
-        label: function() {
-            return this.name||"message-event-trigger";
-        }
+        icon: 'font-awesome/fa-envelope-open',
+        label: function () {
+            return this.name || 'message-event-trigger';
+        },
     });
 </script>
 
 <script type="text/html" data-template-name="message-event-trigger">
     <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">
+        <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</label>
-        <input type="text" id="node-input-engine" placeholder="Engine">
+        <input type="text" id="node-input-engine" placeholder="Engine" />
     </div>
     <div class="form-row">
         <label for="node-input-messagename"><i class="fa fa-tag"></i> Message Name</label>
-        <input type="text" id="node-input-messagename" placeholder="Name of the Message-Event">
+        <input type="text" id="node-input-messagename" placeholder="Name of the Message-Event" />
     </div>
     <div class="form-row">
         <label for="node-input-processinstanceid"><i class="fa fa-tag"></i> Process Instance Id</label>
-        <input type="text" id="node-input-processinstanceid" placeholder="Id of the recipient process instance">
+        <input type="text" id="node-input-processinstanceid" placeholder="Id of the recipient process instance" />
     </div>
 </script>
 
 <script type="text/html" data-help-name="externaltask-input">
     <p>A node which emmits an message event to the Engine.</p>
-</script>
+</script>

package/message-event-trigger.js

@@ -1,6 +1,6 @@
-const process = require("process");
+const process = require('process');
 
-const engine_client = require("@5minds/processcube_engine_client");
+const engine_client = require('@5minds/processcube_engine_client');
 
 module.exports = function (RED) {
     function MessageEventTrigger(config) {
@@ -11,7 +11,7 @@ module.exports = function (RED) {
 
         const client = this.engine.getEngineClient();
 
-        node.on("input", function (msg) {
+        node.on('input', function (msg) {
             client.events
                 .triggerMessageEvent(config.messagename, {
                     processInstanceId: config.processinstanceid,
@@ -23,8 +23,8 @@ module.exports = function (RED) {
 
                     node.send(msg);
                     node.status({
-                        fill: "blue",
-                        shape: "dot",
+                        fill: 'blue',
+                        shape: 'dot',
                         text: `message event triggered`,
                     });
                 })
@@ -33,5 +33,5 @@ module.exports = function (RED) {
                 });
         });
     }
-    RED.nodes.registerType("message-event-trigger", MessageEventTrigger);
+    RED.nodes.registerType('message-event-trigger', MessageEventTrigger);
 };