@oino-ts/common 0.21.2 → 1.0.0

package/dist/cjs/OINOSwagger.js

@@ -0,0 +1,205 @@
+"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.OINOSwagger = void 0;
+/**
+ * Static class for Swagger utilities
+ *
+ */
+class OINOSwagger {
+    static _getSchemaApiMethodParamsQueryId() {
+        return {
+            "schema": {
+                "type": "string"
+            },
+            "in": "path",
+            "name": "id",
+            "required": true
+        };
+    }
+    static _getSchemaApiMethodParamsBody(tableName) {
+        return {
+            "required": true,
+            "content": {
+                "application/json": {
+                    "schema": {
+                        "$ref": "#/components/schemas/" + tableName
+                    }
+                }
+            }
+        };
+    }
+    static _getSchemaApiMethodDescription(method, tableName, hasQueryIdParam) {
+        if (hasQueryIdParam) {
+            return method.toUpperCase() + " " + tableName + " object";
+        }
+        else {
+            return method.toUpperCase() + " " + tableName + " object array";
+        }
+    }
+    static _getSchemaApiMethodOperationId(method, tableName, hasQueryIdParam) {
+        if (hasQueryIdParam) {
+            return method + tableName;
+        }
+        else {
+            return method + tableName + "All";
+        }
+    }
+    static _getSchemaOinoResponse() {
+        return {
+            "type": "object",
+            "properties": {
+                "success": {
+                    "type": "boolean"
+                },
+                "status": {
+                    "type": "number"
+                },
+                "statusText": {
+                    "type": "string"
+                },
+                "messages": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            },
+            "required": [
+                "success",
+                "status",
+                "statusText",
+                "messages"
+            ]
+        };
+    }
+    static _getSchemaFieldType(field) {
+        let type_string;
+        if (field.type == "boolean") {
+            type_string = "boolean";
+        }
+        else if (field.type == "integer" || field.type == "number") {
+            type_string = "number";
+        }
+        else {
+            type_string = "string";
+        }
+        if (!field.fieldParams.isNotNull) {
+            return {
+                "anyOf": [
+                    {
+                        "type": type_string
+                    },
+                    {
+                        "type": "null"
+                    }
+                ]
+            };
+        }
+        else {
+            return { type: type_string };
+        }
+    }
+    static _getSwaggerApiType(api) {
+        let result = {
+            type: "object",
+            properties: {},
+            required: []
+        };
+        let field;
+        for (field of api.datamodel.fields) {
+            result.properties[field.name] = this._getSchemaFieldType(field);
+            if (field.fieldParams.isPrimaryKey) {
+                result.required.push(field.name);
+            }
+        }
+        return result;
+    }
+    static _getSchemaType(tableName, hasQueryIdParam, hasResultData) {
+        if (hasResultData && hasQueryIdParam) {
+            return { "$ref": "#/components/schemas/" + tableName };
+        }
+        else if (hasResultData) {
+            return { type: "array", items: { "$ref": "#/components/schemas/" + tableName } };
+        }
+        else if (hasQueryIdParam) {
+            return { "$ref": "#/components/schemas/OINOResponse" };
+        }
+        else {
+            return { "$ref": "#/components/schemas/OINOResponse" };
+        }
+    }
+    static _getSchemaApiMethodParams(hasQueryIdParam) {
+        if (hasQueryIdParam) {
+            return [this._getSchemaApiMethodParamsQueryId()];
+        }
+        else {
+            return [];
+        }
+    }
+    static _getSchemaApiMethod(method, tableName, hasQueryIdParam, hasBody, hasResultData) {
+        const result = {
+            responses: {
+                200: { description: this._getSchemaApiMethodDescription(method, tableName, hasQueryIdParam), content: { "application/json": { schema: this._getSchemaType(tableName, hasQueryIdParam, hasResultData) } } }
+            },
+            "operationId": this._getSchemaApiMethodOperationId(method, tableName, hasQueryIdParam),
+            "parameters": this._getSchemaApiMethodParams(hasQueryIdParam)
+        };
+        if (hasBody) {
+            result["requestBody"] = this._getSchemaApiMethodParamsBody(tableName);
+        }
+        return result;
+    }
+    static _getSwaggerApiPath(tableName, hasQueryIdParam) {
+        if (hasQueryIdParam) {
+            return {
+                get: this._getSchemaApiMethod("get", tableName, hasQueryIdParam, false, true),
+                put: this._getSchemaApiMethod("put", tableName, hasQueryIdParam, true, false),
+                delete: this._getSchemaApiMethod("delete", tableName, hasQueryIdParam, false, false)
+            };
+        }
+        else {
+            return {
+                get: this._getSchemaApiMethod("get", tableName, hasQueryIdParam, false, true),
+                post: this._getSchemaApiMethod("post", tableName, hasQueryIdParam, true, false)
+            };
+        }
+    }
+    /**
+     * Returns swagger.json as object of the given API's.
+     *
+     * @param apis array of API's use for Swagger definition
+     *
+     */
+    static getApiDefinition(apis) {
+        let result = {
+            "openapi": "3.1.0",
+            "info": {
+                "title": "",
+                "description": "",
+                "version": ""
+            },
+            "paths": {},
+            "components": {
+                "schemas": {
+                    OINOResponse: this._getSchemaOinoResponse()
+                }
+            }
+        };
+        for (let i = 0; i < apis.length; i++) {
+            if (!apis[i].initialized) {
+                throw new Error("API " + apis[i].params.tableName + " is not initialized, cannot create Swagger definition");
+            }
+            const table_name = apis[i].params.tableName;
+            result.paths["/" + table_name] = this._getSwaggerApiPath(table_name, false);
+            result.paths["/" + table_name + "/{id}"] = this._getSwaggerApiPath(table_name, true);
+            result.components.schemas[table_name] = this._getSwaggerApiType(apis[i]);
+        }
+        return result;
+    }
+}
+exports.OINOSwagger = OINOSwagger;

