@theotherwillembotha/node-red-plugincore 0.0.50

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

@@ -0,0 +1,307 @@
+
+<script type="text/javascript" template-section="onCompose">
+    node
+        .addDefault("name", {value:"Logger Example", required:true})
+        .addDefault("platform", {value:"rest", required:true})
+        .addDefault("template", {value:`message:{{msg}}`, required:true})
+        .addDefault("level", {value:"info", required:true})
+
+        // platform rest:
+        .addDefault("platform_rest_url", {})
+        .addDefault("platform_rest_ignoresslerror", {})
+        .addDefault("platform_rest_auth_type", {})
+        .addDefault("platform_rest_auth_basic_username", {})
+        .addDefault("platform_rest_auth_basic_password", {})
+        .addDefault("platform_rest_auth_apikey_mechanism", {})
+        .addDefault("platform_rest_auth_apikey_name", {})
+        .addDefault("platform_rest_auth_apikey_value", {})
+
+        // platform loki:
+        .addDefault("platform_loki_host", {})
+        .addDefault("platform_loki_tenantID", {})
+        .addDefault("platform_loki_userid", {})
+        .addDefault("platform_loki_authtoken", {})
+
+        .setPaletteLabel("Logger Config Node")
+        .setLabel(function() {return this.name })
+
+</script>
+
+<script type="text/javascript" template-section="onIncludeEditPrepare">
+{
+    let node = this;
+
+    let showSelectedPlatform = (value) => {
+        let loggerConfig = $("#LoggerConfig");
+        loggerConfig.find(".platform").each((i, t) => {
+            t = $(t);
+            if(t.hasClass(`platform-${value}`)){ t.show(); }
+            else { t.hide(); }
+        });
+
+        $("#LoggerConfig").find(`.platform-${value}`).find(`.platform-${value}-input.required`).each((i, entry) => { 
+            let id = entry.id.replace("node-config-input-", "");
+            if(node._def.defaults[id]){
+                node._def.defaults[id].required = true;
+            }
+            else{
+                console.log(`you forgot to define ${id} in the defaults for LoggerConfigNode`);
+            }
+        });
+
+        Object.entries(node._def.defaults)
+            .filter(([k, v]) => k.startsWith(`platform_`))
+            .filter(([k, v]) => !k.startsWith(`platform_${value}_`))
+            .forEach(([k, v]) => v.required = false );
+
+        node.platform = value;
+    }
+
+    let showSelectedRestAuthMethod = (value) => {
+        $("#LoggerConfig")
+            .find(".platform.platform-rest").first()
+            .find(".platform-rest-auth")
+            .each((i, t) => {
+                t = $(t);
+                if(t.hasClass(`auth-${value}`)){ t.show(); }
+                else { t.hide(); }
+            });
+    }
+
+    let levelSelection = $("#node-config-input-level");
+    levelSelection.typedInput({type:"level", types:[{
+        value: "level",
+        options: [
+            { value: "DEBUG", label: "debug"},
+            { value: "INFO", label: "info"},
+            { value: "WARNING", label: "warning"},
+            { value: "ERROR", label: "error"},
+        ]
+    }]});
+
+    let platformSelection = $("#node-config-input-platform");
+    platformSelection.typedInput({type:"platform", types:[{
+        value: "platform",
+        options: [
+            { value: "console", label:"Console"},
+            { value: "rest", label: "Http / Https"},
+            { value: "loki", label: "Loki"},
+        //    { value: "elasticsearch", label: "ElasticSearch"},
+        //    { value: "datadog", label: "Datadog"},
+        //    { value: "graylog", label: "Graylog"},
+        ]
+    }]});
+    platformSelection.on("change", () => showSelectedPlatform(platformSelection.val()));
+
+    let platformRestAuthType = $("#node-config-input-platform_rest_auth_type");
+    platformRestAuthType.typedInput({type:"authtype", types:[{
+        value: "authtype",
+        options: [
+            { value: "none", label: "None"},
+            { value: "basic", label: "Basic"},
+            { value: "apikey", label: "ApiKey"}
+        ]
+    }]});
+    platformRestAuthType.on("change", () => showSelectedRestAuthMethod(platformRestAuthType.val()));
+
+    
+    let apiKeyMechanism = $("#node-config-input-platform_rest_auth_apikey_mechanism");
+    apiKeyMechanism.typedInput({type:"apikeymechansim", types:[{
+        value: "apikeymechansim",
+        options: [
+            { value: "header", label: "Header"},
+            { value: "queryparam", label: "Query Param"},
+            { value: "matrixparam", label: "Matrix Param"}
+        ]
+    }]});
+
+    this.editor = RED.editor.createEditor({
+        id: 'node-config-input-templateEditor',
+        mode: 'ace/mode/handlebars',
+        value: this.template
+    });
+
+
+    // setup defaults //
+    if(node.platform){
+        platformSelection.typedInput('value',node.platform);
+    }
+    showSelectedPlatform(platformSelection.val());
+}
+</script>
+
+<script type="text/javascript" template-section="onIncludeEditSave">
+{
+    let node = this;
+
+    this.template = this.editor.getValue();
+    this.editor.destroy();
+    delete this.editor;
+
+    // TODO: when saving the node, we need to remove all the platform_XXXX config values
+    // that are not supposed to be populated. For instance, when you switch from a loki to
+    // rest logger, the loki logger should be zeroed out.
+}
+
+</script>
+
+<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>
+        <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>
+        <input type="text" id="node-config-input-level" />
+    </div>
+
+    <div class="form-row">
+        <label for="node-config-input-platform"><i class="fa fa-tag"></i> Platform</label>
+        <input type="text" id="node-config-input-platform" />
+    </div>
+
+    <div class="platform platform-console">
+    </div>
+
+    <div class="platform platform-rest">
+        <div class="form-row">
+            <label for="node-config-input-platform_rest_url"><i class="fa fa-tag"></i> URL</label>
+            <input class="platform-rest-input required" type="text" id="node-config-input-platform_rest_url" />
+        </div>
+        <div class="form-row">
+            <input type="checkbox" id="node-config-input-platform_rest_ignoresslerror" style="margin:8px 0 10px 102px; width:20px;" />
+            <label style="width:auto" for="node-config-input-platform_rest_ignoresslerror"><span>Ignore Invalid SSL certificates</span></label>
+        </div>
+        <div class="form-row">
+            <label for="node-config-input-platform_rest_auth_type"><i class="fa fa-tag"></i> Authentication</label>
+            <input class="platform-rest-input required" type="text" id="node-config-input-platform_rest_auth_type" />
+        </div>
+        <div class="form-row platform-rest-auth auth-basic">
+            <label for="node-config-input-platform_rest_auth_basic_username"><i class="fa fa-tag"></i> Username</label>
+            <input class="platform-rest-input" type="text" id="node-config-input-platform_rest_auth_basic_username" />
+        </div>
+        <div class="form-row platform-rest-auth auth-basic">
+            <label for="node-config-input-platform_rest_auth_basic_password"><i class="fa fa-tag"></i> Password</label>
+            <input class="platform-rest-input" type="password" id="node-config-input-platform_rest_auth_basic_password" />
+        </div>
+        <div class="form-row platform-rest-auth auth-apikey">
+            <label for="node-config-input-platform_rest_auth_apikey_mechanism"><i class="fa fa-tag"></i> Mechanism</label>
+            <input class="platform-rest-input" type="text" id="node-config-input-platform_rest_auth_apikey_mechanism" />
+        </div>
+        <div class="form-row platform-rest-auth auth-apikey">
+            <label for="node-config-input-platform_rest_auth_apikey_name"><i class="fa fa-tag"></i> APIKey name</label>
+            <input class="platform-rest-input" type="text" id="node-config-input-platform_rest_auth_apikey_name" />
+        </div>
+        <div class="form-row platform-rest-auth auth-apikey">
+            <label for="node-config-input-platform_rest_auth_apikey_value"><i class="fa fa-tag"></i> APIKey value</label>
+            <input class="platform-rest-input" type="text" id="node-config-input-platform_rest_auth_apikey_value" />
+        </div>
+    </div>
+
+    <div class="platform platform-loki">
+        <div class="form-row">
+            <label for="node-config-input-platform_loki_host"><i class="fa fa-tag"></i> Host</label>
+            <input class="platform-loki-input required" type="text" id="node-config-input-platform_loki_host" />
+        </div>
+        <div class="form-row">
+            <label for="node-config-input-platform_loki_tenantID"><i class="fa fa-tag"></i> TenantID</label>
+            <input class="platform-loki-input" type="text" id="node-config-input-platform_loki_tenantID" />
+        </div>
+        <div class="form-row">
+            <label for="node-config-input-platform_loki_userid"><i class="fa fa-tag"></i> Username</label>
+            <input class="platform-loki-input" type="text" id="node-config-input-platform_loki_userid" />
+        </div>
+        <div class="form-row">
+            <label for="node-config-input-platform_loki_authtoken"><i class="fa fa-tag"></i> AuthToken</label>
+            <input class="platform-loki-input" type="password" id="node-config-input-platform_loki_authtoken" />
+        </div>
+    </div>
+
+    <div class="platform platform-elasticsearch">
+        ELASTIC SEARCH
+    </div>
+
+    <div class="platform platform-datadog">
+        DATADOG
+    </div>
+
+    <div class="platform platform-graylog">
+        GRAYLOG
+    </div>
+
+    <div class="form-row">
+        <label for="node-config-input-templateEditor"><i class="fa fa-tag"></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)
+</script>
+

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

