minervajs-helmet 1.0.8 → 1.0.9

package/README.md

@@ -1,30 +1,64 @@
-# MinervaJS.Helmet
+# MinervaJS-Helmet
 Modulo para la gestion de las conección a la base de datos, permite conectarse a varios tipos utilizando sobrecarga de metodos, tolera MySQL y Oracle Client  
 
-Ejemplo: Partiendo de un proyecto en blanco recien creado  
-> npm i minervajs-helmet  
-
-Archivo: index.js  
-
-var db = require('minervajs-helmet');  
-
-var l_sql = " SELECT P.id, " +  
-           " P.titulo, " +  
-           " P.subtitulo, " +  
-           " DATE_FORMAT(P.publicado, '%M %d, %Y') as publicado, " +  
-           " P.autor, " +  
-           " P.introduccion, " +  
-           " P.tags, " +  
-           " P.url_imagen " +  
-     " FROM publicacion P " +  
-     " ORDER BY P.publicado DESC " +  
-     " LIMIT 10 ";  
-
-db.executeSQL(l_sql, function(a_data, err)  
-{  
-      if (err)  
-      {console.log(err);}  
-      else  
-      {console.log(a_data);}  
-});  
+Ejemplo: Partiendo de un proyecto en blanco recien creado
+`$ npm i minervajs-helmet  `
+
+####Archivo: ./config/settings.js  
+Adicionas una Entrada, por cada tipo y base de datos
+```javascript
+{
+  'my_mysql':							// 'Perfil de Conexion'
+  {
+    type: 'mysql',
+    host: 'sql3.freesqldatabase.com',	// 'localhost',
+    port: 3306, 						// 'puerto',
+    user: 'sql3772729', 				// 'usuario',
+    password: 'esUA3qpGKD', 			// 'contraseña',
+    database: 'sql3772729' 				// 'nombre_db'
+  }
+}
+```
+
+####Archivo: index.js
+
+```javascript
+var db = require('minervajs-helmet');
+var config = require('./config/settings.js');
+
+async function main() {
+	try {
+    // Conexión a MySQL
+    const mysqlConnection = await db.connect('my_mysql', config);
+    const mysqlResult = await db.query('my_mysql', ' SELECT * FROM test ;', [], config); // Ejemplo con parámetros
+    console.log('Resultados de MySQL:', mysqlResult);
+    await db.close('my_mysql', config);
+  } catch (error) {
+    console.error('Error:', error);
+  }
+}
+
+main();
+```
+
+####Salida de resultados
+```javascript
+Resultados de MySQL: [
+  {
+    id: 1,
+    codigo: 'SV',
+    descripcion: 'El Salvador',
+    fecha: 2025-04-02T06:00:00.000Z
+  },
+  {
+    id: 2,
+    codigo: 'EU',
+    descripcion: 'Estados Unidos',
+    fecha: 2025-04-02T06:00:00.000Z
+  }
+]
+```
+
+En la instalacion, puedes hacer uso del archivo muestra que esta en *\node_modules\minervajs-helmet\config\settings.js*
+
 

package/config/settings.js

