@oino-ts/types 0.0.14 → 0.0.16

package/README.md

@@ -10,15 +10,15 @@
  # GETTING STARTED
  
  ### Setup
- Install the `@oino-ts/core` npm package and necessary database packages and import them in your code.
+ Install the `@oino-ts/db` npm package and necessary database packages and import them in your code.
  ```
- bun install @oino-ts/core
- bun install @oino-ts/bunsqlite
+ bun install @oino-ts/db
+ bun install @oino-ts/db-bunsqlite
  ```
  
  ```
- import { OINODb, OINOApi, OINOFactory } from "@oino-ts/core";
- import { OINODbBunSqlite } from "@oino-ts/bunsqlite"
+ import { OINODb, OINOApi, OINOFactory } from "@oino-ts/db";
+ import { OINODbBunSqlite } from "@oino-ts/db-bunsqlite"
  ```
  
  ### Register database and logger
@@ -51,7 +51,7 @@
  ### Write results back to HTTP Response
  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))
+ return new Response(result.data.writeString(OINOContentType.json))
  ```
  
  
@@ -129,12 +129,13 @@
  - Bun Sqlite through Bun native implementation
  - Postgresql through [pg](https://www.npmjs.com/package/pg)-package
  - Mariadb / Mysql-support through [mariadb](https://www.npmjs.com/package/mariadb)-package
+ - Sql Server through [mssql](https://www.npmjs.com/package/mssql)-package
 
  ## Complex Keys
  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/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.
+ Since OINO is just generating 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.
@@ -158,7 +159,7 @@
  # STATUS
  OINO is currently a hobby project which should and should considered in alpha status. That also means compatibility breaking changes can be made without prior notice when architectual issues are discovered.
 
- ## Beta
+ ## Beta 
  For a beta status following milestones are planned:
 
  ### Realistic app
@@ -205,14 +206,16 @@
  # LINKS
  - [Github repository](https://github.com/pragmatta/oino-ts)
  - [NPM repository](https://www.npmjs.com/org/oino-ts) 
-
+ 
  
  # ACKNOWLEDGEMENTS
  
  ## Libraries
  OINO uses the following open source libraries and npm packages and I would like to thank everyone for their contributions:
- - Postgresql support by [node-postgres package](https://www.npmjs.com/package/pg)
- - Mariadb / Mysql-support by [mariadb package](https://www.npmjs.com/package/mariadb)
+ - Postgresql [node-postgres package](https://www.npmjs.com/package/pg)
+ - Mariadb / Mysql [mariadb package](https://www.npmjs.com/package/mariadb)
+ - Sql Server [mssql package](https://www.npmjs.com/package/mssql)
+ - Custom base encoding [base-x package](https://www.npmjs.com/package/base-x)
 
  ## Bun
  OINO has been developed using the Bun runtime, not because of the speed improvements but for the first class Typescript support and integrated developper experience. Kudos on the bun team for making Typescript work more exiting again.

package/dist/cjs/OINOHtmlTemplate.js

@@ -6,6 +6,9 @@ const _1 = require(".");
  * Class for rendering HTML from data.
  */
 class OINOHtmlTemplate {
+    _tag;
+    _tagCleanRegex;
+    _variables = {};
     /** HTML template string */
     template;
     /** Cache modified value for template */
@@ -16,12 +19,15 @@ class OINOHtmlTemplate {
      * Creates HTML Response from a key-value-pair.
      *
      * @param template template string
+     * @param tag tag to identify variables in template
      *
      */
-    constructor(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
@@ -29,16 +35,10 @@ class OINOHtmlTemplate {
     isEmpty() {
         return this.template == "";
     }
-    /**
-     * Creates HTML Response from a key-value-pair.
-     *
-     * @param key key
-     * @param value value
-     *
-     */
-    renderFromKeyValue(key, value) {
-        _1.OINOBenchmark.start("OINOHtmlTemplate", "renderFromKeyValue");
-        const html = this.template.replaceAll('###' + key + '###', _1.OINOStr.encode(value, _1.OINOContentType.html));
+    _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);
@@ -46,34 +46,91 @@ class OINOHtmlTemplate {
         if (this.modified >= 1) {
             result.lastModified = this.modified;
         }
-        _1.OINOBenchmark.end("OINOHtmlTemplate", "renderFromKeyValue");
         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;
+    }
     /**
-     * Creates HTML Response from object properties.
+     * Clear template variables.
      *
-     * @param object object
+     */
+    clearVariables() {
+        this._variables = {};
+    }
+    /**
+     * Sets template variable from a key-value-pair.
+     *
+     * @param variable key
+     * @param value value
+     * @param escapeValue whether to escape value
      *
      */
-    renderFromObject(object) {
-        _1.OINOBenchmark.start("OINOHtmlTemplate", "renderFromObject");
-        let html = this.template;
+    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) {
-                const value = object[key];
-                if (value) {
-                    html = html.replaceAll('###' + key + '###', _1.OINOStr.encode(value.toString(), _1.OINOContentType.html));
+                if (escapeValue) {
+                    this._variables[key] = _1.OINOStr.encode(object[key], _1.OINOContentType.html);
+                }
+                else {
+                    this._variables[key] = object[key];
                 }
             }
         }
-        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;
-        }
+    }
+    /**
+     * 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;
     }
@@ -81,43 +138,37 @@ class OINOHtmlTemplate {
      * 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, includeErrorMessages = false, includeWarningMessages = false, includeInfoMessages = false, includeDebugMessages = false) {
+    renderFromResult(result, removeUnusedTags = true, messageSeparator, includeErrorMessages = false, includeWarningMessages = false, includeInfoMessages = false, includeDebugMessages = false) {
         _1.OINOBenchmark.start("OINOHtmlTemplate", "renderFromResult");
-        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 = "";
+        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 += "<li>" + _1.OINOStr.encode(result.messages[i], _1.OINOContentType.html) + "</li>";
+                messages.push(_1.OINOStr.encode(result.messages[i], _1.OINOContentType.html));
             }
             if (includeWarningMessages && result.messages[i].startsWith(_1.OINO_WARNING_PREFIX)) {
-                messages += "<li>" + _1.OINOStr.encode(result.messages[i], _1.OINOContentType.html) + "</li>";
+                messages.push(_1.OINOStr.encode(result.messages[i], _1.OINOContentType.html));
             }
             if (includeInfoMessages && result.messages[i].startsWith(_1.OINO_INFO_PREFIX)) {
-                messages += "<li>" + _1.OINOStr.encode(result.messages[i], _1.OINOContentType.html) + "</li>";
+                messages.push(_1.OINOStr.encode(result.messages[i], _1.OINOContentType.html));
             }
             if (includeDebugMessages && result.messages[i].startsWith(_1.OINO_DEBUG_PREFIX)) {
-                messages += "<li>" + _1.OINOStr.encode(result.messages[i], _1.OINOContentType.html) + "</li>";
+                messages.push(_1.OINOStr.encode(result.messages[i], _1.OINOContentType.html));
             }
         }
-        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;
+        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;
     }

package/dist/esm/OINOHtmlTemplate.js

@@ -3,6 +3,9 @@ import { OINOStr, OINOContentType, OINOHttpResult, OINO_ERROR_PREFIX, OINO_WARNI
  * Class for rendering HTML from data.
  */
 export class OINOHtmlTemplate {
+    _tag;
+    _tagCleanRegex;
+    _variables = {};
     /** HTML template string */
     template;
     /** Cache modified value for template */
@@ -13,12 +16,15 @@ export class OINOHtmlTemplate {
      * Creates HTML Response from a key-value-pair.
      *
      * @param template template string
+     * @param tag tag to identify variables in template
      *
      */
-    constructor(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
@@ -26,16 +32,10 @@ export class OINOHtmlTemplate {
     isEmpty() {
         return this.template == "";
     }
-    /**
-     * Creates HTML Response from a key-value-pair.
-     *
-     * @param key key
-     * @param value value
-     *
-     */
-    renderFromKeyValue(key, value) {
-        OINOBenchmark.start("OINOHtmlTemplate", "renderFromKeyValue");
-        const html = this.template.replaceAll('###' + key + '###', OINOStr.encode(value, OINOContentType.html));
+    _createHttpResult(html, removeUnusedTags) {
+        if (removeUnusedTags) {
+            html = html.replace(this._tagCleanRegex, "");
+        }
         const result = new OINOHttpResult(html);
         if (this.expires >= 1) {
             result.expires = Math.round(this.expires);
@@ -43,34 +43,91 @@ export class OINOHtmlTemplate {
         if (this.modified >= 1) {
             result.lastModified = this.modified;
         }
-        OINOBenchmark.end("OINOHtmlTemplate", "renderFromKeyValue");
         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;
+    }
     /**
-     * Creates HTML Response from object properties.
+     * Clear template variables.
      *
-     * @param object object
+     */
+    clearVariables() {
+        this._variables = {};
+    }
+    /**
+     * Sets template variable from a key-value-pair.
+     *
+     * @param variable key
+     * @param value value
+     * @param escapeValue whether to escape value
      *
      */
-    renderFromObject(object) {
-        OINOBenchmark.start("OINOHtmlTemplate", "renderFromObject");
-        let html = this.template;
+    setVariableFromValue(variable, value, escapeValue = true) {
+        if (escapeValue) {
+            value = OINOStr.encode(value, 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) {
-                const value = object[key];
-                if (value) {
-                    html = html.replaceAll('###' + key + '###', OINOStr.encode(value.toString(), OINOContentType.html));
+                if (escapeValue) {
+                    this._variables[key] = OINOStr.encode(object[key], OINOContentType.html);
+                }
+                else {
+                    this._variables[key] = object[key];
                 }
             }
         }
-        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;
-        }
+    }
+    /**
+     * 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) {
+        OINOBenchmark.start("OINOHtmlTemplate", "renderFromKeyValue");
+        this.setVariableFromValue(key, value);
+        const result = this.render(removeUnusedTags);
+        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) {
+        OINOBenchmark.start("OINOHtmlTemplate", "renderFromObject");
+        this.setVariableFromProperties(object);
+        const result = this.render(removeUnusedTags);
         OINOBenchmark.end("OINOHtmlTemplate", "renderFromObject");
         return result;
     }
@@ -78,43 +135,37 @@ export class OINOHtmlTemplate {
      * 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, includeErrorMessages = false, includeWarningMessages = false, includeInfoMessages = false, includeDebugMessages = false) {
+    renderFromResult(result, removeUnusedTags = true, messageSeparator, includeErrorMessages = false, includeWarningMessages = false, includeInfoMessages = false, includeDebugMessages = false) {
         OINOBenchmark.start("OINOHtmlTemplate", "renderFromResult");
-        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 = "";
+        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(OINO_ERROR_PREFIX)) {
-                messages += "<li>" + OINOStr.encode(result.messages[i], OINOContentType.html) + "</li>";
+                messages.push(OINOStr.encode(result.messages[i], OINOContentType.html));
             }
             if (includeWarningMessages && result.messages[i].startsWith(OINO_WARNING_PREFIX)) {
-                messages += "<li>" + OINOStr.encode(result.messages[i], OINOContentType.html) + "</li>";
+                messages.push(OINOStr.encode(result.messages[i], OINOContentType.html));
             }
             if (includeInfoMessages && result.messages[i].startsWith(OINO_INFO_PREFIX)) {
-                messages += "<li>" + OINOStr.encode(result.messages[i], OINOContentType.html) + "</li>";
+                messages.push(OINOStr.encode(result.messages[i], OINOContentType.html));
             }
             if (includeDebugMessages && result.messages[i].startsWith(OINO_DEBUG_PREFIX)) {
-                messages += "<li>" + OINOStr.encode(result.messages[i], OINOContentType.html) + "</li>";
+                messages.push(OINOStr.encode(result.messages[i], OINOContentType.html));
             }
         }
-        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;
+        if (messages.length > 0) {
+            this.setVariableFromValue("messages", messages.join(messageSeparator), false); // messages have been escaped already
         }
+        const http_result = this.render(removeUnusedTags);
         OINOBenchmark.end("OINOHtmlTemplate", "renderFromResult");
         return http_result;
     }

package/dist/types/OINOHtmlTemplate.d.ts

@@ -3,6 +3,9 @@ import { OINOResult, OINOHttpResult } from ".";
  * Class for rendering HTML from data.
  */
 export declare class OINOHtmlTemplate {
+    private _tag;
+    private _tagCleanRegex;
+    private _variables;
     /** HTML template string */
     template: string;
     /** Cache modified value for template */
@@ -13,37 +16,73 @@ export declare class OINOHtmlTemplate {
      * Creates HTML Response from a key-value-pair.
      *
      * @param template template string
+     * @param tag tag to identify variables in template
      *
      */
-    constructor(template: string);
+    constructor(template: string, tag?: string);
     /**
      * @returns whether template is empty
      */
     isEmpty(): boolean;
+    protected _createHttpResult(html: string, removeUnusedTags: boolean): OINOHttpResult;
+    protected _renderHtml(): string;
+    /**
+     * Clear template variables.
+     *
+     */
+    clearVariables(): void;
+    /**
+     * Sets template variable from a key-value-pair.
+     *
+     * @param variable key
+     * @param value value
+     * @param escapeValue whether to escape value
+     *
+     */
+    setVariableFromValue(variable: string, value: string, escapeValue?: boolean): void;
+    /**
+     * Sets template variables from object properties.
+     *
+     * @param object any object
+     * @param escapeValue whether to escape value
+     *
+     */
+    setVariableFromProperties(object: any, escapeValue?: boolean): void;
+    /**
+     * Creates HTML Response from set variables.
+     *
+     * @param removeUnusedTags whether to remove unused tags
+     *
+     */
+    render(removeUnusedTags?: boolean): OINOHttpResult;
     /**
      * Creates HTML Response from a key-value-pair.
      *
      * @param key key
      * @param value value
+     * @param removeUnusedTags whether to remove unused tags
      *
      */
-    renderFromKeyValue(key: string, value: string): OINOHttpResult;
+    renderFromKeyValue(key: string, value: string, removeUnusedTags?: boolean): OINOHttpResult;
     /**
      * Creates HTML Response from object properties.
      *
      * @param object object
+     * @param removeUnusedTags whether to remove unused tags
      *
      */
-    renderFromObject(object: any): OINOHttpResult;
+    renderFromObject(object: any, removeUnusedTags?: boolean): OINOHttpResult;
     /**
      * 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: OINOResult, includeErrorMessages?: boolean, includeWarningMessages?: boolean, includeInfoMessages?: boolean, includeDebugMessages?: boolean): OINOHttpResult;
+    renderFromResult(result: OINOResult, removeUnusedTags: boolean | undefined, messageSeparator: string, includeErrorMessages?: boolean, includeWarningMessages?: boolean, includeInfoMessages?: boolean, includeDebugMessages?: boolean): OINOHttpResult;
 }

package/dist/types/OINOStr.d.ts

@@ -40,7 +40,7 @@ export declare class OINOStr {
      *
      * @param str string to decode
      */
-    static decodeJSON(str: string): string | null | undefined;
+    static decodeJSON(str: string): string;
     /**
      * Encode OINO serialized strings as valid CSV.
      *
@@ -52,7 +52,7 @@ export declare class OINOStr {
      *
      * @param str string to decode
      */
-    static decodeCSV(str: string): string | null | undefined;
+    static decodeCSV(str: string): string;
     /**
      * Encode OINO serialized strings as valid Formdata.
      *
@@ -64,7 +64,7 @@ export declare class OINOStr {
      *
      * @param str string to decode
      */
-    static decodeFormdata(str: string): string | null | undefined;
+    static decodeFormdata(str: string): string;
     /**
      * Encode OINO serialized strings as valid Urlencode.
      *
@@ -76,7 +76,7 @@ export declare class OINOStr {
      *
      * @param str string to decode
      */
-    static decodeUrlencode(str: string): string | null | undefined;
+    static decodeUrlencode(str: string): string;
     /**
      * Encode OINO serialized strings as valid HTML content.
      *
@@ -88,7 +88,7 @@ export declare class OINOStr {
      *
      * @param str string to encode
      */
-    static decodeHtml(str: string): string | null | undefined;
+    static decodeHtml(str: string): string;
     /**
      * Decode content type formatted string as OINO serialization.
      *
@@ -96,7 +96,7 @@ export declare class OINOStr {
      * @param contentType content type for serialization
      *
      */
-    static decode(str: string, contentType: OINOContentType): string | null | undefined;
+    static decode(str: string, contentType: OINOContentType): string;
     /**
      * Encode OINO serialized string to the content type formatting.
      *

package/package.json

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

package/src/OINOHtmlTemplate.ts

@@ -4,6 +4,9 @@ import { OINOStr, OINOContentType, OINOResult, OINOHttpResult, OINO_ERROR_PREFIX
  * Class for rendering HTML from data. 
  */
 export class OINOHtmlTemplate {
+    private _tag:string
+    private _tagCleanRegex:RegExp 
+    private _variables:Record<string, string> = {}
     /** HTML template string */
 	template: string;
 
@@ -17,12 +20,15 @@ export class OINOHtmlTemplate {
      * Creates HTML Response from a key-value-pair.
      *
      * @param template template string
+     * @param tag tag to identify variables in template
      * 
      */
-	constructor (template:string) {
+	constructor (template:string, tag:string = "###") {
 		this.template = template
 		this.modified = 0
 		this.expires = 0
+        this._tag = tag
+        this._tagCleanRegex = new RegExp(tag + ".*" + tag, "g")
 	}
 
     /**
@@ -32,23 +38,93 @@ export class OINOHtmlTemplate {
 		return this.template == ""
 	}
 
+    protected _createHttpResult(html:string, removeUnusedTags:boolean):OINOHttpResult {
+        if (removeUnusedTags) {
+            html = html.replace(this._tagCleanRegex, "")
+        }
+        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
+    }
+
+    protected _renderHtml():string {
+        let html:string = 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:string, value:string, escapeValue:boolean = true) {
+        if (escapeValue) {
+            value = OINOStr.encode(value, OINOContentType.html)
+        }
+        this._variables[variable] = value
+    }
+
+    /**
+     * Sets template variables from object properties.
+     *
+     * @param object any object
+     * @param escapeValue whether to escape value
+     * 
+     */
+    setVariableFromProperties(object:any, escapeValue:boolean = true) {
+        if (object) {
+            for (let key in object) {
+                if (escapeValue) {
+                    this._variables[key] = OINOStr.encode(object[key], OINOContentType.html)
+                } else {
+                    this._variables[key] = object[key]
+                }
+            }
+        }
+    }
+
+    /**
+     * Creates HTML Response from set variables.
+     *
+     * @param removeUnusedTags whether to remove unused tags
+     * 
+     */
+    render(removeUnusedTags:boolean = true):OINOHttpResult {
+        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:string, value:string):OINOHttpResult {
+    renderFromKeyValue(key:string, value:string, removeUnusedTags:boolean = true):OINOHttpResult {
         OINOBenchmark.start("OINOHtmlTemplate", "renderFromKeyValue")
-        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
-		}
+        this.setVariableFromValue(key, value)
+        const result:OINOHttpResult = this.render(removeUnusedTags)
         OINOBenchmark.end("OINOHtmlTemplate", "renderFromKeyValue")
         return result
     }
@@ -57,27 +133,13 @@ export class OINOHtmlTemplate {
      * Creates HTML Response from object properties.
      *
      * @param object object
+     * @param removeUnusedTags whether to remove unused tags
      * 
      */
-    renderFromObject(object:any):OINOHttpResult {
+    renderFromObject(object:any, removeUnusedTags:boolean = true):OINOHttpResult {
         OINOBenchmark.start("OINOHtmlTemplate", "renderFromObject")
-        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
-		}
+        this.setVariableFromProperties(object)
+        const result:OINOHttpResult = this.render(removeUnusedTags)
         OINOBenchmark.end("OINOHtmlTemplate", "renderFromObject")
         return result
     }
@@ -86,44 +148,38 @@ export class OINOHtmlTemplate {
      * 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:OINOResult, includeErrorMessages:boolean=false, includeWarningMessages:boolean=false, includeInfoMessages:boolean=false, includeDebugMessages:boolean=false):OINOHttpResult {
+    renderFromResult(result:OINOResult, removeUnusedTags:boolean=true, messageSeparator:string, includeErrorMessages:boolean=false, includeWarningMessages:boolean=false, includeInfoMessages:boolean=false, includeDebugMessages:boolean=false):OINOHttpResult {
         OINOBenchmark.start("OINOHtmlTemplate", "renderFromResult")
-        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 = ""
+        this.setVariableFromValue("statusCode", result.statusCode.toString())
+        this.setVariableFromValue("statusMessage", result.statusMessage.toString())
+        let messages:string[] = []
         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>"
+                messages.push(OINOStr.encode(result.messages[i], OINOContentType.html))
             } 
             if (includeWarningMessages && result.messages[i].startsWith(OINO_WARNING_PREFIX)) {
-                messages += "<li>" + OINOStr.encode(result.messages[i], OINOContentType.html) + "</li>"
+                messages.push(OINOStr.encode(result.messages[i], OINOContentType.html))
             } 
             if (includeInfoMessages && result.messages[i].startsWith(OINO_INFO_PREFIX)) {
-                messages += "<li>" + OINOStr.encode(result.messages[i], OINOContentType.html) + "</li>"
+                messages.push(OINOStr.encode(result.messages[i], OINOContentType.html))
             } 
             if (includeDebugMessages && result.messages[i].startsWith(OINO_DEBUG_PREFIX)) {
-                messages += "<li>" + OINOStr.encode(result.messages[i], OINOContentType.html) + "</li>"
+                messages.push(OINOStr.encode(result.messages[i], OINOContentType.html))
             } 
             
         }
-        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
-		}
+        if (messages.length > 0) {
+            this.setVariableFromValue("messages", messages.join(messageSeparator), false) // messages have been escaped already
+        }        
+        const http_result:OINOHttpResult = this.render(removeUnusedTags)
         OINOBenchmark.end("OINOHtmlTemplate", "renderFromResult")
         return http_result
     }

package/src/OINOStr.ts

@@ -109,7 +109,7 @@ export class OINOStr {
      * 
      * @param str string to decode
      */
-    static decodeJSON(str:string):string|null|undefined {
+    static decodeJSON(str:string):string {
         return str // JSON parsing using JS methods, no need to decode anything
     }
 
@@ -133,7 +133,7 @@ export class OINOStr {
      * 
      * @param str string to decode
      */
-    static decodeCSV(str:string):string|null|undefined {
+    static decodeCSV(str:string):string {
         return str.replaceAll("\"\"", "\"")
     }
     
@@ -157,7 +157,7 @@ export class OINOStr {
      * 
      * @param str string to decode
      */
-    static decodeFormdata(str:string):string|null|undefined {
+    static decodeFormdata(str:string):string {
         return str
     }
     /**
@@ -180,7 +180,7 @@ export class OINOStr {
      * 
      * @param str string to decode
      */
-    static decodeUrlencode(str:string):string|null|undefined {
+    static decodeUrlencode(str:string):string {
         return decodeURIComponent(str)
     }
 
@@ -204,7 +204,7 @@ export class OINOStr {
      * 
      * @param str string to encode
      */
-    static decodeHtml(str:string):string|null|undefined {
+    static decodeHtml(str:string):string {
         return str.replaceAll('&amp;', '&').replaceAll('&lt;', '<').replaceAll('&gt;', '>').replaceAll('&quot;', '"').replaceAll('&#039;', "'")
     }
     /**
@@ -214,7 +214,7 @@ export class OINOStr {
      * @param contentType content type for serialization
      * 
      */
-    static decode(str:string, contentType:OINOContentType):string|null|undefined {
+    static decode(str:string, contentType:OINOContentType):string {
         if (contentType == OINOContentType.csv) {
             return this.decodeCSV(str)
         } else if (contentType == OINOContentType.json) {