@oino-ts/common 0.21.1 → 1.0.0

package/dist/cjs/OINOFormatter.js

@@ -6,7 +6,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OINO_EMPTY_FORMATTER = exports.OINOFormatter = void 0;
-const index_js_1 = require("./index.js");
+const OINOConstants_js_1 = require("./OINOConstants.js");
+const OINOLog_js_1 = require("./OINOLog.js");
 /**
  * Class for formatting strings and values.
  *
@@ -53,8 +54,8 @@ class OINOFormatter {
             for (let i = 0; i < formatters.length; i++) {
                 let match = formatters[i]?.match(this.OINO_FORMATTER_REGEXP);
                 if (!match) {
-                    index_js_1.OINOLog.error("@oino-ts/common", "OINOFormatter", "parse", "Invalid formatter string", { formatter: formatters[i] });
-                    throw new Error(index_js_1.OINO_ERROR_PREFIX + "Invalid formatter: " + formatters[i]);
+                    OINOLog_js_1.OINOLog.error("@oino-ts/common", "OINOFormatter", "parse", "Invalid formatter string", { formatter: formatters[i] });
+                    throw new Error(OINOConstants_js_1.OINO_ERROR_PREFIX + "Invalid formatter: " + formatters[i]);
                 }
                 else {
                     const formatter_type = match[1].toLowerCase().substring(0, match[1].indexOf('('));
@@ -81,8 +82,8 @@ class OINOFormatter {
                         formatter_params.push(decodeURIComponent(match[15]), decodeURIComponent(match[16]));
                     }
                     else {
-                        index_js_1.OINOLog.error("@oino-ts/common", "OINOFormatter", "parse", "Unknown formatter type", { formatter: formatters[i] });
-                        throw new Error(index_js_1.OINO_ERROR_PREFIX + "Unsupported formatter: " + formatters[i]);
+                        OINOLog_js_1.OINOLog.error("@oino-ts/common", "OINOFormatter", "parse", "Unknown formatter type", { formatter: formatters[i] });
+                        throw new Error(OINOConstants_js_1.OINO_ERROR_PREFIX + "Unsupported formatter: " + formatters[i]);
                     }
                     types.push(formatter_type);
                     params.push(formatter_params);

package/dist/cjs/OINOHtmlTemplate.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OINOHtmlTemplate = void 0;
-const _1 = require(".");
+const OINOConstants_js_1 = require("./OINOConstants.js");
+const OINOStr_js_1 = require("./OINOStr.js");
+const OINOResult_js_1 = require("./OINOResult.js");
+const OINOBenchmark_js_1 = require("./OINOBenchmark.js");
 const OINOFormatter_1 = require("./OINOFormatter");
 /**
  * Class for rendering HTML from data.
@@ -66,7 +69,7 @@ class OINOHtmlTemplate {
         }
     }
     _createHttpResult(html) {
-        const result = new _1.OINOHttpResult({ body: html });
+        const result = new OINOResult_js_1.OINOHttpResult({ body: html });
         if (this.expires >= 1) {
             result.expires = Math.round(this.expires);
         }
@@ -111,7 +114,7 @@ class OINOHtmlTemplate {
      */
     setVariableFromValue(variable, value, escapeValue = true) {
         if (escapeValue) {
-            value = _1.OINOStr.encode(value, _1.OINOContentType.html);
+            value = OINOStr_js_1.OINOStr.encode(value, OINOConstants_js_1.OINOContentType.html);
         }
         this._variables[variable] = value;
     }
