@oino-ts/types 0.0.17 → 0.1.0

package/dist/cjs/OINOBenchmark.js

@@ -1,108 +0,0 @@
-"use strict";
-/*
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OINOBenchmark = void 0;
-/**
- * Static class for benchmarking functions.
- *
- */
-class OINOBenchmark {
-    static _benchmarkCount = {};
-    static _benchmarkData = {};
-    static _benchmarkEnabled = {};
-    static _benchmarkStart = {};
-    /**
-     * Reset benchmark data (but not what is enabled).
-     *
-     */
-    static reset() {
-        this._benchmarkData = {};
-        this._benchmarkCount = {};
-    }
-    /**
-     *  Set benchmark names that are enabled.
-     *
-     *  @param module array of those benchmarks that are enabled
-     */
-    static setEnabled(module) {
-        this._benchmarkEnabled = {};
-        module.forEach(module_name => {
-            this._benchmarkEnabled[module_name] = true;
-        });
-    }
-    /**
-     * Start benchmark timing.
-     *
-     * @param module of the benchmark
-     * @param method of the benchmark
-     */
-    static start(module, method) {
-        const name = module + "." + method;
-        if (this._benchmarkEnabled[module]) {
-            if (this._benchmarkCount[name] == undefined) {
-                this._benchmarkCount[name] = 0;
-                this._benchmarkData[name] = 0;
-            }
-            this._benchmarkStart[name] = performance.now();
-        }
-    }
-    /**
-     * Complete benchmark timing
-     *
-     * @param module of the benchmark
-     * @param method of the benchmark
-     * @param category optional subcategory of the benchmark
-     */
-    static end(module, method, category) {
-        const name = module + "." + method;
-        let result = 0;
-        if (this._benchmarkEnabled[module]) {
-            const duration = performance.now() - this._benchmarkStart[name];
-            this._benchmarkCount[name] += 1;
-            this._benchmarkData[name] += duration;
-            if (category) {
-                const category_name = name + "." + category;
-                if (this._benchmarkCount[category_name] == undefined) {
-                    this._benchmarkCount[category_name] = 0;
-                    this._benchmarkData[category_name] = 0;
-                }
-                this._benchmarkCount[category_name] += 1;
-                this._benchmarkData[category_name] += duration;
-            }
-            result = this._benchmarkData[name] / this._benchmarkCount[name];
-        }
-        return result;
-    }
-    /**
-     * Get given benchmark data.
-     *
-     * @param module of the benchmark
-     * @param method of the benchmark
-     *
-     */
-    static get(module, method) {
-        const name = module + "." + method;
-        if (this._benchmarkEnabled[module]) {
-            return this._benchmarkData[module] / this._benchmarkCount[module];
-        }
-        return -1;
-    }
-    /**
-     * Get all benchmark data.
-     *
-     */
-    static getAll() {
-        let result = {};
-        for (const name in this._benchmarkData) {
-            if (this._benchmarkCount[name] > 0) {
-                result[name] = this._benchmarkData[name] / this._benchmarkCount[name];
-            }
-        }
-        return result;
-    }
-}
-exports.OINOBenchmark = OINOBenchmark;

package/dist/cjs/OINOHtmlTemplate.js