@@ -15,7 +15,7 @@ module.exports = {
  * 'mi_postgres': 
  * {
  *   type: 'postgres',
- *   host: 'localhost',
+ *   host: 'localhost o IP',
  *   port: 5432,
  *   user: 'usuario',
  *   password: 'contraseña',
@@ -25,20 +25,29 @@ module.exports = {
   'my_mysql': 
   {
     type: 'mysql',
-    host: 'sql3.freesqldatabase.com'	// 'localhost',
-    port: 3306,							//
-    user: 'sql3772729'					// 'usuario',
-    password: 'esUA3qpGKD'				// 'contraseña',
+    host: 'sql3.freesqldatabase.com',	// 'localhost',
+    port: 3306,							// 'puerto',
+    user: 'sql3772729',					// 'usuario',
+    password: 'esUA3qpGKD',				// 'contraseña',
     database: 'sql3772729'				// 'nombre_db'
   },
-  'my_oracle':  {
-    type: 'oracle',
-    host: 'localhost o IP'
-    port: 5432,
-    user: 'usuario',
-    password: 'contraseña',
-    database: 'nombre_db',
- 	connectString : '(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=namehostoip)(PORT=port))(CONNECT_DATA=(SERVICE_NAME=servicename)))'
-  },
-
+/*  'my_oracle':  {
+ *   type: 'oracle',
+ *   user: 'usuario',
+ *   password: 'contraseña',
+ *	connectString : '(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=namehostoip)(PORT=port))(CONNECT_DATA=(SERVICE_NAME=servicename)))'
+ * },
+ *  'mi_mongodb': {
+ *   type: 'mongodb',
+ *   url: 'mongodb://localhost:27017/nombre_db'
+ * },
+ * 'mi_mariadb': {
+ *   type: 'mariadb',
+ *   host: 'localhost',
+ *   port: 3306,
+ *   user: 'mi_usuario',
+ *   password: 'mi_contraseña',
+ *   database: 'nombre_db'
+ * }
+ */
 };

package/js/OLD db.js

@@ -1,8 +1,7 @@
 /**
  * @module 
- * @name db
- * @description Modulo gestor de la coneccion a la base de datos
- *
+ * @name db_mysql
+ * @description Modulo gestor de la coneccion a la base de datos, MySQL, utiliza el cliente mysql2
  */
 
 var mysql = require('mysql');
@@ -74,4 +73,4 @@ exports.executeSQLarray = function (sql, array, callback)
 		  con.end();
         });
     });
-}
+}

package/js/db_mariadb.js

@@ -0,0 +1,69 @@
+/**
+ * @module lib/mariadb
+ * @description Módulo para la conexión y operaciones de MariaDB.
+ */
+ 
+ /**
+ * @constant
+ * @type {string}
+ * @default
+ */
+const mariadb = require('mariadb/promise');
+
+/**
+ * Establece una conexión a la base de datos MariaDB.
+ *
+ * @async
+ * @function connect
+ * @param {object} config - Configuración de la conexión.
+ * @returns {Promise<mariadb.Connection>} Objeto de conexión de MariaDB.
+ */
+async function connect(config) {
+  try {
+    const connection = await mariadb.createConnection(config);
+    return connection;
+  } catch (error) {
+    console.error('Error al conectar a MariaDB:', error);
+    throw error;
+  }
+}
+
+/**
+ * Ejecuta una consulta SQL en la base de datos MariaDB.
+ *
+ * @async
+ * @function query
+ * @param {mariadb.Connection} connection - Objeto de conexión de MariaDB.
+ * @param {string} sql - Consulta SQL.
+ * @param {Array} [values] - Parámetros para la consulta.
+ * @returns {Promise<Array>} Filas resultantes de la consulta.
+ */
+async function query(connection, sql, values = []) {
+  try {
+    const rows = await connection.query(sql, values);
+    return rows;
+  } catch (error) {
+    console.error('Error al ejecutar la consulta MariaDB:', error);
+    throw error;
+  }
+}
+
+/**
+ * Cierra la conexión a la base de datos MariaDB.
+ *
+ * @async
+ * @function close
+ * @param {mariadb.Connection} connection - Objeto de conexión de MariaDB.
+ * @returns {Promise<void>}
+ */
+async function close(connection) {
+  try {
+    await connection.end();
+  } catch (error) {
+    console.error('Error al cerrar la conexión MariaDB:', error);
+    throw error;
+  }
+}
+
+module.exports = { connect, query, close };
+

package/js/db_mongodb.js

@@ -0,0 +1,49 @@
+const { MongoClient } = require('mongodb');
+
+/**
+ * @module lib/mongodb
+ * @description Módulo para la conexión y operaciones de MongoDB. Comando: npm install mongodb
+ */
+
+/**
+ * Establece una conexión a la base de datos MongoDB.
+ *
+ * @async
+ * @function connect
+ * @param {object} config - Configuración de la conexión.
+ * @returns {Promise<MongoClient>} Objeto de cliente de MongoDB.
+ */
+async function connect(config) {
+  try {
+    const client = new MongoClient(config.url);
+    await client.connect();
+    return client;
+  } catch (error) {
+    console.error('Error al conectar a MongoDB:', error);
+    throw error;
+  }
+}
+
+
+// query
+// logica
+
+
+/**
+ * Cierra la conexión a la base de datos MongoDB.
+ *
+ * @async
+ * @function close
+ * @param {MongoClient} client - Objeto de cliente de MongoDB.
+ * @returns {Promise<void>}
+ */
+async function close(client) {
+  try {
+    await client.close();
+  } catch (error) {
+    console.error('Error al cerrar la conexión MongoDB:', error);
+    throw error;
+  }
+}
+
+module.exports = { connect, close };