@@ -126,7 +129,7 @@ class OINOHtmlTemplate {
         if (object) {
             for (let key in object) {
                 if (escapeValue) {
-                    this._variables[key] = _1.OINOStr.encode(object[key], _1.OINOContentType.html);
+                    this._variables[key] = OINOStr_js_1.OINOStr.encode(object[key], OINOConstants_js_1.OINOContentType.html);
                 }
                 else {
                     this._variables[key] = object[key];
@@ -151,10 +154,10 @@ class OINOHtmlTemplate {
      *
      */
     renderFromKeyValue(key, value) {
-        _1.OINOBenchmark.startMetric("OINOHtmlTemplate", "renderFromKeyValue");
+        OINOBenchmark_js_1.OINOBenchmark.startMetric("OINOHtmlTemplate", "renderFromKeyValue");
         this.setVariableFromValue(key, value);
         const result = this.render();
-        _1.OINOBenchmark.endMetric("OINOHtmlTemplate", "renderFromKeyValue");
+        OINOBenchmark_js_1.OINOBenchmark.endMetric("OINOHtmlTemplate", "renderFromKeyValue");
         return result;
     }
     /**
@@ -164,10 +167,10 @@ class OINOHtmlTemplate {
      *
      */
     renderFromObject(object = true) {
-        _1.OINOBenchmark.startMetric("OINOHtmlTemplate", "renderFromObject");
+        OINOBenchmark_js_1.OINOBenchmark.startMetric("OINOHtmlTemplate", "renderFromObject");
         this.setVariableFromProperties(object);
         const result = this.render();
-        _1.OINOBenchmark.endMetric("OINOHtmlTemplate", "renderFromObject");
+        OINOBenchmark_js_1.OINOBenchmark.endMetric("OINOHtmlTemplate", "renderFromObject");
         return result;
     }
     /**
@@ -182,29 +185,29 @@ class OINOHtmlTemplate {
      *
      */
     renderFromResult(result, messageSeparator = "", includeErrorMessages = false, includeWarningMessages = false, includeInfoMessages = false, includeDebugMessages = false) {
-        _1.OINOBenchmark.startMetric("OINOHtmlTemplate", "renderFromResult");
+        OINOBenchmark_js_1.OINOBenchmark.startMetric("OINOHtmlTemplate", "renderFromResult");
         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)) {
-                messages.push(_1.OINOStr.encode(result.messages[i], _1.OINOContentType.html));
+            if (includeErrorMessages && result.messages[i].startsWith(OINOConstants_js_1.OINO_ERROR_PREFIX)) {
+                messages.push(OINOStr_js_1.OINOStr.encode(result.messages[i], OINOConstants_js_1.OINOContentType.html));
             }
-            if (includeWarningMessages && result.messages[i].startsWith(_1.OINO_WARNING_PREFIX)) {
-                messages.push(_1.OINOStr.encode(result.messages[i], _1.OINOContentType.html));
+            if (includeWarningMessages && result.messages[i].startsWith(OINOConstants_js_1.OINO_WARNING_PREFIX)) {
+                messages.push(OINOStr_js_1.OINOStr.encode(result.messages[i], OINOConstants_js_1.OINOContentType.html));
             }
-            if (includeInfoMessages && result.messages[i].startsWith(_1.OINO_INFO_PREFIX)) {
-                messages.push(_1.OINOStr.encode(result.messages[i], _1.OINOContentType.html));
+            if (includeInfoMessages && result.messages[i].startsWith(OINOConstants_js_1.OINO_INFO_PREFIX)) {
+                messages.push(OINOStr_js_1.OINOStr.encode(result.messages[i], OINOConstants_js_1.OINOContentType.html));
             }
-            if (includeDebugMessages && result.messages[i].startsWith(_1.OINO_DEBUG_PREFIX)) {
-                messages.push(_1.OINOStr.encode(result.messages[i], _1.OINOContentType.html));
+            if (includeDebugMessages && result.messages[i].startsWith(OINOConstants_js_1.OINO_DEBUG_PREFIX)) {
+                messages.push(OINOStr_js_1.OINOStr.encode(result.messages[i], OINOConstants_js_1.OINOContentType.html));
             }
         }
         if (messageSeparator && (messages.length > 0)) {
             this.setVariableFromValue("messages", messages.join(messageSeparator), false); // messages have been escaped already
         }
         const http_result = this.render();
-        _1.OINOBenchmark.endMetric("OINOHtmlTemplate", "renderFromResult");
+        OINOBenchmark_js_1.OINOBenchmark.endMetric("OINOHtmlTemplate", "renderFromResult");
         return http_result;
     }
 }

package/dist/cjs/OINOModelSet.js

@@ -0,0 +1,333 @@
+"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.OINOModelSet = void 0;
+const OINOConstants_js_1 = require("./OINOConstants.js");
+const OINOConfig_js_1 = require("./OINOConfig.js");
+const OINOStr_js_1 = require("./OINOStr.js");
+const OINOLog_js_1 = require("./OINOLog.js");
+const OINODataField_js_1 = require("./OINODataField.js");
+/**
+ * Class for dataset based on a data model that can be serialized to
+ * a supported format:
+ * - JSON (application/json)
+ * - CSV (text/csv)
+ *
+ */
+class OINOModelSet {
+    /** Reference to datamodel */
+    datamodel;
+    /** Reference to data set */
+    dataset;
+    /** SQL parameters */
+    queryParams;
+    /** Collection of errors */
+    errors;
+    /**
+     * Constructor for `OINOModelSet`.
+     *
+     * @param datamodel data model
+     * @param dataset data set
+     * @param queryParams SQL parameters
+     */
+    constructor(datamodel, dataset, queryParams) {
+        this.datamodel = datamodel;
+        this.dataset = dataset;
+        this.queryParams = queryParams;
+        this.errors = this.dataset.messages;
+    }
+    _encodeAndHashFieldValue(field, value, contentType, primaryKeyValues, rowIdSeed) {
+        let result;
+        if (field.fieldParams.isPrimaryKey || field.fieldParams.isForeignKey) {
+            if (value && (field instanceof OINODataField_js_1.OINONumberDataField) && (this.datamodel.api.hashid) && ((this.queryParams?.aggregate === undefined) || (this.queryParams.aggregate.isAggregated(field.name) == false))) {
+                value = this.datamodel.api.hashid.encode(value, rowIdSeed);
+            }
+            if (field.fieldParams.isPrimaryKey) {
+                primaryKeyValues.push(value || "");
+            }
+        }
+        result = OINOStr_js_1.OINOStr.encode(value, contentType);
+        return result;
+    }
+    _writeRowJson(row) {
+        // console.log("OINOModelSet._writeRowJson: row=" + row)
+        const model = this.datamodel;
+        const fields = model.fields;
+        let row_id_seed = model.getRowPrimarykeyValues(row).join(' ');
+        let primary_key_values = [];
+        let json_row = "";
+        for (let i = 0; i < fields.length; i++) {
+            const f = fields[i];
+            if ((this.queryParams?.select?.isSelected(f.name) === false) && (f.fieldParams.isPrimaryKey == false)) {
+                continue;
+            }
+            let value = f.serializeCell(row[i]);
+            if (value === undefined) {
+                // skip undefined values
+            }
+            else if (value === null) {
+                json_row += "," + OINOStr_js_1.OINOStr.encode(f.name, OINOConstants_js_1.OINOContentType.json) + ":null";
+            }
+            else {
+                let is_hashed = (f.fieldParams.isPrimaryKey || f.fieldParams.isForeignKey) && (f instanceof OINODataField_js_1.OINONumberDataField) && (this.datamodel.api.hashid != null);
+                let is_value = (f instanceof OINODataField_js_1.OINOBooleanDataField) || ((f instanceof OINODataField_js_1.OINONumberDataField) && !is_hashed);
+                value = this._encodeAndHashFieldValue(f, value, OINOConstants_js_1.OINOContentType.json, primary_key_values, f.name + " " + row_id_seed);
+                if (is_value) {
+                    value = value.substring(1, value.length - 1);
+                }
+                json_row += "," + OINOStr_js_1.OINOStr.encode(f.name, OINOConstants_js_1.OINOContentType.json) + ":" + value;
+            }
+        }
+        json_row = OINOStr_js_1.OINOStr.encode(OINOConfig_js_1.OINOConfig.OINO_ID_FIELD, OINOConstants_js_1.OINOContentType.json) + ":" + OINOStr_js_1.OINOStr.encode(OINOConfig_js_1.OINOConfig.printOINOId(primary_key_values), OINOConstants_js_1.OINOContentType.json) + json_row;
+        return "{" + json_row + "}";
+    }
+    async _writeStringJson() {
+        let result = "";
+        while (!this.dataset.isEof()) {
+            if (result != "") {
+                result += ",\r\n";
+            }
+            const row = this.dataset.getRow();
+            result += this._writeRowJson(row);
+            await this.dataset.next();
+        }
+        result = "[\r\n" + result + "\r\n]";
+        return result;
+    }
+    _writeHeaderCsv() {
+        const model = this.datamodel;
+        const fields = model.fields;
+        let csv_header = "\"" + OINOConfig_js_1.OINOConfig.OINO_ID_FIELD + "\"";
+        for (let i = 0; i < fields.length; i++) {
+            if ((this.queryParams?.select?.isSelected(fields[i].name) === false) && (fields[i].fieldParams.isPrimaryKey == false)) {
+                continue;
+            }
+            csv_header += ",\"" + fields[i].name + "\"";
+        }
+        return csv_header;
+    }
+    _writeRowCsv(row) {
+        const model = this.datamodel;
+        const fields = model.fields;
+        let row_id_seed = model.getRowPrimarykeyValues(row).join(' ');
+        let primary_key_values = [];
+        let csv_row = "";
+        for (let i = 0; i < fields.length; i++) {
+            const f = fields[i];
+            if ((this.queryParams?.select?.isSelected(f.name) === false) && (f.fieldParams.isPrimaryKey == false)) {
+                continue;
+            }
+            let value = f.serializeCell(row[i]);
+            if (value == null) {
+                csv_row += "," + OINOStr_js_1.OINOStr.encode(value, OINOConstants_js_1.OINOContentType.csv); // either null or undefined
+            }
+            else {
+                value = this._encodeAndHashFieldValue(f, value, OINOConstants_js_1.OINOContentType.csv, primary_key_values, f.name + " " + row_id_seed);
+                csv_row += "," + value;
+            }
+        }
+        csv_row = OINOStr_js_1.OINOStr.encode(OINOConfig_js_1.OINOConfig.printOINOId(primary_key_values), OINOConstants_js_1.OINOContentType.csv) + csv_row;
+        return csv_row;
+    }
+    async _writeStringCsv() {
+        let result = this._writeHeaderCsv();
+        while (!this.dataset.isEof()) {
+            if (result != "") {
+                result += "\r\n";
+            }
+            const row = this.dataset.getRow();
+            result += this._writeRowCsv(row);
+            await this.dataset.next();
+        }
+        return result;
+    }
+    _writeRowFormdataParameterBlock(blockName, blockValue, multipartBoundary) {
+        if (blockValue === null) {
+            return multipartBoundary + "\r\n" + "Content-Disposition: form-data; name=\"" + blockName + "\"\r\n\r\n";
+        }
+        else {
+            return multipartBoundary + "\r\n" + "Content-Disposition: form-data; name=\"" + blockName + "\"\r\n\r\n" + blockValue + "\r\n";
+        }
+    }
+    _writeRowFormdataFileBlock(blockName, blockValue, multipartBoundary) {
+        return multipartBoundary + "\r\n" + "Content-Disposition: form-data; name=\"" + blockName + "\"; filename=" + blockName + "\"\r\nContent-Type: application/octet-stream\r\nContent-Transfer-Encoding: BASE64\r\n\r\n" + blockValue + "\r\n";
+    }
+    _writeRowFormdata(row) {
+        const multipart_boundary = "---------OINOMultipartBoundary35424568"; // this method is just used for test data generation and we want it to be static
+        const model = this.datamodel;
+        const fields = model.fields;
+        let row_id_seed = model.getRowPrimarykeyValues(row).join(' ');
+        let primary_key_values = [];
+        let result = "";
+        for (let i = 0; i < fields.length; i++) {
+            const f = fields[i];
+            if ((this.queryParams?.select?.isSelected(f.name) === false) && (f.fieldParams.isPrimaryKey == false)) {
+                continue;
+            }
+            let value = f.serializeCell(row[i]);
+            let formdata_block = "";
+            let is_file = (f instanceof OINODataField_js_1.OINOBlobDataField);
+            if (value === undefined) {
+                OINOLog_js_1.OINOLog.info("@oino-ts/db", "OINOModelSet", "_writeRowFormdata", "Undefined value skipped", { field_name: f.name });
+            }
+            else if (value === null) {
+                formdata_block = this._writeRowFormdataParameterBlock(fields[i].name, null, multipart_boundary);
+            }
+            else {
+                value = this._encodeAndHashFieldValue(f, value, OINOConstants_js_1.OINOContentType.formdata, primary_key_values, f.name + " " + row_id_seed);
+                if (is_file) {
+                    formdata_block = this._writeRowFormdataFileBlock(f.name, value, multipart_boundary);
+                }
+                else {
+                    formdata_block = this._writeRowFormdataParameterBlock(fields[i].name, value, multipart_boundary);
+                }
+            }
+            result += formdata_block;
+        }
+        result = this._writeRowFormdataParameterBlock(OINOConfig_js_1.OINOConfig.OINO_ID_FIELD, OINOConfig_js_1.OINOConfig.printOINOId(primary_key_values), multipart_boundary) + result;
+        return result;
+    }
+    _writeStringFormdata() {
+        const row = this.dataset.getRow();
+        let result = this._writeRowFormdata(row);
+        return result;
+    }
+    _writeRowUrlencode(row) {
+        const model = this.datamodel;
+        const fields = model.fields;
+        let row_id_seed = model.getRowPrimarykeyValues(row).join(' ');
+        let primary_key_values = [];
+        let urlencode_row = "";
+        for (let i = 0; i < fields.length; i++) {
+            const f = fields[i];
+            if ((this.queryParams?.select?.isSelected(f.name) === false) && (f.fieldParams.isPrimaryKey == false)) {
+                continue;
+            }
+            let value = f.serializeCell(row[i]);
+            if ((value === undefined)) { // || (value === null)) {
+                // console.log("OINOModelSet._writeRowUrlencode undefined field value:" + fields[i].name)
+            }
+            else {
+                value = this._encodeAndHashFieldValue(f, value, OINOConstants_js_1.OINOContentType.urlencode, primary_key_values, f.name + " " + row_id_seed);
+                if (urlencode_row != "") {
+                    urlencode_row += "&";
+                }
+                urlencode_row += OINOStr_js_1.OINOStr.encode(f.name, OINOConstants_js_1.OINOContentType.urlencode) + "=" + value;
+            }
+        }
+        urlencode_row = OINOStr_js_1.OINOStr.encode(OINOConfig_js_1.OINOConfig.OINO_ID_FIELD, OINOConstants_js_1.OINOContentType.urlencode) + "=" + OINOStr_js_1.OINOStr.encode(OINOConfig_js_1.OINOConfig.printOINOId(primary_key_values), OINOConstants_js_1.OINOContentType.urlencode) + "&" + urlencode_row;
+        return urlencode_row;
+    }
+    async _writeStringUrlencode() {
+        let result = "";
+        let line_count = 0;
+        while (!this.dataset.isEof()) {
+            const row = this.dataset.getRow();
+            result += this._writeRowUrlencode(row) + "\r\n";
+            await this.dataset.next();
+            line_count += 1;
+        }
+        if (line_count > 1) {
+            OINOLog_js_1.OINOLog.warning("@oino-ts/db", "OINOModelSet", "_writeStringUrlencode", "Content type " + OINOConstants_js_1.OINOContentType.urlencode + " does not officially support multiline content!", {});
+        }
+        return result;
+    }
+    _exportRow(row) {
+        // console.log("OINOModelSet._exportRow: row=" + row)
+        const model = this.datamodel;
+        const fields = model.fields;
+        let row_id_seed = model.getRowPrimarykeyValues(row).join(' ');
+        let primary_key_values = [];
+        let result = {};
+        for (let i = 0; i < fields.length; i++) {
+            const f = fields[i];
+            if (f.fieldParams.isPrimaryKey) {
+                primary_key_values.push(f.serializeCell(row[i]) || "");
+            }
+            if ((this.queryParams?.select?.isSelected(f.name) === false) && (f.fieldParams.isPrimaryKey == false)) {
+                continue;
+            }
+            let value = f.datasource.parseValueAsCell(row[i], f.nativeType); // retain original value without serialization
+            if (value === undefined) {
+                // skip undefined values
+            }
+            else if (value === null) { // differentiate null and undefined
+                result[f.name] = null;
+            }
+            else {
+                result[f.name] = value;
+            }
+        }
+        result[OINOConfig_js_1.OINOConfig.OINO_ID_FIELD] = OINOConfig_js_1.OINOConfig.printOINOId(primary_key_values);
+        return result;
+    }
+    /**
+     * Serialize model set in the given format.
+     *
+     * @param [contentType=OINOContentType.json] serialization content type
+     *
+     */
+    async writeString(contentType = OINOConstants_js_1.OINOContentType.json) {
+        let result = "";
+        if (contentType == OINOConstants_js_1.OINOContentType.csv) {
+            result += await this._writeStringCsv();
+        }
+        else if (contentType == OINOConstants_js_1.OINOContentType.json) {
+            result += await this._writeStringJson();
+        }
+        else if (contentType == OINOConstants_js_1.OINOContentType.formdata) {
+            result += await this._writeStringFormdata();
+        }
+        else if (contentType == OINOConstants_js_1.OINOContentType.urlencode) {
+            result += await this._writeStringUrlencode();
+        }
+        else {
+            OINOLog_js_1.OINOLog.error("@oino-ts/db", "OINOModelSet", "writeString", "Content type is only for input!", { contentType: contentType });
+        }
+        return result;
+    }
+    /**
+     * Get value of given field in the current row. Undefined if no rows,
+     * field not found or value does not exist.
+     *
+     * @param fieldName name of the field
+     * @param serialize serialize the value
+     *
+     */
+    getValueByFieldName(fieldName, serialize = false) {
+        let result = undefined;
+        if (!this.dataset.isEof()) {
+            const current_row = this.dataset.getRow();
+            const field_index = this.datamodel.findFieldIndexByName(fieldName);
+            if (field_index >= 0) {
+                result = current_row[field_index];
+                if (serialize) {
+                    result = this.datamodel.fields[field_index].serializeCell(result);
+                }
+            }
+        }
+        return result;
+    }
+    /**
+     * Export all rows as a record with OINOId as key and object with row cells as values.
+     *
+     * @param idFieldName optional field name to use as key instead of OINOId
+     */
+    async exportAsRecord(idFieldName) {
+        const result = {};
+        const row_id_field = idFieldName || OINOConfig_js_1.OINOConfig.OINO_ID_FIELD;
+        while (!this.dataset.isEof()) {
+            const row_data = this.dataset.getRow();
+            const row_export = this._exportRow(row_data);
+            const row_id = row_export[row_id_field];
+            result[row_id] = row_export;
+            await this.dataset.next();
+        }
+        return result;
+    }
+}
+exports.OINOModelSet = OINOModelSet;