package/dist/cjs/index.js

@@ -1,53 +1,71 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.OINOHeaders = 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;
+exports.OINOSwagger = exports.OINOStr = exports.OINOHttpResult = exports.OINOResult = exports.OINOHttpRequest = exports.OINORequest = exports.OINOQueryAggregate = exports.OINOQueryLimit = exports.OINOQueryOrder = exports.OINOQueryFilter = exports.OINOQuerySelect = exports.OINOQueryAggregateFunctions = exports.OINOQueryNullCheck = exports.OINOQueryComparison = exports.OINOQueryBooleanOperation = exports.OINOParser = exports.OINOModelSet = exports.OINOConsoleLog = exports.OINOLogLevel = exports.OINOLog = exports.OINOHtmlTemplate = exports.OINOHeaders = exports.OINO_EMPTY_FORMATTER = exports.OINOFormatter = exports.OINOBlobDataField = exports.OINODatetimeDataField = exports.OINOBooleanDataField = exports.OINONumberDataField = exports.OINOStringDataField = exports.OINODataField = exports.OINOMemoryDataset = exports.OINODataSet = exports.OINODataSource = exports.OINODataModel = exports.OINO_EMPTY_ROWS = exports.OINO_EMPTY_ROW = 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.OINOConfig = exports.OINOMemoryBenchmark = exports.OINOBenchmark = exports.OINOApiHtmlTemplate = exports.OINOApiResult = exports.OINOApiRequest = exports.OINOApi = void 0;
+var OINOApi_js_1 = require("./OINOApi.js");
+Object.defineProperty(exports, "OINOApi", { enumerable: true, get: function () { return OINOApi_js_1.OINOApi; } });
+Object.defineProperty(exports, "OINOApiRequest", { enumerable: true, get: function () { return OINOApi_js_1.OINOApiRequest; } });
+Object.defineProperty(exports, "OINOApiResult", { enumerable: true, get: function () { return OINOApi_js_1.OINOApiResult; } });
+Object.defineProperty(exports, "OINOApiHtmlTemplate", { enumerable: true, get: function () { return OINOApi_js_1.OINOApiHtmlTemplate; } });
 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; } });
