@oino-ts/db 0.21.2 → 1.0.0

package/dist/cjs/OINODbConfig.js

@@ -8,13 +8,13 @@ class OINODbConfig {
     /** Private key separator of the synthetic OINO ID field */
     static OINODB_ID_SEPARATOR = "_";
     static OINODB_ID_SEPARATOR_ESCAPED = "%";
-    /** Name of the OINODbSqlFilter-parameter in request */
+    /** Name of the OINODbQueryFilter-parameter in request */
     static OINODB_SQL_FILTER_PARAM = "oinosqlfilter";
-    /** Name of the OINODbSqlOrder-parameter in request */
+    /** Name of the OINODbQueryOrder-parameter in request */
     static OINODB_SQL_ORDER_PARAM = "oinosqlorder";
-    /** Name of the OINODbSqlLimit-parameter in request */
+    /** Name of the OINODbQueryLimit-parameter in request */
     static OINODB_SQL_LIMIT_PARAM = "oinosqllimit";
-    /** Name of the OINODbSqlAggregate-parameter in request */
+    /** Name of the OINODbQueryAggregate-parameter in request */
     static OINODB_SQL_AGGREGATE_PARAM = "oinosqlaggregate";
     /** Name of the OINODbSqlSelect-parameter in request */
     static OINODB_SQL_SELECT_PARAM = "oinosqlselect";
@@ -54,9 +54,9 @@ class OINODbConfig {
         return result;
     }
     /**
-     * Set the name of the OINODbSqlFilter-param field
+     * Set the name of the OINODbQueryFilter-param field
      *
-     * @param sqlFilterParam name of the http parameter with `OINODbSqlFilter` definition
+     * @param sqlFilterParam name of the http parameter with `OINODbQueryFilter` definition
      *
      */
     static setOinoSqlFilterParam(sqlFilterParam) {
@@ -65,9 +65,9 @@ class OINODbConfig {
         }
     }
     /**
-     * Set the name of the OINODbSqlOrder-param field
+     * Set the name of the OINODbQueryOrder-param field
      *
-     * @param sqlOrderParam name of the http parameter with `OINODbSqlOrder` definition
+     * @param sqlOrderParam name of the http parameter with `OINODbQueryOrder` definition
      *
      */
     static setOinoSqlOrderParam(sqlOrderParam) {
@@ -76,9 +76,9 @@ class OINODbConfig {
         }
     }
     /**
-     * Set the name of the OINODbSqlLimit-param field
+     * Set the name of the OINODbQueryLimit-param field
      *
-     * @param sqlLimitParam name of the http parameter with `OINODbSqlLimit` definition
+     * @param sqlLimitParam name of the http parameter with `OINODbQueryLimit` definition
      *
      */
     static setOinoSqlLimitParam(sqlLimitParam) {

package/dist/cjs/OINODbConstants.js

@@ -0,0 +1,10 @@
+"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.OINODB_UNDEFINED = void 0;
+/** Constant for undefined values */
+exports.OINODB_UNDEFINED = ""; // original idea was to have a defined literal that get's swapped back to undefined, but current implementation just leaves it out at serialization (so value does not matter)

package/dist/cjs/OINODbDataField.js

@@ -13,8 +13,8 @@ const common_1 = require("@oino-ts/common");
  *
  */
 class OINODbDataField {
-    /** OINODB reference*/
-    db;
+    /** OINO data source reference*/
+    datasource;
     /** Name of the field */
     name;
     /** Internal type of field*/
@@ -28,7 +28,7 @@ class OINODbDataField {
     /**
      * Constructor for a data field
      *
-     * @param db OINODb reference
+     * @param datasource OINO data source reference
      * @param name name of the field
      * @param type internal type of the field
      * @param sqlType column type in database
@@ -36,56 +36,14 @@ class OINODbDataField {
      * @param maxLength maximum length of the field (or 0)
      *
      */
-    constructor(db, name, type, sqlType, fieldParams, maxLength = 0) {
-        this.db = db;
+    constructor(datasource, name, type, sqlType, fieldParams, maxLength = 0) {
+        this.datasource = datasource;
         this.name = name;
         this.type = type;
         this.maxLength = maxLength;
         this.sqlType = sqlType;
         this.fieldParams = fieldParams;
     }
-    /**
-     * Pring debug information for the field
-     *
-     * @param length length of the debug output (or 0 for as long as needed)
-     *
-     */
-    printColumnDebug(length = 0) {
-        let params = "";
-        if (this.fieldParams.isPrimaryKey) {
-            params += "PK ";
-        }
-        if (this.fieldParams.isForeignKey) {
-            params += "FK ";
-        }
-        if (this.fieldParams.isAutoInc) {
-            params += "AUTOINC ";
-        }
-        if (this.fieldParams.isNotNull) {
-            params += "NOTNUL ";
-        }
-        if (params != "") {
-            params = "{" + params.trim() + "}";
-        }
-        if (this.maxLength > 0) {
-            params = this.sqlType + "(" + this.maxLength + ")" + params;
-        }
-        else {
-            params = this.sqlType + params;
-        }
-        const name_length = length - 2 - 1 - params.length;
-        let result = this.name;
-        if (length > 0) {
-            if (result.length > name_length) {
-                result = result.substring(0, name_length - 2) + "..";
-            }
-            result = (result + ":" + params).padEnd(length - 2, " ");
-        }
-        else {
-            result = this.type + ":" + result + ":" + params;
-        }
-        return "[" + result + "]";
-    }
     /**
      * Serialize cell value in the given content format.
      *
@@ -93,7 +51,7 @@ class OINODbDataField {
      *
      */
     serializeCell(cellVal) {
-        cellVal = this.db.parseSqlValueAsCell(cellVal, this.sqlType);
+        cellVal = this.datasource.parseValueAsCell(cellVal, this.sqlType);
         if ((cellVal === null) || (cellVal === undefined)) {
             return cellVal; // let content type encoder worry what to do with the value (so not force it to string)
         }
@@ -116,15 +74,15 @@ class OINODbDataField {
      * @param cellVal cell value
      *
      */
-    printCellAsSqlValue(cellVal) {
-        return this.db.printCellAsSqlValue(cellVal, this.sqlType);
+    printCellAsValue(cellVal) {
+        return this.datasource.printCellAsValue(cellVal, this.sqlType);
     }
     /**
      * Print name of column as SQL.
      *
      */
-    printSqlColumnName() {
-        return this.db.printSqlColumnname(this.name);
+    printColumnName() {
+        return this.datasource.printColumnName(this.name);
     }
 }
 exports.OINODbDataField = OINODbDataField;
@@ -143,8 +101,8 @@ class OINOStringDataField extends OINODbDataField {
      * @param maxLength maximum length of the field (or 0)
      *
      */
-    constructor(db, name, sqlType, fieldParams, maxLength) {
-        super(db, name, "string", sqlType, fieldParams, maxLength);
+    constructor(datasource, name, sqlType, fieldParams, maxLength) {
+        super(datasource, name, "string", sqlType, fieldParams, maxLength);
     }
 }
 exports.OINOStringDataField = OINOStringDataField;
@@ -156,14 +114,14 @@ class OINOBooleanDataField extends OINODbDataField {
     /**
      * Constructor for a boolean data field
      *
-     * @param db OINODb reference
+     * @param datasource OINODb reference
      * @param name name of the field
      * @param sqlType column type in database
      * @param fieldParams parameters of the field
      *
      */
-    constructor(db, name, sqlType, fieldParams) {
-        super(db, name, "boolean", sqlType, fieldParams);
+    constructor(datasource, name, sqlType, fieldParams) {
+        super(datasource, name, "boolean", sqlType, fieldParams);
     }
     /**
      * Serialize cell value in the given content format.
@@ -172,7 +130,7 @@ class OINOBooleanDataField extends OINODbDataField {
      *
      */
     serializeCell(cellVal) {
-        const parsed_value = (this.db.parseSqlValueAsCell(cellVal, this.sqlType) || "").toString();
+        const parsed_value = (this.datasource.parseValueAsCell(cellVal, this.sqlType) || "").toString();
         let result;
         // console.log("OINOBooleanDataField.serializeCell: parsed_value=" + parsed_value)
         if ((parsed_value == "") || (parsed_value.toLowerCase() == "false") || (parsed_value.match(/^0+$/))) {
@@ -207,14 +165,14 @@ class OINONumberDataField extends OINODbDataField {
     /**
      * Constructor for a string data field
      *
-     * @param db OINODb reference
+     * @param datasource OINODb reference
      * @param name name of the field
      * @param sqlType column type in database
      * @param fieldParams parameters of the field
      *
      */
-    constructor(db, name, sqlType, fieldParams) {
-        super(db, name, "number", sqlType, fieldParams);
+    constructor(datasource, name, sqlType, fieldParams) {
+        super(datasource, name, "number", sqlType, fieldParams);
     }
     /**
      * Serialize cell value in the given content format.
@@ -264,15 +222,15 @@ class OINOBlobDataField extends OINODbDataField {
     /**
      * Constructor for a blob data field
      *
-     * @param db OINODb reference
+     * @param datasource OINODb reference
      * @param name name of the field
      * @param sqlType column type in database
      * @param fieldParams parameters of the field
      * @param maxLength maximum length of the field (or 0)
      *
      */
-    constructor(db, name, sqlType, fieldParams, maxLength) {
-        super(db, name, "blob", sqlType, fieldParams, maxLength);
+    constructor(datasource, name, sqlType, fieldParams, maxLength) {
+        super(datasource, name, "blob", sqlType, fieldParams, maxLength);
     }
     /**
      * Serialize cell value in the given content format.
@@ -292,7 +250,7 @@ class OINOBlobDataField extends OINODbDataField {
             return buffer_1.Buffer.from(cellVal).toString('base64');
         }
         else {
-            return this.db.parseSqlValueAsCell(cellVal, this.sqlType)?.toString();
+            return this.datasource.parseValueAsCell(cellVal, this.sqlType)?.toString();
         }
     }
     /**
@@ -319,14 +277,14 @@ class OINODatetimeDataField extends OINODbDataField {
     /**
      * Constructor for a string data field
      *
-     * @param db OINODb reference
+     * @param datasource OINODb reference
      * @param name name of the field
      * @param sqlType column type in database
      * @param fieldParams parameters of the field
      *
      */
-    constructor(db, name, sqlType, fieldParams) {
-        super(db, name, "datetime", sqlType, fieldParams);
+    constructor(datasource, name, sqlType, fieldParams) {
+        super(datasource, name, "datetime", sqlType, fieldParams);
     }
     /**
      * Serialize cell value in the given content format.
@@ -336,7 +294,7 @@ class OINODatetimeDataField extends OINODbDataField {
      */
     serializeCell(cellVal) {
         if (typeof (cellVal) == "string") {
-            cellVal = this.db.parseSqlValueAsCell(cellVal, this.sqlType);
+            cellVal = this.datasource.parseValueAsCell(cellVal, this.sqlType);
         }
         if ((cellVal === null) || (cellVal === undefined)) {
             return cellVal;
@@ -357,7 +315,7 @@ class OINODatetimeDataField extends OINODbDataField {
      */
     serializeCellWithLocale(cellVal, locale) {
         if (typeof (cellVal) == "string") {
-            cellVal = this.db.parseSqlValueAsCell(cellVal, this.sqlType);
+            cellVal = this.datasource.parseValueAsCell(cellVal, this.sqlType);
         }
         if ((cellVal === null) || (cellVal === undefined)) {
             return cellVal;

package/dist/cjs/OINODbDataModel.js

@@ -7,15 +7,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OINODbDataModel = void 0;
 const common_1 = require("@oino-ts/common");
-const index_js_1 = require("./index.js");
+const OINODbConstants_js_1 = require("./OINODbConstants.js");
+const OINODbQueryParams_js_1 = require("./OINODbQueryParams.js");
 /**
  * OINO Datamodel object for representing one database table and it's columns.
  *
  */
-class OINODbDataModel {
-    _fieldIndexLookup;
+class OINODbDataModel extends common_1.OINODataModel {
     /** Database refererence of the table */
-    api;
+    dbApi;
     /** Field refererences of the API */
     fields;
     /**
@@ -26,26 +26,19 @@ class OINODbDataModel {
      *
      */
     constructor(api) {
-        this._fieldIndexLookup = {};
-        this.api = api;
+        super(api);
+        this.dbApi = api;
         this.fields = [];
     }
-    /**
-     * Initialize datamodel from SQL schema.
-     *
-     */
-    async initialize() {
-        await this.api.db.initializeApiDatamodel(this.api);
-    }
-    _printSqlColumnNames(select) {
+    _printColumnNames(select) {
         let result = "";
         for (let i = 0; i < this.fields.length; i++) {
             const f = this.fields[i];
-            if (select?.isSelected(f) === false) { // if a field is not selected, we include a constant and correct fieldname instead so that dimensions of the data don't change but no unnecessary data is fetched
-                result += f.db.printSqlString(index_js_1.OINODB_UNDEFINED) + " as " + f.printSqlColumnName() + ",";
+            if ((select?.isSelected(f.name) === false) && (f.fieldParams.isPrimaryKey == false)) { // if a field is not selected, we include a constant and correct fieldname instead so that dimensions of the data don't change but no unnecessary data is fetched
+                result += f.datasource.printStringValue(OINODbConstants_js_1.OINODB_UNDEFINED) + " as " + f.printColumnName() + ",";
             }
             else {
-                result += f.printSqlColumnName() + ",";
+                result += f.printColumnName() + ",";
             }
         }
         return result.substring(0, result.length - 1);
@@ -62,8 +55,8 @@ class OINODbDataModel {
                     columns += ",";
                     values += ",";
                 }
-                columns += f.printSqlColumnName();
-                values += f.printCellAsSqlValue(val);
+                columns += f.printColumnName();
+                values += f.printCellAsValue(val);
             }
         }
         // console.log("_printSqlInsertColumnsAndValues: columns=" + columns + ", values=" + values)
@@ -78,7 +71,7 @@ class OINODbDataModel {
                 if (result != "") {
                     result += ",";
                 }
-                result += f.printSqlColumnName() + "=" + f.printCellAsSqlValue(val);
+                result += f.printColumnName() + "=" + f.printCellAsValue(val);
             }
         }
         if (result == "") {
@@ -89,21 +82,21 @@ class OINODbDataModel {
     _printSqlPrimaryKeyCondition(id_value) {
         let result = "";
         let i = 0;
-        const id_parts = id_value.split(index_js_1.OINODbConfig.OINODB_ID_SEPARATOR);
+        const id_parts = id_value.split(common_1.OINOConfig.OINO_ID_SEPARATOR);
         for (let f of this.fields) {
             if (f.fieldParams.isPrimaryKey) {
                 if (result != "") {
                     result += " AND ";
                 }
                 let value = decodeURIComponent(id_parts[i]);
-                if ((f instanceof index_js_1.OINONumberDataField) && (this.api.hashid)) {
+                if ((f instanceof common_1.OINONumberDataField) && (this.api.hashid)) {
                     value = this.api.hashid.decode(value);
                 }
-                value = f.printCellAsSqlValue(value);
+                value = f.printCellAsValue(value);
                 if (value == "") { // ids are user input and could be specially crafted to be empty
                     throw new Error(common_1.OINO_ERROR_PREFIX + ": empty condition for id '" + id_value + "' for table " + this.api.params.tableName);
                 }
-                result += f.printSqlColumnName() + "=" + value;
+                result += f.printColumnName() + "=" + value;
                 i = i + 1;
             }
         }
@@ -116,118 +109,11 @@ class OINODbDataModel {
         let result = [];
         for (let f of this.fields) {
             if (f.fieldParams.isPrimaryKey) {
-                result.push(this.api.db.printSqlColumnname(f.name));
+                result.push(this.dbApi.db.printColumnName(f.name));
             }
         }
         return result;
     }
-    /**
-     * Add a field to the datamodel.
-     *
-     * @param field dataset field
-     *
-     */
-    addField(field) {
-        this.fields.push(field);
-        this._fieldIndexLookup[field.name] = this.fields.length - 1;
-    }
-    /**
-     * Find a field of a given name if any.
-     *
-     * @param name name of the field to find
-     *
-     */
-    findFieldByName(name) {
-        const i = this._fieldIndexLookup[name];
-        if (i >= 0) {
-            return this.fields[i];
-        }
-        else {
-            return null;
-        }
-    }
-    /**
-     * Find index of a field of a given name if any.
-     *
-     * @param name name of the field to find
-     *
-     */
-    findFieldIndexByName(name) {
-        const i = this._fieldIndexLookup[name];
-        if (i >= 0) {
-            return i;
-        }
-        else {
-            return -1;
-        }
-    }
-    /**
-     * Find all fields based of given filter callback criteria (e.g. fields of certain data type, primary keys etc.)
-     *
-     * @param filter callback called for each field to include or not
-     *
-     */
-    filterFields(filter) {
-        let result = [];
-        for (let f of this.fields) {
-            if (filter(f)) {
-                result.push(f);
-            }
-        }
-        return result;
-    }
-    /**
-     * Return the primary key values of one row in order of the data model
-     *
-     * @param row data row
-     * @param hashidValues apply hashid when applicable
-     *
-     */
-    getRowPrimarykeyValues(row, hashidValues = false) {
-        let values = [];
-        for (let i = 0; i < this.fields.length; i++) {
-            const f = this.fields[i];
-            if (f.fieldParams.isPrimaryKey) {
-                const value = row[i]?.toString() || "";
-                if (hashidValues && value && (f instanceof index_js_1.OINONumberDataField) && this.api.hashid) {
-                    values.push(this.api.hashid.encode(value));
-                }
-                else {
-                    values.push(value);
-                }
-            }
-        }
-        return values;
-    }
-    /**
-     * Print debug information about the fields.
-     *
-     * @param separator string to separate field prints
-     *
-     */
-    printDebug(separator = "") {
-        let result = this.api.params.tableName + ":" + separator;
-        for (let f of this.fields) {
-            result += f.printColumnDebug() + separator;
-        }
-        return result;
-    }
-    /**
-     * Print all public properties (db, table name, fields) of the datamodel. Used
-     * in automated testing validate schema has stayed the same.
-     *
-     */
-    printFieldPublicPropertiesJson() {
-        const result = JSON.stringify(this.fields, (key, value) => {
-            if (key.startsWith("_")) {
-                return undefined;
-            }
-            else {
-                return value;
-            }
-        });
-        return result;
-    }
     /**
      * Print SQL select statement using optional id and filter.
      *
@@ -238,15 +124,15 @@ class OINODbDataModel {
     printSqlSelect(id, params) {
         let column_names = "";
         if (params.aggregate) {
-            column_names = params.aggregate.printSqlColumnNames(this, params.select);
+            column_names = OINODbQueryParams_js_1.OINODbQueryAggregate.printColumnNames(params.aggregate, this, params.select);
         }
         else {
-            column_names = this._printSqlColumnNames(params.select);
+            column_names = this._printColumnNames(params.select);
         }
-        const order_sql = params.order?.toSql(this) || "";
-        const limit_sql = params.limit?.toSql(this) || "";
-        const filter_sql = params.filter?.toSql(this) || "";
-        const groupby_sql = params.aggregate?.toSql(this, params.select) || "";
+        const order_sql = params.order ? OINODbQueryParams_js_1.OINODbQueryOrder.printSql(params.order, this) : "";
+        const limit_sql = params.limit ? OINODbQueryParams_js_1.OINODbQueryLimit.printSql(params.limit, this) : "";
+        const filter_sql = params.filter ? OINODbQueryParams_js_1.OINODbQueryFilter.printSql(params.filter, this) : "";
+        const groupby_sql = params.aggregate ? OINODbQueryParams_js_1.OINODbQueryAggregate.printSql(params.aggregate, this, params.select) : "";
         let where_sql = "";
         if ((id != null) && (id != "") && (filter_sql != "")) {
             where_sql = this._printSqlPrimaryKeyCondition(id) + " AND " + filter_sql;
@@ -257,7 +143,7 @@ class OINODbDataModel {
         else if (filter_sql != "") {
             where_sql = filter_sql;
         }
-        const result = this.api.db.printSqlSelect(this.api.params.tableName, column_names, where_sql, order_sql, limit_sql, groupby_sql);
+        const result = this.dbApi.db.printSqlSelect(this.api.params.tableName, column_names, where_sql, order_sql, limit_sql, groupby_sql);
         return result;
     }
     /**
@@ -267,10 +153,10 @@ class OINODbDataModel {
      *
      */
     printSqlInsert(row) {
-        const table_name = this.api.db.printSqlTablename(this.api.params.tableName);
+        const table_name = this.dbApi.db.printTableName(this.api.params.tableName);
         const [columns, values] = this._printSqlInsertColumnsAndValues(row);
         const return_fields = this.api.params.returnInsertedIds ? this._printSqlPrimaryKeyColumns() : undefined;
-        return this.api.db.printSqlInsert(table_name, columns, values, return_fields);
+        return this.dbApi.db.printSqlInsert(table_name, columns, values, return_fields);
     }
     /**
      * Print SQL insert statement from one data row.
@@ -280,7 +166,7 @@ class OINODbDataModel {
      *
      */
     printSqlUpdate(id, row) {
-        let result = "UPDATE " + this.api.db.printSqlTablename(this.api.params.tableName) + " SET " + this._printSqlUpdateValues(row) + " WHERE " + this._printSqlPrimaryKeyCondition(id) + ";";
+        let result = "UPDATE " + this.dbApi.db.printTableName(this.api.params.tableName) + " SET " + this._printSqlUpdateValues(row) + " WHERE " + this._printSqlPrimaryKeyCondition(id) + ";";
         return result;
     }
     /**
@@ -290,7 +176,7 @@ class OINODbDataModel {
      *
      */
     printSqlDelete(id) {
-        let result = "DELETE FROM " + this.api.db.printSqlTablename(this.api.params.tableName) + " WHERE " + this._printSqlPrimaryKeyCondition(id) + ";";
+        let result = "DELETE FROM " + this.dbApi.db.printTableName(this.api.params.tableName) + " WHERE " + this._printSqlPrimaryKeyCondition(id) + ";";
         return result;
     }
 }

package/dist/cjs/OINODbFactory.js

@@ -6,7 +6,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OINODbFactory = void 0;
-const index_js_1 = require("./index.js");
+const OINODbApi_js_1 = require("./OINODbApi.js");
 /**
  * Static factory class for easily creating things based on data
  *
@@ -60,7 +60,7 @@ class OINODbFactory {
      * @param params parameters of the API
      */
     static async createApi(db, params) {
-        let result = new index_js_1.OINODbApi(db, params);
+        let result = new OINODbApi_js_1.OINODbApi(db, params);
         await db.initializeApiDatamodel(result);
         return result;
     }