@@ -1,177 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OINOHtmlTemplate = void 0;
-const _1 = require(".");
-/**
- * Class for rendering HTML from data.
- */
-class OINOHtmlTemplate {
-    _tag;
-    _tagCleanRegex;
-    _variables = {};
-    /** HTML template string */
-    template;
-    /** Cache modified value for template */
-    modified;
-    /** Cache expiration value for template */
-    expires;
-    /**
-     * Creates HTML Response from a key-value-pair.
-     *
-     * @param template template string
-     * @param tag tag to identify variables in template
-     *
-     */
-    constructor(template, tag = "###") {
-        this.template = template;
-        this.modified = 0;
-        this.expires = 0;
-        this._tag = tag;
-        this._tagCleanRegex = new RegExp(tag + ".*" + tag, "g");
-    }
-    /**
-     * @returns whether template is empty
-     */
-    isEmpty() {
-        return this.template == "";
-    }
-    _createHttpResult(html, removeUnusedTags) {
-        if (removeUnusedTags) {
-            html = html.replace(this._tagCleanRegex, "");
-        }
-        const result = new _1.OINOHttpResult(html);
-        if (this.expires >= 1) {
-            result.expires = Math.round(this.expires);
-        }
-        if (this.modified >= 1) {
-            result.lastModified = this.modified;
-        }
-        return result;
-    }
-    _renderHtml() {
-        let html = this.template;
-        for (let key in this._variables) {
-            const value = this._variables[key];
-            html = html.replaceAll(this._tag + key + this._tag, value);
-        }
-        return html;
-    }
-    /**
-     * Clear template variables.
-     *
-     */
-    clearVariables() {
-        this._variables = {};
-    }
-    /**
-     * Sets template variable from a key-value-pair.
-     *
-     * @param variable key
-     * @param value value
-     * @param escapeValue whether to escape value
-     *
-     */
-    setVariableFromValue(variable, value, escapeValue = true) {
-        if (escapeValue) {
-            value = _1.OINOStr.encode(value, _1.OINOContentType.html);
-        }
-        this._variables[variable] = value;
-    }
-    /**
-     * Sets template variables from object properties.
-     *
-     * @param object any object
-     * @param escapeValue whether to escape value
-     *
-     */
-    setVariableFromProperties(object, escapeValue = true) {
-        if (object) {
-            for (let key in object) {
-                if (escapeValue) {
-                    this._variables[key] = _1.OINOStr.encode(object[key], _1.OINOContentType.html);
-                }
-                else {
-                    this._variables[key] = object[key];
-                }
-            }
-        }
-    }
-    /**
-     * Creates HTML Response from set variables.
-     *
-     * @param removeUnusedTags whether to remove unused tags
-     *
-     */
-    render(removeUnusedTags = true) {
-        return this._createHttpResult(this._renderHtml(), removeUnusedTags);
-    }
-    /**
-     * Creates HTML Response from a key-value-pair.
-     *
-     * @param key key
-     * @param value value
-     * @param removeUnusedTags whether to remove unused tags
-     *
-     */
-    renderFromKeyValue(key, value, removeUnusedTags = true) {
-        _1.OINOBenchmark.start("OINOHtmlTemplate", "renderFromKeyValue");
-        this.setVariableFromValue(key, value);
-        const result = this.render(removeUnusedTags);
-        _1.OINOBenchmark.end("OINOHtmlTemplate", "renderFromKeyValue");
-        return result;
-    }
-    /**
-     * Creates HTML Response from object properties.
-     *
-     * @param object object
-     * @param removeUnusedTags whether to remove unused tags
-     *
-     */
-    renderFromObject(object, removeUnusedTags = true) {
-        _1.OINOBenchmark.start("OINOHtmlTemplate", "renderFromObject");
-        this.setVariableFromProperties(object);
-        const result = this.render(removeUnusedTags);
-        _1.OINOBenchmark.end("OINOHtmlTemplate", "renderFromObject");
-        return result;
-    }
-    /**
-     * Creates HTML Response from API result.
-     *
-     * @param result OINOResult-object
-     * @param removeUnusedTags whether to remove unused tags
-     * @param messageSeparator HTML separator for messages
-     * @param includeErrorMessages include debug messages in result
-     * @param includeWarningMessages include debug messages in result
-     * @param includeInfoMessages include debug messages in result
-     * @param includeDebugMessages include debug messages in result
-     *
-     */
-    renderFromResult(result, removeUnusedTags = true, messageSeparator, includeErrorMessages = false, includeWarningMessages = false, includeInfoMessages = false, includeDebugMessages = false) {
-        _1.OINOBenchmark.start("OINOHtmlTemplate", "renderFromResult");
-        this.setVariableFromValue("statusCode", result.statusCode.toString());
-        this.setVariableFromValue("statusMessage", result.statusMessage.toString());
-        let messages = [];
-        for (let i = 0; i < result.messages.length; i++) {
-            if (includeErrorMessages && result.messages[i].startsWith(_1.OINO_ERROR_PREFIX)) {
-                messages.push(_1.OINOStr.encode(result.messages[i], _1.OINOContentType.html));
-            }
-            if (includeWarningMessages && result.messages[i].startsWith(_1.OINO_WARNING_PREFIX)) {
-                messages.push(_1.OINOStr.encode(result.messages[i], _1.OINOContentType.html));
-            }
-            if (includeInfoMessages && result.messages[i].startsWith(_1.OINO_INFO_PREFIX)) {
-                messages.push(_1.OINOStr.encode(result.messages[i], _1.OINOContentType.html));
-            }
-            if (includeDebugMessages && result.messages[i].startsWith(_1.OINO_DEBUG_PREFIX)) {
-                messages.push(_1.OINOStr.encode(result.messages[i], _1.OINOContentType.html));
-            }
-        }
-        if (messages.length > 0) {
-            this.setVariableFromValue("messages", messages.join(messageSeparator), false); // messages have been escaped already
-        }
-        const http_result = this.render(removeUnusedTags);
-        _1.OINOBenchmark.end("OINOHtmlTemplate", "renderFromResult");
-        return http_result;
-    }
-}
-exports.OINOHtmlTemplate = OINOHtmlTemplate;
-;