+var OINOConfig_js_1 = require("./OINOConfig.js");
+Object.defineProperty(exports, "OINOConfig", { enumerable: true, get: function () { return OINOConfig_js_1.OINOConfig; } });
+var OINOConstants_js_1 = require("./OINOConstants.js");
+Object.defineProperty(exports, "OINO_ERROR_PREFIX", { enumerable: true, get: function () { return OINOConstants_js_1.OINO_ERROR_PREFIX; } });
+Object.defineProperty(exports, "OINO_WARNING_PREFIX", { enumerable: true, get: function () { return OINOConstants_js_1.OINO_WARNING_PREFIX; } });
+Object.defineProperty(exports, "OINO_INFO_PREFIX", { enumerable: true, get: function () { return OINOConstants_js_1.OINO_INFO_PREFIX; } });
+Object.defineProperty(exports, "OINO_DEBUG_PREFIX", { enumerable: true, get: function () { return OINOConstants_js_1.OINO_DEBUG_PREFIX; } });
+Object.defineProperty(exports, "OINO_REQUEST_TYPE_PARAM", { enumerable: true, get: function () { return OINOConstants_js_1.OINO_REQUEST_TYPE_PARAM; } });
+Object.defineProperty(exports, "OINO_RESPONSE_TYPE_PARAM", { enumerable: true, get: function () { return OINOConstants_js_1.OINO_RESPONSE_TYPE_PARAM; } });
+Object.defineProperty(exports, "OINOContentType", { enumerable: true, get: function () { return OINOConstants_js_1.OINOContentType; } });
+Object.defineProperty(exports, "OINO_EMPTY_ROW", { enumerable: true, get: function () { return OINOConstants_js_1.OINO_EMPTY_ROW; } });
+Object.defineProperty(exports, "OINO_EMPTY_ROWS", { enumerable: true, get: function () { return OINOConstants_js_1.OINO_EMPTY_ROWS; } });
+var OINODataModel_js_1 = require("./OINODataModel.js");
+Object.defineProperty(exports, "OINODataModel", { enumerable: true, get: function () { return OINODataModel_js_1.OINODataModel; } });
+var OINODataSource_js_1 = require("./OINODataSource.js");
+Object.defineProperty(exports, "OINODataSource", { enumerable: true, get: function () { return OINODataSource_js_1.OINODataSource; } });
+Object.defineProperty(exports, "OINODataSet", { enumerable: true, get: function () { return OINODataSource_js_1.OINODataSet; } });
+Object.defineProperty(exports, "OINOMemoryDataset", { enumerable: true, get: function () { return OINODataSource_js_1.OINOMemoryDataset; } });
+var OINODataField_js_1 = require("./OINODataField.js");
+Object.defineProperty(exports, "OINODataField", { enumerable: true, get: function () { return OINODataField_js_1.OINODataField; } });
+Object.defineProperty(exports, "OINOStringDataField", { enumerable: true, get: function () { return OINODataField_js_1.OINOStringDataField; } });
+Object.defineProperty(exports, "OINONumberDataField", { enumerable: true, get: function () { return OINODataField_js_1.OINONumberDataField; } });
+Object.defineProperty(exports, "OINOBooleanDataField", { enumerable: true, get: function () { return OINODataField_js_1.OINOBooleanDataField; } });
+Object.defineProperty(exports, "OINODatetimeDataField", { enumerable: true, get: function () { return OINODataField_js_1.OINODatetimeDataField; } });
+Object.defineProperty(exports, "OINOBlobDataField", { enumerable: true, get: function () { return OINODataField_js_1.OINOBlobDataField; } });
+var OINOFormatter_js_1 = require("./OINOFormatter.js");
+Object.defineProperty(exports, "OINOFormatter", { enumerable: true, get: function () { return OINOFormatter_js_1.OINOFormatter; } });
+Object.defineProperty(exports, "OINO_EMPTY_FORMATTER", { enumerable: true, get: function () { return OINOFormatter_js_1.OINO_EMPTY_FORMATTER; } });
+var OINOHeaders_js_1 = require("./OINOHeaders.js");
+Object.defineProperty(exports, "OINOHeaders", { enumerable: true, get: function () { return OINOHeaders_js_1.OINOHeaders; } });
+var OINOHtmlTemplate_js_1 = require("./OINOHtmlTemplate.js");
+Object.defineProperty(exports, "OINOHtmlTemplate", { enumerable: true, get: function () { return OINOHtmlTemplate_js_1.OINOHtmlTemplate; } });
 var OINOLog_js_1 = require("./OINOLog.js");
 Object.defineProperty(exports, "OINOLog", { enumerable: true, get: function () { return OINOLog_js_1.OINOLog; } });
 Object.defineProperty(exports, "OINOLogLevel", { enumerable: true, get: function () { return OINOLog_js_1.OINOLogLevel; } });
 Object.defineProperty(exports, "OINOConsoleLog", { enumerable: true, get: function () { return OINOLog_js_1.OINOConsoleLog; } });
