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

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [0.3.0] - 2026-01-31
+### Changed
+- New configuration property `concatArrays`: true -> array elements of corresponding arrays are concatenated, otherwise merged, default: `true`. Input message `msg.concatArrays` overwrites the node property.
+- Properties: The allowed data types for the input fields are now more restricted. 
+
 ## [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.

package/HELP.md

@@ -8,6 +8,7 @@ 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.
+: concatArrays (boolean) : true -> array elements of corresponding arrays are concatenated, otherwise merged, default: `true`. Input message `msg.concatArrays` overwrites the node property.
 
 ### Outputs
 
@@ -25,6 +26,12 @@ 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.
 
+The property `concatArrays` defines how to merge corresponding arrays defined in more 
+than one config file and/or `defaultConfig`: 
+- `true` Concatenate the array elements of corresponding arrays.
+- `false` Array elements in corresponding arrays with the same index overwrite each 
+other, with the overwrite order depending on the order of the sorted files (see above).
+
 ### References
 
 - [GitHub](https://github.com/schaeren/node-red-contrib-config-files) - source code

package/README.md

@@ -14,8 +14,12 @@ The node status displays one of the following two messages:
 - 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.
+If directory `configDir` doesn't exist or is not accessible or if no file was found with `configFileExt`, node warnings 
+are created. These warnings may appear in the “Debug Messages” sidebar.
+
+Special care is required when using config files containing arrays with objects: The `concatArray` property can be used 
+to define whether the array elements should be concatenated or merged. In the latter case, array elements with the same 
+array index are merged, i.e., element properties with identical names overwrite each other.
 
 ## Internals
 - This custom node was created from a subflow.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-red-contrib-config-files",
-    "version": "0.2.1",
+    "version": "0.3.0",
     "description": "Read and merge configuration files (JSON).",
     "main": "install.js",
     "scripts": {

package/subflow.json

@@ -21,37 +21,79 @@
             "y": 400,
             "wires": [
                 {
-                    "id": "86c429715975c781",
+                    "id": "efa7ea24e8224b84",
                     "port": 0
                 },
                 {
-                    "id": "efa7ea24e8224b84",
+                    "id": "86c429715975c781",
                     "port": 0
                 }
             ]
-        }    ],
+        }        
+    ],
     "env": [
         {
             "name": "configDir",
             "type": "str",
-            "value": "/config"
+            "value": "/config",
+            "ui": {
+                "type": "input",
+                "opts": {
+                    "types": [
+                        "str",
+                        "env"
+                    ]
+                }
+            }
         },
         {
             "name": "configFileExt",
             "type": "str",
-            "value": ".json"
+            "value": ".json",
+            "ui": {
+                "type": "input",
+                "opts": {
+                    "types": [
+                        "str",
+                        "env"
+                    ]
+                }
+            }
+        },
+        {
+            "name": "concatArrays",
+            "type": "bool",
+            "value": "true",
+            "ui": {
+                "type": "input",
+                "opts": {
+                    "types": [
+                        "bool",
+                        "env"
+                    ]
+                }
+            }
         },
         {
             "name": "defaultConfig",
             "type": "json",
-            "value": "{}"
+            "value": "{}",
+            "ui": {
+                "type": "input",
+                "opts": {
+                    "types": [
+                        "json",
+                        "env"
+                    ]
+                }
+            }
         }
     ],
     "meta": {
         "module": "node-red-contrib-config-files",
         "type": "config-files",
         "desc": "Read and merge configuration files (JSON).",
-        "version": "0.2.1",
+        "version": "0.3.0",
         "author": "Peter Schären <peter.schaeren@gmail.com>",
         "keywords": "node-red,config-files,config,json",
         "license": "MIT"
@@ -105,8 +147,7 @@
             "y": 240,
             "wires": [
                 [
-                    "7f1816d008fa2b70",
-                    "b46481b92cb28e07"
+                    "7f1816d008fa2b70"
                 ]
             ]
         },
@@ -122,7 +163,6 @@
             "y": 320,
             "wires": [
                 [
-                    "86c429715975c781",
                     "8639805af947d0c3"
                 ]
             ]
@@ -153,7 +193,7 @@
             "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;",
+            "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\nconst concatArrays = msg.concatArrays ?? null;\nif (typeof concatArrays === 'boolean') {\n    msg.concatArrays = concatArrays;\n}\nelse {\n    msg.concatArrays = env.get('concatArrays');\n}\n\nmsg.topic = 'configFiles';\nreturn msg;",
             "outputs": 1,
             "timeout": 0,
             "noerr": 0,
