node-red-contrib-config-files 0.1.0 → 0.2.1

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## [0.2.1] - 2026-01-31
+### Changed
+- If directory `configDir` doesn't exist or is not accessible: Instead of throwing a node error, a node warning is created. This warning may appear in the “Debug Messages” sidebar.
+
+## [0.2.0] - 2026-01-30
+### Added
+- If directory `configDir` doesn't exist or is not accessible, a node error is throw. This error can be received with a `catch` node, for example.
+- If no file was found with `configFileExt`, a node warning is created. This warning may appear in the “Debug Messages” sidebar.
+
+### Changed
+- A filename extension can be specified for searching configuration files. In the previous version, a search pattern could be configured. The corresponding property has renamed to `configFileEx` (previously: `configFilePattern`).
+- Dependency from `node-red-contrib-filesystem` has been removed. Only the Node.js core module [File System](https://nodejs.org/api/fs.html#file-system) (fs) is now used. This eliminates dependencies on third-party modules.
+
+### Fixed
+nothing

package/HELP.md

@@ -0,0 +1,30 @@
+Read and merge configuration files (JSON). 
+
+### Inputs
+
+Directory and filename extension used to search for configuration 
+files can be configured using the node properties and/or with the 
+input message.
+
+: configDir (string)     : Directory with config files. Absolute or relative path, default: `/config`. Input message `msg.configDir` overwrites the node property.
+: configFileExt (string) : Filename extension for config files, default: `.json`. Input message `msg.configFileExt` overwrites the node property.
+
+### Outputs
+
+: payload (object) : Merged content from config files.
+: configFiles []   : Paths to config files found, empty array if no files were found.
+
+### Details
+The node pproperty `defaultConfig` can be used to define configuration 
+values that are used when they are missing in the configuration files.
+
+The `configDir` is searched non-recursively for configuration files using 
+the filename extension `configFilePattern`.
+The files are sorted by their file names and merged in this order. 
+
+The content of the `defaultConfig` property and the configuration files 
+must by valid JSON.
+
+### References
+
+- [GitHub](https://github.com/schaeren/node-red-contrib-config-files) - source code

package/LICENSE

@@ -1 +1,21 @@
-Apache-2.0
+MIT License
+
+Copyright (c) [year] [fullname]
+
+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

@@ -1,17 +1,24 @@
 # node-red-contrib-config-files 
-[Node-Red](https://nodered.org/) node for reading and merging configuration files with JSON content. The output returns the resulting configuration.
+[Node-Red](https://nodered.org/) node for reading and merging configuration files with JSON content. The output returns 
+the resulting configuration object.
 
-Directory and search patterns for configuration files can be configured using the node properties and/or with the input message.
+Directory and filename extension used to search for configuration files can be configured using the node properties and/or 
+with the input message.
 
-The files are sorted by their file names and merged in this order. The `defaultConfig` property can be used to define configuration values that are missing in the files.
+The files are sorted by their file names and merged in this order. The `defaultConfig` can be used to define configuration 
+values that are used when they are missing in the configuration files.
 
 If no configuration files are found, the `defaultConfig` is returned.
 
 The node status displays one of the following two messages:
-- Found {count} config files in '{configDir}' with pattern '{configFilePattern}'
-- No config files found in '{configDir}' with pattern '{configFilePattern}' -> using default config
+- Found {count} config files in '{configDir}' with extension '{configFileExt}'
+- No config files found in '{configDir}' with extension '{configFileExt}' -> using default config
+
+If directory `configDir` doesn't exist or is not accessible or if no file was found with `configFileExt`, a node warning 
+is created. This warning may appear in the “Debug Messages” sidebar.
 
 ## Internals
-- This custom node is created from a subflow.
-- It uses `node-red-contrib-filesystem : fs-list` to find the config files.
+- This custom node was created from a subflow.
 - It uses `lodash.merge()` to merge the `defaultConfig` with the contents of the files found.
+- Some debug information is written by the node using `node.debug()`. To view these messages, set the logging level 
+in `settings.js` to at least `debug`.

package/install.js

@@ -2,7 +2,7 @@ const fs = require("fs");
 const path = require("path");
 
 module.exports = function(RED) {
-    const subflowFile = path.join(__dirname,"subflow.json");
+    const subflowFile = path.join(__dirname, "subflow.json");
     const subflowContents = fs.readFileSync(subflowFile);
     const subflowJSON = JSON.parse(subflowContents);
     RED.nodes.registerSubflow(subflowJSON);

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "node-red-contrib-config-files",
-    "version": "0.1.0",
-    "description": "Read and merge configuration files (JSON). The files are sorted by their file names and merged in this order. The “defaultConfig” property can be used to define configuration values that are missing in the files.",
+    "version": "0.2.1",
+    "description": "Read and merge configuration files (JSON).",
     "main": "install.js",
     "scripts": {
         "test": "echo \"Error: no test specified\" && exit 1"
@@ -20,16 +20,11 @@
         "type": "git",
         "url": "https://github.com/schaeren/node-red-contrib-config-files"
     },
-    "license": "Apache-2.0",
+    "homepage": "https://github.com/schaeren/node-red-contrib-config-files",
+    "license": "MIT",
     "node-red": {
         "nodes": {
             "config-files": "install.js"
-        },
-        "dependencies": [
-            "node-red-contrib-filesystem"
-        ]
-    },
-    "dependencies": {
-        "node-red-contrib-filesystem": "*"
+        }
     }
 }

package/subflow.json

@@ -1,8 +1,8 @@
 {
-    "id": "0d7c13f79e4a7aee",
+    "id": "ec796389903c1d0f",
     "type": "subflow",
     "name": "config-files",
-    "info": "Read and merge configuration files (JSON). \r\n\r\n### Inputs\r\nIf the node receives any message, it will read the \r\nconfig files and merge their contents.\r\n\r\nOptionally a directory and file search pattern can \r\nbe specified in the input message. These will \r\noverwrite the corresponding node properties.\r\n\r\n: configDir (string)         : Directory with config files. Absolute or relative path.\r\n: configFilePattern (string) : Search pattern for config files, e.g. `\"*.json\"`\r\n\r\n### Outputs\r\n\r\n: payload (object) : Merged content from config files.\r\n\r\n### Details\r\nThe `defaultConfig` property can be used to define \r\nconfiguration values that are missing in the \r\nconfiguration files.\r\n\r\nThe `configDir` is searched non-recursively for \r\nconfiguration files using the filename pattern \r\n`configFilePattern`.\r\nThe files are sorted by their file names and merged in \r\nthis order. \r\n\r\nThe content of the `defaultConfig` property and the \r\nconfiguration files must by valid JSON.\r\n\r\n### References\r\n\r\n - [GitHub](https://github.com/schaeren/node-red-contrib-config-files) - source code\r\n ",
+    "info": "Read and merge configuration files (JSON). \n\n### Inputs\n\nDirectory and filename extension used to search for configuration \nfiles can be configured using the node properties and/or with the \ninput message.\n\n: configDir (string)     : Directory with config files. Absolute or relative path, default: `/config`. Input message `msg.configDir` overwrites the node property.\n: configFileExt (string) : Filename extension for config files, default: `.json`. Input message `msg.configFileExt` overwrites the node property.\n\n### Outputs\n\n: payload (object) : Merged content from config files.\n: configFiles []   : Paths to config files found, empty array if no files were found.\n\n### Details\nThe node pproperty `defaultConfig` can be used to define configuration \nvalues that are used when they are missing in the configuration files.\n\nThe `configDir` is searched non-recursively for configuration files using \nthe filename extension `configFilePattern`.\nThe files are sorted by their file names and merged in this order. \n\nThe content of the `defaultConfig` property and the configuration files \nmust by valid JSON.\n\n### References\n\n- [GitHub](https://github.com/schaeren/node-red-contrib-config-files) - source code",
     "category": "",
     "in": [
         {
@@ -17,16 +17,19 @@
     ],
     "out": [
         {
-            "x": 720,
-            "y": 240,
+            "x": 740,
+            "y": 400,
             "wires": [
                 {
-                    "id": "81b18d7aad495891",
+                    "id": "86c429715975c781",
+                    "port": 0
+                },
+                {
+                    "id": "efa7ea24e8224b84",
                     "port": 0
                 }
             ]
-        }
-    ],
+        }    ],
     "env": [
         {
             "name": "configDir",
@@ -34,9 +37,9 @@
             "value": "/config"
         },
         {
-            "name": "configFilePattern",
+            "name": "configFileExt",
             "type": "str",
-            "value": "*.json"
+            "value": ".json"
         },
         {
             "name": "defaultConfig",
@@ -47,17 +50,17 @@
     "meta": {
         "module": "node-red-contrib-config-files",
         "type": "config-files",
-        "version": "0.1.0",
-        "author": "Peter Schären <peter.schaeren@gmail.com>",
         "desc": "Read and merge configuration files (JSON).",
+        "version": "0.2.1",
+        "author": "Peter Schären <peter.schaeren@gmail.com>",
         "keywords": "node-red,config-files,config,json",
-        "license": "Apache-2.0"
+        "license": "MIT"
     },
     "color": "#b0c2ba",
     "icon": "node-red/parser-json.svg",
     "status": {
-        "x": 720,
-        "y": 120,
+        "x": 740,
+        "y": 160,
         "wires": [
             {
                 "id": "73c98834cb90c714",
@@ -66,32 +69,10 @@
         ]
     },
     "flow": [
-        {
-            "id": "2b5d6f663d02b82f",
-            "type": "fs-list",
-            "z": "0d7c13f79e4a7aee",
-            "name": "Find config files",
-            "path": "configDir",
-            "pathType": "msg",
-            "pattern": "configFilePattern",
-            "patternType": "msg",
-            "filter": "files",
-            "recursive": false,
-            "follow": false,
-            "property": "payload",
-            "propertyType": "msg",
-            "x": 220,
-            "y": 80,
-            "wires": [
-                [
-                    "73c98834cb90c714"
-                ]
-            ]
-        },
         {
             "id": "b46481b92cb28e07",
             "type": "file in",
-            "z": "0d7c13f79e4a7aee",
+            "z": "ec796389903c1d0f",
             "name": "read file",
             "filename": "payload",
             "filenameType": "msg",
@@ -101,7 +82,7 @@
             "encoding": "utf8",
             "allProps": false,
             "x": 200,
-            "y": 200,
+            "y": 280,
             "wires": [
                 [
                     "f3c260d6c082e422"
@@ -111,7 +92,7 @@
         {
             "id": "bebafe14f9cc467b",
             "type": "split",
-            "z": "0d7c13f79e4a7aee",
+            "z": "ec796389903c1d0f",
             "name": "",
             "splt": "\\n",
             "spltType": "str",
@@ -120,35 +101,11 @@
             "stream": false,
             "addname": "",
             "property": "payload",
-            "x": 330,
-            "y": 160,
-            "wires": [
-                [
-                    "ef0d2e4ce8988133"
-                ]
-            ]
-        },
-        {
-            "id": "ef0d2e4ce8988133",
-            "type": "function",
-            "z": "0d7c13f79e4a7aee",
-            "name": "make paths absolute",
-            "func": "const configDir = env.get('configDir');\nmsg.payload = path.join(configDir, msg.payload);\n\nreturn msg;\n",
-            "outputs": 1,
-            "timeout": 0,
-            "noerr": 0,
-            "initialize": "",
-            "finalize": "",
-            "libs": [
-                {
-                    "var": "path",
-                    "module": "path"
-                }
-            ],
-            "x": 520,
-            "y": 160,
+            "x": 510,
+            "y": 240,
             "wires": [
                 [
+                    "7f1816d008fa2b70",
                     "b46481b92cb28e07"
                 ]
             ]
@@ -156,23 +113,24 @@
         {
             "id": "f3c260d6c082e422",
             "type": "json",
-            "z": "0d7c13f79e4a7aee",
-            "name": "to JS",
+            "z": "ec796389903c1d0f",
+            "name": "JSON to JS object",
             "property": "payload",
             "action": "obj",
             "pretty": false,
-            "x": 350,
-            "y": 200,
+            "x": 230,
+            "y": 320,
             "wires": [
                 [
-                    "81b18d7aad495891"
+                    "86c429715975c781",
+                    "8639805af947d0c3"
                 ]
             ]
         },
         {
             "id": "e2a872db2d9086e6",
             "type": "sort",
-            "z": "0d7c13f79e4a7aee",
+            "z": "ec796389903c1d0f",
             "name": "",
             "order": "ascending",
             "as_num": false,
@@ -182,8 +140,8 @@
             "msgKeyType": "elem",
             "seqKey": "payload",
             "seqKeyType": "msg",
-            "x": 190,
-            "y": 160,
+            "x": 370,
+            "y": 240,
             "wires": [
                 [
                     "bebafe14f9cc467b"
@@ -191,11 +149,81 @@
             ]
         },
         {
-            "id": "81b18d7aad495891",
+            "id": "3c563aca59369641",
+            "type": "function",
+            "z": "ec796389903c1d0f",
+            "name": "get config dir and filename extension",
+            "func": "const configDir = msg.configDir ?? null;\nif (typeof configDir === 'string' && configDir.trim().length > 0) {\n    msg.configDir = configDir;\n}\nelse {\n    msg.configDir = env.get('configDir');\n}\n\nconst configFileExt = msg.configFileExt ?? null;\nif (typeof configFileExt === 'string' && configFileExt.trim().length > 0) {\n    msg.configFileExt = configFileExt;\n}\nelse {\n    msg.configFileExt = env.get('configFileExt');\n}\n\nmsg.topic = 'configFiles';\nreturn msg;",
+            "outputs": 1,
+            "timeout": 0,
+            "noerr": 0,
+            "initialize": "",
+            "finalize": "",
+            "libs": [],
+            "x": 290,
+            "y": 40,
+            "wires": [
+                [
+                    "7883192ade1cf939"
+                ]
+            ]
+        },
+        {
+            "id": "73c98834cb90c714",
+            "type": "function",
+            "z": "ec796389903c1d0f",
+            "name": "node status",
+            "func": "const count = Array.isArray(msg.payload) ? msg.payload.length : 0;\n\nlet statusText = '';\nif (count > 0) {\n    statusText = `Found ${count} config files in '${msg.configDir}' with extension '${msg.configFileExt}'`;\n}\nelse {\n    statusText = `No config files found in '${msg.configDir}' with extension '${msg.configFileExt}' -> using default config`;\n}\nconst statusMsg = { payload: { fill: \"blue\", shape: \"ring\", text: statusText } };\n\nmsg.configFiles = msg.payload;\n\nreturn [msg, statusMsg];\n",
+            "outputs": 2,
+            "timeout": 0,
+            "noerr": 0,
+            "initialize": "",
+            "finalize": "",
+            "libs": [],
+            "x": 210,
+            "y": 160,
+            "wires": [
+                [
+                    "6a7545e5271cd1fa"
+                ],
+                []
+            ]
+        },
+        {
+            "id": "7883192ade1cf939",
+            "type": "function",
+            "z": "ec796389903c1d0f",
+            "name": "find files",
+            "func": "const dir = msg.configDir;\nconst ext = msg.configFileExt\n\n// ---------------------------------------------------------------------------------------\n\nasync function findFiles(dir, ext) {\n    try {\n        // Check if directory exists and is accessible\n        await fs.promises.access(dir);\n\n        // Find files\n        let filenames = await fs.promises.readdir(dir);\n        filenames = filenames.filter(f => path.extname(f) === ext);\n\n        // Prepend configDir to filenames\n        const filepaths = filenames.map(f => path.join(dir, f));\n        return filepaths ?? [];\n\n    } catch (err) {\n        node.warn(`Directory not found or not accessible: ${dir}`);\n        return [];\n    }\n}\n\n// ---------------------------------------------------------------------------------------\n\nnode.debug(`Searching files in directory '${dir}' filename extension '${ext}' ...`);\n\nconst filepaths = await findFiles(dir, ext);\n\n// log\nif (filepaths.length > 0) {\n    node.debug(`${filepaths.length} files found:`);\n    for (let fp of filepaths) {\n        node.debug(`    ${fp}`);\n    }\n}\nelse  {\n    node.warn(`No config files found in '${dir}' with extension '${ext}' -> using default config`);\n}\n\nmsg.payload = filepaths;\nreturn msg;\n",
+            "outputs": 1,
+            "timeout": 0,
+            "noerr": 0,
+            "initialize": "",
+            "finalize": "",
+            "libs": [
+                {
+                    "var": "fs",
+                    "module": "fs"
+                },
+                {
+                    "var": "path",
+                    "module": "path"
+                }
+            ],
+            "x": 200,
+            "y": 120,
+            "wires": [
+                [
+                    "73c98834cb90c714"
+                ]
+            ]
+        },
+        {
+            "id": "86c429715975c781",
             "type": "function",
-            "z": "0d7c13f79e4a7aee",
+            "z": "ec796389903c1d0f",
             "name": "merge configs",
-            "func": "// const _t = global.get('libTracer');\n// _t.init(node, msg, flow.get('enableTracer')); \n\nlet config = flow.get('mergedConfig');\nconfig = lodash.merge(config, msg.payload);\n// _t.trace(node, msg, 'config', lodash.cloneDeep(config));\n\nmsg.payload = config;\nreturn msg;\n",
+            "func": "// const _t = global.get('libTracer');\n// _t.init(node, msg, flow.get('enableTracer')); \n\nlet config = flow.get('mergedConfig');\n\nconfig = lodash.merge(config, msg.payload);\n// _t.trace(node, msg, 'config', lodash.cloneDeep(config));\n\n\n// Last config file read?\nif (msg.parts.index == msg.parts.count - 1) {\n    msg.topic = 'config';\n    msg.payload = config;\n    delete msg.parts;\n    delete msg.filename;\n\n    node.debug(`Merged ALL configs:\\n ${JSON.stringify(msg.payload, null, 2)}`);\n    return msg;\n}\n",
             "outputs": 1,
             "timeout": 0,
             "noerr": 0,
@@ -208,51 +236,91 @@
                 }
             ],
             "x": 220,
-            "y": 240,
+            "y": 400,
             "wires": [
                 []
             ]
         },
         {
-            "id": "3c563aca59369641",
+            "id": "7f1816d008fa2b70",
             "type": "function",
-            "z": "0d7c13f79e4a7aee",
-            "name": "get config dir and filename pattern",
-            "func": "const configDir = msg.configDir ?? null;\nif (typeof configDir === 'string' && configDir.trim().length > 0) {\n    msg.configDir = configDir;\n}\nelse {\n    msg.configDir = env.get('configDir');\n}\n\nconst configFilePattern = msg.configFilePattern ?? null;\nif (typeof configFilePattern === 'string' && configFilePattern.trim().length > 0) {\n    msg.configFilePattern = configFilePattern;\n}\nelse {\n    msg.configFilePattern = env.get('configFilePattern');\n}\n\nmsg.topic = 'configFiles';\nreturn msg;",
-            "outputs": 1,
+            "z": "ec796389903c1d0f",
+            "name": "log",
+            "func": "node.debug(`Reading file '${msg.payload}' ...`)\nreturn msg;",
+            "outputs": 0,
             "timeout": 0,
             "noerr": 0,
             "initialize": "",
             "finalize": "",
             "libs": [],
-            "x": 280,
-            "y": 40,
+            "x": 650,
+            "y": 240,
+            "wires": []
+        },
+        {
+            "id": "8639805af947d0c3",
+            "type": "function",
+            "z": "ec796389903c1d0f",
+            "name": "log",
+            "func": "node.debug(`Config read from '${msg.filename}':\\n${JSON.stringify(msg.payload, null, 2)}`)\nreturn msg;",
+            "outputs": 0,
+            "timeout": 0,
+            "noerr": 0,
+            "initialize": "",
+            "finalize": "",
+            "libs": [],
+            "x": 650,
+            "y": 320,
+            "wires": []
+        },
+        {
+            "id": "6a7545e5271cd1fa",
+            "type": "switch",
+            "z": "ec796389903c1d0f",
+            "name": "files found",
+            "property": "payload.length",
+            "propertyType": "msg",
+            "rules": [
+                {
+                    "t": "gt",
+                    "v": "0",
+                    "vt": "str"
+                },
+                {
+                    "t": "else"
+                }
+            ],
+            "checkall": "true",
+            "repair": false,
+            "outputs": 2,
+            "x": 210,
+            "y": 240,
             "wires": [
                 [
-                    "2b5d6f663d02b82f"
+                    "e2a872db2d9086e6"
+                ],
+                [
+                    "efa7ea24e8224b84"
                 ]
             ]
         },
         {
-            "id": "73c98834cb90c714",
+            "id": "efa7ea24e8224b84",
             "type": "function",
-            "z": "0d7c13f79e4a7aee",
-            "name": "status",
-            "func": "const count = Array.isArray(msg.payload) ? msg.payload.length : 0;\n\nlet statusText = `No config files found in '${msg.configDir}' with pattern '${msg.configFilePattern}' -> using default config`;\nif (count > 0) {\n    statusText = `Found ${count} config files in '${msg.configDir}' with pattern '${msg.configFilePattern}'`;\n}\nconst status = { fill: \"blue\", shape: \"ring\", text: statusText };\n\nreturn [ msg, { payload: status} ];",
-            "outputs": 2,
+            "z": "ec796389903c1d0f",
+            "name": "defaultConfig",
+            "func": "const defaultConfig = env.get('defaultConfig') ?? {};\n\nmsg.payload = defaultConfig;\nreturn msg;\n",
+            "outputs": 1,
             "timeout": 0,
             "noerr": 0,
             "initialize": "",
             "finalize": "",
             "libs": [],
-            "x": 190,
-            "y": 120,
+            "x": 570,
+            "y": 380,
             "wires": [
-                [
-                    "e2a872db2d9086e6"
-                ],
                 []
             ]
         }
-    ]
+   ]
 }