@@ -0,0 +1,95 @@
+// LOGGER is officially deprecated. Do not use it.
+import { Node } from "node-red";
+import { ConfigNode, ConfigNodeConfig, NodeDescriptor } from "../../NodeConstructor"
+import { NewLogger, Log, LoggerRegistration, LoggerService, RestLoggerConfig } from "../service/LoggerService"
+import { SourceUtility } from "../../NodeGenerator";
+import { ApiKeyMechanismType, Level, PlatformType, RestAuthType } from "../service/LoggerServiceTypes";
+
+interface LoggerConfigNodeConfig extends ConfigNodeConfig {
+
+    id: string;
+    platform: PlatformType;
+    level:Level;
+    platfrom:PlatformType;
+    template:string;
+    
+    platform_rest_url: string;
+    platform_rest_auth_type: RestAuthType;
+    platform_rest_auth_basic_username:string;
+    platform_rest_auth_basic_password:string;
+    platform_rest_auth_apikey_mechanism:ApiKeyMechanismType;
+    platform_rest_auth_apikey_name:string;
+    platform_rest_auth_apikey_value:string;
+
+    platform_loki_host:string,
+    platform_loki_userid?:string,
+    platform_loki_authtoken?:string,
+    platform_loki_tenantID?:string
+}
+
+export class LoggerConfigNode extends ConfigNode<LoggerConfigNodeConfig> {
+    
+    private _logger!: NewLogger<any>;
+    
+    constructor(node: Node, config: LoggerConfigNodeConfig){
+        super(node, config);
+        let _this = this;
+
+        // instantiate the logger.
+        let loggerConfig:any;
+
+        if(config.platform === PlatformType.console){
+            loggerConfig = {
+                id:this.id(),
+                type:PlatformType.console,
+                template:config.template,
+                level:config.level,
+            }
+        }
+
+        if(config.platform === PlatformType.rest){
+            loggerConfig = {
+                id:this.id(),
+                type:PlatformType.rest,
+                template:config.template,
+                level:config.level,
+                url: config.platform_rest_url,
+                auth_type: config.platform_rest_auth_type,
+                auth_basic_username:config.platform_rest_auth_basic_username,
+                auth_basic_password:config.platform_rest_auth_basic_password,
+                auth_apikey_mechanism:config.platform_rest_auth_apikey_mechanism,
+                auth_apikey_name:config.platform_rest_auth_apikey_name,
+                auth_apikey_value:config.platform_rest_auth_apikey_value,
+            } as RestLoggerConfig;
+        }
+
+        if(config.platform === PlatformType.loki){
+            loggerConfig = {
+                id:this.id(),
+                type:PlatformType.loki,
+                template:config.template,
+                level:config.level,
+                host:config.platform_loki_host,
+                userid:config.platform_loki_userid,
+                authtoken:config.platform_loki_authtoken,
+                tenantID:config.platform_loki_tenantID,
+            }
+        }
+
+        this._logger = LoggerService.get(loggerConfig);
+    }
+
+    public registerLogger(registration:LoggerRegistration):Log {
+        return this._logger.register(registration)
+    }
+
+    static override getNodeDescriptor():NodeDescriptor {
+        return new NodeDescriptor(
+            "config", 
+            "LoggerConfigNode",
+            SourceUtility.getSourcePath("/build/", "/src/") + "LoggerConfigNode.html",
+            "@theotherwillembotha/node-red-plugincore")
+        .addDependency(LoggerService)
+        .addTag("Core")
+    }
+}

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

