node-red-contrib-uos-nats 0.1.3 → 0.1.5

package/README.md

@@ -22,7 +22,7 @@ npm install node-red-contrib-uos-nats
 npm install /path/to/local/NATS-NodeRED
 ```
 
-Restart Node-RED. You will find the nodes under the *u-OS Data Hub* category.
+Restart Node-RED. You will find the nodes under the *DataHub-NATS* category.
 
 ## u-OS Config Node
 
@@ -31,15 +31,15 @@ Fields:
 - **Host / Port** – IP address of your controller (e.g. `192.168.10.100`) and the NATS port `49360`.
 - **Client Name** – used for the NATS inbox prefix (`_INBOX.<name>`).
 - **Client ID / Secret** – OAuth2 client credentials created in the Control Center.
-- **Token URL** – optional override, defaults to `https://<host>/oauth2/token`.
 - **Scope** – usually `hub.variables.provide hub.variables.readwrite`.
+- **Granted scopes** – click *Refresh* to query the token endpoint and show the scopes currently granted to that client.
 
-The config node automatically fetches tokens via Client Credentials flow and exposes helper endpoints so other nodes can list providers and variables.
+The config node automatically fetches tokens via Client Credentials flow and exposes helper endpoints so other nodes can list providers and variables. The token endpoint is derived from the configured host (`https://<host>/oauth2/token`), so there is no additional field to maintain.
 
 ## DataHub Input Node
 