package/dist/cjs/OINOLog.js

@@ -1,140 +0,0 @@
-"use strict";
-/*
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OINOConsoleLog = exports.OINOLog = exports.OINOLogLevel = void 0;
-/** Logging levels */
-var OINOLogLevel;
-(function (OINOLogLevel) {
-    /** Debug messages */
-    OINOLogLevel[OINOLogLevel["debug"] = 0] = "debug";
-    /** Informational messages */
-    OINOLogLevel[OINOLogLevel["info"] = 1] = "info";
-    /** Warning messages */
-    OINOLogLevel[OINOLogLevel["warn"] = 2] = "warn";
-    /** Error messages */
-    OINOLogLevel[OINOLogLevel["error"] = 3] = "error";
-})(OINOLogLevel || (exports.OINOLogLevel = OINOLogLevel = {}));
-/**
- * Abstract base class for logging implementations supporting
- * - error, warning, info and debug channels
- * - setting level of logs outputted
- *
- */
-class OINOLog {
-    static _instance;
-    _logLevel = OINOLogLevel.warn;
-    /**
-     * Abstract logging method to implement the actual logging operation.
-     *
-     * @param logLevel level of the log events
-     *
-     */
-    constructor(logLevel = OINOLogLevel.warn) {
-        // console.log("OINOLog.constructor: logLevel=" + logLevel)
-        this._logLevel = logLevel;
-    }
-    /**
-     * Abstract logging method to implement the actual logging operation.
-     *
-     * @param level level of the log event
-     * @param levelStr level string of the log event
-     * @param message message of the log event
-     * @param data structured data associated with the log event
-     *
-     */
-    static _log(level, levelStr, message, data) {
-        // console.log("_log: level=" + level + ", levelStr=" + levelStr + ", message=" + message + ", data=" + data)
-        if ((OINOLog._instance) && (OINOLog._instance._logLevel <= level)) {
-            OINOLog._instance?._writeLog(levelStr, message, data);
-        }
-    }
-    /**
-     * Set active logger and log level.
-     *
-     * @param logger logger instance
-     *
-     */
-    static setLogger(logger) {
-        // console.log("setLogger: " + log)
-        if (logger) {
-            OINOLog._instance = logger;
-        }
-    }
-    /**
-     * Set log level.
-     *
-     * @param logLevel log level to use
-     *
-     */
-    static setLogLevel(logLevel) {
-        if (OINOLog._instance) {
-            OINOLog._instance._logLevel = logLevel;
-        }
-    }
-    /**
-     * Log error event.
-     *
-     * @param message message of the log event
-     * @param data structured data associated with the log event
-     *
-     */
-    static error(message, data) {
-        OINOLog._log(OINOLogLevel.error, "ERROR", message, data);
-    }
-    /**
-     * Log warning event.
-     *
-     * @param message message of the log event
-     * @param data structured data associated with the log event
-     *
-     */
-    static warning(message, data) {
-        OINOLog._log(OINOLogLevel.warn, "WARN", message, data);
-    }
-    /**
-     * Log info event.
-     *
-     * @param message message of the log event
-     * @param data structured data associated with the log event
-     *
-     */
-    static info(message, data) {
-        OINOLog._log(OINOLogLevel.info, "INFO", message, data);
-    }
-    /**
-     * Log debug event.
-     *
-     * @param message message of the log event
-     * @param data structured data associated with the log event
-     *
-     */
-    static debug(message, data) {
-        OINOLog._log(OINOLogLevel.debug, "DEBUG", message, data);
-    }
-}
-exports.OINOLog = OINOLog;
-/**
- * Logging implementation based on console.log.
- *
- */
-class OINOConsoleLog extends OINOLog {
-    /**
-     * Constructor of `OINOConsoleLog`
-     * @param logLevel logging level
-     */
-    constructor(logLevel = OINOLogLevel.warn) {
-        super(logLevel);
-    }
-    _writeLog(level, message, data) {
-        let log = "OINOLog " + level + ": " + message;
-        if (data) {
-            log += " " + JSON.stringify(data);
-        }
-        console.log(log);
-    }
-}
-exports.OINOConsoleLog = OINOConsoleLog;

