@5minds/node-red-contrib-processcube 0.3.3-develop-eaf8b5-lx1oicum → 0.3.3-feature-cefc25-lx7iaahd

package/.node-red/data/.config.nodes.json

@@ -547,6 +547,28 @@
                 "module": "@5minds/node-red-contrib-processcube",
                 "file": "/data/node_modules/node-red-contrib-processcube/process-start.js"
             },
+            "UserTaskInput": {
+                "name": "UserTaskInput",
+                "types": [
+                    "usertask-input"
+                ],
+                "enabled": true,
+                "local": true,
+                "user": false,
+                "module": "@5minds/node-red-contrib-processcube",
+                "file": "/data/node_modules/node-red-contrib-processcube/usertask-input.js"
+            },
+            "UserTaskOutput": {
+                "name": "UserTaskOutput",
+                "types": [
+                    "usertask-output"
+                ],
+                "enabled": true,
+                "local": true,
+                "user": false,
+                "module": "@5minds/node-red-contrib-processcube",
+                "file": "/data/node_modules/node-red-contrib-processcube/usertask-output.js"
+            },
             "processcubeEngineConfig": {
                 "name": "processcubeEngineConfig",
                 "types": [
@@ -559,5 +581,112 @@
                 "file": "/data/node_modules/node-red-contrib-processcube/processcube-engine-config.js"
             }
         }
