@gregoriusrippenstein/node-red-contrib-introspection 0.3.0 → 0.3.2

package/README.md

@@ -85,6 +85,14 @@ GetFlows supports version selection of the flows and it has limited authenticati
 
 Inspired by the [dsm](https://flows.nodered.org/node/node-red-contrib-dsm) package that has a [backup](https://github.com/cflurin/node-red-contrib-dsm/wiki/Backup) state machine.
 
+### SendFlow
+
+Send a flow to another Node-RED instance. This will replace **any existing** flows on the other server, use with care. Under the hood this uses the [Node-RED API](https://nodered.org/docs/api/admin/methods/post/flows/) to post a new flow to the server. This node also supports authentication if the other server happens to have some.
+
+### TriggerImport
+
+This node will open the Node-RED import dialog and insert the payload, i.e. a flow object, into the dialog. The flow can then be imported into the existing workspace. See the [RSS example](https://flowhub.org/f/e02ba6e534f7a0f4) for more details. Payload must be a valid flow object, i.e. a Javascript array with one object per node. The import dialog will complain should this not be the case.
+
 ## Node-RED Versions
 
 These nodes have been tested and found to work on Node-RED 3.0.2 and 3.1.0.beta.4.
@@ -97,6 +105,8 @@ There are [example flows](/examples) contained in the package, examples can also
 - [Sink and Seeker](https://flowhub.org/f/139a816449acd89f)
 - [Screenshot](https://flowhub.org/f/07b2d0f3b0445ab5)
 - [DrawSVG](https://flowhub.org/f/141037dcda5b69fd)
+- [GetFlows](https://flowhub.org/f/0b1bfbf6e540be66)
+- [TriggerImport](https://flowhub.org/f/e02ba6e534f7a0f4)
 
 ## License
 

package/nodes/50-send-flow.html

@@ -0,0 +1,126 @@
+<script type="text/javascript">
+  RED.nodes.registerType('SendFlow',{
+    color: '#e5e4ef',
+    icon: "icons/subflow.svg",
+    category: 'introspection',
+    defaults: {
+      name: {
+        value:"",
+      },
+      hostUrl: {
+        value: ""
+      },
+      flowVersion: {
+        value: "v1"
+      },
+      useAuthentication: {
+        value:false
+      },
+      apiUsername: {
+        value: "",
+      },
+      apiUsernameType: {
+        value: "env",
+      },
+      apiPassword: {
+        value: "",
+      },
+      apiPasswordType: {
+        value: "env",
+      },
+    },
+    inputs:1,
+    outputs:1,
+
+    label: function() {
+      return (this.name || this._def.paletteLabel);
+    },
+
+    labelStyle: function() {
+      return this.name?"node_label_italic":"";
+    },
+    oneditprepare: function() {
+      $("#node-input-apiUsername").typedInput({
+        types:["env", "msg", "flow","global", "cred"],
+        typeField: "#node-input-apiUsernameType"
+      });
+
+      $("#node-input-apiPassword").typedInput({
+        types:["env", "msg", "flow","global", "env", "cred"],
+        typeField: "#node-input-apiPasswordType"
+      });
+
+      if ( $('#node-input-useAuthentication').is(":checked") ) {
+        $('#useAuthentication-input-fields').show();
+      } else {
+        $('#useAuthentication-input-fields').hide()
+      }
+
+      $('#node-input-useAuthentication').on( 'change', function() {
+        if ( $('#node-input-useAuthentication').is(":checked") ) {
+          $('#useAuthentication-input-fields').show();
+        } else {
+          $('#useAuthentication-input-fields').hide()
+        }
+      });
+    },
+  });
+</script>
+
+<script type="text/html" data-template-name="SendFlow">
+    <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-hostUrl"><i class="fa fa-tag"></i> Host</label>
+        <input type="text" id="node-input-hostUrl" placeholder="Host URL">
+    </div>
+
+    <div class="form-row">
+      <label for="node-input-flowVersion">
+        <i class="fa fa-tag"></i>
+        <span>Flow Version</span>
+      </label>
+
+      <select id="node-input-flowVersion">
+        <option value="v1" selected=selected>Version 1</option>
+        <option value="v2">Version 2</option>
+      </select>
+    </div>
+
+    <div class="form-row">
+      <label for="node-input-useAuthentication">
+        <i class="fa "></i>
+        <span>Use Authentication?</span>
+      </label>
+
+      <input type="checkbox" id="node-input-useAuthentication"
+             style="display:inline-block; width:15px; vertical-align:baseline;">
+    </div>
+
+    <div id="useAuthentication-input-fields" class="hidden">
+      <div class="form-row">
+        <label for="node-input-apiUsername">
+          <i class="fa fa-tag"></i>
+          Username
+        </label>
+        <input type="text" id="node-input-apiUsername">
+        <input type="hidden" id="node-input-apiUsernameType">
+      </div>
+
+      <div class="form-row">
+        <label for="node-input-apiPassword">
+          <i class="fa fa-tag"></i>
+          Password
+        </label>
+        <input type="text" id="node-input-apiPassword">
+        <input type="hidden" id="node-input-apiPasswordType">
+      </div>
+    </div>
+</script>
+
+<script type="text/html" data-help-name="SendFlow">
+  <p>Send flow to another Node-RED instance.</p>
+</script>

package/nodes/50-send-flow.js

@@ -0,0 +1,112 @@
+module.exports = function(RED) {
+  function SendFlowFunctionality(config) {
+    RED.nodes.createNode(this,config);
+
+    var node = this;
+    var cfg = config;
+
+    node.on('close', function() {
+      node.status({});
+    });
+
+    node.on("input", function(msg, send, done) {
+      var sendFlow = (hdrs, got) => {
+        got.post( cfg.hostUrl + "/flows", {
+          headers: {
+            "Node-RED-API-Version":     cfg.flowVersion,
+            "Content-type":	            "application/json",
+            "Node-RED-Deployment-Type": "full",
+            ...hdrs
+          },
+          body: JSON.stringify(msg.payload)
+        }).then( res => {
+          var bodySize = res.body.length;
+
+          send({
+            ...msg,
+            payload: res.body
+          });
+
+          node.status({fill:"green",shape:"dot",text:"Good"});
+          setTimeout( function() {
+            node.status({})
+          }, 450);
+
+        }).catch( err => {
+          node.status({fill:"red",shape:"dot",text:"Failed"});
+          node.error(err)
+        });
+      };
+
+      /**
+      * Authentication
+      **/
+      if ( cfg.useAuthentication ) {
+        var username = undefined;
+        var password = undefined;
+
+        node.status({fill:"blue",shape:"dot",text:"Requesting token"});
+
+        RED.util.evaluateNodeProperty(cfg.apiUsername, cfg.apiUsernameType,
+                                      node, msg, (err, result) => {
+          if (err) {
+            node.status({fill:"red",shape:"dot",text:"Failed"});
+            node.error(err)
+          } else {
+            username = result;
+
+            RED.util.evaluateNodeProperty(cfg.apiPassword, cfg.apiPasswordType,
+                                          node, msg, (err, result) => {
+              if (err) {
+                node.status({fill:"red",shape:"dot",text:"Failed"});
+                node.error(err)
+              } else {
+                password = result;
+
+                var data = {
+                      "client_id":  "node-red-admin",
+                      "grant_type": "password",
+                      "scope":      "*",
+                      "username":   username,
+                      "password":   password
+                }
+
+                import('got').then( (module) => {
+                  module.got.post( cfg.hostUrl + "/auth/token", {
+                    json: data
+                  }).then( res => {
+                    node.status({
+                      fill:"blue",
+                      shape:"dot",
+                      text:"Sending flow"
+                    });
+
+                    var access_token = JSON.parse(res.body).access_token;
+
+                    sendFlow({
+                      "Authorization": "Bearer " + access_token
+                    }, module.got);
+
+                  }).catch((err) => {
+                    node.status({fill:"red",shape:"dot",text:"Failed"});
+                    node.error( err );
+                  });
+                });
+              }
+            })
+          }
+        })
+      } else {
+        /*
+         * Authentication free zone...
+         */
+        node.status({fill:"blue",shape:"dot",text:"Sending flow"});
+        import('got').then( (module) => {
+          sendFlow({}, module.got);
+        });
+      }
+    });
+  }
+
+  RED.nodes.registerType("SendFlow", SendFlowFunctionality);
+}

package/nodes/55-trigger-import.html

@@ -0,0 +1,48 @@
+<script type="text/javascript">
+  RED.comms.subscribe('introspect:trigger-import-tripped', (event,data) => {
+    if ( data.msg == "import-flow" ) {
+      RED.clipboard.import();
+
+      setTimeout( () => {
+        var content = data.flowContent;
+
+        $('#red-ui-clipboard-dialog-import-text').val(
+          JSON.stringify(content)
+        ).trigger("paste");
+      }, 300);
+    }
+  });
+
+  RED.nodes.registerType('TriggerImport',{
+    color: '#e5e4ef',
+    icon: "icons/subflow.svg",
+    category: 'introspection',
+    paletteLabel: "TriggerImport",
+    defaults: {
+      name: {
+        value:"",
+      },
+    },
+    inputs:1,
+    outputs:1,
+
+    label: function() {
+      return (this.name || this._def.paletteLabel);
+    },
+
+    labelStyle: function() {
+      return this.name?"node_label_italic":"";
+    },
+});
+</script>
+
+<script type="text/html" data-template-name="TriggerImport">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="common.label.name">Name</span></label>
+    <input type="text" id="node-input-name" placeholder="Name">
+  </div>
+</script>
+
+<script type="text/html" data-help-name="TriggerImport">
+  <p>Trigger import opens the flow import dialog with data that came from the server.</p>
+</script>

package/nodes/55-trigger-import.js

@@ -0,0 +1,24 @@
+module.exports = function(RED) {
+  function TriggerImportFunctionality(config) {
+    RED.nodes.createNode(this,config);
+
+    var node = this;
+    var cfg = config;
+
+    node.on('close', function() {
+      node.status({});
+    });
+
+    node.on("input", function(msg, send, done) {
+      RED.comms.publish("introspect:trigger-import-tripped",
+                        RED.util.encodeObject({
+                          flowContent: msg.payload,
+                          msg: "import-flow",
+                        })
+      );
+
+      send(msg);
+    });
+  }
+  RED.nodes.registerType("TriggerImport", TriggerImportFunctionality);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gregoriusrippenstein/node-red-contrib-introspection",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "dependencies": {
     "got": "latest"
   },
@@ -16,14 +16,16 @@
   "node-red": {
     "version": ">=2.0.0",
     "nodes": {
-      "seeker":     "nodes/05-seeker.js",
-      "sink":       "nodes/10-sink.js",
-      "screenshot": "nodes/15-screenshot.js",
-      "orphans":    "nodes/20-orphans.js",
-      "ismobile":   "nodes/25-ismobile.js",
-      "navigator":  "nodes/30-navigator.js",
-      "drawsvg":    "nodes/40-drawsvg.js",
-      "getflows":   "nodes/45-get-flows.js"
+      "seeker":          "nodes/05-seeker.js",
+      "sink":            "nodes/10-sink.js",
+      "screenshot":      "nodes/15-screenshot.js",
+      "orphans":         "nodes/20-orphans.js",
+      "ismobile":        "nodes/25-ismobile.js",
+      "navigator":       "nodes/30-navigator.js",
+      "drawsvg":         "nodes/40-drawsvg.js",
+      "getflows":        "nodes/45-get-flows.js",
+      "sendflow":        "nodes/50-send-flow.js",
+      "triggerimport":   "nodes/55-trigger-import.js"
     }
   },
   "description": "Node-RED Editor-only nodes for introspecting flows.",