node-red-contrib-vectorprime 0.1.7 → 0.1.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-vectorprime",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "VectorPrime Decision Kernel node for Node-RED",
   "main": "vectorprime.js",
   "license": "MIT",

package/vectorprime.html

@@ -27,28 +27,6 @@
   </div>
 </script>
 
-<!-- ✅ Help text for the config node -->
-<script type="text/html" data-help-name="vectorprime-config">
-  <p><b>VectorPrime Config</b></p>
-
-  <p>
-    Stores your VectorPrime API connection details securely using Node-RED credentials.
-    This keeps your API key <b>out of flow exports</b>.
-  </p>
-
-  <h3>Quick setup</h3>
-  <ol>
-    <li>Leave Base URL as default (or set your own hosted backend).</li>
-    <li>Click <b>Get Free Key</b> to generate a starter key instantly.</li>
-    <li>Use this config in one or more VectorPrime nodes.</li>
-  </ol>
-
-  <p>
-    <b>Default Base URL:</b><br/>
-    <code>https://vectorprime-kernel-backend.onrender.com</code>
-  </p>
-</script>
-
 <script type="text/javascript">
   (function () {
     function normalizeBaseUrl(url) {
@@ -126,6 +104,32 @@
   })();
 </script>
 
+<!-- ✅ HELP TAB: vectorprime-config -->
+<script type="text/html" data-help-name="vectorprime-config">
+  <p><b>VectorPrime Config</b> stores your Base URL and API key securely.</p>
+
+  <h3>Quick Setup</h3>
+  <ol>
+    <li>Set <b>Base URL</b> (default is already correct)</li>
+    <li>Click <b>Get Free Key</b></li>
+    <li>Click <b>Done</b></li>
+  </ol>
+
+  <p>
+    ✅ Your key is stored in Node-RED <b>credentials</b>, so it is <b>not exported with flows</b>.
+  </p>
+
+  <h3>Recommended Base URL</h3>
+  <pre>https://vectorprime-kernel-backend.onrender.com</pre>
+
+  <h3>Tip</h3>
+  <p>
+    You can also paste your own paid key here if you want higher limits.
+  </p>
+</script>
+
+<hr />
+
 <script type="text/html" data-template-name="vectorprime-rank">
   <div class="form-row">
     <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
@@ -144,48 +148,14 @@
 
   <div class="form-row">
     <div style="font-size:12px; color:#666;">
-      ✅ Sends <code>msg.payload</code> to VectorPrime and returns ranked results in <code>msg.payload</code>.
+      ✅ Sends <code>msg.payload</code> to VectorPrime and returns the ranked result in <code>msg.payload</code>.
     </div>
   </div>
 </script>
 
-<!-- ✅ Help text for the rank node (THIS controls the palette hover tooltip content) -->
-<script type="text/html" data-help-name="vectorprime-rank">
-  <p><b>Rank Decision (VectorPrime)</b></p>
-
-  <p>
-    Instantly rank tasks, events, or choices by <b>priority + urgency</b> using the VectorPrime Decision Kernel.
-    Perfect for building flows that automatically pick the <b>best next action</b>.
-  </p>
-
-  <h3>Best use cases</h3>
-  <ul>
-    <li><b>Incident response:</b> Rank alerts and decide what to fix first</li>
-    <li><b>Ops & automation:</b> Choose the next job to run when resources are limited</li>
-    <li><b>AI agents:</b> Pick the best tool/action based on outcome + risk</li>
-    <li><b>Queues & tickets:</b> Prioritize support tickets, backlog items, escalations</li>
-    <li><b>Workflow routing:</b> Route messages/events to the right handler by importance</li>
-  </ul>
-
-  <h3>Input</h3>
-  <p>
-    Expects <code>msg.payload</code> to be your decision set / tasks object (JSON).
-  </p>
-
-  <h3>Output</h3>
-  <p>
-    Returns the VectorPrime response in <code>msg.payload</code>, including ranked results.
-  </p>
-
-  <h3>Tip</h3>
-  <p>
-    If you hit a free-tier limit, the response may include an upgrade URL so your flow can continue.
-  </p>
-</script>
-
 <script type="text/javascript">
   RED.nodes.registerType("vectorprime-rank", {
-    category: "network",                 // ✅ moved to Network
+    category: "network",
     color: "#2563EB",
     defaults: {
       name: { value: "" },
@@ -196,11 +166,140 @@
     outputs: 1,
     icon: "font-awesome/fa-bolt",
 
-    // ✅ This makes the palette show a human label instantly
+    // ✅ This is the name users see in the palette
     paletteLabel: "Rank Decision (VectorPrime)",
 
+    // ✅ This is the short description used in the tooltip card
+    description: "Automatically ranks tasks, alerts, or choices in msg.payload so your flow can pick the best next action.",
+
     label: function () {
       return this.name || "Rank Decision (VectorPrime)";
     }
   });
+</script>
+
+<!-- ✅ HELP TAB: vectorprime-rank -->
+<script type="text/html" data-help-name="vectorprime-rank">
+  <p>
+    <b>Rank Decision (VectorPrime)</b> sorts your options and returns the best next action.
+    Use it anywhere you need <b>priority scoring</b> or <b>decision ranking</b> inside a flow.
+  </p>
+
+  <h3>What it does</h3>
+  <ul>
+    <li>Reads input from <code>msg.payload</code></li>
+    <li>Calls VectorPrime Rank API</li>
+    <li>Returns the ranked decision in <code>msg.payload</code></li>
+  </ul>
+
+  <h3>Best use cases</h3>
+  <ul>
+    <li><b>Incident response:</b> rank alerts by urgency</li>
+    <li><b>Task automation:</b> choose the best next action automatically</li>
+    <li><b>Ops + IoT:</b> prioritize device events and maintenance actions</li>
+    <li><b>Workflows:</b> sort leads, tickets, jobs, or notifications</li>
+  </ul>
+
+  <h3>Input format (example)</h3>
+  <p>Send a list of options to rank inside <code>msg.payload</code>:</p>
+
+  <pre><code>{
+  "items": [
+    { "id": "fix-prod-bug", "label": "Fix production bug", "urgency": 10, "impact": 10 },
+    { "id": "ship-feature", "label": "Ship new feature", "urgency": 7, "impact": 8 },
+    { "id": "refactor", "label": "Refactor module", "urgency": 3, "impact": 5 }
+  ]
+}</code></pre>
+
+  <h3>Output</h3>
+  <p>
+    The response is returned in <code>msg.payload</code> (ranked order + decision result).
+    If your free tier limit is reached, the node may return an <b>upgrade URL</b>.
+  </p>
+
+  <h3>1-Click Example Flow (Import This)</h3>
+  <p>
+    Copy the JSON below, then go to:
+    <br/>
+    <b>Node-RED Menu → Import → Clipboard → Paste → Import</b>
+  </p>
+
+  <pre><code>[
+  {
+    "id": "a111111111111111",
+    "type": "tab",
+    "label": "VectorPrime 1-Click Demo",
+    "disabled": false,
+    "info": ""
+  },
+  {
+    "id": "b111111111111111",
+    "type": "inject",
+    "z": "a111111111111111",
+    "name": "Run VectorPrime Rank (1-click)",
+    "props": [
+      {
+        "p": "payload"
+      }
+    ],
+    "payload": "{\"items\":[{\"id\":\"fix-prod-bug\",\"label\":\"Fix production bug\",\"urgency\":10,\"impact\":10},{\"id\":\"ship-feature\",\"label\":\"Ship new feature\",\"urgency\":7,\"impact\":8},{\"id\":\"refactor\",\"label\":\"Refactor module\",\"urgency\":3,\"impact\":5}]}",
+    "payloadType": "json",
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "x": 220,
+    "y": 160,
+    "wires": [
+      [
+        "c111111111111111"
+      ]
+    ]
+  },
+  {
+    "id": "c111111111111111",
+    "type": "vectorprime-rank",
+    "z": "a111111111111111",
+    "name": "VectorPrime Rank",
+    "config": "d111111111111111",
+    "endpoint": "/v1/kernel/rank",
+    "x": 460,
+    "y": 160,
+    "wires": [
+      [
+        "e111111111111111"
+      ]
+    ]
+  },
+  {
+    "id": "e111111111111111",
+    "type": "debug",
+    "z": "a111111111111111",
+    "name": "VectorPrime Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "payload",
+    "targetType": "msg",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 700,
+    "y": 160,
+    "wires": []
+  },
+  {
+    "id": "d111111111111111",
+    "type": "vectorprime-config",
+    "name": "VectorPrime Config",
+    "baseUrl": "https://vectorprime-kernel-backend.onrender.com"
+  }
+]</code></pre>
+
+  <h3>Advanced tip: override Authorization</h3>
+  <p>
+    If you set <code>msg.headers.Authorization</code> before this node runs, it will use your header instead
+    of the stored key.
+  </p>
 </script>