@gregoriusrippenstein/node-red-contrib-introspection 0.5.0 → 0.5.1

package/README.md

@@ -79,9 +79,16 @@ The context in which the code is exected includes:
 
 - `payload` which is the the `msg.payload` value
 - `topic` which is the `msg.topic` value
+- `msg.payload` contains the payload sent to the node.
+- `node.id` and `nodeid` are the id of the current node
+
+Functionality which interacts with the flow: 
+
 - `node.send(payload)` where `payload` becomes the output the node on the server side
 - `node.error("msg")` where msg is shown as a notification within the editor
-- `msg.payload` contains the payload sent to the node.
+- `node.status({fill: 'red', shape: 'dot', text: 'hello world'})` - generate a status for the node.
+
+An example if the client code node is this [flow](https://flowhub.org/f/01920991a09b7e95) where the node generates an in browser notification.
 
 ## Deprecated Nodes
 

package/nodes/60-client-code.html

@@ -15,7 +15,7 @@
          url:         "ClientCode/" + nodeid,
          type:        "POST",
          contentType: "application/json; charset=utf-8",
-         data: JSON.stringify(data),
+         data:        JSON.stringify(data),
 
          success: function (resp) {
          },
@@ -31,6 +31,27 @@
        });
      };
 
+    var doStatus = (sts, nodeid, _msg) => {
+       $.ajax({
+         url:         "ClientCode/" + nodeid + "/status",
+         type:        "POST",
+         contentType: "application/json; charset=utf-8",
+         data:        JSON.stringify(sts),
+
+         success: function (resp) {
+         },
+
+         error: function (jqXHR, textStatus, errorThrown) {
+           RED.notify("ClientCode Communcation Failure: " +
+                      nodeid + ": " + textStatus, {
+             type: "error",
+             id: nodeid,
+             timeout: 3000
+           });
+         }
+       });
+     }
+
      var doError = (msg, nodeid, _msg) => {
        RED.notify("ClientCode Failed: " + nodeid + ": " + msg, {
          type: "error",
@@ -46,13 +67,10 @@
      var msg = data._msg;
 
      var node = {
-       send: (dt) => {
-         doSend(dt, nodeid, _msg)
-       },
-       error: (mg) => {
-         doError(mg, nodeid, _msg)
-       },
-       id: data.nodeid
+       id:     data.nodeid,
+       send:   (dt)  => { doSend(dt, nodeid, _msg)     },
+       error:  (mg)  => { doError(mg, nodeid, _msg)    },
+       status: (sts) => { doStatus(sts, nodeid, _msg)  }
      };
 
      var payload = data.payload;
@@ -106,8 +124,19 @@
 
       this.editor = RED.editor.createEditor({
         id: 'node-input-clientcode-editor',
-        mode: 'ace/mode/javascript',
+        mode: 'ace/mode/nrjavascript',
         stateId: stateId,
+        globals: {
+          msg:true,          
+          RED: true,
+          node: true,
+          console: true,
+          Buffer: true,
+          setTimeout: true,
+          clearTimeout: true,
+          setInterval: true,
+          clearInterval: true
+        },
         value: $("#node-input-clientcode").val()
       });
 
@@ -218,6 +247,7 @@ Variables:
 Functionality:
   node.send({..}) - send data to the output port of this node
   node.error("msg") - generate an error for the node
+  node.status( { fill: 'red', shape: 'dot', text: 'hello world'}) - generate a status for the node.
     </code>
    </pre>
 

package/nodes/60-client-code.js

@@ -47,4 +47,27 @@ module.exports = function(RED) {
                        }
                      });
 
+
+  RED.httpAdmin.post("/ClientCode/:id/status",
+    RED.auth.needsPermission("ClientCode.write"),
+    (req, res) => {
+      var node = RED.nodes.getNode(req.params.id);
+      if (node != null) {
+        try {
+          if (req.body && node.type == "ClientCode") {
+            node.status(req.body);
+            res.sendStatus(200);
+          } else {
+            res.sendStatus(404);
+          }
+        } catch (err) {
+          res.sendStatus(500);
+          node.error("ClientCode: Submission failed: " +
+            err.toString())
+        }
+      } else {
+        res.sendStatus(404);
+      }
+    });
+
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gregoriusrippenstein/node-red-contrib-introspection",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "dependencies": {
     "got": "latest"
   },