-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 OINOModelSet_js_1 = require("./OINOModelSet.js");
+Object.defineProperty(exports, "OINOModelSet", { enumerable: true, get: function () { return OINOModelSet_js_1.OINOModelSet; } });
+var OINOParser_js_1 = require("./OINOParser.js");
+Object.defineProperty(exports, "OINOParser", { enumerable: true, get: function () { return OINOParser_js_1.OINOParser; } });
+var OINOQueryParams_js_1 = require("./OINOQueryParams.js");
+Object.defineProperty(exports, "OINOQueryBooleanOperation", { enumerable: true, get: function () { return OINOQueryParams_js_1.OINOQueryBooleanOperation; } });
+Object.defineProperty(exports, "OINOQueryComparison", { enumerable: true, get: function () { return OINOQueryParams_js_1.OINOQueryComparison; } });
+Object.defineProperty(exports, "OINOQueryNullCheck", { enumerable: true, get: function () { return OINOQueryParams_js_1.OINOQueryNullCheck; } });
+Object.defineProperty(exports, "OINOQueryAggregateFunctions", { enumerable: true, get: function () { return OINOQueryParams_js_1.OINOQueryAggregateFunctions; } });
+Object.defineProperty(exports, "OINOQuerySelect", { enumerable: true, get: function () { return OINOQueryParams_js_1.OINOQuerySelect; } });
+Object.defineProperty(exports, "OINOQueryFilter", { enumerable: true, get: function () { return OINOQueryParams_js_1.OINOQueryFilter; } });
+Object.defineProperty(exports, "OINOQueryOrder", { enumerable: true, get: function () { return OINOQueryParams_js_1.OINOQueryOrder; } });
+Object.defineProperty(exports, "OINOQueryLimit", { enumerable: true, get: function () { return OINOQueryParams_js_1.OINOQueryLimit; } });
+Object.defineProperty(exports, "OINOQueryAggregate", { enumerable: true, get: function () { return OINOQueryParams_js_1.OINOQueryAggregate; } });
 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 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 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");
-Object.defineProperty(exports, "OINOHtmlTemplate", { enumerable: true, get: function () { return OINOHtmlTemplate_js_1.OINOHtmlTemplate; } });
-var OINOFormatter_js_1 = require("./OINOFormatter.js");
-Object.defineProperty(exports, "OINOFormatter", { enumerable: true, get: function () { return OINOFormatter_js_1.OINOFormatter; } });
-Object.defineProperty(exports, "OINO_EMPTY_FORMATTER", { enumerable: true, get: function () { return OINOFormatter_js_1.OINO_EMPTY_FORMATTER; } });
-var OINOHeaders_js_1 = require("./OINOHeaders.js");
-Object.defineProperty(exports, "OINOHeaders", { enumerable: true, get: function () { return OINOHeaders_js_1.OINOHeaders; } });
-/** OINO error message prefix */
-exports.OINO_ERROR_PREFIX = "OINO ERROR";
-/** OINO warning message prefix */
-exports.OINO_WARNING_PREFIX = "OINO WARNING";
-/** OINO info message prefix */
-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
- */
-var OINOContentType;
-(function (OINOContentType) {
-    /** JSON encoded data */
-    OINOContentType["json"] = "application/json";
-    /** CSV encoded data */
-    OINOContentType["csv"] = "text/csv";
-    /** Multipart encoded form data */
-    OINOContentType["formdata"] = "multipart/form-data";
-    /** URL encoded form data */
-    OINOContentType["urlencode"] = "application/x-www-form-urlencoded";
-    /** HTML encoded data (output only) */
-    OINOContentType["html"] = "text/html";
-})(OINOContentType || (exports.OINOContentType = OINOContentType = {}));
+var OINOSwagger_js_1 = require("./OINOSwagger.js");
+Object.defineProperty(exports, "OINOSwagger", { enumerable: true, get: function () { return OINOSwagger_js_1.OINOSwagger; } });

