@theotherwillembotha/node-red-plugincore 0.0.54 → 0.1.0

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

@@ -1,442 +0,0 @@
-
-
-<script type="text/javascript" template-section="onCompose">
-node
-    .addDefault('webhook', {type:"WebhookServerConfigNode", required:true})
-    .addDefault('webhookPath', {value:"/example", required:true})
-    .addDefault('webhookAuth', { value:"none", required:true})
-    .addDefault('webhookAuth_basic_username', {value:"user", required:false})
-    .addDefault('webhookAuth_basic_password', {value:"pass", required:false})
-    .addDefault('webhookAuth_apikey_mechanism', {value:"header", required:false})
-    .addDefault('webhookAuth_apikey_key', {value:"x-api-key", required:false})
-    .addDefault('webhookAuth_apikey_value', {value:"testkey", required:false})
-    .addDefault('reverseProxies_enabled', {required:false})
-    .addDefault('reverseProxies_connections', { type:"ReverseProxyType[]", maxInstances:10})
-</script>
-
-<div template-section="onIncludeOnce">
-    <script type="text/javascript">
-
-        // CSS
-        dropdownStyles = `
-        .proxy-dropdown {
-            position: absolute;
-            background: white;
-            border: 1px solid #ccc;
-            border-radius: 4px;
-            box-shadow: 0 2px 8px rgba(0,0,0,0.15);
-            max-height: 150px;
-            overflow-y: auto;
-            z-index: 1000;
-            min-width: 150px;
-        }
-        .proxy-dropdown .dropdown-item {
-            padding: 6px 12px;
-            cursor: pointer;
-        }
-        .proxy-dropdown .dropdown-item:hover {
-            background: #f0f0f0;
-        }
-        `;
-        $('<style>').text(dropdownStyles).appendTo('head');
-
-    </script>
-
-</div>
-
-<script type="text/javascript" template-section="onIncludeEditPrepare">
-{
-    let node = this;
-
-    let showSelectedAutnetication = function(value){
-        let webhookConfig = $("#section_webhookconfig");
-        webhookConfig.find(".webhookauth").each((i, t) => {
-            t = $(t);
-            if(t.hasClass(`webhookauth-${value}`)){ t.show(); }
-            else { t.hide(); }
-        });
-
-        webhookConfig.find(`.webhookauth-${value}`).find(`.webhookauth-${value}-input.required`).each((i, entry) => { 
-            let id = entry.id.replace("node-{{#if config.isConfigNode}}config-{{/if}}input-", "");
-            if(node._def.defaults[id]){
-                node._def.defaults[id].required = true;
-            }
-            else{
-                console.log(`you forgot to define ${id} in the defaults for WebhookTemplate`);
-            }
-        });
-
-        Object.entries(node._def.defaults)
-            .filter(([k, v]) => k.startsWith(`webhookAuth_`))
-            .filter(([k, v]) => !k.startsWith(`webhookAuth_${value}_`))
-            .forEach(([k, v]) => v.required = false );
-        
-        node.webhookAuth = value;
-    }
-
-    let webhookAuthSelection = $("#{{defaults.webhookAuth}}");
-    webhookAuthSelection.typedInput({type:"authentication", types:[{
-        value: "authentication",
-        options: [
-            { value: "none", label: "None"},
-            { value: "basic", label: "BasicAuth"},
-            { value: "apikey", label: "APIKey"}
-        ]
-    }]});
-    webhookAuthSelection.on("change", () => showSelectedAutnetication(webhookAuthSelection.val()));
-    showSelectedAutnetication(webhookAuthSelection.val());
-
-    let webhookAPIKeyMechanism = $("#{{defaults.webhookAuth_apikey_mechanism}}");
-    webhookAPIKeyMechanism.typedInput({type:"apikeymechanism", types:[{
-        value: "apikeymechansim",
-        options: [
-            { value: "header", label: "Header"},
-            { value: "queryparam", label: "Query Param"},
-            { value: "matrixparam", label: "Matrix Param"}
-        ]
-    }]});
-    webhookAuthSelection.on("change", () => showSelectedAutnetication(webhookAuthSelection.val()));
-    showSelectedAutnetication(webhookAuthSelection.val());
-
-    let enableReverseProxy = $("#{{defaults.reverseProxies_enabled}}");
-    let reverseProxySection = $("#section_webhookconfig_reverseproxy"); 
-    enableReverseProxy.on("change", () => {
-        console.log("show / hide reverse proxy table");
-        if(enableReverseProxy.prop("checked")){
-            reverseProxySection.show();
-        }
-        else{
-            reverseProxySection.hide();
-        }
-    });
-    if(this.reverseProxies_enabled){
-        reverseProxySection.show();
-    }
-    else{
-        reverseProxySection.hide();
-    }
-
-    let getProxyTypes = async () => {
-        let types = [];
-        await $.ajax({
-            url: "nodetypeservice/find?tag=ReverseProxyType",
-            type: "GET",
-            contentType: "application/json; charset=utf-8",
-            data:JSON.stringify({id:node.id}),
-            success: (response) => {
-                types = response;
-            },
-            error: (jqXHR, textStatus, errorThrown) => {
-                console.log(jqXHR, textStatus, errorThrown);
-            },
-        });
-        return types;
-    }
-
-    getProxyTypes().then(types => {
-        if(types.length === 0){
-            $("#section_reverseproxy_feature").hide();
-        }
-    });
-
-    let getProxies = async () => {
-        let proxies = [];
-
-        // get the list of types again.
-        let proxyTypes = (await getProxyTypes()).map(type => type.id);
-
-        // add all of the known proxies.
-        RED.nodes.eachConfig(cfg => { 
-            if(proxyTypes.includes(cfg.type)){
-                proxies.push({id:cfg.id, name:cfg.label(), type:cfg.type});
-            }
-        });
-
-        return proxies;
-    };
-
-    let reverseProxyList = $("#reverseproxylist_table");
-    reverseProxyList.editableList({
-        sortable: true,
-        removable: true,
-        height: 'auto',
-        scrollOnAdd: true,
-        addButton: 'Add ProxyHost',
-        header: $('<div>').append($.parseHTML(`
-            <div style='width:30%; margin-left:5%; display:inline-grid;'>Proxy</div>
-            <div style='width:auto; margin-right:5%; display:inline-grid;'>Domain Name</div>
-            `)
-        ),
-        buttons: [
-        {
-            label: "Add Reverse Proxy",
-            icon: "fa fa-star",
-            title: "Add a reverse proxy configuration",
-            click: () => {
-                event.stopPropagation();
-                let $btn = $(event.target);
-
-                // Remove any existing dropdown
-                $('.proxy-dropdown').remove();
-
-                // Fetch the list of reverseproxy types.
-                getProxyTypes().then(proxyTypes => {
-                    let $dropdown = $('<div class="proxy-dropdown red-ui-editor"></div>');
-
-                    proxyTypes.forEach(proxyType => {
-                        $('<div class="dropdown-item"></div>')
-                            .text(proxyType.name)
-                            .data('value', proxyType.id)
-                            .css({
-                                padding: '4px 8px',
-                                cursor: 'pointer'
-                            })
-                            .appendTo($dropdown);
-                    });
-
-                    // Position it near the button
-                    $dropdown.css({
-                        top:  $btn.offset().top + $btn.height(),
-                        left: $btn.offset().left
-                    });
-
-                    $('body').append($dropdown);
-
-                    // Handle item selection
-                    $dropdown.on('click', '.dropdown-item', function(e) {
-                        e.stopPropagation();
-                        const selectedValue = $(this).data('value');
-                        const selectedText = $(this).text();
-
-                        // Do whatever you need with the selection
-                        $dropdown.remove();
-                        RED.editor.editConfig("reverseproxy", selectedValue, "_ADD_");
-                    });
-                })
-            },
-        },
-        {
-            label: "Edit Reverse Proxy",
-            icon: "fa fa-edit",
-            title: "Edit a reverse proxy configuration",
-            click: async (event) => {
-                event.stopPropagation();
-
-                // Remove any existing dropdown
-                $('.proxy-dropdown').remove();
-
-                // Build the dropdown from the select's options
-                const $dropdown = $('<div class="proxy-dropdown red-ui-editor"></div>');
-
-                (await getProxies()).forEach(proxy => {
-                    $('<div class="dropdown-item"></div>')
-                    .text(proxy.name)
-                    .data('value', proxy.id)
-                    .data('type', proxy.type)
-                    .css({
-                        padding: '4px 8px',
-                        cursor: 'pointer'
-                    })
-                    .appendTo($dropdown);
-                });
-
-                // Position it near the button
-                let $btn = $(event.target);
-                $dropdown.css({
-                    top: $btn.offset().top + $btn.height(),
-                    left: $btn.offset().left
-                });
-
-                $('body').append($dropdown);
-
-                // Handle item selection
-                $dropdown.on('click', '.dropdown-item', function(e) {
-                    e.stopPropagation();
-                    const selectedType = $(this).data('type');
-                    const selectedValue = $(this).data('value');
-                    const selectedText = $(this).text();
-
-                    // Do whatever you need with the selection
-                    $dropdown.remove();
-                    RED.editor.editConfig("reverseproxy", selectedType, selectedValue);
-                });
-            }
-        }],
-
-        addItem: async function(container, i, proxy){
-            let row =  $('<div/>', {
-                class: 'form-row',
-                style: 'display: flex; margin-bottom: 0;'
-            }).appendTo(container);
-
-            let proxyColumn = $('<select/>', {
-                type: 'text',
-                name: i,
-                required: true,
-                style: 'margin-left: 5px; margin-bottom: 0;',
-                class: 'proxy-proxy'
-            }).appendTo(row);
-
-            (await getProxies()).forEach(proxy => {
-                $('<option value="' + proxy.id + '">' + proxy.name + '</option>').appendTo(proxyColumn);
-            });
-
-            proxyColumn.on("focus", async () => {
-                proxyColumn.empty();
-                (await getProxies()).forEach(proxy => {
-                    $('<option value="' + proxy.id + '">' + proxy.name + '</option>').appendTo(proxyColumn);
-                })
-            });
-
-            proxyColumn.val(proxy.proxy);
-
-            // Add the Domain Name column
-            let domainnameColumn = $('<input/>', {
-                type: 'text',
-                name: i,
-                required: true,
-                style: 'margin-left: 5px; margin-bottom: 0;',
-                class: 'proxy-domainname'
-            }).appendTo(row)
-            domainnameColumn.val(proxy.domainname);
-        },
-        removeItem :function(data){
-            // nothing to do here.
-        },
-    });
-
-    // Close dropdown when clicking anywhere else
-    $(document).on('click', function() {
-        $('.proxy-dropdown').remove();
-    });
-
-    this.reverseProxies_connections = (this.reverseProxies_connections) ? this.reverseProxies_connections : [];
-    reverseProxyList.editableList('addItems', this.reverseProxies_connections);
-}
-</script>
-
-<script type="text/javascript" template-section="onIncludeEditSave">
-{
-    let node = this;
-
-    // pulling the values from the reverseproxy table.
-    let connectionList = $("#reverseproxylist_table").editableList('items');
-    node.reverseProxies_connections = [];
-    connectionList.each(function(i) {
-        node.reverseProxies_connections.push({
-            proxy: $(this).find('.proxy-proxy').val(),
-            domainname: $(this).find('.proxy-domainname').val(),
-        });
-    });
-
-    console.log(node.reverseProxies_connections);
-}
-</script>
-
-<script type="text/html" template-section="onIncludeEditForm">
-    <div id="section_webhookconfig">
-        <div class="form-row editorsectionheading">
-            <i class="w-16 fa fa-eye"></i> <span>Webhook</span>
-        </div>
-        
-        <div class="editorgroupborder">
-            <div class="form-row nomargin">
-                <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 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 class="towb_editorlabel" for="{{defaults.webhookAuth}}"><i class="fa fa-lock"></i> Authentication</label>
-                <input type="text" id="{{defaults.webhookAuth}}" placeholder="none" />
-            </div>
-
-            <div class="webhookauth webhookauth-none">
-            </div>
-
-            <div class="webhookauth webhookauth-basic">
-                <div class="form-row">
-                    <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 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 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 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 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;" />
-                <label style="width:auto" for="{{defaults.reverseProxies_enabled}}"><span>Enable Reverse Proxy</span></label>
-            </div>
-            <div id="section_webhookconfig_reverseproxy" style="display:none">
-                <div class="form-row">
-                    <label></label>
-                    <ol id="reverseproxylist_table" class="theotherwillembotha-compact-table"></ol>
-                </div>
-            </div>
-            </div>
-
-
-        </div>
-    </div>
-</script>
-
-
-<script type="text/markdown" template-section="onIncludeDocumentation">
-### Webhook
-: *server* (webhookserverconfig) : the web server that this webhook will be bound to.
-: *path* (string) : the url path eg '/service' that should be regeistered on the webserver for this webhook callback
-: *authentication* (auth) : the authentication mechanism that should be used on this endpoint
-: *enable reverse proxy* (boolean) : whether this webhook will be exposed using a reverse proxy or not.
-: *reverse proxies* (reverse proxies) : the list of reverse proxies thie endpoint will be exposed on.
-
-### Webhook Authentication
-Three strategies are available for securing the webhook endpoint.
-
-- None:
-The endpoint accepts all incoming requests without any credential check.
-
-- Basic Auth:
-Validates the `Authorization` header on each incoming request against a username and password pair using HTTP Basic Authentication (RFC 7617).
-: *username* (string) : the username expected in the `Authorization` header
-: *password* (string) : the password expected in the `Authorization` header
-
-- API Key:
-Validates a key/value pair carried in the request. Only the `Header` mechanism is currently supported — the key is read from a named request header and compared against the configured value. Requests that do not supply the correct key receive a `401` response.
-: *mechanism* (mechanism) : the transport mechanism for the key. Currently supported: `Header`
-: *key name*  (string)    : the name of the request header carrying the key (e.g. `x-api-key`)
-: *key value* (string)    : the expected value — requests not matching this value are rejected
-
-### Reverse Proxy
-When *enable reverse proxy* is checked, the webhook endpoint is registered with one or more reverse proxy services installed in Node-RED. Reverse proxy types are discovered automatically from any plugin that registers a service tagged `ReverseProxyType` (e.g. an Nginx Proxy Manager integration). Each row in the list maps the internal webhook server to a public-facing domain.
-
-: *proxy*       (ReverseProxyType) : the reverse proxy service to register the endpoint with
-: *domain name* (string)           : the public domain name to expose the endpoint on
-
-The *external host* and *external port* fields on the linked **Webhook Server** config node must be set correctly for the proxy registration to resolve to the right internal address.
-</script>

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

@@ -1,117 +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})
-
-        .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 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="form-row">
-        <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 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 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 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 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">
-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

@@ -1,58 +0,0 @@
-
-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)
-    }
-}

package/src/core/logger/service/LoggerServiceTypes.ts

@@ -1,26 +0,0 @@
-export enum Level{
-    DEBUG = "DEBUG",
-    INFO = "INFO",
-    WARNING = "WARNING",
-    ERROR = "ERROR"
-}
-
-export enum PlatformType {
-    console = 'console',
-    rest = 'rest',
-    loki = 'loki',
-    elasticsearch = 'elasticsearch',
-    datadog = 'datadog',
-}
-
-export enum RestAuthType {
-    none="none",
-    basic="basic",
-    apikey="apikey",
-}
-
-export enum ApiKeyMechanismType {
-    header="header",
-    queryparam="queryparam",
-    matrixparam="matrixparam",
-}