@oino-ts/db 0.5.2 → 0.6.1

package/dist/cjs/OINODb.js

@@ -16,13 +16,15 @@ class OINODb {
     _params;
     /** Name of the database */
     name;
+    isConnected = false;
+    isValidated = false;
     /**
      * Constructor for `OINODb`.
      * @param params database parameters
      */
     constructor(params) {
-        this._params = params;
-        this.name = params.database;
+        this._params = { ...params }; // make a shallow copy of params so that changes to them do not affect the original object
+        this.name = this._params.database;
     }
     /**
      * Print SQL select statement with DB specific formatting.

package/dist/cjs/OINODbFactory.js

@@ -29,7 +29,7 @@ class OINODbFactory {
      *
      * @param params database connection parameters
      */
-    static async createDb(params) {
+    static async createDb(params, connect = true, validate = true) {
         let result;
         let db_type = this._dbRegistry[params.type];
         if (db_type) {
@@ -38,7 +38,18 @@ class OINODbFactory {
         else {
             throw new Error("Unsupported database type: " + params.type);
         }
-        await result.connect();
+        if (connect) {
+            const connect_res = await result.connect();
+            if (connect_res.success == false) {
+                throw new Error("Database connection failed: " + connect_res.statusMessage);
+            }
+        }
+        if (validate) {
+            const validate_res = await result.validate();
+            if (validate_res.success == false) {
+                throw new Error("Database validation failed: " + validate_res.statusMessage);
+            }
+        }
         return result;
     }
     /**

package/dist/cjs/OINODbSqlParams.js

@@ -412,7 +412,7 @@ class OINODbSqlAggregate {
                 result += f.printSqlColumnName() + ",";
             }
         }
-        index_js_1.OINOLog.debug("OINODbSqlAggregate.toSql", { result: result });
+        // OINOLog.debug("OINODbSqlAggregate.toSql", {result:result})
         return result.substring(0, result.length - 1);
     }
     /**

package/dist/esm/OINODb.js

@@ -13,13 +13,15 @@ export class OINODb {
     _params;
     /** Name of the database */
     name;
+    isConnected = false;
+    isValidated = false;
     /**
      * Constructor for `OINODb`.
      * @param params database parameters
      */
     constructor(params) {
-        this._params = params;
-        this.name = params.database;
+        this._params = { ...params }; // make a shallow copy of params so that changes to them do not affect the original object
+        this.name = this._params.database;
     }
     /**
      * Print SQL select statement with DB specific formatting.

package/dist/esm/OINODbFactory.js

@@ -26,7 +26,7 @@ export class OINODbFactory {
      *
      * @param params database connection parameters
      */
-    static async createDb(params) {
+    static async createDb(params, connect = true, validate = true) {
         let result;
         let db_type = this._dbRegistry[params.type];
         if (db_type) {
@@ -35,7 +35,18 @@ export class OINODbFactory {
         else {
             throw new Error("Unsupported database type: " + params.type);
         }
-        await result.connect();
+        if (connect) {
+            const connect_res = await result.connect();
+            if (connect_res.success == false) {
+                throw new Error("Database connection failed: " + connect_res.statusMessage);
+            }
+        }
+        if (validate) {
+            const validate_res = await result.validate();
+            if (validate_res.success == false) {
+                throw new Error("Database validation failed: " + validate_res.statusMessage);
+            }
+        }
         return result;
     }
     /**

package/dist/esm/OINODbSqlParams.js

@@ -406,7 +406,7 @@ export class OINODbSqlAggregate {
                 result += f.printSqlColumnName() + ",";
             }
         }
-        OINOLog.debug("OINODbSqlAggregate.toSql", { result: result });
+        // OINOLog.debug("OINODbSqlAggregate.toSql", {result:result})
         return result.substring(0, result.length - 1);
     }
     /**

package/dist/types/OINODb.d.ts

@@ -1,4 +1,4 @@
-import { OINODbParams, OINODbApi, OINODataCell, OINODataRow } from "./index.js";
+import { OINODbParams, OINODbApi, OINODataCell, OINODataRow, OINOResult } from "./index.js";
 /**
  * Base class for database abstraction, implementing methods for connecting, making queries and parsing/formatting data
  * between SQL and serialization formats.
@@ -8,6 +8,8 @@ export declare abstract class OINODb {
     protected _params: OINODbParams;
     /** Name of the database */
     readonly name: string;
+    protected isConnected: boolean;
+    protected isValidated: boolean;
     /**
      * Constructor for `OINODb`.
      * @param params database parameters
@@ -17,7 +19,12 @@ export declare abstract class OINODb {
      * Connect to database.
      *
      */
-    abstract connect(): Promise<boolean>;
+    abstract connect(): Promise<OINOResult>;
+    /**
+     * Validate connection to database is working.
+     *
+     */
+    abstract validate(): Promise<OINOResult>;
     /**
      * Print a table name using database specific SQL escaping.
      *

package/dist/types/OINODbFactory.d.ts

@@ -18,7 +18,7 @@ export declare class OINODbFactory {
      *
      * @param params database connection parameters
      */
-    static createDb(params: OINODbParams): Promise<OINODb>;
+    static createDb(params: OINODbParams, connect?: boolean, validate?: boolean): Promise<OINODb>;
     /**
      * Create API from parameters and calls initDatamodel on the datamodel.
      *

package/package.json

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

package/src/OINODb.ts

@@ -4,7 +4,7 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
-import { OINODbParams, OINODbApi, OINODataCell, OINO_ERROR_PREFIX, OINODataRow, OINODB_EMPTY_ROW } from "./index.js"
+import { OINODbParams, OINODbApi, OINODataCell, OINO_ERROR_PREFIX, OINODataRow, OINODB_EMPTY_ROW, OINOResult } from "./index.js"
 
 /**
  * Base class for database abstraction, implementing methods for connecting, making queries and parsing/formatting data 
@@ -18,20 +18,29 @@ export abstract class OINODb {
     /** Name of the database */
     readonly name:string
 
+    protected isConnected:boolean = false
+    protected isValidated:boolean = false
+
     /**
      * Constructor for `OINODb`.
      * @param params database parameters
      */
     constructor(params:OINODbParams) {
-        this._params = params
-        this.name = params.database
+        this._params = { ...params } // make a shallow copy of params so that changes to them do not affect the original object
+        this.name = this._params.database
     }
 
     /**
      * Connect to database.
      *
      */
-    abstract connect(): Promise<boolean>
+    abstract connect(): Promise<OINOResult>
+    
+    /**
+     * Validate connection to database is working. 
+     *
+     */
+    abstract validate(): Promise<OINOResult>
     
     /**
      * Print a table name using database specific SQL escaping.

package/src/OINODbApi.test.ts

@@ -12,7 +12,7 @@ import { OINODbBunSqlite } from "@oino-ts/db-bunsqlite"
 import { OINODbPostgresql } from "@oino-ts/db-postgresql"
 import { OINODbMariadb } from "@oino-ts/db-mariadb"
 import { OINODbMsSql } from "@oino-ts/db-mssql"
-import { OINODbSqlAggregate } from "./OINODbSqlParams.js";
+import { OINODbSqlAggregate, OINODbSqlSelect } from "./OINODbSqlParams.js";
 
 const OINODB_POSTGRESQL_TOKEN = process.env.OINODB_POSTGRESQL_TOKEN || console.error("OINODB_POSTGRESQL_TOKEN not set") || ""
 const OINODB_MARIADB_TOKEN = process.env.OINODB_MARIADB_TOKEN || console.error("OINODB_MARIADB_TOKEN not set") || ""
@@ -67,7 +67,7 @@ const api_tests:OINOTestParams[] = [
         name: "API 4",
         apiParams: { apiName: "OrderDetails", tableName: "OrderDetails" },
         requestParams: {
-            sqlParams: { aggregate: OINODbSqlAggregate.parse("count(ProductID),avg(UnitPrice),sum(Quantity),max(Discount)") }
+            sqlParams: { aggregate: OINODbSqlAggregate.parse("count(OrderID),count(ProductID),avg(UnitPrice),sum(Quantity)"), select: OINODbSqlSelect.parse("OrderID,ProductID,UnitPrice,Quantity,Discount"), order: OINODbSqlOrder.parse("Discount asc") }
         },
         postRow: [10249,77,12.34,56,0],
         putRow: [10249,77,23.45,67,0]
@@ -140,9 +140,38 @@ function createApiTemplate(api:OINODbApi):OINODbHtmlTemplate {
 
 export async function OINOTestApi(dbParams:OINODbParams, testParams: OINOTestParams) {
     // OINOLog.info("OINOTestApi", {dbParams:dbParams, apiDataset:apiDataset})
+
+    let target_name:string = ""
+    if (testParams.name) {
+        target_name = "[" + testParams.name + "]"
+    } 
+    const target_db:string = "[" + dbParams.type + "]"
+    let target_table:string = "[" + testParams.apiParams.tableName + "]"
+    let target_group:string = "[CONNECTION]"
+
+    if (dbParams.type != "OINODbBunSqlite") { // no passwords in BunSqlite, it will never fail
+        const wrong_pwd_params:OINODbParams = Object.assign({}, dbParams)
+        wrong_pwd_params.password = "WRONG_PASSWORD"
+        const wrong_pwd_db:OINODb = await OINODbFactory.createDb( wrong_pwd_params, false, false )
+        test(target_name + target_db + target_table + target_group + " connection error", async () => {
+            expect(wrong_pwd_db).toBeDefined()
+
+            const connect_res = await wrong_pwd_db.connect()
+            expect(connect_res.success).toBe(false)
+            expect(connect_res.statusMessage).toMatchSnapshot("CONNECTION ERROR")
+        })
+    }
+
+    // const db:OINODb = await OINODbFactory.createDb( dbParams )
     const db:OINODb = await OINODbFactory.createDb( dbParams )
+    test(target_name + target_db + target_table + target_group + " connection success", async () => {
+        expect(db).toBeDefined()
+        expect(db.isConnected).toBe(true)
+        expect(db.isValidated).toBe(true)
+    })
+
     const api:OINODbApi = await OINODbFactory.createApi(db, testParams.apiParams)
-    
+
     const post_dataset:OINODbMemoryDataSet = new OINODbMemoryDataSet([testParams.postRow])
     const post_modelset:OINODbModelSet = new OINODbModelSet(api.datamodel, post_dataset)
     
@@ -160,18 +189,11 @@ export async function OINOTestApi(dbParams:OINODbParams, testParams: OINOTestPar
     request_params_with_filters.sqlParams = testParams.requestParams.sqlParams
     // OINOLog.debug("OINOTestApi", {request_params:request_params, request_params_with_filters:request_params_with_filters})
     
-    let target_name:string = ""
-    if (testParams.name) {
-        target_name = "[" + testParams.name + "]"
-    } 
-    const target_db:string = "[" + dbParams.type + "]"
-    let target_table:string = "[" + testParams.apiParams.tableName + "]"
-    let target_group:string = "[SCHEMA]"
-
     // test("dummy", () => {
     //     expect({foo:"h\\i"}).toMatchSnapshot()
     // })
 
+    target_group = "[SCHEMA]"
     test(target_name + target_db + target_table + target_group + " public properties", async () => {
         expect(api.datamodel.printFieldPublicPropertiesJson()).toMatchSnapshot("SCHEMA")
     })

package/src/OINODbFactory.ts

@@ -31,7 +31,7 @@ export class OINODbFactory {
      * 
      * @param params database connection parameters
      */
-    static async createDb(params:OINODbParams):Promise<OINODb> {
+    static async createDb(params:OINODbParams, connect:boolean = true, validate:boolean = true):Promise<OINODb> {
         let result:OINODb
         let db_type = this._dbRegistry[params.type]
         if (db_type) {
@@ -39,10 +39,22 @@ export class OINODbFactory {
         } else {
             throw new Error("Unsupported database type: " + params.type)
         }
-        await result.connect()
+        if (connect) {
+            const connect_res = await result.connect()
+            if (connect_res.success == false) {
+                throw new Error("Database connection failed: " + connect_res.statusMessage)
+            }
+        }
+        if (validate) {
+            const validate_res = await result.validate()
+            if (validate_res.success == false) {
+                throw new Error("Database validation failed: " + validate_res.statusMessage)
+            }
+        }
         return result
     }
 
+
     /**
      * Create API from parameters and calls initDatamodel on the datamodel.
      * 

package/src/OINODbSqlParams.ts

@@ -411,7 +411,7 @@ export class OINODbSqlAggregate {
                 result += f.printSqlColumnName() + ","
             }
         }
-        OINOLog.debug("OINODbSqlAggregate.toSql", {result:result})
+        // OINOLog.debug("OINODbSqlAggregate.toSql", {result:result})
         return result.substring(0, result.length-1)
     }