db-crud-api 0.3.9 → 0.3.11

package/CHANGELOG.md

@@ -45,3 +45,7 @@
 
     Bug fix:
         - autoId flag not onored
+## v0.3.11 (2025-10-25)
+
+    Added:
+        - testConnection()

package/README.md

@@ -60,6 +60,8 @@
     const apiOrderDetail = apiFactory.newFullApi("table2"); // full CRUD api
     const apiExecuteSP = apiFactory.newExecuteApi("db1.my_storeproc"); // execute my_storeproc
 
+    console.log(await apiFactory.testConnection()); // optional
+
     console.log(await apiOrder.getById("xxxxx-xxxxx-xxxxxxxxxxxx-xxxxxx"));
     console.log(await apiOrder.getById("xxxxx-xxxxx-xxxxxxxxxxxx-xxxxxx", {get: {fields: ["Id", "OrderNumber", "OrderTotal"]}}));
     console.log(await apiOrder.getByFilter({get: {filters: ["OrderType in ('P', 'A')", "and", "OrderDate > '2022-12-01'"]}}));   // get filterd rows

package/lib/api-factory.js

@@ -24,4 +24,8 @@ export function newBatchApi(useTransaction) {
 
 export function closeAllDbConnections() {
     return dbOpe.closeAllConnections();
+}
+
+export function testDbConnection() {
+    return dbOpe.testConnection();
 }

package/lib/db-operations.js

@@ -76,6 +76,16 @@ export function closeAllConnections() {
     return;
 }
 
+export function testConnection() {
+    const _connection = prepareConnection(prepareSchema("test", objectType.procedure));
+    // MSSQL
+    if (_connection.serverType === serverType.mssql) { return mssql.testConnection(_connection); }
+    // MySQL
+    if (_connection.serverType === serverType.mysql) { return mysql.testConnection(_connection); }
+    // server type not supported
+    throw new TypeError('server type not supported');
+}
+
 export function toStringValue(value) {
     if (!value) return 'null';
     if (value.trimStart().charAt(0) === '\'') return value;

package/lib/mssql.js

@@ -13,7 +13,7 @@ function stringifyValue(fieldName, value, tSchema) {
     if (value == undefined) { return 'null' }
     if (typeof value !== 'string' || value.trimStart().charAt(0) !== '[') {
         if (tSchema.table.fields && tSchema.table.fields[fieldName] && tSchema.table.fields[fieldName].type) {
-            if (tSchema.table.fields[fieldName].type == 'datetime') { 
+            if (tSchema.table.fields[fieldName].type == 'datetime') {
                 if (typeof value == 'datetime' || typeof value == 'object') return `\'${value.toISOString()}\'`;
                 if (typeof value == 'string' && value.trimStart().charAt(0) !== '\'' && value.trimStart().charAt(0) !== '\"') return `\'${value}\'`;
                 return value;
@@ -35,7 +35,7 @@ function stringifyValue(fieldName, value, tSchema) {
 export function prepareConnection(tSchema) {
     return {
         id: `${tSchema.server.realName}-${tSchema.database.realName}-${tSchema.server.user}`,
-        server: ((tSchema.server.instance && tSchema.server.instance != 'DEFAULT') ? (tSchema.server.realName + '\\' + tSchema.server.instance) : tSchema.server.realName)  ?? 'localhost',
+        server: ((tSchema.server.instance && tSchema.server.instance != 'DEFAULT') ? (tSchema.server.realName + '\\' + tSchema.server.instance) : tSchema.server.realName) ?? 'localhost',
         port: tSchema.server.port,
         user: tSchema.server.user,
         password: tSchema.server.password,
@@ -64,12 +64,31 @@ export async function closeAllConnections() {
         if (!pools.hasOwnProperty(poolId)) continue;
         let pool = pools[poolId];
         if (pool) {
-           await pool.close();  // wait pool is closed
-           pool = undefined;  // remove pool from pools
+            await pool.close();  // wait pool is closed
+            pool = undefined;  // remove pool from pools
         }
     }
 }
 
+// Test connection
+export async function testConnection(connection) {
+
+    let _connection;
+    try {
+        _connection = await sql.connect(connection);
+        return true;
+    }
+    catch (error) {
+        throw (error);
+    }
+    finally {
+        if (_connection) {
+            await _connection.close();
+        }
+    }
+
+}
+
 // Query
 export async function query(connection, dbOpes) {
 
@@ -77,8 +96,9 @@ export async function query(connection, dbOpes) {
     let pool = pools[connection.id];  // Try to get an existing pool
     if (!pool) {
         pool = new sql.ConnectionPool(connection);  // Create new pool
-        try { await pool.connect();  // wait that connection are made
-        } catch(err) { throw(err); } // using original error
+        try {
+            await pool.connect();  // wait that connection are made
+        } catch (err) { throw (err); } // using original error
         pools[connection.id] = pool;  // add new pool to pools
     }
 
@@ -104,7 +124,7 @@ export async function query(connection, dbOpes) {
 function normalizeSpecialName(name) {
     let _odd = false;  // interpreted as 0
     return name.replaceAll('\`', (_m) => {
-        _odd = !_odd; 
+        _odd = !_odd;
         if (_odd) return '[';
         else return ']';
     });
@@ -162,42 +182,42 @@ function getToSql(dbOpe, sqlRequest) {
 
     let result = 'select'
 
-    if ((dbOpe.get.options) && (Object.keys(dbOpe.get.options).length > 0)) {
-        if (Array.isArray(dbOpe.get.options)) { for (const s of dbOpe.get.options) { result += ' ' + replaceLIMITToTOP(s); }}
+    if (dbOpe.get.options && dbOpe.get.options.length > 0) {
+        if (Array.isArray(dbOpe.get.options)) { for (const s of dbOpe.get.options) { result += ' ' + replaceLIMITToTOP(s); } }
         else result += ' ' + replaceLIMITToTOP(dbOpe.get.options);
     }
 
-    if ((dbOpe.get.fields) && (Object.keys(dbOpe.get.fields).length > 0)) {
-        if (Array.isArray(dbOpe.get.fields)) result += ' '  + dbOpe.get.fields.join(',') 
+    if (dbOpe.get.fields && dbOpe.get.fields.length > 0) {
+        if (Array.isArray(dbOpe.get.fields)) result += ' ' + dbOpe.get.fields.join(',')
         else result += ' ' + dbOpe.get.fields;
     }
     else { throw new Error('fields is missing.'); }
 
     result += ' from ' + fullyQualifiedTableName(dbOpe.get.schema);
 
-    if ((dbOpe.get.filters) && (Object.keys(dbOpe.get.filters).length > 0)) {
+    if (dbOpe.get.filters && dbOpe.get.filters.length > 0) {
         if (Array.isArray(dbOpe.get.filters)) result += ' where ' + dbOpe.get.filters.join(' ');
         else result += ' where ' + dbOpe.get.filters;
     }
 
-    if ((dbOpe.get.groups) && (Object.keys(dbOpe.get.groups).length > 0)) {
+    if (dbOpe.get.groups && dbOpe.get.groups.length > 0) {
         if (Array.isArray(dbOpe.get.groups)) result += ' group by ' + dbOpe.get.groups.join(', ');
         else result += ' group by ' + dbOpe.get.groups;
     }
 
-    if ((dbOpe.get.groupsFilters) && (Object.keys(dbOpe.get.groupsFilters).length > 0)) {
+    if (dbOpe.get.groupsFilters && dbOpe.get.groupsFilters.length > 0) {
         if (Array.isArray(dbOpe.get.groupsFilters)) result += ' having ' + dbOpe.get.groupsFilters.join(' ');
         else result += ' having ' + dbOpe.get.groupsFilters;
     }
 
-    if ((dbOpe.get.orderBy) && (Object.keys(dbOpe.get.orderBy).length > 0)) {
+    if (dbOpe.get.orderBy && dbOpe.get.orderBy.length > 0) {
         if (Array.isArray(dbOpe.get.orderBy)) result += ' order by ' + dbOpe.get.orderBy.join(', ');
         else result += ' order by ' + dbOpe.get.orderBy;
     }
 
     if (dbOpe.get.params) addParams(dbOpe.get.params, sqlRequest);
 
-    result += ';' 
+    result += ';'
 
     return result;
 }
@@ -206,19 +226,19 @@ function getToSql(dbOpe, sqlRequest) {
 function patchToSql(dbOpe, sqlRequest) {
     let result = 'update ' + fullyQualifiedTableName(dbOpe.patch.schema);
 
-    if (dbOpe.patch.sets) { 
-        result += ' set ' + Object.entries(dbOpe.patch.sets).map(e => { return e[0] + '=' + stringifyValue(e[0], e[1], dbOpe.patch.schema) }).join(', '); 
+    if (dbOpe.patch.sets) {
+        result += ' set ' + Object.entries(dbOpe.patch.sets).map(e => { return e[0] + '=' + stringifyValue(e[0], e[1], dbOpe.patch.schema) }).join(', ');
     }
     else { throw new Error('sets is missing.'); }
 
-    if ((dbOpe.patch.filters) && (Object.keys(dbOpe.patch.filters).length > 0)) {
+    if (dbOpe.patch.filters && dbOpe.patch.filters.length > 0) {
         if (Array.isArray(dbOpe.patch.filters)) result += ' where ' + dbOpe.patch.filters.join(' ');
         else result += ' where ' + dbOpe.patch.filters;
     }
 
     if (dbOpe.patch.params) addParams(dbOpe.patch.params, sqlRequest);
 
-    result += ';' 
+    result += ';'
 
     return result;
 }
@@ -241,7 +261,7 @@ function putToSql(dbOpe, sqlRequest) {
 
     if (dbOpe.put.params) addParams(dbOpe.put.params, sqlRequest);
 
-    result += ';' 
+    result += ';'
 
     return result;
 }
@@ -250,14 +270,14 @@ function putToSql(dbOpe, sqlRequest) {
 function deleteToSql(dbOpe, sqlRequest) {
     let result = 'delete from ' + fullyQualifiedTableName(dbOpe.delete.schema);
 
-    if ((dbOpe.delete.filters) && (Object.keys(dbOpe.delete.filters).length > 0)) {
+    if (dbOpe.delete.filters && dbOpe.delete.filters.length > 0) {
         if (Array.isArray(dbOpe.delete.filters)) result += ' where ' + dbOpe.delete.filters.join(' ');
         else result += ' where ' + dbOpe.delete.filters;
     }
 
     if (dbOpe.delete.params) addParams(dbOpe.delete.params, sqlRequest);
 
-    result += ';' 
+    result += ';'
 
     return result;
 }
@@ -274,7 +294,7 @@ function executeToSql(dbOpe, sqlRequest) {
 
     if (dbOpe.execute.params) addParams(dbOpe.execute.params, sqlRequest);
 
-    result += ';' 
+    result += ';'
 
     return result;
 }

package/lib/mysql.js

@@ -71,6 +71,19 @@ export async function closeAllConnections() {
     }
 }
 
+// Test connection
+export async function testConnection(connection) {
+  try {
+    const _connection = await sql.createConnection(connection);
+    await _connection.end();
+    return true;
+  } 
+  catch (error) 
+  {
+    throw (error);
+  }
+}
+
 // Query
 export async function query(connection, dbOpes) {
 
@@ -168,14 +181,14 @@ function getToSql(dbOpe, sqlRequest) {
     let result = 'select'
 
     // omit 'limit' or 'top'
-    if ((dbOpe.get.options) && (Object.keys(dbOpe.get.options).length > 0)) {
+    if (dbOpe.get.options && dbOpe.get.options.length > 0) {
         if (Array.isArray(dbOpe.get.options)) {
             for (const s of dbOpe.get.options) { if (!containLIMIT(s) && !containTOP(s)) result += ' ' + s; }
         }
         else if (!containLIMIT(dbOpe.get.options) && !containTOP(dbOpe.get.options)) result += ' ' + dbOpe.get.options;
     }
 
-    if ((dbOpe.get.fields) && (Object.keys(dbOpe.get.fields).length > 0)) {
+    if (dbOpe.get.fields && dbOpe.get.fields.length > 0) {
         if (Array.isArray(dbOpe.get.fields)) result += ' ' + dbOpe.get.fields.join(',')
         else result += ' ' + dbOpe.get.fields;
     }
@@ -183,28 +196,28 @@ function getToSql(dbOpe, sqlRequest) {
 
     result += ' from ' + fullyQualifiedTableName(dbOpe.get.schema);
 
-    if ((dbOpe.get.filters) && (Object.keys(dbOpe.get.filters).length > 0)) {
+    if (dbOpe.get.filters && dbOpe.get.filters.length > 0) {
         if (Array.isArray(dbOpe.get.filters)) result += ' where ' + dbOpe.get.filters.join(' ');
         else result += ' where ' + dbOpe.get.filters;
     }
 
-    if ((dbOpe.get.groups) && (Object.keys(dbOpe.get.groups).length > 0)) {
+    if (dbOpe.get.groups && dbOpe.get.groups.length > 0) {
         if (Array.isArray(dbOpe.get.groups)) result += ' group by ' + dbOpe.get.groups.join(', ');
         else result += ' group by ' + dbOpe.get.groups;
     }
 
-    if ((dbOpe.get.groupsFilters) && (Object.keys(dbOpe.get.groupsFilters).length > 0)) {
+    if (dbOpe.get.groupsFilters && dbOpe.get.groupsFilters.length > 0) {
         if (Array.isArray(dbOpe.get.groupsFilters)) result += ' having ' + dbOpe.get.groupsFilters.join(' ');
         else result += ' having ' + dbOpe.get.groupsFilters;
     }
 
-    if ((dbOpe.get.orderBy) && (Object.keys(dbOpe.get.orderBy).length > 0)) {
+    if (dbOpe.get.orderBy && dbOpe.get.orderBy.length > 0) {
         if (Array.isArray(dbOpe.get.orderBy)) result += ' order by ' + dbOpe.get.orderBy.join(', ');
         else result += ' order by ' + dbOpe.get.orderBy;
     }
 
     // search if 'limit' or 'top'
-    if ((dbOpe.get.options) && (Object.keys(dbOpe.get.options).length > 0)) {
+    if (dbOpe.get.options && dbOpe.get.options.length > 0) {
         if (Array.isArray(dbOpe.get.options)) {
             for (const s of dbOpe.get.options) { if (containLIMIT(s) || containTOP(s)) result += ' ' + replaceTOPToLIMIT(s); }
         }
@@ -225,7 +238,7 @@ function patchToSql(dbOpe, sqlRequest) {
     if (dbOpe.patch.sets) { result += ' set ' + Object.entries(dbOpe.patch.sets).map(e => { return e[0] + '=' + stringifyValue(e[0], e[1], dbOpe.patch.schema) }).join(', '); }
     else { throw new Error('sets is missing.'); }
 
-    if ((dbOpe.patch.filters) && (Object.keys(dbOpe.patch.filters).length > 0)) {
+    if (dbOpe.patch.filters && dbOpe.patch.filters.length > 0) {
         if (Array.isArray(dbOpe.patch.filters)) result += ' where ' + dbOpe.patch.filters.join(' ');
         else result += ' where ' + dbOpe.patch.filters;
     }
@@ -264,7 +277,7 @@ function putToSql(dbOpe, sqlRequest) {
 function deleteToSql(dbOpe, sqlRequest) {
     let result = 'delete from ' + fullyQualifiedTableName(dbOpe.delete.schema);
 
-    if ((dbOpe.delete.filters) && (Object.keys(dbOpe.delete.filters).length > 0)) {
+    if (dbOpe.delete.filters && dbOpe.delete.filters.length > 0) {
         if (Array.isArray(dbOpe.delete.filters)) result += ' where ' + dbOpe.delete.filters.join(' ');
         else result += ' where ' + dbOpe.delete.filters;
     }
@@ -311,4 +324,4 @@ function addParams(params, sqlRequest) {
         }
     }
     return;
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "db-crud-api",
-  "version": "0.3.9",
+  "version": "0.3.11",
   "type": "module",
   "description": "CRUD api for database tables",
   "main": "index.js",
@@ -10,9 +10,9 @@
   "author": "FF",
   "license": "MIT",
   "dependencies": {
-    "mssql": "^11.0.1",
-    "mysql2": "^3.12.0",
-    "uuid": "^11.0.3"
+    "mssql": "^12.0.0",
+    "mysql2": "^3.15.3",
+    "uuid": "^11.1.0"
   },
   "keywords": [
     "db",

package/deploy

@@ -1,5 +0,0 @@
-##### publish npm package/module
-##### !!! pay attention to not publish files with secrets
-npm login
-npm publish
-npm unpublish db-crud-api@0.1.0