@oino-ts/common 0.3.3 → 0.3.4

package/package.json

@@ -1,30 +1,30 @@
-{
-  "name": "@oino-ts/common",
-  "version": "0.3.3",
-  "description": "OINO TS package for common classes.",
-  "author": "Matias Kiviniemi (pragmatta)",
-  "license": "MPL-2.0",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/pragmatta/oino-ts.git"
-  },
-  "keywords": [
-    "types",
-    "typescript",
-    "library"
-  ],
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/types/index.d.ts",
-  "dependencies": {
-  },
-  "devDependencies": {
-    "@oino-ts/types": "0.3.3"
-  },
-  "files": [
-    "src/*.ts",
-    "dist/cjs/*.js",
-    "dist/esm/*.js",
-    "dist/types/*.d.ts"
-  ]
-}
+{
+  "name": "@oino-ts/common",
+  "version": "0.3.4",
+  "description": "OINO TS package for common classes.",
+  "author": "Matias Kiviniemi (pragmatta)",
+  "license": "MPL-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pragmatta/oino-ts.git"
+  },
+  "keywords": [
+    "types",
+    "typescript",
+    "library"
+  ],
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "dependencies": {
+  },
+  "devDependencies": {
+    "@oino-ts/types": "0.3.4"
+  },
+  "files": [
+    "src/*.ts",
+    "dist/cjs/*.js",
+    "dist/esm/*.js",
+    "dist/types/*.d.ts"
+  ]
+}

package/src/OINOBenchmark.ts

@@ -1,112 +1,112 @@
-/*
- * 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/.
- */
-
-/**
- * Static class for benchmarking functions.
- *
- */
-export class OINOBenchmark {
-
-    private static _benchmarkCount:Record<string, number> = {}
-    private static _benchmarkData:Record<string, number> = {}
-    private static _benchmarkEnabled:Record<string, boolean> = {}
-    private static _benchmarkStart:Record<string, number> = {}
-
-    /**
-     * 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:string[]):void {
-        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:string, method:string):void {
-        const name:string = 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:string, method:string, category?:string):number {
-        const name:string = module + "." + method
-        let result:number = 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:string, method:string):number {
-        const name:string = module + "." + method
-        if (this._benchmarkEnabled[module]) {
-            return this._benchmarkData[module] / this._benchmarkCount[module]
-        }
-        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
-    }
-}
+/*
+ * 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/.
+ */
+
+/**
+ * Static class for benchmarking functions.
+ *
+ */
+export class OINOBenchmark {
+
+    private static _benchmarkCount:Record<string, number> = {}
+    private static _benchmarkData:Record<string, number> = {}
+    private static _benchmarkEnabled:Record<string, boolean> = {}
+    private static _benchmarkStart:Record<string, number> = {}
+
+    /**
+     * 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:string[]):void {
+        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:string, method:string):void {
+        const name:string = 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:string, method:string, category?:string):number {
+        const name:string = module + "." + method
+        let result:number = 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:string, method:string):number {
+        const name:string = module + "." + method
+        if (this._benchmarkEnabled[module]) {
+            return this._benchmarkData[module] / this._benchmarkCount[module]
+        }
+        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

@@ -1,186 +1,186 @@
-import { OINOStr, OINOContentType, OINOResult, OINOHttpResult, OINO_ERROR_PREFIX, OINO_WARNING_PREFIX, OINO_INFO_PREFIX, OINO_DEBUG_PREFIX, OINOBenchmark } from "."
-
-/**
- * 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;
-
-    /** 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
-     * @param tag tag to identify variables in template
-     * 
-     */
-	constructor (template:string, tag:string = "###") {
-		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():boolean {
-		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, removeUnusedTags:boolean = true):OINOHttpResult {
-        OINOBenchmark.start("OINOHtmlTemplate", "renderFromKeyValue")
-        this.setVariableFromValue(key, value)
-        const result:OINOHttpResult = 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:any, removeUnusedTags:boolean = true):OINOHttpResult {
-        OINOBenchmark.start("OINOHtmlTemplate", "renderFromObject")
-        this.setVariableFromProperties(object)
-        const result:OINOHttpResult = this.render(removeUnusedTags)
-        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:OINOResult, removeUnusedTags:boolean=true, messageSeparator:string = "", includeErrorMessages:boolean=false, includeWarningMessages:boolean=false, includeInfoMessages:boolean=false, includeDebugMessages:boolean=false):OINOHttpResult {
-        OINOBenchmark.start("OINOHtmlTemplate", "renderFromResult")
-        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.push(OINOStr.encode(result.messages[i], OINOContentType.html))
-            } 
-            if (includeWarningMessages && result.messages[i].startsWith(OINO_WARNING_PREFIX)) {
-                messages.push(OINOStr.encode(result.messages[i], OINOContentType.html))
-            } 
-            if (includeInfoMessages && result.messages[i].startsWith(OINO_INFO_PREFIX)) {
-                messages.push(OINOStr.encode(result.messages[i], OINOContentType.html))
-            } 
-            if (includeDebugMessages && result.messages[i].startsWith(OINO_DEBUG_PREFIX)) {
-                messages.push(OINOStr.encode(result.messages[i], OINOContentType.html))
-            } 
-            
-        }
-        if (messageSeparator && (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
-    }
-};
+import { OINOStr, OINOContentType, OINOResult, OINOHttpResult, OINO_ERROR_PREFIX, OINO_WARNING_PREFIX, OINO_INFO_PREFIX, OINO_DEBUG_PREFIX, OINOBenchmark } from "."
+
+/**
+ * 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;
+
+    /** 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
+     * @param tag tag to identify variables in template
+     * 
+     */
+	constructor (template:string, tag:string = "###") {
+		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():boolean {
+		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, removeUnusedTags:boolean = true):OINOHttpResult {
+        OINOBenchmark.start("OINOHtmlTemplate", "renderFromKeyValue")
+        this.setVariableFromValue(key, value)
+        const result:OINOHttpResult = 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:any, removeUnusedTags:boolean = true):OINOHttpResult {
+        OINOBenchmark.start("OINOHtmlTemplate", "renderFromObject")
+        this.setVariableFromProperties(object)
+        const result:OINOHttpResult = this.render(removeUnusedTags)
+        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:OINOResult, removeUnusedTags:boolean=true, messageSeparator:string = "", includeErrorMessages:boolean=false, includeWarningMessages:boolean=false, includeInfoMessages:boolean=false, includeDebugMessages:boolean=false):OINOHttpResult {
+        OINOBenchmark.start("OINOHtmlTemplate", "renderFromResult")
+        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.push(OINOStr.encode(result.messages[i], OINOContentType.html))
+            } 
+            if (includeWarningMessages && result.messages[i].startsWith(OINO_WARNING_PREFIX)) {
+                messages.push(OINOStr.encode(result.messages[i], OINOContentType.html))
+            } 
+            if (includeInfoMessages && result.messages[i].startsWith(OINO_INFO_PREFIX)) {
+                messages.push(OINOStr.encode(result.messages[i], OINOContentType.html))
+            } 
+            if (includeDebugMessages && result.messages[i].startsWith(OINO_DEBUG_PREFIX)) {
+                messages.push(OINOStr.encode(result.messages[i], OINOContentType.html))
+            } 
+            
+        }
+        if (messageSeparator && (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
+    }
+};