@oino-ts/common 0.17.4 → 0.18.1

package/dist/cjs/OINORequest.js

@@ -34,7 +34,7 @@ class OINOHttpRequest extends OINORequest {
     url;
     method;
     headers;
-    data;
+    body;
     requestType;
     responseType;
     multipartBoundary;
@@ -51,7 +51,7 @@ class OINOHttpRequest extends OINORequest {
         this.url = init.url;
         this.method = init.method ?? "GET";
         this.headers = new _1.OINOHeaders(init.headers);
-        this.data = init.data ?? "";
+        this.body = init.body;
         this.multipartBoundary = "";
         this.lastModified = init.lastModified;
         if (init.multipartBoundary) {
@@ -102,47 +102,69 @@ class OINOHttpRequest extends OINORequest {
             this.etags = etags;
         }
     }
+    /**
+     * Creates a `OINOHttpRequest` from a Fetch API `Request` object.
+     *
+     * @param request Fetch request
+     *
+     */
     static async fromFetchRequest(request) {
         const body = await request.arrayBuffer();
         return new OINOHttpRequest({
             url: new URL(request.url),
             method: request.method,
             headers: Object.fromEntries(request.headers),
-            data: node_buffer_1.Buffer.from(body),
+            body: node_buffer_1.Buffer.from(body),
         });
     }
-    dataAsText() {
-        if (this.data instanceof Uint8Array) {
-            return new TextDecoder().decode(this.data);
+    /**
+     * Returns the request data as a text string.
+     *
+     */
+    bodyAsText() {
+        if (this.body instanceof Uint8Array) {
+            return new TextDecoder().decode(this.body);
         }
-        else if (this.data instanceof Object) {
-            return JSON.stringify(this.data);
+        else if (this.body instanceof Object) {
+            return JSON.stringify(this.body);
         }
         else {
-            return this.data?.toString() || "";
+            return this.body?.toString() || "";
         }
     }
-    dataAsParsedJson() {
-        return this.data ? JSON.parse(this.dataAsText()) : {};
+    /**
+     * Returns the request data parsed as JSON object.
+     *
+     */
+    bodyAsParsedJson() {
+        return this.body ? JSON.parse(this.bodyAsText()) : {};
     }
-    dataAsFormData() {
-        return new URLSearchParams(this.dataAsText() || "");
+    /**
+     * Returns the request data as URLSearchParams (form data).
+     *
+     */
+    bodyAsFormData() {
+        return new URLSearchParams(this.bodyAsText() || "");
     }
-    dataAsBuffer() {
-        if (this.data === null) {
+    /**
+     * Returns the request data as Buffer.
+     *
+     */
+    bodyAsBuffer() {
+        if ((this.body === null) || (this.body === undefined)) {
             return node_buffer_1.Buffer.alloc(0);
         }
-        else if (this.data instanceof node_buffer_1.Buffer) {
-            return this.data;
+        else if (this.body instanceof node_buffer_1.Buffer) {
+            return this.body;
         }
-        else if (this.data instanceof Uint8Array) {
-            return node_buffer_1.Buffer.from(this.data);
+        else if (this.body instanceof Uint8Array) {
+            return node_buffer_1.Buffer.from(this.body);
         }
-        else if (this.data instanceof Object) {
-            return node_buffer_1.Buffer.from(JSON.stringify(this.data), "utf-8");
+        else if (this.body instanceof Object) {
+            return node_buffer_1.Buffer.from(JSON.stringify(this.body), "utf-8");
         }
         else {
-            return node_buffer_1.Buffer.from(this.data, "utf-8");
+            return node_buffer_1.Buffer.from(this.body, "utf-8");
         }
     }
 }

package/dist/cjs/OINOResult.js

@@ -7,6 +7,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OINOHttpResult = exports.OINOResult = void 0;
 const node_crypto_1 = require("node:crypto");
+const node_buffer_1 = require("node:buffer");
 const _1 = require(".");
 /**
  * OINO API request result object with returned data and/or http status code/message and
@@ -209,7 +210,14 @@ class OINOHttpResult extends OINOResult {
         if (headers) {
             merged_headers.setHeaders(headers);
         }
-        const result = new Response(this.body, { status: this.status, statusText: this.statusText, headers: merged_headers });
+        let body;
+        if (this.body instanceof node_buffer_1.Buffer) {
+            body = new Uint8Array(this.body);
+        }
+        else {
+            body = this.body;
+        }
+        const result = new Response(body, { status: this.status, statusText: this.statusText, headers: merged_headers });
         result.headers.set('Content-Length', this.body.length.toString());
         if (merged_headers['Last-Modified'] === undefined && this.lastModified > 0) {
             result.headers.set('Last-Modified', new Date(this.lastModified).toUTCString());
@@ -223,5 +231,66 @@ class OINOHttpResult extends OINOResult {
         result.headers.set("ETag", this.getEtag());
         return result;
     }
+    /**
+     * Create from a Response object from the result values.
+     *
+     * @param response fetch Response object
+     *
+     */
+    static async fromFetchResponse(response) {
+        const body = node_buffer_1.Buffer.from(await response.arrayBuffer());
+        const last_modified = response.headers.get('Last-Modified');
+        const expires = response.headers.get('Expires');
+        const result = new OINOHttpResult({
+            status: response.status,
+            statusText: response.statusText,
+            body: body,
+            headers: response.headers,
+            lastModified: last_modified ? (new Date(last_modified).getTime()) : 0,
+            expires: expires ? (new Date(expires).getTime() - Date.now()) : 0
+        });
+        return result;
+    }
+    /**
+     * Returns the request body as a text string.
+     *
+     */
+    bodyAsText() {
+        if (this.body instanceof node_buffer_1.Buffer) {
+            return this.body.toString("utf-8");
+        }
+        else {
+            return this.body || "";
+        }
+    }
+    /**
+     * Returns the request body parsed as JSON object.
+     *
+     */
+    bodyAsParsedJson() {
+        return this.body ? JSON.parse(this.bodyAsText()) : {};
+    }
+    /**
+     * Returns the request body as URLSearchParams (form body).
+     *
+     */
+    bodyAsFormData() {
+        return new URLSearchParams(this.bodyAsText() || "");
+    }
+    /**
+     * Returns the request body as Buffer.
+     *
+     */
+    bodyAsBuffer() {
+        if (this.body === null) {
+            return node_buffer_1.Buffer.alloc(0);
+        }
+        else if (this.body instanceof node_buffer_1.Buffer) {
+            return this.body;
+        }
+        else {
+            return node_buffer_1.Buffer.from(this.body, "utf-8");
+        }
+    }
 }
 exports.OINOHttpResult = OINOHttpResult;

package/dist/esm/OINORequest.js

@@ -30,7 +30,7 @@ export class OINOHttpRequest extends OINORequest {
     url;
     method;
     headers;
-    data;
+    body;
     requestType;
     responseType;
     multipartBoundary;
@@ -47,7 +47,7 @@ export class OINOHttpRequest extends OINORequest {
         this.url = init.url;
         this.method = init.method ?? "GET";
         this.headers = new OINOHeaders(init.headers);
-        this.data = init.data ?? "";
+        this.body = init.body;
         this.multipartBoundary = "";
         this.lastModified = init.lastModified;
         if (init.multipartBoundary) {
@@ -98,47 +98,69 @@ export class OINOHttpRequest extends OINORequest {
             this.etags = etags;
         }
     }
+    /**
+     * Creates a `OINOHttpRequest` from a Fetch API `Request` object.
+     *
+     * @param request Fetch request
+     *
+     */
     static async fromFetchRequest(request) {
         const body = await request.arrayBuffer();
         return new OINOHttpRequest({
             url: new URL(request.url),
             method: request.method,
             headers: Object.fromEntries(request.headers),
-            data: Buffer.from(body),
+            body: Buffer.from(body),
         });
     }
-    dataAsText() {
-        if (this.data instanceof Uint8Array) {
-            return new TextDecoder().decode(this.data);
+    /**
+     * Returns the request data as a text string.
+     *
+     */
+    bodyAsText() {
+        if (this.body instanceof Uint8Array) {
+            return new TextDecoder().decode(this.body);
         }
-        else if (this.data instanceof Object) {
-            return JSON.stringify(this.data);
+        else if (this.body instanceof Object) {
+            return JSON.stringify(this.body);
         }
         else {
-            return this.data?.toString() || "";
+            return this.body?.toString() || "";
         }
     }
-    dataAsParsedJson() {
-        return this.data ? JSON.parse(this.dataAsText()) : {};
+    /**
+     * Returns the request data parsed as JSON object.
+     *
+     */
+    bodyAsParsedJson() {
+        return this.body ? JSON.parse(this.bodyAsText()) : {};
     }
-    dataAsFormData() {
-        return new URLSearchParams(this.dataAsText() || "");
+    /**
+     * Returns the request data as URLSearchParams (form data).
+     *
+     */
+    bodyAsFormData() {
+        return new URLSearchParams(this.bodyAsText() || "");
     }
-    dataAsBuffer() {
-        if (this.data === null) {
+    /**
+     * Returns the request data as Buffer.
+     *
+     */
+    bodyAsBuffer() {
+        if ((this.body === null) || (this.body === undefined)) {
             return Buffer.alloc(0);
         }
-        else if (this.data instanceof Buffer) {
-            return this.data;
+        else if (this.body instanceof Buffer) {
+            return this.body;
         }
-        else if (this.data instanceof Uint8Array) {
-            return Buffer.from(this.data);
+        else if (this.body instanceof Uint8Array) {
+            return Buffer.from(this.body);
         }
-        else if (this.data instanceof Object) {
-            return Buffer.from(JSON.stringify(this.data), "utf-8");
+        else if (this.body instanceof Object) {
+            return Buffer.from(JSON.stringify(this.body), "utf-8");
         }
         else {
-            return Buffer.from(this.data, "utf-8");
+            return Buffer.from(this.body, "utf-8");
         }
     }
 }

package/dist/esm/OINOResult.js

@@ -4,6 +4,7 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 import { createHash } from "node:crypto";
+import { Buffer } from "node:buffer";
 import { OINO_DEBUG_PREFIX, OINO_ERROR_PREFIX, OINO_INFO_PREFIX, OINO_WARNING_PREFIX, OINOHeaders } from ".";
 /**
  * OINO API request result object with returned data and/or http status code/message and
@@ -205,7 +206,14 @@ export class OINOHttpResult extends OINOResult {
         if (headers) {
             merged_headers.setHeaders(headers);
         }
-        const result = new Response(this.body, { status: this.status, statusText: this.statusText, headers: merged_headers });
+        let body;
+        if (this.body instanceof Buffer) {
+            body = new Uint8Array(this.body);
+        }
+        else {
+            body = this.body;
+        }
+        const result = new Response(body, { status: this.status, statusText: this.statusText, headers: merged_headers });
         result.headers.set('Content-Length', this.body.length.toString());
         if (merged_headers['Last-Modified'] === undefined && this.lastModified > 0) {
             result.headers.set('Last-Modified', new Date(this.lastModified).toUTCString());
@@ -219,4 +227,65 @@ export class OINOHttpResult extends OINOResult {
         result.headers.set("ETag", this.getEtag());
         return result;
     }
+    /**
+     * Create from a Response object from the result values.
+     *
+     * @param response fetch Response object
+     *
+     */
+    static async fromFetchResponse(response) {
+        const body = Buffer.from(await response.arrayBuffer());
+        const last_modified = response.headers.get('Last-Modified');
+        const expires = response.headers.get('Expires');
+        const result = new OINOHttpResult({
+            status: response.status,
+            statusText: response.statusText,
+            body: body,
+            headers: response.headers,
+            lastModified: last_modified ? (new Date(last_modified).getTime()) : 0,
+            expires: expires ? (new Date(expires).getTime() - Date.now()) : 0
+        });
+        return result;
+    }
+    /**
+     * Returns the request body as a text string.
+     *
+     */
+    bodyAsText() {
+        if (this.body instanceof Buffer) {
+            return this.body.toString("utf-8");
+        }
+        else {
+            return this.body || "";
+        }
+    }
+    /**
+     * Returns the request body parsed as JSON object.
+     *
+     */
+    bodyAsParsedJson() {
+        return this.body ? JSON.parse(this.bodyAsText()) : {};
+    }
+    /**
+     * Returns the request body as URLSearchParams (form body).
+     *
+     */
+    bodyAsFormData() {
+        return new URLSearchParams(this.bodyAsText() || "");
+    }
+    /**
+     * Returns the request body as Buffer.
+     *
+     */
+    bodyAsBuffer() {
+        if (this.body === null) {
+            return Buffer.alloc(0);
+        }
+        else if (this.body instanceof Buffer) {
+            return this.body;
+        }
+        else {
+            return Buffer.from(this.body, "utf-8");
+        }
+    }
 }

package/dist/types/OINORequest.d.ts

@@ -23,7 +23,7 @@ export interface OINOHttpRequestInit extends OINORequestInit {
     url?: URL;
     method?: string;
     headers?: OINOHeadersInit;
-    data?: string | Buffer | Uint8Array | object | null;
+    body?: string | Buffer | Uint8Array | object | null | undefined;
     requestType?: OINOContentType;
     responseType?: OINOContentType;
     multipartBoundary?: string;
@@ -36,7 +36,7 @@ export declare class OINOHttpRequest extends OINORequest {
     readonly url?: URL;
     readonly method: string;
     readonly headers: OINOHeaders;
-    readonly data: string | Buffer | Uint8Array | object | null;
+    readonly body: string | Buffer | Uint8Array | object | null | undefined;
     readonly requestType: OINOContentType;
     readonly responseType: OINOContentType;
     readonly multipartBoundary?: string;
@@ -49,9 +49,31 @@ export declare class OINOHttpRequest extends OINORequest {
      *
      */
     constructor(init: OINOHttpRequestInit);
+    /**
+     * Creates a `OINOHttpRequest` from a Fetch API `Request` object.
+     *
+     * @param request Fetch request
+     *
+     */
     static fromFetchRequest(request: Request): Promise<OINOHttpRequest>;
-    dataAsText(): string;
-    dataAsParsedJson(): any;
-    dataAsFormData(): URLSearchParams;
-    dataAsBuffer(): Buffer;
+    /**
+     * Returns the request data as a text string.
+     *
+     */
+    bodyAsText(): string;
+    /**
+     * Returns the request data parsed as JSON object.
+     *
+     */
+    bodyAsParsedJson(): any;
+    /**
+     * Returns the request data as URLSearchParams (form data).
+     *
+     */
+    bodyAsFormData(): URLSearchParams;
+    /**
+     * Returns the request data as Buffer.
+     *
+     */
+    bodyAsBuffer(): Buffer;
 }

package/dist/types/OINOResult.d.ts

@@ -1,3 +1,4 @@
+import { Buffer } from "node:buffer";
 import { OINOHeaders, OINOHeadersInit } from ".";
 export interface OINOResultInit {
     success?: boolean;
@@ -88,7 +89,7 @@ export declare class OINOResult {
     printLog(): string;
 }
 export interface OINOHttpResultInit extends OINOResultInit {
-    body?: string;
+    body?: string | Buffer;
     headers?: OINOHeadersInit;
     expires?: number;
     lastModified?: number;
@@ -99,7 +100,7 @@ export interface OINOHttpResultInit extends OINOResultInit {
 export declare class OINOHttpResult extends OINOResult {
     private _etag;
     /** HTTP body data */
-    readonly body: string;
+    readonly body: string | Buffer;
     /** HTTP headers */
     readonly headers: OINOHeaders;
     /** HTTP cache expiration value
@@ -126,4 +127,31 @@ export declare class OINOHttpResult extends OINOResult {
      * @param headers HTTP headers (overrides existing values)
      */
     getFetchResponse(headers?: OINOHeadersInit): Response;
+    /**
+     * Create from a Response object from the result values.
+     *
+     * @param response fetch Response object
+     *
+     */
+    static fromFetchResponse(response: Response): Promise<OINOHttpResult>;
+    /**
+     * Returns the request body as a text string.
+     *
+     */
+    bodyAsText(): string;
+    /**
+     * Returns the request body parsed as JSON object.
+     *
+     */
+    bodyAsParsedJson(): any;
+    /**
+     * Returns the request body as URLSearchParams (form body).
+     *
+     */
+    bodyAsFormData(): URLSearchParams;
+    /**
+     * Returns the request body as Buffer.
+     *
+     */
+    bodyAsBuffer(): Buffer;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/common",
-  "version": "0.17.4",
+  "version": "0.18.1",
   "description": "OINO TS package for common classes.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",
@@ -19,7 +19,7 @@
   "dependencies": {
   },
   "devDependencies": {
-    "@oino-ts/types": "0.17.4",
+    "@oino-ts/types": "0.18.1",
     "@types/node": "^22.0.0",
     "typescript": "~5.9.0"
   },

package/src/OINORequest.ts

@@ -36,7 +36,7 @@ export interface OINOHttpRequestInit extends OINORequestInit {
     url?: URL
     method?: string
     headers?: OINOHeadersInit
-    data?: string|Buffer|Uint8Array|object|null
+    body?: string|Buffer|Uint8Array|object|null|undefined
     requestType?:OINOContentType
     responseType?:OINOContentType
     multipartBoundary?:string
@@ -50,7 +50,7 @@ export class OINOHttpRequest extends OINORequest {
     readonly url?: URL
     readonly method: string
     readonly headers: OINOHeaders
-    readonly data: string|Buffer|Uint8Array|object|null
+    readonly body: string|Buffer|Uint8Array|object|null|undefined
     readonly requestType:OINOContentType
     readonly responseType:OINOContentType
     readonly multipartBoundary?:string
@@ -68,7 +68,7 @@ export class OINOHttpRequest extends OINORequest {
         this.url = init.url 
         this.method = init.method ?? "GET"
         this.headers = new OINOHeaders(init.headers)
-        this.data = init.data ?? ""
+        this.body = init.body 
         this.multipartBoundary = ""
         this.lastModified = init.lastModified
 
@@ -118,51 +118,73 @@ export class OINOHttpRequest extends OINORequest {
         }
     }
 
+    /**
+     * Creates a `OINOHttpRequest` from a Fetch API `Request` object.
+     * 
+     * @param request Fetch request
+     *  
+     */
     static async fromFetchRequest(request: Request): Promise<OINOHttpRequest> {
         const body = await request.arrayBuffer()
         return new OINOHttpRequest({
             url: new URL(request.url),
             method: request.method,
             headers: Object.fromEntries(request.headers as any),
-            data: Buffer.from(body),
+            body: Buffer.from(body),
         })
     }
 
-    dataAsText(): string {
-        if (this.data instanceof Uint8Array) {
-            return new TextDecoder().decode(this.data)
+    /**
+     * Returns the request data as a text string.
+     * 
+     */
+    bodyAsText(): string {
+        if (this.body instanceof Uint8Array) {
+            return new TextDecoder().decode(this.body)
 
-        } else if (this.data instanceof Object) {
-            return JSON.stringify(this.data)
+        } else if (this.body instanceof Object) {
+            return JSON.stringify(this.body)
             
         } else {
-            return this.data?.toString() || ""
+            return this.body?.toString() || ""
         }
     }
 
-    dataAsParsedJson(): any {
-        return this.data ? JSON.parse(this.dataAsText()) : {}
+    /**
+     * Returns the request data parsed as JSON object.
+     * 
+     */
+    bodyAsParsedJson(): any {
+        return this.body ? JSON.parse(this.bodyAsText()) : {}
     }
 
-    dataAsFormData(): URLSearchParams {
-        return new URLSearchParams(this.dataAsText() || "")
+    /**
+     * Returns the request data as URLSearchParams (form data).
+     * 
+     */
+    bodyAsFormData(): URLSearchParams {
+        return new URLSearchParams(this.bodyAsText() || "")
     }
-
-    dataAsBuffer(): Buffer {
-        if (this.data === null) {
+    
+    /**
+     * Returns the request data as Buffer.
+     * 
+     */
+    bodyAsBuffer(): Buffer {
+        if ((this.body === null) || (this.body === undefined)) {
             return Buffer.alloc(0)
 
-        } else if (this.data instanceof Buffer) {
-            return this.data
+        } else if (this.body instanceof Buffer) {
+            return this.body
 
-        } else if (this.data instanceof Uint8Array) {
-            return Buffer.from(this.data)
+        } else if (this.body instanceof Uint8Array) {
+            return Buffer.from(this.body)
 
-        } else if (this.data instanceof Object) {
-            return Buffer.from(JSON.stringify(this.data), "utf-8")
+        } else if (this.body instanceof Object) {
+            return Buffer.from(JSON.stringify(this.body), "utf-8")
 
         } else {
-            return Buffer.from(this.data, "utf-8")
+            return Buffer.from(this.body, "utf-8")
         }
     }
 

package/src/OINOResult.ts

@@ -5,6 +5,7 @@
  */
 
 import { createHash, Hash } from "node:crypto";
+import { Buffer } from "node:buffer";
 import { OINO_DEBUG_PREFIX, OINO_ERROR_PREFIX, OINO_INFO_PREFIX, OINO_WARNING_PREFIX, OINOHeaders, OINOHeadersInit } from ".";
 
 export interface OINOResultInit {
@@ -177,7 +178,7 @@ export class OINOResult {
 }
 
 export interface OINOHttpResultInit extends OINOResultInit {
-    body?: string
+    body?: string|Buffer
     headers?: OINOHeadersInit
     expires?: number
     lastModified?: number
@@ -190,7 +191,7 @@ export class OINOHttpResult extends OINOResult {
     private _etag:string
 
     /** HTTP body data */
-    readonly body: string
+    readonly body: string|Buffer
     
     /** HTTP headers */
     readonly headers: OINOHeaders
@@ -240,7 +241,13 @@ export class OINOHttpResult extends OINOResult {
         if (headers) {
             merged_headers.setHeaders(headers)
         }
-        const result: Response = new Response(this.body, { status: this.status, statusText: this.statusText, headers: merged_headers })
+        let body: string|BufferSource 
+        if (this.body instanceof Buffer) {
+            body = new Uint8Array(this.body)
+        } else {
+            body = this.body as string
+        }
+        const result: Response = new Response(body, { status: this.status, statusText: this.statusText, headers: merged_headers })
         result.headers.set('Content-Length', this.body.length.toString())
         if (merged_headers['Last-Modified'] === undefined && this.lastModified > 0) {
             result.headers.set('Last-Modified', new Date(this.lastModified).toUTCString())
@@ -255,4 +262,69 @@ export class OINOHttpResult extends OINOResult {
         return result
     }
 
+    /**
+     * Create from a Response object from the result values.
+     * 
+     * @param response fetch Response object
+     * 
+     */
+    static async fromFetchResponse(response: Response): Promise<OINOHttpResult> {
+        const body = Buffer.from(await response.arrayBuffer())
+        const last_modified = response.headers.get('Last-Modified')
+        const expires = response.headers.get('Expires')
+        const result = new OINOHttpResult({
+            status: response.status,
+            statusText: response.statusText,
+            body: body,            
+            headers: response.headers as unknown as OINOHeadersInit,
+            lastModified: last_modified ? (new Date(last_modified).getTime()) : 0,
+            expires: expires ? (new Date(expires).getTime() - Date.now()) : 0
+        })
+        return result
+    }
+
+    /**
+     * Returns the request body as a text string.
+     * 
+     */
+    bodyAsText(): string {
+        if (this.body instanceof Buffer) {
+            return this.body.toString("utf-8")
+            
+        } else {
+            return this.body as string || ""
+        }
+    }
+
+    /**
+     * Returns the request body parsed as JSON object.
+     * 
+     */
+    bodyAsParsedJson(): any {
+        return this.body ? JSON.parse(this.bodyAsText()) : {}
+    }
+
+    /**
+     * Returns the request body as URLSearchParams (form body).
+     * 
+     */
+    bodyAsFormData(): URLSearchParams {
+        return new URLSearchParams(this.bodyAsText() || "")
+    }
+    
+    /**
+     * Returns the request body as Buffer.
+     * 
+     */
+    bodyAsBuffer(): Buffer {
+        if (this.body === null) {
+            return Buffer.alloc(0)
+
+        } else if (this.body instanceof Buffer) {
+            return this.body
+
+        } else {
+            return Buffer.from(this.body as string, "utf-8")
+        }
+    }
 }