@@ -218,36 +258,13 @@
                 ]
             ]
         },
-        {
-            "id": "86c429715975c781",
-            "type": "function",
-            "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');\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,
-            "initialize": "// Code added here will be run once\n// whenever the node is started.\n\nconst defaultConfig = env.get('defaultConfig') ?? {};\n\nflow.set('mergedConfig', defaultConfig);\n",
-            "finalize": "",
-            "libs": [
-                {
-                    "var": "lodash",
-                    "module": "lodash"
-                }
-            ],
-            "x": 220,
-            "y": 400,
-            "wires": [
-                []
-            ]
-        },
         {
             "id": "7f1816d008fa2b70",
             "type": "function",
             "z": "ec796389903c1d0f",
             "name": "log",
             "func": "node.debug(`Reading file '${msg.payload}' ...`)\nreturn msg;",
-            "outputs": 0,
+            "outputs": 1,
             "timeout": 0,
             "noerr": 0,
             "initialize": "",
@@ -255,7 +272,11 @@
             "libs": [],
             "x": 650,
             "y": 240,
-            "wires": []
+            "wires": [
+                [
+                    "b46481b92cb28e07"
+                ]
+            ]
         },
         {
             "id": "8639805af947d0c3",
@@ -263,7 +284,7 @@
             "z": "ec796389903c1d0f",
             "name": "log",
             "func": "node.debug(`Config read from '${msg.filename}':\\n${JSON.stringify(msg.payload, null, 2)}`)\nreturn msg;",
-            "outputs": 0,
+            "outputs": 1,
             "timeout": 0,
             "noerr": 0,
             "initialize": "",
@@ -271,7 +292,11 @@
             "libs": [],
             "x": 650,
             "y": 320,
-            "wires": []
+            "wires": [
+                [
+                    "86c429715975c781"
+                ]
+            ]
         },
         {
             "id": "6a7545e5271cd1fa",
@@ -308,19 +333,42 @@
             "id": "efa7ea24e8224b84",
             "type": "function",
             "z": "ec796389903c1d0f",
-            "name": "defaultConfig",
-            "func": "const defaultConfig = env.get('defaultConfig') ?? {};\n\nmsg.payload = defaultConfig;\nreturn msg;\n",
+            "name": "use defaultConfig only",
+            "func": "let defaultConfig = env.get('defaultConfig');\n// defaultConfig may be null or '' (value can be '' if an undefined environment variable is used)\nif (!defaultConfig) {\n    defaultConfig = {};\n}\n\n\nmsg.payload = defaultConfig;\nreturn msg;\n",
             "outputs": 1,
             "timeout": 0,
             "noerr": 0,
             "initialize": "",
             "finalize": "",
             "libs": [],
-            "x": 570,
+            "x": 560,
             "y": 380,
             "wires": [
                 []
             ]
+        },
+        {
+            "id": "86c429715975c781",
+            "type": "function",
+            "z": "ec796389903c1d0f",
+            "name": "merge configs",
+            "func": "// -----------------------------------------------------------------------\nconst merge_customizer = (objValue, srcValue) => {\n    if (Array.isArray(objValue) && Array.isArray(srcValue)) {\n        return objValue.concat(srcValue);\n    }\n    return undefined;\n};\n// -----------------------------------------------------------------------\n\nlet config = flow.get('mergedConfig');\nconst concatArrays = env.get('concatArrays');\n\nif (concatArrays) {\n    config = lodash.mergeWith(config, msg.payload, merge_customizer);\n}\nelse {\n    config = lodash.merge(config, msg.payload);\n}\nnode.trace(`Merged config after merging file #${msg.parts.index + 1} '${msg.configFiles[msg.parts.index]}':\\n${JSON.stringify(config, null, 2)}`);\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 (concatArraays: ${concatArrays}):\\n ${JSON.stringify(msg.payload, null, 2)}`);\n    return msg;\n}\n",
+            "outputs": 1,
+            "timeout": 0,
+            "noerr": 0,
+            "initialize": "let defaultConfig = env.get('defaultConfig');\n// defaultConfig may be null or '' (value can be '' if an undefined environment variable is used)\nif (!defaultConfig) {\n    defaultConfig = {};\n}\n\nflow.set('mergedConfig', defaultConfig);\n",
+            "finalize": "",
+            "libs": [
+                {
+                    "var": "lodash",
+                    "module": "lodash"
+                }
+            ],
+            "x": 220,
+            "y": 400,
+            "wires": [
+                []
+            ]
         }
-   ]
+    ]
 }