@oino-ts/types 0.0.11 → 0.0.13

package/README.md

@@ -22,7 +22,7 @@
  ```
  
  ### Register database and logger
- Register your database implementation and logger (see [`OINOConsoleLog`](https://pragmatta.github.io/oino-ts/classes/core_src.OINOConsoleLog.html) how to implement your own)
+ Register your database implementation and logger (see [`OINOConsoleLog`](https://pragmatta.github.io/oino-ts/classes/types_src.OINOConsoleLog.html) how to implement your own)
 
  ```
  OINOLog.setLogger(new OINOConsoleLog())
@@ -30,13 +30,13 @@
  ```
 
  ### Create a database
- Creating a database connection [`OINODb`](https://pragmatta.github.io/oino-ts/classes/core_src_OINODb.OINODb.html) is done by passing [`OINODbParams`](https://pragmatta.github.io/oino-ts/types/core_src.OINODbParams.html) to the factory method. For [`OINODbBunSqlite`](https://pragmatta.github.io/oino-ts/classes/bunsqlite_OINODbBunSqlite.OINODbBunSqlite.html) that means a file url for the database file, for others network host, port, credentials etc.
+ Creating a database connection [`OINODb`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODb.html) is done by passing [`OINODbParams`](https://pragmatta.github.io/oino-ts/types/db_src.OINODbParams.html) to the factory method. For [`OINODbBunSqlite`](https://pragmatta.github.io/oino-ts/classes/db_bunsqlite_src.OINODbBunSqlite.html) that means a file url for the database file, for others network host, port, credentials etc.
  ```
  const db:OINODb = await OINOFactory.createDb( { type: "OINODbBunSqlite", url: "file://../localDb/northwind.sqlite" } )
  ```
 
  ### Create an API
- From a database you can create an [`OINOApi`](https://pragmatta.github.io/oino-ts/classes/core_src_OINOApi.OINOApi.html) by passing [`OINOApiParams`](https://pragmatta.github.io/oino-ts/types/core_src.OINOApiParams.html) with table name and preferences to the factory method.
+ From a database you can create an [`OINOApi`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbApi.html) by passing [`OINOApiParams`](https://pragmatta.github.io/oino-ts/types/db_src.OINODbApiParams.html) with table name and preferences to the factory method.
  ```
  const api_employees:OINOApi = await OINOFactory.createApi(db, { tableName: "Employees", excludeFields:["BirthDate"] })
  ```
@@ -49,7 +49,7 @@
  ```
 
  ### Write results back to HTTP Response
