@theotherwillembotha/node-red-plugincore 0.0.50 → 0.0.52

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@theotherwillembotha/node-red-plugincore",
-  "version": "0.0.50",
-  "description": "A TypeScript framework for building production-grade Node-RED plugins, with built-in logging, Prometheus metrics, and webhook support.",
+  "version": "0.0.52",
+  "description": "A core framework for building production-grade Node-RED plugins, with built-in support for structured logging, metrics, and webhook ingestion.",
   "author": "Willem Botha (@theotherwillembotha)",
   "license": "ISC",
   "keywords": [
-    "node-red", "logging", "metrics", "webhook", "reverseproxy"
+    "node-red",
+    "logging",
+    "metrics",
+    "webhook",
+    "reverseproxy"
   ],
   "main": "./build/index.js",
   "exports": "./build/index.js",
@@ -20,13 +24,20 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/theotherwillembotha/nodered_plugincore.git"
+    "url": "git+https://github.com/theotherwillembotha/nodered_plugincore.git"
   },
   "bugs": {
     "url": "https://github.com/theotherwillembotha/nodered_plugincore/issues"
   },
   "types": "./build/index.d.ts",
-  "files": ["build/", "src/", "icons/", "LICENSE", "README.md"],
+  "files": [
+    "build/",
+    "src/",
+    "icons/",
+    "documentation/",
+    "LICENSE",
+    "README.md"
+  ],
   "homepage": "https://github.com/theotherwillembotha/nodered_plugincore#readme",
   "engines": {
     "node": ">=18",
@@ -35,7 +46,7 @@
   "devDependencies": {
     "@types/deep-equal": "^1.0.4",
     "@types/js-beautify": "^1.14.3",
-    "@types/jsdom": "^21.1.7",
+    "@types/jsdom": "^28.0.3",
     "@types/markdown-it": "^14.1.2",
     "@types/node": "^22.15.29",
     "@types/node-red": "~1.3.5",
@@ -47,16 +58,17 @@
     "express": "^5.1.0",
     "handlebars": "^4.7.8",
     "js-beautify": "^1.15.4",
-    "jsdom": "^26.1.0",
+    "jsdom": "^29.1.1",
     "markdown-it": "^14.1.0",
     "network": "^0.7.0",
     "prom-client": "^15.1.3",
     "reflect-metadata": "^0.2.2",
-    "whatwg-url": "^14.2.0",
+    "whatwg-url": "^16.0.1",
     "winston": "^3.17.0",
     "winston-loki": "^6.1.3"
   },
   "node-red": {
+    "version": ">=4.0.0",
     "nodes": {
       "core": "./build/Nodes.js"
     },

package/src/GenerateNodes.ts

@@ -1,9 +1,10 @@
 
+import { DelegatedConfigReferenceNode } from "./core/other/node/DelegatedConfigReferenceNode.js";
 import { NodeTypeService } from "./core/tagging/service/NodeTypeService.js";
-import { NodeGenerator, SettingsService, BasicTemplate, SettingsTemplate, TimerMetricTemplate, ConsoleLoggerConfigNode, RestLoggerConfigNode, LokiLoggerConfigNode } from "./index.js"
+import { NodeGenerator, SettingsService, BasicTemplate, SettingsTemplate, TimerMetricTemplate, ConsoleLoggerConfigNode, RestLoggerConfigNode, LokiLoggerConfigNode, UIHelperTemplate } from "./index.js"
 import { WebhookServerConfigNode, WebhookServerService, WebhookTemplate,  } from "./index.js"
 
-import {LoggerService, LoggerTemplate, LoggerConfigNode } from "./index.js";
+import {LoggerService, LoggerTemplate } from "./index.js";
 
 import { MetricsService, MetricsTemplate, CounterMetricTemplate, GaugeMetricTemplate} from "./index.js";
 import { MetricsConfigNode, GaugeMetricConfigNode, TimerMetricConfigNode, CounterMetricConfigNode } from "./index.js";
@@ -25,8 +26,10 @@ new NodeGenerator("./src/core/")
     .registerTemplate(GaugeMetricTemplate)
     .registerTemplate(TimerMetricTemplate)
     .registerTemplate(WebhookTemplate)
+    .registerTemplate(UIHelperTemplate)
 
     // nodes
+    .registerNode(DelegatedConfigReferenceNode)
     .registerNode(ConsoleLoggerConfigNode)
     .registerNode(RestLoggerConfigNode)
     .registerNode(LokiLoggerConfigNode)

package/src/core/NodeConstructor.ts

@@ -79,15 +79,17 @@ export type NodeDependencyType = INamedType & (INodeClass | IServiceClass);
 
 export class NodeDescriptor {
     private _group:string;
-    private _name:string;
+    private _id:string;
+    private _name:String;
     private _sourceFile: string;
     private _dependencies: DependencyType[] = []
     private _templates:{template:ITemplateClass, config:TemplateConfig}[] = [];
     private _package: string;
     private _tags: string[] = [];
 
-    constructor(group:string, name:string, sourceFile:string, pkg:string){
+    constructor(group:string, id:string, name:string, sourceFile:string, pkg:string){
         this._group = group;
+        this._id = id;
         this._name = name;
         this._sourceFile = sourceFile;
         this._package = pkg;
@@ -114,6 +116,7 @@ export class NodeDescriptor {
     }
 
     public group(){ return  this._group; }
+    public id(){ return this._id; }
     public name(){ return this._name; }
     public sourceFile() { return this._sourceFile; }
     public package() { return this._package; }
@@ -857,7 +860,7 @@ let evalInContext = (context: any, js: string) => {
 let buildNode = function(node:INodeClass){
     // get the node descriptor and create the builder.
     let nodeDescriptor = node.getNodeDescriptor();
-    let nodeBuilder = new NodeBuilder(nodeDescriptor.name(), nodeDescriptor.group());
+    let nodeBuilder = new NodeBuilder(nodeDescriptor.id(), nodeDescriptor.group());
 
     // load the html source file
     let uiDom = new JSDOM(fs.readFileSync(nodeDescriptor.sourceFile()));
@@ -873,7 +876,7 @@ let buildNode = function(node:INodeClass){
     Object.values(sections).forEach(section => {
         let sectionData = uiDom.window.document.querySelector(`[template-section='on${section}']`)?.innerHTML;
         if(sectionData){
-            (nodeBuilder as any)[`add${section}`](nodeDescriptor.name(), sectionData);
+            (nodeBuilder as any)[`add${section}`](nodeDescriptor.id(), sectionData);
         }
     });
 

package/src/core/NodeGenerator.ts

@@ -76,8 +76,8 @@ class NodeGenerator {
         try{
             // verify that we have dont already have this node.
             let descriptor = node.getNodeDescriptor();
-            if(!this._nodes[descriptor.name()]){
-                this._nodes[descriptor.name()] = {nodeClass:node, descriptor:descriptor};
+            if(!this._nodes[descriptor.id()]){
+                this._nodes[descriptor.id()] = {nodeClass:node, descriptor:descriptor};
                 // skip the recursive dependencies for now.
                 //descriptor.dependencies().forEach(dependency => this.addDependency(dependency));
             }
@@ -117,7 +117,7 @@ class NodeGenerator {
         // STEP 2. compose the HTMLStructure of each of the nodes.
         let nodeHTMLOutut = Object.values(this._nodes)
             .map(node => {
-                console.log(`Processing node: ${node.descriptor.name()}`);
+                console.log(`Processing node: ${node.descriptor.id()}`);
 
                 return buildNode(node.nodeClass);
             })
@@ -136,7 +136,7 @@ ${nodeHTMLOutut}
         // 1. get a list of the files to import.
         let importList = [
             ...Object.values(this._nodes).map(node => {
-                return `const ${node.descriptor.name()} = require("${node.descriptor.package()}").${node.descriptor.name()};`;
+                return `const ${node.descriptor.id()} = require("${node.descriptor.package()}").${node.descriptor.id()};`;
                 //let nodeFile = "./" + node.group() + "/" + node.sourceFile();
                 //return `const ${node.name()} = require("${nodeFile}");`;
             }),
@@ -145,7 +145,7 @@ ${nodeHTMLOutut}
 
         // 2. get the exported modules that have to be regestered by the node manager.
         let moduleExports = Object.values(this._nodes).map(node => {
-            return `    manager.registerNodeType("${node.descriptor.name()}", ${node.descriptor.name()});`;
+            return `    manager.registerNodeType("${node.descriptor.id()}", ${node.descriptor.id()});`;
         }).join("\n");
 
         fs.writeFileSync(nodesOutputFile + ".js", `
@@ -162,7 +162,7 @@ ${moduleExports}
         
         `);
 
-        console.log(`Done building ${Object.keys(this._nodes).length} nodes\n${Object.values(this._nodes).map(node => " - " + node.descriptor.name() + "\n").join("")}\n`);
+        console.log(`Done building ${Object.keys(this._nodes).length} nodes\n${Object.values(this._nodes).map(node => " - " + node.descriptor.id() + "\n").join("")}\n`);
 
         let serviceExports = this._services.map(service => {
             return `    manager.registerService(${service.name()}.${service.name()});`
@@ -243,10 +243,10 @@ module.exports = function (RED) {
     }
 
     private static generateHeader(node:NodeDescriptor){
-        let padding = ' '.repeat(Math.max(0, Math.floor(NodeGenerator.headerWidth - node.name().length)/2 ));
+        let padding = ' '.repeat(Math.max(0, Math.floor(NodeGenerator.headerWidth - node.id().length)/2 ));
         return `
 <!-- *${'*'.repeat(NodeGenerator.headerWidth)}* -->
-<!-- ${padding} ${node.name()} ${padding}  -->
+<!-- ${padding} ${node.id()} ${padding}  -->
 <!-- *${'*'.repeat(NodeGenerator.headerWidth)}* -->
 `;
     }

package/src/core/logger/node/ConsoleLoggerConfigNode.html

@@ -46,86 +46,45 @@
 <script type="text/html" template-section="onIncludeEditForm">
 <div id="LoggerConfig">
     <div class="form-row">
-        <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
+        <label class="towb_editorlabel" for="node-config-input-name"><i class="fa fa-font"></i> Name</label>
         <input type="text" id="node-config-input-name" />
     </div>
 
     <div class="form-row">
-        <label for="node-config-input-level"><i class="fa fa-tag"></i> Level</label>
+        <label class="towb_editorlabel" for="node-config-input-level"><i class="fa fa-signal"></i> Level</label>
         <input type="text" id="node-config-input-level" />
     </div>
 
     <div class="form-row">
-        <label for="node-config-input-templateEditor"><i class="fa fa-tag"></i> Template</label>
+        <label class="towb_editorlabel" for="node-config-input-templateEditor"><i class="fa fa-code"></i> Template</label>
         <div style="height: 250px; min-height:150px;" class="node-text-editor" id="node-config-input-templateEditor"></div>
     </div>
 </div>
 </script>
 
 <script type="text/markdown" template-section="onIncludeDocumentation">
-Configuration node for the Logger Integration
+Writes log output to the Node-RED runtime console (stdout). Suitable for local development and containerised environments where stdout is captured.
 
-## Inputs
-: *name*    (string)    : The common name for the logger Configuration
-: *level*   (level)     : The logging level - debug, info, warning, error
-: *platform*(string)    : The common name for the logger Configuration
-: *template*(mustache)  : A template for the log messages.
+### Properties
+: *name*        (string)    : A descriptive name for this logger configuration.
+: *level*       (level)     : The minimum log level. Messages below this threshold are suppressed. Options: DEBUG, INFO, WARNING, ERROR.
+: *template*    (mustache)  : A Mustache/Handlebars template that formats the log message body.
 
-## Logger platform
-Currently supported logging platforms
+### Mustache Templating
+Mustache/Handlebars templates build the message string written to the console.
 
-### Console
-The log message will be printed out to stdio
+#### Provided Properties
+: *msg*         (object)    : The Node-RED message object passed through the node.
+: *currentTime* (string)    : The current time in ISO 8601 format.
 
-### Http / Https
-Publish the message to an http endpoint using a http / https POST command.
+#### Helpers
+: *json*        (helper)    : Serialises an object to a JSON string using `JSON.stringify`.
 
-: *url*                 (url)           : The endpoint for the url where requests are to be posted to.
-: *ignore ssl errors*   (boolean)       : If enabled, the invalid ssl certificates will be ignored.
-: *authentication*      (auth method)   : what auth method should be used for the http request. (none, basic, api key)
+#### Examples
+- `{{{json msg}}}` — serialises the full message object as JSON.
 
-#### Authentication
-##### Basic
-Provides basic authentication using the Authorization header 
-
-: *username*    (string) : the username used for basic authentication
-: *password*    (string) : the password used for basic authentication
-
-##### APIKey
-Provides authentication using a matrix parameter, header or query parameter and an apikey
-
-: *mechanism*   (mechanism) : the mechanism that will be used for transmitting the key (header, queryparam, matrixparam)
-: *apikey name* (string)    : the name of the key used for api authentication. (path variable or query param name)
-: *apikey value*(string)    : the value of the api key that will be transmitted. (beware of special characters)
-
-### Loki
-Publish the message to a loki endpoint.
-
-: *host*        (string) : the host and port\ of the loki instance that it being logged to
-: *tenant*      (string) : the tenant id that will be used to log to
-: *username*    (string) : the username for the loki instance.
-: *authtoken*   (string) : the authtoken for the loki instance.
-
-# Mustache Templating
-Mustache / Handlebars are used for building up the logged message payloads that are sent to the logging backend.
-The resultant message will be interpreted as a string, meaning care should be taken in the event that a string representation of a json object is built.
-
-### Provided Properties
-A couple of values are provided to the logging context by default.
-
-: *msg*         (object)    : an object containing the payload or message that should be parsed through the template.
-: *currentTime* (object)    : a string containing the current time in ISO8601 format
-
-### Mustache Helpers
-In addition to the provided properties, some "helpers" have also been provided to assist in serialization.
-
-: *json*        (helper)    : converts a json object to a string using the JSON.stringify method.
-
-## Examples
-- {{{json msg}}} - serializes the the msg object to json format.
-
-# References
-- [Mustache - Wikipedia](https://en.wikipedia.org/wiki/Mustache_(template_system))
-- [Mustache - Playground](https://jgonggrijp.gitlab.io/wontache/playground.html)
+#### References
+- [Mustache — Wikipedia](https://en.wikipedia.org/wiki/Mustache_(template_system))
+- [Mustache — Playground](https://jgonggrijp.gitlab.io/wontache/playground.html)
 </script>
 

package/src/core/logger/node/LokiLoggerConfigNode.html

@@ -6,7 +6,7 @@
         .addDefault("level", {value:"info", required:true})
 
         .addDefault("loki_host", {})
-        .addDefault("loki_tenantID", {})
+        .addDefault("loki_tenantid", {})
         .addDefault("loki_userid", {})
         .addDefault("loki_authtoken", {})
 
@@ -51,103 +51,67 @@
 <script type="text/html" template-section="onIncludeEditForm">
 <div id="LoggerConfig">
     <div class="form-row">
-        <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
+        <label class="towb_editorlabel" for="node-config-input-name"><i class="fa fa-font"></i> Name</label>
         <input type="text" id="node-config-input-name" />
     </div>
 
     <div class="form-row">
-        <label for="node-config-input-level"><i class="fa fa-tag"></i> Level</label>
+        <label class="towb_editorlabel" for="node-config-input-level"><i class="fa fa-signal"></i> Level</label>
         <input type="text" id="node-config-input-level" />
     </div>
 
     <div class="form-row">
-        <label for="node-config-input-loki_host"><i class="fa fa-tag"></i> Host</label>
+        <label class="towb_editorlabel" for="node-config-input-loki_host"><i class="fa fa-server"></i> Host</label>
         <input class="required" type="text" id="node-config-input-loki_host" />
     </div>
     <div class="form-row">
-        <label for="node-config-input-loki_tenantID"><i class="fa fa-tag"></i> TenantID</label>
-        <input class="" type="text" id="node-config-input-loki_tenantID" />
+        <label class="towb_editorlabel" for="node-config-input-loki_tenantid"><i class="fa fa-building-o"></i> Tenant ID</label>
+        <input class="" type="text" id="node-config-input-loki_tenantid" />
     </div>
     <div class="form-row">
-        <label for="node-config-input-loki_userid"><i class="fa fa-tag"></i> Username</label>
+        <label class="towb_editorlabel" for="node-config-input-loki_userid"><i class="fa fa-user"></i> Username</label>
         <input class="" type="text" id="node-config-input-loki_userid" />
     </div>
     <div class="form-row">
-        <label for="node-config-input-loki_authtoken"><i class="fa fa-tag"></i> AuthToken</label>
+        <label class="towb_editorlabel" for="node-config-input-loki_authtoken"><i class="fa fa-key"></i> Auth Token</label>
         <input class="" type="password" id="node-config-input-loki_authtoken" />
     </div>
 
     <div class="form-row">
-        <label for="node-config-input-templateEditor"><i class="fa fa-tag"></i> Template</label>
+        <label class="towb_editorlabel" for="node-config-input-templateEditor"><i class="fa fa-code"></i> Template</label>
         <div style="height: 250px; min-height:150px;" class="node-text-editor" id="node-config-input-templateEditor"></div>
     </div>
 </div>
 </script>
 
 <script type="text/markdown" template-section="onIncludeDocumentation">
-Configuration node for the Logger Integration
-
-## Inputs
-: *name*    (string)    : The common name for the logger Configuration
-: *level*   (level)     : The logging level - debug, info, warning, error
-: *platform*(string)    : The common name for the logger Configuration
-: *template*(mustache)  : A template for the log messages.
-
-## Logger platform
-Currently supported logging platforms
-
-### Console
-The log message will be printed out to stdio
-
-### Http / Https
-Publish the message to an http endpoint using a http / https POST command.
-
-: *url*                 (url)           : The endpoint for the url where requests are to be posted to.
-: *ignore ssl errors*   (boolean)       : If enabled, the invalid ssl certificates will be ignored.
-: *authentication*      (auth method)   : what auth method should be used for the http request. (none, basic, api key)
-
-#### Authentication
-##### Basic
-Provides basic authentication using the Authorization header 
-
-: *username*    (string) : the username used for basic authentication
-: *password*    (string) : the password used for basic authentication
-
-##### APIKey
-Provides authentication using a matrix parameter, header or query parameter and an apikey
-
-: *mechanism*   (mechanism) : the mechanism that will be used for transmitting the key (header, queryparam, matrixparam)
-: *apikey name* (string)    : the name of the key used for api authentication. (path variable or query param name)
-: *apikey value*(string)    : the value of the api key that will be transmitted. (beware of special characters)
-
-### Loki
-Publish the message to a loki endpoint.
-
-: *host*        (string) : the host and port\ of the loki instance that it being logged to
-: *tenant*      (string) : the tenant id that will be used to log to
-: *username*    (string) : the username for the loki instance.
-: *authtoken*   (string) : the authtoken for the loki instance.
-
-# Mustache Templating
-Mustache / Handlebars are used for building up the logged message payloads that are sent to the logging backend.
-The resultant message will be interpreted as a string, meaning care should be taken in the event that a string representation of a json object is built.
-
-### Provided Properties
-A couple of values are provided to the logging context by default.
-
-: *msg*         (object)    : an object containing the payload or message that should be parsed through the template.
-: *currentTime* (object)    : a string containing the current time in ISO8601 format
-
-### Mustache Helpers
-In addition to the provided properties, some "helpers" have also been provided to assist in serialization.
-
-: *json*        (helper)    : converts a json object to a string using the JSON.stringify method.
-
-## Examples
-- {{{json msg}}} - serializes the the msg object to json format.
-
-# References
-- [Mustache - Wikipedia](https://en.wikipedia.org/wiki/Mustache_(template_system))
-- [Mustache - Playground](https://jgonggrijp.gitlab.io/wontache/playground.html)
+Pushes log messages to a Grafana Loki instance using the Loki HTTP API.
+
+### Properties
+: *name*        (string)    : A descriptive name for this logger configuration.
+: *level*       (level)     : The minimum log level. Messages below this threshold are suppressed. Options: DEBUG, INFO, WARNING, ERROR.
+: *host*        (string)    : The base URL of the Loki instance, including port (e.g. `http://localhost:3100`).
+: *tenant ID*   (string)    : The tenant identifier for multi-tenant Loki deployments (`X-Scope-OrgID` header). Leave blank for single-tenant deployments.
+: *username*    (string)    : Username for Loki authentication.
+: *auth token*  (string)    : Authentication token or password for Loki.
+: *template*    (mustache)  : A Mustache/Handlebars template that formats the log message body.
+
+### Mustache Templating
+Mustache/Handlebars templates build the message string pushed to Loki.
+
+#### Provided Properties
+: *msg*         (object)    : The Node-RED message object passed through the node.
+: *currentTime* (string)    : The current time in ISO 8601 format.
+
+#### Helpers
+: *json*        (helper)    : Serialises an object to a JSON string using `JSON.stringify`.
+
+#### Examples
+- `{{{json msg}}}` — serialises the full message object as JSON.
+
+#### References
+- [Grafana Loki — HTTP API](https://grafana.com/docs/loki/latest/reference/loki-http-api/)
+- [Mustache — Wikipedia](https://en.wikipedia.org/wiki/Mustache_(template_system))
+- [Mustache — Playground](https://jgonggrijp.gitlab.io/wontache/playground.html)
 </script>
 

package/src/core/logger/node/LokiLoggerConfigNode.ts

@@ -15,7 +15,7 @@ interface LokiLoggerConfigNodeConfig extends ConfigNodeConfig {
     loki_host:string,
     loki_userid?:string,
     loki_authtoken?:string,
-    loki_tenantID?:string
+    loki_tenantid?:string
 }
 
 @NodeDescription({
@@ -46,7 +46,7 @@ export class LokiLoggerConfigNode extends ConfigNode<LokiLoggerConfigNodeConfig>
             host:config.loki_host,
             userid:config.loki_userid,
             authtoken:config.loki_authtoken,
-            tenantID:config.loki_tenantID,
+            tenantID:config.loki_tenantid,
         }
 
         this._logger = LoggerService.get(loggerConfig);