@theotherwillembotha/node-red-plugincore 0.0.50 → 0.0.51

package/build/core/other/node/DelegatedConfigReferenceNode.d.ts

@@ -0,0 +1,57 @@
+/**
+ * DelegatedConfigReferenceNode — a framework-internal sentinel type.
+ *
+ * PROBLEM
+ * Node-RED's reference counter (the usage count shown on config nodes in the
+ * Config sidebar) is driven by `updateConfigNodeUsers()` in nodes.js. That
+ * function only tracks a property as a config-node reference when two conditions
+ * are met:
+ *   1. `defaults[property].type` is set to a registered node type name.
+ *   2. That node type's `category` equals `"config"`.
+ *
+ * When a node property can reference *any* of several config-node types (e.g.
+ * ConsoleLoggerConfigNode, RestLoggerConfigNode, LokiLoggerConfigNode, or a
+ * future third-party logger), there is no single concrete type to declare.
+ * Leaving `type` blank causes the counter to stay at zero even when references
+ * exist, and the config node is incorrectly flagged as unused.
+ *
+ * WORKAROUND
+ * Register this no-op node with `category: "config"` so that its type name can
+ * be used as the `type` value in `addDefault(...)` calls where the referenced
+ * config node type is not known ahead of time (open/delegated reference).
+ * `updateConfigNodeUsers` will then pass both gates, look up the config node by
+ * its actual runtime ID, and correctly increment the counter.
+ *
+ * USAGE
+ * In a template or node's onCompose section, declare the property like this:
+ *
+ *   .addDefault("myProp", { value: '', required: false, type: "DelegatedConfigReferenceNode" })
+ *
+ * Because the property name intentionally does NOT match the `node-input-X` /
+ * `node-config-input-X` naming convention, Node-RED will NOT auto-initialise
+ * the form element or auto-save the value. You must therefore:
+ *   - Read  the stored value manually in `onIncludeEditPrepare`
+ *             e.g. $("#my-selector").val(node.myProp);
+ *   - Write it back manually in `onIncludeEditSave`
+ *             e.g. node.myProp = $("#my-selector").val();
+ *
+ * LONG-TERM
+ * A proper fix would be a Node-RED PR to make `updateConfigNodeUsers` use the
+ * already-parsed `_type.types` array (set by `parseNodePropertyTypeString`) so
+ * that pipe-separated multi-type strings such as
+ * "ConsoleLoggerConfigNode|RestLoggerConfigNode" work natively.
+ * Until that PR is accepted, this sentinel type is the recommended workaround
+ * within this framework.
+ *
+ * NOTE: This node has no UI, no edit form, and no runtime behaviour. It cannot
+ * be instantiated by users and should never appear as a flow node.
+ */
+import { Node } from "node-red";
+import { ConfigNode, ConfigNodeConfig } from "../../NodeConstructor";
+interface DelegatedConfigReferenceNodeConfig extends ConfigNodeConfig {
+}
+export declare class DelegatedConfigReferenceNode extends ConfigNode<DelegatedConfigReferenceNodeConfig> {
+    constructor(node: Node, config: DelegatedConfigReferenceNodeConfig);
+}
+export {};
+//# sourceMappingURL=DelegatedConfigReferenceNode.d.ts.map

package/build/core/other/node/DelegatedConfigReferenceNode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DelegatedConfigReferenceNode.d.ts","sourceRoot":"","sources":["../../../../src/core/other/node/DelegatedConfigReferenceNode.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAIpE,UAAU,kCAAmC,SAAQ,gBAAgB;CAAG;AAExE,qBAOa,4BAA6B,SAAQ,UAAU,CAAC,kCAAkC,CAAC;gBAEhF,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,kCAAkC;CAGrE"}

package/build/core/other/node/DelegatedConfigReferenceNode.html

@@ -0,0 +1 @@
+<!-- This section is intentionally left blank -->

package/build/core/other/node/DelegatedConfigReferenceNode.js