package/dist/esm/OINOApi.js

@@ -0,0 +1,315 @@
+import { Buffer } from "node:buffer";
+import { OINOHashid } from "@oino-ts/hashid";
+import { OINOQueryFilter, OINOQueryOrder, OINOQueryAggregate, OINOQueryLimit, OINOQuerySelect, OINOQueryBooleanOperation } from "./OINOQueryParams.js";
+import { OINOConfig } from "./OINOConfig.js";
+import { OINOHttpRequest } from "./OINORequest.js";
+import { OINOResult } from "./OINOResult.js";
+import { OINOHtmlTemplate } from "./OINOHtmlTemplate.js";
+import { OINODatetimeDataField, OINONumberDataField } from "./OINODataField.js";
+import { OINOBenchmark } from "./OINOBenchmark.js";
+export class OINOApiRequest extends OINOHttpRequest {
+    rowId;
+    rowData;
+    queryParams;
+    constructor(init) {
+        super(init);
+        this.rowId = init?.rowId || "";
+        this.rowData = init?.rowData || null; // rowData is not compatible with OINOHttpRequest body so it's not automatically set, caller can set both if needed
+        this.queryParams = init?.queryParams || {};
+        if (init?.filter) {
+            if (init.filter instanceof OINOQueryFilter) {
+                this.queryParams.filter = init.filter;
+            }
+            else {
+                this.queryParams.filter = OINOQueryFilter.parse(init.filter);
+            }
+        }
+        if (!this.queryParams.filter) {
+            const filter_params = this.url?.searchParams.getAll(OINOConfig.OINO_QUERY_FILTER_PARAM) || [];
+            for (let i = 0; i < filter_params.length; i++) {
+                const f = OINOQueryFilter.parse(filter_params[i]);
+                if (i > 0) {
+                    this.queryParams.filter = OINOQueryFilter.combine(this.queryParams.filter, OINOQueryBooleanOperation.and, f);
+                }
+                else {
+                    this.queryParams.filter = f;
+                }
+            }
+        }
+        if (init?.order) {
+            if (init.order instanceof OINOQueryOrder) {
+                this.queryParams.order = init.order;
+            }
+            else {
+                this.queryParams.order = OINOQueryOrder.parse(init.order);
+            }
+        }
+        if (!this.queryParams.order) {
+            const order_param = this.url?.searchParams.get(OINOConfig.OINO_QUERY_ORDER_PARAM);
+            if (order_param) {
+                this.queryParams.order = OINOQueryOrder.parse(order_param);
+            }
+        }
+        if (init?.limit) {
+            if (init.limit instanceof OINOQueryLimit) {
+                this.queryParams.limit = init.limit;
+            }
+            else {
+                this.queryParams.limit = OINOQueryLimit.parse(init.limit);
+            }
+        }
+        if (!this.queryParams.limit) {
+            const limit_param = this.url?.searchParams.get(OINOConfig.OINO_QUERY_LIMIT_PARAM);
+            if (limit_param) {
+                this.queryParams.limit = OINOQueryLimit.parse(limit_param);
+            }
+        }
+        if (init?.aggregate) {
+            if (init.aggregate instanceof OINOQueryAggregate) {
+                this.queryParams.aggregate = init.aggregate;
+            }
+            else {
+                this.queryParams.aggregate = OINOQueryAggregate.parse(init.aggregate);
+            }
+        }
+        if (!this.queryParams.aggregate) {
+            const aggregate_param = this.url?.searchParams.get(OINOConfig.OINO_QUERY_AGGREGATE_PARAM);
+            if (aggregate_param) {
+                this.queryParams.aggregate = OINOQueryAggregate.parse(aggregate_param);
+            }
+        }
+        if (init?.select) {
+            if (init.select instanceof OINOQuerySelect) {
+                this.queryParams.select = init.select;
+            }
+            else {
+                this.queryParams.select = OINOQuerySelect.parse(init.select);
+            }
+        }
+        if (!this.queryParams.select) {
+            const select_param = this.url?.searchParams.get(OINOConfig.OINO_QUERY_SELECT_PARAM);
+            if (select_param) {
+                this.queryParams.select = OINOQuerySelect.parse(select_param);
+            }
+        }
+    }
+    static async fromFetchRequest(request, rowId, rowData, queryParams) {
+        return new OINOApiRequest({
+            url: new URL(request.url),
+            method: request.method,
+            headers: Object.fromEntries(request.headers),
+            rowId: rowId,
+            rowData: rowData ?? Buffer.from(await request.arrayBuffer()),
+            queryParams: queryParams
+        });
+    }
+    static fromHttpRequest(request, rowId, rowData, queryParams) {
+        return new OINOApiRequest({
+            url: typeof request.url === "string" ? new URL(request.url) : request.url,
+            method: request.method,
+            headers: Object.fromEntries(request.headers),
+            rowId: rowId,
+            rowData: rowData ?? request.bodyAsBuffer(),
+            requestType: request.requestType,
+            responseType: request.responseType,
+            multipartBoundary: request.multipartBoundary,
+            lastModified: request.lastModified,
+            queryParams: queryParams
+        });
+    }
+}
+/**
+ * OINO API request result object with returned data and/or http status code/message and
+ * error / warning messages.
+ *
+ */
+export class OINOApiResult extends OINOResult {
+    /** DbApi request params */
+    request;
+    /** Returned data if any */
+    data;
+    /**
+     * Constructor of OINOApiResult.
+     *
+     * @param request DbApi request parameters
+     * @param data result data
+     *
+     */
+    constructor(request, data) {
+        super();
+        this.request = request;
+        this.data = data;
+    }
+    /**
+     * Creates a HTTP Response from API results.
+     *
+     * @param headers Headers to include in the response
+     *
+     */
+    async writeApiResponse(headers = {}) {
+        let response = null;
+        if (this.success && this.data) {
+            const body = await this.data.writeString(this.request.responseType);
+            response = new Response(body, { status: this.status, statusText: this.statusText, headers: headers });
+        }
+        else {
+            response = new Response(JSON.stringify(this, null, 3), { status: this.status, statusText: this.statusText, headers: headers });
+        }
+        if (this.request.responseDownload) {
+            response.headers.set('Content-Disposition', 'attachment; filename="' + this.request.responseDownload + '"');
+        }
+        else {
+            response.headers.set('Content-Disposition', 'inline');
+        }
+        for (let i = 0; i < this.messages.length; i++) {
+            response.headers.set('X-OINO-MESSAGE-' + i, this.messages[i]);
+        }
+        return Promise.resolve(response);
+    }
+}
+/**
+ * Specialized HTML template that can render ´OINOApiResult´.
+ *
+ */
+export class OINOApiHtmlTemplate extends OINOHtmlTemplate {
+    /** Locale validation regex */
+    static LOCALE_REGEX = /^(\w\w)(\-\w\w)?$/;
+    /** Locale formatter */
+    _locale;
+    _numberDecimals = -1;
+    /**
+     * Constructor of OINOApiHtmlTemplate.
+     *
+     * @param template HTML template string
+     * @param numberDecimals Number of decimals to use for numbers, -1 for no formatting
+     * @param dateLocaleStr Datetime format string, either "iso" for ISO8601 or "default" for system default or valid locale string
+     * @param dateLocaleStyle Datetime format style, either "short/medium/long/full" or Intl.DateTimeFormat options
+     *
+     */
+    constructor(template, numberDecimals = -1, dateLocaleStr = "", dateLocaleStyle = "") {
+        super(template);
+        let locale_opts;
+        if ((dateLocaleStyle == null) || (dateLocaleStyle == "")) {
+            locale_opts = { dateStyle: "medium", timeStyle: "medium" };
+        }
+        else if (typeof dateLocaleStyle == "string") {
+            locale_opts = { dateStyle: dateLocaleStyle, timeStyle: dateLocaleStyle };
+        }
+        else {
+            locale_opts = dateLocaleStyle;
+        }
+        this._locale = null;
+        this._numberDecimals = numberDecimals;
+        if ((dateLocaleStr != null) && (dateLocaleStr != "") && OINOApiHtmlTemplate.LOCALE_REGEX.test(dateLocaleStr)) {
+            try {
+                this._locale = new Intl.DateTimeFormat(dateLocaleStr, locale_opts);
+            }
+            catch (e) { }
+        }
+    }
+    /**
+     * Creates HTML Response from API modelset.
+     *
+     * @param modelset OINO API dataset
+     * @param overrideValues values to override in the data
+     *
+     */
+    async renderFromDbData(modelset, overrideValues) {
+        OINOBenchmark.startMetric("OINOHtmlTemplate", "renderFromDbData");
+        let html = "";
+        const dataset = modelset.dataset;
+        const datamodel = modelset.datamodel;
+        const api = modelset.datamodel.api;
+        const modified_index = datamodel.findFieldIndexByName(api.params.cacheModifiedField || "");
+        let last_modified = this.modified;
+        while (!dataset.isEof()) {
+            const row = dataset.getRow();
+            if (modified_index >= 0) {
+                last_modified = Math.max(last_modified, new Date(row[modified_index]).getTime());
+            }
+            let row_id_seed = datamodel.getRowPrimarykeyValues(row).join(' ');
+            let primary_key_values = [];
+            this.clearVariables();
+            this.setVariableFromValue(OINOConfig.OINO_ID_FIELD, "");
+            for (let i = 0; i < datamodel.fields.length; i++) {
+                const f = datamodel.fields[i];
+                let value;
+                if ((f instanceof OINODatetimeDataField) && (this._locale != null)) {
+                    value = f.serializeCellWithLocale(row[i], this._locale);
+                }
+                else if ((f instanceof OINONumberDataField) && (this._numberDecimals >= 0) && (typeof row[i] === "number")) {
+                    // console.debug("renderFromDbData number decimals", { field: f.name, value: row[i], type: typeof row[i] });
+                    value = row[i].toFixed(this._numberDecimals);
+                }
+                else {
+                    value = f.serializeCell(row[i]);
+                }
+                if (f.fieldParams.isPrimaryKey || f.fieldParams.isForeignKey) {
+                    if (value && (f instanceof OINONumberDataField) && (datamodel.api.hashid)) {
+                        value = datamodel.api.hashid.encode(value, f.name + " " + row_id_seed);
+                    }
+                    if (f.fieldParams.isPrimaryKey) {
+                        primary_key_values.push(value || "");
+                    }
+                }
+                this.setVariableFromValue(f.name, value || "");
+            }
+            this.setVariableFromProperties(overrideValues);
+            this.setVariableFromValue(OINOConfig.OINO_ID_FIELD, OINOConfig.printOINOId(primary_key_values));
+            html += this._renderHtml() + "\r\n";
+            await dataset.next();
+        }
+        this.modified = last_modified;
+        const result = this._createHttpResult(html);
+        OINOBenchmark.endMetric("OINOHtmlTemplate", "renderFromDbData");
+        return result;
+    }
+}
+/**
+ * API class with method to process HTTP REST requests.
+ *
+ */
+export class OINOApi {
+    /** Enable debug output on errors */
+    _debugOnError = false;
+    /** API database reference */
+    datasource;
+    /** API parameters */
+    params;
+    /** API hashid */
+    hashid;
+    /** Is API initialized */
+    initialized = false;
+    /** API datamodel */
+    datamodel = null;
+    constructor(datasource, params) {
+        this.datasource = datasource;
+        this.params = params;
+        if (this.params.hashidKey) {
+            this.hashid = new OINOHashid(this.params.hashidKey, this.params.apiName, this.params.hashidLength, this.params.hashidStaticIds);
+        }
+        else {
+            this.hashid = null;
+        }
+    }
+    /**
+     * Enable or disable debug output on errors.
+     *
+     * @param debugOnError true to enable debug output on errors, false to disable
+     */
+    setDebugOnError(debugOnError) {
+        this._debugOnError = debugOnError;
+    }
+    /**
+     * Method to check if a field is included in the API params.
+     *
+     * @param fieldName name of the field
+     *
+     */
+    isFieldIncluded(fieldName) {
+        const params = this.params;
+        return (((params.excludeFieldPrefix == undefined) || (params.excludeFieldPrefix == "") || (fieldName.startsWith(params.excludeFieldPrefix) == false)) &&
+            ((params.excludeFields == undefined) || (params.excludeFields.length == 0) || (params.excludeFields.indexOf(fieldName) < 0)) &&
+            ((params.includeFields == undefined) || (params.includeFields.length == 0) || (params.includeFields.indexOf(fieldName) >= 0)));
+    }
+}