@gregoriusrippenstein/node-red-contrib-nodedev 0.1.1 → 0.1.3

package/examples/factory-generate-happy-node.json

@@ -0,0 +1,386 @@
+[
+    {
+        "id": "2b6bc676aaa603ad",
+        "type": "group",
+        "z": "7bece6814c033925",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "d4c53464a044324a",
+            "fece8b2f1459b822",
+            "5dea66e11691c1f2",
+            "9f4584bc1aeabf43",
+            "8a667fa50ad9b9ee",
+            "42a101dda45403ee",
+            "a301a4a721a507d9",
+            "1fa5af4c7e44a739",
+            "b103106ae655b460",
+            "77bf2cb0aa2f60ff"
+        ],
+        "x": 396,
+        "y": 187,
+        "w": 1423,
+        "h": 860
+    },
+    {
+        "id": "d4c53464a044324a",
+        "type": "PkgFile",
+        "z": "7bece6814c033925",
+        "g": "2b6bc676aaa603ad",
+        "name": "LICENSE",
+        "filename": "LICENSE",
+        "format": "text",
+        "syntax": "mustache",
+        "template": "Nothing, nope, can't do a thing. ",
+        "output": "str",
+        "x": 739,
+        "y": 498,
+        "wires": [
+            [
+                "fece8b2f1459b822"
+            ]
+        ]
+    },
+    {
+        "id": "fece8b2f1459b822",
+        "type": "PkgFile",
+        "z": "7bece6814c033925",
+        "g": "2b6bc676aaa603ad",
+        "name": "README",
+        "filename": "README.md",
+        "format": "markdown",
+        "syntax": "mustache",
+        "template": "## What does this package do?\n\n## Why does it exist?\n\n## Where will it go?\n\n",
+        "output": "str",
+        "x": 741,
+        "y": 544,
+        "wires": [
+            [
+                "0e9d26e2b43ca0f5"
+            ]
+        ]
+    },
+    {
+        "id": "5dea66e11691c1f2",
+        "type": "NpmTarBall",
+        "z": "7bece6814c033925",
+        "g": "2b6bc676aaa603ad",
+        "name": "",
+        "x": 1454,
+        "y": 979,
+        "wires": [
+            [
+                "9f4584bc1aeabf43",
+                "8a667fa50ad9b9ee",
+                "42a101dda45403ee"
+            ]
+        ]
+    },
+    {
+        "id": "9f4584bc1aeabf43",
+        "type": "NodeRedInstall",
+        "z": "7bece6814c033925",
+        "g": "2b6bc676aaa603ad",
+        "name": "",
+        "x": 1724,
+        "y": 691,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "8a667fa50ad9b9ee",
+        "type": "NodeFactory",
+        "z": "7bece6814c033925",
+        "d": true,
+        "g": "2b6bc676aaa603ad",
+        "name": "",
+        "nodename": "",
+        "color": "#e5e4ef",
+        "hasbutton": false,
+        "hasinput": true,
+        "outputcount": 1,
+        "category": "",
+        "summary": "",
+        "description": "",
+        "icon": "font-awesome/fa-industry",
+        "frt2bakcomm": false,
+        "bak2frtcomm": false,
+        "createmanifest": false,
+        "x": 1723,
+        "y": 540,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "42a101dda45403ee",
+        "type": "NpmPublish",
+        "z": "7bece6814c033925",
+        "d": true,
+        "g": "2b6bc676aaa603ad",
+        "name": "",
+        "otp": "",
+        "action": "publish",
+        "authToken": "NPM_AUTH_TOKEN",
+        "authTokenType": "env",
+        "x": 1714,
+        "y": 399,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "a301a4a721a507d9",
+        "type": "group",
+        "z": "7bece6814c033925",
+        "g": "2b6bc676aaa603ad",
+        "name": "Step 1: create node templates",
+        "style": {
+            "label": true
+        },
+        "nodes": [
+            "5798e7102230c00f",
+            "6ab6fc44537f08e4"
+        ],
+        "x": 886,
+        "y": 213,
+        "w": 332,
+        "h": 144
+    },
+    {
+        "id": "5798e7102230c00f",
+        "type": "NodeFactory",
+        "z": "7bece6814c033925",
+        "g": "a301a4a721a507d9",
+        "name": "Node with 4 outputs and a button",
+        "nodename": "NodeWithFour",
+        "color": "#87A980",
+        "hasbutton": true,
+        "hasinput": false,
+        "outputcount": "4",
+        "category": "nodedev-background",
+        "summary": "This is the short summary of what this node does.",
+        "description": "This is a long and descriptive version of the summary. Rather boring and tedious to write but nonetheless, we try our best.",
+        "icon": "node-red/inject.svg",
+        "frt2bakcomm": false,
+        "bak2frtcomm": false,
+        "createmanifest": false,
+        "x": 1052,
+        "y": 254,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "6ab6fc44537f08e4",
+        "type": "NodeFactory",
+        "z": "7bece6814c033925",
+        "g": "a301a4a721a507d9",
+        "name": "Node with Input and Output",
+        "nodename": "NodeWithOne",
+        "color": "#F3B567",
+        "hasbutton": false,
+        "hasinput": true,
+        "outputcount": "1",
+        "category": "nodedev-background",
+        "summary": "This node only has one input",
+        "description": "And does even less.",
+        "icon": "node-red/inject.svg",
+        "frt2bakcomm": false,
+        "bak2frtcomm": false,
+        "createmanifest": false,
+        "x": 1032,
+        "y": 316,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "1fa5af4c7e44a739",
+        "type": "group",
+        "z": "7bece6814c033925",
+        "g": "2b6bc676aaa603ad",
+        "name": "Step 2: include the node templates within a package structure",
+        "style": {
+            "label": true
+        },
+        "nodes": [
+            "38d7ab2facd1efd0",
+            "29fc98b9e556085c",
+            "cd9766062675838b",
+            "392e75983c1c894d"
+        ],
+        "x": 857,
+        "y": 773,
+        "w": 396,
+        "h": 248
+    },
+    {
+        "id": "38d7ab2facd1efd0",
+        "type": "PkgFile",
+        "z": "7bece6814c033925",
+        "g": "1fa5af4c7e44a739",
+        "name": "NodeWithFour.js",
+        "filename": "nodes/nodewithfour.js",
+        "format": "javascript",
+        "syntax": "mustache",
+        "template": "module.exports = function(RED) {\n  function NodeWithFourFunctionality(config) {\n    RED.nodes.createNode(this,config);\n\n    var node = this;\n    var cfg = config;\n\n    node.on('close', function() {\n      node.status({});\n    });\n\n    node.on(\"input\", function(msg, send, done) {\n        send(msg);\n        done();\n    });\n  }\n  RED.nodes.registerType(\"NodeWithFour\", NodeWithFourFunctionality);\n}\n",
+        "output": "str",
+        "x": 973,
+        "y": 814,
+        "wires": [
+            [
+                "29fc98b9e556085c"
+            ]
+        ]
+    },
+    {
+        "id": "29fc98b9e556085c",
+        "type": "PkgFile",
+        "z": "7bece6814c033925",
+        "g": "1fa5af4c7e44a739",
+        "name": "NodeWithFour.html",
+        "filename": "nodes/nodewithfour.html",
+        "format": "html",
+        "syntax": "mustache",
+        "template": "<script type=\"text/javascript\">\n  RED.nodes.registerType('NodeWithFour',{\n    color: '#87A980',\n    icon: \"node-red/inject.svg\",\n    category: 'nodedev-background',\n    defaults: {\n      name: {\n        value:\"\",\n      },\n    },\n\n    inputs: 0,\n\n    outputs: 4,\n\n    label: function() {\n      return (this.name || this._def.paletteLabel);\n    },\n\n    labelStyle: function() {\n      return this.name?\"node_label_italic\":\"\";\n    },\n\n    onpaletteadd: function() {\n    },\n\n    oneditprepare: function() {\n    },\n\n    oneditcancel: function() {\n    },\n\n    oneditsave: function() {\n    },\n\n    button: {\n      enabled: function() {\n        return !this.changed\n      },\n\n      onclick: function () {\n        if (this.changed) {\n          return RED.notify(RED._(\"notification.warning\", {\n            message: RED._(\"notification.warnings.undeployedChanges\")\n          }), \"warning\");\n        }\n      }\n    },\n\n  });\n</script>\n\n<script type=\"text/html\" data-template-name=\"NodeWithFour\">\n    <div class=\"form-row\">\n        <label for=\"node-input-name\"><i class=\"fa fa-tag\"></i> Name</label>\n        <input type=\"text\" id=\"node-input-name\" placeholder=\"Name\">\n    </div>\n</script>\n\n<script type=\"text/html\" data-help-name=\"NodeWithFour\">\n  <p>This is the short summary of what this node does.</p>\n  This is a long and descriptive version of the summary. Rather boring and tedious to write but nonetheless, we try our best.\n</script>\n",
+        "output": "str",
+        "x": 973,
+        "y": 864,
+        "wires": [
+            [
+                "cd9766062675838b"
+            ]
+        ]
+    },
+    {
+        "id": "cd9766062675838b",
+        "type": "PkgFile",
+        "z": "7bece6814c033925",
+        "g": "1fa5af4c7e44a739",
+        "name": "NodeWithOne.js",
+        "filename": "nodes/nodewithone.js",
+        "format": "javascript",
+        "syntax": "mustache",
+        "template": "module.exports = function(RED) {\n  function NodeWithOneFunctionality(config) {\n    RED.nodes.createNode(this,config);\n\n    var node = this;\n    var cfg = config;\n\n    node.on('close', function() {\n      node.status({});\n    });\n\n    node.on(\"input\", function(msg, send, done) {\n        send(msg);\n        done();\n    });\n  }\n  RED.nodes.registerType(\"NodeWithOne\", NodeWithOneFunctionality);\n}\n",
+        "output": "str",
+        "x": 978,
+        "y": 930,
+        "wires": [
+            [
+                "392e75983c1c894d"
+            ]
+        ]
+    },
+    {
+        "id": "392e75983c1c894d",
+        "type": "PkgFile",
+        "z": "7bece6814c033925",
+        "g": "1fa5af4c7e44a739",
+        "name": "NodeWithOne.html",
+        "filename": "nodes/nodewithone.html",
+        "format": "html",
+        "syntax": "mustache",
+        "template": "<script type=\"text/javascript\">\n  RED.nodes.registerType('NodeWithOne',{\n    color: '#F3B567',\n    icon: \"node-red/inject.svg\",\n    category: 'nodedev-background',\n    defaults: {\n      name: {\n        value:\"\",\n      },\n    },\n\n    inputs: 1,\n\n    outputs: 1,\n\n    label: function() {\n      return (this.name || this._def.paletteLabel);\n    },\n\n    labelStyle: function() {\n      return this.name?\"node_label_italic\":\"\";\n    },\n\n    onpaletteadd: function() {\n    },\n\n    oneditprepare: function() {\n    },\n\n    oneditcancel: function() {\n    },\n\n    oneditsave: function() {\n    },\n\n\n  });\n</script>\n\n<script type=\"text/html\" data-template-name=\"NodeWithOne\">\n    <div class=\"form-row\">\n        <label for=\"node-input-name\"><i class=\"fa fa-tag\"></i> Name</label>\n        <input type=\"text\" id=\"node-input-name\" placeholder=\"Name\">\n    </div>\n</script>\n\n<script type=\"text/html\" data-help-name=\"NodeWithOne\">\n  <p>This node only has one input</p>\n  And does even less.\n</script>\n",
+        "output": "str",
+        "x": 978,
+        "y": 980,
+        "wires": [
+            [
+                "5dea66e11691c1f2"
+            ]
+        ]
+    },
+    {
+        "id": "b103106ae655b460",
+        "type": "group",
+        "z": "7bece6814c033925",
+        "g": "2b6bc676aaa603ad",
+        "name": "Step 3: ensure package.json includes the nodes - only the .js file",
+        "style": {
+            "label": true
+        },
+        "nodes": [
+            "0e9d26e2b43ca0f5"
+        ],
+        "x": 644,
+        "y": 647,
+        "w": 411,
+        "h": 82
+    },
+    {
+        "id": "0e9d26e2b43ca0f5",
+        "type": "PkgFile",
+        "z": "7bece6814c033925",
+        "g": "b103106ae655b460",
+        "name": "package.json",
+        "filename": "package.json",
+        "format": "json",
+        "syntax": "mustache",
+        "template": "{\n  \"name\" : \"\",\n  \"version\": \"\",\n  \"dependencies\": {\n  },\n\n  \"keywords\": [\n    \"node-red\"\n  ],\n\n  \"homepage\": \"https://github.com/username/node-red-contrib-test\",\n  \"license\": \"Don't do evil.\",\n  \"author\": \"Joe Blog <joe.blog@spreads-the.love>\",\n  \"engines\": {\n    \"node\": \">=16\"\n  },\n\n  \"node-red\" : {\n    \"version\": \">=3.0.0\",\n    \"nodes\": {\n      \"nodewithfour\": \"nodes/nodewithfour.js\",\n      \"nodewithone\":  \"nodes/nodewithone.js\"\n    }\n  },\n\n  \"description\": \"Description of what these nodes do.\",\n  \"repository\": {\n    \"type\": \"github\",\n    \"url\": \"git+https://github.com/username/node-red-contrib-test.git\"\n  },\n  \"bugs\": {\n    \"url\": \"https://github.com/username/node-red-contrib-test\"\n  }\n}\n",
+        "output": "str",
+        "x": 740,
+        "y": 688,
+        "wires": [
+            [
+                "38d7ab2facd1efd0"
+            ]
+        ]
+    },
+    {
+        "id": "77bf2cb0aa2f60ff",
+        "type": "group",
+        "z": "7bece6814c033925",
+        "g": "2b6bc676aaa603ad",
+        "name": "Step 4: install into Node-RED to test the nodes",
+        "style": {
+            "label": true
+        },
+        "nodes": [
+            "af227f8a9f44c79d"
+        ],
+        "x": 422,
+        "y": 304,
+        "w": 301,
+        "h": 82
+    },
+    {
+        "id": "af227f8a9f44c79d",
+        "type": "inject",
+        "z": "7bece6814c033925",
+        "g": "77bf2cb0aa2f60ff",
+        "name": "",
+        "props": [
+            {
+                "p": "packagename",
+                "v": "@username/node-red-contrib-test",
+                "vt": "str"
+            },
+            {
+                "p": "packageversion",
+                "v": "0.0.1",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 518,
+        "y": 345,
+        "wires": [
+            [
+                "d4c53464a044324a"
+            ]
+        ]
+    }
+]

package/nodes/05-node-dev-ops.html

@@ -47,20 +47,23 @@
     defaults: {
       name: { value:"" },
 
-      pname: { value: "", required: true },
-      pversion: { value: "", required: true },
+      pname:        { value: "", required: true },
+      pversion:     { value: "", required: true },
+      pauthorname:  { value: "", required: true },
+      pauthoremail: { value: "", required: true },
+      pdescription: { value: "", required: true },
 
       noderedinstall: { value: false },
       randompackagename: { value: false },
 
-      gitcommit: { value: false },
+      gitcommit:         { value: false },
       gitcheckforchange: { value: false },
-      githubowner: { value: ""},
-      githubrepo: { value: ""},
-      githubbranch: { value: "main"},
-      githubauthor: { value: ""},
+      githubowner:       { value: ""},
+      githubrepo:        { value: ""},
+      githubbranch:      { value: "main"},
+      githubauthor:      { value: ""},
       githubauthoremail: { value: "" },
-      githubmessage: { value: "" },
+      githubmessage:     { value: "" },
 
       npmpublish: { value: false },
       npmunpublish: { value: false },
@@ -196,6 +199,21 @@
     <input type="text" id="node-input-pversion" placeholder="0.0.1"/>
   </div>
   
+  <div class="form-row">
+    <label for="node-input-pauthorname" style="min-width: 250px;"><i class="fa fa-address-book-o"></i> Package Author Name</label>
+    <input type="text" id="node-input-pauthorname" placeholder="Alfred E. Neumann"/>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-pauthoremail" style="min-width: 250px;"><i class="fa fa-envelope-o"></i> Package Author Email</label>
+    <input type="text" id="node-input-pauthoremail" placeholder="joe.blog@example.com"/>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-pdescription" style="min-width: 150px;"><i class="fa fa-book"></i> Package Description</label>
+    <input type="text" id="node-input-pdescription" placeholder="Package description"/>
+  </div>
+
   <hr/>
 
   <div class="form-row">
@@ -248,15 +266,15 @@
 
   <div id="github-options">
     <div class="form-row">
-      <label for="node-input-githubowner" style="min-width: 150px;"><i class="fa fa-tag"></i> GitHub Username</label>
+      <label for="node-input-githubowner" style="min-width: 150px;"><i class="fa fa-user-o"></i> GitHub Username</label>
       <input type="text" id="node-input-githubowner" placeholder="username"/>
     </div>
     <div class="form-row">
-       <label for="node-input-githubrepo" style="min-width: 150px;"><i class="fa fa-tag"></i> Repository</label>
+       <label for="node-input-githubrepo" style="min-width: 150px;"><i class="fa fa-paw"></i> Repository</label>
        <input type="text" id="node-input-githubrepo" placeholder=""/>
     </div>
     <div class="form-row">
-       <label for="node-input-githubbranch" style="min-width: 150px;"><i class="fa fa-tag"></i> Branch</label>
+       <label for="node-input-githubbranch" style="min-width: 150px;"><i class="fa fa-tree"></i> Branch</label>
        <input type="text" id="node-input-githubbranch" placeholder="main"/>
     </div>
   </div>
@@ -267,11 +285,11 @@
       <input type="text" id="node-input-githubmessage" placeholder="Initial Commit"/>
     </div>
     <div class="form-row">
-      <label for="node-input-githubauthor" style="min-width: 150px;"><i class="fa fa-tag"></i> Author Name</label>
+      <label for="node-input-githubauthor" style="min-width: 150px;"><i class="fa fa-address-book-o"></i> Author Name</label>
       <input type="text" id="node-input-githubauthor" placeholder="Joe Blog"/>
     </div>
     <div class="form-row">
-      <label for="node-input-githubauthoremail" style="min-width: 150px;"><i class="fa fa-tag"></i> Author Email</label>
+      <label for="node-input-githubauthoremail" style="min-width: 150px;"><i class="fa fa-envelope-o"></i> Author Email</label>
       <input type="text" id="node-input-githubauthoremail" placeholder="joe@spreads-the.love"/>
     </div>
   </div>

package/nodes/10-node-factory.html

@@ -47,7 +47,7 @@
     <div class="form-row">
         <label for="node-input-summary">
           <i class="fa fa-tag"></i>
-          <span>Summary</span>
+          <span>Summary (REQUIRED)</span>
         </label>
         <div style="height: 150px; min-height:150px; max-height: 150px;" class="node-text-editor" id="node-input-summary">
         </div>
@@ -56,12 +56,19 @@
     <div class="form-row">
         <label for="node-input-description">
               <i class="fa fa-tag"></i>
-              <span>Description</span>
+              <span>Description (REQUIRED)</span>
             </label>
         <div style="height: 350px; min-height:350px; max-height: 350px;" class="node-text-editor" id="node-input-description">
         </div>
     </div>
 
+    <div class="form-row">
+        <label for="node-input-isplugin" style="min-width: 250px;">
+                    <span>Plugin: Sidebar + Config?</span>
+                </label>
+        <input type="checkbox" id="node-input-isplugin" style="display:inline-block; width:15px; vertical-align:baseline;">
+    </div>
+    
     <div class="form-row">
         <label for="node-input-frt2bakcomm" style="min-width: 250px;">
                 <span>Frontend to Backend communication?</span>
@@ -119,7 +126,9 @@
         
         data["color"]       = $('#node-input-colour').val();
         data["icon"]        = $('#red-ui-editor-node-icon').val();
+        data["iconclass"]   = "fa " + data["icon"].split("/")[1]; /* Assume font-awesomeness */
         data["name"]        = $('#node-input-nodename').val();
+        data["namelwr"]     = data["name"].toLowerCase();
         data["outputcount"] = $('#node-input-outputcount').val();
         data["category"]    = $('#node-input-category').val();
 
@@ -128,7 +137,8 @@
         data["bak2frtcomm"]    = $('#node-input-bak2frtcomm').is(":checked");
         data["frt2bakcomm"]    = $('#node-input-frt2bakcomm').is(":checked");
         data["createmanifest"] = $('#node-input-createmanifest').is(":checked");
-        
+        data["isplugin"]       = $('#node-input-isplugin').is(":checked");
+
         data["__task"]      = "generate_from_templates";
                 
         $.ajax({
@@ -177,19 +187,20 @@
         color: "#e5e4ef",
         category: 'nodedev',
         defaults: {
-            name: { value: "" },
-            nodename: { value: "" },
-            color: { value: "#e5e4ef" },
-            hasbutton: { value: false },
-            hasinput: { value: true },
-            outputcount: { value: 1 },
-            category: { value: "" },
-            summary: { value: ""},
-            description: { value: ""},
-            icon: { value: "font-awesome/fa-industry" },
-            frt2bakcomm: { value: false },
-            bak2frtcomm: { value: false },
-            createmanifest: { value: false }
+            name:           { value: "" },
+            nodename:       { value: "", required: true },
+            color:          { value: "#e5e4ef" },
+            hasbutton:      { value: false },
+            hasinput:       { value: true },
+            outputcount:    { value: 1 },
+            category:       { value: "" },
+            summary:        { value: "", required: true },
+            description:    { value: "", required: true },
+            icon:           { value: "font-awesome/fa-industry" },
+            frt2bakcomm:    { value: false },
+            bak2frtcomm:    { value: false },
+            createmanifest: { value: false },
+            isplugin:       { value: false },
         },
         inputs: 1,
         outputs: 1,