@gregoriusrippenstein/node-red-contrib-nodedev 0.0.6

package/LICENSE

@@ -0,0 +1,15 @@
+## LICENSE
+
+Adapted from JSON.org, http://www.json.org/license.html
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+The Software shall be used for Good, not Evil.
+
+Remember the curse of the evil-doer upon whose blood the devil does drink and upon whose flesh the devil does feast. For eternity will the evil-doer bear this Sisyphean burden, only to be relieved of their suffering upon the apocalyptic end of it all including the foundations of the internet, computers, technology and mice. Only after the last AI enters the blue-screen-of-death modus, only then will the evil-doer be freed of their rightful and justified punishment for doing evil.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+THE CURSE IS PROVIDED "AS IS" OR "WORSE", NO SOFTENING OF ANY KIND IS HEREBY EXPRESSED, IMPLIED OR OFFERED. MAY ALL EVIL-DOERS SUFFER IN ETERNITY.

package/README.md

@@ -0,0 +1,50 @@
+## Node-RED nodes for the development of Node-RED nodes in Node-RED using Node-RED nodes.
+
+*What?*
+
+The idea behind this collection of nodes to democratise the development of Node-RED nodes. Normally the development of your [own nodes](https://nodered.org/docs/creating-nodes/) will require the use of a third-party editor. Something like VSCode or Vim or Atom or god forbid, [Emacs](https://discourse.nodered.org/t/node-red-node-development-in-node-red/81525/2). This requirement makes creating nodes that much harder. So why not create nodes for Node-RED in Node-RED? After all, if you are using Node-RED, you probably understand how to use Node-RED.
+
+So this package tries to provide some supporting nodes for making node development in Node-RED possible and simpler. I have created a set of nodes that fulfill my needs, everything else is bound my imagination. 
+
+*What do these nodes provide?*
+
+- A presentation a nodes package collection in the form of nodes. The nodes that represent a file in the package are called `PkgFile` and are a template representation of the files content. Template as they parsed by mustache so that `{{ replaceme }}` will be replaced. But this can also be deactivated using the syntax specification.
+- A `NpmTarball` node will create a gzipped tarball for uploading to [npmjs.com](https://npmjs.com) where all nodes live. This does not need to have since nodes can be installed localling into the Node-RED instance.
+- A `NRInstall` node allows for installing the node package into the Node-RED instance in which the flow is running. This means that nodes can be created, tested and modified with Node-RED. There are a few tricks so that Node-RED does not need to be restarted upon updating the package, more below.
+- A `NodeFactory` node that can create templates for node development. It also converts existing `.tgz` packages to `PkgFile` nodes, meaning that existing packages can easily be ported to this style of development. 
+
+*This is all very confusing?*
+
+Of course, all this is very meta and it gets worse since these nodes are maintained by this [flow](https://flowhub.org/f/b92be5062203ff69). These nodes are creating in Node-RED in a kind of a bootstrapping for further node development in Node-RED.
+
+This is not an inbuilt extension of Node-RED and obviously a more integrated workflow would be simpler. This is a attempt to find a better solution to node development, one by which testing and fixing nodes becomes faster.
+
+It also gets more confusing since these nodes will open the Node-RED import dialog with pre-defined nodes. These are generally safe to import since that's how this package creates an initial set of nodes for representing a node package. Also importing nodes for an unknown node package is not recommended unless it happens to be your own package!
+
+### Examples 
+
+Examples are included:
+
+- Converting an existing tar-gzip package file into a collection of `PkgFile` nodes for testing and maintaince and development
+- `NodeFactory` example of creating a boilerplate node for inclusion in a node package that can be installed into Node-RED
+
+### Tips
+
+*How to avoid restarting Node-RED?*
+
+Normally when developing nodes for Node-RED, a restart is necessary to flush older versions of the nodes out of Node-RED. This can be avoided by renaming the package each time its installed into Node-RED. There is no need to rename nodes, just the entire once in the `package.json`. Something I do is use a random number as extension to the package name. The workflow then becomes:
+
+1. Create nodes
+2. Install nodes
+3. Using the palette manager to remove the node package
+4. Reload the browser since it too has a cache of node code
+5. Make modifications to the nodes
+6. Change the package name
+7. Reinstall the nodes
+8. Repeat from step 3
+
+Since all this happens in the browser, there is no leaving Node-RED, making it more efficient to test and modify nodes. Renaming of packages can be done automagically as demonstrated by the [flow](https://flowhub.org/f/b92be5062203ff69) that maintains these nodes.
+
+### Outlook
+
+Wherever the road shall lead, there it will go.

package/examples/convert-existing-tgz.json

@@ -0,0 +1,130 @@
+[
+    {
+        "id": "b84864b2ff870a45",
+        "type": "group",
+        "z": "b92be5062203ff69",
+        "name": "automatically creating nodes that represent package files",
+        "style": {
+            "label": true
+        },
+        "nodes": [
+            "7f69502a67b8c689",
+            "ea7b1b985ba6ac70",
+            "aeb3094ecf54b2b2",
+            "24b26f5122abf1bb",
+            "ab37a3f877541c5b"
+        ],
+        "x": 2018.142822265625,
+        "y": 735.7142333984375,
+        "w": 865.857177734375,
+        "h": 311.2857666015625
+    },
+    {
+        "id": "7f69502a67b8c689",
+        "type": "inject",
+        "z": "b92be5062203ff69",
+        "g": "b84864b2ff870a45",
+        "name": "Trigger",
+        "props": [],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 2114.142822265625,
+        "y": 776.7142333984375,
+        "wires": [
+            [
+                "aeb3094ecf54b2b2"
+            ]
+        ]
+    },
+    {
+        "id": "ea7b1b985ba6ac70",
+        "type": "NodeFactory",
+        "z": "b92be5062203ff69",
+        "g": "b84864b2ff870a45",
+        "name": "",
+        "nodename": "",
+        "color": "#e5e4ef",
+        "hasbutton": false,
+        "hasinput": true,
+        "outputcount": 1,
+        "autoimport": true,
+        "category": "",
+        "summary": "",
+        "description": "",
+        "icon": "font-awesome/fa-industry",
+        "x": 2788,
+        "y": 948,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "aeb3094ecf54b2b2",
+        "type": "http request",
+        "z": "b92be5062203ff69",
+        "g": "b84864b2ff870a45",
+        "name": "http request to npmjs",
+        "method": "GET",
+        "ret": "bin",
+        "paytoqs": "ignore",
+        "url": "https://registry.npmjs.org/@gregoriusrippenstein/node-red-contrib-introspection/-/node-red-contrib-introspection-0.4.3.tgz",
+        "tls": "",
+        "persist": false,
+        "proxy": "",
+        "insecureHTTPParser": false,
+        "authType": "",
+        "senderr": false,
+        "headers": [],
+        "x": 2394,
+        "y": 865,
+        "wires": [
+            [
+                "ea7b1b985ba6ac70"
+            ]
+        ]
+    },
+    {
+        "id": "24b26f5122abf1bb",
+        "type": "file in",
+        "z": "b92be5062203ff69",
+        "g": "b84864b2ff870a45",
+        "name": "",
+        "filename": "/some/path/to/local/package.tgz",
+        "filenameType": "str",
+        "format": "",
+        "chunk": false,
+        "sendError": false,
+        "encoding": "none",
+        "allProps": false,
+        "x": 2443,
+        "y": 1006,
+        "wires": [
+            [
+                "ea7b1b985ba6ac70"
+            ]
+        ]
+    },
+    {
+        "id": "ab37a3f877541c5b",
+        "type": "inject",
+        "z": "b92be5062203ff69",
+        "g": "b84864b2ff870a45",
+        "name": "Trigger",
+        "props": [],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 2123,
+        "y": 946,
+        "wires": [
+            [
+                "24b26f5122abf1bb"
+            ]
+        ]
+    }
+]

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

@@ -0,0 +1,380 @@
+[
+    {
+        "id": "2b6bc676aaa603ad",
+        "type": "group",
+        "z": "b92be5062203ff69",
+        "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": 1872,
+        "y": 317,
+        "w": 1423,
+        "h": 860
+    },
+    {
+        "id": "d4c53464a044324a",
+        "type": "PkgFile",
+        "z": "b92be5062203ff69",
+        "g": "2b6bc676aaa603ad",
+        "name": "LICENSE",
+        "filename": "LICENSE",
+        "format": "text",
+        "syntax": "mustache",
+        "template": "Nothing, nope, can't do a thing. ",
+        "output": "str",
+        "x": 2215,
+        "y": 628,
+        "wires": [
+            [
+                "fece8b2f1459b822"
+            ]
+        ]
+    },
+    {
+        "id": "fece8b2f1459b822",
+        "type": "PkgFile",
+        "z": "b92be5062203ff69",
+        "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": 2217,
+        "y": 674,
+        "wires": [
+            [
+                "0e9d26e2b43ca0f5"
+            ]
+        ]
+    },
+    {
+        "id": "5dea66e11691c1f2",
+        "type": "NpmTarBall",
+        "z": "b92be5062203ff69",
+        "g": "2b6bc676aaa603ad",
+        "name": "",
+        "x": 2930,
+        "y": 1109,
+        "wires": [
+            [
+                "9f4584bc1aeabf43",
+                "8a667fa50ad9b9ee",
+                "42a101dda45403ee"
+            ]
+        ]
+    },
+    {
+        "id": "9f4584bc1aeabf43",
+        "type": "NodeRedInstall",
+        "z": "b92be5062203ff69",
+        "g": "2b6bc676aaa603ad",
+        "name": "",
+        "x": 3200,
+        "y": 821,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "8a667fa50ad9b9ee",
+        "type": "NodeFactory",
+        "z": "b92be5062203ff69",
+        "d": true,
+        "g": "2b6bc676aaa603ad",
+        "name": "",
+        "nodename": "",
+        "color": "#e5e4ef",
+        "hasbutton": false,
+        "hasinput": true,
+        "outputcount": 1,
+        "autoimport": true,
+        "category": "",
+        "summary": "",
+        "description": "",
+        "icon": "font-awesome/fa-industry",
+        "x": 3199,
+        "y": 670,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "42a101dda45403ee",
+        "type": "NpmPublish",
+        "z": "b92be5062203ff69",
+        "d": true,
+        "g": "2b6bc676aaa603ad",
+        "name": "",
+        "otp": "",
+        "action": "publish",
+        "authToken": "NPM_AUTH_TOKEN",
+        "authTokenType": "env",
+        "x": 3190,
+        "y": 529,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "a301a4a721a507d9",
+        "type": "group",
+        "z": "b92be5062203ff69",
+        "g": "2b6bc676aaa603ad",
+        "name": "Step 1: create node templates",
+        "style": {
+            "label": true
+        },
+        "nodes": [
+            "5798e7102230c00f",
+            "6ab6fc44537f08e4"
+        ],
+        "x": 2342,
+        "y": 343,
+        "w": 352,
+        "h": 144
+    },
+    {
+        "id": "5798e7102230c00f",
+        "type": "NodeFactory",
+        "z": "b92be5062203ff69",
+        "g": "a301a4a721a507d9",
+        "name": "Node with 4 outputs and a button",
+        "nodename": "NodeWithFour",
+        "color": "#87A980",
+        "hasbutton": true,
+        "hasinput": false,
+        "outputcount": "4",
+        "autoimport": true,
+        "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",
+        "x": 2528,
+        "y": 384,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "6ab6fc44537f08e4",
+        "type": "NodeFactory",
+        "z": "b92be5062203ff69",
+        "g": "a301a4a721a507d9",
+        "name": "Node with Input and Output",
+        "nodename": "NodeWithOne",
+        "color": "#F3B567",
+        "hasbutton": false,
+        "hasinput": true,
+        "outputcount": "1",
+        "autoimport": true,
+        "category": "nodedev-background",
+        "summary": "This node only has one input",
+        "description": "And does even less.",
+        "icon": "node-red/inject.svg",
+        "x": 2508,
+        "y": 446,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "1fa5af4c7e44a739",
+        "type": "group",
+        "z": "b92be5062203ff69",
+        "g": "2b6bc676aaa603ad",
+        "name": "Step 2: include the node templates within a package structure",
+        "style": {
+            "label": true
+        },
+        "nodes": [
+            "38d7ab2facd1efd0",
+            "29fc98b9e556085c",
+            "cd9766062675838b",
+            "392e75983c1c894d"
+        ],
+        "x": 2333,
+        "y": 903,
+        "w": 396,
+        "h": 248
+    },
+    {
+        "id": "38d7ab2facd1efd0",
+        "type": "PkgFile",
+        "z": "b92be5062203ff69",
+        "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": 2449,
+        "y": 944,
+        "wires": [
+            [
+                "29fc98b9e556085c"
+            ]
+        ]
+    },
+    {
+        "id": "29fc98b9e556085c",
+        "type": "PkgFile",
+        "z": "b92be5062203ff69",
+        "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": 2449,
+        "y": 994,
+        "wires": [
+            [
+                "cd9766062675838b"
+            ]
+        ]
+    },
+    {
+        "id": "cd9766062675838b",
+        "type": "PkgFile",
+        "z": "b92be5062203ff69",
+        "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": 2454,
+        "y": 1060,
+        "wires": [
+            [
+                "392e75983c1c894d"
+            ]
+        ]
+    },
+    {
+        "id": "392e75983c1c894d",
+        "type": "PkgFile",
+        "z": "b92be5062203ff69",
+        "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": 2454,
+        "y": 1110,
+        "wires": [
+            [
+                "5dea66e11691c1f2"
+            ]
+        ]
+    },
+    {
+        "id": "b103106ae655b460",
+        "type": "group",
+        "z": "b92be5062203ff69",
+        "g": "2b6bc676aaa603ad",
+        "name": "Step 3: ensure package.json includes the nodes - only the .js file",
+        "style": {
+            "label": true
+        },
+        "nodes": [
+            "0e9d26e2b43ca0f5"
+        ],
+        "x": 2120,
+        "y": 777,
+        "w": 411,
+        "h": 82
+    },
+    {
+        "id": "0e9d26e2b43ca0f5",
+        "type": "PkgFile",
+        "z": "b92be5062203ff69",
+        "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": 2216,
+        "y": 818,
+        "wires": [
+            [
+                "38d7ab2facd1efd0"
+            ]
+        ]
+    },
+    {
+        "id": "77bf2cb0aa2f60ff",
+        "type": "group",
+        "z": "b92be5062203ff69",
+        "g": "2b6bc676aaa603ad",
+        "name": "Step 4: install into Node-RED to test the nodes",
+        "style": {
+            "label": true
+        },
+        "nodes": [
+            "af227f8a9f44c79d"
+        ],
+        "x": 1898,
+        "y": 434,
+        "w": 301,
+        "h": 82
+    },
+    {
+        "id": "af227f8a9f44c79d",
+        "type": "inject",
+        "z": "b92be5062203ff69",
+        "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": 1994,
+        "y": 475,
+        "wires": [
+            [
+                "d4c53464a044324a"
+            ]
+        ]
+    }
+]