-- Select the u-OS config node and enter the provider ID (e.g. `u_os_adm`).
-- Optionally provide a comma-separated list of variable keys (leave empty to receive all).
+- Select the u-OS config node, then choose one of the discovered providers from the dropdown (the node queries `/datahub/v1/providers` for you).
+- Pick the variables you need from the multi-select list. Leave it empty to receive all variables from the provider.
 - The node outputs messages with the structure:
   ```json
   {

package/nodes/datahub-input.html

@@ -5,23 +5,193 @@
     defaults: {
       name: { value: '' },
       connection: { type: 'uos-config', required: true },
-      providerId: { value: 'sampleprovider', required: true },
+      providerId: { value: '', required: true },
       variablesText: { value: '' }
     },
     inputs: 0,
     outputs: 1,
     icon: "white/datahub-input.svg",
     oneditprepare: function() {
-      const help = `
-      <b>DataHub Input node</b><br>
-      <ul>
-        <li><b>u-OS Config</b>: choose the config node with host and OAuth credentials.</li>
-        <li><b>Provider ID</b>: e.g. <code>sampleprovider</code> or <code>u_os_adm</code>.</li>
-        <li><b>Variables</b>: leave empty for all variables or enter comma-separated keys like <code>diagnostics.status_text,diagnostics.error_count</code>.</li>
-      </ul>
-      The node outputs messages of the form <code>{ type: 'snapshot'|'change', variables: [...] }</code>.
-      `;
-      $('#datahub-input-help').html(help);
+      const node = this;
+      const $config = $('#node-input-connection');
+      const $provider = $('#node-input-providerId');
+      const $providerStatus = $('#datahub-provider-status');
+      const $variablesHidden = $('#node-input-variablesText');
+      const $variables = $('#datahub-input-variables');
+      const $variablesStatus = $('#datahub-variables-status');
+
+      const initialProvider = node.providerId;
+      const initialVars = ($variablesHidden.val() || '')
+        .split(',')
+        .map((entry) => entry.trim())
+        .filter((entry) => entry.length > 0);
+
+      const normalizeProviders = (payload) => {
+        if (!payload) {
+          return [];
+        }
+        if (Array.isArray(payload)) {
+          return payload;
+        }
+        if (Array.isArray(payload.providers)) {
+          return payload.providers;
+        }
+        return [];
+      };
+
+      const normalizeVariables = (payload) => {
+        if (!payload) {
+          return [];
+        }
+        if (Array.isArray(payload)) {
+          return payload;
+        }
+        if (Array.isArray(payload.variables)) {
+          return payload.variables;
+        }
+        return [];
+      };
+
+      const providerLabel = (provider) => provider.name || provider.displayName || provider.providerId || provider.id || 'Unnamed provider';
+      const providerValue = (provider) => provider.providerId || provider.id || provider.name || '';
+      const variableValue = (variable) => variable.key || variable.name || variable.path || variable.id || '';
+      const variableLabel = (variable) => variable.tagName || variable.key || variable.name || variable.path || variable.id || 'Unnamed variable';
+
+      const syncVariablesField = () => {
+        const values = $variables.val() || [];
+        $variablesHidden.val(values.join(','));
+      };
+
+      let providerRequest = 0;
+      let variableRequest = 0;
+
+      const setProviderStatus = (text) => $providerStatus.text(text || '');
+      const setVariableStatus = (text) => $variablesStatus.text(text || '');
+
+      const loadVariables = (providerId, keepSelection = false) => {
+        const configId = $config.val();
+        if (!configId || !providerId) {
+          $variables.empty();
+          setVariableStatus('Select a provider to load variables.');
+          return;
+        }
+        const seq = ++variableRequest;
+        setVariableStatus('Loading variables…');
+        $variables.prop('disabled', true);
+        $.getJSON(`uos/providers/${configId}/${encodeURIComponent(providerId)}/variables`)
+          .done((payload) => {
+            if (seq !== variableRequest) {
+              return;
+            }
+            const vars = normalizeVariables(payload);
+            $variables.empty();
+            if (!vars.length) {
+              setVariableStatus('No variables returned. Check Data Hub permissions.');
+              $variables.prop('disabled', true);
+              syncVariablesField();
+              return;
+            }
+            vars.forEach((variable) => {
+              const value = variableValue(variable);
+              if (!value) {
+                return;
+              }
+              const option = $('<option></option>')
+                .attr('value', value)
+                .text(variableLabel(variable));
+              $variables.append(option);
+            });
+            $variables.prop('disabled', false);
+            const preset = keepSelection ? ($variablesHidden.val() || '').split(',').map((entry) => entry.trim()).filter(Boolean) : initialVars;
+            if (preset.length) {
+              $variables.val(preset);
+            }
+            syncVariablesField();
+            setVariableStatus('Select one or multiple variables (Ctrl/Cmd + click). Leave empty to receive all.');
+          })
+          .fail((xhr) => {
+            const msg = xhr?.responseJSON?.error || xhr.statusText || 'Failed to load variables.';
+            setVariableStatus(msg);
+            $variables.prop('disabled', true);
+            $variables.empty();
+            syncVariablesField();
+          });
+      };
+
+      const loadProviders = () => {
+        const configId = $config.val();
+        if (!configId) {
+          $provider.empty();
+          $provider.append('<option value="">Select a u-OS config first</option>');
+          $provider.prop('disabled', true);
+          setProviderStatus('Pick or create a u-OS config node before selecting a provider.');
+          setVariableStatus('');
+          $variables.empty();
+          $variables.prop('disabled', true);
+          return;
+        }
+        const seq = ++providerRequest;
+        setProviderStatus('Loading providers…');
+        $provider.prop('disabled', true);
+        $.getJSON(`uos/providers/${configId}`)
+          .done((payload) => {
+            if (seq !== providerRequest) {
+              return;
+            }
+            const list = normalizeProviders(payload);
+            $provider.empty();
+            if (!list.length) {
+              $provider.append('<option value="">No providers available</option>');
+              setProviderStatus('No providers returned. Verify Data Hub access.');
+              $provider.prop('disabled', true);
+              return;
+            }
+            list.forEach((prov) => {
+              const value = providerValue(prov);
+              if (!value) {
+                return;
+              }
+              const option = $('<option></option>')
+                .attr('value', value)
+                .text(providerLabel(prov));
+              $provider.append(option);
+            });
+            $provider.prop('disabled', false);
+            if (initialProvider) {
+              $provider.val(initialProvider);
+            }
+            if (!$provider.val()) {
+              $provider.val($provider.find('option:first').attr('value'));
+            }
+            setProviderStatus('Choose the provider you want to subscribe to.');
+            loadVariables($provider.val());
+          })
+          .fail((xhr) => {
+            const msg = xhr?.responseJSON?.error || xhr.statusText || 'Failed to load providers.';
+            $provider.empty();
+            $provider.append('<option value="">Unable to load providers</option>');
+            $provider.prop('disabled', true);
+            setProviderStatus(msg);
+          });
+      };
+
+      $variables.on('change', () => {
+        syncVariablesField();
+      });
+
+      $provider.on('change', () => {
+        $variablesHidden.val('');
+        syncVariablesField();
+        loadVariables($provider.val(), false);
+      });
+
+      $config.on('change', () => {
+        loadProviders();
+      });
+
+      syncVariablesField();
+      // Delay provider loading slightly to ensure the config typedInput is ready.
+      setTimeout(() => loadProviders(), 100);
     },
     label: function () {
       return this.name || `Input ${this.providerId || ''}`;
@@ -32,20 +202,51 @@
   });
 </script>
 
-<div class="form-row">
-  <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
-  <input type="text" id="node-input-name">
-</div>
-<div class="form-row">
-  <label for="node-input-connection"><i class="fa fa-cube"></i> u-OS Config</label>
-  <input type="text" id="node-input-connection">
-</div>
-<div class="form-row">
-  <label for="node-input-providerId"><i class="fa fa-id-badge"></i> Provider ID</label>
-  <input type="text" id="node-input-providerId" placeholder="sampleprovider">
-</div>
-<div class="form-row">
-  <label for="node-input-variablesText"><i class="fa fa-list"></i> Variables (comma separated)</label>
-  <input type="text" id="node-input-variablesText" placeholder="diagnostics.status_text,diagnostics.error_count">
-</div>
-<div id="datahub-input-help" class="form-tips"></div>
+<script type="text/html" data-template-name="datahub-input">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name">
+  </div>
+  <div class="form-row">
+    <label for="node-input-connection"><i class="fa fa-cube"></i> u-OS Config</label>
+    <input type="text" id="node-input-connection">
+  </div>
+  <div class="form-row">
+    <label for="node-input-providerId"><i class="fa fa-id-badge"></i> Provider</label>
+    <select id="node-input-providerId"></select>
+  </div>
+  <div class="form-row">
+    <label></label>
+    <div id="datahub-provider-status" class="form-tips"></div>
+  </div>
+  <div class="form-row">
+    <label for="datahub-input-variables"><i class="fa fa-list"></i> Variables</label>
+    <div style="flex:1;">
+      <select id="datahub-input-variables" multiple size="6" style="width:100%;"></select>
+      <input type="hidden" id="node-input-variablesText">
+    </div>
+  </div>
+  <div class="form-row">
+    <label></label>
+    <div id="datahub-variables-status" class="form-tips">Leave empty to listen to every variable.</div>
+  </div>
+</script>
+
+<script type="text/html" data-help-name="datahub-input">
+  <p><strong>DataHub Input</strong> subscribes to a provider via the u-OS Data Hub and emits JSON messages.</p>
+  <dl>
+    <dt>u-OS Config</dt>
+    <dd>Pick the connection node that holds host, port and OAuth credentials.</dd>
+    <dt>Provider ID</dt>
+    <dd>Provider to read. The drop-down lists every provider returned by the Control Center REST API.</dd>
+    <dt>Variables</dt>
+    <dd>Select one or more variable keys (single/multi-select). Leave unselected to stream all variables from the provider.</dd>
+  </dl>
+  <p>Each message has <code>msg.payload</code> shaped like:</p>
+<pre>{
+  "type": "snapshot" | "change",
+  "variables": [
+    { "name": "diagnostics.status_text", "value": "ready" }
+  ]
+}</pre>
+</script>

package/nodes/datahub-output.html

@@ -10,17 +10,7 @@
     inputs: 1,
     outputs: 1,
     icon: "white/datahub-output.svg",
-    oneditprepare: function() {
-      const help = `
-      <b>DataHub Output node</b><br>
-      <ul>
-        <li><b>u-OS Config</b>: select the config node.</li>
-        <li><b>Provider ID</b>: defaults to <code>nodered</code> (will be registered automatically).</li>
-      </ul>
-      Send any JSON payload → nested objects become dot-separated keys (e.g. <code>{ diagnostics: { status_text: 'ok' } }</code> ⇢ <code>diagnostics.status_text</code>).
-      `;
-      $('#datahub-output-help').html(help);
-    },
+    oneditprepare: function() {},
     label: function () {
       return this.name || `Output ${this.providerId || ''}`;
     },
@@ -30,16 +20,35 @@
   });
 </script>
 
-<div class="form-row">
-  <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
-  <input type="text" id="node-input-name">
-</div>
-<div class="form-row">
-  <label for="node-input-connection"><i class="fa fa-cube"></i> u-OS Config</label>
-  <input type="text" id="node-input-connection">
-</div>
-<div class="form-row">
-  <label for="node-input-providerId"><i class="fa fa-id-badge"></i> Provider ID</label>
-  <input type="text" id="node-input-providerId" placeholder="nodered">
-</div>
-<div id="datahub-output-help" class="form-tips"></div>
+<script type="text/html" data-template-name="datahub-output">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name">
+  </div>
+  <div class="form-row">
+    <label for="node-input-connection"><i class="fa fa-cube"></i> u-OS Config</label>
+    <input type="text" id="node-input-connection">
+  </div>
+  <div class="form-row">
+    <label for="node-input-providerId"><i class="fa fa-id-badge"></i> Provider ID</label>
+    <input type="text" id="node-input-providerId" placeholder="nodered">
+  </div>
+</script>
+
+<script type="text/html" data-help-name="datahub-output">
+  <p><strong>DataHub Output</strong> registers (if needed) and writes variables for the provider you specify.</p>
+  <dl>
+    <dt>u-OS Config</dt>
+    <dd>Connection node with host/port and OAuth credentials.</dd>
+    <dt>Provider ID</dt>
+    <dd>Defaults to <code>nodered</code>; change it if you want to publish under another provider name.</dd>
+  </dl>
+  <p>Send a JSON object as <code>msg.payload</code>. Nested objects are flattened using dot-notation:</p>
+<pre>{
+  "diagnostics": {
+    "status_text": "running",
+    "error_count": 0
+  }
+}</pre>
+  <p>becomes variables <code>diagnostics.status_text</code> and <code>diagnostics.error_count</code> in the Data Hub.</p>
+</script>

package/nodes/uos-config.html

@@ -2,10 +2,9 @@
   RED.nodes.registerType('uos-config', {
     category: 'config',
     defaults: {
-      host: { value: '192.168.10.100', required: true },
+      host: { value: '127.0.0.1', required: true },
       port: { value: 49360, required: true, validate: RED.validators.number() },
       clientName: { value: 'nodered', required: true },
-      tokenEndpoint: { value: '', required: false },
       scope: { value: 'hub.variables.provide hub.variables.readwrite', required: true },
     },
     credentials: {
@@ -15,34 +14,95 @@
     label: function () {
       return this.clientName ? `u-OS ${this.clientName}` : 'u-OS NATS';
     },
+    oneditprepare: function() {
+      const node = this;
+      const $scopeDisplay = $('#uos-scope-display');
+      const $scopeSpinner = $('#uos-scope-spinner');
+      const $refresh = $('#uos-scope-refresh');
+      const updateDisplay = (text, cls = '') => {
+        $scopeDisplay.text(text);
+        $scopeDisplay.removeClass('form-tips-warning form-tips-error');
+        if (cls) {
+          $scopeDisplay.addClass(cls);
+        }
+      };
+      const fetchScopes = () => {
+        const configId = node.id;
+        if (!configId || !node.credentials || !node.credentials.clientId) {
+          updateDisplay('Save credentials and deploy to fetch granted scopes.');
+          return;
+        }
+        $scopeSpinner.show();
+        $.getJSON(`uos/oauth-scopes/${configId}`)
+          .done((data) => {
+            if (data && data.scope) {
+              updateDisplay(data.scope);
+            }
+            else {
+              updateDisplay('The client did not return a scope string.');
+            }
+          })
+          .fail((xhr) => {
+            const msg = xhr?.responseJSON?.error || xhr.statusText || 'Could not read scopes';
+            updateDisplay(msg);
+          })
+          .always(() => {
+            $scopeSpinner.hide();
+          });
+      };
+      $refresh.on('click', function (evt) {
+        evt.preventDefault();
+        fetchScopes();
+      });
+      if (node.credentials && node.credentials.clientId) {
+        fetchScopes();
+      }
+    },
   });
 </script>
 
-<div class="form-row">
-  <label for="node-config-input-host"><i class="fa fa-globe"></i> Host</label>
-  <input type="text" id="node-config-input-host" placeholder="127.0.0.1">
-</div>
-<div class="form-row">
-  <label for="node-config-input-port"><i class="fa fa-plug"></i> Port</label>
-  <input type="number" id="node-config-input-port">
-</div>
-<div class="form-row">
-  <label for="node-config-input-clientName"><i class="fa fa-user"></i> Client Name</label>
-  <input type="text" id="node-config-input-clientName" placeholder="nodered">
-</div>
-<div class="form-row">
-  <label for="node-config-input-clientId"><i class="fa fa-id-card"></i> Client ID</label>
-  <input type="text" id="node-config-input-clientId">
-</div>
-<div class="form-row">
-  <label for="node-config-input-clientSecret"><i class="fa fa-key"></i> Client Secret</label>
-  <input type="password" id="node-config-input-clientSecret">
-</div>
-<div class="form-row">
-  <label for="node-config-input-tokenEndpoint"><i class="fa fa-lock"></i> Token URL</label>
-  <input type="text" id="node-config-input-tokenEndpoint" placeholder="https://HOST/oauth2/token">
-</div>
-<div class="form-row">
-  <label for="node-config-input-scope"><i class="fa fa-list"></i> Scope</label>
-  <input type="text" id="node-config-input-scope">
-</div>
+<script type="text/html" data-template-name="uos-config">
+  <div class="form-row">
+    <label for="node-config-input-host"><i class="fa fa-globe"></i> Host</label>
+    <input type="text" id="node-config-input-host" placeholder="127.0.0.1">
+  </div>
+  <div class="form-row">
+    <label for="node-config-input-port"><i class="fa fa-plug"></i> Port</label>
+    <input type="number" id="node-config-input-port">
+  </div>
+  <div class="form-row">
+    <label for="node-config-input-clientName"><i class="fa fa-user"></i> Client Name</label>
+    <input type="text" id="node-config-input-clientName" placeholder="nodered">
+  </div>
+  <div class="form-row">
+    <label for="node-config-input-clientId"><i class="fa fa-id-card"></i> Client ID</label>
+    <input type="text" id="node-config-input-clientId">
+  </div>
+  <div class="form-row">
+    <label for="node-config-input-clientSecret"><i class="fa fa-key"></i> Client Secret</label>
+    <input type="password" id="node-config-input-clientSecret">
+  </div>
+  <div class="form-row">
+    <label for="node-config-input-scope"><i class="fa fa-list"></i> Scope</label>
+    <input type="text" id="node-config-input-scope">
+  </div>
+  <div class="form-row">
+    <label><i class="fa fa-info-circle"></i> Granted scopes</label>
+    <div style="display:flex; align-items:center; gap:0.5rem;">
+      <button class="red-ui-button" id="uos-scope-refresh" type="button">Refresh</button>
+      <span id="uos-scope-display" class="form-tips">Save first to query granted scopes.</span>
+      <span id="uos-scope-spinner" class="fa fa-spinner fa-spin" style="display:none;"></span>
+    </div>
+  </div>
+</script>
+
+<script type="text/html" data-help-name="uos-config">
+  <p><strong>u-OS Config</strong> stores the shared connection settings for all DataHub nodes.</p>
+  <ul>
+    <li><strong>Host / Port</strong> – IP and NATS port of the controller (default <code>127.0.0.1:49360</code>).</li>
+    <li><strong>Client Name</strong> – Friendly identifier used in NATS connection logs.</li>
+    <li><strong>Client ID / Secret</strong> – OAuth credentials from your u-OS Control Center client.</li>
+    <li><strong>Token URL</strong> – Optional; defaults to <code>https://&lt;Host&gt;/oauth2/token</code> if left empty.</li>
+    <li><strong>Scope</strong> – Space separated scopes; e.g. <code>hub.variables.provide hub.variables.readwrite</code>.</li>
+  </ul>
+</script>

package/nodes/uos-config.js

@@ -14,7 +14,6 @@ module.exports = function (RED) {
     this.port = Number(config.port) || 49360;
     this.clientName = config.clientName || 'nodered';
     this.scope = config.scope || 'hub.variables.provide hub.variables.readwrite';
-    this.tokenEndpoint = config.tokenEndpoint || `https://${this.host}/oauth2/token`;
     this.clientId = this.credentials.clientId;
     this.clientSecret = this.credentials.clientSecret;
     this.tokenInfo = null;