package/js/db_mysql.js

@@ -1,67 +1,24 @@
 /**
- * @module 
- * @name db_mysql
- * @description Modulo gestor de la coneccion a la base de datos, MySQL, utiliza el cliente mysql2
- *
- *
-var mysql = require('mysql2');
-var settings = require('../js/settings');
-
-
-exports.executeSQL = function (sql, callback)
-{
-    var con = new mysql.createConnection(settings.dbConfig);
-    
-    con.connect(function(err) 
-	{
-        if (err) 
-        {
-            callback(null, err);
-            //throw err;
-        }
-        if (settings.servConfig.debug){console.log("Connected!");}
-        con.query(sql, function (err, result) {
-          if (err) 
-          {
-            callback(null, err);
-            //throw err;
-          }
-		  if (settings.servConfig.debug){console.log("Sentencia Ejecutada:"+sql);}
-          callback(result);
-		  
-		  con.end();
-        });
-    });
-};
-
-exports.executeSQLarray = function (sql, array, callback)
-{
-	var con = new mysql.createConnection(settings.dbConfig);
-    
-    con.connect(function(err) 
-	{
-        if (err) 
-        {
-            callback(null, err);
-            //throw err;
-        }
-        if (settings.servConfig.debug){console.log("Connected!");}
-        con.query(sql, array, function (err, result) {
-          if (err) 
-          {
-            callback(null, err);
-            //throw err;
-          }
-          if (settings.servConfig.debug){console.log("Sentencia Ejecutada:"+sql);}
-          callback(result);
-		  
-		  con.end();
-        });
-    });
-}
-*/
+ * @module js/mysql
+ * @name Provider DB js/mysql
+ * @description Módulo para la conexión y operaciones del Proveedor MySQL.
+ */
+ 
+ /**
+ * @constant
+ * @type {string}
+ * @default
+ */
 const mysql = require('mysql2/promise'); // Usamos mysql2/promise para async/await
 
