@oino-ts/db 0.17.1 → 0.17.2

package/src/OINODbDataField.ts

@@ -1,403 +1,403 @@
-/*
- * 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, OINOLog, OINO_ERROR_PREFIX } 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
-    }
-
-    /**
-     * 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.isForeignKey) {
-            params += "FK ";
-        }
-        if (this.fieldParams.isAutoInc) {
-            params += "AUTOINC ";
-        }
-        if (this.fieldParams.isNotNull) {
-            params += "NOTNUL ";
-        }
-        if (params != "") {
-            params = "{" + params.trim() + "}";
-        }
-        if (this.maxLength > 0) {
-            params = this.sqlType + "(" + this.maxLength + ")" + params
-        } else {
-            params = this.sqlType + params
-        }
-        const name_length: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 === undefined) { 
-            return undefined
-        } else if ((value === "") || (value === null)) {
-            return null
-        } else {
-            const result:number = parseFloat(value)
-            if (isNaN(result)) {
-                OINOLog.error("@oino-ts/db", "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
-        }
-    }
-}
-
-/**
- * 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 {
-        // console.log("OINOBlobDataField.serializeCell: cellVal", cellVal, typeof(cellVal))
-        if ((cellVal === null) || (cellVal === undefined))  {
-            return cellVal
-
-        } else if (cellVal instanceof Buffer) {
-            return cellVal.toString('base64')
-
-        } else if (cellVal instanceof Uint8Array) {
-            return Buffer.from(cellVal).toString('base64')
-
-        } else {
-            return this.db.parseSqlValueAsCell(cellVal, this.sqlType)?.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 Buffer.alloc(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 {
-        if (typeof(cellVal) == "string") {
-            cellVal = this.db.parseSqlValueAsCell(cellVal, this.sqlType)
-        }
-        if ((cellVal === null) || (cellVal === undefined))  {
-            return cellVal
-            
-        } else if (cellVal instanceof Date) {
-            return cellVal.toISOString()
-
-        } else {
-            return cellVal.toString()
-        }
-    }
-
-    /**
-     * Serialize cell value in the given content format.
-     * 
-     * @param cellVal cell value
-     * @param locale locale-object to format datetimes with
-     *
-     */
-    serializeCellWithLocale(cellVal: OINODataCell, locale:Intl.DateTimeFormat): string|null|undefined {
-        if (typeof(cellVal) == "string") {
-            cellVal = this.db.parseSqlValueAsCell(cellVal, this.sqlType)
-        }
-        if ((cellVal === null) || (cellVal === undefined))  {
-            return cellVal
-            
-        } else if (cellVal instanceof Date) {
-            return locale.format(cellVal)
-
-        } 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) || (value === undefined)) {
-            return value
-        } else {
-            return new Date(value)
-        }        
-    }
-    
-}
+/*
+ * 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, OINOLog, OINO_ERROR_PREFIX } 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
+    }
+
+    /**
+     * 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.isForeignKey) {
+            params += "FK ";
+        }
+        if (this.fieldParams.isAutoInc) {
+            params += "AUTOINC ";
+        }
+        if (this.fieldParams.isNotNull) {
+            params += "NOTNUL ";
+        }
+        if (params != "") {
+            params = "{" + params.trim() + "}";
+        }
+        if (this.maxLength > 0) {
+            params = this.sqlType + "(" + this.maxLength + ")" + params
+        } else {
+            params = this.sqlType + params
+        }
+        const name_length: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 === undefined) { 
+            return undefined
+        } else if ((value === "") || (value === null)) {
+            return null
+        } else {
+            const result:number = parseFloat(value)
+            if (isNaN(result)) {
+                OINOLog.error("@oino-ts/db", "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
+        }
+    }
+}
+
+/**
+ * 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 {
+        // console.log("OINOBlobDataField.serializeCell: cellVal", cellVal, typeof(cellVal))
+        if ((cellVal === null) || (cellVal === undefined))  {
+            return cellVal
+
+        } else if (cellVal instanceof Buffer) {
+            return cellVal.toString('base64')
+
+        } else if (cellVal instanceof Uint8Array) {
+            return Buffer.from(cellVal).toString('base64')
+
+        } else {
+            return this.db.parseSqlValueAsCell(cellVal, this.sqlType)?.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 Buffer.alloc(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 {
+        if (typeof(cellVal) == "string") {
+            cellVal = this.db.parseSqlValueAsCell(cellVal, this.sqlType)
+        }
+        if ((cellVal === null) || (cellVal === undefined))  {
+            return cellVal
+            
+        } else if (cellVal instanceof Date) {
+            return cellVal.toISOString()
+
+        } else {
+            return cellVal.toString()
+        }
+    }
+
+    /**
+     * Serialize cell value in the given content format.
+     * 
+     * @param cellVal cell value
+     * @param locale locale-object to format datetimes with
+     *
+     */
+    serializeCellWithLocale(cellVal: OINODataCell, locale:Intl.DateTimeFormat): string|null|undefined {
+        if (typeof(cellVal) == "string") {
+            cellVal = this.db.parseSqlValueAsCell(cellVal, this.sqlType)
+        }
+        if ((cellVal === null) || (cellVal === undefined))  {
+            return cellVal
+            
+        } else if (cellVal instanceof Date) {
+            return locale.format(cellVal)
+
+        } 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) || (value === undefined)) {
+            return value
+        } else {
+            return new Date(value)
+        }        
+    }
+    
+}