@malysus/node-red-contrib-flow-splitter-extended 0.0.0-stage → 1.4.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,13 @@
+@yroshcha/node-red-contrib-flow-splitter-extended
+
+Original work:
+vdwpsmt
+https://github.com/vdwpsmt/node-red-contrib-flow-splitter-extended
+
+Fork modifications:
+Copyright 2026 Yehor Roshcha
+https://github.com/YRoshcha/node-red-contrib-flow-splitter-extended
+
+Fork modifications:
+Copyright 2026 Malys
+https://github.com/malys/node-red-contrib-flow-splitter-extended

package/README.md

@@ -1,3 +1,320 @@
-# Temporary Holding Version
+# node-red-contrib-flow-splitter-extended
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Node-RED plugin to split your **_flows.json_** file in individual YAML or JSON files (per tab, subflow and config-node) **with automatic extraction of function and ui-template node code**.
+
+## Purpose
+
+This plugin is useful if you regularly edit Node-RED applications in combination with editing in VS code or other IDEs.
+
+It will make the diffs of your version control much more controlled and readable:  It will also allow to edit (complex) function and UI-template nodes from within an external IDE
+
+- Commit files individually
+- Nodes are ordered alphabetically with their id
+- **Function and ui-template node code is extracted into separate `.js`, `.vue`, and `.md` files for easier editing in VS Code or other IDEs**
+- **Edit function code externally and reload changes without restarting Node-RED**
+
+**Note:** Add **_flows.json_** (or its equivalent given in the `package.json`) to your project `.gitignore` file.
+
+## Features
+
+### Flow Splitting
+- Splits flows.json into separate files for tabs, subflows, and config-nodes
+- Supports both YAML and JSON formats
+- Maintains tab order through configuration
+
+### Optional Function & Template Extraction and Restore (NEW)
+- Automatically extracts into seperate files per function/ui-template/template
+  - Extracts code from `function` nodes into `.js` files
+  - Extracts `ui-template` (Dashboard 2.0) content into `.vue` files
+  - Extracts core `template` node content (mustache/plain templating) into a file matching its format - `.html`, `.json`, `.xml`, `.yaml`, `.md`, `.hbs`, `.sql`, `.css`, `.js`, or `.txt` as a fallback
+  - Supports function `initialize` and `finalize` code in separate files
+  - Extracts node `info` documentation into `.md` files
+- Organizes extracted files in subdirectories alongside their parent tab/subflow
+- Restores changes back to Node-RED
+  - Automatically on startup
+  - Manually reload using endpoint
+- Both extraction (default true) and restoring (default false) can be changed in `.config.flow-splitter.json`
+
+
+## Functioning
+
+This plugin does not modify Node-RED core behavior. Node-RED core will still compile the flows into the JSON file stipulated in the `package.json`.
+
+The code is executed at each start of the flows, i.e. a start of Node-RED or a "deploy" action.
+
+It will take the running JSON file used by Node-RED specified in the Node-RED `package.json` (**_flows.json_** by default) and create all files in the directory `src` (_by default_) and their sub-directories : `tabs`, `subflows` and `config-nodes` at the root of the Node-RED userDir or the active project folder.
+
+### Function/Template Extraction Workflow
+
+When you deploy flows containing function or ui-template nodes:
+
+1. **Extraction Phase**: After splitting the flow files, the plugin scans each tab and subflow for function and ui-template nodes
+2. **File Creation**: For each node, it creates a subdirectory named after the tab/subflow and extracts:
+   - Main code into `<node-name>.js` (function) or `<node-name>.vue` (ui-template)
+   - Initialize code into `<node-name>.initialize.js` (if present)
+   - Finalize code into `<node-name>.finalize.js` (if present)
+   - Info documentation into `<node-name>.info.md` (if present)
+3. **Manifest**: A `.manifest.json` file tracks the mapping between nodes and extracted files
+
+When Node-RED starts with no flows.json:
+
+1. **Collection Phase**: The plugin reads all extracted function/template files
+2. **Update**: Updates the split flow files with the current code from disk
+3. **Rebuild**: Reconstructs the flows.json from the updated split files
+
+This allows you to edit function and template code in your favorite IDE with full syntax highlighting, linting, code assist and version control benefits!
+
+### Backward Compatibility & Safety
+
+This fork intentionally **keeps the monolith flow file (`flows.json` by default) on disk** after every split, instead of deleting it. Node-RED's own deploy/storage layer already writes a fully current copy of it on every deploy - this plugin just leaves that copy in place rather than erasing it.
+
+This means:
+- If this plugin is ever removed (`npm uninstall`, or simply not carried into a new image/build), plain Node-RED keeps booting normally from the last known-good `flows.json`. No data loss, no code changes required, no empty flows.
+- `src/` remains the source you actually edit and diff in git (still add the monolith flow file to `.gitignore` for that reason - see the note at the top), but it's no longer a *single point of failure* for booting Node-RED at all.
+
+On top of that, when `enableArtifact` is `true` (the default), every reload also writes a backup copy to `artifact/flows.json`. If a rebuild from `src/` ever fails (for example due to a corrupted or malformed split file), the plugin automatically restores the last good `artifact/flows.json` instead of leaving Node-RED with zero flows. This fallback only kicks in for the "no flow file present, rebuilding from source" case, and only if at least one successful reload has run before to create the backup.
+
+### Manual Reload (Live Editing)
+
+When Node-RED is running and you edit function/template files externally, use the **manual reload** endpoint to apply changes without restarting:
+
+**HTTP Endpoint:**
+```bash
+POST http://localhost:1880/flow-splitter/reload
+```
+
+**Usage Examples:**
+```powershell
+# PowerShell (Windows)
+Invoke-RestMethod -Uri http://localhost:1880/flow-splitter/reload -Method Post
+
+# Bash (Linux/Mac)
+curl -X POST http://localhost:1880/flow-splitter/reload
+
+# From browser console or bookmarklet
+fetch('http://localhost:1880/flow-splitter/reload', {method: 'POST'})
+  .then(r => r.json()).then(console.log);
+```
+
+This allows you to:
+1. Edit function/template files in VS Code or any other IDE
+2. Save changes
+3. Run the reload command
+4. See changes immediately in Node-RED (without deploy/restart)
+
+## File Structure Example
+
+```
+project/
+├── flows.json (kept in sync, safe fallback if this plugin is ever removed)
+├── artifact/
+│   └── flows.json (backup copy, written when enableArtifact is true)
+├── .config.flow-splitter.json
+└── src/
+    ├── tabs/
+    │   ├── Dashboard.json
+    │   └── Dashboard/
+    │       ├── .manifest.json
+    │       ├── process_data.js
+    │       ├── process_data.initialize.js
+    │       ├── process_data.finalize.js
+    │       ├── process_data.info.md
+    │       ├── header_template.vue
+    │       └── status_widget.vue
+    ├── subflows/
+    │   ├── DataProcessor.json
+    │   └── DataProcessor/
+    │       ├── .manifest.json
+    │       ├── transform.js
+    │       └── validate.js
+    └── config-nodes/
+        └── mqtt-broker.json
+```
+
+## Configuration
+
+The plugin will generate a configuration file `.config.flow-splitter.json` at the root of the Node-RED userDir or the active project folder.
+
+Default configuration file =
+
+```json
+{
+  "fileFormat": "json",
+  "destinationFolder": "src",
+  "tabsOrder": [],
+  "extractFunctionsTemplates": true,
+  "restoreFunctionsTemplates": false,
+  "enableArtifact": true,
+  "fastJsonSplit": true
+}
+```
+
+You can freely edit the config file, the changes are taken into account at the next restart of the flows.
+
+- `fileFormat`: **default `json`.** Parsing language for your split source files (either `yaml` or `json`). JSON split files can be pasted directly into the Node-RED *Import* dialog. Existing projects keep the format stored in this file; to switch, change it here, restart and deploy, then delete the old split files.
+- `destinationFolder`: path where to create the `tabs`, `subflows` and `config-nodes` sub-directories
+- `tabsOrder`: position of each tab (ordered array of the Ids of each tab node)
+- `extractFunctionsTemplates`: additional extraction of function and ui-template nodes
+- `enableArtifact`: **default `true`.** Writes a backup monolith flow file to `artifact/flows.json` on every reload/start event, and is used to automatically restore flows if a rebuild from `src/` ever fails (see [Backward Compatibility & Safety](#backward-compatibility--safety)). Set to `false` only if you don't want this backup written at all.
+- `fastJsonSplit`: **default `true`.** Uses an in-memory JSON splitter that avoids rebuilding a full `FlowSet` and rereading every generated file. Set to `false` to use the legacy `flows-file-manager` path.
+## Installation
+
+Run the following command in your Node-RED user directory - typically `~/.node-red`:
+
+```bash
+npm install @malysus/node-red-contrib-flow-splitter-extended
+```
+
+Migrating from `@yroshcha/node-red-contrib-flow-splitter-extended`: uninstall it first (both register the same plugin and endpoint). `.config.flow-splitter.json` and `src/` are kept as they are.
+
+```bash
+npm uninstall @yroshcha/node-red-contrib-flow-splitter-extended
+```
+
+Or install via the Node-RED palette manager.
+
+## Quick Start
+
+1. **Install the plugin** (see above)
+2. **Start Node-RED** and deploy your flows
+3. **Plugin automatically:**
+   - Splits flows.json into separate files in `src/` directory
+   - Extracts function and ui-template code into `.js` and `.vue` files
+   - Creates `.config.flow-splitter.json` configuration file
+4. **Edit extracted files** in VS Code or your favorite editor
+5. **Reload changes** using the manual reload command (see above)
+
+## Usage Workflows
+
+### Option 1: Edit & Restart (Simple)
+1. Edit function/template files in `src/tabs/<TabName>/`
+2. Stop Node-RED
+3. Start Node-RED
+4. Changes are automatically collected and applied
+
+### Option 2: Edit & Manual Reload (Fast)
+1. Edit function/template files in `src/tabs/<TabName>/`
+2. Save files
+3. Run reload command: `curl -X POST http://localhost:1880/flow-splitter/reload`
+4. Changes applied immediately (no restart needed)
+
+## Working with Extracted Code
+
+### Function Nodes
+
+Function nodes are extracted to `.js` files:
+- **Main code:** `<node-name>.js`
+- **Initialize code:** `<node-name>.initialize.js` (if present)
+- **Finalize code:** `<node-name>.finalize.js` (if present)
+- **Documentation:** `<node-name>.info.md` (if present)
+
+**Example:** A function node named "Process Data" creates:
+```
+src/tabs/MyTab/Process_Data.js
+src/tabs/MyTab/Process_Data.initialize.js
+src/tabs/MyTab/Process_Data.finalize.js
+src/tabs/MyTab/Process_Data.info.md
+```
+
+### UI Template Nodes
+
+Dashboard 2.0 ui-template nodes are extracted to `.vue` files:
+- **Template code:** `<node-name>.vue`
+- **Documentation:** `<node-name>.info.md` (if present)
+
+**Example:** A ui-template node named "Header Widget" creates:
+```
+src/tabs/Dashboard/Header_Widget.vue
+src/tabs/Dashboard/Header_Widget.info.md
+```
+
+### Core Template Nodes
+
+Node-RED's built-in `template` node (mustache/plain templating - commonly used to build HTML, emails, or any other text output) is extracted to a file matching its `format` field:
+
+| `format` on the node | Extracted extension |
+|---|---|
+| `html` | `.html` |
+| `json` | `.json` |
+| `xml` | `.xml` |
+| `yaml` | `.yaml` |
+| `markdown` | `.md` |
+| `handlebars` | `.hbs` |
+| `sql` | `.sql` |
+| `css` | `.css` |
+| `javascript` | `.js` |
+| anything else (e.g. `plain`) | `.txt` |
+
+**Example:** A `template` node named "driver Bonus 04-03" with `format: "html"` creates:
+```
+src/tabs/MyTab/driver_Bonus_04-03.html
+```
+
+Editing that `.html` file and reloading writes the content straight back into the node's `template` field - the `format` field itself is left untouched, since it only controls the editor's syntax-highlighting mode, not the content.
+
+## Benefits for Development
+
+### Version Control
+- Each function/template is in its own file - perfect for git diffs
+- See exactly what changed in each function
+- Review code changes more easily in pull requests
+
+### IDE Integration
+- Full syntax highlighting in VS Code or your favorite editor
+- Linting and formatting support
+- IntelliSense and autocomplete
+- Search across all functions easily
+
+### Code Organization
+- Functions grouped by their parent tab/subflow
+- Easy to find and navigate function code
+- Consistent file structure across projects
+
+## Troubleshooting
+
+### Changes Not Appearing After Manual Reload
+
+1. **Check Node-RED is running:** Ensure Node-RED is started and accessible at the URL
+2. **Verify endpoint:** Test with `curl -X POST http://localhost:1880/flow-splitter/reload`
+3. **Check file paths:** Ensure you're editing files in the correct `src/` subdirectory
+4. **Review manifest:** Check `.manifest.json` to verify node-to-file mappings
+
+### Files Not Extracted After Deploy
+
+1. **Check configuration:** Ensure `extractFunctionsTemplates: true` in `.config.flow-splitter.json`
+2. **Verify node types:** Only `function` and `ui-template` nodes are extracted
+3. **Node naming:** Ensure nodes have names (unnamed nodes use their ID)
+
+### Split Files Not Rebuilding
+
+The "rebuild from `src/`" path only runs when Node-RED boots with no flow file present at all (a genuinely fresh environment - new PVC, fresh git clone, etc.), since this fork no longer deletes the monolith flow file after a split.
+
+1. **Check flows.json:** If you expected a rebuild and it didn't happen, confirm the monolith flow file genuinely doesn't exist on disk yet - if it's present (even from a previous run), Node-RED just boots from it directly and the split-side logic keeps `src/` in sync on the next deploy instead.
+2. **Verify file format:** Ensure split files match the configured format (YAML/JSON)
+3. **Check the logs:** Any rebuild failure is logged with the `[node-red-contrib-flow-splitter-extended]` prefix, including whether it fell back to the `artifact/flows.json` backup or not - see [Backward Compatibility & Safety](#backward-compatibility--safety)
+
+## Compatibility
+
+- Works with Node-RED project mode
+- Compatible with function nodes (core)
+- Compatible with Dashboard 2.0 ui-template nodes
+- Supports both CommonJS and modern JavaScript
+
+## Development
+
+```bash
+npm install
+npm test
+```
+
+The tests run the plugin against a fake Node-RED runtime in a temporary user directory: split, extraction, rebuild, manual reload and artifact fallback.
+
+## Credits
+
+Maintained by [Malys](https://github.com/malys), fork of [YRoshcha/node-red-contrib-flow-splitter-extended](https://github.com/YRoshcha/node-red-contrib-flow-splitter-extended).
+
+This extended version combines the flow-splitting functionality from the original [node-red-contrib-flow-splitter](https://github.com/vgo-exo/node-red-contrib-flow-splitter) with function/template extraction inspired by [functions-templates-manager](https://github.com/daniel-payne/functions-templates-manager). It was originally packaged as `node-red-contrib-flow-splitter-extended` by vdwpsmt.
+
+## License
+
+See LICENSE file for details.