@@ -0,0 +1,153 @@
+
+<script type="text/javascript" template-section="onCompose">
+    node
+        .addDefault("name", {value:"Logger Example", required:true})
+        .addDefault("template", {value:`message:{{msg}}`, required:true})
+        .addDefault("level", {value:"info", required:true})
+
+        .addDefault("loki_host", {})
+        .addDefault("loki_tenantID", {})
+        .addDefault("loki_userid", {})
+        .addDefault("loki_authtoken", {})
+
+        .setPaletteLabel("Loki Logger Config Node")
+        .setLabel(function() {return this.name })
+</script>
+
+<script type="text/javascript" template-section="onIncludeEditPrepare">
+{
+    let node = this;
+
+    let levelSelection = $("#node-config-input-level");
+    levelSelection.typedInput({type:"level", types:[{
+        value: "level",
+        options: [
+            { value: "DEBUG", label: "debug"},
+            { value: "INFO", label: "info"},
+            { value: "WARNING", label: "warning"},
+            { value: "ERROR", label: "error"},
+        ]
+    }]});
+
+    this.editor = RED.editor.createEditor({
+        id: 'node-config-input-templateEditor',
+        mode: 'ace/mode/handlebars',
+        value: this.template
+    });
+}
+</script>
+
+<script type="text/javascript" template-section="onIncludeEditSave">
+{
+    let node = this;
+
+    this.template = this.editor.getValue();
+    this.editor.destroy();
+    delete this.editor;
+}
+
+</script>
+
+<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>
+        <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>
+        <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>
+        <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" />
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-loki_userid"><i class="fa fa-tag"></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>
+        <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>
+        <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)
+</script>
+

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