- The results for a GET request will contain [`OINOModelSet`](https://pragmatta.github.io/oino-ts/classes/core_src_OINOModelSet.OINOModelSet.html) data that can be written out as JSON or CSV as needed. For other requests result is just success or error with messages.
+ The results for a GET request will contain [`OINOModelSet`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbModelSet.html) data that can be written out as JSON or CSV as needed. For other requests result is just success or error with messages.
  ```
  return new Response(result.modelset.writeString(OINOContentType.json))
  ```
@@ -134,7 +134,7 @@
  To support tables with multipart primary keys OINO generates a composite key `_OINOID_` that is included in the result and can be used as the REST ID. For example in the example above table `OrderDetails` has two primary keys `OrderID` and `ProductID` making the `_OINOID_` of form `11077:99`. 
 
  ## Power Of SQL
- Since OINO controls the SQL, WHERE-conditions can be defined with [`OINOSqlFilter`](https://pragmatta.github.io/oino-ts/classes/core_src.OINOSqlFilter.html) and order with [`OINOSqlOrder`](https://pragmatta.github.io/oino-ts/classes/core_src.OINOSqlOrder.html) that are passed as HTTP request parameters. No more API development where you make unique API endpoints for each filter that fetch all data with original API and filter in backend code. Every API can be filtered when and as needed without unnessecary data tranfer and utilizing SQL indexing when available.
+ Since OINO controls the SQL, WHERE-conditions can be defined with [`OINOSqlFilter`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlFilter.html) and order with [`OINOSqlOrder`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlOrder.html) that are passed as HTTP request parameters. No more API development where you make unique API endpoints for each filter that fetch all data with original API and filter in backend code. Every API can be filtered when and as needed without unnessecary data tranfer and utilizing SQL indexing when available.
 
  ## Swagger Support
  Swagger is great as long as the definitions are updated and with OINO you can automatically get a Swagger definition including a data model schema.
@@ -149,7 +149,7 @@
  OINO is developped Typescript first but compiles to standard CommonJS and the NPM packages should work on either ESM / CommonJS. Checkout sample apps `readmeApp` (ESM) and `nodeApp` (CommonJS).
 
  ## HTMX support
- OINO is [htmx.org](https://htmx.org) friendly, allowing easy translation of [`OINODataRow`](https://pragmatta.github.io/oino-ts/types/core_src.OINODataRow.html) to HTML output using templates (cf. the [htmx sample app](https://github.com/pragmatta/oino-ts/tree/main/samples/htmxApp)).
+ OINO is [htmx.org](https://htmx.org) friendly, allowing easy translation of [`OINODataRow`](https://pragmatta.github.io/oino-ts/types/db_src.OINODataRow.html) to HTML output using templates (cf. the [htmx sample app](https://github.com/pragmatta/oino-ts/tree/main/samples/htmxApp)).
 
  ### Hashids
  Autoinc numeric id's are very pragmatic and fit well with OINO (e.g. using a form without primary key fields to insert new rows with database assigned ids). However it's not always sensible to share information about the sequence. Hashids solve this by masking the original values by encrypting the ids using AES-128 and some randomness. Length of the hashid can be chosen from 12-32 characters where longer ids provide more security. However this should not be considereded a cryptographic solution for keeping ids secret but rather making it infeasible to iterate all ids.

package/dist/cjs/OINOBenchmark.js

@@ -52,15 +52,50 @@ class OINOBenchmark {
      * Complete benchmark timing
      *
      * @param name of the benchmark
+     * @param category optional subcategory of the benchmark
      */
-    static end(name) {
+    static end(name, category) {
         let result = 0;
         if (this._benchmarkEnabled[name]) {
+            const duration = performance.now() - this._benchmarkStart[name];
             this._benchmarkCount[name] += 1;
-            this._benchmarkData[name] += performance.now() - this._benchmarkStart[name];
+            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 name of the benchmark
+     */
+    static get(name) {
+        if (this._benchmarkEnabled[name]) {
+            return this._benchmarkData[name] / this._benchmarkCount[name];
+        }
+        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

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OINOHtmlTemplate = void 0;
+const _1 = require(".");
+/**
+ * Class for rendering HTML from data.
+ */
+class OINOHtmlTemplate {
+    /** 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
+     *
+     */
+    constructor(template) {
+        this.template = template;
+        this.modified = 0;
+        this.expires = 0;
+    }
+    /**
+     * @returns whether template is empty
+     */
+    isEmpty() {
+        return this.template == "";
+    }
+    /**
+     * Creates HTML Response from a key-value-pair.
+     *
+     * @param key key
+     * @param value value
+     *
+     */
+    renderFromKeyValue(key, value) {
+        const html = this.template.replaceAll('###' + key + '###', _1.OINOStr.encode(value, _1.OINOContentType.html));
+        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;
+    }
+    /**
+     * Creates HTML Response from object properties.
+     *
+     * @param object object
+     *
+     */
+    renderFromObject(object) {
+        let html = this.template;
+        if (object) {
+            for (let key in object) {
+                const value = object[key];
+                if (value) {
+                    html = html.replaceAll('###' + key + '###', _1.OINOStr.encode(value.toString(), _1.OINOContentType.html));
+                }
+            }
+        }
+        html = html.replace(/###[^#]*###/g, "");
+        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;
+    }
+    /**
+     * Creates HTML Response from API result.
+     *
+     * @param result OINOResult-object
+     * @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, includeErrorMessages = false, includeWarningMessages = false, includeInfoMessages = false, includeDebugMessages = false) {
+        let html = this.template;
+        html = html.replaceAll('###statusCode###', _1.OINOStr.encode(result.statusCode.toString(), _1.OINOContentType.html));
+        html = html.replaceAll('###statusMessage###', _1.OINOStr.encode(result.statusMessage.toString(), _1.OINOContentType.html));
+        let messages = "";
+        for (let i = 0; i < result.messages.length; i++) {
+            if (includeErrorMessages && result.messages[i].startsWith(_1.OINO_ERROR_PREFIX)) {
+                messages += "<li>" + _1.OINOStr.encode(result.messages[i], _1.OINOContentType.html) + "</li>";
+            }
+            if (includeWarningMessages && result.messages[i].startsWith(_1.OINO_WARNING_PREFIX)) {
+                messages += "<li>" + _1.OINOStr.encode(result.messages[i], _1.OINOContentType.html) + "</li>";
+            }
+            if (includeInfoMessages && result.messages[i].startsWith(_1.OINO_INFO_PREFIX)) {
+                messages += "<li>" + _1.OINOStr.encode(result.messages[i], _1.OINOContentType.html) + "</li>";
+            }
+            if (includeDebugMessages && result.messages[i].startsWith(_1.OINO_DEBUG_PREFIX)) {
+                messages += "<li>" + _1.OINOStr.encode(result.messages[i], _1.OINOContentType.html) + "</li>";
+            }
+        }
+        if (messages) {
+            html = html.replaceAll('###messages###', "<ul>" + messages + "</ul>");
+        }
+        html = html.replace(/###[^#]*###/g, "");
+        const http_result = new _1.OINOHttpResult(html);
+        if (this.expires >= 1) {
+            http_result.expires = Math.round(this.expires);
+        }
+        if (this.modified >= 1) {
+            http_result.lastModified = this.modified;
+        }
+        return http_result;
+    }
+}
+exports.OINOHtmlTemplate = OINOHtmlTemplate;
+;

package/dist/cjs/OINOResult.js

@@ -5,7 +5,8 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OINOResult = void 0;
+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
@@ -31,6 +32,17 @@ class OINOResult {
         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).
      *
@@ -41,7 +53,7 @@ class OINOResult {
         this.statusMessage = "OK";
     }
     /**
-     * Set HTTP error status using given code and message.
+     * Set HTTP error status using given code and message. Returns self reference for chaining.
      *
      * @param statusCode HTTP status code
      * @param statusMessage HTTP status message
@@ -60,9 +72,10 @@ class OINOResult {
         else {
             this.statusMessage = _1.OINO_ERROR_PREFIX + " (" + operation + "): " + statusMessage;
         }
+        return this;
     }
     /**
-     * Add warning message.
+     * Add warning message. Returns self reference for chaining.
      *
      * @param message HTTP status message
      * @param operation operation where warning occured
@@ -73,9 +86,10 @@ class OINOResult {
         if (message) {
             this.messages.push(_1.OINO_WARNING_PREFIX + " (" + operation + "): " + message);
         }
+        return this;
     }
     /**
-     * Add info message.
+     * Add info message. Returns self reference for chaining.
      *
      * @param message HTTP status message
      * @param operation operation where info occured
@@ -86,9 +100,10 @@ class OINOResult {
         if (message) {
             this.messages.push(_1.OINO_INFO_PREFIX + " (" + operation + "): " + message);
         }
+        return this;
     }
     /**
-     * Add debug message.
+     * Add debug message. Returns self reference for chaining.
      *
      * @param message HTTP status message
      * @param operation operation where debug occured
@@ -99,6 +114,7 @@ class OINOResult {
         if (message) {
             this.messages.push(_1.OINO_DEBUG_PREFIX + " (" + operation + "): " + message);
         }
+        return this;
     }
     /**
      * Copy given messages to HTTP headers.
@@ -134,3 +150,60 @@ class OINOResult {
     }
 }
 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;

package/dist/cjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OINOContentType = exports.OINO_DEBUG_PREFIX = exports.OINO_INFO_PREFIX = exports.OINO_WARNING_PREFIX = exports.OINO_ERROR_PREFIX = exports.OINOStr = exports.OINOResult = exports.OINOConsoleLog = exports.OINOLogLevel = exports.OINOLog = exports.OINOBenchmark = void 0;
+exports.OINOContentType = exports.OINO_DEBUG_PREFIX = exports.OINO_INFO_PREFIX = exports.OINO_WARNING_PREFIX = exports.OINO_ERROR_PREFIX = exports.OINOHtmlTemplate = exports.OINOStr = exports.OINOHttpResult = exports.OINOResult = exports.OINOConsoleLog = exports.OINOLogLevel = exports.OINOLog = exports.OINOBenchmark = void 0;
 var OINOBenchmark_js_1 = require("./OINOBenchmark.js");
 Object.defineProperty(exports, "OINOBenchmark", { enumerable: true, get: function () { return OINOBenchmark_js_1.OINOBenchmark; } });
 var OINOLog_js_1 = require("./OINOLog.js");
@@ -9,8 +9,11 @@ Object.defineProperty(exports, "OINOLogLevel", { enumerable: true, get: function
 Object.defineProperty(exports, "OINOConsoleLog", { enumerable: true, get: function () { return OINOLog_js_1.OINOConsoleLog; } });
 var OINOResult_js_1 = require("./OINOResult.js");
 Object.defineProperty(exports, "OINOResult", { enumerable: true, get: function () { return OINOResult_js_1.OINOResult; } });
+Object.defineProperty(exports, "OINOHttpResult", { enumerable: true, get: function () { return OINOResult_js_1.OINOHttpResult; } });
 var OINOStr_js_1 = require("./OINOStr.js");
 Object.defineProperty(exports, "OINOStr", { enumerable: true, get: function () { return OINOStr_js_1.OINOStr; } });
+var OINOHtmlTemplate_js_1 = require("./OINOHtmlTemplate.js");
+Object.defineProperty(exports, "OINOHtmlTemplate", { enumerable: true, get: function () { return OINOHtmlTemplate_js_1.OINOHtmlTemplate; } });
 /** OINO error message prefix */
 exports.OINO_ERROR_PREFIX = "OINO ERROR";
 /** OINO warning message prefix */

package/dist/esm/OINOBenchmark.js

@@ -49,14 +49,49 @@ export class OINOBenchmark {
      * Complete benchmark timing
      *
      * @param name of the benchmark
+     * @param category optional subcategory of the benchmark
      */
-    static end(name) {
+    static end(name, category) {
         let result = 0;
         if (this._benchmarkEnabled[name]) {
+            const duration = performance.now() - this._benchmarkStart[name];
             this._benchmarkCount[name] += 1;
-            this._benchmarkData[name] += performance.now() - this._benchmarkStart[name];
+            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 name of the benchmark
+     */
+    static get(name) {
+        if (this._benchmarkEnabled[name]) {
+            return this._benchmarkData[name] / this._benchmarkCount[name];
+        }
+        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;
+    }
 }

package/dist/esm/OINOHtmlTemplate.js

@@ -0,0 +1,116 @@
+import { OINOStr, OINOContentType, OINOHttpResult, OINO_ERROR_PREFIX, OINO_WARNING_PREFIX, OINO_INFO_PREFIX, OINO_DEBUG_PREFIX } from ".";
+/**
+ * Class for rendering HTML from data.
+ */
+export class OINOHtmlTemplate {
+    /** 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
+     *
+     */
+    constructor(template) {
+        this.template = template;
+        this.modified = 0;
+        this.expires = 0;
+    }
+    /**
+     * @returns whether template is empty
+     */
+    isEmpty() {
+        return this.template == "";
+    }
+    /**
+     * Creates HTML Response from a key-value-pair.
+     *
+     * @param key key
+     * @param value value
+     *
+     */
+    renderFromKeyValue(key, value) {
+        const html = this.template.replaceAll('###' + key + '###', OINOStr.encode(value, OINOContentType.html));
+        const result = new OINOHttpResult(html);
+        if (this.expires >= 1) {
+            result.expires = Math.round(this.expires);
+        }
+        if (this.modified >= 1) {
+            result.lastModified = this.modified;
+        }
+        return result;
+    }
+    /**
+     * Creates HTML Response from object properties.
+     *
+     * @param object object
+     *
+     */
+    renderFromObject(object) {
+        let html = this.template;
+        if (object) {
+            for (let key in object) {
+                const value = object[key];
+                if (value) {
+                    html = html.replaceAll('###' + key + '###', OINOStr.encode(value.toString(), OINOContentType.html));
+                }
+            }
+        }
+        html = html.replace(/###[^#]*###/g, "");
+        const result = new OINOHttpResult(html);
+        if (this.expires >= 1) {
+            result.expires = Math.round(this.expires);
+        }
+        if (this.modified >= 1) {
+            result.lastModified = this.modified;
+        }
+        return result;
+    }
+    /**
+     * Creates HTML Response from API result.
+     *
+     * @param result OINOResult-object
+     * @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, includeErrorMessages = false, includeWarningMessages = false, includeInfoMessages = false, includeDebugMessages = false) {
+        let html = this.template;
+        html = html.replaceAll('###statusCode###', OINOStr.encode(result.statusCode.toString(), OINOContentType.html));
+        html = html.replaceAll('###statusMessage###', OINOStr.encode(result.statusMessage.toString(), OINOContentType.html));
+        let messages = "";
+        for (let i = 0; i < result.messages.length; i++) {
+            if (includeErrorMessages && result.messages[i].startsWith(OINO_ERROR_PREFIX)) {
+                messages += "<li>" + OINOStr.encode(result.messages[i], OINOContentType.html) + "</li>";
+            }
+            if (includeWarningMessages && result.messages[i].startsWith(OINO_WARNING_PREFIX)) {
+                messages += "<li>" + OINOStr.encode(result.messages[i], OINOContentType.html) + "</li>";
+            }
+            if (includeInfoMessages && result.messages[i].startsWith(OINO_INFO_PREFIX)) {
+                messages += "<li>" + OINOStr.encode(result.messages[i], OINOContentType.html) + "</li>";
+            }
+            if (includeDebugMessages && result.messages[i].startsWith(OINO_DEBUG_PREFIX)) {
+                messages += "<li>" + OINOStr.encode(result.messages[i], OINOContentType.html) + "</li>";
+            }
+        }
+        if (messages) {
+            html = html.replaceAll('###messages###', "<ul>" + messages + "</ul>");
+        }
+        html = html.replace(/###[^#]*###/g, "");
+        const http_result = new OINOHttpResult(html);
+        if (this.expires >= 1) {
+            http_result.expires = Math.round(this.expires);
+        }
+        if (this.modified >= 1) {
+            http_result.lastModified = this.modified;
+        }
+        return http_result;
+    }
+}
+;

package/dist/esm/OINOResult.js

@@ -3,6 +3,7 @@
  * 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/.
  */
+import { createHash } from "node:crypto";
 import { OINO_DEBUG_PREFIX, OINO_ERROR_PREFIX, OINO_INFO_PREFIX, OINO_WARNING_PREFIX } from ".";
 /**
  * OINO API request result object with returned data and/or http status code/message and
@@ -28,6 +29,17 @@ export class OINOResult {
         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).
      *
@@ -38,7 +50,7 @@ export class OINOResult {
         this.statusMessage = "OK";
     }
     /**
-     * Set HTTP error status using given code and message.
+     * Set HTTP error status using given code and message. Returns self reference for chaining.
      *
      * @param statusCode HTTP status code
      * @param statusMessage HTTP status message
@@ -57,9 +69,10 @@ export class OINOResult {
         else {
             this.statusMessage = OINO_ERROR_PREFIX + " (" + operation + "): " + statusMessage;
         }
+        return this;
     }
     /**
-     * Add warning message.
+     * Add warning message. Returns self reference for chaining.
      *
      * @param message HTTP status message
      * @param operation operation where warning occured
@@ -70,9 +83,10 @@ export class OINOResult {
         if (message) {
             this.messages.push(OINO_WARNING_PREFIX + " (" + operation + "): " + message);
         }
+        return this;
     }
     /**
-     * Add info message.
+     * Add info message. Returns self reference for chaining.
      *
      * @param message HTTP status message
      * @param operation operation where info occured
@@ -83,9 +97,10 @@ export class OINOResult {
         if (message) {
             this.messages.push(OINO_INFO_PREFIX + " (" + operation + "): " + message);
         }
+        return this;
     }
     /**
-     * Add debug message.
+     * Add debug message. Returns self reference for chaining.
      *
      * @param message HTTP status message
      * @param operation operation where debug occured
@@ -96,6 +111,7 @@ export class OINOResult {
         if (message) {
             this.messages.push(OINO_DEBUG_PREFIX + " (" + operation + "): " + message);
         }
+        return this;
     }
     /**
      * Copy given messages to HTTP headers.
@@ -130,3 +146,59 @@ export class OINOResult {
         }
     }
 }
+/**
+ * Specialized result for HTTP responses.
+ */
+export 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 = 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;
+    }
+}

package/dist/esm/index.js

@@ -1,7 +1,8 @@
 export { OINOBenchmark } from "./OINOBenchmark.js";
 export { OINOLog, OINOLogLevel, OINOConsoleLog } from "./OINOLog.js";
-export { OINOResult } from "./OINOResult.js";
+export { OINOResult, OINOHttpResult } from "./OINOResult.js";
 export { OINOStr } from "./OINOStr.js";
+export { OINOHtmlTemplate } from "./OINOHtmlTemplate.js";
 /** OINO error message prefix */
 export const OINO_ERROR_PREFIX = "OINO ERROR";
 /** OINO warning message prefix */

package/dist/types/OINOBenchmark.d.ts

@@ -28,6 +28,18 @@ export declare class OINOBenchmark {
      * Complete benchmark timing
      *
      * @param name of the benchmark
+     * @param category optional subcategory of the benchmark
      */
-    static end(name: string): number;
+    static end(name: string, category?: string): number;
+    /**
+     * Get given benchmark data.
+     *
+     * @param name of the benchmark
+     */
+    static get(name: string): number;
+    /**
+     * Get all benchmark data.
+     *
+     */
+    static getAll(): number;
 }

package/dist/types/OINOHtmlTemplate.d.ts

@@ -0,0 +1,49 @@
+import { OINOResult, OINOHttpResult } from ".";
+/**
+ * Class for rendering HTML from data.
+ */
+export declare class OINOHtmlTemplate {
+    /** HTML template string */
+    template: string;
+    /** Cache modified value for template */
+    modified: number;
+    /** Cache expiration value for template */
+    expires: number;
+    /**
+     * Creates HTML Response from a key-value-pair.
+     *
+     * @param template template string
+     *
+     */
+    constructor(template: string);
+    /**
+     * @returns whether template is empty
+     */
+    isEmpty(): boolean;
+    /**
+     * Creates HTML Response from a key-value-pair.
+     *
+     * @param key key
+     * @param value value
+     *
+     */
+    renderFromKeyValue(key: string, value: string): OINOHttpResult;
+    /**
+     * Creates HTML Response from object properties.
+     *
+     * @param object object
+     *
+     */
+    renderFromObject(object: any): OINOHttpResult;
+    /**
+     * Creates HTML Response from API result.
+     *
+     * @param result OINOResult-object
+     * @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: OINOResult, includeErrorMessages?: boolean, includeWarningMessages?: boolean, includeInfoMessages?: boolean, includeDebugMessages?: boolean): OINOHttpResult;
+}

package/dist/types/OINOResult.d.ts

@@ -17,44 +17,50 @@ export declare class OINOResult {
      *
      */
     constructor();
+    /**
+     * Copy values from different result.
+     *
+     * @param result source value
+     */
+    copy(result: OINOResult): void;
     /**
      * Set HTTP OK status (does not reset messages).
      *
      */
     setOk(): void;
     /**
-     * Set HTTP error status using given code and message.
+     * 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: number, statusMessage: string, operation: string): void;
+    setError(statusCode: number, statusMessage: string, operation: string): OINOResult;
     /**
-     * Add warning message.
+     * Add warning message. Returns self reference for chaining.
      *
      * @param message HTTP status message
      * @param operation operation where warning occured
      *
      */
-    addWarning(message: string, operation: string): void;
+    addWarning(message: string, operation: string): OINOResult;
     /**
-     * Add info message.
+     * Add info message. Returns self reference for chaining.
      *
      * @param message HTTP status message
      * @param operation operation where info occured
      *
      */
-    addInfo(message: string, operation: string): void;
+    addInfo(message: string, operation: string): OINOResult;
     /**
-     * Add debug message.
+     * Add debug message. Returns self reference for chaining.
      *
      * @param message HTTP status message
      * @param operation operation where debug occured
      *
      */
-    addDebug(message: string, operation: string): void;
+    addDebug(message: string, operation: string): OINOResult;
     /**
      * Copy given messages to HTTP headers.
      *
@@ -67,3 +73,33 @@ export declare class OINOResult {
      */
     copyMessagesToHeaders(headers: Headers, copyErrors?: boolean, copyWarnings?: boolean, copyInfos?: boolean, copyDebug?: boolean): void;
 }
+/**
+ * Specialized result for HTTP responses.
+ */
+export declare class OINOHttpResult extends OINOResult {
+    private _etag;
+    /** HTTP body data */
+    readonly body: string;
+    /** HTTP cache expiration value */
+    expires: number;
+    /** HTTP cache last-modified value */
+    lastModified: number;
+    /**
+     * Constructor for a `OINOHttpResult`
+     *
+     * @param body HTTP body
+     *
+     */
+    constructor(body: string);
+    /**
+     * Get the ETag value for the body opportunistically, i.e. don't calculate until requested and reuse value.
+     *
+     */
+    getEtag(): string;
+    /**
+     * Get a Response object from the result values.
+     *
+     * @param headers HTTP headers (overrides existing values)
+     */
+    getResponse(headers?: Record<string, string>): Response;
+}

package/dist/types/index.d.ts

@@ -1,7 +1,8 @@
 export { OINOBenchmark } from "./OINOBenchmark.js";
 export { OINOLog, OINOLogLevel, OINOConsoleLog } from "./OINOLog.js";
-export { OINOResult } from "./OINOResult.js";
+export { OINOResult, OINOHttpResult } from "./OINOResult.js";
 export { OINOStr } from "./OINOStr.js";
+export { OINOHtmlTemplate } from "./OINOHtmlTemplate.js";
 /** OINO error message prefix */
 export declare const OINO_ERROR_PREFIX = "OINO ERROR";
 /** OINO warning message prefix */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/types",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "description": "OINO TS package for types.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",

package/src/OINOBenchmark.ts

@@ -55,14 +55,51 @@ export class OINOBenchmark {
      * Complete benchmark timing
      * 
      * @param name of the benchmark
+     * @param category optional subcategory of the benchmark
      */
-    static end(name:string):number {
+    static end(name:string, category?:string):number {
         let result:number = 0
         if (this._benchmarkEnabled[name]) {
+            const duration = performance.now() - this._benchmarkStart[name]
             this._benchmarkCount[name] += 1
-            this._benchmarkData[name] += performance.now() - this._benchmarkStart[name]
+            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 name of the benchmark
+     */
+    static get(name:string):number {
+        if (this._benchmarkEnabled[name]) {
+            return this._benchmarkData[name] / this._benchmarkCount[name]
+        }
+        return -1
+    }
+
+    /**
+     * Get all benchmark data.
+     * 
+     */
+    static getAll():number {
+        let result:any = {}
+        for (const name in this._benchmarkData) {
+            if (this._benchmarkCount[name] > 0) {
+                result[name] = this._benchmarkData[name] / this._benchmarkCount[name]
+            }
+        }
+        return result
+    }
 }

package/src/OINOHtmlTemplate.ts

@@ -0,0 +1,124 @@
+import { OINOStr, OINOContentType, OINOResult, OINOHttpResult, OINO_ERROR_PREFIX, OINO_WARNING_PREFIX, OINO_INFO_PREFIX, OINO_DEBUG_PREFIX } from "."
+
+/**
+ * Class for rendering HTML from data. 
+ */
+export class OINOHtmlTemplate {
+    /** HTML template string */
+	template: string;
+
+    /** Cache modified value for template */
+	modified: number;
+
+    /** Cache expiration value for template */
+	expires: number;
+
+    /**
+     * Creates HTML Response from a key-value-pair.
+     *
+     * @param template template string
+     * 
+     */
+	constructor (template:string) {
+		this.template = template
+		this.modified = 0
+		this.expires = 0
+	}
+
+    /**
+     * @returns whether template is empty
+     */
+	isEmpty():boolean {
+		return this.template == ""
+	}
+
+    /**
+     * Creates HTML Response from a key-value-pair.
+     *
+     * @param key key
+     * @param value value
+     * 
+     */
+    renderFromKeyValue(key:string, value:string):OINOHttpResult {
+        const html:string = this.template.replaceAll('###' + key + '###', OINOStr.encode(value, OINOContentType.html))
+        const result:OINOHttpResult = new OINOHttpResult(html) 
+		if (this.expires >= 1) {
+			result.expires = Math.round(this.expires)
+		}
+		if (this.modified >= 1) {
+			result.lastModified = this.modified
+		}
+        return result
+    }
+
+	/**
+     * Creates HTML Response from object properties.
+     *
+     * @param object object
+     * 
+     */
+    renderFromObject(object:any):OINOHttpResult {
+        let html:string = this.template
+        if (object) {
+            for (let key in object) {
+                const value = object[key]
+                if (value) {
+                    html = html.replaceAll('###' + key + '###', OINOStr.encode(value.toString(), OINOContentType.html))
+                }
+            }
+        }
+        html = html.replace(/###[^#]*###/g, "")
+        const result:OINOHttpResult = new OINOHttpResult(html) 
+		if (this.expires >= 1) {
+			result.expires = Math.round(this.expires)
+		}
+		if (this.modified >= 1) {
+			result.lastModified = this.modified
+		}
+        return result
+    }
+
+    /**
+     * Creates HTML Response from API result.
+     *
+     * @param result OINOResult-object
+     * @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:OINOResult, includeErrorMessages:boolean=false, includeWarningMessages:boolean=false, includeInfoMessages:boolean=false, includeDebugMessages:boolean=false):OINOHttpResult {
+        let html:string = this.template
+        html = html.replaceAll('###statusCode###', OINOStr.encode(result.statusCode.toString(), OINOContentType.html))
+        html = html.replaceAll('###statusMessage###', OINOStr.encode(result.statusMessage.toString(), OINOContentType.html))
+        let messages = ""
+        for (let i:number = 0; i<result.messages.length; i++) {
+            if (includeErrorMessages && result.messages[i].startsWith(OINO_ERROR_PREFIX)) {
+                messages += "<li>" + OINOStr.encode(result.messages[i], OINOContentType.html) + "</li>"
+            } 
+            if (includeWarningMessages && result.messages[i].startsWith(OINO_WARNING_PREFIX)) {
+                messages += "<li>" + OINOStr.encode(result.messages[i], OINOContentType.html) + "</li>"
+            } 
+            if (includeInfoMessages && result.messages[i].startsWith(OINO_INFO_PREFIX)) {
+                messages += "<li>" + OINOStr.encode(result.messages[i], OINOContentType.html) + "</li>"
+            } 
+            if (includeDebugMessages && result.messages[i].startsWith(OINO_DEBUG_PREFIX)) {
+                messages += "<li>" + OINOStr.encode(result.messages[i], OINOContentType.html) + "</li>"
+            } 
+            
+        }
+        if (messages) {
+            html = html.replaceAll('###messages###', "<ul>" + messages + "</ul>")
+        }
+        html = html.replace(/###[^#]*###/g, "")
+        const http_result:OINOHttpResult = new OINOHttpResult(html) 
+		if (this.expires >= 1) {
+			http_result.expires = Math.round(this.expires)
+		}
+		if (this.modified >= 1) {
+			http_result.lastModified = this.modified
+		}
+        return http_result
+    }
+};

package/src/OINOResult.ts

@@ -4,6 +4,7 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
+import { createHash, Hash } from "node:crypto";
 import { OINO_DEBUG_PREFIX, OINO_ERROR_PREFIX, OINO_INFO_PREFIX, OINO_WARNING_PREFIX } from ".";
 
 /**
@@ -35,6 +36,18 @@ export class OINOResult {
         this.messages = []
     }
 
+    /**
+     * Copy values from different result.
+     * 
+     * @param result source value
+     */
+    copy(result: OINOResult) {
+        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).
      *
@@ -46,14 +59,14 @@ export class OINOResult {
     }
 
     /**
-     * Set HTTP error status using given code and message.
+     * 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:number, statusMessage:string, operation:string) {
+    setError(statusCode:number, statusMessage:string, operation:string):OINOResult {
         this.success = false
         this.statusCode = statusCode
         if (this.statusMessage != "OK") {
@@ -64,48 +77,52 @@ export class OINOResult {
         } else {
             this.statusMessage = OINO_ERROR_PREFIX + " (" + operation + "): " + statusMessage
         }
+        return this
     }
 
     /**
-     * Add warning message.
+     * Add warning message. Returns self reference for chaining.
      *
      * @param message HTTP status message
      * @param operation operation where warning occured
      * 
      */
-    addWarning(message:string, operation:string) {
+    addWarning(message:string, operation:string):OINOResult {
         message = message.trim()
         if (message) {
             this.messages.push(OINO_WARNING_PREFIX + " (" + operation + "): " + message)
         }
+        return this
     }
 
     /**
-     * Add info message.
+     * Add info message. Returns self reference for chaining.
      *
      * @param message HTTP status message
      * @param operation operation where info occured
      *
      */
-    addInfo(message:string, operation:string) {
+    addInfo(message:string, operation:string):OINOResult {
         message = message.trim()
         if (message) {
             this.messages.push(OINO_INFO_PREFIX + " (" + operation + "): " + message)
         }
+        return this
     }
 
     /**
-     * Add debug message.
+     * Add debug message. Returns self reference for chaining.
      *
      * @param message HTTP status message
      * @param operation operation where debug occured
      *
      */
-    addDebug(message:string, operation:string) {
+    addDebug(message:string, operation:string):OINOResult {
         message = message.trim()
         if (message) {
             this.messages.push(OINO_DEBUG_PREFIX + " (" + operation + "): " + message)
         }
+        return this
     }
 
     /**
@@ -141,3 +158,69 @@ export class OINOResult {
         }
     }
 }
+
+/**
+ * Specialized result for HTTP responses.
+ */
+export class OINOHttpResult extends OINOResult {
+    private _etag:string
+
+    /** HTTP body data */
+    readonly body: string
+
+    /** HTTP cache expiration value */
+    expires: number
+
+    /** HTTP cache last-modified value */
+    lastModified: number
+
+    /**
+     * Constructor for a `OINOHttpResult` 
+     * 
+     * @param body HTTP body
+     * 
+     */
+    constructor(body:string) {
+        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():string {
+        if (this._etag == "") {
+            const hash:Hash = 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?:Record<string, string>):Response {
+        const result:Response = 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
+    }
+
+
+
+}

package/src/index.ts

@@ -1,7 +1,8 @@
 export { OINOBenchmark } from "./OINOBenchmark.js"
 export { OINOLog, OINOLogLevel, OINOConsoleLog } from "./OINOLog.js"
-export { OINOResult } from "./OINOResult.js"
+export { OINOResult, OINOHttpResult } from "./OINOResult.js"
 export { OINOStr } from "./OINOStr.js"
+export { OINOHtmlTemplate } from "./OINOHtmlTemplate.js"
 
 /** OINO error message prefix */
 export const OINO_ERROR_PREFIX = "OINO ERROR"