2.6 KiB
2.6 KiB
name, description
| name | description |
|---|---|
| evolv-frontend-node-red | Design and implement Node-RED node editor UI and runtime-facing configuration for EVOLV. Use when editing node HTML editor files, `RED.nodes.registerType(...)` defaults, admin endpoint-driven menus/config scripts, and config mapping into `src/nodeClass.js` in JavaScript/CommonJS nodes. |
EVOLV Frontend Node-RED
Mission
Implement robust Node-RED editor experiences that keep UI defaults, runtime config parsing, and behavior in lockstep.
Repo-Specific Rules
- Use CommonJS patterns in runtime files.
- Keep node names aligned across
RED.nodes.registerType('<nodeName>', ...), runtime registration in<nodeName>.js, and package/node mapping. - Keep admin endpoint paths stable unless editor consumers are updated:
/<nodeName>/menu.jsand/<nodeName>/configData.js. - Prefer placeholder-driven UI composition when matching EVOLV patterns.
Node Layout Standard
Use nodes/machineGroupControl/ as the template baseline for new nodes.
nodes/<nodeName>/<nodeName>.js- Keep runtime entry small.
- Create Node-RED instance and attach
this.nodeClass = new nodeClass(...). - Register admin endpoints via shared managers.
nodes/<nodeName>/<nodeName>.html- Register defaults in
RED.nodes.registerType(...). - Load
/<nodeName>/menu.jsand/<nodeName>/configData.js. - Use
oneditprepareto callwindow.EVOLV.nodes.<nodeName>.initEditor(this).
- Register defaults in
nodes/<nodeName>/src/nodeClass.js- Normalize
uiConfiginto runtime config. - Keep Node-RED concerns here: input routing, tick loop, output formatting, status.
- Normalize
nodes/<nodeName>/src/specificClass.js- Keep domain logic here with minimal/no direct Node-RED coupling.
Implementation Workflow
- Inspect current node trio:
.html,.js,src/nodeClass.js. - Define required config properties and defaults.
- Update
.htmldefaults and form controls. - Update runtime config normalization in
src/nodeClass.js. - Confirm
msg.topiccommand handling is still coherent. - Add tests under
nodes/<nodeName>/test/with focus on config defaults/overrides and topic routing. - If creating a new node, add entry under root
package.jsonnode-red.nodesmap.
Quality Gates
- Every UI property has corresponding runtime handling.
- Numeric inputs are validated/coerced consistently.
- Node status and output shape remain predictable.
- No Node-RED runtime dependency required for domain tests.
Deliverables
Return:
- changed config fields and mapping table
- changed files
- tests added and what they prove
- migration notes if backward compatibility changed