@theotherwillembotha/node-red-cluster 0.0.55

package/build/Nodes.html

@@ -0,0 +1,653 @@
+
+<!--
+
+    This file was automatically generated using the NODERED Core utility.
+    Any modifications to his file will be overwritten the next time the code is regenerated.
+        
+    You have been warned.
+    
+-->
+
+<!-- ClusterConfigNode -->
+<style>
+</style>
+<script type="text/javascript">
+    RED.nodes.registerType('ClusterConfigNode', {
+      category: 'config',
+      label: function() {
+        return this.name;
+      },
+      paletteLabel: 'Cluster Config',
+      defaults: {
+        name: {
+          value: 'My Cluster',
+          required: true
+        },
+        instanceId: {
+          value: '',
+          required: true
+        },
+        zkRootPath: {
+          value: '/nodered-cluster',
+          required: true
+        },
+        natsAddress: {
+          value: 'localhost:4222',
+          required: true
+        },
+        natsUser: {
+          value: '',
+          required: false
+        },
+        natsPass: {
+          value: '',
+          required: false
+        },
+        role: {
+          value: 'Member',
+          required: true
+        },
+      },
+      oneditprepare: function() {
+        // **** ClusterConfigNode **** //
+        {
+          let node = this;
+          $("#node-config-input-role").typedInput({
+            type: "role",
+            types: [{
+              value: "role",
+              options: [{
+                value: "Member",
+                label: "Member"
+              }, {
+                value: "Observer",
+                label: "Observer"
+              }]
+            }]
+          });
+          $("#cluster-test-connection-btn").on("click", function() {
+            let $btn = $(this);
+            let natsText = $("#cluster-test-nats-text");
+            $btn.prop("disabled", true);
+            natsText.text("Testing...").css("color", "gray");
+            $.ajax({
+              url: "cluster/testconnection",
+              type: "POST",
+              contentType: "application/json",
+              data: JSON.stringify({
+                natsAddress: $("#node-config-input-natsAddress").val(),
+                natsUser: $("#node-config-input-natsUser").val() || undefined,
+                natsPass: $("#node-config-input-natsPass").val() || undefined
+              }),
+              success: function(r) {
+                natsText.text((r.nats.ok ? "\u2714 " : "\u2718 ") + (r.nats.message || r.nats.error)).css("color", r.nats.ok ? "green" : "red");
+              },
+              error: function(xhr) {
+                let msg = "Request failed";
+                try {
+                  msg = JSON.parse(xhr.responseText).error || msg;
+                } catch (e) {}
+                natsText.text("\u2718 " + msg).css("color", "red");
+              },
+              complete: function() {
+                $btn.prop("disabled", false);
+              }
+            });
+          });
+        }
+      },
+      oneditsave: function() {
+        // **** ClusterConfigNode **** //
+        {
+          let node = this;
+        }
+      },
+      oneditcancel: function() {},
+      oneditdelete: function() {},
+    });
+
+</script>
+
+
+<script type="text/html" data-template-name='ClusterConfigNode'>
+    <div id='section_ClusterConfigNode'>
+        <div class="form-row">
+            <label for="node-config-input-name" class="towb_editorlabel"><i class="fa fa-tag"></i> Name</label>
+            <input type="text" id="node-config-input-name" />
+        </div>
+
+        <div class="form-row editorsectionheading">
+            <i class="w-16 fa fa-sitemap"></i> <span>Identity</span>
+        </div>
+
+        <div class="editorgroupborder">
+            <div class="form-row nomargin">
+                <label for="node-config-input-instanceId" class="towb_editorlabel"><i class="fa fa-id-badge"></i> Instance ID</label>
+                <input type="text" id="node-config-input-instanceId" placeholder="e.g. field-a, control-center" />
+            </div>
+            <div class="form-row nomargin">
+                <label for="node-config-input-role" class="towb_editorlabel"><i class="fa fa-user-circle"></i> Role</label>
+                <input type="text" id="node-config-input-role" />
+            </div>
+        </div>
+
+        <div class="form-row editorsectionheading">
+            <i class="w-16 fa fa-plug"></i> <span>Connections</span>
+        </div>
+
+        <div class="editorgroupborder">
+            <div class="form-row nomargin">
+                <label for="node-config-input-natsAddress" class="towb_editorlabel"><i class="fa fa-exchange"></i> NATS Address</label>
+                <input type="text" id="node-config-input-natsAddress" placeholder="localhost:4222" />
+            </div>
+            <div class="form-row nomargin">
+                <label for="node-config-input-zkRootPath" class="towb_editorlabel"><i class="fa fa-folder"></i> Root Path</label>
+                <input type="text" id="node-config-input-zkRootPath" placeholder="/nodered-cluster" />
+            </div>
+            <div class="form-row nomargin">
+                <label for="node-config-input-natsUser" class="towb_editorlabel"><i class="fa fa-user"></i> Username</label>
+                <input type="text" id="node-config-input-natsUser" placeholder="(optional)" autocomplete="off" />
+            </div>
+            <div class="form-row nomargin">
+                <label for="node-config-input-natsPass" class="towb_editorlabel"><i class="fa fa-lock"></i> Password</label>
+                <input type="password" id="node-config-input-natsPass" placeholder="(optional)" autocomplete="new-password" />
+            </div>
+            <div class="form-row nomargin">
+                <label class="towb_editorlabel"></label>
+                <button type="button" id="cluster-test-connection-btn" class="red-ui-button"><i class="fa fa-plug"></i> Test Connection</button>
+                <span id="cluster-test-nats-text" style="font-size: 12px; margin-left: 8px;"></span>
+            </div>
+        </div>
+
+    </div>
+</script>
+
+<script type="text/markdown" data-help-name='ClusterConfigNode'>
+> **Early development**  this package is still in development. APIs and configuration may change.
+
+Defines a cluster connection. Each Node-RED instance that participates in a cluster needs one **Cluster Config** node per cluster it belongs to.
+
+A single Node-RED instance can belong to multiple clusters simultaneously by creating multiple config nodes with different Root Paths.
+
+### Identity
+
+: *name*        (string) : Display label for this config node.
+: *instance id* (string) : Unique name for this Node-RED instance within the cluster (e.g. `field-a`, `control-center`). Must be unique across all instances sharing the same Root Path.
+: *role*        (select) : **Member**  full participation; can publish and subscribe. **Observer**  subscribe only; all Cluster Publish nodes linked to this config are silently disabled at runtime.
+
+### Connections
+
+: *NATS address* (string) : Address of the NATS server or leaf node (`host:port`). Defaults to `localhost:4222`.
+: *Root Path*   (string)  : Path prefix that identifies this cluster (e.g. `/nodered-cluster`). All instances in the same cluster must use the same value. Multiple independent clusters can share a NATS server by using different Root Paths.
+: *username*    (string)  : NATS username for authentication. Leave blank for unauthenticated connections.
+: *password*    (string)  : NATS password for authentication. Leave blank for unauthenticated connections.
+
+### Status indicators
+
+| Colour | Meaning |
+|--------|---------|
+| Yellow ring | Connecting to NATS |
+| Green dot   | Connected and registered |
+| Red ring    | Connection error or disconnected |
+| Grey ring   | Idle (not yet started) |
+</script>
+<!-- ClusterPublishNode -->
+<style>
+</style>
+<script type="text/javascript">
+    RED.nodes.registerType('ClusterPublishNode', {
+      category: 'cluster',
+      icon: 'cluster.png',
+      color: '#4A90D9',
+      label: function() {
+        return this.name;
+      },
+      paletteLabel: 'Cluster Publish',
+      inputs: 1,
+      inputLabels: (i) => 'message',
+      outputs: 0,
+      outputLabels: (i) => [][i],
+      defaults: {
+        name: {
+          value: 'Cluster Publish',
+          required: true
+        },
+        clusterConfig: {
+          type: 'ClusterConfigNode',
+          required: true
+        },
+        subject: {
+          value: '',
+          required: true
+        },
+        mode: {
+          value: 'Durable',
+          required: true
+        },
+        ttl: {
+          value: '30',
+          required: false
+        },
+      },
+      oneditprepare: function() {
+        // **** ClusterPublishNode **** //
+        {
+          let node = this;
+          let modeSelect = $("#node-input-mode");
+          let updateTtlVisibility = function() {
+            let isEphemeral = modeSelect.typedInput("value") === "Ephemeral";
+            $("#cluster-publish-ttl-row").toggle(isEphemeral);
+          };
+          modeSelect.typedInput({
+            type: "mode",
+            types: [{
+              value: "mode",
+              options: [{
+                value: "Durable",
+                label: "Durable (delivered eventually)"
+              }, {
+                value: "Ephemeral",
+                label: "Ephemeral (discard if stale)"
+              }]
+            }]
+          });
+          modeSelect.on("change", updateTtlVisibility);
+          updateTtlVisibility();
+          // show observer warning if the linked config is in Observer role.
+          let clusterConfigInput = $("#node-input-clusterConfig");
+          clusterConfigInput.on("change", function() {
+            let configId = clusterConfigInput.val();
+            let configNode;
+            RED.nodes.eachConfig(function(cfg) {
+              if (cfg.id === configId) configNode = cfg;
+            });
+            let isObserver = configNode && configNode.role === "Observer";
+            $("#cluster-publish-observer-warning").toggle(!!isObserver);
+          });
+        }
+      },
+      oneditsave: function() {
+        // **** ClusterPublishNode **** //
+        {
+          let node = this;
+        }
+      },
+      oneditcancel: function() {},
+      oneditdelete: function() {},
+    });
+
+</script>
+
+
+<script type="text/html" data-template-name='ClusterPublishNode'>
+    <div id='section_ClusterPublishNode'>
+        <div class="form-row">
+            <label for="node-input-name" class="towb_editorlabel"><i class="fa fa-tag"></i> Name</label>
+            <input type="text" id="node-input-name" />
+        </div>
+
+        <div class="form-row nomargin">
+            <label for="node-input-clusterConfig" class="towb_editorlabel"><i class="fa fa-sitemap"></i> Cluster</label>
+            <input type="text" id="node-input-clusterConfig" placeholder="config" />
+        </div>
+
+        <div id="cluster-publish-observer-warning" style="display:none;" class="form-row">
+            <div style="padding: 6px 8px; background: #fff3cd; border: 1px solid #ffc107; border-radius: 4px; color: #856404;">
+                <i class="fa fa-exclamation-triangle"></i>
+                This node is <strong>disabled</strong> the linked cluster config is set to <strong>Observer</strong> role. Publishing will be silently ignored at runtime.
+            </div>
+        </div>
+
+        <div class="form-row editorsectionheading">
+            <i class="w-16 fa fa-paper-plane"></i> <span>Publish</span>
+        </div>
+
+        <div class="editorgroupborder">
+            <div class="form-row nomargin">
+                <label for="node-input-subject" class="towb_editorlabel"><i class="fa fa-tag"></i> Subject</label>
+                <input type="text" id="node-input-subject" placeholder="e.g. commands.opengate" />
+            </div>
+            <div class="form-row nomargin">
+                <label for="node-input-mode" class="towb_editorlabel"><i class="fa fa-send"></i> Mode</label>
+                <input type="text" id="node-input-mode" />
+            </div>
+            <div class="form-row nomargin" id="cluster-publish-ttl-row">
+                <label for="node-input-ttl" class="towb_editorlabel"><i class="fa fa-clock-o"></i> TTL (seconds)</label>
+                <input type="number" id="node-input-ttl" min="1" style="width: 80px;" />
+            </div>
+        </div>
+
+    </div>
+</script>
+
+<script type="text/markdown" data-help-name='ClusterPublishNode'>
+> **Early development**  this package is still in development. APIs and configuration may change.
+
+Publishes a Node-RED message to the cluster. Any instance with a matching **Cluster Subscribe** pattern will receive it.
+
+If the linked Cluster Config is set to **Observer** role, this node displays a warning in the editor and silently discards all messages at runtime.
+
+### Properties
+
+: *cluster* (config) : The Cluster Config node that defines which cluster to publish to.
+: *subject* (string) : Subject identifier for this publisher  e.g. `commands.opengate` or `sensors.temperature`. Dot-notation is supported.
+: *mode*    (select) : **Durable**  persisted in JetStream; delivered even if the subscriber is offline. **Ephemeral**  discarded if not consumed within the TTL window; use for time-sensitive data.
+: *TTL*     (number) : Ephemeral mode only. Seconds before an undelivered message is discarded. Default: 30.
+
+### Subject routing
+
+The full NATS subject is composed automatically as `<rootPath>.<instanceId>.<subject>`.
+
+Example  Root Path `/nodered-cluster`, Instance ID `field-a`, Subject `commands.opengate`:
+
+```
+nodered-cluster.field-a.commands.opengate
+```
+
+Subscribers use wildcards to match across instances:
+- `*.commands.opengate`  receives this subject from any instance
+- `field-a.>`  receives all subjects from `field-a`
+
+### Input
+
+: *msg.payload* : Serialised as JSON and published to the cluster subject.
+</script>
+<!-- ClusterSubscribeNode -->
+<style>
+    .cluster-sub-ac-dropdown {
+      position: fixed;
+      background: var(--red-ui-primary-background, #fff);
+      border: 1px solid var(--red-ui-form-input-border-color, #ccc);
+      border-top: none;
+      border-radius: 0 0 4px 4px;
+      max-height: 220px;
+      overflow-y: auto;
+      z-index: 2000;
+      display: none;
+      box-shadow: 0 4px 8px rgba(0, 0, 0, 0.15);
+    }
+
+    .cluster-sub-ac-item {
+      padding: 5px 10px;
+      cursor: pointer;
+      display: flex;
+      justify-content: space-between;
+      align-items: center;
+      font-size: 12px;
+      border-bottom: 1px solid var(--red-ui-secondary-border-color, #eee);
+    }
+
+    .cluster-sub-ac-item:last-child {
+      border-bottom: none;
+    }
+
+    .cluster-sub-ac-item:hover,
+    .cluster-sub-ac-item.cluster-sub-ac-active {
+      background: var(--red-ui-secondary-background-selected, #e5f3ff);
+    }
+
+    .cluster-sub-ac-value {
+      font-family: monospace;
+      font-weight: 500;
+    }
+
+    .cluster-sub-ac-desc {
+      color: var(--red-ui-tertiary-text-color, #999);
+      font-size: 11px;
+      white-space: nowrap;
+      margin-left: 8px;
+    }
+
+</style>
+<script type="text/javascript">
+    RED.nodes.registerType('ClusterSubscribeNode', {
+      category: 'cluster',
+      icon: 'cluster.png',
+      color: '#4A90D9',
+      label: function() {
+        return this.name;
+      },
+      paletteLabel: 'Cluster Subscribe',
+      inputs: 0,
+      inputLabels: (i) => 'undefined',
+      outputs: 1,
+      outputLabels: (i) => ['message'][i],
+      defaults: {
+        name: {
+          value: 'Cluster Subscribe',
+          required: true
+        },
+        clusterConfig: {
+          type: 'ClusterConfigNode',
+          required: true
+        },
+        subjectPattern: {
+          value: '',
+          required: true
+        },
+      },
+      oneditprepare: function() {
+        // **** ClusterSubscribeNode **** //
+        {
+          let node = this;
+          let _suggestions = [];
+          let _currentMatches = [];
+          let _activeIdx = -1;
+          // Clean up any leftover dropdown from a previous edit
+          $('.cluster-sub-ac-dropdown').remove();
+          let $input = $('#node-input-subjectPattern');
+          let $dropdown = $('<div class="cluster-sub-ac-dropdown">').appendTo('body');
+          // ── Build suggestion list from discovery data ─────────────────────────────
+          function buildSuggestions(data) {
+            let result = [];
+            let endpoints = data.endpoints || {};
+            let allSubjects = new Set();
+            Object.values(endpoints).forEach(function(subjects) {
+              subjects.forEach(function(s) {
+                allSubjects.add(s);
+              });
+            });
+            result.push({
+              value: '>',
+              desc: 'all messages'
+            });
+            [...allSubjects].sort().forEach(function(subject) {
+              result.push({
+                value: '*.' + subject,
+                desc: 'any instance'
+              });
+            });
+            Object.keys(endpoints).sort().forEach(function(instanceId) {
+              result.push({
+                value: instanceId + '.>',
+                desc: 'all from ' + instanceId
+              });
+              (endpoints[instanceId] || []).sort().forEach(function(subject) {
+                result.push({
+                  value: instanceId + '.' + subject,
+                  desc: instanceId
+                });
+              });
+            });
+            return result;
+          }
+          // ── Token helpers ─────────────────────────────────────────────────────────
+          function getCurrentToken() {
+            let parts = ($input.val() || '').split(',');
+            return parts[parts.length - 1].trimStart();
+          }
+
+          function replaceCurrentToken(value) {
+            let val = $input.val() || '';
+            let commaIdx = val.lastIndexOf(',');
+            $input.val(commaIdx === -1 ? value : val.substring(0, commaIdx) + ', ' + value);
+            $input.focus();
+          }
+
+          function filterSuggestions(token) {
+            let lower = token.toLowerCase();
+            let pool = token.length === 0 ? _suggestions : _suggestions.filter(function(s) {
+              return s.value.toLowerCase().startsWith(lower);
+            });
+            return pool.slice(0, 12);
+          }
+          // ── Dropdown rendering ────────────────────────────────────────────────────
+          function showDropdown(matches) {
+            _currentMatches = matches;
+            _activeIdx = -1;
+            $dropdown.empty();
+            if (matches.length === 0) {
+              $dropdown.hide();
+              return;
+            }
+            matches.forEach(function(s) {
+              $('<div class="cluster-sub-ac-item">').append($('<span class="cluster-sub-ac-value">').text(s.value)).append($('<span class="cluster-sub-ac-desc">').text(s.desc)).on('mousedown', function(e) {
+                e.preventDefault();
+                replaceCurrentToken(s.value);
+                $dropdown.hide();
+                _activeIdx = -1;
+              }).appendTo($dropdown);
+            });
+            let rect = $input[0].getBoundingClientRect();
+            $dropdown.css({
+              top: rect.bottom + 'px',
+              left: rect.left + 'px',
+              width: rect.width + 'px'
+            }).show();
+          }
+          // ── Input event handlers ──────────────────────────────────────────────────
+          $input.on('input', function() {
+            let matches = filterSuggestions(getCurrentToken());
+            matches.length > 0 ? showDropdown(matches) : $dropdown.hide();
+          });
+          $input.on('focus', function() {
+            if (_suggestions.length > 0) showDropdown(filterSuggestions(getCurrentToken()));
+          });
+          $input.on('blur', function() {
+            setTimeout(function() {
+              $dropdown.hide();
+            }, 150);
+          });
+          $input.on('keydown', function(e) {
+            if ($dropdown.is(':hidden')) {
+              if (e.key === 'ArrowDown' && _suggestions.length > 0) {
+                showDropdown(filterSuggestions(getCurrentToken()));
+              }
+              return;
+            }
+            let items = $dropdown.find('.cluster-sub-ac-item');
+            if (e.key === 'ArrowDown') {
+              e.preventDefault();
+              _activeIdx = Math.min(_activeIdx + 1, _currentMatches.length - 1);
+              items.removeClass('cluster-sub-ac-active').eq(_activeIdx).addClass('cluster-sub-ac-active');
+              items[_activeIdx] && items[_activeIdx].scrollIntoView({
+                block: 'nearest'
+              });
+            } else if (e.key === 'ArrowUp') {
+              e.preventDefault();
+              _activeIdx = Math.max(_activeIdx - 1, 0);
+              items.removeClass('cluster-sub-ac-active').eq(_activeIdx).addClass('cluster-sub-ac-active');
+              items[_activeIdx] && items[_activeIdx].scrollIntoView({
+                block: 'nearest'
+              });
+            } else if ((e.key === 'Enter' || e.key === 'Tab') && _activeIdx >= 0) {
+              e.preventDefault();
+              replaceCurrentToken(_currentMatches[_activeIdx].value);
+              $dropdown.hide();
+              _activeIdx = -1;
+            } else if (e.key === 'Escape') {
+              $dropdown.hide();
+              _activeIdx = -1;
+            }
+          });
+          // ── Fetch discovery data ──────────────────────────────────────────────────
+          let configId = node.clusterConfig;
+          if (configId) {
+            $.ajax({
+              url: 'cluster/discovery/' + configId,
+              type: 'GET',
+              success: function(data) {
+                _suggestions = buildSuggestions(data);
+              },
+              error: function() {
+                console.warn('[ClusterSubscribe] Discovery unavailable  autocomplete disabled');
+              }
+            });
+          }
+        }
+      },
+      oneditsave: function() {
+        // **** ClusterSubscribeNode **** //
+        {
+          let node = this;
+          $('.cluster-sub-ac-dropdown').remove();
+        }
+      },
+      oneditcancel: function() {},
+      oneditdelete: function() {},
+    });
+
+</script>
+
+
+<script type="text/html" data-template-name='ClusterSubscribeNode'>
+    <div id='section_ClusterSubscribeNode'>
+        <div class="form-row">
+            <label for="node-input-name" class="towb_editorlabel"><i class="fa fa-tag"></i> Name</label>
+            <input type="text" id="node-input-name" />
+        </div>
+
+        <div class="form-row nomargin">
+            <label for="node-input-clusterConfig" class="towb_editorlabel"><i class="fa fa-sitemap"></i> Cluster</label>
+            <input type="text" id="node-input-clusterConfig" placeholder="config" />
+        </div>
+
+        <div class="form-row editorsectionheading">
+            <i class="w-16 fa fa-inbox"></i> <span>Subscribe</span>
+        </div>
+
+        <div class="editorgroupborder">
+            <div class="form-row nomargin">
+                <label for="node-input-subjectPattern" class="towb_editorlabel"><i class="fa fa-filter"></i> Subject Pattern</label>
+                <input type="text" id="node-input-subjectPattern" placeholder="e.g. *.commands.opengate, *.events.closegate" autocomplete="off" />
+            </div>
+        </div>
+
+    </div>
+</script>
+
+<script type="text/markdown" data-help-name='ClusterSubscribeNode'>
+> **Early development**  this package is still in development. APIs and configuration may change.
+
+Subscribes to one or more cluster subjects and emits a Node-RED message each time a matching message arrives from any instance in the cluster.
+
+### Properties
+
+: *cluster*         (config) : The Cluster Config node that defines which cluster to subscribe to.
+: *subject pattern* (string) : One or more subject patterns, comma-separated. Each pattern creates an independent subscription. Supports NATS wildcards.
+
+### Subject pattern syntax
+
+Patterns are scoped to the cluster's Root Path automatically  you only write the part after the root prefix.
+
+| Pattern | Matches |
+|---------|---------|
+| `*.commands.opengate` | Open-gate command from **any** instance |
+| `field-a.sensors.temperature` | Temperature from `field-a` only |
+| `field-a.>` | **All** messages from `field-a` |
+| `>` | Every message in the cluster |
+| `*.commands.opengate, *.commands.closegate` | Both gate commands from any instance |
+
+`*` matches a single subject token. `>` matches one or more tokens and must be the last token in the pattern.
+
+### Autocomplete
+
+When the editor opens, the node fetches live discovery data from the cluster and populates an autocomplete dropdown as you type. Suggestions are grouped from broadest to most specific. Use arrow keys to navigate, Enter or Tab to select.
+
+### Outputs
+
+: *msg.payload* : The payload published by the remote Cluster Publish node.
+: *msg.topic*   : The full NATS subject the message arrived on  use this to identify which instance sent the message.
+</script>
+
+        

package/build/Nodes.js

@@ -0,0 +1,22 @@
+
+/*
+
+    This file was automatically generated using the NODERED Core utility.
+    Any modifications to his file will be overwritten the next time the code is regenerated.
+        
+    You have been warned.
+    
+*/
+"use strict";
+const NodeManager = require("@theotherwillembotha/node-red-plugincore").NodeManager;
+const ClusterConfigNode = require("@theotherwillembotha/node-red-cluster").ClusterConfigNode;
+const ClusterPublishNode = require("@theotherwillembotha/node-red-cluster").ClusterPublishNode;
+const ClusterSubscribeNode = require("@theotherwillembotha/node-red-cluster").ClusterSubscribeNode;
+module.exports = (RED) => {
+let manager = new NodeManager(RED);
+    manager.registerNodeType("ClusterConfigNode", ClusterConfigNode);
+    manager.registerNodeType("ClusterPublishNode", ClusterPublishNode);
+    manager.registerNodeType("ClusterSubscribeNode", ClusterSubscribeNode);
+}        
+        
+