+    },
+    "node-red-contrib-uibuilder": {
+        "name": "node-red-contrib-uibuilder",
+        "version": "6.8.2",
+        "local": false,
+        "user": false,
+        "nodes": {
+            "uibuilder": {
+                "name": "uibuilder",
+                "types": [
+                    "uibuilder"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uibuilder.js"
+            },
+            "uib-cache": {
+                "name": "uib-cache",
+                "types": [
+                    "uib-cache"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uib-cache.js"
+            },
+            "uib-tag": {
+                "name": "uib-tag",
+                "types": [
+                    "uib-tag"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uib-tag/customNode.js"
+            },
+            "uib-element": {
+                "name": "uib-element",
+                "types": [
+                    "uib-element"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uib-element/customNode.js"
+            },
+            "uib-update": {
+                "name": "uib-update",
+                "types": [
+                    "uib-update"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uib-update/customNode.js"
+            },
+            "uib-html": {
+                "name": "uib-html",
+                "types": [
+                    "uib-html"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uib-html/customNode.js"
+            },
+            "uib-save": {
+                "name": "uib-save",
+                "types": [
+                    "uib-save"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uib-save/customNode.js"
+            },
+            "uib-sender": {
+                "name": "uib-sender",
+                "types": [
+                    "uib-sender"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uib-sender.js"
+            },
+            "uib-list": {
+                "name": "uib-list",
+                "types": [
+                    "uib-list"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uib-list/customNode.js"
+            }
+        }
     }
 }

package/.node-red/data/.config.nodes.json.backup

@@ -499,7 +499,7 @@
     },
     "@5minds/node-red-contrib-processcube": {
         "name": "@5minds/node-red-contrib-processcube",
-        "version": "0.2.4",
+        "version": "0.2.6",
         "local": true,
         "user": false,
         "nodes": {
@@ -547,6 +547,17 @@
                 "module": "@5minds/node-red-contrib-processcube",
                 "file": "/data/node_modules/node-red-contrib-processcube/process-start.js"
             },
+            "UserTaskInput": {
+                "name": "UserTaskInput",
+                "types": [
+                    "usertask-input"
+                ],
+                "enabled": true,
+                "local": true,
+                "user": false,
+                "module": "@5minds/node-red-contrib-processcube",
+                "file": "/data/node_modules/node-red-contrib-processcube/usertask-input.js"
+            },
             "processcubeEngineConfig": {
                 "name": "processcubeEngineConfig",
                 "types": [
@@ -559,5 +570,112 @@
                 "file": "/data/node_modules/node-red-contrib-processcube/processcube-engine-config.js"
             }
         }
+    },
+    "node-red-contrib-uibuilder": {
+        "name": "node-red-contrib-uibuilder",
+        "version": "6.8.2",
+        "local": false,
+        "user": false,
+        "nodes": {
+            "uibuilder": {
+                "name": "uibuilder",
+                "types": [
+                    "uibuilder"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uibuilder.js"
+            },
+            "uib-cache": {
+                "name": "uib-cache",
+                "types": [
+                    "uib-cache"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uib-cache.js"
+            },
+            "uib-tag": {
+                "name": "uib-tag",
+                "types": [
+                    "uib-tag"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uib-tag/customNode.js"
+            },
+            "uib-element": {
+                "name": "uib-element",
+                "types": [
+                    "uib-element"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uib-element/customNode.js"
+            },
+            "uib-update": {
+                "name": "uib-update",
+                "types": [
+                    "uib-update"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uib-update/customNode.js"
+            },
+            "uib-html": {
+                "name": "uib-html",
+                "types": [
+                    "uib-html"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uib-html/customNode.js"
+            },
+            "uib-save": {
+                "name": "uib-save",
+                "types": [
+                    "uib-save"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uib-save/customNode.js"
+            },
+            "uib-sender": {
+                "name": "uib-sender",
+                "types": [
+                    "uib-sender"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uib-sender.js"
+            },
+            "uib-list": {
+                "name": "uib-list",
+                "types": [
+                    "uib-list"
+                ],
+                "enabled": true,
+                "local": false,
+                "user": false,
+                "module": "node-red-contrib-uibuilder",
+                "file": "/usr/src/node-red/node_modules/node-red-contrib-uibuilder/nodes/uib-list/customNode.js"
+            }
+        }
     }
 }

package/.node-red/data/.config.users.json.backup

@@ -16,7 +16,7 @@
                 "welcome": "3.1.8"
             }
         },
-        "menu-menu-item-sidebar": false,
-        "menu-menu-item-palette": true
+        "menu-menu-item-sidebar": true,
+        "menu-menu-item-palette": false
     }
 }

package/.node-red/data/flows.json

@@ -7,6 +7,14 @@
         "info": "",
         "env": []
     },
+    {
+        "id": "fd3c725340de4f74",
+        "type": "tab",
+        "label": "Flow 2",
+        "disabled": false,
+        "info": "",
+        "env": []
+    },
     {
         "id": "d042a4c68f51d6ab",
         "type": "processcube-engine-config",
@@ -875,5 +883,215 @@
         "x": 770,
         "y": 840,
         "wires": []
+    },
+    {
+        "id": "ec0be0ef92746967",
+        "type": "usertask-input",
+        "z": "fd3c725340de4f74",
+        "name": "",
+        "engine": "d042a4c68f51d6ab",
+        "x": 250,
+        "y": 120,
+        "wires": [
+            [
+                "090d42845540049c",
+                "846c5269df75c7a1"
+            ]
+        ]
+    },
+    {
+        "id": "090d42845540049c",
+        "type": "debug",
+        "z": "fd3c725340de4f74",
+        "name": "debug 10",
+        "active": false,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "false",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 520,
+        "y": 120,
+        "wires": []
+    },
+    {
+        "id": "661e71d204ee957d",
+        "type": "uibuilder",
+        "z": "fd3c725340de4f74",
+        "name": "",
+        "topic": "",
+        "url": "usertasks",
+        "okToGo": true,
+        "fwdInMessages": false,
+        "allowScripts": false,
+        "allowStyles": false,
+        "copyIndex": true,
+        "templateFolder": "blank",
+        "extTemplate": "",
+        "showfolder": false,
+        "reload": true,
+        "sourceFolder": "src",
+        "deployedVersion": "6.8.2",
+        "showMsgUib": false,
+        "title": "",
+        "descr": "",
+        "x": 410,
+        "y": 300,
+        "wires": [
+            [
+                "823445c277179d4e",
+                "4267576c32c782ec"
+            ],
+            [
+                "ce674239858cdfa1"
+            ]
+        ]
+    },
+    {
+        "id": "823445c277179d4e",
+        "type": "debug",
+        "z": "fd3c725340de4f74",
+        "name": "debug 11",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "false",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 600,
+        "y": 220,
+        "wires": []
+    },
+    {
+        "id": "4078e4fb0a080b04",
+        "type": "uib-element",
+        "z": "fd3c725340de4f74",
+        "name": "",
+        "topic": "",
+        "elementtype": "sform",
+        "parent": "body",
+        "parentSource": "",
+        "parentSourceType": "str",
+        "elementid": "",
+        "elementId": "",
+        "elementIdSourceType": "str",
+        "heading": "",
+        "headingSourceType": "str",
+        "headingLevel": "h2",
+        "data": "payload",
+        "dataSourceType": "msg",
+        "position": "last",
+        "positionSourceType": "str",
+        "passthrough": false,
+        "confData": {},
+        "x": 390,
+        "y": 420,
+        "wires": [
+            [
+                "c59406be55bd5124"
+            ]
+        ]
+    },
+    {
+        "id": "3b9e8eb5743f557c",
+        "type": "inject",
+        "z": "fd3c725340de4f74",
+        "name": "",
+        "props": [
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "[{\"id\":\"r1\",\"type\":\"text\",\"required\":false,\"label\":\"Label for form row 1\",\"value\":\"Foo\",\"title\":\"Some helpful text\"},{\"id\":\"r11\",\"type\":\"email\",\"required\":true,\"label\":\"Label for form row 11\",\"title\":\"Some helpful text\"},{\"id\":\"r12\",\"type\":\"month\",\"required\":true,\"label\":\"Label for form row 11\",\"title\":\"Some helpful text\"},{\"id\":\"r14\",\"type\":\"time\",\"required\":true,\"label\":\"Label for form row 11\",\"title\":\"Some helpful text\"},{\"id\":\"r15\",\"type\":\"week\",\"required\":true,\"label\":\"Label for form row 11\",\"title\":\"Some helpful text\"},{\"id\":\"r16\",\"type\":\"password\",\"required\":true,\"label\":\"Label for form row 11\",\"title\":\"Some helpful text\"},{\"id\":\"r2\",\"type\":\"range\",\"required\":true,\"label\":\"Label for form row 1\",\"value\":\"Foo\"},{\"id\":\"r3\",\"type\":\"button\",\"label\":\"Text on button\",\"value\":\"Buttons can have values as well\"}]",
+        "payloadType": "json",
+        "x": 80,
+        "y": 400,
+        "wires": [
+            [
+                "4078e4fb0a080b04"
+            ]
+        ]
+    },
+    {
+        "id": "c59406be55bd5124",
+        "type": "link out",
+        "z": "fd3c725340de4f74",
+        "name": "link out 1",
+        "mode": "link",
+        "links": [
+            "d9edaa2e3c514edc"
+        ],
+        "x": 545,
+        "y": 400,
+        "wires": []
+    },
+    {
+        "id": "d9edaa2e3c514edc",
+        "type": "link in",
+        "z": "fd3c725340de4f74",
+        "name": "link in 1",
+        "links": [
+            "c59406be55bd5124"
+        ],
+        "x": 245,
+        "y": 300,
+        "wires": [
+            [
+                "661e71d204ee957d"
+            ]
+        ]
+    },
+    {
+        "id": "846c5269df75c7a1",
+        "type": "function",
+        "z": "fd3c725340de4f74",
+        "name": "function 2",
+        "func": "msg.payload = msg.payload.formFields;\n\nreturn msg;",
+        "outputs": 1,
+        "timeout": 0,
+        "noerr": 0,
+        "initialize": "",
+        "finalize": "",
+        "libs": [],
+        "x": 100,
+        "y": 280,
+        "wires": [
+            [
+                "4078e4fb0a080b04"
+            ]
+        ]
+    },
+    {
+        "id": "ce674239858cdfa1",
+        "type": "debug",
+        "z": "fd3c725340de4f74",
+        "name": "debug 12",
+        "active": false,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "false",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 580,
+        "y": 320,
+        "wires": []
+    },
+    {
+        "id": "4267576c32c782ec",
+        "type": "usertask-output",
+        "z": "fd3c725340de4f74",
+        "name": "",
+        "engine": "d042a4c68f51d6ab",
+        "x": 740,
+        "y": 260,
+        "wires": []
     }
 ]

package/.node-red/data/uibuilder/.config/sioMiddleware.js-template

@@ -0,0 +1,53 @@
+/**
+ * Template Socket.IO Connection Middleware for uibuilder.
+ * UPDATED: 2022-04-01
+ *
+ * NOTES & WARNINGS:
+ *   1) This function is only called ONCE - when a new client connects. So any authentication/security processing is limited
+ *      because you cannot use this to, for example, timeout/extend a session without further server processing of incoming messages.
+ *      However, see the sioUse.js and sioMsgOut.js middlewares for per-msg handling.
+ *   2) Failing to either return or call `next()` will mean that your clients will never connect.
+ *   3) An error in this function will probably cause Node-RED to fail to start at all.
+ *   4) You have to restart Node-RED if you change this file.
+ *   5) To use for authentication/authorisation with Express and sio connection middleware, create a common node.js module.
+ *
+ * Allows custom processing for authentication, session management, connection validation, logging, rate limiting, etc.
+ * 
+ * see also: uibRoot/.config/sioUse.js & sioMsgOut.js
+ *           https://cheatsheetseries.owasp.org/cheatsheets/HTML5_Security_Cheat_Sheet.html#websocket-implementation-hints
+ * 
+ * @param {*} socket Socket.IO socket object
+ * @param {function} next The callback to hand off to the next middleware
+ */
+function sioMw(socket, next) {
+    // Some SIO related info that might be useful in security checks
+    console.log('== [sioMiddleware.js] ====================')
+    console.log('New client connected to Namespace')
+    console.log('--socket.request.connection.remoteAddress--', socket.request.connection.remoteAddress)
+    console.log('--socket id--', socket.id)
+    // Added by uibuilder when Namespace is created by uibuilder node instance - Note also that socket.nsp.log can be used to output to the Node-RED log
+    console.log('--socket namespace metadata (server)--', {
+        name: socket.nsp.name,
+        url: socket.nsp.url,
+        nodeId: socket.nsp.nodeId,
+        useSecurity: socket.nsp.useSecurity,
+    })
+    //console.log('--socket handshake--', socket.handshake)
+    //console.log('--socket properties--', Object.keys(socket))
+    // Show the client id (set by uibuilder ExpressJS middleware)
+    console.log('--client id handshake.auth--', socket.handshake.auth.clientId)
+    console.log('--client id in custom header (polling only)--', socket.handshake.headers['x-clientid'])
+    console.log('==========================================\n ')
+
+    // Simplistic auth example
+    let auth = true
+    if (auth !== true) {
+        socket.nsp.log.error(`[uibuilder:sioMiddleware.js] - Authentication error, client disconnected - ID: ${socket.id}`)
+        return next (new Error(`[uibuilder:sioMiddleware.js] - Authentication error, client disconnected - ID: ${socket.id}` ))
+    }
+
+    return next()
+
+} // Remember to end with a `next()` statement or nothing will work.
+
+module.exports = sioMw

package/.node-red/data/uibuilder/.config/sioMsgOut.js-template

@@ -0,0 +1,22 @@
+/**
+ * Template Socket.IO outbound per-msg middleware for uibuilder. Fn will be called for EVERY outbound msg from Node-RED/uibuilder to a client.
+ * UPDATED: 2022-04-01
+ *
+ * NOTES & WARNINGS:
+ *   1) This function is called whenever any instance of uibuilder sends a msg to any client.
+ *   2) You have to restart Node-RED if you change this file.
+ *   3) You can use this to make changes to the msg before it is sent.
+ *
+ * Allows you to process outgoing data to clients. Use it to add security/user data or anything else.
+ * 
+ * @param {object} msg The msg being seny by uibuilder to a client
+ * @param {string} url The uibuilder instance url
+ * @param {string} channel The socket.io channel being used
+ */
+ function sioMsgOutMw( msg, url, channel ) {
+
+    console.log('[uibuilder:Socket.IO:sioMsgOut.js] msg from server: ', msg, url, channel)
+
+}
+
+module.exports = sioMsgOutMw

package/.node-red/data/uibuilder/.config/sioUse.js-template

@@ -0,0 +1,43 @@
+/**
+ * Template Socket.IO `use` middleware for uibuilder. Fn will be called for EVERY inbound msg from a client to Node-RED/uibuilder.
+ * UPDATED: 2022-04-01
+ *
+ * NOTES & WARNINGS:
+ *   1) This function is called when a client sends a "packet" of data to the server.
+ *   2) Failing to either return or call `next()` will mean that your clients will never be able to get responses.
+ *   3) You can amend the incoming msg in this middleware.
+ *   4) An error in this function will probably cause Node-RED to fail to start at all.
+ *   5) You have to restart Node-RED if you change this file.
+ *   6) If you call `next( new Error('blah') )` The error is sent back to the client and further proessing of the incoming msg stops.
+ *   7) To use for authentication/authorisation with Express and sio connection middleware, create a common node.js module.
+ *
+ * Allows you to process incoming data from clients.
+ * 
+ * see: https://socket.io/docs/v4/server-api/#socketusefn
+ * see also: uibRoot/.config/sioMiddleware.js & sioMsgOut.js
+ *           and https://cheatsheetseries.owasp.org/cheatsheets/HTML5_Security_Cheat_Sheet.html#websocket-implementation-hints
+ * 
+ * @param {[string,Array<Object>]} data The channel name (strictly the event name) and args send by a client (Socket.IO calls it a "packet"). data[0] is the channel/event name, data[args][0] is the actual msg
+ * @param {function} next The callback to hand off to the next middleware
+ */
+function sioUseMw([ channel, ...args ], next) {
+
+    const msg = args[0]
+
+    console.log('[uibuilder:Socket.IO:sioUse.js] msg from client: ', 'Channel Name:', channel, ' Msg:', msg)
+
+    // Simplistic error example - looking for specific property on the inbound msg
+    if ( msg.i_am_an_error ) {
+        // The error is sent back to the client and further processing of the msg stops
+        next(new Error('Oops! Some kind of error happened'))
+        return
+    }
+
+    // You can amend the incoming msg
+    msg._test = 'added by sioUse.js middleware'
+    
+    next()
+
+} // Do not forget to end with a call to `next()` or clients will not be able to connect
+
+module.exports = sioUseMw

package/.node-red/data/uibuilder/.config/uibMiddleware.js-template

@@ -0,0 +1,26 @@
+/**
+ * Template ExpressJS Middleware for uibuilder.
+ * UPDATED: 2022-04-01
+ *
+ * NOTES & WARNINGS:
+ *   1) This function is called EVERY TIME any web call is made to the URL defined by your uib instance.
+ *      So it should be kept short and efficient.
+ *   2) Failing to either return or call `next()` will cause an ExpressJS error.
+ *   3) An error in this function will probably cause Node-RED to fail to start at all.
+ *   4) You have to restart Node-RED if you change this file.
+ *   5) To use for authentication/authorisation with sio connection middleware, create a common node.js module.
+ *
+ * Allows custom processing for authentication, session management, custom logging, etc.
+ * 
+ * @param {object} req The ExpressJS request object
+ * @param {object} res The ExpressJS result object
+ * @param {function} next The callback to hand off to the next middleware
+ */
+ function uibMw(req,res,next) {
+
+    console.log('[uibuilder:uibMiddleware.js] Custom ExpressJS middleware called.')
+    next()
+
+} // Do not forget to end with a call to `next()`
+
+module.exports = uibMw