+/**
+ * Establece una conexión a la base de datos MySQL.
+ *
+ * @async
+ * @function connect
+ * @param {object} config - Configuración de la conexión.
+ * @returns {Promise<mysql.Connection>} Objeto de conexión de MySQL.
+ */
 async function connect(config) {
   try {
     const connection = await mysql.createConnection({
@@ -78,6 +35,16 @@ async function connect(config) {
   }
 }
 
+/**
+ * Ejecuta una consulta SQL en la base de datos MySQL.
+ *
+ * @async
+ * @function query
+ * @param {mysql.Connection} connection - Objeto de conexión de MySQL.
+ * @param {string} sql - Consulta SQL.
+ * @param {Array} [values] - Parámetros para la consulta.
+ * @returns {Promise<Array>} Filas resultantes de la consulta.
+ */
 async function query(connection, sql, values = []) {
   try {
     const [rows, fields] = await connection.execute(sql, values);
@@ -88,6 +55,14 @@ async function query(connection, sql, values = []) {
   }
 }
 
+/**
+ * Cierra la conexión a la base de datos MySQL.
+ *
+ * @async
+ * @function close
+ * @param {mysql.Connection} connection - Objeto de conexión de MySQL.
+ * @returns {Promise<void>}
+ */
 async function close(connection) {
   try {
     await connection.end();
@@ -97,4 +72,4 @@ async function close(connection) {
   }
 }
 
-module.exports = { connect, query, close };
+module.exports = { connect, query, close };

package/js/db_oracle.js

@@ -1,5 +1,25 @@
+/**
+ * @module js/oracle
+  * @name Provider DB js/oracle
+ * @description Módulo para la conexión y operaciones de Oracle.
+ */
+ 
+ /**
+ * @constant
+ * @type {string}
+ * @default
+ */
 const oracledb = require('oracledb');
 
+
+/**
+ * Establece una conexión a la base de datos Oracle.
+ *
+ * @async
+ * @function connect
+ * @param {object} config - Configuración de la conexión.
+ * @returns {Promise<oracledb.Connection>} Objeto de conexión de Oracle.
+ */
 async function connect(config) {
   try {
     oracledb.outFormat = oracledb.OUT_FORMAT_OBJECT; // Para obtener resultados como objetos
@@ -16,6 +36,16 @@ async function connect(config) {
   }
 }
 
+/**
+ * Ejecuta una consulta SQL en la base de datos Oracle.
+ *
+ * @async
+ * @function query
+ * @param {oracledb.Connection} connection - Objeto de conexión de Oracle.
+ * @param {string} sql - Consulta SQL.
+ * @param {Array} [binds] - Parámetros para la consulta (bind variables).
+ * @returns {Promise<Array>} Filas resultantes de la consulta.
+ */
 async function query(connection, sql, binds = []) {
   try {
     const result = await connection.execute(sql, binds);
@@ -26,6 +56,14 @@ async function query(connection, sql, binds = []) {
   }
 }
 
+/**
+ * Cierra la conexión a la base de datos Oracle.
+ *
+ * @async
+ * @function close
+ * @param {oracledb.Connection} connection - Objeto de conexión de Oracle.
+ * @returns {Promise<void>}
+ */
 async function close(connection) {
   try {
     await connection.close();

package/js/db_postgres.js

@@ -1,5 +1,25 @@
+/**
+ * @module js/postgres
+ * @name Provider DB js/postgres
+ * @description Módulo para la conexión y operaciones del Proveedor PostgreSQL.
+ */
+
+/**
+ * @constant
+ * @type {string}
+ * @default
+ */
 const { Client } = require('pg');
 
+/**
+ * Establece una conexión a la base de datos PostgreSQL.
+ *
+ * @async
+ * @function connect
+ * @name connect
+ * @param {object} config - Configuración de la conexión.
+ * @returns {Promise<Client>} Objeto de cliente de PostgreSQL.
+ */
 async function connect(config) 
 {
   const client = new Client(config);
@@ -7,12 +27,31 @@ async function connect(config)
   return client;
 }
 
+/**
+ * Ejecuta una consulta SQL en la base de datos PostgreSQL.
+ *
+ * @async
+ * @function query
+ * @name query
+ * @param {Client} client - Objeto de cliente de PostgreSQL.
+ * @param {string} sql - Consulta SQL.
+ * @returns {Promise<Array>} Filas resultantes de la consulta.
+ */
 async function query(client, sql) 
 {
   const result = await client.query(sql);
   return result.rows;
 }
 
+/**
+ * Cierra la conexión a la base de datos PostgreSQL.
+ *
+ * @async
+ * @function close
+ * @name close
+ * @param {Client} client - Objeto de cliente de PostgreSQL.
+ * @returns {Promise<void>}
+ */
 async function close(client) 
 {
   await client.end();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "minervajs-helmet",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "main": "src/db.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/src/db.js

@@ -1,25 +1,31 @@
 /**
  * 
  * @name MinervaJS-Helmet
- * @description Modulo gestor de la coneccion a la base de datos
+ * @module MinervaJS-Helmet
+ * @description Modulo gestor de la coneccion a la base de datos, con capacidad de realizar consultas en múltiples bases de datos.
  *
  */
+
 const postgres = require('../js/db_postgres');
 const mysql = require('../js/db_mysql');
 const oracle = require('../js/db_oracle');
-const config = require('../config/settings');
+// const mongodb = require('./lib/mongodb');
+// const mariadb = require('./lib/mariadb');
 
 const connections = {};
 
-
 /**
- * @function 
+ * Establece una conexión a la base de datos especificada.
+ *
+ * @async
+ * @function connect
  * @name connect
- * @param {string} databaseName - Perfil de la base de datos
- * @returns {result} result/err - Devuelve un objeto con del tipo conexión
- * @description Toma la configuracion y realiza la coneccion a la base de datos
+ * @param {string} databaseName - Perfil de la base de datos  (clave de configuración)
+ * @returns {Promise<object>} Objeto de conexión.
+ * @throws {Error} Si la configuración no se encuentra o el tipo de base de datos no es soportado.
+ * @description Toma la configuracion y Establece una conexión a la base de datos especificada
  */
-async function connect(databaseName) 
+async function connect(databaseName, config) 
 {
   const dbConfig = config[databaseName];
   if (!dbConfig) {
@@ -39,9 +45,15 @@ async function connect(databaseName)
     case 'mysql':
       connections[databaseName] = await mysql.connect(dbConfig);
       break;
+    // case 'mariadb':
+    //   connections[databaseName] = await mariadb.connect(dbConfig);
+    //   break;
     case 'oracle':
       connections[databaseName] = await oracle.connect(dbConfig);
       break;
+    // case 'mongodb':
+    //  connections[databaseName] = await mongodb.connect(dbConfig);
+    //  break;
     default:
       throw new Error(`Tipo de base de datos '${dbConfig.type}' no soportado.`);
   }
@@ -50,14 +62,19 @@ async function connect(databaseName)
 }
 
 /**
- * @function 
+ * Ejecuta una consulta en la base de datos especificada.
+ *
+ * @async
+ * @function query
  * @name query
- * @param {string} databaseName - Perfil de la base de datos
- * @param {string} sql - Sentencia SQL a ejecutar
- * @returns {result} result/err - Devuelve un objeto con el set de datos o un objeto err con la respuesta del error
- * @description Ejecuta una sentencia SQL y devuelve un objeto en un set de datos
+ * @param {string} databaseName - Perfil de la base de datos  (clave de configuración)
+ * @param {string} sql - Consulta SQL, Sentencia SQL a ejecutar
+ * @param {Array} [binds] - Parámetros para la consulta (bind variables).
+ * @returns {Promise<Array>} Filas resultantes de la consulta.
+ * @throws {Error} Si el tipo de base de datos no es soportado para la operación 'query'.
+ * @description Ejecuta una sentencia SQL en la base de datos especificada y devuelve un objeto en un set de datos
  */
-async function query(databaseName, sql) 
+async function query(databaseName, sql, config) 
 {
   const connection = await connect(databaseName);
   const dbConfig = config[databaseName];
@@ -68,21 +85,31 @@ async function query(databaseName, sql)
       return postgres.query(connection, sql);
     case 'mysql':
       return mysql.query(connection, sql);
+    // case 'mariadb': // agregamos el caso MariaDB
+    //   return mariadb.query(connection, sql, binds);
+    //   break;
     case 'oracle':
       return oracle.query(connection, sql);
+    // case 'mongodb':
+    //  // Adaptar la consulta SQL a la sintaxis de MongoDB
+    //  console.warn("La función 'query' no es directamente aplicable a MongoDB con sintaxis SQL.");
+    //  return null; // O lanzar un error
     default:
       throw new Error(`Tipo de base de datos '${dbConfig.type}' no soportado para la operación 'query'.`);
   }
 }
 
 /**
- * @function 
+ * Cierra la conexión a la base de datos especificada.
+ *
+ * @async
+ * @function close
  * @name close
- * @param {string} databaseName - Perfil de la base de datos
-  * @returns NONE
- * @description Cierra la conexion del Perfil de la base de datos pasado como parametro.
+ * @param {string} databaseName - Perfil de la base de datos (clave de configuración).
+ * @returns {Promise<void>}
+ * @description Cierra la conexion del Perfil de la base de datos especificada.
  */
-async function close(databaseName) 
+async function close(databaseName, config) 
 {
   if (connections[databaseName]) 
   {
@@ -94,9 +121,15 @@ async function close(databaseName)
       case 'mysql':
         await mysql.close(connections[databaseName]);
         break;
+    //  case 'mariadb': // agregamos el caso MariaDB
+    //    await mariadb.close(connections[databaseName]);
+    //    break;
       case 'oracle':
         await oracle.close(connections[databaseName]);
         break;
+    //  case 'mongodb':
+    //    await mongodb.close(connections[databaseName]);
+    //    break;
     }
     delete connections[databaseName];
   }
@@ -112,6 +145,7 @@ async function close(databaseName)
  * @returns {result} result/err - Devuelve un objeto con el set de datos o un objeto err con la respuesta del error
  * @description Ejecuta una sentencia SQL y devuelve un objeto en un set de datos
  */
+
  
 
 module.exports =