@@ -0,0 +1,79 @@
+"use strict";
+/**
+ * DelegatedConfigReferenceNode — a framework-internal sentinel type.
+ *
+ * PROBLEM
+ * Node-RED's reference counter (the usage count shown on config nodes in the
+ * Config sidebar) is driven by `updateConfigNodeUsers()` in nodes.js. That
+ * function only tracks a property as a config-node reference when two conditions
+ * are met:
+ *   1. `defaults[property].type` is set to a registered node type name.
+ *   2. That node type's `category` equals `"config"`.
+ *
+ * When a node property can reference *any* of several config-node types (e.g.
+ * ConsoleLoggerConfigNode, RestLoggerConfigNode, LokiLoggerConfigNode, or a
+ * future third-party logger), there is no single concrete type to declare.
+ * Leaving `type` blank causes the counter to stay at zero even when references
+ * exist, and the config node is incorrectly flagged as unused.
+ *
+ * WORKAROUND
+ * Register this no-op node with `category: "config"` so that its type name can
+ * be used as the `type` value in `addDefault(...)` calls where the referenced
+ * config node type is not known ahead of time (open/delegated reference).
+ * `updateConfigNodeUsers` will then pass both gates, look up the config node by
+ * its actual runtime ID, and correctly increment the counter.
+ *
+ * USAGE
+ * In a template or node's onCompose section, declare the property like this:
+ *
+ *   .addDefault("myProp", { value: '', required: false, type: "DelegatedConfigReferenceNode" })
+ *
+ * Because the property name intentionally does NOT match the `node-input-X` /
+ * `node-config-input-X` naming convention, Node-RED will NOT auto-initialise
+ * the form element or auto-save the value. You must therefore:
+ *   - Read  the stored value manually in `onIncludeEditPrepare`
+ *             e.g. $("#my-selector").val(node.myProp);
+ *   - Write it back manually in `onIncludeEditSave`
+ *             e.g. node.myProp = $("#my-selector").val();
+ *
+ * LONG-TERM
+ * A proper fix would be a Node-RED PR to make `updateConfigNodeUsers` use the
+ * already-parsed `_type.types` array (set by `parseNodePropertyTypeString`) so
+ * that pipe-separated multi-type strings such as
+ * "ConsoleLoggerConfigNode|RestLoggerConfigNode" work natively.
+ * Until that PR is accepted, this sentinel type is the recommended workaround
+ * within this framework.
+ *
+ * NOTE: This node has no UI, no edit form, and no runtime behaviour. It cannot
+ * be instantiated by users and should never appear as a flow node.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DelegatedConfigReferenceNode = void 0;
+const NodeConstructor_1 = require("../../NodeConstructor");
+const NodeGenerator_1 = require("../../NodeGenerator");
+const NodeDescriptionDecorator_1 = require("../../tagging/NodeDescriptionDecorator");
+let DelegatedConfigReferenceNode = class DelegatedConfigReferenceNode extends NodeConstructor_1.ConfigNode {
+    constructor(node, config) {
+        super(node, config);
+    }
+};
+exports.DelegatedConfigReferenceNode = DelegatedConfigReferenceNode;
+exports.DelegatedConfigReferenceNode = DelegatedConfigReferenceNode = __decorate([
+    (0, NodeDescriptionDecorator_1.NodeDescription)({
+        id: "DelegatedConfigReferenceNode",
+        name: "DelegatedConfigReferenceNode",
+        group: "config",
+        sourceFile: NodeGenerator_1.SourceUtility.getSourcePath("/build/", "/src/") + "DelegatedConfigReferenceNode.html",
+        package: "@theotherwillembotha/node-red-plugincore",
+    }),
+    __metadata("design:paramtypes", [Object, Object])
+], DelegatedConfigReferenceNode);

package/build/core/tagging/NodeDescriptionDecorator.js

@@ -4,7 +4,7 @@ exports.NodeDescription = NodeDescription;
 const NodeConstructor_1 = require("../NodeConstructor");
 function NodeDescription(config) {
     return function (target) {
-        let descriptor = new NodeConstructor_1.NodeDescriptor(config.group, config.id, config.sourceFile, config.package);
+        let descriptor = new NodeConstructor_1.NodeDescriptor(config.group, config.id, config.name, config.sourceFile, config.package);
         if (config.templates) {
             for (let template of config.templates) {
                 descriptor.addTemplate(template.template, template.config);

package/build/core/tagging/service/NodeTypeService.js

@@ -16,7 +16,7 @@ class NodeTypeService extends NodeConstructor_1.BaseService {
             let types = this.getNodeTypesForTag(tag).map(type => {
                 let description = type.getNodeDescriptor();
                 return {
-                    "id": description.name(),
+                    "id": description.id(),
                     "name": description.name(),
                 };
             });

package/build/core/webhook/node/WebhookServerConfigNode.html

@@ -18,25 +18,25 @@
 </div>
 
 
-<script type="text/html" template-section="onIncludeEditForm">\
+<script type="text/html" template-section="onIncludeEditForm">
     <div id="WebhookServerConfig">
         <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-port"><i class="fa fa-tag"></i> Port</label>
+            <label class="towb_editorlabel" 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-externalHost"><i class="fa fa-tag"></i> External Host</label>
+            <label class="towb_editorlabel" for="node-config-input-externalHost"><i class="fa fa-globe"></i> External Host</label>
             <input type="text" id="node-config-input-externalHost" />
         </div>
 
         <div class="form-row">
-            <label for="node-config-input-externalPort"><i class="fa fa-tag"></i> External Port</label>
+            <label class="towb_editorlabel" for="node-config-input-externalPort"><i class="fa fa-plug"></i> External Port</label>
             <input type="number" id="node-config-input-externalPort" />
         </div>
         <!-- add a button here to autmatically find an open port --> 

package/build/core/webhook/template/WebhookTemplate.html

@@ -133,6 +133,12 @@ node
         return types;
     }
 
+    getProxyTypes().then(types => {
+        if(types.length === 0){
+            $("#section_reverseproxy_feature").hide();
+        }
+    });
+
     let getProxies = async () => {
         let proxies = [];
 
@@ -335,17 +341,17 @@ node
         
         <div class="editorgroupborder">
             <div class="form-row nomargin">
-                <label for="{{defaults.webhook}}">Server</label>
+                <label class="towb_editorlabel" for="{{defaults.webhook}}"><i class="fa fa-server"></i> Server</label>
                 <input id="{{defaults.webhook}}" placeholder="webhook" />
             </div>
-            
+
             <div class="form-row">
-                <label for="{{defaults.webhookPath}}">Path</label>
+                <label class="towb_editorlabel" for="{{defaults.webhookPath}}"><i class="fa fa-link"></i> Path</label>
                 <input type="text" id="{{defaults.webhookPath}}" placeholder="/example" />
             </div>
 
             <div class="form-row">
-                <label for="{{defaults.webhookAuth}}">Authentication</label>
+                <label class="towb_editorlabel" for="{{defaults.webhookAuth}}"><i class="fa fa-lock"></i> Authentication</label>
                 <input type="text" id="{{defaults.webhookAuth}}" placeholder="none" />
             </div>
 
@@ -354,33 +360,34 @@ node
 
             <div class="webhookauth webhookauth-basic">
                 <div class="form-row">
-                    <label for="{{defaults.webhookAuth_basic_username}}">Auth Username:</label>
+                    <label class="towb_editorlabel" for="{{defaults.webhookAuth_basic_username}}"><i class="fa fa-user"></i> Username</label>
                     <input type="text" id="{{defaults.webhookAuth_basic_username}}" placeholder="testUser" />
                 </div>
 
                 <div class="form-row">
-                    <label for="{{defaults.webhookAuth_basic_password}}">Auth Password:</label>
+                    <label class="towb_editorlabel" for="{{defaults.webhookAuth_basic_password}}"><i class="fa fa-key"></i> Password</label>
                     <input type="password" id="{{defaults.webhookAuth_basic_password}}" placeholder="password" />
                 </div>
             </div>
 
             <div class="webhookauth webhookauth-apikey">
                 <div class="form-row">
-                    <label for="{{defaults.webhookAuth_apikey_mechanism}}">APIKey Mechanism:</label>
+                    <label class="towb_editorlabel" for="{{defaults.webhookAuth_apikey_mechanism}}"><i class="fa fa-exchange"></i> Mechanism</label>
                     <input type="text" id="{{defaults.webhookAuth_apikey_mechanism}}"/>
                 </div>
 
                 <div class="form-row">
-                    <label for="{{defaults.webhookAuth_apikey_key}}">APIKey Key:</label>
+                    <label class="towb_editorlabel" for="{{defaults.webhookAuth_apikey_key}}"><i class="fa fa-id-badge"></i> APIKey name</label>
                     <input type="text" id="{{defaults.webhookAuth_apikey_key}}" placeholder="x-api-key" />
                 </div>
 
                 <div class="form-row">
-                    <label for="{{defaults.webhookAuth_apikey_value}}">APIKey Value</label>
+                    <label class="towb_editorlabel" for="{{defaults.webhookAuth_apikey_value}}"><i class="fa fa-lock"></i> APIKey value</label>
                     <input type="text" id="{{defaults.webhookAuth_apikey_value}}" placeholder="testvalue" />
                 </div>
             </div>
 
+            <div id="section_reverseproxy_feature">
             <div class="form-row">
                 <label>Reverse Proxy</label>
                 <input type="checkbox" id="{{defaults.reverseProxies_enabled}}" style="width:20px; margin-right:5px;" />
@@ -392,8 +399,9 @@ node
                     <ol id="reverseproxylist_table" class="theotherwillembotha-compact-table"></ol>
                 </div>
             </div>
+            </div>
+
 
-            
         </div>
     </div>
 </script>

package/build/index.d.ts

@@ -2,7 +2,6 @@ export * from "./core/Utils";
 export * from "./core/NodeGenerator";
 export * from "./core/NodeConstructor";
 export * from "./core/logger/service/LoggerService";
-export * from "./core/logger/node/LoggerConfigNode";
 export * from "./core/logger/template/LoggerTemplate";
 export * from "./core/logger/node/ConsoleLoggerConfigNode";
 export * from "./core/logger/node/RestLoggerConfigNode";
@@ -18,6 +17,7 @@ export * from "./core/metrics/node/TimerMetricConfigNode";
 export * from "./core/metrics/template/TimerMetricTemplate";
 export * from "./core/tagging/service/NodeTypeService";
 export * from "./core/tagging/NodeDescriptionDecorator";
+export * from "./core/other/node/DelegatedConfigReferenceNode";
 export * from "./core/other/service/InputService";
 export * from "./core/other/service/SettingsService";
 export * from "./core/other/template/BasicTemplate";

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AAGvC,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,uCAAuC,CAAC;AACtD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC;AAGxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,yCAAyC,CAAC;AACxD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,uCAAuC,CAAC;AACtD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,6CAA6C,CAAC;AAG5D,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AAIxD,cAAc,mCAAmC,CAAC;AAClD,cAAc,sCAAsC,CAAC;AACrD,cAAc,qCAAqC,CAAC;AACpD,cAAc,wCAAwC,CAAC;AAGvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,6CAA6C,CAAC;AAG5D,cAAc,gDAAgD,CAAC;AAG/D,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAChD,cAAc,6BAA6B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AAGvC,cAAc,qCAAqC,CAAC;AACpD,cAAc,uCAAuC,CAAC;AACtD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC;AAGxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,yCAAyC,CAAC;AACxD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,uCAAuC,CAAC;AACtD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,6CAA6C,CAAC;AAG5D,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AAGxD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,mCAAmC,CAAC;AAClD,cAAc,sCAAsC,CAAC;AACrD,cAAc,qCAAqC,CAAC;AACpD,cAAc,wCAAwC,CAAC;AAGvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,6CAA6C,CAAC;AAG5D,cAAc,gDAAgD,CAAC;AAG/D,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAChD,cAAc,6BAA6B,CAAC"}

package/build/index.js

@@ -19,7 +19,6 @@ __exportStar(require("./core/NodeGenerator"), exports);
 __exportStar(require("./core/NodeConstructor"), exports);
 // LOGGER
 __exportStar(require("./core/logger/service/LoggerService"), exports);
-__exportStar(require("./core/logger/node/LoggerConfigNode"), exports);
 __exportStar(require("./core/logger/template/LoggerTemplate"), exports);
 __exportStar(require("./core/logger/node/ConsoleLoggerConfigNode"), exports);
 __exportStar(require("./core/logger/node/RestLoggerConfigNode"), exports);
@@ -38,6 +37,7 @@ __exportStar(require("./core/metrics/template/TimerMetricTemplate"), exports);
 __exportStar(require("./core/tagging/service/NodeTypeService"), exports);
 __exportStar(require("./core/tagging/NodeDescriptionDecorator"), exports);
 // OTHER
+__exportStar(require("./core/other/node/DelegatedConfigReferenceNode"), exports);
 __exportStar(require("./core/other/service/InputService"), exports);
 __exportStar(require("./core/other/service/SettingsService"), exports);
 __exportStar(require("./core/other/template/BasicTemplate"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "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.51",
+  "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": [
@@ -26,7 +26,7 @@
     "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",
@@ -57,6 +57,7 @@
     "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 { 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";
@@ -27,6 +28,7 @@ new NodeGenerator("./src/core/")
     .registerTemplate(WebhookTemplate)
 
     // 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>