@oino-ts/db 0.0.11

package/src/OINODbConfig.ts

@@ -0,0 +1,92 @@
+/** Set the name of the OINO ID field (default \_OINOID\_) */
+
+export class OINODbConfig {
+    /** Name of the synthetic OINO ID field */
+    static OINODB_ID_FIELD:string = "_OINOID_"
+    /** Private key separator of the synthetic OINO ID field */
+    static OINODB_ID_SEPARATOR:string = "_"
+    private static OINODB_ID_SEPARATOR_ESCAPED:string = "%"
+
+    /** Name of the OINODbSqlFilter-parameter in request */
+    static OINODB_SQL_FILTER_PARAM:string = "oinosqlfilter"
+
+    /** Name of the OINODbSqlOrder-parameter in request */
+    static OINODB_SQL_ORDER_PARAM:string = "oinosqlorder"
+
+    /** Name of the OINODbSqlLimit-parameter in request */
+    static OINODB_SQL_LIMIT_PARAM:string = "oinosqllimit"
+
+    /** 
+     * Set the name of the OINO ID field 
+     * @param idField name of the OINO ID field 
+     */
+    static setOinoIdField(idField: string) {
+        if (idField) {
+            OINODbConfig.OINODB_ID_FIELD = idField;
+        }
+    }
+
+    /** 
+     * Set the separator character of the OINO ID field 
+     * @param idSeparator character to use as separator of id parts
+    */
+    static setOinoIdSeparator(idSeparator: string) {
+        if (idSeparator && (idSeparator.length == 1)) {
+            OINODbConfig.OINODB_ID_SEPARATOR = idSeparator;
+            OINODbConfig.OINODB_ID_SEPARATOR_ESCAPED = '%' + idSeparator.charCodeAt(0).toString(16);
+        }
+    }
+
+    /**
+     * Print OINO ID for primary key values.
+     *
+     * @param primaryKeys an array of primary key values.
+     * 
+     */
+    static printOINOId(primaryKeys:string[]):string {
+        let result:string = ""
+        for (let i=0; i< primaryKeys.length; i++) {
+            if (i > 0) {
+                result += OINODbConfig.OINODB_ID_SEPARATOR
+            } 
+            result += encodeURIComponent(primaryKeys[i] as string).replaceAll(OINODbConfig.OINODB_ID_SEPARATOR, OINODbConfig.OINODB_ID_SEPARATOR_ESCAPED)
+        }
+        return result
+    }
+
+    /** 
+     * Set the name of the OINODbSqlFilter-param field 
+     * 
+     * @param sqlFilterParam name of the http parameter with `OINODbSqlFilter` definition
+     * 
+     */
+    static setOinoSqlFilterParam(sqlFilterParam: string) {
+        if (sqlFilterParam) {
+            OINODbConfig.OINODB_SQL_FILTER_PARAM = sqlFilterParam;
+        }
+    }
+
+    /** 
+     * Set the name of the OINODbSqlOrder-param field 
+     * 
+     * @param sqlOrderParam name of the http parameter with `OINODbSqlOrder` definition
+     * 
+     */
+    static setOinoSqlOrderParam(sqlOrderParam: string) {
+        if (sqlOrderParam) {
+            OINODbConfig.OINODB_SQL_ORDER_PARAM = sqlOrderParam;
+        }
+    }
+
+    /** 
+     * Set the name of the OINODbSqlLimit-param field 
+     * 
+     * @param sqlLimitParam name of the http parameter with `OINODbSqlLimit` definition
+     * 
+     */
+    static setOinoSqlLimitParam(sqlLimitParam: string) {
+        if (sqlLimitParam) {
+            OINODbConfig.OINODB_SQL_LIMIT_PARAM = sqlLimitParam;
+        }
+    }
+}

package/src/OINODbDataField.ts

