@oino-ts/db 0.2.0 → 0.3.0

package/dist/cjs/OINODb.js

@@ -32,9 +32,10 @@ class OINODb {
      * @param whereCondition - The WHERE clause to filter the results.
      * @param orderCondition - The ORDER BY clause to sort the results.
      * @param limitCondition - The LIMIT clause to limit the number of results.
+     * @param groupByCondition - The GROUP BY clause to group the results.
      *
      */
-    printSqlSelect(tableName, columnNames, whereCondition, orderCondition, limitCondition) {
+    printSqlSelect(tableName, columnNames, whereCondition, orderCondition, limitCondition, groupByCondition) {
         let result = "SELECT " + columnNames + " FROM " + tableName;
         // OINOLog.debug("OINODb.printSqlSelect", {tableName:tableName, columnNames:columnNames, whereCondition:whereCondition, orderCondition:orderCondition, limitCondition:limitCondition })
         if (whereCondition != "") {
@@ -46,6 +47,9 @@ class OINODb {
         if (limitCondition != "") {
             result += " LIMIT " + limitCondition;
         }
+        if (groupByCondition != "") {
+            result += " GROUP BY " + groupByCondition;
+        }
         result += ";";
         // OINOLog.debug("OINODb.printSqlSelect", {result:result})
         return result;

package/dist/cjs/OINODbApi.js

@@ -358,5 +358,18 @@ class OINODbApi {
         index_js_1.OINOBenchmark.end("OINODbApi", "doRequest", method);
         return Promise.resolve(result);
     }
+    /**
+     * Method to check if a field is included in the API params.
+     *
+     * @param fieldName name of the field
+     *
+     */
+    isFieldIncluded(fieldName) {
+        // OINOLog.debug("OINODbApi.isFieldIncluded", {fieldName:fieldName, included:this.params.includeFields})
+        const params = this.params;
+        return (((params.excludeFieldPrefix == undefined) || (params.excludeFieldPrefix == "") || fieldName.startsWith(params.excludeFieldPrefix)) &&
+            ((params.excludeFields == undefined) || (params.excludeFields.length == 0) || (params.excludeFields.indexOf(fieldName) < 0)) &&
+            ((params.includeFields == undefined) || (params.includeFields.length == 0) || (params.includeFields.indexOf(fieldName) >= 0)));
+    }
 }
 exports.OINODbApi = OINODbApi;

package/dist/cjs/OINODbConfig.js

@@ -14,6 +14,8 @@ class OINODbConfig {
     static OINODB_SQL_ORDER_PARAM = "oinosqlorder";
     /** Name of the OINODbSqlLimit-parameter in request */
     static OINODB_SQL_LIMIT_PARAM = "oinosqllimit";
+    /** Name of the OINODbSqlAggregate-parameter in request */
+    static OINODB_SQL_AGGREGATE_PARAM = "oinosqlaggregate";
     /**
      * Set the name of the OINO ID field
      * @param idField name of the OINO ID field

package/dist/cjs/OINODbDataField.js

@@ -248,7 +248,7 @@ class OINONumberDataField extends OINODbDataField {
         else {
             const result = parseFloat(value);
             if (isNaN(result)) {
-                index_js_1.OINOLog.error("OINODbSqlFilter.toSql: Invalid value!", { value: value });
+                index_js_1.OINOLog.error("OINONumberDataField.toSql: Invalid value!", { value: value });
                 throw new Error(index_js_1.OINO_ERROR_PREFIX + ": OINONumberDataField.deserializeCell - Invalid value '" + value + "'"); // incorrectly formatted data could be a security risk, abort processing
             }
             return result;

package/dist/cjs/OINODbDataModel.js

@@ -39,13 +39,10 @@ class OINODbDataModel {
     }
     _printSqlColumnNames() {
         let result = "";
-        for (let f of this.fields) {
-            if (result != "") {
-                result += ",";
-            }
-            result += f.printSqlColumnName();
+        for (let i = 0; i < this.fields.length; i++) {
+            result += this.fields[i].printSqlColumnName() + ",";
         }
-        return result;
+        return result.substring(0, result.length - 1);
     }
     _printSqlInsertColumnsAndValues(row) {
         let columns = "";
@@ -220,10 +217,17 @@ class OINODbDataModel {
      *
      */
     printSqlSelect(id, params) {
-        const column_names = this._printSqlColumnNames();
+        let column_names = "";
+        if (params.aggregate) {
+            column_names = params.aggregate.printSqlColumnNames(this);
+        }
+        else {
+            column_names = this._printSqlColumnNames();
+        }
         const order_sql = params.order?.toSql(this) || "";
         const limit_sql = params.limit?.toSql(this) || "";
         const filter_sql = params.filter?.toSql(this) || "";
+        const aggregate_sql = params.aggregate?.toSql(this) || "";
         let where_sql = "";
         // OINOLog.debug("OINODbDataModel.printSqlSelect", {id:id, select_sql:result, filter_sql:filter_sql, order_sql:order_sql})
         if ((id != null) && (id != "") && (filter_sql != "")) {
@@ -235,7 +239,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);
+        const result = this.api.db.printSqlSelect(this.api.params.tableName, column_names, where_sql, order_sql, limit_sql, aggregate_sql);
         // OINOLog.debug("OINODbDataModel.printSqlSelect", {result:result})
         return result;
     }

package/dist/cjs/OINODbFactory.js

@@ -7,6 +7,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OINODbFactory = void 0;
 const index_js_1 = require("./index.js");
+const OINODbSqlParams_js_1 = require("./OINODbSqlParams.js");
 /**
  * Static factory class for easily creating things based on data
  *
@@ -72,6 +73,10 @@ class OINODbFactory {
         if (limit) {
             sql_params.limit = index_js_1.OINODbSqlLimit.parse(limit);
         }
+        const aggregate = url.searchParams.get(index_js_1.OINODbConfig.OINODB_SQL_AGGREGATE_PARAM);
+        if (aggregate) {
+            sql_params.aggregate = OINODbSqlParams_js_1.OINODbSqlAggregate.parse(aggregate);
+        }
         let result = { sqlParams: sql_params };
         const content_type = request.headers.get("content-type");
         if (content_type == index_js_1.OINOContentType.csv) {

package/dist/cjs/OINODbSqlParams.js

@@ -5,8 +5,9 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OINODbSqlLimit = exports.OINODbSqlOrder = exports.OINODbSqlFilter = exports.OINODbSqlComparison = exports.OINODbSqlBooleanOperation = void 0;
+exports.OINODbSqlAggregate = exports.OINODbSqlAggregateFunctions = exports.OINODbSqlLimit = exports.OINODbSqlOrder = exports.OINODbSqlFilter = exports.OINODbSqlComparison = exports.OINODbSqlBooleanOperation = void 0;
 const index_js_1 = require("./index.js");
+const OINO_FIELD_NAME_CHARS = "\\w\\s\\-\\_\\#\\¤";
 /**
  * Supported logical conjunctions in filter predicates.
  * @enum
@@ -65,13 +66,13 @@ class OINODbSqlFilter {
         this._rightSide = rightSide;
     }
     /**
-     * Constructor for `OINOFilter` as parser of http parameter.
+     * Constructor for `OINODbSqlFilter` as parser of http parameter.
      *
      * @param filterString string representation of filter from HTTP-request
      *
      */
     static parse(filterString) {
-        // OINOLog_debug("OINOFilter.constructor", {filterString:filterString})
+        // OINOLog_debug("OINODbSqlFilter.constructor", {filterString:filterString})
         if (!filterString) {
             return new OINODbSqlFilter("", null, "");
         }
@@ -87,7 +88,7 @@ class OINODbSqlFilter {
                 }
                 else {
                     let boolean_parts = index_js_1.OINOStr.splitByBrackets(filterString, true, false, '(', ')');
-                    // OINOLog_debug("OINOFilter.constructor", {boolean_parts:boolean_parts})
+                    // OINOLog_debug("OINODbSqlFilter.constructor", {boolean_parts:boolean_parts})
                     if (boolean_parts.length == 3 && (boolean_parts[1].match(OINODbSqlFilter._booleanOperationRegex))) {
                         return new OINODbSqlFilter(OINODbSqlFilter.parse(boolean_parts[0]), boolean_parts[1].trim().toLowerCase().substring(1), OINODbSqlFilter.parse(boolean_parts[2]));
                     }
@@ -99,7 +100,7 @@ class OINODbSqlFilter {
         }
     }
     /**
-     * Construct a new `OINOFilter` as combination of (boolean and/or) of two filters.
+     * Construct a new `OINODbSqlFilter` as combination of (boolean and/or) of two filters.
      *
      * @param leftSide left side to combine
      * @param operation boolean operation to use in combination
@@ -148,7 +149,7 @@ class OINODbSqlFilter {
      *
      */
     toSql(dataModel) {
-        // OINOLog.debug("OINOFilter.toSql", {_leftSide:this._leftSide, _operator:this._operator, _rightSide:this._rightSide})
+        // OINOLog.debug("OINODbSqlFilter.toSql", {_leftSide:this._leftSide, _operator:this._operator, _rightSide:this._rightSide})
         if (this.isEmpty()) {
             return "";
         }
@@ -177,7 +178,7 @@ class OINODbSqlFilter {
             }
             result += field.printCellAsSqlValue(value);
         }
-        // OINOLog.debug("OINOFilter.toSql", {result:result})
+        // OINOLog.debug("OINODbSqlFilter.toSql", {result:result})
         return "(" + result + ")";
     }
 }
@@ -187,7 +188,7 @@ exports.OINODbSqlFilter = OINODbSqlFilter;
  *
  */
 class OINODbSqlOrder {
-    static _orderColumnRegex = /^\s*(\w+)\s?(ASC|DESC)?\s*?$/i;
+    static _orderColumnRegex = /^\s*(\w+)\s?(ASC|DESC|\+|\-)?\s*?$/i;
     _columns;
     _descending;
     /**
@@ -226,7 +227,8 @@ class OINODbSqlOrder {
             let match = OINODbSqlOrder._orderColumnRegex.exec(column_strings[i]);
             if (match != null) {
                 columns.push(match[1]);
-                directions.push((match[2] || "DESC").toUpperCase() == "DESC");
+                const dir = (match[2] || "ASC").toUpperCase();
+                directions.push((dir == "DESC") || (dir == "-"));
             }
         }
         return new OINODbSqlOrder(columns, directions);
@@ -334,3 +336,102 @@ class OINODbSqlLimit {
     }
 }
 exports.OINODbSqlLimit = OINODbSqlLimit;
+/**
+ * Supported aggregation functions in OINODbSqlAggregate.
+ * @enum
+ */
+var OINODbSqlAggregateFunctions;
+(function (OINODbSqlAggregateFunctions) {
+    OINODbSqlAggregateFunctions["count"] = "count";
+    OINODbSqlAggregateFunctions["sum"] = "sum";
+    OINODbSqlAggregateFunctions["avg"] = "avg";
+    OINODbSqlAggregateFunctions["min"] = "min";
+    OINODbSqlAggregateFunctions["max"] = "max";
+})(OINODbSqlAggregateFunctions || (exports.OINODbSqlAggregateFunctions = OINODbSqlAggregateFunctions = {}));
+/**
+ * Class for limiting the number of results.
+ *
+ */
+class OINODbSqlAggregate {
+    static _aggregateRegex = new RegExp("^(count|sum|avg|min|max)\\(([" + OINO_FIELD_NAME_CHARS + "]+)\\)$", "mi");
+    _functions;
+    _fields;
+    /**
+     * Constructor for `OINODbSqlAggregate`.
+     *
+     * @param function aggregate function to use
+     * @param fields fields to aggregate
+     *
+     */
+    constructor(func, fields) {
+        this._functions = func;
+        this._fields = fields;
+    }
+    /**
+     * Constructor for `OINODbSqlAggregate` as parser of http parameter.
+     *
+     * @param aggregatorString string representation of limit from HTTP-request
+     *
+     */
+    static parse(aggregatorString) {
+        let funtions = [];
+        let fields = [];
+        const aggregator_parts = aggregatorString.split(',');
+        for (let i = 0; i < aggregator_parts.length; i++) {
+            let match = OINODbSqlAggregate._aggregateRegex.exec(aggregator_parts[i]);
+            // OINOLog.debug("OINODbSqlAggregate.parse - next aggregator", {aggregator: aggregator_parts[i], match:match})
+            if ((match != null) && (match.length == 3)) {
+                funtions.push(match[1]);
+                fields.push(match[2]);
+            }
+        }
+        return new OINODbSqlAggregate(funtions, fields);
+    }
+    /**
+     * Does filter contain any valid conditions.
+     *
+     */
+    isEmpty() {
+        return (this._functions.length <= 0);
+    }
+    /**
+     * Print non-aggregated fields as SQL GROUP BY-condition based on the datamodel of the API.
+     *
+     * @param dataModel data model (and database) to use for formatting of values
+     *
+     */
+    toSql(dataModel) {
+        if (this.isEmpty()) {
+            return "";
+        }
+        let result = "";
+        for (let i = 0; i < dataModel.fields.length; i++) {
+            if (this._fields.includes(dataModel.fields[i].name) == false) {
+                result += dataModel.fields[i].printSqlColumnName() + ",";
+            }
+        }
+        index_js_1.OINOLog.debug("OINODbSqlAggregate.toSql", { result: result });
+        return result.substring(0, result.length - 1);
+    }
+    /**
+     * Print non-aggregated fields as SQL GROUP BY-condition based on the datamodel of the API.
+     *
+     * @param dataModel data model (and database) to use for formatting of values
+     *
+     */
+    printSqlColumnNames(dataModel) {
+        let result = "";
+        for (let i = 0; i < dataModel.fields.length; i++) {
+            const aggregate_index = this._fields.indexOf(dataModel.fields[i].name);
+            if (aggregate_index >= 0) {
+                result += this._functions[aggregate_index] + "(" + dataModel.fields[i].printSqlColumnName() + "),";
+            }
+            else {
+                result += dataModel.fields[i].printSqlColumnName() + ",";
+            }
+        }
+        index_js_1.OINOLog.debug("OINODbSqlAggregate.printSqlColumnNames", { result: result });
+        return result.substring(0, result.length - 1);
+    }
+}
+exports.OINODbSqlAggregate = OINODbSqlAggregate;

package/dist/esm/OINODb.js

@@ -29,9 +29,10 @@ export class OINODb {
      * @param whereCondition - The WHERE clause to filter the results.
      * @param orderCondition - The ORDER BY clause to sort the results.
      * @param limitCondition - The LIMIT clause to limit the number of results.
+     * @param groupByCondition - The GROUP BY clause to group the results.
      *
      */
-    printSqlSelect(tableName, columnNames, whereCondition, orderCondition, limitCondition) {
+    printSqlSelect(tableName, columnNames, whereCondition, orderCondition, limitCondition, groupByCondition) {
         let result = "SELECT " + columnNames + " FROM " + tableName;
         // OINOLog.debug("OINODb.printSqlSelect", {tableName:tableName, columnNames:columnNames, whereCondition:whereCondition, orderCondition:orderCondition, limitCondition:limitCondition })
         if (whereCondition != "") {
@@ -43,6 +44,9 @@ export class OINODb {
         if (limitCondition != "") {
             result += " LIMIT " + limitCondition;
         }
+        if (groupByCondition != "") {
+            result += " GROUP BY " + groupByCondition;
+        }
         result += ";";
         // OINOLog.debug("OINODb.printSqlSelect", {result:result})
         return result;

package/dist/esm/OINODbApi.js

@@ -353,4 +353,17 @@ export class OINODbApi {
         OINOBenchmark.end("OINODbApi", "doRequest", method);
         return Promise.resolve(result);
     }
+    /**
+     * Method to check if a field is included in the API params.
+     *
+     * @param fieldName name of the field
+     *
+     */
+    isFieldIncluded(fieldName) {
+        // OINOLog.debug("OINODbApi.isFieldIncluded", {fieldName:fieldName, included:this.params.includeFields})
+        const params = this.params;
+        return (((params.excludeFieldPrefix == undefined) || (params.excludeFieldPrefix == "") || fieldName.startsWith(params.excludeFieldPrefix)) &&
+            ((params.excludeFields == undefined) || (params.excludeFields.length == 0) || (params.excludeFields.indexOf(fieldName) < 0)) &&
+            ((params.includeFields == undefined) || (params.includeFields.length == 0) || (params.includeFields.indexOf(fieldName) >= 0)));
+    }
 }

package/dist/esm/OINODbConfig.js

@@ -11,6 +11,8 @@ export class OINODbConfig {
     static OINODB_SQL_ORDER_PARAM = "oinosqlorder";
     /** Name of the OINODbSqlLimit-parameter in request */
     static OINODB_SQL_LIMIT_PARAM = "oinosqllimit";
+    /** Name of the OINODbSqlAggregate-parameter in request */
+    static OINODB_SQL_AGGREGATE_PARAM = "oinosqlaggregate";
     /**
      * Set the name of the OINO ID field
      * @param idField name of the OINO ID field

package/dist/esm/OINODbDataField.js

@@ -242,7 +242,7 @@ export class OINONumberDataField extends OINODbDataField {
         else {
             const result = parseFloat(value);
             if (isNaN(result)) {
-                OINOLog.error("OINODbSqlFilter.toSql: Invalid value!", { value: value });
+                OINOLog.error("OINONumberDataField.toSql: Invalid value!", { value: value });
                 throw new Error(OINO_ERROR_PREFIX + ": OINONumberDataField.deserializeCell - Invalid value '" + value + "'"); // incorrectly formatted data could be a security risk, abort processing
             }
             return result;

package/dist/esm/OINODbDataModel.js

@@ -36,13 +36,10 @@ export class OINODbDataModel {
     }
     _printSqlColumnNames() {
         let result = "";
-        for (let f of this.fields) {
-            if (result != "") {
-                result += ",";
-            }
-            result += f.printSqlColumnName();
+        for (let i = 0; i < this.fields.length; i++) {
+            result += this.fields[i].printSqlColumnName() + ",";
         }
-        return result;
+        return result.substring(0, result.length - 1);
     }
     _printSqlInsertColumnsAndValues(row) {
         let columns = "";
@@ -217,10 +214,17 @@ export class OINODbDataModel {
      *
      */
     printSqlSelect(id, params) {
-        const column_names = this._printSqlColumnNames();
+        let column_names = "";
+        if (params.aggregate) {
+            column_names = params.aggregate.printSqlColumnNames(this);
+        }
+        else {
+            column_names = this._printSqlColumnNames();
+        }
         const order_sql = params.order?.toSql(this) || "";
         const limit_sql = params.limit?.toSql(this) || "";
         const filter_sql = params.filter?.toSql(this) || "";
+        const aggregate_sql = params.aggregate?.toSql(this) || "";
         let where_sql = "";
         // OINOLog.debug("OINODbDataModel.printSqlSelect", {id:id, select_sql:result, filter_sql:filter_sql, order_sql:order_sql})
         if ((id != null) && (id != "") && (filter_sql != "")) {
@@ -232,7 +236,7 @@ export 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);
+        const result = this.api.db.printSqlSelect(this.api.params.tableName, column_names, where_sql, order_sql, limit_sql, aggregate_sql);
         // OINOLog.debug("OINODbDataModel.printSqlSelect", {result:result})
         return result;
     }

package/dist/esm/OINODbFactory.js

@@ -4,6 +4,7 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 import { OINODbApi, OINOContentType, OINODbSqlFilter, OINODbConfig, OINODbSqlOrder, OINODbSqlLimit } from "./index.js";
+import { OINODbSqlAggregate } from "./OINODbSqlParams.js";
 /**
  * Static factory class for easily creating things based on data
  *
@@ -69,6 +70,10 @@ export class OINODbFactory {
         if (limit) {
             sql_params.limit = OINODbSqlLimit.parse(limit);
         }
+        const aggregate = url.searchParams.get(OINODbConfig.OINODB_SQL_AGGREGATE_PARAM);
+        if (aggregate) {
+            sql_params.aggregate = OINODbSqlAggregate.parse(aggregate);
+        }
         let result = { sqlParams: sql_params };
         const content_type = request.headers.get("content-type");
         if (content_type == OINOContentType.csv) {

package/dist/esm/OINODbSqlParams.js

@@ -4,6 +4,7 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 import { OINOStr, OINO_ERROR_PREFIX, OINOLog } from "./index.js";
+const OINO_FIELD_NAME_CHARS = "\\w\\s\\-\\_\\#\\¤";
 /**
  * Supported logical conjunctions in filter predicates.
  * @enum
@@ -62,13 +63,13 @@ export class OINODbSqlFilter {
         this._rightSide = rightSide;
     }
     /**
-     * Constructor for `OINOFilter` as parser of http parameter.
+     * Constructor for `OINODbSqlFilter` as parser of http parameter.
      *
      * @param filterString string representation of filter from HTTP-request
      *
      */
     static parse(filterString) {
-        // OINOLog_debug("OINOFilter.constructor", {filterString:filterString})
+        // OINOLog_debug("OINODbSqlFilter.constructor", {filterString:filterString})
         if (!filterString) {
             return new OINODbSqlFilter("", null, "");
         }
@@ -84,7 +85,7 @@ export class OINODbSqlFilter {
                 }
                 else {
                     let boolean_parts = OINOStr.splitByBrackets(filterString, true, false, '(', ')');
-                    // OINOLog_debug("OINOFilter.constructor", {boolean_parts:boolean_parts})
+                    // OINOLog_debug("OINODbSqlFilter.constructor", {boolean_parts:boolean_parts})
                     if (boolean_parts.length == 3 && (boolean_parts[1].match(OINODbSqlFilter._booleanOperationRegex))) {
                         return new OINODbSqlFilter(OINODbSqlFilter.parse(boolean_parts[0]), boolean_parts[1].trim().toLowerCase().substring(1), OINODbSqlFilter.parse(boolean_parts[2]));
                     }
@@ -96,7 +97,7 @@ export class OINODbSqlFilter {
         }
     }
     /**
-     * Construct a new `OINOFilter` as combination of (boolean and/or) of two filters.
+     * Construct a new `OINODbSqlFilter` as combination of (boolean and/or) of two filters.
      *
      * @param leftSide left side to combine
      * @param operation boolean operation to use in combination
@@ -145,7 +146,7 @@ export class OINODbSqlFilter {
      *
      */
     toSql(dataModel) {
-        // OINOLog.debug("OINOFilter.toSql", {_leftSide:this._leftSide, _operator:this._operator, _rightSide:this._rightSide})
+        // OINOLog.debug("OINODbSqlFilter.toSql", {_leftSide:this._leftSide, _operator:this._operator, _rightSide:this._rightSide})
         if (this.isEmpty()) {
             return "";
         }
@@ -174,7 +175,7 @@ export class OINODbSqlFilter {
             }
             result += field.printCellAsSqlValue(value);
         }
-        // OINOLog.debug("OINOFilter.toSql", {result:result})
+        // OINOLog.debug("OINODbSqlFilter.toSql", {result:result})
         return "(" + result + ")";
     }
 }
@@ -183,7 +184,7 @@ export class OINODbSqlFilter {
  *
  */
 export class OINODbSqlOrder {
-    static _orderColumnRegex = /^\s*(\w+)\s?(ASC|DESC)?\s*?$/i;
+    static _orderColumnRegex = /^\s*(\w+)\s?(ASC|DESC|\+|\-)?\s*?$/i;
     _columns;
     _descending;
     /**
@@ -222,7 +223,8 @@ export class OINODbSqlOrder {
             let match = OINODbSqlOrder._orderColumnRegex.exec(column_strings[i]);
             if (match != null) {
                 columns.push(match[1]);
-                directions.push((match[2] || "DESC").toUpperCase() == "DESC");
+                const dir = (match[2] || "ASC").toUpperCase();
+                directions.push((dir == "DESC") || (dir == "-"));
             }
         }
         return new OINODbSqlOrder(columns, directions);
@@ -328,3 +330,101 @@ export class OINODbSqlLimit {
         return result;
     }
 }
+/**
+ * Supported aggregation functions in OINODbSqlAggregate.
+ * @enum
+ */
+export var OINODbSqlAggregateFunctions;
+(function (OINODbSqlAggregateFunctions) {
+    OINODbSqlAggregateFunctions["count"] = "count";
+    OINODbSqlAggregateFunctions["sum"] = "sum";
+    OINODbSqlAggregateFunctions["avg"] = "avg";
+    OINODbSqlAggregateFunctions["min"] = "min";
+    OINODbSqlAggregateFunctions["max"] = "max";
+})(OINODbSqlAggregateFunctions || (OINODbSqlAggregateFunctions = {}));
+/**
+ * Class for limiting the number of results.
+ *
+ */
+export class OINODbSqlAggregate {
+    static _aggregateRegex = new RegExp("^(count|sum|avg|min|max)\\(([" + OINO_FIELD_NAME_CHARS + "]+)\\)$", "mi");
+    _functions;
+    _fields;
+    /**
+     * Constructor for `OINODbSqlAggregate`.
+     *
+     * @param function aggregate function to use
+     * @param fields fields to aggregate
+     *
+     */
+    constructor(func, fields) {
+        this._functions = func;
+        this._fields = fields;
+    }
+    /**
+     * Constructor for `OINODbSqlAggregate` as parser of http parameter.
+     *
+     * @param aggregatorString string representation of limit from HTTP-request
+     *
+     */
+    static parse(aggregatorString) {
+        let funtions = [];
+        let fields = [];
+        const aggregator_parts = aggregatorString.split(',');
+        for (let i = 0; i < aggregator_parts.length; i++) {
+            let match = OINODbSqlAggregate._aggregateRegex.exec(aggregator_parts[i]);
+            // OINOLog.debug("OINODbSqlAggregate.parse - next aggregator", {aggregator: aggregator_parts[i], match:match})
+            if ((match != null) && (match.length == 3)) {
+                funtions.push(match[1]);
+                fields.push(match[2]);
+            }
+        }
+        return new OINODbSqlAggregate(funtions, fields);
+    }
+    /**
+     * Does filter contain any valid conditions.
+     *
+     */
+    isEmpty() {
+        return (this._functions.length <= 0);
+    }
+    /**
+     * Print non-aggregated fields as SQL GROUP BY-condition based on the datamodel of the API.
+     *
+     * @param dataModel data model (and database) to use for formatting of values
+     *
+     */
+    toSql(dataModel) {
+        if (this.isEmpty()) {
+            return "";
+        }
+        let result = "";
+        for (let i = 0; i < dataModel.fields.length; i++) {
+            if (this._fields.includes(dataModel.fields[i].name) == false) {
+                result += dataModel.fields[i].printSqlColumnName() + ",";
+            }
+        }
+        OINOLog.debug("OINODbSqlAggregate.toSql", { result: result });
+        return result.substring(0, result.length - 1);
+    }
+    /**
+     * Print non-aggregated fields as SQL GROUP BY-condition based on the datamodel of the API.
+     *
+     * @param dataModel data model (and database) to use for formatting of values
+     *
+     */
+    printSqlColumnNames(dataModel) {
+        let result = "";
+        for (let i = 0; i < dataModel.fields.length; i++) {
+            const aggregate_index = this._fields.indexOf(dataModel.fields[i].name);
+            if (aggregate_index >= 0) {
+                result += this._functions[aggregate_index] + "(" + dataModel.fields[i].printSqlColumnName() + "),";
+            }
+            else {
+                result += dataModel.fields[i].printSqlColumnName() + ",";
+            }
+        }
+        OINOLog.debug("OINODbSqlAggregate.printSqlColumnNames", { result: result });
+        return result.substring(0, result.length - 1);
+    }
+}

package/dist/types/OINODb.d.ts

@@ -80,9 +80,10 @@ export declare abstract class OINODb {
      * @param whereCondition - The WHERE clause to filter the results.
      * @param orderCondition - The ORDER BY clause to sort the results.
      * @param limitCondition - The LIMIT clause to limit the number of results.
+     * @param groupByCondition - The GROUP BY clause to group the results.
      *
      */
-    printSqlSelect(tableName: string, columnNames: string, whereCondition: string, orderCondition: string, limitCondition: string): string;
+    printSqlSelect(tableName: string, columnNames: string, whereCondition: string, orderCondition: string, limitCondition: string, groupByCondition: string): string;
 }
 /**
  * Base class for SQL results that can be asynchronously iterated (but

package/dist/types/OINODbApi.d.ts

@@ -79,4 +79,11 @@ export declare class OINODbApi {
      *
      */
     doRequest(method: string, id: string, body: string | OINODataRow[] | Buffer | any, params?: OINODbApiRequestParams): Promise<OINODbApiResult>;
+    /**
+     * Method to check if a field is included in the API params.
+     *
+     * @param fieldName name of the field
+     *
+     */
+    isFieldIncluded(fieldName: string): boolean;
 }

package/dist/types/OINODbConfig.d.ts

@@ -11,6 +11,8 @@ export declare class OINODbConfig {
     static OINODB_SQL_ORDER_PARAM: string;
     /** Name of the OINODbSqlLimit-parameter in request */
     static OINODB_SQL_LIMIT_PARAM: string;
+    /** Name of the OINODbSqlAggregate-parameter in request */
+    static OINODB_SQL_AGGREGATE_PARAM: string;
     /**
      * Set the name of the OINO ID field
      * @param idField name of the OINO ID field

package/dist/types/OINODbSqlParams.d.ts

@@ -44,14 +44,14 @@ export declare class OINODbSqlFilter {
      */
     constructor(leftSide: OINODbSqlFilter | string, operation: OINODbSqlComparison | OINODbSqlBooleanOperation | null, rightSide: OINODbSqlFilter | string);
     /**
-     * Constructor for `OINOFilter` as parser of http parameter.
+     * Constructor for `OINODbSqlFilter` as parser of http parameter.
      *
      * @param filterString string representation of filter from HTTP-request
      *
      */
     static parse(filterString: string): OINODbSqlFilter;
     /**
-     * Construct a new `OINOFilter` as combination of (boolean and/or) of two filters.
+     * Construct a new `OINODbSqlFilter` as combination of (boolean and/or) of two filters.
      *
      * @param leftSide left side to combine
      * @param operation boolean operation to use in combination
@@ -145,3 +145,57 @@ export declare class OINODbSqlLimit {
      */
     toSql(dataModel: OINODbDataModel): string;
 }
+/**
+ * Supported aggregation functions in OINODbSqlAggregate.
+ * @enum
+ */
+export declare enum OINODbSqlAggregateFunctions {
+    count = "count",
+    sum = "sum",
+    avg = "avg",
+    min = "min",
+    max = "max"
+}
+/**
+ * Class for limiting the number of results.
+ *
+ */
+export declare class OINODbSqlAggregate {
+    private static _aggregateRegex;
+    private _functions;
+    private _fields;
+    /**
+     * Constructor for `OINODbSqlAggregate`.
+     *
+     * @param function aggregate function to use
+     * @param fields fields to aggregate
+     *
+     */
+    constructor(func: OINODbSqlAggregateFunctions[], fields: string[]);
+    /**
+     * Constructor for `OINODbSqlAggregate` as parser of http parameter.
+     *
+     * @param aggregatorString string representation of limit from HTTP-request
+     *
+     */
+    static parse(aggregatorString: string): OINODbSqlAggregate;
+    /**
+     * Does filter contain any valid conditions.
+     *
+     */
+    isEmpty(): boolean;
+    /**
+     * Print non-aggregated fields as SQL GROUP BY-condition based on the datamodel of the API.
+     *
+     * @param dataModel data model (and database) to use for formatting of values
+     *
+     */
+    toSql(dataModel: OINODbDataModel): string;
+    /**
+     * Print non-aggregated fields as SQL GROUP BY-condition based on the datamodel of the API.
+     *
+     * @param dataModel data model (and database) to use for formatting of values
+     *
+     */
+    printSqlColumnNames(dataModel: OINODbDataModel): string;
+}

package/dist/types/index.d.ts

@@ -3,7 +3,7 @@ export { OINOContentType };
 export { OINO_ERROR_PREFIX, OINO_WARNING_PREFIX, OINO_INFO_PREFIX, OINO_DEBUG_PREFIX, OINOStr, OINOBenchmark, OINOLog, OINOLogLevel, OINOConsoleLog, OINOResult, OINOHttpResult, OINOHtmlTemplate } from "@oino-ts/common";
 import { OINODb } from "./OINODb.js";
 import { OINODbDataField } from "./OINODbDataField.js";
-import { OINODbSqlFilter, OINODbSqlLimit, OINODbSqlOrder } from "./OINODbSqlParams.js";
+import { OINODbSqlAggregate, OINODbSqlFilter, OINODbSqlLimit, OINODbSqlOrder } from "./OINODbSqlParams.js";
 export { OINODbApiResult, OINODbHtmlTemplate, OINODbApi } from "./OINODbApi.js";
 export { OINODbDataModel } from "./OINODbDataModel.js";
 export { OINODbModelSet } from "./OINODbModelSet.js";
@@ -16,6 +16,8 @@ export { OINODbSwagger } from "./OINODbSwagger.js";
 export { OINODbParser } from "./OINODbParser.js";
 /** API parameters */
 export type OINODbApiParams = {
+    /** Name of the api */
+    apiName: string;
     /** Name of the database table */
     tableName: string;
     /** Reject values that exceed field max length (behaviour on such is platform dependent) */
@@ -26,9 +28,11 @@ export type OINODbApiParams = {
     failOnInsertWithoutKey?: boolean;
     /** Treat date type fields as just strings and use the native formatting instead of the ISO 8601 format */
     useDatesAsString?: Boolean;
+    /** Include given fields from the API and exclude rest (if defined) */
+    includeFields?: string[];
     /** Exclude all fields with this prefix from the API */
     excludeFieldPrefix?: string;
-    /** Exclude given fields from the API */
+    /** Exclude given fields from the API and include rest (if defined) */
     excludeFields?: string[];
     /** Enable hashids for numeric primarykeys by adding a 32 char key */
     hashidKey?: string;
@@ -83,6 +87,8 @@ export type OINODbSqlParams = {
     order?: OINODbSqlOrder;
     /** SQL result limit condition */
     limit?: OINODbSqlLimit;
+    /** SQL aggregation functions */
+    aggregate?: OINODbSqlAggregate;
 };
 /** Request options */
 export type OINODbApiRequestParams = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/db",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "OINO TS library package for publishing an SQL database tables as a REST API.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",
@@ -19,12 +19,12 @@
   "module": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
   "dependencies": {
-    "@oino-ts/common": "0.2.0"
+    "@oino-ts/common": "0.3.0"
   },
   "devDependencies": {
     "@types/node": "^20.14.10",
     "@types/bun": "^1.1.14",
-    "@oino-ts/types": "0.2.0",
+    "@oino-ts/types": "0.3.0",
     "typedoc": "^0.25.13"
   },
   "files": [

package/src/OINODb.ts

@@ -102,9 +102,10 @@ export abstract class OINODb {
      * @param whereCondition - The WHERE clause to filter the results.
      * @param orderCondition - The ORDER BY clause to sort the results.
      * @param limitCondition - The LIMIT clause to limit the number of results.
+     * @param groupByCondition - The GROUP BY clause to group the results.
      * 
      */
-    printSqlSelect(tableName:string, columnNames:string, whereCondition:string, orderCondition:string, limitCondition:string): string {
+    printSqlSelect(tableName:string, columnNames:string, whereCondition:string, orderCondition:string, limitCondition:string, groupByCondition: string): string {
         let result:string = "SELECT " + columnNames + " FROM " + tableName;
         // OINOLog.debug("OINODb.printSqlSelect", {tableName:tableName, columnNames:columnNames, whereCondition:whereCondition, orderCondition:orderCondition, limitCondition:limitCondition })
         if (whereCondition != "")  {
@@ -116,6 +117,9 @@ export abstract class OINODb {
         if (limitCondition != "") {
             result += " LIMIT " + limitCondition 
         }
+        if (groupByCondition != "") {
+            result += " GROUP BY " + groupByCondition 
+        }
         result += ";"
         // OINOLog.debug("OINODb.printSqlSelect", {result:result})
         return result;

package/src/OINODbApi.test.ts

@@ -12,6 +12,7 @@ import { OINODbBunSqlite } from "@oino-ts/db-bunsqlite"
 import { OINODbPostgresql } from "@oino-ts/db-postgresql"
 import { OINODbMariadb } from "@oino-ts/db-mariadb"
 import { OINODbMsSql } from "@oino-ts/db-mssql"
+import { OINODbSqlAggregate } from "./OINODbSqlParams.js";
 
 const OINODB_POSTGRESQL_TOKEN = process.env.OINODB_POSTGRESQL_TOKEN || console.error("OINODB_POSTGRESQL_TOKEN not set") || ""
 const OINODB_MARIADB_TOKEN = process.env.OINODB_MARIADB_TOKEN || console.error("OINODB_MARIADB_TOKEN not set") || ""
@@ -36,8 +37,8 @@ const dbs:OINODbParams[] = [
 
 const api_tests:OINOTestParams[] = [
     {
-        name: "API",
-        apiParams: { tableName: "Orders" },
+        name: "API 1",
+        apiParams: { apiName: "Orders", tableName: "Orders" },
         requestParams: {
             sqlParams: { filter: OINODbSqlFilter.parse("(ShipPostalCode)-like(0502%)"), order: OINODbSqlOrder.parse("ShipPostalCode-,Freight+"), limit: OINODbSqlLimit.parse("5 page 2") }
         },
@@ -45,8 +46,8 @@ const api_tests:OINOTestParams[] = [
         putRow: [30000,"CACTU",1,new Date("2023-04-05"),new Date("2023-04-06"),new Date("2023-04-07"),2,"847.51","k'l\"m%n_o\tp\rq\nr\\s","59 rue de l'Abbaye","Cowes2","Western Europe","PO31 8PJ","UK"]
     },
     {
-        name: "API",
-        apiParams: { tableName: "Products", failOnOversizedValues: true },
+        name: "API 2",
+        apiParams: { apiName: "Products", tableName: "Products", failOnOversizedValues: true },
         requestParams: {
             sqlParams: { filter: OINODbSqlFilter.parse("(UnitsInStock)-le(5)"), order: OINODbSqlOrder.parse("UnitsInStock,UnitPrice"), limit: OINODbSqlLimit.parse("7") }
         },
@@ -54,8 +55,8 @@ const api_tests:OINOTestParams[] = [
         putRow: [99, "Umeshu", 1, 1, undefined, 24.99, 3, 0, 20, 0]
     },
     {
-        name: "API",
-        apiParams: { tableName: "Employees", hashidKey: "12345678901234567890123456789012", hashidStaticIds:true },
+        name: "API 3",
+        apiParams: { apiName: "Employees", tableName: "Employees", hashidKey: "12345678901234567890123456789012", hashidStaticIds:true },
         requestParams: {
             sqlParams: { filter: OINODbSqlFilter.parse("(TitleOfCourtesy)-eq(Ms.)"), order: OINODbSqlOrder.parse("LastName asc"), limit: OINODbSqlLimit.parse("5") }
         },
@@ -63,20 +64,21 @@ const api_tests:OINOTestParams[] = [
         putRow: [99, "LastName2", "FirstName2", null, "TitleOfCourtesy2", new Date("2023-04-06"), new Date("2023-04-07"), "Address2", "City2", "Region2", 54321, "EU2", "234 567 8901", "8765", Buffer.from("0506070809", "hex"), "Line3\nLine4", 1, "http://accweb/emmployees/lastnamefirstname.bmp"],
     },
     {
-        name: "API",
-        apiParams: { tableName: "OrderDetails" },
+        name: "API 4",
+        apiParams: { apiName: "OrderDetails", tableName: "OrderDetails" },
         requestParams: {
-            sqlParams: { filter: OINODbSqlFilter.parse("(Quantity)-gt(100)"), order: OINODbSqlOrder.parse("Quantity desc,UnitPrice asc"), limit: OINODbSqlLimit.parse("5 page 2") }
+            sqlParams: { aggregate: OINODbSqlAggregate.parse("count(ProductID),avg(UnitPrice),sum(Quantity),max(Discount)") }
         },
         postRow: [10249,77,12.34,56,0],
         putRow: [10249,77,23.45,67,0]
     }
+    
 ]
 
 const owasp_tests:OINOTestParams[] = [
     {
         name: "OWASP 1",
-        apiParams: { tableName: "Products", failOnOversizedValues: true },
+        apiParams: { apiName: "Products", tableName: "Products", failOnOversizedValues: true },
         requestParams: {
             sqlParams: { filter: OINODbSqlFilter.parse("(1)-eq(1)") }
         },
@@ -85,7 +87,7 @@ const owasp_tests:OINOTestParams[] = [
     },
     {
         name: "OWASP 2",
-        apiParams: { tableName: "Products", failOnOversizedValues: true },
+        apiParams: { apiName: "Products", tableName: "Products", failOnOversizedValues: true },
         requestParams: {
             sqlParams: { order: OINODbSqlOrder.parse("1 asc") }
         },
@@ -94,7 +96,7 @@ const owasp_tests:OINOTestParams[] = [
     },
     {
         name: "OWASP 3",
-        apiParams: { tableName: "Products", failOnOversizedValues: true },
+        apiParams: { apiName: "Products", tableName: "Products", failOnOversizedValues: true },
         requestParams: {
             sqlParams: { filter: OINODbSqlFilter.parse("(ProductID)-eq(FOO)") }
         },

package/src/OINODbApi.ts

@@ -5,7 +5,7 @@
  */
 
 import { OINODbApiParams, OINODb, OINODbDataSet, OINODbDataModel, OINODbDataField, OINOStringDataField, OINO_ERROR_PREFIX, OINODataRow, OINODataCell, OINODbModelSet, OINOBenchmark, OINODbApiRequestParams, OINODbConfig, OINOHttpResult, OINOHtmlTemplate, OINONumberDataField, OINODbParser } from "./index.js"
-import { OINOResult } from "@oino-ts/common";
+import { OINOLog, OINOResult } from "@oino-ts/common";
 import { OINOHashid } from "@oino-ts/hashid"
 
 const API_EMPTY_PARAMS:OINODbApiRequestParams = { sqlParams: {} }
@@ -364,4 +364,22 @@ export class OINODbApi {
         OINOBenchmark.end("OINODbApi", "doRequest", method)
         return Promise.resolve(result)
     }
+
+    /**
+     * Method to check if a field is included in the API params.
+     *
+     * @param fieldName name of the field
+     * 
+     */
+
+    public isFieldIncluded(fieldName:string):boolean {
+        // OINOLog.debug("OINODbApi.isFieldIncluded", {fieldName:fieldName, included:this.params.includeFields})
+        const params = this.params
+        return (
+            ((params.excludeFieldPrefix == undefined) || (params.excludeFieldPrefix == "") || fieldName.startsWith(params.excludeFieldPrefix)) && 
+            ((params.excludeFields == undefined) || (params.excludeFields.length == 0) || (params.excludeFields.indexOf(fieldName) < 0)) &&
+            ((params.includeFields == undefined) || (params.includeFields.length == 0) || (params.includeFields.indexOf(fieldName) >= 0))
+        ) 
+    }
+
 }

package/src/OINODbConfig.ts

@@ -16,6 +16,9 @@ export class OINODbConfig {
     /** Name of the OINODbSqlLimit-parameter in request */
     static OINODB_SQL_LIMIT_PARAM:string = "oinosqllimit"
 
+    /** Name of the OINODbSqlAggregate-parameter in request */
+    static OINODB_SQL_AGGREGATE_PARAM:string = "oinosqlaggregate"
+
     /** 
      * Set the name of the OINO ID field 
      * @param idField name of the OINO ID field 

package/src/OINODbDataField.ts

@@ -258,7 +258,7 @@ export class OINONumberDataField extends OINODbDataField {
         } else {
             const result:number = parseFloat(value)
             if (isNaN(result)) {
-                OINOLog.error("OINODbSqlFilter.toSql: Invalid value!", {value:value})
+                OINOLog.error("OINONumberDataField.toSql: Invalid value!", {value:value})
                 throw new Error(OINO_ERROR_PREFIX + ": OINONumberDataField.deserializeCell - Invalid value '" + value + "'") // incorrectly formatted data could be a security risk, abort processing
             }
             return result

package/src/OINODbDataModel.ts

@@ -43,13 +43,10 @@ export class OINODbDataModel {
 
     private _printSqlColumnNames(): string {
         let result: string = "";
-        for (let f of this.fields) {
-            if (result != "") {
-                result += ",";
-            }
-            result += f.printSqlColumnName();
+        for (let i=0; i < this.fields.length; i++) {
+            result += this.fields[i].printSqlColumnName()+","
         }
-        return result;
+        return result.substring(0, result.length-1)
     }
 
     private _printSqlInsertColumnsAndValues(row: OINODataRow): string {
@@ -231,10 +228,17 @@ export class OINODbDataModel {
      *
      */
     printSqlSelect(id: string, params:OINODbSqlParams): string {
-        const column_names = this._printSqlColumnNames()
+        let column_names = ""
+        if (params.aggregate) {
+            column_names = params.aggregate.printSqlColumnNames(this)
+        } else { 
+            column_names = this._printSqlColumnNames()
+        } 
         const order_sql = params.order?.toSql(this) || ""
         const limit_sql = params.limit?.toSql(this) || ""
         const filter_sql = params.filter?.toSql(this) || ""
+        const aggregate_sql = params.aggregate?.toSql(this) || ""
+        
         let where_sql = ""
         // OINOLog.debug("OINODbDataModel.printSqlSelect", {id:id, select_sql:result, filter_sql:filter_sql, order_sql:order_sql})
         if ((id != null) && (id != "") && (filter_sql != ""))  {
@@ -244,7 +248,7 @@ export 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)
+        const result = this.api.db.printSqlSelect(this.api.params.tableName, column_names, where_sql, order_sql, limit_sql, aggregate_sql)
         // OINOLog.debug("OINODbDataModel.printSqlSelect", {result:result})
         return result;
     }

package/src/OINODbFactory.ts

@@ -5,6 +5,7 @@
  */
 
 import { OINODbApi, OINODbApiParams, OINODbParams, OINOContentType, OINODb, OINODbConstructor, OINODbApiRequestParams, OINODbSqlFilter, OINODbConfig, OINODbSqlOrder, OINODbSqlLimit, OINODbSqlParams } from "./index.js"
+import { OINODbSqlAggregate } from "./OINODbSqlParams.js"
 
 /**
  * Static factory class for easily creating things based on data
@@ -75,6 +76,10 @@ export class OINODbFactory {
         if (limit) {
             sql_params.limit = OINODbSqlLimit.parse(limit)
         }
+        const aggregate = url.searchParams.get(OINODbConfig.OINODB_SQL_AGGREGATE_PARAM)
+        if (aggregate) {
+            sql_params.aggregate = OINODbSqlAggregate.parse(aggregate)
+        }
 
         let result:OINODbApiRequestParams = { sqlParams: sql_params }
 

package/src/OINODbSqlParams.ts

@@ -6,6 +6,8 @@
 
 import { OINOStr, OINODbDataField, OINODbDataModel, OINO_ERROR_PREFIX, OINOLog } from "./index.js"
 
+const OINO_FIELD_NAME_CHARS:string = "\\w\\s\\-\\_\\#\\¤"
+
 /**
  * Supported logical conjunctions in filter predicates.
  * @enum
@@ -58,13 +60,13 @@ export class OINODbSqlFilter {
     }
 
     /**
-     * Constructor for `OINOFilter` as parser of http parameter.
+     * Constructor for `OINODbSqlFilter` as parser of http parameter.
      * 
      * @param filterString string representation of filter from HTTP-request
      *
      */
     static parse(filterString: string):OINODbSqlFilter {
-        // OINOLog_debug("OINOFilter.constructor", {filterString:filterString})
+        // OINOLog_debug("OINODbSqlFilter.constructor", {filterString:filterString})
         if (!filterString) {
             return new OINODbSqlFilter("", null, "")
 
@@ -78,7 +80,7 @@ export class OINODbSqlFilter {
                     return new OINODbSqlFilter("", OINODbSqlBooleanOperation.not, OINODbSqlFilter.parse(match[3]))
                 } else {
                     let boolean_parts = OINOStr.splitByBrackets(filterString, true, false, '(', ')')
-                    // OINOLog_debug("OINOFilter.constructor", {boolean_parts:boolean_parts})
+                    // OINOLog_debug("OINODbSqlFilter.constructor", {boolean_parts:boolean_parts})
                     if (boolean_parts.length == 3 && (boolean_parts[1].match(OINODbSqlFilter._booleanOperationRegex))) {
                         return new OINODbSqlFilter(OINODbSqlFilter.parse(boolean_parts[0]), boolean_parts[1].trim().toLowerCase().substring(1) as OINODbSqlBooleanOperation, OINODbSqlFilter.parse(boolean_parts[2]))
         
@@ -91,7 +93,7 @@ export class OINODbSqlFilter {
     }
 
     /**
-     * Construct a new `OINOFilter` as combination of (boolean and/or) of two filters.
+     * Construct a new `OINODbSqlFilter` as combination of (boolean and/or) of two filters.
      * 
      * @param leftSide left side to combine
      * @param operation boolean operation to use in combination
@@ -144,7 +146,7 @@ export class OINODbSqlFilter {
      *
      */
     toSql(dataModel:OINODbDataModel):string {
-        // OINOLog.debug("OINOFilter.toSql", {_leftSide:this._leftSide, _operator:this._operator, _rightSide:this._rightSide})
+        // OINOLog.debug("OINODbSqlFilter.toSql", {_leftSide:this._leftSide, _operator:this._operator, _rightSide:this._rightSide})
         if (this.isEmpty()) {
             return ""
         }
@@ -171,7 +173,7 @@ export class OINODbSqlFilter {
             }
             result += field!.printCellAsSqlValue(value)
         }
-        // OINOLog.debug("OINOFilter.toSql", {result:result})
+        // OINOLog.debug("OINODbSqlFilter.toSql", {result:result})
         return "(" + result + ")"
     }
 }
@@ -335,4 +337,101 @@ export class OINODbSqlLimit {
     }
 }
 
+/**
+ * Supported aggregation functions in OINODbSqlAggregate.
+ * @enum
+ */
+export enum OINODbSqlAggregateFunctions { count = "count", sum = "sum", avg = "avg", min = "min", max = "max" }
+
+/**
+ * Class for limiting the number of results. 
+ *
+ */
+export class OINODbSqlAggregate {
+    private static _aggregateRegex:RegExp = new RegExp("^(count|sum|avg|min|max)\\(([" + OINO_FIELD_NAME_CHARS + "]+)\\)$", "mi")
+    
+    private _functions: OINODbSqlAggregateFunctions[]
+    private _fields: string[]
+
+    /**
+     * Constructor for `OINODbSqlAggregate`.
+     * 
+     * @param function aggregate function to use
+     * @param fields fields to aggregate
+     *
+     */
+    constructor(func: OINODbSqlAggregateFunctions[], fields: string[]) {
+        this._functions = func
+        this._fields = fields
+    }
+    /**
+     * Constructor for `OINODbSqlAggregate` as parser of http parameter.
+     * 
+     * @param aggregatorString string representation of limit from HTTP-request
+     *
+     */
+    static parse(aggregatorString: string):OINODbSqlAggregate {
+        let funtions:OINODbSqlAggregateFunctions[] = []
+        let fields:string[] = []
+        const aggregator_parts = aggregatorString.split(',')
+        for (let i=0; i<aggregator_parts.length; i++) {
+            let match = OINODbSqlAggregate._aggregateRegex.exec(aggregator_parts[i])
+            // OINOLog.debug("OINODbSqlAggregate.parse - next aggregator", {aggregator: aggregator_parts[i], match:match})
+            if ((match != null) && (match.length == 3)) {
+                funtions.push(match[1] as OINODbSqlAggregateFunctions)
+                fields.push(match[2])
+            } 
+        }
+        return new OINODbSqlAggregate(funtions, fields)
+    }
+
+    /**
+     * Does filter contain any valid conditions.
+     *
+     */
+    isEmpty():boolean {
+        return (this._functions.length <= 0)
+    }
+
+    /**
+     * Print non-aggregated fields as SQL GROUP BY-condition based on the datamodel of the API.
+     * 
+     * @param dataModel data model (and database) to use for formatting of values
+     *
+     */
+    toSql(dataModel:OINODbDataModel):string {
+        if (this.isEmpty()) {
+            return ""
+        }
+        let result:string = ""
+        for (let i=0; i<dataModel.fields.length; i++) {
+            if (this._fields.includes(dataModel.fields[i].name) == false) {
+                result += dataModel.fields[i].printSqlColumnName() + ","
+            }
+        }
+        OINOLog.debug("OINODbSqlAggregate.toSql", {result:result})
+        return result.substring(0, result.length-1)
+    }
+
+    /**
+     * Print non-aggregated fields as SQL GROUP BY-condition based on the datamodel of the API.
+     * 
+     * @param dataModel data model (and database) to use for formatting of values
+     *
+     */
+    printSqlColumnNames(dataModel:OINODbDataModel):string {
+        let result:string = ""
+        for (let i=0; i<dataModel.fields.length; i++) {
+            const aggregate_index = this._fields.indexOf(dataModel.fields[i].name)
+            if (aggregate_index >= 0) {
+                result += this._functions[aggregate_index] + "(" + dataModel.fields[i].printSqlColumnName() + "),"
+            } else {
+                result += dataModel.fields[i].printSqlColumnName() + ","
+            }
+        }
+        OINOLog.debug("OINODbSqlAggregate.printSqlColumnNames", {result:result})
+        return result.substring(0, result.length-1)
+    }
+}
+
 

package/src/index.ts

@@ -5,7 +5,7 @@ export { OINO_ERROR_PREFIX, OINO_WARNING_PREFIX, OINO_INFO_PREFIX, OINO_DEBUG_PR
 
 import { OINODb } from "./OINODb.js"
 import { OINODbDataField } from "./OINODbDataField.js"
-import { OINODbSqlFilter, OINODbSqlLimit, OINODbSqlOrder } from "./OINODbSqlParams.js"
+import { OINODbSqlAggregate, OINODbSqlFilter, OINODbSqlLimit, OINODbSqlOrder } from "./OINODbSqlParams.js"
 
 export { OINODbApiResult, OINODbHtmlTemplate, OINODbApi } from "./OINODbApi.js"
 export { OINODbDataModel } from "./OINODbDataModel.js"
@@ -20,6 +20,8 @@ export { OINODbParser } from "./OINODbParser.js"
 
 /** API parameters */
 export type OINODbApiParams = {
+    /** Name of the api */
+    apiName: string 
     /** Name of the database table */
     tableName: string 
     /** Reject values that exceed field max length (behaviour on such is platform dependent) */
@@ -30,9 +32,11 @@ export type OINODbApiParams = {
     failOnInsertWithoutKey?: boolean
     /** Treat date type fields as just strings and use the native formatting instead of the ISO 8601 format */
     useDatesAsString?: Boolean
+    /** Include given fields from the API and exclude rest (if defined) */
+    includeFields?:string[],
     /** Exclude all fields with this prefix from the API */
     excludeFieldPrefix?:string
-    /** Exclude given fields from the API */
+    /** Exclude given fields from the API and include rest (if defined) */
     excludeFields?:string[],
     /** Enable hashids for numeric primarykeys by adding a 32 char key */
     hashidKey?:string,
@@ -92,6 +96,8 @@ export type OINODbSqlParams = {
     order?:OINODbSqlOrder
     /** SQL result limit condition */
     limit?:OINODbSqlLimit
+    /** SQL aggregation functions */
+    aggregate?:OINODbSqlAggregate
 }
 
 /** Request options */