node-red-contrib-chokidar-watcher 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Andres Carmona
+
+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 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.

package/README.md

@@ -0,0 +1,63 @@
+# node-red-contrib-chokidar-watcher
+
+Node-RED node to watch folders using [chokidar](https://github.com/paulmillr/chokidar)
+with **`awaitWriteFinish`** support: events fire only after a file has finished
+being written.
+
+This solves the classic problem of the core `watch` node (and inotify-based
+watchers) firing while a file is still being uploaded — e.g. sensors pushing
+data files over FTP, where you must not process a file until the transfer
+completes.
+
+## Install
+
+From the Node-RED editor: **Menu → Manage palette → Install** and search for
+`node-red-contrib-chokidar-watcher`, or from your Node-RED user directory
+(typically `~/.node-red`):
+
+```bash
+npm install node-red-contrib-chokidar-watcher
+```
+
+## Usage
+
+Drop the **chokidar-watcher** node into a flow and configure the folder to
+watch. Every filesystem event emits a message:
+
+```json
+{
+  "payload": {
+    "type": "file",
+    "event": "add",
+    "path": "/data/incoming/sensor_data.xml",
+    "filename": "sensor_data.xml"
+  }
+}
+```
+
+- `type`: `file` or `directory`
+- `event`: chokidar event (`add`, `change`, `unlink`, `addDir`, `unlinkDir`)
+- `path`: full path of the affected file
+- `filename`: basename
+
+## Configuration
+
+| Option | Default | Description |
+|---|---|---|
+| Folder | — | Path to watch (recursive) |
+| Persistent | `true` | Keep the process alive while watching |
+| Stability threshold (ms) | `2000` | File size must stay constant this long before the event fires (`awaitWriteFinish.stabilityThreshold`) |
+| Polling interval (ms) | `100` | File size polling rate while waiting for stability (`awaitWriteFinish.pollInterval`) |
+
+Initial scan events are ignored (`ignoreInitial: true`): only changes after
+deploy are reported.
+
+## Notes
+
+- On network filesystems (CIFS/NFS) events may not propagate for writes made
+  from *other* hosts; writes made through the same mount (e.g. an FTP server
+  in the same pod/container) work fine.
+
+## License
+
+MIT

package/chokidar-watcher/chokidar-watcher.html

@@ -0,0 +1,50 @@
+<script type="text/javascript">
+    RED.nodes.registerType('chokidar-watcher',{
+        category: 'storage',
+        color: '#C0DEED',
+        defaults: {
+            name: {value:""},
+            folder: {value:"", required:true},
+            persistent: {value:true},
+            awaitWriteStabilityThreshold: {value:2000},
+            awaitWritePollingInterval: {value:100}
+        },
+        inputs:0,
+        outputs:1,
+        icon: "file-in.png",
+        label: function() {
+            return this.name || this.folder || "chokidar-watcher";
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="chokidar-watcher">
+    <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-folder"><i class="fa fa-folder"></i> Folder</label>
+        <input type="text" id="node-input-folder" placeholder="/path/to/folder">
+    </div>
+    <div class="form-row">
+        <label for="node-input-persistent"><i class="fa fa-refresh"></i> Persistent</label>
+        <input type="checkbox" id="node-input-persistent">
+    </div>
+    <div class="form-row">
+        <label for="node-input-awaitWriteStabilityThreshold">Stability (ms)</label>
+        <input type="number" id="node-input-awaitWriteStabilityThreshold" placeholder="2000">
+    </div>
+    <div class="form-row">
+        <label for="node-input-awaitWritePollingInterval">Poll interval (ms)</label>
+        <input type="number" id="node-input-awaitWritePollingInterval" placeholder="100">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="chokidar-watcher">
+    <p>Watches a folder for file changes using chokidar with awaitWriteFinish support.</p>
+    <p><b>Folder</b>: The path to the folder to watch.</p>
+    <p><b>Persistent</b>: Whether the watcher should keep the process running.</p>
+    <p><b>Stability Threshold</b>: Time in ms to wait for a file to stop changing before considering it written.</p>
+    <p><b>Poll Interval</b>: Time in ms between polls when checking for file stability.</p>
+</script>

package/chokidar-watcher/chokidar-watcher.js

@@ -0,0 +1,75 @@
+module.exports = function(RED) {
+    var chokidar = require('chokidar');
+    var path = require('path');
+    var watchers = {};
+
+    function ChokidarWatcherNode(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+
+        node.folder = config.folder;
+        node.persistent = config.persistent !== undefined ? config.persistent : true;
+        node.awaitWriteStabilityThreshold = config.awaitWriteStabilityThreshold || 2000;
+        node.awaitWritePollingInterval = config.awaitWritePollingInterval || 100;
+
+        if (watchers[node.id]) {
+            watchers[node.id].close();
+            delete watchers[node.id];
+        }
+
+        if (!node.folder) {
+            node.warn("No folder specified");
+            return;
+        }
+
+        var watcherOptions = {
+            persistent: node.persistent,
+            ignoreInitial: true,
+            awaitWriteFinish: {
+                stabilityThreshold: node.awaitWriteStabilityThreshold,
+                pollInterval: node.awaitWritePollingInterval
+            }
+        };
+
+        var watcher = chokidar.watch(node.folder, watcherOptions);
+
+        watchers[node.id] = watcher;
+
+        node.status({fill: "green", shape: "dot", text: "watching"});
+
+        watcher.on('all', function(event, filePath) {
+            var type = 'file';
+            if (event === 'addDir' || event === 'unlinkDir') {
+                type = 'directory';
+            }
+
+            var payload = {
+                type: type,
+                event: event,
+                path: filePath,
+                filename: path.basename(filePath)
+            };
+
+            node.send({payload: payload});
+        });
+
+        watcher.on('error', function(error) {
+            node.error("Watcher error: " + error.message);
+            node.status({fill: "red", shape: "ring", text: "error"});
+        });
+
+        watcher.on('ready', function() {
+            node.status({fill: "green", shape: "dot", text: "ready"});
+        });
+
+        node.on('close', function() {
+            if (watchers[node.id]) {
+                watchers[node.id].close();
+                delete watchers[node.id];
+            }
+            node.status({});
+        });
+    }
+
+    RED.nodes.registerType("chokidar-watcher", ChokidarWatcherNode);
+};

package/package.json

@@ -0,0 +1,42 @@
+{
+    "name": "node-red-contrib-chokidar-watcher",
+    "version": "1.0.1",
+    "description": "Node-RED node to watch folders using chokidar with awaitWriteFinish support",
+    "author": "Andres Carmona <valdepeace@gmail.com> (https://www.valdepeace.com)",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/valdepeace/node-red-contrib-chokidar-watcher.git"
+    },
+    "bugs": {
+        "url": "https://github.com/valdepeace/node-red-contrib-chokidar-watcher/issues"
+    },
+    "homepage": "https://www.valdepeace.com",
+    "keywords": [
+        "node-red",
+        "chokidar",
+        "watch",
+        "watcher",
+        "folder",
+        "file",
+        "inotify",
+        "awaitWriteFinish"
+    ],
+    "license": "MIT",
+    "files": [
+        "chokidar-watcher",
+        "README.md",
+        "LICENSE"
+    ],
+    "engines": {
+        "node": ">=18"
+    },
+    "dependencies": {
+        "chokidar": "^3.5.3"
+    },
+    "node-red": {
+        "version": ">=3.0.0",
+        "nodes": {
+            "chokidar-watcher": "chokidar-watcher/chokidar-watcher.js"
+        }
+    }
+}