@theotherwillembotha/node-red-cluster 0.0.55 → 0.4.4

package/README.md

@@ -4,21 +4,6 @@ Connect multiple Node-RED instances into a coordinated cluster. Instances discov
 
 ---
 
-> [!IMPORTANT]
-> **This plugin requires [`@theotherwillembotha/node-red-plugincore`](https://github.com/theotherwillembotha/nodered_plugincore) to be installed.**
->
-> `node-red-plugincore` is declared as a dependency and npm will install it automatically. However, due to a [known Node-RED limitation](https://github.com/node-red/node-red/issues/3529), packages that arrive as transitive npm dependencies are only discovered by the Node-RED runtime on the **next startup**.
->
-> **Two options:**
-> - Install [`@theotherwillembotha/node-red-plugincore`](https://flows.nodered.org/node/@theotherwillembotha/node-red-plugincore) via the palette manager or `npm install` **first**, then install this plugin.
-> - Install this plugin directly, then **restart Node-RED once** and both packages will be fully loaded.
-
----
-
-> **Early development** - this package is still in development. APIs and configuration may change between releases.
-
----
-
 ## What it does
 
 Each Node-RED instance in the cluster connects to a NATS server. A **Cluster Publish** node sends a message onto a named subject; any other instance with a matching **Cluster Subscribe** node receives it. Subjects are automatically namespaced by instance, so you can subscribe to `field-a.sensors.temperature` for data from one specific instance, or `*.sensors.temperature` to receive it from all of them simultaneously.

package/build/GenerateNodes.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=GenerateNodes.d.ts.map

package/build/GenerateNodes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GenerateNodes.d.ts","sourceRoot":"","sources":["../src/GenerateNodes.ts"],"names":[],"mappings":""}

package/build/GenerateNodes.js

@@ -9,11 +9,12 @@ const ClusterPublishNode_1 = require("./cluster/node/ClusterPublishNode");
 const ClusterSubscribeNode_1 = require("./cluster/node/ClusterSubscribeNode");
 new node_red_plugincore_1.NodeGenerator("./src/")
     // services.
+    .registerService(node_red_plugincore_1.NodeTypeService)
     .registerService(ClusterService_1.ClusterService)
     // nodes
     .registerNode(ClusterConfigNode_1.ClusterConfigNode)
     .registerNode(ClusterPublishNode_1.ClusterPublishNode)
     .registerNode(ClusterSubscribeNode_1.ClusterSubscribeNode)
     // done.
-    .generate("./build/Nodes", "./build/Plugins");
+    .generate("./build/Nodes", "./build/Plugins", "@theotherwillembotha/node-red-cluster");
 process.exit(0);

package/build/Nodes.html

@@ -7,10 +7,52 @@
     You have been warned.
     
 -->
-
 <!-- ClusterConfigNode -->
-<style>
-</style>
+        
+    <style>
+    </style>
+
+        
+<!-- ClusterPublishNode -->
+        
+    <style>
+    </style>
+
+        
+<!-- 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('ClusterConfigNode', {
       category: 'config',
@@ -191,9 +233,7 @@ A single Node-RED instance can belong to multiple clusters simultaneously by cre
 | 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',
@@ -294,7 +334,7 @@ A single Node-RED instance can belong to multiple clusters simultaneously by cre
         <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.
+                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>
 
@@ -321,7 +361,7 @@ A single Node-RED instance can belong to multiple clusters simultaneously by cre
 </script>
 
 <script type="text/markdown" data-help-name='ClusterPublishNode'>
-> **Early development**  this package is still in development. APIs and configuration may change.
+> **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.
 
@@ -330,75 +370,29 @@ If the linked Cluster Config is set to **Observer** role, this node displays a w
 ### 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.
+: *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`:
+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`
+- `*.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',
@@ -570,7 +564,7 @@ Subscribers use wildcards to match across instances:
                 _suggestions = buildSuggestions(data);
               },
               error: function() {
-                console.warn('[ClusterSubscribe] Discovery unavailable  autocomplete disabled');
+                console.warn('[ClusterSubscribe] Discovery unavailable - autocomplete disabled');
               }
             });
           }
@@ -617,7 +611,7 @@ Subscribers use wildcards to match across instances:
 </script>
 
 <script type="text/markdown" data-help-name='ClusterSubscribeNode'>
-> **Early development**  this package is still in development. APIs and configuration may change.
+> **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.
 
@@ -628,7 +622,7 @@ Subscribes to one or more cluster subjects and emits a Node-RED message each tim
 
 ### Subject pattern syntax
 
-Patterns are scoped to the cluster's Root Path automatically  you only write the part after the root prefix.
+Patterns are scoped to the cluster's Root Path automatically - you only write the part after the root prefix.
 
 | Pattern | Matches |
 |---------|---------|
@@ -647,7 +641,6 @@ When the editor opens, the node fetches live discovery data from the cluster and
 ### 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.
+: *msg.topic*   : The full NATS subject the message arrived on - use this to identify which instance sent the message.
 </script>
-