@@ -0,0 +1,372 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+import { OINODbDataFieldParams, OINODataCell, OINODb } from "./index.js";
+
+/**
+ * Base class for a column of data responsible for appropriatelly serializing/deserializing the data.
+ *
+ */
+export class OINODbDataField {
+
+    /** OINODB reference*/
+    readonly db:OINODb;
+
+    /** Name of the field */
+    readonly name: string;
+
+    /** Internal type of field*/
+    readonly type: string;
+
+    /** SQL type of the field */
+    readonly sqlType: string;
+
+    /** Maximum length of the field (or 0) */
+    readonly maxLength: number;
+
+    /** Parameters for the field */
+    readonly fieldParams: OINODbDataFieldParams;
+
+    /**
+     * Constructor for a data field
+     * 
+     * @param db OINODb reference
+     * @param name name of the field
+     * @param type internal type of the field
+     * @param sqlType column type in database
+     * @param fieldParams parameters of the field
+     * @param maxLength maximum length of the field (or 0)
+     *
+     */
+    constructor(db:OINODb, name: string, type:string, sqlType: string, fieldParams: OINODbDataFieldParams, maxLength:number = 0) {
+        this.db = db
+        this.name = name
+        this.type = type
+        this.maxLength = maxLength
+        this.sqlType = sqlType
+        this.fieldParams = fieldParams
+        // OINOLog.debug("OINODbDataField.constructor", {this:this})
+    }
+
+    /**
+     * Pring debug information for the field
+     * 
+     * @param length length of the debug output (or 0 for as long as needed)
+     *
+     */
+    printColumnDebug(length:number = 0): string {
+        let params: string = "";
+        if (this.fieldParams.isPrimaryKey) {
+            params += "PK ";
+        }
+        if (this.fieldParams.isAutoInc) {
+            params += "AUTOINC ";
+        }
+        if (this.fieldParams.isNotNull) {
+            params += "NOTNUL ";
+        }
+        if (params != "") {
+            params = "{" + params.trim() + "}";
+        }
+        if (this.maxLength > 0) {
+            params = this.sqlType + "(" + this.maxLength + ")" + params
+        } else {
+            params = this.sqlType + params
+        }
+        const name_length:number = length - 2 - 1 - params.length
+        let result:string = this.name
+        if (length > 0) {
+            if (result.length > name_length) {
+                result = result.substring(0, name_length-2)+".."    
+            }
+            result = (result + ":" + params).padEnd(length-2, " ")
+        } else {
+            result = this.type + ":" + result + ":" + params
+        }
+        return "[" + result + "]";
+    }
+
+    /**
+     * Serialize cell value in the given content format.
+     * 
+     * @param cellVal cell value
+     *
+     */
+    serializeCell(cellVal: OINODataCell):string|null|undefined {
+        cellVal = this.db.parseSqlValueAsCell(cellVal, this.sqlType)
+        if ((cellVal === null) || (cellVal === undefined))  { 
+            return cellVal  // let content type encoder worry what to do with the value (so not force it to string)
+        } else {
+            return cellVal.toString()
+        }
+    }
+
+    /**
+     * Parce cell value from string using field type specific formatting rules.
+     * 
+     * @param value string value
+     *
+     */
+    deserializeCell(value: string|null|undefined): OINODataCell {
+        return value
+    }
+
+    /**
+     * Print data cell (from deserialization) as SQL-string.
+     * 
+     * @param cellVal cell value
+     *
+     */
+    printCellAsSqlValue(cellVal: OINODataCell):string {
+        return this.db.printCellAsSqlValue(cellVal, this.sqlType);
+    }
+
+    /**
+     * Print name of column as SQL.
+     * 
+     */
+    printSqlColumnName():string {
+        return this.db.printSqlColumnname(this.name)
+    }
+}
+
+/**
+ * Specialised class for a string column.
+ *
+ */
+export class OINOStringDataField extends OINODbDataField {
+
+    /**
+     * Constructor for a string data field
+     * 
+     * @param db OINODb reference
+     * @param name name of the field
+     * @param sqlType column type in database
+     * @param fieldParams parameters of the field
+     * @param maxLength maximum length of the field (or 0)
+     *
+     */
+    constructor(db:OINODb, name: string, sqlType: string, fieldParams: OINODbDataFieldParams, maxLength: number) {
+        super(db, name, "string", sqlType, fieldParams, maxLength)
+    }
+
+}
+
+/**
+ * Specialised class for a boolean column.
+ *
+ */
+export class OINOBooleanDataField extends OINODbDataField {
+
+    /**
+     * Constructor for a boolean data field
+     * 
+     * @param db OINODb reference
+     * @param name name of the field
+     * @param sqlType column type in database
+     * @param fieldParams parameters of the field
+     *
+     */
+    constructor(db:OINODb, name: string, sqlType: string, fieldParams: OINODbDataFieldParams) {
+        super(db, name, "boolean", sqlType, fieldParams)
+    }
+    /**
+     * Serialize cell value in the given content format.
+     * 
+     * @param cellVal cell value
+     *
+     */
+    serializeCell(cellVal: OINODataCell):string|null|undefined {
+        const parsed_value:string = (this.db.parseSqlValueAsCell(cellVal, this.sqlType) || "").toString()
+        let result:string
+        // console.log("OINOBooleanDataField.serializeCell: parsed_value=" + parsed_value)
+        if ((parsed_value == "") || (parsed_value.toLowerCase() == "false") || (parsed_value.match(/^0+$/))) {
+            result = "false"
+        } else {
+            result = "true"
+        }
+        return result
+    }
+
+    /**
+     * Parce cell value from string using field type specific formatting rules.
+     * 
+     * @param value string value
+     *
+     */
+    deserializeCell(value: string|null|undefined): OINODataCell {
+        if (value == null || value == "" || value.toString().toLowerCase() == "false" || value == "0") { // TODO: testaa poistaa .toString()
+            return false
+        } else {
+            return true
+        }
+    }
+}
+
+/**
+ * Specialised class for a number column.
+ *
+ */
+export class OINONumberDataField extends OINODbDataField {
+
+    /**
+     * Constructor for a string data field
+     * 
+     * @param db OINODb reference
+     * @param name name of the field
+     * @param sqlType column type in database
+     * @param fieldParams parameters of the field
+     *
+     */
+    constructor(db:OINODb, name: string, sqlType: string, fieldParams: OINODbDataFieldParams) {
+        super(db, name, "number", sqlType, fieldParams)
+    }
+
+    /**
+     * Serialize cell value in the given content format.
+     * 
+     * @param cellVal cell value
+     *
+     */
+    serializeCell(cellVal: OINODataCell):string|null|undefined {
+        let result:string|null
+        if ((cellVal === null) || (cellVal === undefined) || (cellVal === "")) {
+            result = null
+        } else {
+            result = cellVal.toString()
+        }
+        return result
+    }
+
+    /**
+     * Parce cell value from string using field type specific formatting rules.
+     * 
+     * @param value string value
+     *
+     */
+    deserializeCell(value: string|null|undefined): OINODataCell {
+        if (!value) { 
+            return 0
+        } else {
+            return Number.parseFloat(value)
+        }
+    }
+}
+
+/**
+ * Specialised class for a blob column.
+ *
+ */
+export class OINOBlobDataField extends OINODbDataField {
+
+    /**
+     * Constructor for a blob data field
+     * 
+     * @param db OINODb reference
+     * @param name name of the field
+     * @param sqlType column type in database
+     * @param fieldParams parameters of the field
+     * @param maxLength maximum length of the field (or 0)
+     *
+     */
+    constructor(db:OINODb, name: string, sqlType: string, fieldParams: OINODbDataFieldParams, maxLength:number) {
+        super(db, name, "blob", sqlType, fieldParams, maxLength)
+    }
+
+    /**
+     * Serialize cell value in the given content format.
+     * 
+     * @param cellVal cell value
+     *
+     */
+    serializeCell(cellVal: OINODataCell):string|null|undefined {
+        // OINOLog.debug("OINOBlobDataField.serializeCell", {cellVal:cellVal})
+        if ((cellVal === null) || (cellVal === undefined))  {
+            return cellVal
+
+        } else if (cellVal instanceof Uint8Array) {
+            return Buffer.from(cellVal).toString('base64')
+
+        } else {
+            return cellVal.toString()
+        }
+    }
+
+    /**
+     * Parce cell value from string using field type specific formatting rules.
+     * 
+     * @param value string value
+     *
+     */
+    deserializeCell(value: string|null|undefined): OINODataCell {
+        if (value == null) {
+            return new Buffer(0)
+
+        } else {
+            return Buffer.from(value, 'base64') // Blob-field data is base64 encoded and converted internally to UInt8Array / Buffer
+        }
+    }
+
+}
+
+/**
+ * Specialised class for a datetime column.
+ *
+ */
+export class OINODatetimeDataField extends OINODbDataField {
+
+    /**
+     * Constructor for a string data field
+     * 
+     * @param db OINODb reference
+     * @param name name of the field
+     * @param sqlType column type in database
+     * @param fieldParams parameters of the field
+     *
+     */
+    constructor(db:OINODb, name: string, sqlType: string, fieldParams: OINODbDataFieldParams) {
+        super(db, name, "datetime", sqlType, fieldParams)
+    }
+
+    /**
+     * Serialize cell value in the given content format.
+     * 
+     * @param cellVal cell value
+     *
+     */
+    serializeCell(cellVal: OINODataCell): string|null|undefined {
+        // OINOLog.debug("OINODatetimeDataField.serializeCell", {cellVal:cellVal, type:typeof(cellVal)})
+        if (typeof(cellVal) == "string") {
+            cellVal = this.db.parseSqlValueAsCell(cellVal, this.sqlType)
+            // OINOLog.debug("OINODatetimeDataField.serializeCell parsed", {cellVal:cellVal, type:typeof(cellVal)})
+        }
+        if ((cellVal === null) || (cellVal === undefined))  {
+            return cellVal
+            
+        } else if (cellVal instanceof Date) {
+            return cellVal.toISOString()
+
+        } else {
+            return cellVal.toString()
+        }
+    }
+
+    /**
+     * Parce cell value from string using field type specific formatting rules.
+     * 
+     * @param value string value
+     *
+     */
+    deserializeCell(value: string|null|undefined): OINODataCell {
+        // OINOLog.debug("OINODatetimeDataField.deserializeCell", {strVal:strVal})
+        if ((value === null) || (value === undefined)) {
+            return value
+        } else {
+            return new Date(value)
+        }        
+    }
+    
+}