package/dist/cjs/OINOResult.js

@@ -1,216 +0,0 @@
-"use strict";
-/*
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OINOHttpResult = exports.OINOResult = void 0;
-const node_crypto_1 = require("node:crypto");
-const _1 = require(".");
-/**
- * OINO API request result object with returned data and/or http status code/message and
- * error / warning messages.
- *
- */
-class OINOResult {
-    /** Wheter request was successfully executed */
-    success;
-    /** HTTP status code */
-    statusCode;
-    /** HTTP status message */
-    statusMessage;
-    /** Error / warning messages */
-    messages;
-    /**
-     * Constructor of OINOResult.
-     *
-     */
-    constructor() {
-        this.success = true;
-        this.statusCode = 200;
-        this.statusMessage = "OK";
-        this.messages = [];
-    }
-    /**
-     * Copy values from different result.
-     *
-     * @param result source value
-     */
-    copy(result) {
-        this.success = result.success;
-        this.statusCode = result.statusCode;
-        this.statusMessage = result.statusMessage;
-        this.messages = result.messages.slice();
-    }
-    /**
-     * Set HTTP OK status (does not reset messages).
-     *
-     */
-    setOk() {
-        this.success = true;
-        this.statusCode = 200;
-        this.statusMessage = "OK";
-    }
-    /**
-     * Set HTTP error status using given code and message. Returns self reference for chaining.
-     *
-     * @param statusCode HTTP status code
-     * @param statusMessage HTTP status message
-     * @param operation operation where error occured
-     *
-     */
-    setError(statusCode, statusMessage, operation) {
-        this.success = false;
-        this.statusCode = statusCode;
-        if (this.statusMessage != "OK") {
-            this.messages.push(this.statusMessage); // latest error becomes status, but if there was something non-trivial, add it to the messages
-        }
-        if (statusMessage.startsWith(_1.OINO_ERROR_PREFIX)) {
-            this.statusMessage = statusMessage;
-        }
-        else {
-            this.statusMessage = _1.OINO_ERROR_PREFIX + " (" + operation + "): " + statusMessage;
-        }
-        return this;
-    }
-    /**
-     * Add warning message. Returns self reference for chaining.
-     *
-     * @param message HTTP status message
-     * @param operation operation where warning occured
-     *
-     */
-    addWarning(message, operation) {
-        message = message.trim();
-        if (message) {
-            this.messages.push(_1.OINO_WARNING_PREFIX + " (" + operation + "): " + message);
-        }
-        return this;
-    }
-    /**
-     * Add info message. Returns self reference for chaining.
-     *
-     * @param message HTTP status message
-     * @param operation operation where info occured
-     *
-     */
-    addInfo(message, operation) {
-        message = message.trim();
-        if (message) {
-            this.messages.push(_1.OINO_INFO_PREFIX + " (" + operation + "): " + message);
-        }
-        return this;
-    }
-    /**
-     * Add debug message. Returns self reference for chaining.
-     *
-     * @param message HTTP status message
-     * @param operation operation where debug occured
-     *
-     */
-    addDebug(message, operation) {
-        message = message.trim();
-        if (message) {
-            this.messages.push(_1.OINO_DEBUG_PREFIX + " (" + operation + "): " + message);
-        }
-        return this;
-    }
-    /**
-     * Copy given messages to HTTP headers.
-     *
-     * @param headers HTTP headers
-     * @param copyErrors wether error messages should be copied (default true)
-     * @param copyWarnings wether warning messages should be copied (default false)
-     * @param copyInfos wether info messages should be copied (default false)
-     * @param copyDebug wether debug messages should be copied (default false)
-     *
-     */
-    copyMessagesToHeaders(headers, copyErrors = true, copyWarnings = false, copyInfos = false, copyDebug = false) {
-        let j = 1;
-        for (let i = 0; i < this.messages.length; i++) {
-            const message = this.messages[i].replaceAll("\r", " ").replaceAll("\n", " ");
-            if (copyErrors && message.startsWith(_1.OINO_ERROR_PREFIX)) {
-                headers.append('X-OINO-MESSAGE-' + j, message);
-                j++;
-            }
-            if (copyWarnings && message.startsWith(_1.OINO_WARNING_PREFIX)) {
-                headers.append('X-OINO-MESSAGE-' + j, message);
-                j++;
-            }
-            if (copyInfos && message.startsWith(_1.OINO_INFO_PREFIX)) {
-                headers.append('X-OINO-MESSAGE-' + j, message);
-                j++;
-            }
-            if (copyDebug && message.startsWith(_1.OINO_DEBUG_PREFIX)) {
-                headers.append('X-OINO-MESSAGE-' + j, message);
-                j++;
-            }
-        }
-    }
-    /**
-     * Print result for logging.
-     *
-     */
-    printLog() {
-        return "OINOResult: statusCode=" + this.statusCode + ", statusMessage=" + this.statusMessage + ", messages=[" + this.messages.join(", ") + "]";
-    }
-}
-exports.OINOResult = OINOResult;
-/**
- * Specialized result for HTTP responses.
- */
-class OINOHttpResult extends OINOResult {
-    _etag;
-    /** HTTP body data */
-    body;
-    /** HTTP cache expiration value */
-    expires;
-    /** HTTP cache last-modified value */
-    lastModified;
-    /**
-     * Constructor for a `OINOHttpResult`
-     *
-     * @param body HTTP body
-     *
-     */
-    constructor(body) {
-        super();
-        this.body = body;
-        this.expires = 0;
-        this.lastModified = 0;
-        this._etag = "";
-    }
-    /**
-     * Get the ETag value for the body opportunistically, i.e. don't calculate until requested and reuse value.
-     *
-     */
-    getEtag() {
-        if (this._etag == "") {
-            const hash = (0, node_crypto_1.createHash)("sha256");
-            this._etag = hash.update(this.body).digest("hex");
-        }
-        return this._etag;
-    }
-    /**
-     * Get a Response object from the result values.
-     *
-     * @param headers HTTP headers (overrides existing values)
-     */
-    getResponse(headers) {
-        const result = new Response(this.body, { status: this.statusCode, statusText: this.statusMessage, headers: headers });
-        result.headers.set('Content-Length', this.body.length.toString());
-        if (this.lastModified > 0) {
-            result.headers.set('Last-Modified', new Date(this.lastModified).toUTCString());
-        }
-        if (this.expires >= 0) {
-            result.headers.set('Expires', Math.round(this.expires).toString());
-            if (this.expires == 0) {
-                result.headers.set('Pragma', 'no-cache');
-            }
-        }
-        result.headers.set("ETag", this.getEtag());
-        return result;
-    }
-}
-exports.OINOHttpResult = OINOHttpResult;