@oino-ts/db 0.13.2 → 0.14.0

package/dist/cjs/OINODbDataModel.js

@@ -12,7 +12,7 @@ const index_js_1 = require("./index.js");
  *
  */
 class OINODbDataModel {
-    _columnLookup;
+    _fieldIndexLookup;
     /** Database refererence of the table */
     api;
     /** Field refererences of the API */
@@ -25,7 +25,7 @@ class OINODbDataModel {
      *
      */
     constructor(api) {
-        this._columnLookup = {};
+        this._fieldIndexLookup = {};
         this.api = api;
         this.fields = [];
     }
@@ -116,7 +116,7 @@ class OINODbDataModel {
      */
     addField(field) {
         this.fields.push(field);
-        this._columnLookup[field.name] = this.fields.length - 1;
+        this._fieldIndexLookup[field.name] = this.fields.length - 1;
     }
     /**
      * Find a field of a given name if any.
@@ -125,7 +125,7 @@ class OINODbDataModel {
      *
      */
     findFieldByName(name) {
-        const i = this._columnLookup[name];
+        const i = this._fieldIndexLookup[name];
         if (i >= 0) {
             return this.fields[i];
         }
@@ -140,7 +140,7 @@ class OINODbDataModel {
      *
      */
     findFieldIndexByName(name) {
-        const i = this._columnLookup[name];
+        const i = this._fieldIndexLookup[name];
         if (i >= 0) {
             return i;
         }

package/dist/cjs/OINODbModelSet.js

@@ -308,13 +308,16 @@ class OINODbModelSet {
     /**
      * 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() {
+    async exportAsRecord(idFieldName) {
         const result = {};
+        const row_id_field = idFieldName || index_js_1.OINODbConfig.OINODB_ID_FIELD;
         while (!this.dataset.isEof()) {
             const row_data = this.dataset.getRow();
             const row_export = this._exportRow(row_data);
-            result[row_export[index_js_1.OINODbConfig.OINODB_ID_FIELD]] = row_export;
+            const row_id = row_export[row_id_field];
+            result[row_id] = row_export;
             await this.dataset.next();
         }
         return result;

package/dist/cjs/OINODbSqlParams.js

@@ -5,7 +5,7 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OINODbSqlSelect = exports.OINODbSqlAggregate = exports.OINODbSqlAggregateFunctions = exports.OINODbSqlLimit = exports.OINODbSqlOrder = exports.OINODbSqlFilter = exports.OINODbSqlComparison = exports.OINODbSqlBooleanOperation = void 0;
+exports.OINODbSqlSelect = exports.OINODbSqlAggregate = exports.OINODbSqlAggregateFunctions = exports.OINODbSqlLimit = exports.OINODbSqlOrder = exports.OINODbSqlFilter = exports.OINODbSqlNullCheck = exports.OINODbSqlComparison = exports.OINODbSqlBooleanOperation = void 0;
 const index_js_1 = require("./index.js");
 const OINO_FIELD_NAME_CHARS = "\\w\\s\\-\\_\\#\\¤";
 /**
@@ -27,10 +27,20 @@ var OINODbSqlComparison;
     OINODbSqlComparison["lt"] = "lt";
     OINODbSqlComparison["le"] = "le";
     OINODbSqlComparison["eq"] = "eq";
+    OINODbSqlComparison["ne"] = "ne";
     OINODbSqlComparison["ge"] = "ge";
     OINODbSqlComparison["gt"] = "gt";
     OINODbSqlComparison["like"] = "like";
 })(OINODbSqlComparison || (exports.OINODbSqlComparison = OINODbSqlComparison = {}));
+/**
+ * Supported logical conjunctions in filter predicates.
+ * @enum
+ */
+var OINODbSqlNullCheck;
+(function (OINODbSqlNullCheck) {
+    OINODbSqlNullCheck["isnull"] = "isnull";
+    OINODbSqlNullCheck["isnotnull"] = "isnotnull";
+})(OINODbSqlNullCheck || (exports.OINODbSqlNullCheck = OINODbSqlNullCheck = {}));
 /**
  * Class for recursively parsing of filters and printing them as SQL conditions.
  * Supports three types of statements
@@ -42,8 +52,9 @@ var OINODbSqlComparison;
  */
 class OINODbSqlFilter {
     static _booleanOperationRegex = /^\s?\-(and|or)\s?$/i;
-    static _negationRegex = /^-(not|)\((.+)\)$/i;
-    static _filterComparisonRegex = /^\(([^'"\(\)]+)\)\s?\-(lt|le|eq|ge|gt|like)\s?\(([^'"\(\)]+)\)$/i;
+    static _negationRegex = /^-(not)\((.+)\)$/i;
+    static _filterComparisonRegex = /^\(([^'"\(\)]+)\)\s?\-(lt|le|eq|ne|ge|gt|like)\s?\(([^'"\(\)]+)\)$/i;
+    static _filterNullCheckRegex = /^-(isnull|isnotnull)\((.+)\)$/i;
     _leftSide;
     _rightSide;
     _operator;
@@ -57,6 +68,7 @@ class OINODbSqlFilter {
         if (!(((operation === null) && (leftSide == "") && (rightSide == "")) ||
             ((operation !== null) && (Object.values(OINODbSqlComparison).includes(operation)) && (typeof (leftSide) == "string") && (leftSide != "") && (typeof (rightSide) == "string") && (rightSide != "")) ||
             ((operation == OINODbSqlBooleanOperation.not) && (leftSide == "") && (rightSide instanceof OINODbSqlFilter)) ||
+            (((operation == OINODbSqlNullCheck.isnull) || (operation == OINODbSqlNullCheck.isnotnull)) && (typeof (leftSide) == "string") && (rightSide == "")) ||
             (((operation == OINODbSqlBooleanOperation.and) || (operation == OINODbSqlBooleanOperation.or)) && (leftSide instanceof OINODbSqlFilter) && (rightSide instanceof OINODbSqlFilter)))) {
             index_js_1.OINOLog.error("@oino-ts/db", "OINODbSqlFilter", "constructor", "Unsupported OINODbSqlFilter format", { leftSide: leftSide, operation: operation, rightSide: rightSide });
             throw new Error(index_js_1.OINO_ERROR_PREFIX + ": Unsupported OINODbSqlFilter format!");
@@ -72,6 +84,7 @@ class OINODbSqlFilter {
      * - comparison: (field)-lt|le|eq|ge|gt|like(value)
      * - negation: -not(filter)
      * - conjunction/disjunction: (filter)-and|or(filter)
+     * - null check: -isnull(field) or -isnotnull(field)
      *
      * @param filterString string representation of filter from HTTP-request
      *
@@ -82,7 +95,7 @@ class OINODbSqlFilter {
         }
         else {
             let match = OINODbSqlFilter._filterComparisonRegex.exec(filterString);
-            if (match != null) {
+            if ((match != null) && (match.length == 4)) {
                 return new OINODbSqlFilter(match[1], match[2].toLowerCase(), match[3]);
             }
             else {
@@ -96,8 +109,14 @@ class OINODbSqlFilter {
                         return new OINODbSqlFilter(OINODbSqlFilter.parse(boolean_parts[0]), boolean_parts[1].trim().toLowerCase().substring(1), OINODbSqlFilter.parse(boolean_parts[2]));
                     }
                     else {
-                        index_js_1.OINOLog.error("@oino-ts/db", "OINODbSqlFilter", "constructor", "Invalid filter", { filterString: filterString });
-                        throw new Error(index_js_1.OINO_ERROR_PREFIX + ": Invalid filter '" + filterString + "'"); // invalid filter could be a security risk, stop processing
+                        let match = OINODbSqlFilter._filterNullCheckRegex.exec(filterString);
+                        if ((match != null)) {
+                            return new OINODbSqlFilter(match[2], match[1].toLowerCase(), "");
+                        }
+                        else {
+                            index_js_1.OINOLog.error("@oino-ts/db", "OINODbSqlFilter", "constructor", "Invalid filter", { filterString: filterString });
+                            throw new Error(index_js_1.OINO_ERROR_PREFIX + ": Invalid filter '" + filterString + "'"); // invalid filter could be a security risk, stop processing
+                        }
                     }
                 }
             }
@@ -125,6 +144,50 @@ class OINODbSqlFilter {
             return undefined;
         }
     }
+    /**
+     * Combine two filters with an AND operation.
+     *
+     * @param leftSide left side filter
+     * @param rightSide right side filter
+     *
+     */
+    static and(leftSide, rightSide) {
+        if ((leftSide) && (!leftSide.isEmpty()) && (rightSide) && (!rightSide.isEmpty())) {
+            return new OINODbSqlFilter(leftSide, OINODbSqlBooleanOperation.and, rightSide);
+        }
+        else {
+            return undefined;
+        }
+    }
+    /**
+     * Combine two filters with an OR operation.
+     *
+     * @param leftSide left side filter
+     * @param rightSide right side filter
+     *
+     */
+    static or(leftSide, rightSide) {
+        if ((leftSide) && (!leftSide.isEmpty()) && (rightSide) && (!rightSide.isEmpty())) {
+            return new OINODbSqlFilter(leftSide, OINODbSqlBooleanOperation.or, rightSide);
+        }
+        else {
+            return undefined;
+        }
+    }
+    /**
+     * Negate a filter with a NOT operation.
+     *
+     * @param leftSide left side filter
+     *
+     */
+    static not(leftSide) {
+        if ((leftSide) && (!leftSide.isEmpty())) {
+            return new OINODbSqlFilter(leftSide, OINODbSqlBooleanOperation.not, "");
+        }
+        else {
+            return undefined;
+        }
+    }
     _operatorToSql() {
         switch (this._operator) {
             case "and": return " AND ";
@@ -133,9 +196,12 @@ class OINODbSqlFilter {
             case "lt": return " < ";
             case "le": return " <= ";
             case "eq": return " = ";
+            case "ne": return " != ";
             case "ge": return " >= ";
             case "gt": return " > ";
             case "like": return " LIKE ";
+            case "isnull": return " IS NULL";
+            case "isnotnull": return " IS NOT NULL";
         }
         return " ";
     }
@@ -173,6 +239,9 @@ class OINODbSqlFilter {
         if (this._rightSide instanceof OINODbSqlFilter) {
             result += this._rightSide.toSql(dataModel);
         }
+        else if (this._operator == OINODbSqlNullCheck.isnull || this._operator == OINODbSqlNullCheck.isnotnull) {
+            // nothing to do, IS NULL and IS NOT NULL do not have a right side
+        }
         else {
             const value = field.deserializeCell(this._rightSide);
             if ((value == null) || (value === "")) {

package/dist/esm/OINODbDataModel.js

@@ -9,7 +9,7 @@ import { OINO_ERROR_PREFIX, OINODbConfig, OINONumberDataField, OINODB_UNDEFINED
  *
  */
 export class OINODbDataModel {
-    _columnLookup;
+    _fieldIndexLookup;
     /** Database refererence of the table */
     api;
     /** Field refererences of the API */
@@ -22,7 +22,7 @@ export class OINODbDataModel {
      *
      */
     constructor(api) {
-        this._columnLookup = {};
+        this._fieldIndexLookup = {};
         this.api = api;
         this.fields = [];
     }
@@ -113,7 +113,7 @@ export class OINODbDataModel {
      */
     addField(field) {
         this.fields.push(field);
-        this._columnLookup[field.name] = this.fields.length - 1;
+        this._fieldIndexLookup[field.name] = this.fields.length - 1;
     }
     /**
      * Find a field of a given name if any.
@@ -122,7 +122,7 @@ export class OINODbDataModel {
      *
      */
     findFieldByName(name) {
-        const i = this._columnLookup[name];
+        const i = this._fieldIndexLookup[name];
         if (i >= 0) {
             return this.fields[i];
         }
@@ -137,7 +137,7 @@ export class OINODbDataModel {
      *
      */
     findFieldIndexByName(name) {
-        const i = this._columnLookup[name];
+        const i = this._fieldIndexLookup[name];
         if (i >= 0) {
             return i;
         }

package/dist/esm/OINODbModelSet.js

@@ -305,13 +305,16 @@ export class OINODbModelSet {
     /**
      * 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() {
+    async exportAsRecord(idFieldName) {
         const result = {};
+        const row_id_field = idFieldName || OINODbConfig.OINODB_ID_FIELD;
         while (!this.dataset.isEof()) {
             const row_data = this.dataset.getRow();
             const row_export = this._exportRow(row_data);
-            result[row_export[OINODbConfig.OINODB_ID_FIELD]] = row_export;
+            const row_id = row_export[row_id_field];
+            result[row_id] = row_export;
             await this.dataset.next();
         }
         return result;

package/dist/esm/OINODbSqlParams.js

@@ -24,10 +24,20 @@ export var OINODbSqlComparison;
     OINODbSqlComparison["lt"] = "lt";
     OINODbSqlComparison["le"] = "le";
     OINODbSqlComparison["eq"] = "eq";
+    OINODbSqlComparison["ne"] = "ne";
     OINODbSqlComparison["ge"] = "ge";
     OINODbSqlComparison["gt"] = "gt";
     OINODbSqlComparison["like"] = "like";
 })(OINODbSqlComparison || (OINODbSqlComparison = {}));
+/**
+ * Supported logical conjunctions in filter predicates.
+ * @enum
+ */
+export var OINODbSqlNullCheck;
+(function (OINODbSqlNullCheck) {
+    OINODbSqlNullCheck["isnull"] = "isnull";
+    OINODbSqlNullCheck["isnotnull"] = "isnotnull";
+})(OINODbSqlNullCheck || (OINODbSqlNullCheck = {}));
 /**
  * Class for recursively parsing of filters and printing them as SQL conditions.
  * Supports three types of statements
@@ -39,8 +49,9 @@ export var OINODbSqlComparison;
  */
 export class OINODbSqlFilter {
     static _booleanOperationRegex = /^\s?\-(and|or)\s?$/i;
-    static _negationRegex = /^-(not|)\((.+)\)$/i;
-    static _filterComparisonRegex = /^\(([^'"\(\)]+)\)\s?\-(lt|le|eq|ge|gt|like)\s?\(([^'"\(\)]+)\)$/i;
+    static _negationRegex = /^-(not)\((.+)\)$/i;
+    static _filterComparisonRegex = /^\(([^'"\(\)]+)\)\s?\-(lt|le|eq|ne|ge|gt|like)\s?\(([^'"\(\)]+)\)$/i;
+    static _filterNullCheckRegex = /^-(isnull|isnotnull)\((.+)\)$/i;
     _leftSide;
     _rightSide;
     _operator;
@@ -54,6 +65,7 @@ export class OINODbSqlFilter {
         if (!(((operation === null) && (leftSide == "") && (rightSide == "")) ||
             ((operation !== null) && (Object.values(OINODbSqlComparison).includes(operation)) && (typeof (leftSide) == "string") && (leftSide != "") && (typeof (rightSide) == "string") && (rightSide != "")) ||
             ((operation == OINODbSqlBooleanOperation.not) && (leftSide == "") && (rightSide instanceof OINODbSqlFilter)) ||
+            (((operation == OINODbSqlNullCheck.isnull) || (operation == OINODbSqlNullCheck.isnotnull)) && (typeof (leftSide) == "string") && (rightSide == "")) ||
             (((operation == OINODbSqlBooleanOperation.and) || (operation == OINODbSqlBooleanOperation.or)) && (leftSide instanceof OINODbSqlFilter) && (rightSide instanceof OINODbSqlFilter)))) {
             OINOLog.error("@oino-ts/db", "OINODbSqlFilter", "constructor", "Unsupported OINODbSqlFilter format", { leftSide: leftSide, operation: operation, rightSide: rightSide });
             throw new Error(OINO_ERROR_PREFIX + ": Unsupported OINODbSqlFilter format!");
@@ -69,6 +81,7 @@ export class OINODbSqlFilter {
      * - comparison: (field)-lt|le|eq|ge|gt|like(value)
      * - negation: -not(filter)
      * - conjunction/disjunction: (filter)-and|or(filter)
+     * - null check: -isnull(field) or -isnotnull(field)
      *
      * @param filterString string representation of filter from HTTP-request
      *
@@ -79,7 +92,7 @@ export class OINODbSqlFilter {
         }
         else {
             let match = OINODbSqlFilter._filterComparisonRegex.exec(filterString);
-            if (match != null) {
+            if ((match != null) && (match.length == 4)) {
                 return new OINODbSqlFilter(match[1], match[2].toLowerCase(), match[3]);
             }
             else {
@@ -93,8 +106,14 @@ export class OINODbSqlFilter {
                         return new OINODbSqlFilter(OINODbSqlFilter.parse(boolean_parts[0]), boolean_parts[1].trim().toLowerCase().substring(1), OINODbSqlFilter.parse(boolean_parts[2]));
                     }
                     else {
-                        OINOLog.error("@oino-ts/db", "OINODbSqlFilter", "constructor", "Invalid filter", { filterString: filterString });
-                        throw new Error(OINO_ERROR_PREFIX + ": Invalid filter '" + filterString + "'"); // invalid filter could be a security risk, stop processing
+                        let match = OINODbSqlFilter._filterNullCheckRegex.exec(filterString);
+                        if ((match != null)) {
+                            return new OINODbSqlFilter(match[2], match[1].toLowerCase(), "");
+                        }
+                        else {
+                            OINOLog.error("@oino-ts/db", "OINODbSqlFilter", "constructor", "Invalid filter", { filterString: filterString });
+                            throw new Error(OINO_ERROR_PREFIX + ": Invalid filter '" + filterString + "'"); // invalid filter could be a security risk, stop processing
+                        }
                     }
                 }
             }
@@ -122,6 +141,50 @@ export class OINODbSqlFilter {
             return undefined;
         }
     }
+    /**
+     * Combine two filters with an AND operation.
+     *
+     * @param leftSide left side filter
+     * @param rightSide right side filter
+     *
+     */
+    static and(leftSide, rightSide) {
+        if ((leftSide) && (!leftSide.isEmpty()) && (rightSide) && (!rightSide.isEmpty())) {
+            return new OINODbSqlFilter(leftSide, OINODbSqlBooleanOperation.and, rightSide);
+        }
+        else {
+            return undefined;
+        }
+    }
+    /**
+     * Combine two filters with an OR operation.
+     *
+     * @param leftSide left side filter
+     * @param rightSide right side filter
+     *
+     */
+    static or(leftSide, rightSide) {
+        if ((leftSide) && (!leftSide.isEmpty()) && (rightSide) && (!rightSide.isEmpty())) {
+            return new OINODbSqlFilter(leftSide, OINODbSqlBooleanOperation.or, rightSide);
+        }
+        else {
+            return undefined;
+        }
+    }
+    /**
+     * Negate a filter with a NOT operation.
+     *
+     * @param leftSide left side filter
+     *
+     */
+    static not(leftSide) {
+        if ((leftSide) && (!leftSide.isEmpty())) {
+            return new OINODbSqlFilter(leftSide, OINODbSqlBooleanOperation.not, "");
+        }
+        else {
+            return undefined;
+        }
+    }
     _operatorToSql() {
         switch (this._operator) {
             case "and": return " AND ";
@@ -130,9 +193,12 @@ export class OINODbSqlFilter {
             case "lt": return " < ";
             case "le": return " <= ";
             case "eq": return " = ";
+            case "ne": return " != ";
             case "ge": return " >= ";
             case "gt": return " > ";
             case "like": return " LIKE ";
+            case "isnull": return " IS NULL";
+            case "isnotnull": return " IS NOT NULL";
         }
         return " ";
     }
@@ -170,6 +236,9 @@ export class OINODbSqlFilter {
         if (this._rightSide instanceof OINODbSqlFilter) {
             result += this._rightSide.toSql(dataModel);
         }
+        else if (this._operator == OINODbSqlNullCheck.isnull || this._operator == OINODbSqlNullCheck.isnotnull) {
+            // nothing to do, IS NULL and IS NOT NULL do not have a right side
+        }
         else {
             const value = field.deserializeCell(this._rightSide);
             if ((value == null) || (value === "")) {

package/dist/types/OINODbApi.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { OINODbApiParams, OINODb, OINODbDataModel, OINODataRow, OINODbModelSet, OINODbApiRequestParams, OINOHttpResult, OINOHtmlTemplate } from "./index.js";
 import { OINOResult } from "@oino-ts/common";
 import { OINOHashid } from "@oino-ts/hashid";

package/dist/types/OINODbDataModel.d.ts

@@ -4,7 +4,7 @@ import { OINODbDataField, OINODbApi, OINODataRow, OINODbDataFieldFilter, OINODbS
  *
  */
 export declare class OINODbDataModel {
-    private _columnLookup;
+    private _fieldIndexLookup;
     /** Database refererence of the table */
     readonly api: OINODbApi;
     /** Field refererences of the API */

package/dist/types/OINODbModelSet.d.ts

@@ -55,6 +55,7 @@ export declare class OINODbModelSet {
     /**
      * 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
      */
-    exportAsRecord(): Promise<Record<string, any>>;
+    exportAsRecord(idFieldName?: string): Promise<Record<string, any>>;
 }

package/dist/types/OINODbParser.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { OINODbDataModel, OINODataRow, OINODbApiRequestParams } from "./index.js";
 /**
  * Static factory class for easily creating things based on data

package/dist/types/OINODbSqlParams.d.ts

@@ -16,10 +16,19 @@ export declare enum OINODbSqlComparison {
     lt = "lt",
     le = "le",
     eq = "eq",
+    ne = "ne",
     ge = "ge",
     gt = "gt",
     like = "like"
 }
+/**
+ * Supported logical conjunctions in filter predicates.
+ * @enum
+ */
+export declare enum OINODbSqlNullCheck {
+    isnull = "isnull",
+    isnotnull = "isnotnull"
+}
 /**
  * Class for recursively parsing of filters and printing them as SQL conditions.
  * Supports three types of statements
@@ -33,6 +42,7 @@ export declare class OINODbSqlFilter {
     private static _booleanOperationRegex;
     private static _negationRegex;
     private static _filterComparisonRegex;
+    private static _filterNullCheckRegex;
     private _leftSide;
     private _rightSide;
     private _operator;
@@ -42,7 +52,7 @@ export declare class OINODbSqlFilter {
      * @param operation operation of the filter, either `OINODbSqlComparison` or `OINODbSqlBooleanOperation`
      * @param rightSide right side of the filter, either another filter or a value
      */
-    constructor(leftSide: OINODbSqlFilter | string, operation: OINODbSqlComparison | OINODbSqlBooleanOperation | null, rightSide: OINODbSqlFilter | string);
+    constructor(leftSide: OINODbSqlFilter | string, operation: OINODbSqlComparison | OINODbSqlBooleanOperation | OINODbSqlNullCheck | null, rightSide: OINODbSqlFilter | string);
     /**
      * Constructor for `OINODbSqlFilter` as parser of http parameter.
      *
@@ -50,6 +60,7 @@ export declare class OINODbSqlFilter {
      * - comparison: (field)-lt|le|eq|ge|gt|like(value)
      * - negation: -not(filter)
      * - conjunction/disjunction: (filter)-and|or(filter)
+     * - null check: -isnull(field) or -isnotnull(field)
      *
      * @param filterString string representation of filter from HTTP-request
      *
@@ -64,6 +75,29 @@ export declare class OINODbSqlFilter {
      *
      */
     static combine(leftSide: OINODbSqlFilter | undefined, operation: OINODbSqlBooleanOperation, rightSide: OINODbSqlFilter | undefined): OINODbSqlFilter | undefined;
+    /**
+     * Combine two filters with an AND operation.
+     *
+     * @param leftSide left side filter
+     * @param rightSide right side filter
+     *
+     */
+    static and(leftSide: OINODbSqlFilter, rightSide: OINODbSqlFilter): OINODbSqlFilter | undefined;
+    /**
+     * Combine two filters with an OR operation.
+     *
+     * @param leftSide left side filter
+     * @param rightSide right side filter
+     *
+     */
+    static or(leftSide: OINODbSqlFilter, rightSide: OINODbSqlFilter): OINODbSqlFilter | undefined;
+    /**
+     * Negate a filter with a NOT operation.
+     *
+     * @param leftSide left side filter
+     *
+     */
+    static not(leftSide: OINODbSqlFilter): OINODbSqlFilter | undefined;
     private _operatorToSql;
     /**
      * Does filter contain any valid conditions.

package/dist/types/index.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { OINOContentType } from "@oino-ts/common";
 export { OINOContentType };
 export { OINO_ERROR_PREFIX, OINO_WARNING_PREFIX, OINO_INFO_PREFIX, OINO_DEBUG_PREFIX, OINOStr, OINOBenchmark, OINOMemoryBenchmark, OINOLog, OINOLogLevel, OINOConsoleLog, OINOResult, OINOHttpResult, OINOHtmlTemplate } from "@oino-ts/common";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/db",
-  "version": "0.13.2",
+  "version": "0.14.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,11 +19,11 @@
   "module": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
   "dependencies": {
-    "@oino-ts/common": "0.13.2",
+    "@oino-ts/common": "0.14.0",
     "oino-ts": "file:.."
   },
   "devDependencies": {
-    "@oino-ts/types": "0.13.2",
+    "@oino-ts/types": "0.14.0",
     "@types/bun": "^1.1.14",
     "@types/node": "^20.14.10",
     "typescript": "~5.9.0"

package/src/OINODbApi.test.ts

@@ -6,7 +6,7 @@
 
 import { expect, test } from "bun:test";
 
-import { OINODbApi, OINODbApiParams, OINOContentType, OINODataRow, OINODbDataField, OINOStringDataField, OINODb, OINODbFactory, OINODbParams, OINODbMemoryDataSet, OINODbModelSet, OINOBenchmark, OINOConsoleLog, OINODbSqlFilter, OINODbConfig, OINODbSqlOrder, OINOLogLevel, OINOLog, OINODbSqlLimit, OINODbApiResult, OINODbSqlComparison, OINONumberDataField, OINODatetimeDataField, OINODbApiRequestParams, OINODbHtmlTemplate, OINODbParser } from "./index.js";
+import { OINODbApi, OINODbApiParams, OINOContentType, OINODataRow, OINODbDataField, OINOStringDataField, OINODb, OINODbFactory, OINODbParams, OINODbMemoryDataSet, OINODbModelSet, OINOBenchmark, OINOConsoleLog, OINODbSqlFilter, OINODbConfig, OINODbSqlOrder, OINOLogLevel, OINOLog, OINODbSqlLimit, OINODbApiResult, OINODbSqlComparison, OINONumberDataField, OINODatetimeDataField, OINODbApiRequestParams, OINODbHtmlTemplate, OINODbParser, OINODbSqlBooleanOperation } from "./index.js";
 
 import { OINODbBunSqlite } from "@oino-ts/db-bunsqlite"
 import { OINODbPostgresql } from "@oino-ts/db-postgresql"
@@ -40,7 +40,13 @@ const API_TESTS:OINOTestParams[] = [
         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") }
+            sqlParams: { filter: OINODbSqlFilter.and(
+                    OINODbSqlFilter.parse("(ShipPostalCode)-like(0502%)"), 
+                    OINODbSqlFilter.parse("-isnull(ShipRegion)")
+                ), 
+                order: OINODbSqlOrder.parse("ShipPostalCode-,Freight+"), 
+                limit: OINODbSqlLimit.parse("5 page 2") 
+            }
         },
         postRow: [30000,"CACTU",1,new Date("2024-04-05"),new Date("2024-04-06"),new Date("2024-04-07"),2,"184.75","a'b\"c%d_e\tf\rg\nh\\i","Garden House Crowther Way","Cowes","British Isles","PO31 7PJ","UK"],
         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"]
@@ -49,7 +55,13 @@ const API_TESTS:OINOTestParams[] = [
         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") }
+            sqlParams: { filter: OINODbSqlFilter.and(
+                    OINODbSqlFilter.parse("(UnitsInStock)-le(5)"), 
+                    OINODbSqlFilter.parse("(UnitsInStock)-ne(4)"),
+                ), 
+                order: OINODbSqlOrder.parse("UnitsInStock,UnitPrice"), 
+                limit: OINODbSqlLimit.parse("7") 
+            }
         },
         postRow: [99, "Umeshu", 1, 1, "500 ml", 12.99, 2, 0, 20, 0],
         putRow: [99, "Umeshu", 1, 1, undefined, 24.99, 3, 0, 20, 0]

package/src/OINODbDataModel.ts

@@ -11,7 +11,7 @@ import { OINODbDataField, OINODbApi, OINODataRow, OINO_ERROR_PREFIX, OINODbDataF
  *
  */
 export class OINODbDataModel {
-    private _columnLookup:Record<string, number>;
+    private _fieldIndexLookup:Record<string, number>;
 
     /** Database refererence of the table */
     readonly api:OINODbApi 
@@ -27,7 +27,7 @@ export class OINODbDataModel {
      *
      */
     constructor(api:OINODbApi) {
-        this._columnLookup = {}
+        this._fieldIndexLookup = {}
         this.api = api
         this.fields = []
     }
@@ -122,7 +122,7 @@ export class OINODbDataModel {
      */
     addField(field:OINODbDataField) {
         this.fields.push(field)
-        this._columnLookup[field.name] = this.fields.length-1
+        this._fieldIndexLookup[field.name] = this.fields.length-1
     }
 
     /**
@@ -132,7 +132,7 @@ export class OINODbDataModel {
      *
      */
     findFieldByName(name:string):OINODbDataField|null {
-        const i:number = this._columnLookup[name]
+        const i:number = this._fieldIndexLookup[name]
         if (i >= 0) {
             return this.fields[i]
         } else {
@@ -147,7 +147,7 @@ export class OINODbDataModel {
      *
      */
     findFieldIndexByName(name:string):number {
-        const i:number = this._columnLookup[name]
+        const i:number = this._fieldIndexLookup[name]
         if (i >= 0) {
             return i
         } else {

package/src/OINODbModelSet.ts

@@ -329,15 +329,18 @@ export class OINODbModelSet {
 
     /**
      * 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():Promise<Record<string, any>> {
+    async exportAsRecord(idFieldName?:string):Promise<Record<string, any>> {
         const result:Record<string, any> = {}
+        const row_id_field = idFieldName || OINODbConfig.OINODB_ID_FIELD
         while (!this.dataset.isEof()) {
             const row_data:OINODataRow = this.dataset.getRow()
             const row_export = this._exportRow(row_data)
-            result[row_export[OINODbConfig.OINODB_ID_FIELD]] = row_export
+            const row_id = row_export[row_id_field]
+            result[row_id] = row_export
             await this.dataset.next()
         }
         return result

package/src/OINODbSqlParams.ts

@@ -18,7 +18,14 @@ export enum OINODbSqlBooleanOperation { and = "and", or = "or", not = "not" }
  * Supported logical conjunctions in filter predicates.
  * @enum
  */
-export enum OINODbSqlComparison { lt = "lt", le = "le", eq = "eq", ge = "ge", gt = "gt", like = "like" } 
+export enum OINODbSqlComparison { lt = "lt", le = "le", eq = "eq", ne = "ne", ge = "ge", gt = "gt", like = "like" } 
+
+/**
+ * Supported logical conjunctions in filter predicates.
+ * @enum
+ */
+export enum OINODbSqlNullCheck { isnull = "isnull", isnotnull = "isnotnull" } 
+
 
 /**
  * Class for recursively parsing of filters and printing them as SQL conditions. 
@@ -31,12 +38,13 @@ export enum OINODbSqlComparison { lt = "lt", le = "le", eq = "eq", ge = "ge", gt
  */
 export class OINODbSqlFilter {
     private static _booleanOperationRegex = /^\s?\-(and|or)\s?$/i
-    private static _negationRegex = /^-(not|)\((.+)\)$/i
-    private static _filterComparisonRegex = /^\(([^'"\(\)]+)\)\s?\-(lt|le|eq|ge|gt|like)\s?\(([^'"\(\)]+)\)$/i
+    private static _negationRegex = /^-(not)\((.+)\)$/i
+    private static _filterComparisonRegex = /^\(([^'"\(\)]+)\)\s?\-(lt|le|eq|ne|ge|gt|like)\s?\(([^'"\(\)]+)\)$/i
+    private static _filterNullCheckRegex = /^-(isnull|isnotnull)\((.+)\)$/i
     
     private _leftSide: OINODbSqlFilter | string
     private _rightSide: OINODbSqlFilter | string
-    private _operator:OINODbSqlComparison|OINODbSqlBooleanOperation|null
+    private _operator:OINODbSqlComparison|OINODbSqlBooleanOperation|OINODbSqlNullCheck|null
 
     /**
      * Constructor of `OINODbSqlFilter`
@@ -44,11 +52,12 @@ export class OINODbSqlFilter {
      * @param operation operation of the filter, either `OINODbSqlComparison` or `OINODbSqlBooleanOperation`
      * @param rightSide right side of the filter, either another filter or a value
      */
-    constructor(leftSide:OINODbSqlFilter|string, operation:OINODbSqlComparison|OINODbSqlBooleanOperation|null, rightSide:OINODbSqlFilter|string) {
+    constructor(leftSide:OINODbSqlFilter|string, operation:OINODbSqlComparison|OINODbSqlBooleanOperation|OINODbSqlNullCheck|null, rightSide:OINODbSqlFilter|string) {
         if (!(
             ((operation === null) && (leftSide == "") && (rightSide == "")) ||
             ((operation !== null) && (Object.values(OINODbSqlComparison).includes(operation as OINODbSqlComparison)) && (typeof(leftSide) == "string") && (leftSide != "") && (typeof(rightSide) == "string") && (rightSide != "")) ||
             ((operation == OINODbSqlBooleanOperation.not) && (leftSide == "") && (rightSide instanceof OINODbSqlFilter)) ||
+            (((operation == OINODbSqlNullCheck.isnull) || (operation == OINODbSqlNullCheck.isnotnull)) && (typeof(leftSide) == "string") && (rightSide == "")) ||
             (((operation == OINODbSqlBooleanOperation.and) || (operation == OINODbSqlBooleanOperation.or)) && (leftSide instanceof OINODbSqlFilter) && (rightSide instanceof OINODbSqlFilter))
         )) {
             OINOLog.error("@oino-ts/db", "OINODbSqlFilter", "constructor", "Unsupported OINODbSqlFilter format", {leftSide:leftSide, operation:operation, rightSide:rightSide})
@@ -66,6 +75,7 @@ export class OINODbSqlFilter {
      * - comparison: (field)-lt|le|eq|ge|gt|like(value)
      * - negation: -not(filter)
      * - conjunction/disjunction: (filter)-and|or(filter)
+     * - null check: -isnull(field) or -isnotnull(field)
      * 
      * @param filterString string representation of filter from HTTP-request
      *
@@ -76,20 +86,28 @@ export class OINODbSqlFilter {
 
         } else {
             let match = OINODbSqlFilter._filterComparisonRegex.exec(filterString)
-            if (match != null) {
+            if ((match != null) && (match.length == 4)) {
                 return new OINODbSqlFilter(match[1], match[2].toLowerCase() as OINODbSqlComparison, match[3])
+
             } else {
                 let match = OINODbSqlFilter._negationRegex.exec(filterString)
                 if (match != null) {
                     return new OINODbSqlFilter("", OINODbSqlBooleanOperation.not, OINODbSqlFilter.parse(match[3]))
+
                 } else {
                     let boolean_parts = OINOStr.splitByBrackets(filterString, true, false, '(', ')')
                     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]))
-        
+
                     } else {
-                        OINOLog.error("@oino-ts/db", "OINODbSqlFilter", "constructor", "Invalid filter", {filterString:filterString})
-                        throw new Error(OINO_ERROR_PREFIX + ": Invalid filter '" + filterString + "'") // invalid filter could be a security risk, stop processing
+                        let match = OINODbSqlFilter._filterNullCheckRegex.exec(filterString)
+                        if ((match != null)) {
+                            return new OINODbSqlFilter(match[2], match[1].toLowerCase() as OINODbSqlComparison, "")
+
+                        } else {
+                            OINOLog.error("@oino-ts/db", "OINODbSqlFilter", "constructor", "Invalid filter", {filterString:filterString})
+                            throw new Error(OINO_ERROR_PREFIX + ": Invalid filter '" + filterString + "'") // invalid filter could be a security risk, stop processing
+                        }
                     }                
                 }            
             }
@@ -119,6 +137,53 @@ export class OINODbSqlFilter {
         }
     }
 
+    /**
+     * Combine two filters with an AND operation.
+     *
+     * @param leftSide left side filter
+     * @param rightSide right side filter
+     *
+     */
+    static and(leftSide:OINODbSqlFilter, rightSide:OINODbSqlFilter):OINODbSqlFilter|undefined {
+        if ((leftSide) && (!leftSide.isEmpty()) && (rightSide) && (!rightSide.isEmpty())) {
+            return new OINODbSqlFilter(leftSide, OINODbSqlBooleanOperation.and, rightSide)
+
+        } else {
+            return undefined
+        }
+    }
+
+    /**
+     * Combine two filters with an OR operation.
+     *
+     * @param leftSide left side filter
+     * @param rightSide right side filter
+     *
+     */
+    static or(leftSide:OINODbSqlFilter, rightSide:OINODbSqlFilter):OINODbSqlFilter|undefined {
+        if ((leftSide) && (!leftSide.isEmpty()) && (rightSide) && (!rightSide.isEmpty())) {
+            return new OINODbSqlFilter(leftSide, OINODbSqlBooleanOperation.or, rightSide)
+
+        } else {
+            return undefined
+        }
+    }
+
+    /**
+     * Negate a filter with a NOT operation.
+     *
+     * @param leftSide left side filter
+     *
+     */
+    static not(leftSide:OINODbSqlFilter):OINODbSqlFilter|undefined {
+        if ((leftSide) && (!leftSide.isEmpty())) {
+            return new OINODbSqlFilter(leftSide, OINODbSqlBooleanOperation.not, "")
+
+        } else {
+            return undefined
+        }
+    }
+
 
     private _operatorToSql():string {
         switch (this._operator) {
@@ -128,9 +193,12 @@ export class OINODbSqlFilter {
             case "lt": return " < "
             case "le": return " <= "
             case "eq": return " = "
+            case "ne": return " != "
             case "ge": return " >= "
             case "gt": return " > "
             case "like": return " LIKE "
+            case "isnull": return " IS NULL"
+            case "isnotnull": return " IS NOT NULL"
         }
         return " "
     }
@@ -168,6 +236,8 @@ export class OINODbSqlFilter {
         result += this._operatorToSql()
         if (this._rightSide instanceof OINODbSqlFilter) {
             result += this._rightSide.toSql(dataModel)
+        } else if (this._operator == OINODbSqlNullCheck.isnull || this._operator == OINODbSqlNullCheck.isnotnull) {
+            // nothing to do, IS NULL and IS NOT NULL do not have a right side
         } else {
             const value = field!.deserializeCell(this._rightSide)
             if ((value == null) || (value === "")) {