db-crud-api 0.2.2 → 0.3.1

package/lib/mysql.js

@@ -0,0 +1,278 @@
+'use strict';
+
+import sql from 'mysql2/promise';
+
+const pools = {};
+
+// Common
+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 (typeof value == 'datetime' || typeof value == 'object') return `\'${value.toISOString().slice(0, 19).replace('T', ' ')}\'`;
+                if (typeof value == 'string' && value.trimStart().charAt(0) !== '\'' && value.trimStart().charAt(0) !== '\"') return `\'${value}\'`;
+                return value;
+            }
+            if (tSchema.table.fields[fieldName].type == 'boolean' && typeof value == 'boolean') return `\'${value}\'`;
+            if (tSchema.table.fields[fieldName].type == 'string' && value.trimStart().charAt(0) !== '\'' && value.trimStart().charAt(0) !== '\"') return `\'${value}\'`;
+            if (tSchema.table.fields[fieldName].type == 'uuid' && value.trimStart().charAt(0) !== '\'' && value.trimStart().charAt(0) !== '\"') return `\'${value}\'`;
+        }
+        else {
+            // if (typeof value == 'datetime') return `\'${value.toISOString().slice(0, 19).replace('T', ' ')}\'`;
+            if (typeof value == 'boolean') return `\'${value}\'`;
+            if (typeof value == 'string' && value.trimStart().charAt(0) !== '\'' && value.trimStart().charAt(0) !== '\"') return `\'${value}\'`;
+        }
+    }
+    return value;
+}
+
+// Create config object for pool
+export function prepareConnection(tSchema) {
+    return {
+        id: `${tSchema.server.realName}-${tSchema.database.realName}-${tSchema.server.user}`,
+        host: ((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,
+        database: tSchema.database.realName,
+        ssl : {
+            rejectUnauthorized: false
+          },
+        multipleStatements: true,
+        connectionLimit: tSchema.server.connectionLimit
+    };
+};
+
+// Close connection
+export async function closeConnection(connection) {
+    let pool = pools[connection.id];
+    if (pool) {
+        pool.releaseConnection(); 
+        connection.end();
+        pools[connection.id] = undefined;  // remove pool from pools
+    }
+}
+
+// Close all connections
+export async function closeAllConnections() {
+    for (let poolId in pools) {
+        if (!pools.hasOwnProperty(poolId)) continue;
+        let pool = pools[poolId];
+        if (pool) {
+            pool.end();
+            pool = undefined;  // remove pool from pools
+        }
+    }
+}
+
+// Query
+export async function query(connection, dbOpes) {
+
+    // Prepare pool
+    let pool = pools[connection.id];  // Try to get an existing pool
+    if (!pool) {
+        pool = new sql.createPool(connection);  // Create new pool
+        pools[connection.id] = pool;  // add new pool to pools
+    }
+
+    // Prepare sql statement
+    let sqlString = '';
+    // if exists, input params will be added to request
+    if (Array.isArray(dbOpes)) dbOpes.forEach((dbOpe, index) => { sqlString += ToSql(dbOpe, pool); });
+    else sqlString += ToSql(dbOpes, pool);
+
+    // Run query
+    let sqlresult = undefined;
+    let sqlconn = undefined;
+    try { 
+        sqlconn = await pool.getConnection();
+        sqlresult = await sqlconn.query(sqlString); 
+    }
+    catch(err) { throw(err); } // using original error
+    finally { if (sqlconn) sqlconn.release(); } 
+
+    // Return single object if there is only 1 row
+    if (sqlresult[0].length === 0) return;
+    if (sqlresult[0].length === 1) return sqlresult[0][0];
+    else return sqlresult[0];
+}
+
+// Normalize field name
+//function toFieldName(s) {
+//    if ( s.trimStart().charAt(0) === '\`' ) return s;
+//    else return `\`${s}\``;
+//}
+
+// Compose fully qualified table name
+function fullyQualifiedTableName(tSchema) {
+    return (tSchema.database.realName + '.' + tSchema.table.realName);
+}
+
+// Parse oprations object to sql string
+function ToSql(dbOpe, sqlRequest) {
+    if (dbOpe.get) return getToSql(dbOpe, sqlRequest);
+    if (dbOpe.patch) return patchToSql(dbOpe, sqlRequest);
+    if (dbOpe.put) return putToSql(dbOpe, sqlRequest);
+    if (dbOpe.delete) return deleteToSql(dbOpe, sqlRequest);
+    if (dbOpe.execute) return executeToSql(dbOpe, sqlRequest);
+    if (dbOpe.begin) return beginToSql(dbOpe, sqlRequest);
+    if (dbOpe.commit) return commitToSql(dbOpe, sqlRequest);
+    if (dbOpe.passthrough) return passthroughToSql(dbOpe, sqlRequest);
+}
+
+// Parse operation object to sql string without any trasformation.
+function passthroughToSql(dbOpe, sqlRequest) {
+
+    let result = "";
+
+    if (dbOpe.passthrough.command) {
+        result += dbOpe.passthrough.command;
+    }
+    else { throw new Error('command is missing.'); }
+
+    if (dbOpe.passthrough.params) addParams(dbOpe.passthrough.params, sqlRequest);
+
+    return result;
+}
+
+// Parse get operation object to sql string
+function getToSql(dbOpe, sqlRequest) {
+    let _first = true;
+
+    let result = 'select '
+
+    if ((dbOpe.get.fields) && (Object.keys(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 (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 (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 (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 (Array.isArray(dbOpe.get.orderBy)) result += ' order by ' + dbOpe.get.orderBy.join(', ');
+        else result += ' order by ' + dbOpe.get.orderBy;
+    }
+
+    if ((dbOpe.get.options) && (Object.keys(dbOpe.get.options).length > 0)) {
+        if (Array.isArray(dbOpe.get.options)) result += ' ' + dbOpe.get.options.join(' ');
+        else result += ' ' + dbOpe.get.options;
+    }
+
+    if (dbOpe.get.params) addParams(dbOpe.get.params, sqlRequest);
+
+    result += ';' 
+
+    return result;
+}
+
+// Parse patch operation object to sql string
+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(', '); }
+    else { throw new Error('sets is missing.'); }
+
+    if ((dbOpe.patch.filters) && (Object.keys(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 += ';' 
+
+    return result;
+}
+
+// Parse put (add) operation object to sql string
+function putToSql(dbOpe, sqlRequest) {
+    let result = 'insert into ' + fullyQualifiedTableName(dbOpe.put.schema);
+
+    if ((dbOpe.put.sets) && (Object.keys(dbOpe.put.sets).length > 0)) {
+        let result_f = ' ('; let result_v = ' values (';
+        let _first = true;
+        for (const [key, value] of Object.entries(dbOpe.put.sets)) {
+            if (!_first) { result_f += ', '; result_v += ', '; } else { _first = false }
+            if (key || value) { result_f += key; result_v += stringifyValue(key, value, dbOpe.put.schema); }
+        }
+        result_f += ')'; result_v += ')';
+        result += result_f + result_v;
+    }
+    else { throw new Error('sets is missing.'); }
+
+    if (dbOpe.put.params) addParams(dbOpe.put.params, sqlRequest);
+
+    result += ';' 
+
+    return result;
+}
+
+// Parse delete operation object to sql string
+function deleteToSql(dbOpe, sqlRequest) {
+    let result = 'delete from ' + fullyQualifiedTableName(dbOpe.delete.schema);
+
+    if ((dbOpe.delete.filters) && (Object.keys(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 += ';' 
+
+    return result;
+}
+
+// Parse execute operation object to sql string
+function executeToSql(dbOpe, sqlRequest) {
+    let result = "CALL ";
+
+    if (dbOpe.execute.schema.procedure) {
+        result += dbOpe.execute.schema.procedure.command;
+        if (dbOpe.execute.arguments) { result += ('(' + dbOpe.execute.arguments) + ')'; }
+    }
+    else { throw new Error('missing procedure/function name.'); }
+
+    if (dbOpe.execute.params) addParams(dbOpe.execute.params, sqlRequest);
+
+    result += ';' 
+
+    return result;
+}
+
+// Parse begin operation object to sql string
+function beginToSql(dbOpe, sqlRequest) {
+    return "START TRANSACTION; ";
+}
+
+// Parse commit operation object to sql string
+function commitToSql(dbOpe, sqlRequest) {
+    return " COMMIT;";
+}
+
+// Add input parameters to pool.request
+function addParams(params, sqlRequest) {
+    if (params) {
+        for (const [key, value] of Object.entries(params)) {
+            sqlRequest.input(key, value)
+        }
+    }
+    return;
+}

package/lib/schema.js

@@ -1,4 +1,4 @@
-export default {
-    servers: {
-    }
+export default {
+    servers: {
+    }
 }

package/package.json

@@ -1,17 +1,22 @@
-{
-  "name": "db-crud-api",
-  "version": "0.2.2",
-  "type": "module",
-  "description": "CRUD api for database tables",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "FF",
-  "license": "MIT",
-  "dependencies": {
-    "mssql": "^11.0.1",
-    "uuid": "^11.0.3"
-  },
-  "keywords":["db","crud","api"]
-}
+{
+  "name": "db-crud-api",
+  "version": "0.3.1",
+  "type": "module",
+  "description": "CRUD api for database tables",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "FF",
+  "license": "MIT",
+  "dependencies": {
+    "mssql": "^11.0.1",
+    "mysql2": "^3.12.0",
+    "uuid": "^11.0.3"
+  },
+  "keywords": [
+    "db",
+    "crud",
+    "api"
+  ]
+}