@theotherwillembotha/node-red-plugincore 0.1.0 → 0.2.0

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

@@ -1,183 +0,0 @@
-
-<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})
-
-        // platform rest:
-        .addDefault("rest_url", {})
-        .addDefault("rest_ignoresslerror", {})
-        .addDefault("rest_auth_type", {})
-        .addDefault("rest_auth_basic_username", {})
-        .addDefault("rest_auth_basic_password", {})
-        .addDefault("rest_auth_apikey_mechanism", {})
-        .addDefault("rest_auth_apikey_name", {})
-        .addDefault("rest_auth_apikey_value", {})
-
-        .setPaletteLabel("Rest Logger Config Node")
-        .setLabel(function() {return this.name })
-
-</script>
-
-<script type="text/javascript" template-section="onIncludeEditPrepare">
-{
-    let node = this;
-
-    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 platformRestAuthType = $("#node-config-input-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-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
-    });
-}
-</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 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 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="platform platform-rest">
-        <div class="form-row">
-            <label class="towb_editorlabel" for="node-config-input-rest_url"><i class="fa fa-link"></i> URL</label>
-            <input class="platform-rest-input required" type="text" id="node-config-input-rest_url" />
-        </div>
-        <div class="form-row">
-            <label class="towb_editorlabel"></label>
-            <input type="checkbox" id="node-config-input-rest_ignoresslerror" style="width:20px; margin-right:5px;" />
-            <label style="width:auto" for="node-config-input-rest_ignoresslerror"><span>Ignore Invalid SSL certificates</span></label>
-        </div>
-        <div class="form-row">
-            <label class="towb_editorlabel" for="node-config-input-rest_auth_type"><i class="fa fa-lock"></i> Authentication</label>
-            <input class="platform-rest-input required" type="text" id="node-config-input-rest_auth_type" />
-        </div>
-        <div class="form-row platform-rest-auth auth-basic">
-            <label class="towb_editorlabel" for="node-config-input-rest_auth_basic_username"><i class="fa fa-user"></i> Username</label>
-            <input class="platform-rest-input" type="text" id="node-config-input-rest_auth_basic_username" />
-        </div>
-        <div class="form-row platform-rest-auth auth-basic">
-            <label class="towb_editorlabel" for="node-config-input-rest_auth_basic_password"><i class="fa fa-key"></i> Password</label>
-            <input class="platform-rest-input" type="password" id="node-config-input-rest_auth_basic_password" />
-        </div>
-        <div class="form-row platform-rest-auth auth-apikey">
-            <label class="towb_editorlabel" for="node-config-input-rest_auth_apikey_mechanism"><i class="fa fa-exchange"></i> Mechanism</label>
-            <input class="platform-rest-input" type="text" id="node-config-input-rest_auth_apikey_mechanism" />
-        </div>
-        <div class="form-row platform-rest-auth auth-apikey">
-            <label class="towb_editorlabel" for="node-config-input-rest_auth_apikey_name"><i class="fa fa-id-badge"></i> APIKey name</label>
-            <input class="platform-rest-input" type="text" id="node-config-input-rest_auth_apikey_name" />
-        </div>
-        <div class="form-row platform-rest-auth auth-apikey">
-            <label class="towb_editorlabel" for="node-config-input-rest_auth_apikey_value"><i class="fa fa-lock"></i> APIKey value</label>
-            <input class="platform-rest-input" type="text" id="node-config-input-rest_auth_apikey_value" />
-        </div>
-    </div>
-
-    <div class="form-row">
-        <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">
-Posts log messages to an HTTP or HTTPS endpoint as a JSON payload.
-
-### 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.
-: *url*         (url)       : The endpoint that log messages will be POSTed to.
-: *ignore SSL errors* (boolean) : When enabled, invalid SSL certificates are accepted.
-: *authentication* (select) : The authentication strategy applied to each request. Options: None, Basic, ApiKey.
-: *template*    (mustache)  : A Mustache/Handlebars template that formats the log message body.
-
-### Authentication
-#### Basic
-Authenticates using the HTTP `Authorization` header (RFC 7617).
-: *username*    (string)    : The username credential.
-: *password*    (string)    : The password credential.
-
-#### ApiKey
-Authenticates by injecting a key/value pair into the request.
-: *mechanism*   (select)    : Where the key is injected — Header, Query Param, or Matrix Param.
-: *APIKey name* (string)    : The name of the key (e.g. `x-api-key`).
-: *APIKey value* (string)   : The value of the key.
-
-### Mustache Templating
-Mustache/Handlebars templates build the message string POSTed to the endpoint.
-
-#### 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
-- [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/RestLoggerConfigNode.ts

@@ -1,170 +0,0 @@
-
-import { Node } from "node-red";
-import {ConfigNodeConfig } from "../../NodeConstructor"
-import { LoggerService, LoggerConfigNode, AbstractLogger, BaseLoggerConfig, TagMap, Log } from "../service/LoggerService"
-import { SourceUtility } from "../../NodeGenerator";
-import { ApiKeyMechanismType, Level, RestAuthType } from "../service/LoggerService";
-import { NodeDescription } from "../../tagging/NodeDescriptionDecorator";
-import { LoggerTemplateConfig } from "../template/LoggerTemplate";
-import { parseURL, URLRecord } from "whatwg-url";
-import { HttpTransportOptions } from "winston/lib/winston/transports";
-import { createLogger, format, transports, Logger } from "winston";
-
-interface RestLoggerConfigNodeConfig extends ConfigNodeConfig {
-
-    id: string;
-    level:Level;
-    template:string;
-    
-    rest_url: string;
-    rest_ignoresslerror:boolean;
-    rest_auth_type: RestAuthType;
-    rest_auth_basic_username:string;
-    rest_auth_basic_password:string;
-    rest_auth_apikey_mechanism:ApiKeyMechanismType;
-    rest_auth_apikey_name:string;
-    rest_auth_apikey_value:string;
-}
-
-@NodeDescription({
-    id:"RestLoggerConfigNode",
-    name:"Rest Endpoint Logger",
-    group:"config",
-    sourceFile:SourceUtility.getSourcePath("/build/", "/src/") + "RestLoggerConfigNode.html",
-    package: "@theotherwillembotha/node-red-plugincore",
-    dependencies:[ LoggerService ],
-    tags: [ "LoggerType" ]
-})
-export class RestLoggerConfigNode extends LoggerConfigNode<RestLoggerConfigNodeConfig, RestLogger> {
-    
-    private _logger!: RestLogger;
-    
-    constructor(node: Node, config: RestLoggerConfigNodeConfig){
-        super(node, config);
-        let _this = this;
-
-        // instantiate the logger.
-        let loggerConfig:RestLoggerConfig = {
-            id:this.id(),
-            type:"REST",
-            level:config.level,
-            template:config.template,
-            
-            // additional properties.
-            url: config.rest_url,
-            ignoresslerror:config.rest_ignoresslerror,
-            auth_type: config.rest_auth_type,
-            auth_basic_username:config.rest_auth_basic_username,
-            auth_basic_password:config.rest_auth_basic_password,
-            auth_apikey_mechanism:config.rest_auth_apikey_mechanism,
-            auth_apikey_name:config.rest_auth_apikey_name,
-            auth_apikey_value:config.rest_auth_apikey_value,
-        };
-
-        this._logger = new RestLogger(loggerConfig);
-    }
-
-    protected logger():RestLogger{
-        return this._logger;
-    }
-}
-
-class RestLogger extends AbstractLogger<RestLoggerConfig> {
-
-    private winston:Logger;
-
-    constructor(config:RestLoggerConfig){
-        super(config);
-
-        // get the url.
-        let hosturl:URLRecord|null = parseURL(config.url);
-        if(!hosturl){
-            throw Error("could not parse url: " + config.url);
-        }
-
-        // get the options
-        let httpOptions:{[key:string]:any} = {}
-        
-        // get the params.
-        let httpParams:HttpTransportOptions = {
-            host:hosturl.host?.toString(),
-            path:"/" + (hosturl.path ? [...hosturl.path].join("/") : "") + (hosturl.query ? ("?" + hosturl.query) : ""),
-            port:(hosturl.port) ? hosturl.port : undefined,
-            ssl:hosturl.scheme.toLowerCase() === "https",
-            headers: {},
-        };        
-        (httpParams as any).options = httpOptions;
-
-        // add the ignore ssl error flag if need be.
-        if(config.ignoresslerror){
-            httpOptions.rejectUnauthorized = false;
-        }
-
-        // configure "none" authentication.
-        if(config.auth_type === RestAuthType.none){}
-
-
-        // configure "basic" authentication.
-        if(config.auth_type === RestAuthType.basic){
-            httpParams.auth = {
-                username: config.auth_basic_username,
-                password: config.auth_basic_password
-            }
-        }
-
-        // configure "apikey" authentication.
-        if(config.auth_type === RestAuthType.apikey){
-            if(config.auth_apikey_mechanism === ApiKeyMechanismType.header) {
-                (httpParams.headers as any)[config.auth_apikey_name] = config.auth_apikey_value;
-            }
-            if(config.auth_apikey_mechanism === ApiKeyMechanismType.matrixparam) {
-                httpParams.path = httpParams.path?.replace(`:${config.auth_apikey_name}`, config.auth_apikey_value);
-            }
-            if(config.auth_apikey_mechanism === ApiKeyMechanismType.queryparam) {
-                httpParams.path = httpParams.path + (httpParams.path?.includes("?") ? "&" : "?") + config.auth_apikey_name + "=" + config.auth_apikey_value;
-            }
-        };
-
-        this.winston = createLogger({
-            level: config.level.toString().toLowerCase(),
-            format: format.json(),
-            defaultMeta: {},
-            transports: [
-                new transports.Http(httpParams),
-            ],
-        });
-    }
-
-    protected createLogger(config: LoggerTemplateConfig): Log {
-        return new RestAppender(config, this.winston);
-    }
-}
-
-class RestAppender extends Log {
-    private winston: Logger;
-
-    constructor(config:LoggerTemplateConfig, winston:Logger){
-        super(config);
-        this.winston = winston;
-    }
-
-    protected writeToLog(level:string, message: string, tags: { [key: string]: string | boolean | number; }): void {
-        this.winston.log({
-            level:level,
-            message:message, 
-            labels:tags
-        });
-    }
-
-}
-
-interface RestLoggerConfig extends BaseLoggerConfig {
-    url: string;
-    ignoresslerror:boolean;
-    auth_type: RestAuthType;
-    auth_basic_username:string;
-    auth_basic_password:string;
-    auth_apikey_mechanism:ApiKeyMechanismType;
-    auth_apikey_name:string;
-    auth_apikey_value:string;
-}