@oino-ts/types 0.0.12 → 0.0.13

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

@@ -8,23 +8,20 @@ const _1 = require(".");
 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
-     * @param expires cache expiration value
      *
      */
-    constructor(template, expires) {
+    constructor(template) {
         this.template = template;
-        if (expires) {
-            this.expires = expires;
-        }
-        else {
-            this.expires = -1;
-        }
+        this.modified = 0;
+        this.expires = 0;
     }
     /**
      * @returns whether template is empty
@@ -42,6 +39,12 @@ class OINOHtmlTemplate {
     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;
     }
     /**
@@ -63,7 +66,10 @@ class OINOHtmlTemplate {
         html = html.replace(/###[^#]*###/g, "");
         const result = new _1.OINOHttpResult(html);
         if (this.expires >= 1) {
-            result.headers["Expires"] = Math.round(this.expires).toString();
+            result.expires = Math.round(this.expires);
+        }
+        if (this.modified >= 1) {
+            result.lastModified = this.modified;
         }
         return result;
     }
@@ -101,6 +107,12 @@ class OINOHtmlTemplate {
         }
         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;
     }
 }

package/dist/cjs/OINOResult.js

@@ -6,6 +6,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OINOHttpResult = exports.OINOResult = void 0;
+const node_crypto_1 = require("node:crypto");
 const _1 = require(".");
 /**
  * OINO API request result object with returned data and/or http status code/message and
@@ -153,25 +154,36 @@ exports.OINOResult = OINOResult;
  * Specialized result for HTTP responses.
  */
 class OINOHttpResult extends OINOResult {
+    _etag;
     /** HTTP body data */
     body;
-    /** HTTP header values */
-    headers;
+    /** HTTP cache expiration value */
+    expires;
+    /** HTTP cache last-modified value */
+    lastModified;
     /**
      * Constructor for a `OINOHttpResult`
      *
      * @param body HTTP body
-     * @param headers HTTP headers
+     *
      */
-    constructor(body, headers) {
+    constructor(body) {
         super();
         this.body = body;
-        if (headers) {
-            this.headers = headers;
-        }
-        else {
-            this.headers = {};
+        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.
@@ -179,11 +191,18 @@ class OINOHttpResult extends OINOResult {
      * @param headers HTTP headers (overrides existing values)
      */
     getResponse(headers) {
-        if (!headers) {
-            headers = this.headers;
-        }
-        headers['Content-Length'] = this.body.length.toString();
         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/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

@@ -5,23 +5,20 @@ import { OINOStr, OINOContentType, OINOHttpResult, OINO_ERROR_PREFIX, OINO_WARNI
 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
-     * @param expires cache expiration value
      *
      */
-    constructor(template, expires) {
+    constructor(template) {
         this.template = template;
-        if (expires) {
-            this.expires = expires;
-        }
-        else {
-            this.expires = -1;
-        }
+        this.modified = 0;
+        this.expires = 0;
     }
     /**
      * @returns whether template is empty
@@ -39,6 +36,12 @@ export class OINOHtmlTemplate {
     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;
     }
     /**
@@ -60,7 +63,10 @@ export class OINOHtmlTemplate {
         html = html.replace(/###[^#]*###/g, "");
         const result = new OINOHttpResult(html);
         if (this.expires >= 1) {
-            result.headers["Expires"] = Math.round(this.expires).toString();
+            result.expires = Math.round(this.expires);
+        }
+        if (this.modified >= 1) {
+            result.lastModified = this.modified;
         }
         return result;
     }
@@ -98,6 +104,12 @@ export class OINOHtmlTemplate {
         }
         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
@@ -149,25 +150,36 @@ export class OINOResult {
  * Specialized result for HTTP responses.
  */
 export class OINOHttpResult extends OINOResult {
+    _etag;
     /** HTTP body data */
     body;
-    /** HTTP header values */
-    headers;
+    /** HTTP cache expiration value */
+    expires;
+    /** HTTP cache last-modified value */
+    lastModified;
     /**
      * Constructor for a `OINOHttpResult`
      *
      * @param body HTTP body
-     * @param headers HTTP headers
+     *
      */
-    constructor(body, headers) {
+    constructor(body) {
         super();
         this.body = body;
-        if (headers) {
-            this.headers = headers;
-        }
-        else {
-            this.headers = {};
+        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.
@@ -175,11 +187,18 @@ export class OINOHttpResult extends OINOResult {
      * @param headers HTTP headers (overrides existing values)
      */
     getResponse(headers) {
-        if (!headers) {
-            headers = this.headers;
-        }
-        headers['Content-Length'] = this.body.length.toString();
         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/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

@@ -5,16 +5,17 @@ import { OINOResult, OINOHttpResult } from ".";
 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
-     * @param expires cache expiration value
      *
      */
-    constructor(template: string, expires?: number);
+    constructor(template: string);
     /**
      * @returns whether template is empty
      */

package/dist/types/OINOResult.d.ts

@@ -77,17 +77,25 @@ export declare class OINOResult {
  * Specialized result for HTTP responses.
  */
 export declare class OINOHttpResult extends OINOResult {
+    private _etag;
     /** HTTP body data */
-    body: string;
-    /** HTTP header values */
-    headers: Record<string, string>;
+    readonly body: string;
+    /** HTTP cache expiration value */
+    expires: number;
+    /** HTTP cache last-modified value */
+    lastModified: number;
     /**
      * Constructor for a `OINOHttpResult`
      *
      * @param body HTTP body
-     * @param headers HTTP headers
+     *
+     */
+    constructor(body: string);
+    /**
+     * Get the ETag value for the body opportunistically, i.e. don't calculate until requested and reuse value.
+     *
      */
-    constructor(body: string, headers?: Record<string, string>);
+    getEtag(): string;
     /**
      * Get a Response object from the result values.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/types",
-  "version": "0.0.12",
+  "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

@@ -7,6 +7,9 @@ export class OINOHtmlTemplate {
     /** HTML template string */
 	template: string;
 
+    /** Cache modified value for template */
+	modified: number;
+
     /** Cache expiration value for template */
 	expires: number;
 
@@ -14,16 +17,12 @@ export class OINOHtmlTemplate {
      * Creates HTML Response from a key-value-pair.
      *
      * @param template template string
-     * @param expires cache expiration value
      * 
      */
-	constructor (template:string, expires?: number) {
+	constructor (template:string) {
 		this.template = template
-		if (expires) {
-			this.expires = expires
-		} else {
-			this.expires = -1
-		}
+		this.modified = 0
+		this.expires = 0
 	}
 
     /**
@@ -43,6 +42,12 @@ export class OINOHtmlTemplate {
     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
     }
 
@@ -65,7 +70,10 @@ export class OINOHtmlTemplate {
         html = html.replace(/###[^#]*###/g, "")
         const result:OINOHttpResult = new OINOHttpResult(html) 
 		if (this.expires >= 1) {
-			result.headers["Expires"] = Math.round(this.expires).toString()
+			result.expires = Math.round(this.expires)
+		}
+		if (this.modified >= 1) {
+			result.lastModified = this.modified
 		}
         return result
     }
@@ -105,6 +113,12 @@ export class OINOHtmlTemplate {
         }
         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 ".";
 
 /**
@@ -162,26 +163,41 @@ export class OINOResult {
  * Specialized result for HTTP responses.
  */
 export class OINOHttpResult extends OINOResult {
+    private _etag:string
+
     /** HTTP body data */
-    body: string
+    readonly body: string
+
+    /** HTTP cache expiration value */
+    expires: number
 
-    /** HTTP header values */
-    headers: Record<string, string>
+    /** HTTP cache last-modified value */
+    lastModified: number
 
     /**
      * Constructor for a `OINOHttpResult` 
      * 
      * @param body HTTP body
-     * @param headers HTTP headers
+     * 
      */
-    constructor(body:string, headers?:Record<string, string>) {
+    constructor(body:string) {
         super()
         this.body = body
-        if (headers) {
-            this.headers = headers
-        } else {
-            this.headers = {}
+        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
     }
 
     /**
@@ -190,11 +206,18 @@ export class OINOHttpResult extends OINOResult {
      * @param headers HTTP headers (overrides existing values)
      */
     getResponse(headers?:Record<string, string>):Response {
-        if (!headers) {
-            headers = this.headers
+        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')
+            }
         }
-        headers['Content-Length'] = this.body.length.toString()
-        const result = new Response(this.body, {status:this.statusCode, statusText: this.statusMessage, headers: headers})
+        result.headers.set("ETag", this.getEtag())
         return result
     }