@oino-ts/common 0.16.2 → 0.17.1

package/README.md

@@ -0,0 +1,183 @@
+# OINO TS
+OINO Is Not an ORM but it's trying to solve a similar problem for API development. Instead of mirroring your DB schema in code that needs manual updates, OINO will get the data schema from DBMS using SQL in real time. Every time your app starts, it has an updated data model which enables automatic (de)serialize SQL results to JSON/CSV and back. OINO works on the level below routing where you pass the method, URL ID, body and request parameters to the API-object. OINO will parse and validate the data against the data model and generate proper SQL for your DB. Because OINO knows how data is serialized (e.g. JSON), what column it belongs to (e.g. floating point number) and what the target database is, it knows how to parse, format and escape the value as valid SQL.
+
+```
+const result:OINOApiResult = await api_orderdetails.doRequest("GET", id, body, params)
+return new Response(result.modelset.writeString(OINOContentType.json))
+```
+
+
+# GETTING STARTED
+
+### Setup
+Install the `@oino-ts/db` npm package and necessary database packages and import them in your code.
+```
+bun install @oino-ts/db
+bun install @oino-ts/db-bunsqlite
+```
+
+```
+import { OINODb, OINOApi, OINOFactory } from "@oino-ts/db";
+import { OINODbBunSqlite } from "@oino-ts/db-bunsqlite"
+```
+
+### Register database and logger
+Register your database implementation and logger (see [`OINOConsoleLog`](https://pragmatta.github.io/oino-ts/classes/common_src.OINOConsoleLog.html) how to implement your own)
+
+```
+OINOLog.setLogger(new OINOConsoleLog())
+OINOFactory.registerDb("OINODbBunSqlite", OINODbBunSqlite)
+```
+
+### Create a database
+Creating a database connection [`OINODb`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODb.html) is done by passing [`OINODbParams`](https://pragmatta.github.io/oino-ts/types/db_src.OINODbParams.html) to the factory method. For [`OINODbBunSqlite`](https://pragmatta.github.io/oino-ts/classes/db_bunsqlite_src.OINODbBunSqlite.html) that means a file url for the database file, for others network host, port, credentials etc.
+```
+const db:OINODb = await OINOFactory.createDb( { type: "OINODbBunSqlite", url: "file://../localDb/northwind.sqlite" } )
+```
+
+### Create an API
+From a database you can create an [`OINOApi`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbApi.html) by passing [`OINOApiParams`](https://pragmatta.github.io/oino-ts/types/db_src.OINODbApiParams.html) with table name and preferences to the factory method.
+```
+const api_employees:OINOApi = await OINOFactory.createApi(db, { tableName: "Employees", excludeFields:["BirthDate"] })
+```
+
+### Pass HTTP requests to API
+When you receive a HTTP request, just pass the method, URL ID, body and params to the correct API, which will parse and validate input and return results.
+
+```
+const result:OINOApiResult = await api_orderdetails.doRequest("GET", id, body, params)
+```
+
+### 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.data.writeString(OINOContentType.json))
+```
+
+
+# MAIN FEATURES
+
+## RESTfull
+OINO maps HTTP methods GET/POST/PUT/DELETE to SQL operations SELECT/INSERT/UPDATE/DELETE. The GET/POST requests can be made without URL ID to get all rows or insert new ones and others target a single row using URL ID. 
+
+For example HTTP POST 
+```
+Request and response:
+> curl.exe -X POST http://localhost:3001/orderdetails -H "Content-Type: application/json" --data '[{\"OrderID\":11077,\"ProductID\":99,\"UnitPrice\":19,\"Quantity\":1,\"Discount\":0}]'
+{"success":true,"statusCode":200,"statusMessage":"OK","messages":[]}
+
+SQL:
+INSERT INTO [OrderDetails] ("OrderID","ProductID","UnitPrice","Quantity","Discount") VALUES (11077,99,19,1,0);
+```
+
+
+## Universal Serialization
+OINO handles serialization of data to JSON/CSV/etc. and back based on the data model. It knows what columns exist, what is their data type and how to convert each to JSON/CSV and back. This allows also partial data to be sent, i.e. you can send only columns that need updating or even send extra columns and have them ignored.
+
+- Files can be sent to BLOB fields using BASE64 or MIME multipart encoding. Also supports standard HTML form file submission to blob fields and returning them data url images.
+- Datetimes are (optionally) normalized to ISO 8601 format.
+- Extended JSON-encoding
+  - Unquoted literal `undefined` can be used to represent non-existent values (leaving property out works too but preserving structure might be easier e.g. when translating data).
+- CSV
+  - Comma-separated, doublequotes.
+  - Unquoted literal `null` represents null values.
+  - Unquoted empty string represents undefined values.
+- Form data
+  - Multipart-mixed and binary files not supported.
+  - Non-existent value line (i.e. nothing after the empty line) treated as a null value.
+- Url-encoded
+  - No null values, missing properties treated as undefined.
+  - Multiple lines could be used to post multiple rows.
+
+
+## Database Abstraction
+OINO functions as a database abstraction, providing a consistent interface for working with different databases. It abstracts out different conventions in connecting, making queries and formatting data.
+
+Currently supported databases:
+- 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
+
+## Composite 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 is just generating SQL, WHERE-conditions can be defined with [`OINODbSqlFilter`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlFilter.html), order with [`OINODbSqlOrder`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlOrder.html), limits/paging with [`OINODbSqlLimit`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlLimit.html) and aggregation with [`OINODbSqlAggregate`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlAggregate.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.
+```
+if (url.pathname == "/swagger.json") {
+  return new Response(JSON.stringify(OINOSwagger.getApiDefinition(api_array)))
+}
+```
+![Swagger definition with a data model schema](img/readme-swagger.png)
+
+## Node support
+OINO is developped Typescript first but compiles to standard CommonJS and the NPM packages should work on either ESM / CommonJS. Checkout sample apps `readmeApp` (ESM) and `nodeApp` (CommonJS).
+
+## HTMX support
+OINO is [htmx.org](https://htmx.org) friendly, allowing easy translation of [`OINODataRow`](https://pragmatta.github.io/oino-ts/types/db_src.OINODataRow.html) to HTML output using templates (cf. the [htmx sample app](https://github.com/pragmatta/oino-ts/tree/main/samples/htmxApp)).
+
+## Hashids
+Autoinc numeric id's are very pragmatic and fit well with OINO (e.g. using a form without primary key fields to insert new rows with database assigned ids). However it's not always sensible to share information about the sequence. Hashids solve this by masking the original values by encrypting the ids using AES-128 and some randomness. Length of the hashid can be chosen from 12-32 characters where longer ids provide more security. However this should not be considereded a cryptographic solution for keeping ids secret but rather making it infeasible to iterate all ids.
+
+
+# STATUS
+OINO is currently a side project which should considered in beta status. That means that semantic versioning is the goal but backwards incompatible changes can still happen in point releases if serious architectual issues are discovered.
+
+## Roadmap
+Major features that are considered in future releases ()
+
+### Support for views
+Simple cases of views probably work already in some databases but edge cases might get complicated.
+
+For example issues could be
+- How to handle a view which does not have a complete private key?
+- What edge cases exist in updating views?
+- Can views be handled transparently to the DBMS or is there some fundamentally platform specific behavior?
+
+### Batch updates
+Supporting batch updates similar to batch inserts is slightly bending the RESTfull principles but would still be a useful optional feature in some situations.
+
+### Streaming
+One core idea is to be efficient in not making unnecessary copies of the data and minimizing garbage collection debt. This can be taken further by implementing streaming, allowing large dataset to be written to HTTP response as SQL result rows are received.
+
+### SQL generation callbacks
+It would be useful to allow developer to validate / override SQL generation to cover cases OINO does not support or even workaround issues.
+
+### Transactions
+Even though the basic case for OINO is executing SQL operations on individual rows, having an option to use SQL transactions could make sense at least for batch operations.
+
+
+# HELP
+
+## Bug reports
+Fixing bugs is a priority and getting good quality bug reports helps. It's recommended to use the sample Northwind database included with project to replicate issues or make an SQL script export of the relevant table.
+
+## Feedback
+Understanding and prioritizing the use cases for OINO is also important and feedback about how you'd use OINO is interesting. Feel free to raise issues and feature requests in Github, but understand that short term most of the effort goes towards reaching the beta stage.
+
+## Typescript / Javascript architecture
+Typescript building with different targets and module-systemts and a ton of configuration is a complex domain and something I have little experience un so help in fixing problems and how thing ought to be done is appreciated.
+
+# 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 [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.
+
+## SQL Scripts
+The SQL scripts for creating the sample Northwind database are based on [Google Code archive](https://code.google.com/archive/p/northwindextended/downloads) and have been further customized to ensure they would have identical data (in the scope of the automated testing).

package/dist/cjs/OINOHtmlTemplate.js

@@ -66,7 +66,7 @@ class OINOHtmlTemplate {
         }
     }
     _createHttpResult(html) {
-        const result = new _1.OINOHttpResult(html);
+        const result = new _1.OINOHttpResult({ body: html });
         if (this.expires >= 1) {
             result.expires = Math.round(this.expires);
         }
@@ -183,8 +183,8 @@ class OINOHtmlTemplate {
      */
     renderFromResult(result, messageSeparator = "", includeErrorMessages = false, includeWarningMessages = false, includeInfoMessages = false, includeDebugMessages = false) {
         _1.OINOBenchmark.startMetric("OINOHtmlTemplate", "renderFromResult");
-        this.setVariableFromValue("statusCode", result.statusCode.toString());
-        this.setVariableFromValue("statusMessage", result.statusMessage.toString());
+        this.setVariableFromValue("status", result.status.toString());
+        this.setVariableFromValue("statusText", result.statusText.toString());
         let messages = [];
         for (let i = 0; i < result.messages.length; i++) {
             if (includeErrorMessages && result.messages[i].startsWith(_1.OINO_ERROR_PREFIX)) {

package/dist/cjs/OINORequest.js

@@ -0,0 +1,114 @@
+"use strict";
+/*
+ * 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/.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OINOHttpRequest = exports.OINORequest = void 0;
+const _1 = require(".");
+const index_js_1 = require("./index.js");
+/**
+ * OINO API request result object with returned data and/or http status code/message and
+ * error / warning messages.
+ *
+ */
+class OINORequest {
+    /** Key-value parameters */
+    params;
+    /**
+     * Constructor of OINORequest.
+     *
+     * @param init initialization values
+     *
+     */
+    constructor(init) {
+        this.params = init?.params ?? {};
+    }
+    /**
+     * Copy values from different result.
+     *
+     * @param request source value
+     */
+    copy(request) {
+        this.params = { ...request.params };
+    }
+}
+exports.OINORequest = OINORequest;
+/**
+ * Specialized result for HTTP responses.
+ */
+class OINOHttpRequest extends OINORequest {
+    url;
+    method;
+    headers;
+    body;
+    requestType;
+    responseType;
+    multipartBoundary;
+    lastModified;
+    etags;
+    /**
+     * Constructor for a `OINOHttpRequest`
+     *
+     * @param init initialization values
+     *
+     */
+    constructor(init) {
+        super(init);
+        this.url = init.url;
+        this.method = init.method ?? "GET";
+        this.headers = init.headers ?? {};
+        this.body = init.body ?? "";
+        this.multipartBoundary = "";
+        this.lastModified = init.lastModified;
+        if (init.multipartBoundary) {
+            this.multipartBoundary = init.multipartBoundary;
+        }
+        if (init.requestType) {
+            this.requestType = init.requestType;
+        }
+        else {
+            const request_type_param = this.url?.searchParams.get(index_js_1.OINO_REQUEST_TYPE_PARAM) || this.headers["content-type"]; // content-type header can be overridden by query parameter
+            if (request_type_param == _1.OINOContentType.csv) {
+                this.requestType = _1.OINOContentType.csv;
+            }
+            else if (request_type_param == _1.OINOContentType.urlencode) {
+                this.requestType = _1.OINOContentType.urlencode;
+            }
+            else if (request_type_param?.startsWith(_1.OINOContentType.formdata)) {
+                this.requestType = _1.OINOContentType.formdata;
+                if (!this.multipartBoundary) {
+                    this.multipartBoundary = request_type_param.split('boundary=')[1] || "";
+                }
+            }
+            else {
+                this.requestType = _1.OINOContentType.json;
+            }
+        }
+        if (init.responseType) {
+            this.responseType = init.responseType;
+        }
+        else {
+            const response_type_param = this.url?.searchParams.get(index_js_1.OINO_RESPONSE_TYPE_PARAM) || this.headers["accept"]; // accept header can be overridden by query parameter
+            const accept_types = response_type_param?.split(', ') || [];
+            let response_type = undefined;
+            for (let i = 0; i < accept_types.length; i++) {
+                if (Object.values(_1.OINOContentType).includes(accept_types[i])) {
+                    response_type = accept_types[i];
+                    break;
+                }
+            }
+            this.responseType = response_type ?? _1.OINOContentType.json;
+        }
+        const last_modified = this.headers["if-modified-since"];
+        if (last_modified) {
+            this.lastModified = new Date(last_modified).getTime();
+        }
+        const etags = this.headers["if-none-match"]?.split(',').map(e => e.trim());
+        if (etags) {
+            this.etags = etags;
+        }
+    }
+}
+exports.OINOHttpRequest = OINOHttpRequest;

package/dist/cjs/OINOResult.js

@@ -17,20 +17,22 @@ class OINOResult {
     /** Wheter request was successfully executed */
     success;
     /** HTTP status code */
-    statusCode;
+    status;
     /** HTTP status message */
-    statusMessage;
+    statusText;
     /** Error / warning messages */
     messages;
     /**
      * Constructor of OINOResult.
      *
+     * @param init initialization values
+     *
      */
-    constructor() {
-        this.success = true;
-        this.statusCode = 200;
-        this.statusMessage = "OK";
-        this.messages = [];
+    constructor(init) {
+        this.success = init?.success ?? true;
+        this.status = init?.status ?? 200;
+        this.statusText = init?.statusText ?? "OK";
+        this.messages = init?.messages ?? [];
     }
     /**
      * Copy values from different result.
@@ -39,8 +41,8 @@ class OINOResult {
      */
     copy(result) {
         this.success = result.success;
-        this.statusCode = result.statusCode;
-        this.statusMessage = result.statusMessage;
+        this.status = result.status;
+        this.statusText = result.statusText;
         this.messages = result.messages.slice();
     }
     /**
@@ -49,28 +51,28 @@ class OINOResult {
      */
     setOk() {
         this.success = true;
-        this.statusCode = 200;
-        this.statusMessage = "OK";
+        this.status = 200;
+        this.statusText = "OK";
     }
     /**
      * Set HTTP error status using given code and message. Returns self reference for chaining.
      *
-     * @param statusCode HTTP status code
-     * @param statusMessage HTTP status message
+     * @param status HTTP status code
+     * @param statusText HTTP status message
      * @param operation operation where error occured
      *
      */
-    setError(statusCode, statusMessage, operation) {
+    setError(status, statusText, operation) {
         this.success = false;
-        this.statusCode = statusCode;
-        if (this.statusMessage != "OK") {
-            this.messages.push(this.statusMessage); // latest error becomes status, but if there was something non-trivial, add it to the messages
+        this.status = status;
+        if (this.statusText != "OK") {
+            this.messages.push(this.statusText); // latest error becomes status, but if there was something non-trivial, add it to the messages
         }
-        if (statusMessage.startsWith(_1.OINO_ERROR_PREFIX)) {
-            this.statusMessage = statusMessage;
+        if (statusText.startsWith(_1.OINO_ERROR_PREFIX)) {
+            this.statusText = statusText;
         }
         else {
-            this.statusMessage = _1.OINO_ERROR_PREFIX + " (" + operation + "): " + statusMessage;
+            this.statusText = _1.OINO_ERROR_PREFIX + " (" + operation + "): " + statusText;
         }
         return this;
     }
@@ -153,17 +155,7 @@ class OINOResult {
      *
      */
     printLog() {
-        return "OINOResult: statusCode=" + this.statusCode + ", statusMessage=" + this.statusMessage + ", messages=[" + this.messages.join(", ") + "]";
-    }
-    /**
-     * Get a Response object from the result values.
-     *
-     * @param headers HTTP headers (overrides existing values)
-     */
-    getStatusResponse(headers) {
-        const result = new Response(this.statusMessage, { status: this.statusCode, headers: headers });
-        result.headers.set('Content-Length', this.statusMessage.length.toString());
-        return result;
+        return "OINOResult: status=" + this.status + ", statusText=" + this.statusText + ", messages=[" + this.messages.join(", ") + "]";
     }
 }
 exports.OINOResult = OINOResult;
@@ -174,21 +166,23 @@ class OINOHttpResult extends OINOResult {
     _etag;
     /** HTTP body data */
     body;
-    /** HTTP cache expiration value */
+    /** HTTP cache expiration value
+     * Note: default 0 means no expiration and 'Pragma: no-cache' is set.
+    */
     expires;
     /** HTTP cache last-modified value */
     lastModified;
     /**
      * Constructor for a `OINOHttpResult`
      *
-     * @param body HTTP body
+     * @param init initialization values
      *
      */
-    constructor(body) {
-        super();
-        this.body = body;
-        this.expires = 0;
-        this.lastModified = 0;
+    constructor(init) {
+        super(init);
+        this.body = init?.body ?? "";
+        this.expires = init?.expires ?? 0;
+        this.lastModified = init?.lastModified ?? 0;
         this._etag = "";
     }
     /**
@@ -208,7 +202,7 @@ class OINOHttpResult extends OINOResult {
      * @param headers HTTP headers (overrides existing values)
      */
     getHttpResponse(headers) {
-        const result = new Response(this.body, { status: this.statusCode, statusText: this.statusMessage, headers: headers });
+        const result = new Response(this.body, { status: this.status, statusText: this.statusText, 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());

package/dist/cjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OINOContentType = exports.OINO_DEBUG_PREFIX = exports.OINO_INFO_PREFIX = exports.OINO_WARNING_PREFIX = exports.OINO_ERROR_PREFIX = exports.OINO_EMPTY_FORMATTER = exports.OINOFormatter = exports.OINOHtmlTemplate = exports.OINOStr = exports.OINOHttpResult = exports.OINOResult = exports.OINOConsoleLog = exports.OINOLogLevel = exports.OINOLog = exports.OINOMemoryBenchmark = exports.OINOBenchmark = void 0;
+exports.OINOContentType = exports.OINO_RESPONSE_TYPE_PARAM = exports.OINO_REQUEST_TYPE_PARAM = exports.OINO_DEBUG_PREFIX = exports.OINO_INFO_PREFIX = exports.OINO_WARNING_PREFIX = exports.OINO_ERROR_PREFIX = exports.OINO_EMPTY_FORMATTER = exports.OINOFormatter = exports.OINOHtmlTemplate = exports.OINOStr = exports.OINOHttpRequest = exports.OINORequest = exports.OINOHttpResult = exports.OINOResult = exports.OINOConsoleLog = exports.OINOLogLevel = exports.OINOLog = exports.OINOMemoryBenchmark = exports.OINOBenchmark = void 0;
 var OINOBenchmark_js_1 = require("./OINOBenchmark.js");
 Object.defineProperty(exports, "OINOBenchmark", { enumerable: true, get: function () { return OINOBenchmark_js_1.OINOBenchmark; } });
 Object.defineProperty(exports, "OINOMemoryBenchmark", { enumerable: true, get: function () { return OINOBenchmark_js_1.OINOMemoryBenchmark; } });
@@ -11,6 +11,9 @@ Object.defineProperty(exports, "OINOConsoleLog", { enumerable: true, get: functi
 var OINOResult_js_1 = require("./OINOResult.js");
 Object.defineProperty(exports, "OINOResult", { enumerable: true, get: function () { return OINOResult_js_1.OINOResult; } });
 Object.defineProperty(exports, "OINOHttpResult", { enumerable: true, get: function () { return OINOResult_js_1.OINOHttpResult; } });
+var OINORequest_js_1 = require("./OINORequest.js");
+Object.defineProperty(exports, "OINORequest", { enumerable: true, get: function () { return OINORequest_js_1.OINORequest; } });
+Object.defineProperty(exports, "OINOHttpRequest", { enumerable: true, get: function () { return OINORequest_js_1.OINOHttpRequest; } });
 var OINOStr_js_1 = require("./OINOStr.js");
 Object.defineProperty(exports, "OINOStr", { enumerable: true, get: function () { return OINOStr_js_1.OINOStr; } });
 var OINOHtmlTemplate_js_1 = require("./OINOHtmlTemplate.js");
@@ -26,6 +29,10 @@ exports.OINO_WARNING_PREFIX = "OINO WARNING";
 exports.OINO_INFO_PREFIX = "OINO INFO";
 /** OINO debug message prefix */
 exports.OINO_DEBUG_PREFIX = "OINO DEBUG";
+/** Name of the OINOContentType-parameter request */
+exports.OINO_REQUEST_TYPE_PARAM = "oinorequesttype";
+/** Name of the OINOContentType-parameter request */
+exports.OINO_RESPONSE_TYPE_PARAM = "oinoresponsetype";
 /**
  * Supported content format mime-types
  */

package/dist/esm/OINOHtmlTemplate.js

@@ -63,7 +63,7 @@ export class OINOHtmlTemplate {
         }
     }
     _createHttpResult(html) {
-        const result = new OINOHttpResult(html);
+        const result = new OINOHttpResult({ body: html });
         if (this.expires >= 1) {
             result.expires = Math.round(this.expires);
         }
@@ -180,8 +180,8 @@ export class OINOHtmlTemplate {
      */
     renderFromResult(result, messageSeparator = "", includeErrorMessages = false, includeWarningMessages = false, includeInfoMessages = false, includeDebugMessages = false) {
         OINOBenchmark.startMetric("OINOHtmlTemplate", "renderFromResult");
-        this.setVariableFromValue("statusCode", result.statusCode.toString());
-        this.setVariableFromValue("statusMessage", result.statusMessage.toString());
+        this.setVariableFromValue("status", result.status.toString());
+        this.setVariableFromValue("statusText", result.statusText.toString());
         let messages = [];
         for (let i = 0; i < result.messages.length; i++) {
             if (includeErrorMessages && result.messages[i].startsWith(OINO_ERROR_PREFIX)) {

package/dist/esm/OINORequest.js

@@ -0,0 +1,109 @@
+/*
+ * 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/.
+ */
+import { OINOContentType } from ".";
+import { OINO_REQUEST_TYPE_PARAM, OINO_RESPONSE_TYPE_PARAM } from "./index.js";
+/**
+ * OINO API request result object with returned data and/or http status code/message and
+ * error / warning messages.
+ *
+ */
+export class OINORequest {
+    /** Key-value parameters */
+    params;
+    /**
+     * Constructor of OINORequest.
+     *
+     * @param init initialization values
+     *
+     */
+    constructor(init) {
+        this.params = init?.params ?? {};
+    }
+    /**
+     * Copy values from different result.
+     *
+     * @param request source value
+     */
+    copy(request) {
+        this.params = { ...request.params };
+    }
+}
+/**
+ * Specialized result for HTTP responses.
+ */
+export class OINOHttpRequest extends OINORequest {
+    url;
+    method;
+    headers;
+    body;
+    requestType;
+    responseType;
+    multipartBoundary;
+    lastModified;
+    etags;
+    /**
+     * Constructor for a `OINOHttpRequest`
+     *
+     * @param init initialization values
+     *
+     */
+    constructor(init) {
+        super(init);
+        this.url = init.url;
+        this.method = init.method ?? "GET";
+        this.headers = init.headers ?? {};
+        this.body = init.body ?? "";
+        this.multipartBoundary = "";
+        this.lastModified = init.lastModified;
+        if (init.multipartBoundary) {
+            this.multipartBoundary = init.multipartBoundary;
+        }
+        if (init.requestType) {
+            this.requestType = init.requestType;
+        }
+        else {
+            const request_type_param = this.url?.searchParams.get(OINO_REQUEST_TYPE_PARAM) || this.headers["content-type"]; // content-type header can be overridden by query parameter
+            if (request_type_param == OINOContentType.csv) {
+                this.requestType = OINOContentType.csv;
+            }
+            else if (request_type_param == OINOContentType.urlencode) {
+                this.requestType = OINOContentType.urlencode;
+            }
+            else if (request_type_param?.startsWith(OINOContentType.formdata)) {
+                this.requestType = OINOContentType.formdata;
+                if (!this.multipartBoundary) {
+                    this.multipartBoundary = request_type_param.split('boundary=')[1] || "";
+                }
+            }
+            else {
+                this.requestType = OINOContentType.json;
+            }
+        }
+        if (init.responseType) {
+            this.responseType = init.responseType;
+        }
+        else {
+            const response_type_param = this.url?.searchParams.get(OINO_RESPONSE_TYPE_PARAM) || this.headers["accept"]; // accept header can be overridden by query parameter
+            const accept_types = response_type_param?.split(', ') || [];
+            let response_type = undefined;
+            for (let i = 0; i < accept_types.length; i++) {
+                if (Object.values(OINOContentType).includes(accept_types[i])) {
+                    response_type = accept_types[i];
+                    break;
+                }
+            }
+            this.responseType = response_type ?? OINOContentType.json;
+        }
+        const last_modified = this.headers["if-modified-since"];
+        if (last_modified) {
+            this.lastModified = new Date(last_modified).getTime();
+        }
+        const etags = this.headers["if-none-match"]?.split(',').map(e => e.trim());
+        if (etags) {
+            this.etags = etags;
+        }
+    }
+}