@@ -0,0 +1,58 @@
+
+import { Node } from "node-red";
+import { ConfigNode, ConfigNodeConfig } from "../../NodeConstructor"
+import { NewLogger, Log, LoggerRegistration, LoggerService } from "../service/LoggerService"
+import { SourceUtility } from "../../NodeGenerator";
+import { Level, PlatformType } from "../service/LoggerServiceTypes";
+import { NodeDescription } from "../../tagging/NodeDescriptionDecorator";
+
+interface LokiLoggerConfigNodeConfig extends ConfigNodeConfig {
+
+    id: string;
+    level:Level;
+    template:string;
+
+    loki_host:string,
+    loki_userid?:string,
+    loki_authtoken?:string,
+    loki_tenantID?:string
+}
+
+@NodeDescription({
+    id:"LokiLoggerConfigNode",
+    name:"Loki Logger",
+    group:"config",
+    sourceFile:SourceUtility.getSourcePath("/build/", "/src/") + "LokiLoggerConfigNode.html",
+    package: "@theotherwillembotha/node-red-plugincore",
+    dependencies:[ LoggerService ],
+    tags: [ "LoggerType" ]
+})
+export class LokiLoggerConfigNode extends ConfigNode<LokiLoggerConfigNodeConfig> {
+    
+    private _logger!: NewLogger<any>;
+    
+    constructor(node: Node, config: LokiLoggerConfigNodeConfig){
+        super(node, config);
+        let _this = this;
+
+        // instantiate the logger.
+        let loggerConfig:any;
+
+        loggerConfig = {
+            id:this.id(),
+            type:PlatformType.loki,
+            template:config.template,
+            level:config.level,
+            host:config.loki_host,
+            userid:config.loki_userid,
+            authtoken:config.loki_authtoken,
+            tenantID:config.loki_tenantID,
+        }
+
+        this._logger = LoggerService.get(loggerConfig);
+    }
+
+    public registerLogger(registration:LoggerRegistration):Log {
+        return this._logger.register(registration)
+    }
+}