@@ -37,7 +36,8 @@ module.exports = function (RED) {
         scope: this.scope,
       });
       const basic = Buffer.from(`${this.clientId}:${this.clientSecret}`).toString('base64');
-      const res = await fetch(this.tokenEndpoint, {
+      const tokenEndpoint = `https://${this.host}/oauth2/token`;
+      const res = await fetch(tokenEndpoint, {
         method: 'POST',
         headers: {
           Authorization: `Basic ${basic}`,
@@ -57,6 +57,7 @@ module.exports = function (RED) {
       this.tokenInfo = {
         token: json.access_token,
         expiresAt: now + ((json.expires_in || 3600) * 1000),
+        grantedScope: json.scope || this.scope,
       };
       return this.tokenInfo.token;
     };
@@ -80,6 +81,11 @@ module.exports = function (RED) {
       return this.nc;
     };
 
+    this.getGrantedScopes = async () => {
+      await this.getToken();
+      return this.tokenInfo?.grantedScope || '';
+    };
+
     this.fetchProviders = async () => {
       const token = await this.getToken();
       const res = await fetch(`https://${this.host}/datahub/v1/providers`, {
@@ -162,6 +168,20 @@ module.exports = function (RED) {
         res.status(500).json({ error: err.message });
       }
     });
+    RED.httpAdmin.get('/uos/oauth-scopes/:id', async (req, res) => {
+      const node = RED.nodes.getNode(req.params.id);
+      if (!node) {
+        res.status(404).json({ error: 'config not found' });
+        return;
+      }
+      try {
+        const scope = await node.getGrantedScopes();
+        res.json({ scope });
+      }
+      catch (err) {
+        res.status(500).json({ error: err.message });
+      }
+    });
   }
 
   RED.nodes.registerType('uos-config', UosConfigNode, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-uos-nats",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Node-RED nodes for u-OS Data Hub via NATS",
   "repository": {
     "type": "git",