@oino-ts/db 0.6.1 → 0.7.1

package/dist/esm/OINODbApi.js

@@ -153,6 +153,8 @@ export class OINODbHtmlTemplate extends OINOHtmlTemplate {
  *
  */
 export class OINODbApi {
+    /** Enable debug output on errors */
+    _debugOnError = false;
     /** API database reference */
     db;
     /** API datamodel */
@@ -184,7 +186,20 @@ export class OINODbApi {
             this.hashid = null;
         }
     }
-    _validateRowValues(httpResult, row, requirePrimaryKey) {
+    _printSql(result, rows, requirePrimaryKey, printer) {
+        let sql = "";
+        for (let i = 0; i < rows.length; i++) {
+            this._validateRow(result, rows[i], requirePrimaryKey);
+            if (result.success) {
+                sql += printer(rows[i]);
+            }
+            else if (this.params.failOnAnyInvalidRows === false) {
+                result.setOk(); // individual rows may fail and will just be messages in response similar to executing multiple sql statements
+            }
+        }
+        return sql;
+    }
+    _validateRow(result, row, requirePrimaryKey) {
         let field;
         for (let i = 0; i < this.datamodel.fields.length; i++) {
             field = this.datamodel.fields[i];
@@ -192,13 +207,13 @@ export class OINODbApi {
             const val = row[i];
             // OINOLog.debug("OINODbApi.validateHttpValues", {val:val})
             if ((val === null) && ((field.fieldParams.isNotNull) || (field.fieldParams.isPrimaryKey))) { // null is a valid SQL value except if it's not allowed
-                httpResult.setError(405, "Field '" + field.name + "' is not allowed to be NULL!", "ValidateRowValues");
+                result.setError(405, "Field '" + field.name + "' is not allowed to be NULL!", "ValidateRowValues");
             }
             else if ((val === undefined) && (requirePrimaryKey) && (field.fieldParams.isPrimaryKey) && (!field.fieldParams.isAutoInc)) {
-                httpResult.setError(405, "Primary key '" + field.name + "' is not autoinc and missing from the data!", "ValidateRowValues");
+                result.setError(405, "Primary key '" + field.name + "' is not autoinc and missing from the data!", "ValidateRowValues");
             }
             else if ((val !== undefined) && (this.params.failOnUpdateOnAutoinc) && (field.fieldParams.isAutoInc)) {
-                httpResult.setError(405, "Autoinc field '" + field.name + "' can't be updated!", "ValidateRowValues");
+                result.setError(405, "Autoinc field '" + field.name + "' can't be updated!", "ValidateRowValues");
             }
             else {
                 if ((field instanceof OINOStringDataField) && ((field.maxLength > 0))) {
@@ -206,10 +221,10 @@ export class OINODbApi {
                     // OINOLog.debug("OINODbApi.validateHttpValues", {f:str_field, val:val})
                     if (str_val.length > field.maxLength) {
                         if (this.params.failOnOversizedValues) {
-                            httpResult.setError(405, "Field '" + field.name + "' length (" + str_val.length + ") exceeds maximum (" + field.maxLength + ") and can't be set!", "ValidateRowValues");
+                            result.setError(405, "Field '" + field.name + "' length (" + str_val.length + ") exceeds maximum (" + field.maxLength + ") and can't be set!", "ValidateRowValues");
                         }
                         else {
-                            httpResult.addWarning("Field '" + field.name + "' length (" + str_val.length + ") exceeds maximum (" + field.maxLength + ") and might truncate or fail.", "ValidateRowValues");
+                            result.addWarning("Field '" + field.name + "' length (" + str_val.length + ") exceeds maximum (" + field.maxLength + ") and might truncate or fail.", "ValidateRowValues");
                         }
                     }
                 }
@@ -217,6 +232,21 @@ export class OINODbApi {
         }
         //logDebug("OINODbApi.validateHttpValues", {result:result})
     }
+    _parseData(httpResult, body, params) {
+        let rows = [];
+        try {
+            if (Array.isArray(body)) {
+                rows = body;
+            }
+            else {
+                rows = OINODbParser.createRows(this.datamodel, body, params);
+            }
+        }
+        catch (e) {
+            httpResult.setError(400, "Invalid data: " + e.message, "DoRequest");
+        }
+        return rows;
+    }
     async _doGet(result, id, params) {
         let sql = "";
         try {
@@ -240,27 +270,28 @@ export class OINODbApi {
     async _doPost(result, rows) {
         let sql = "";
         try {
-            let i = 0;
-            while (i < rows.length) {
-                this._validateRowValues(result, rows[i], this.params.failOnInsertWithoutKey || false);
+            for (let i = 0; i < rows.length; i++) {
+                this._validateRow(result, rows[i], this.params.failOnInsertWithoutKey || false);
                 if (result.success) {
                     sql += this.datamodel.printSqlInsert(rows[i]);
                 }
-                result.setOk(); // individual rows may fail and will just be messages in response similar to executing multiple sql statements
-                i++;
+                else if (this.params.failOnAnyInvalidRows == false) {
+                    result.setOk(); // individual rows may fail and will just be messages in response similar to executing multiple sql statements
+                }
             }
-            if (sql == "") {
+            if ((sql == "") && result.success) {
                 result.setError(405, "No valid rows for POST!", "DoPost");
-                result.addDebug("OINO POST DATA [" + rows.join("|") + "]", "DoPost");
             }
-            else {
+            else if (result.success) {
                 // OINOLog.debug("OINODbApi.doPost sql", {sql:sql})
                 const sql_res = await this.db.sqlExec(sql);
                 // OINOLog.debug("OINODbApi.doPost sql_res", {sql_res:sql_res})
                 if (sql_res.hasErrors()) {
                     result.setError(500, sql_res.getFirstError(), "DoPost");
-                    result.addDebug("OINO POST MESSAGES [" + sql_res.messages.join('|') + "]", "DoPost");
-                    result.addDebug("OINO POST SQL [" + sql + "]", "DoPost");
+                    if (this._debugOnError) {
+                        result.addDebug("OINO POST MESSAGES [" + sql_res.messages.join('|') + "]", "DoPost");
+                        result.addDebug("OINO POST SQL [" + sql + "]", "DoPost");
+                    }
                 }
             }
         }
@@ -269,19 +300,33 @@ export class OINODbApi {
             result.addDebug("OINO POST SQL [" + sql + "]", "DoPost");
         }
     }
-    async _doPut(result, id, row) {
+    async _doPut(result, id, rows) {
         let sql = "";
         try {
-            this._validateRowValues(result, row, false);
-            if (result.success) {
-                sql = this.datamodel.printSqlUpdate(id, row);
+            // this._validateRowValues(result, row, false)
+            for (let i = 0; i < rows.length; i++) {
+                const row_id = id || OINODbConfig.printOINOId(this.datamodel.getRowPrimarykeyValues(rows[i], this.hashid != null));
+                this._validateRow(result, rows[i], this.params.failOnInsertWithoutKey || false);
+                if (result.success) {
+                    sql += this.datamodel.printSqlUpdate(row_id, rows[i]);
+                }
+                else if (this.params.failOnAnyInvalidRows == false) {
+                    result.setOk(); // individual rows may fail and will just be messages in response similar to executing multiple sql statements
+                }
+            }
+            if ((sql == "") && result.success) {
+                result.setError(405, "No valid rows for PUT!", "DoPut"); // only set error if there are multiple rows and no valid sql was created
+            }
+            else if (result.success) {
                 // OINOLog.debug("OINODbApi.doPut sql", {sql:sql})
                 const sql_res = await this.db.sqlExec(sql);
                 // OINOLog.debug("OINODbApi.doPut sql_res", {sql_res:sql_res})
                 if (sql_res.hasErrors()) {
                     result.setError(500, sql_res.getFirstError(), "DoPut");
-                    result.addDebug("OINO PUT MESSAGES [" + sql_res.messages.join('|') + "]", "DoPut");
-                    result.addDebug("OINO PUT SQL [" + sql + "]", "DoPut");
+                    if (this._debugOnError) {
+                        result.addDebug("OINO PUT MESSAGES [" + sql_res.messages.join('|') + "]", "DoPut");
+                        result.addDebug("OINO PUT SQL [" + sql + "]", "DoPut");
+                    }
                 }
             }
         }
@@ -290,17 +335,37 @@ export class OINODbApi {
             result.addDebug("OINO POST SQL [" + sql + "]", "DoPut");
         }
     }
-    async _doDelete(result, id) {
+    async _doDelete(result, id, rows) {
         let sql = "";
         try {
-            sql = this.datamodel.printSqlDelete(id);
-            // OINOLog.debug("OINODbApi.doDelete sql", {sql:sql})
-            const sql_res = await this.db.sqlExec(sql);
-            // OINOLog.debug("OINODbApi.doDelete sql_res", {sql_res:sql_res})
-            if (sql_res.hasErrors()) {
-                result.setError(500, sql_res.getFirstError(), "DoDelete");
-                result.addDebug("OINO DELETE MESSAGES [" + sql_res.messages.join('|') + "]", "DoDelete");
-                result.addDebug("OINO DELETE SQL [" + sql + "]", "DoDelete");
+            if (rows != null) {
+                for (let i = 0; i < rows.length; i++) {
+                    const row_id = OINODbConfig.printOINOId(this.datamodel.getRowPrimarykeyValues(rows[i], this.hashid != null));
+                    if (row_id) {
+                        sql += this.datamodel.printSqlDelete(row_id);
+                    }
+                    else if (this.params.failOnAnyInvalidRows == false) {
+                        result.setOk(); // individual rows may fail and will just be messages in response similar to executing multiple sql statements
+                    }
+                }
+            }
+            else if (id) {
+                sql = this.datamodel.printSqlDelete(id);
+            }
+            if ((sql == "") && result.success) {
+                result.setError(405, "No valid rows for DELETE!", "DoDelete"); // only set error if there are multiple rows and no valid sql was created
+            }
+            else if (result.success) {
+                // OINOLog.debug("OINODbApi.doDelete sql", {sql:sql})
+                const sql_res = await this.db.sqlExec(sql);
+                // OINOLog.debug("OINODbApi.doDelete sql_res", {sql_res:sql_res})
+                if (sql_res.hasErrors()) {
+                    result.setError(500, sql_res.getFirstError(), "DoDelete");
+                    if (this._debugOnError) {
+                        result.addDebug("OINO DELETE MESSAGES [" + sql_res.messages.join('|') + "]", "DoDelete");
+                        result.addDebug("OINO DELETE SQL [" + sql + "]", "DoDelete");
+                    }
+                }
             }
         }
         catch (e) {
@@ -308,34 +373,31 @@ export class OINODbApi {
             result.addDebug("OINO DELETE SQL [" + sql + "]", "DoDelete");
         }
     }
+    /**
+     * Enable or disable debug output on errors.
+     *
+     * @param debugOnError true to enable debug output on errors, false to disable
+     */
+    setDebugOnError(debugOnError) {
+        this._debugOnError = debugOnError;
+    }
     /**
      * Method for handlind a HTTP REST request with GET, POST, PUT, DELETE corresponding to
      * SQL select, insert, update and delete.
      *
      * @param method HTTP verb (uppercase)
      * @param id URL id of the REST request
-     * @param body HTTP body data as either serialized string or unserialized JS object / OINODataRow-array
+     * @param data HTTP body data as either serialized string or unserialized JS object / OINODataRow-array
      * @param params HTTP URL parameters as key-value-pairs
      *
      */
-    async doRequest(method, id, body, params = API_EMPTY_PARAMS) {
+    async doRequest(method, id, data, params = API_EMPTY_PARAMS) {
         OINOBenchmark.start("OINODbApi", "doRequest");
         // OINOLog.debug("OINODbApi.doRequest enter", {method:method, id:id, body:body, params:params})
         let result = new OINODbApiResult(params);
         let rows = [];
         if ((method == "POST") || (method == "PUT")) {
-            try {
-                if (Array.isArray(body)) {
-                    rows = body;
-                }
-                else {
-                    rows = OINODbParser.createRows(this.datamodel, body, params);
-                }
-            }
-            catch (e) {
-                result.setError(400, "Invalid data: " + e.message, "DoRequest");
-            }
-            // OINOLog.debug("OINODbApi.doRequest - OINODataRow rows", {rows:rows})        
+            rows = this._parseData(result, data, params);
         }
         if (method == "GET") {
             await this._doGet(result, id, params);
@@ -349,7 +411,7 @@ export class OINODbApi {
             }
             else {
                 try {
-                    await this._doPut(result, id, rows[0]);
+                    await this._doPut(result, id, rows);
                 }
                 catch (e) {
                     result.setError(500, "Unhandled exception in HTTP PUT doRequest: " + e.message, "DoRequest");
@@ -379,7 +441,7 @@ export class OINODbApi {
             }
             else {
                 try {
-                    await this._doDelete(result, id);
+                    await this._doDelete(result, id, null);
                 }
                 catch (e) {
                     result.setError(500, "Unhandled exception in HTTP DELETE doRequest: " + e.message, "DoRequest");
@@ -387,11 +449,50 @@ export class OINODbApi {
             }
         }
         else {
-            result.setError(405, "Unsupported HTTP method '" + method + "'", "DoRequest");
+            result.setError(405, "Unsupported HTTP method '" + method + "' for REST request", "DoRequest");
         }
         OINOBenchmark.end("OINODbApi", "doRequest", method);
         return Promise.resolve(result);
     }
+    /**
+     * Method for handlind a HTTP REST request with GET, POST, PUT, DELETE corresponding to
+     * SQL select, insert, update and delete.
+     *
+     * @param method HTTP verb (uppercase)
+     * @param data HTTP body data as either serialized string or unserialized JS object / OINODataRow-array
+     * @param params HTTP URL parameters as key-value-pairs
+     *
+     */
+    async doBatchUpdate(method, data, params = API_EMPTY_PARAMS) {
+        OINOBenchmark.start("OINODbApi", "doBatchUpdate");
+        // OINOLog.debug("OINODbApi.doRequest enter", {method:method, id:id, body:body, params:params})
+        let result = new OINODbApiResult(params);
+        let rows = [];
+        if ((method == "PUT")) {
+            rows = this._parseData(result, data, params);
+        }
+        if (method == "PUT") {
+            try {
+                await this._doPut(result, null, rows);
+            }
+            catch (e) {
+                result.setError(500, "Unhandled exception in HTTP PUT doRequest: " + e.message, "DoBatchUpdate");
+            }
+        }
+        else if (method == "DELETE") {
+            try {
+                await this._doDelete(result, null, rows);
+            }
+            catch (e) {
+                result.setError(500, "Unhandled exception in HTTP DELETE doRequest: " + e.message, "DoBatchUpdate");
+            }
+        }
+        else {
+            result.setError(405, "Unsupported HTTP method '" + method + "' for batch update", "DoBatchUpdate");
+        }
+        OINOBenchmark.end("OINODbApi", "doBatchUpdate", method);
+        return Promise.resolve(result);
+    }
     /**
      * Method to check if a field is included in the API params.
      *

package/dist/esm/OINODbDataModel.js

@@ -94,7 +94,12 @@ export class OINODbDataModel {
                 if ((f instanceof OINONumberDataField) && (this.api.hashid)) {
                     value = this.api.hashid.decode(value);
                 }
-                result += f.printSqlColumnName() + "=" + f.printCellAsSqlValue(value);
+                value = f.printCellAsSqlValue(value);
+                if (value == "") { // ids are user input and could be specially crafted to be empty
+                    throw new Error(OINO_ERROR_PREFIX + ": empty condition for id '" + id_value + "' for table " + this.api.params.tableName);
+                }
+                // OINOLog.debug("OINODbDataModel._printSqlPrimaryKeyCondition", {field:f.name, value:value, id_value:id_value})
+                result += f.printSqlColumnName() + "=" + value;
                 i = i + 1;
             }
         }
@@ -266,6 +271,7 @@ export class OINODbDataModel {
      */
     printSqlUpdate(id, row) {
         let result = "UPDATE " + this.api.db.printSqlTablename(this.api.params.tableName) + " SET " + this._printSqlUpdateValues(row) + " WHERE " + this._printSqlPrimaryKeyCondition(id) + ";";
+        // OINOLog.debug("OINODbDataModel.printSqlUpdate", {result:result, id:id, row:row})
         return result;
     }
     /**

package/dist/esm/OINODbFactory.js

@@ -25,6 +25,8 @@ export class OINODbFactory {
      * Create database from parameters from the registered classes.
      *
      * @param params database connection parameters
+     * @param connect if true, connects to the database
+     * @param validate if true, validates the database connection
      */
     static async createDb(params, connect = true, validate = true) {
         let result;

package/dist/types/OINODb.d.ts

@@ -139,6 +139,12 @@ export declare abstract class OINODbDataSet {
      *
      */
     abstract getRow(): OINODataRow;
+    /**
+     * Gets all rows of data.
+     *
+     * NOTE: This is left abstract instead of just using `getRow()` so that DB implementations can hopefully optimize not duplicating data     *
+     */
+    abstract getAllRows(): Promise<OINODataRow[]>;
     /**
      * Checks if the messages contain errors.
      *
@@ -187,6 +193,11 @@ export declare class OINODbMemoryDataSet extends OINODbDataSet {
      *
      */
     getRow(): OINODataRow;
+    /**
+     * Gets all rows of data.
+     *
+     */
+    getAllRows(): Promise<OINODataRow[]>;
     /**
      * Rewinds data set to the first row, returns !isEof().
      *

package/dist/types/OINODbApi.d.ts

@@ -1,3 +1,5 @@
+/// <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";
@@ -59,6 +61,8 @@ export declare class OINODbHtmlTemplate extends OINOHtmlTemplate {
  *
  */
 export declare class OINODbApi {
+    /** Enable debug output on errors */
+    private _debugOnError;
     /** API database reference */
     readonly db: OINODb;
     /** API datamodel */
@@ -76,22 +80,40 @@ export declare class OINODbApi {
      *
      */
     constructor(db: OINODb, params: OINODbApiParams);
-    private _validateRowValues;
+    private _printSql;
+    private _validateRow;
+    private _parseData;
     private _doGet;
     private _doPost;
     private _doPut;
     private _doDelete;
+    /**
+     * Enable or disable debug output on errors.
+     *
+     * @param debugOnError true to enable debug output on errors, false to disable
+     */
+    setDebugOnError(debugOnError: boolean): void;
     /**
      * Method for handlind a HTTP REST request with GET, POST, PUT, DELETE corresponding to
      * SQL select, insert, update and delete.
      *
      * @param method HTTP verb (uppercase)
      * @param id URL id of the REST request
-     * @param body HTTP body data as either serialized string or unserialized JS object / OINODataRow-array
+     * @param data HTTP body data as either serialized string or unserialized JS object / OINODataRow-array
+     * @param params HTTP URL parameters as key-value-pairs
+     *
+     */
+    doRequest(method: string, id: string, data: string | OINODataRow[] | Buffer | any, params?: OINODbApiRequestParams): Promise<OINODbApiResult>;
+    /**
+     * Method for handlind a HTTP REST request with GET, POST, PUT, DELETE corresponding to
+     * SQL select, insert, update and delete.
+     *
+     * @param method HTTP verb (uppercase)
+     * @param data HTTP body data as either serialized string or unserialized JS object / OINODataRow-array
      * @param params HTTP URL parameters as key-value-pairs
      *
      */
-    doRequest(method: string, id: string, body: string | OINODataRow[] | Buffer | any, params?: OINODbApiRequestParams): Promise<OINODbApiResult>;
+    doBatchUpdate(method: string, data: string | OINODataRow[] | Buffer | any, params?: OINODbApiRequestParams): Promise<OINODbApiResult>;
     /**
      * Method to check if a field is included in the API params.
      *

package/dist/types/OINODbFactory.d.ts

@@ -17,6 +17,8 @@ export declare class OINODbFactory {
      * Create database from parameters from the registered classes.
      *
      * @param params database connection parameters
+     * @param connect if true, connects to the database
+     * @param validate if true, validates the database connection
      */
     static createDb(params: OINODbParams, connect?: boolean, validate?: boolean): Promise<OINODb>;
     /**

package/dist/types/OINODbParser.d.ts

@@ -1,3 +1,5 @@
+/// <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/index.d.ts

@@ -1,3 +1,5 @@
+/// <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, OINOLog, OINOLogLevel, OINOConsoleLog, OINOResult, OINOHttpResult, OINOHtmlTemplate } from "@oino-ts/common";
@@ -26,6 +28,8 @@ export type OINODbApiParams = {
     failOnUpdateOnAutoinc?: boolean;
     /** Reject POST-requests without primary key value (can work if DB-side ) */
     failOnInsertWithoutKey?: boolean;
+    /** Reject POST-requests without primary key value (can work if DB-side ) */
+    failOnAnyInvalidRows?: 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) */
@@ -46,6 +50,7 @@ export type OINODbApiParams = {
 /**
  * Database class (constructor) type
  * @param dbParams database parameters
+ * @return OINODb instance
  */
 export type OINODbConstructor = new (dbParams: OINODbParams) => OINODb;
 /** Database parameters */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/db",
-  "version": "0.6.1",
+  "version": "0.7.1",
   "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.6.1"
+    "@oino-ts/common": "0.7.1"
   },
   "devDependencies": {
     "@types/node": "^20.14.10",
     "@types/bun": "^1.1.14",
-    "@oino-ts/types": "0.6.1",
+    "@oino-ts/types": "0.7.1",
     "typedoc": "^0.25.13"
   },
   "files": [

package/src/OINODb.ts

@@ -194,6 +194,13 @@ export abstract class OINODbDataSet {
      */
     abstract getRow(): OINODataRow;
 
+    /**
+     * Gets all rows of data. 
+     * 
+     * NOTE: This is left abstract instead of just using `getRow()` so that DB implementations can hopefully optimize not duplicating data     *
+     */
+    abstract getAllRows(): Promise<OINODataRow[]>;
+
     /**
      * Checks if the messages contain errors.
      *
@@ -294,6 +301,14 @@ export class OINODbMemoryDataSet extends OINODbDataSet {
         }
     }
 
+    /**
+     * Gets all rows of data.
+     *
+     */
+    async getAllRows(): Promise<OINODataRow[]> {
+        return this._rows // at the moment theres no result streaming, so we can just return the rows
+    }
+
     /**
      * Rewinds data set to the first row, returns !isEof().
      *