@node-red/nodes 3.0.2 → 3.1.0-beta.1

package/core/network/10-mqtt.js

@@ -295,7 +295,7 @@ module.exports = function(RED) {
                         /* mute error - it simply isnt JSON, just leave payload as a string */
                     }
                 }
-            } //else { 
+            } //else {
                 //leave as buffer
             //}
         }
@@ -357,7 +357,7 @@ module.exports = function(RED) {
                         return;
                     }
                     done(err);
-                }); 
+                });
             } else {
                 done();
             }
@@ -366,6 +366,16 @@ module.exports = function(RED) {
         }
     }
 
+    function updateStatus(node, allNodes) {
+        let setStatus = setStatusDisconnected
+        if(node.connecting) {
+            setStatus = setStatusConnecting
+        } else if(node.connected) {
+            setStatus = setStatusConnected
+        }
+        setStatus(node, allNodes)
+    }
+
     function setStatusDisconnected(node, allNodes) {
         if(allNodes) {
             for (var id in node.users) {
@@ -459,7 +469,6 @@ module.exports = function(RED) {
             if(!opts || typeof opts !== "object") {
                 return; //nothing to change, simply return
             }
-            const originalBrokerURL = node.brokerurl;
 
             //apply property changes (only if the property exists in the opts object)
             setIfHasProperty(opts, node, "url", init);
@@ -468,13 +477,11 @@ module.exports = function(RED) {
             setIfHasProperty(opts, node, "clientid", init);
             setIfHasProperty(opts, node, "autoConnect", init);
             setIfHasProperty(opts, node, "usetls", init);
-            setIfHasProperty(opts, node, "usews", init);
             setIfHasProperty(opts, node, "verifyservercert", init);
             setIfHasProperty(opts, node, "compatmode", init);
             setIfHasProperty(opts, node, "protocolVersion", init);
             setIfHasProperty(opts, node, "keepalive", init);
             setIfHasProperty(opts, node, "cleansession", init);
-            setIfHasProperty(opts, node, "sessionExpiry", init);
             setIfHasProperty(opts, node, "topicAliasMaximum", init);
             setIfHasProperty(opts, node, "maximumPacketSize", init);
             setIfHasProperty(opts, node, "receiveMaximum", init);
@@ -484,6 +491,11 @@ module.exports = function(RED) {
             } else if (hasProperty(opts, "userProps")) {
                 node.userProperties = opts.userProps;
             }
+            if (hasProperty(opts, "sessionExpiry")) {
+                node.sessionExpiryInterval = opts.sessionExpiry;
+            } else if (hasProperty(opts, "sessionExpiryInterval")) {
+                node.sessionExpiryInterval = opts.sessionExpiryInterval
+            }
 
             function createLWT(topic, payload, qos, retain, v5opts, v5SubPropName) {
                 let message = undefined;
@@ -567,9 +579,6 @@ module.exports = function(RED) {
             if (typeof node.usetls === 'undefined') {
                 node.usetls = false;
             }
-            if (typeof node.usews === 'undefined') {
-                node.usews = false;
-            }
             if (typeof node.verifyservercert === 'undefined') {
                 node.verifyservercert = false;
             }
@@ -698,16 +707,21 @@ module.exports = function(RED) {
             if (Object.keys(node.users).length === 1) {
                 if(node.autoConnect) {
                     node.connect();
+                    //update nodes status
+                    setTimeout(function() {
+                        updateStatus(node, true)
+                    }, 1)
                 }
             }
         };
 
-        node.deregister = function(mqttNode,done) {
+        node.deregister = function(mqttNode, done, autoDisconnect) {
             delete node.users[mqttNode.id];
-            if (!node.closing && node.connected && Object.keys(node.users).length === 0) {
-                node.disconnect();
+            if (autoDisconnect && !node.closing && node.connected && Object.keys(node.users).length === 0) {
+                node.disconnect(done);
+            } else {
+                done();
             }
-            done();
         };
         node.canConnect = function() {
             return !node.connected && !node.connecting;
@@ -782,7 +796,9 @@ module.exports = function(RED) {
 
                         // Send any birth message
                         if (node.birthMessage) {
-                            node.publish(node.birthMessage);
+                            setTimeout(() => {
+                                node.publish(node.birthMessage);
+                            }, 1);
                         }
                     });
                     node._clientOn("reconnect", function() {
@@ -839,7 +855,7 @@ module.exports = function(RED) {
             let waitEnd = (client, ms) => {
                 return new Promise( (resolve, reject) => {
                     node.closing = true;
-                    if(!client) { 
+                    if(!client) {
                         resolve();
                      } else {
                         const t = setTimeout(() => {
@@ -991,14 +1007,21 @@ module.exports = function(RED) {
                 }
 
                 if (topicOK) {
-                    node.client.publish(msg.topic, msg.payload, options, function(err) {
-                        done && done(err);
-                        return
-                    });
+                    node.client.publish(msg.topic, msg.payload, options, function (err) {
+                        if (done) {
+                            done(err)
+                        } else if(err) {
+                            node.error(err, msg)
+                        }
+                    })
                 } else {
-                    const error = new Error(RED._("mqtt.errors.invalid-topic"));
-                    error.warn = true;
-                    done(error);
+                    const error = new Error(RED._("mqtt.errors.invalid-topic"))
+                    error.warn = true
+                    if (done) {
+                        done(error)
+                    } else {
+                        node.warn(error, msg)
+                    }
                 }
             }
         };
@@ -1011,7 +1034,7 @@ module.exports = function(RED) {
 
         /**
          * Add event handlers to the MQTT.js client and track them so that
-         * we do not remove any handlers that the MQTT client uses internally.  
+         * we do not remove any handlers that the MQTT client uses internally.
          * Use {@link node._clientRemoveListeners `node._clientRemoveListeners`} to remove handlers
          * @param {string} event The name of the event
          * @param {function} handler The handler for this event
@@ -1019,11 +1042,11 @@ module.exports = function(RED) {
          node._clientOn = function(event, handler) {
             node.clientListeners.push({event, handler})
             node.client.on(event, handler)
-        } 
+        }
 
         /**
-         * Remove event handlers from the MQTT.js client & only the events 
-         * that we attached in {@link node._clientOn `node._clientOn`}.  
+         * Remove event handlers from the MQTT.js client & only the events
+         * that we attached in {@link node._clientOn `node._clientOn`}.
          * * If `event` is omitted, then all events matching `handler` are removed
          * * If `handler` is omitted, then all events named `event` are removed
          * * If both parameters are omitted, then all events are removed
@@ -1212,7 +1235,7 @@ module.exports = function(RED) {
                     } else {
                         node.brokerConn.unsubscribe(node.topic,node.id, removed);
                     }
-                    node.brokerConn.deregister(node, done);
+                    node.brokerConn.deregister(node, done, removed);
                     node.brokerConn = null;
                 } else {
                     done();
@@ -1275,9 +1298,9 @@ module.exports = function(RED) {
                 node.status({fill:"green",shape:"dot",text:"node-red:common.status.connected"});
             }
             node.brokerConn.register(node);
-            node.on('close', function(done) {
+            node.on('close', function(removed, done) {
                 if (node.brokerConn) {
-                    node.brokerConn.deregister(node,done);
+                    node.brokerConn.deregister(node, done, removed)
                     node.brokerConn = null;
                 } else {
                     done();

package/core/network/21-httpin.html

@@ -227,6 +227,7 @@
                         }
                     });
                 },
+                sortable: true,
                 removable: true
             });
 

package/core/network/21-httpin.js

@@ -46,7 +46,7 @@ module.exports = function(RED) {
                     isText = true;
                 } else if (parsedType.type !== "application") {
                     isText = false;
-                } else if ((parsedType.subtype !== "octet-stream") 
+                } else if ((parsedType.subtype !== "octet-stream")
                     && (parsedType.subtype !== "cbor")
                     && (parsedType.subtype !== "x-protobuf")) {
                     checkUTF = true;
@@ -200,6 +200,15 @@ module.exports = function(RED) {
             this.callback = function(req,res) {
                 var msgid = RED.util.generateId();
                 res._msgid = msgid;
+                // Since Node 15, req.headers are lazily computed and the property
+                // marked as non-enumerable.
+                // That means it doesn't show up in the Debug sidebar.
+                // This redefines the property causing it to be evaluated *and*
+                // marked as enumerable again.
+                Object.defineProperty(req, 'headers', {
+                    value: req.headers,
+                    enumerable: true
+                })
                 if (node.method.match(/^(post|delete|put|options|patch)$/)) {
                     node.send({_msgid:msgid,req:req,res:createResponseWrapper(node,res),payload:req.body});
                 } else if (node.method == "get") {
@@ -282,7 +291,7 @@ module.exports = function(RED) {
         RED.nodes.createNode(this,n);
         var node = this;
         this.headers = n.headers||{};
-        this.statusCode = n.statusCode;
+        this.statusCode = parseInt(n.statusCode);
         this.on("input",function(msg,_send,done) {
             if (msg.res) {
                 var headers = RED.util.cloneMessage(node.headers);
@@ -323,7 +332,7 @@ module.exports = function(RED) {
                         }
                     }
                 }
-                var statusCode = node.statusCode || msg.statusCode || 200;
+                var statusCode = node.statusCode || parseInt(msg.statusCode) || 200;
                 if (typeof msg.payload == "object" && !Buffer.isBuffer(msg.payload)) {
                     msg.res._res.status(statusCode).jsonp(msg.payload);
                 } else {

package/core/network/21-httprequest.html

@@ -417,6 +417,7 @@
                     });
 
                 },
+                sortable: true,
                 removable: true
             });
             if (node.headers) {

package/core/network/21-httprequest.js

@@ -86,6 +86,7 @@ in your Node-RED user directory (${RED.settings.userDir}).
         if (n.paytoqs === true || n.paytoqs === "query") { paytoqs = true; }
         else if (n.paytoqs === "body") { paytobody = true; }
 
+        node.insecureHTTPParser = n.insecureHTTPParser
 
         var prox, noprox;
         if (process.env.http_proxy) { prox = process.env.http_proxy; }
@@ -434,6 +435,10 @@ in your Node-RED user directory (${RED.settings.userDir}).
                                     formData.append(opt, val);
                                 } else if (typeof val === 'object' && val.hasOwnProperty('value')) {
                                     formData.append(opt,val.value,val.options || {});
+                                } else if (Array.isArray(val)) {
+                                    for (var i=0; i<val.length; i++) {
+                                        formData.append(opt, val[i])
+                                    }
                                 } else {
                                     formData.append(opt,JSON.stringify(val));
                                 }

package/core/network/31-tcpin.js

@@ -86,7 +86,7 @@ module.exports = function(RED) {
         this.topic = n.topic;
         this.stream = (!n.datamode||n.datamode=='stream'); /* stream,single*/
         this.datatype = n.datatype||'buffer'; /* buffer,utf8,base64 */
-        this.newline = (n.newline||"").replace("\\n","\n").replace("\\r","\r").replace("\\t","\t");
+        this.newline = (n.newline||"").replace(/\\n/g,"\n").replace(/\\r/g,"\r").replace(/\\t/g,"\t");
         this.base64 = n.base64;
         this.trim = n.trim || false;
         this.server = (typeof n.server == 'boolean')?n.server:(n.server == "server");

package/core/parsers/70-CSV.js

@@ -19,9 +19,9 @@ module.exports = function(RED) {
     function CSVNode(n) {
         RED.nodes.createNode(this,n);
         this.template = (n.temp || "");
-        this.sep = (n.sep || ',').replace("\\t","\t").replace("\\n","\n").replace("\\r","\r");
+        this.sep = (n.sep || ',').replace(/\\t/g,"\t").replace(/\\n/g,"\n").replace(/\\r/g,"\r");
         this.quo = '"';
-        this.ret = (n.ret || "\n").replace("\\n","\n").replace("\\r","\r");
+        this.ret = (n.ret || "\n").replace(/\\n/g,"\n").replace(/\\r/g,"\r");
         this.winflag = (this.ret === "\r\n");
         this.lineend = "\n";
         this.multi = n.multi || "one";
@@ -110,7 +110,12 @@ module.exports = function(RED) {
                                         if (msg.payload[s].hasOwnProperty(p)) {
                                             /* istanbul ignore else */
                                             if (typeof msg.payload[s][p] !== "object") {
-                                                var q = "" + msg.payload[s][p];
+                                            // Fix to honour include null values flag
+                                            //if (typeof msg.payload[s][p] !== "object" || (node.include_null_values === true && msg.payload[s][p] === null)) {
+                                                var q = "";
+                                                if (msg.payload[s][p] !== undefined) {
+                                                    q += msg.payload[s][p];
+                                                }
                                                 if (q.indexOf(node.quo) !== -1) { // add double quotes if any quotes
                                                     q = q.replace(/"/g, '""');
                                                     ou += node.quo + q + node.quo + node.sep;
@@ -130,9 +135,15 @@ module.exports = function(RED) {
                                             ou += node.sep;
                                         }
                                         else {
-                                            var p = RED.util.ensureString(RED.util.getMessageProperty(msg,"payload["+s+"]['"+template[t]+"']"));
+                                            var tt = template[t];
+                                            if (template[t].indexOf('"') >=0 ) { tt = "'"+tt+"'"; }
+                                            else { tt = '"'+tt+'"'; }
+                                            var p = RED.util.getMessageProperty(msg,'payload["'+s+'"]['+tt+']');
                                             /* istanbul ignore else */
-                                            if (p === "undefined") { p = ""; }
+                                            if (p === undefined) { p = ""; }
+                                            // fix to honour include null values flag
+                                            //if (p === null && node.include_null_values !== true) { p = "";}
+                                            p = RED.util.ensureString(p);
                                             if (p.indexOf(node.quo) !== -1) { // add double quotes if any quotes
                                                 p = p.replace(/"/g, '""');
                                                 ou += node.quo + p + node.quo + node.sep;

package/core/sequence/17-split.html

@@ -224,7 +224,12 @@
         outputs:1,
         icon: "join.svg",
         label: function() {
-            return this.name||this._("join.join");
+            var nam = this.name||this._("join.join");
+            if (this.mode === "custom" && !isNaN(Number(this.count))) {
+                nam += " "+this.count;
+                if (this.accumulate === true) { nam+= "+"; }
+            }
+            return nam;
         },
         labelStyle: function() {
             return this.name?"node_label_italic":"";

package/core/sequence/17-split.js

@@ -251,7 +251,9 @@ module.exports = function(RED) {
                         }
                         else {
                             node.buffer = buff.slice(p,buff.length);
-                            node.pendingDones.push(done);
+                            if (node.buffer.length > 0) {
+                                node.pendingDones.push(done);
+                            }
                         }
                         if (node.buffer.length == 0) {
                             done();

package/core/sequence/19-batch.html

@@ -107,7 +107,14 @@
         outputs:1,
         icon: "batch.svg",
         label: function() {
-            return this.name||this._("batch.batch");;
+            var nam = this.name||this._("batch.batch");
+            if (this.mode === "count" && !isNaN(Number(this.count))) {
+                nam += " "+this.count;
+            }
+            if (this.mode === "interval" && !isNaN(Number(this.interval))) {
+                nam += " "+this.interval+"s";
+            }
+            return nam;
         },
         labelStyle: function() {
             return this.name ? "node_label_italic" : "";

package/locales/en-US/common/90-comment.html

@@ -18,5 +18,5 @@
     <p>A node you can use to add comments to your flows.</p>
     <h3>Details</h3>
     <p>The edit panel will accept Markdown syntax. The text will be rendered into
-    this information side panel.</p>
+    the information side panel.</p>
 </script>

package/locales/en-US/common/91-global-config.html

@@ -0,0 +1,3 @@
+<script type="text/html" data-help-name="global-config">
+    <p>A node for holding global configuration of flows.</p>
+</script>

package/locales/en-US/function/16-range.html

@@ -34,11 +34,14 @@
     the range specified within the target range.</p>
     <p><i>Scale and wrap within the target range</i> means that the result will
     be wrapped within the target range.</p>
+    <p><i>Scale, but drop if outside input range</i> means that the result will
+    be scaled, but any inputs outside of the inout range will be dropped.</p>
     <p>For example an input 0 - 10 mapped to 0 - 100.</p>
     <table style="outline-width:#888 solid thin">
         <tr><th width="80px">mode</th><th width="80px">input</th><th width="80px">output</th></tr>
         <tr><td><center>scale</center></td><td><center>12</center></td><td><center>120</center></td></tr>
         <tr><td><center>limit</center></td><td><center>12</center></td><td><center>100</center></td></tr>
         <tr><td><center>wrap</center></td><td><center>12</center></td><td><center>20</center></td></tr>
+        <tr><td><center>drop</center></td><td><center>12</center></td><td><center><i>(no output)</i></center></td></tr>
     </table>
 </script>

package/locales/en-US/function/80-template.html

@@ -52,4 +52,7 @@
        used to mark the templated sections. For example, to use <code>[[ ]]</code>
        instead, add the following line to the top of the template:</p>
     <pre>{{=[[ ]]=}}</pre>
+    <h4>Using environment variables</h4>
+    <p>The template node can access environment variables using the syntax:</p>
+    <pre>My favourite colour is {{env.COLOUR}}.</pre>
 </script>

package/locales/en-US/messages.json

@@ -446,7 +446,9 @@
             "staticTopic": "Subscribe to single topic",
             "dynamicTopic": "Dynamic subscription",
             "auto-connect": "Connect automatically",
-            "auto-mode-depreciated": "This option is depreciated. Please use the new auto-detect mode."
+            "auto-mode-depreciated": "This option is depreciated. Please use the new auto-detect mode.",
+            "none": "none",
+            "other": "other"
         },
         "sections-label": {
             "birth-message": "Message sent on connection (birth message)",
@@ -814,7 +816,8 @@
         "scale": {
             "payload": "Scale the message property",
             "limit": "Scale and limit to the target range",
-            "wrap": "Scale and wrap within the target range"
+            "wrap": "Scale and wrap within the target range",
+            "drop": "Scale, but drop msg if outside input range"
         },
         "tip": "Tip: This node ONLY works with numbers.",
         "errors": {
@@ -1124,5 +1127,10 @@
         "warn": {
             "nonumber": "no number found in payload"
         }
+    },
+    "global-config": {
+        "label": {
+            "open-conf": "Open Configuration"
+        }
     }
 }

package/locales/en-US/parsers/70-CSV.html

@@ -47,5 +47,6 @@
     <p>If 'include null values' option is checked, null values will be returned in result, ie. middle value '"1",,3'.</p>
     <p>The node can accept a multi-part input as long as the <code>parts</code> property is set correctly, for example from a file-in node or split node.</p>
     <p>If outputting multiple messages they will have their <code>parts</code> property set and form a complete message sequence.</p>
+    <p>If the node is set to only send column headers once, then setting <code>msg.reset</code> to any value will cause the node to resend the headers.</p>
     <p><b>Note:</b> the column template must be comma separated - even if a different separator is chosen for the data.</p>
 </script>

package/locales/ja/common/91-global-config.html

@@ -0,0 +1,3 @@
+<script type="text/html" data-help-name="global-config">
+    <p>大域的なフローの設定を保持するノード。大域的な環境変数の定義を含みます。</p>
+</script>p

package/locales/ja/function/80-template.html

@@ -48,4 +48,7 @@
     <p><b>注: </b>デフォルトでは、<i>mustache</i>形式は置換対象のHTML要素をエスケープします。これを抑止するには<code>{{{三重}}}</code>括弧形式を使います。</p>
     <p>もし、コンテンツの中で<code>{{ }}</code>を出力する必要がある場合は、テンプレートで使われる記号文字を変えることもできます。例えば、<code>[[ ]]</code>を代わりに用いるには、テンプレートの先頭に以下の行を追加します。</p>
     <pre>{{=[[ ]]=}}</pre>
+    <h4>環境変数の利用</h4>
+    <p>templateノードでは、次の構文を用いると環境変数にアクセスできます:</p>
+    <pre>私の好きな色は{{env.COLOUR}}です。</pre>
 </script>

package/locales/ja/messages.json

@@ -446,7 +446,9 @@
             "staticTopic": "1つのトピックを購読",
             "dynamicTopic": "動的な購読",
             "auto-connect": "自動接続",
-            "auto-mode-depreciated": "本オプションは非推奨になりました。新しい自動判定モードを使用してください。"
+            "auto-mode-depreciated": "本オプションは非推奨になりました。新しい自動判定モードを使用してください。",
+            "none": "なし",
+            "other": "その他"
         },
         "sections-label": {
             "birth-message": "接続時の送信メッセージ(Birthメッセージ)",
@@ -554,7 +556,8 @@
         },
         "status": {
             "requesting": "要求中"
-        }
+        },
+        "insecureHTTPParser": "厳密なHTTPパース処理を無効化"
     },
     "websocket": {
         "label": {
@@ -777,8 +780,8 @@
             "change": "値の置換",
             "delete": "値の削除",
             "move": "値の移動",
-            "toValue": "対象の値",
-            "to": "対象の値",
+            "toValue": "代入する値",
+            "to": "移動先",
             "search": "検索する文字列",
             "replace": "置換後の文字列"
         },
@@ -813,7 +816,8 @@
         "scale": {
             "payload": "msg.payloadの値を拡大/縮小",
             "limit": "入力値の範囲外の値を最小値/最大値とし拡大/縮小",
-            "wrap": "入力値の範囲外の値を範囲幅で割った余りとし拡大/縮小"
+            "wrap": "入力値の範囲外の値を範囲幅で割った余りとし拡大/縮小",
+            "drop": "値を拡大/縮小(入力範囲外の時はメッセージを削除)"
         },
         "tip": "注釈: 本ノードは、数値のみ扱うことができます。",
         "errors": {
@@ -1123,5 +1127,10 @@
         "warn": {
             "nonumber": "ペイロードに数値が含まれていません"
         }
+    },
+    "global-config": {
+        "label": {
+            "open-conf": "設定を開く"
+        }
     }
 }

package/locales/ja/parsers/70-CSV.html

@@ -43,5 +43,6 @@
     <p>「null値を含む」オプションがチェックされている場合、null値が結果に返されます。つまり「"1",,3」の真ん中の値がnullになります。</p>
     <p>file-inノードやsplitノードが出力するメッセージの様に、<code>parts</code>プロパティが正しく設定されている場合、メッセージ列を入力として受け付けます。</p>
     <p>CSVを複数のメッセージに変換して出力する場合、出力がメッセージ列となるよう<code>parts</code>プロパティを設定します。</p>
+    <p>ヘッダを一度だけ送信するよう設定している場合、任意の値を持つ<code>msg.reset</code>を渡すと、再度ヘッダを含めて送信できるようになります。</p>
     <p><b>注:</b> カンマ以外の区切り文字を設定した場合であっても、「列名」はカンマ区切りとしてください。</p>
 </script>