jerkjs 2.1.0 → 2.1.2

package/examples/v2_mariadb_auth/README.md

@@ -1,94 +0,0 @@
-# Ejemplo API con Autenticación MariaDB
-
-Este ejemplo demuestra cómo crear una API con autenticación basada en tokens almacenados en MariaDB utilizando el Framework JERK.
-
-## Características
-
-- Autenticación JWT con tokens almacenados en MariaDB
-- Rutas protegidas y públicas
-- Sistema de login/logout para obtener y revocar tokens
-- Controladores organizados por funcionalidad
-- Revocación de tokens en la base de datos
-
-## Configuración
-
-1. Asegúrate de tener instaladas las dependencias del framework JERK
-2. Instala mariadb si aún no está instalado: `npm install mariadb`
-3. Asegúrate de tener MariaDB instalado y en ejecución
-4. Crea la base de datos `token_db` en MariaDB
-
-## Preparación de la base de datos
-
-Antes de ejecutar la aplicación, asegúrate de tener MariaDB en ejecución y crea la base de datos:
-
-```sql
-CREATE DATABASE IF NOT EXISTS token_db;
-USE token_db;
-```
-
-La tabla de tokens se creará automáticamente al iniciar la aplicación.
-
-## Uso
-
-1. Inicia el servidor:
-   ```bash
-   node app.js
-   ```
-
-2. El servidor escuchará en `http://localhost:8090`
-
-## Endpoints
-
-- `GET /` - Página de inicio (público)
-- `POST /login` - Iniciar sesión y obtener token (público)
-- `GET /protected` - Contenido protegido (requiere token)
-- `GET /profile` - Perfil de usuario (requiere token)
-- `POST /logout` - Cerrar sesión y revocar token (requiere token)
-
-## Ejemplo de uso
-
-1. Iniciar sesión:
-   ```bash
-   curl -X POST http://localhost:8090/login \
-     -H "Content-Type: application/json" \
-     -d '{"username": "admin", "password": "password"}'
-   ```
-
-2. Acceder a contenido protegido:
-   ```bash
-   curl -X GET http://localhost:8090/protected \
-     -H "Authorization: Bearer TU_TOKEN_AQUI"
-   ```
-
-3. Ver perfil de usuario:
-   ```bash
-   curl -X GET http://localhost:8090/profile \
-     -H "Authorization: Bearer TU_TOKEN_AQUI"
-   ```
-
-4. Cerrar sesión y revocar token:
-   ```bash
-   curl -X POST http://localhost:8090/logout \
-     -H "Authorization: Bearer TU_TOKEN_AQUI"
-   ```
-
-## Estructura del proyecto
-
-```
-examples/v2_mariadb_auth/
-├── app.js              # Punto de entrada de la aplicación
-├── routes.json         # Definición de rutas
-├── controllers/        # Controladores de las rutas
-│   ├── mainController.js
-│   ├── authController.js
-│   ├── protectedController.js
-│   └── userController.js
-└── README.md
-```
-
-## Seguridad
-
-- Los tokens se almacenan en una base de datos MariaDB
-- Los tokens expiran después de 1 hora
-- Las rutas protegidas requieren un token válido en el header Authorization
-- Los tokens pueden ser revocados mediante el endpoint de logout

package/examples/v2_mariadb_auth/app.js

@@ -1,81 +0,0 @@
-const {
-  APIServer,
-  Authenticator,
-  RouteLoader,
-  Logger,
-  MariaDBTokenAdapter
-} = require('../../index.js');
-
-async function startServer() {
-  // Crear instancia del servidor
-  const server = new APIServer({
-    port: 8090,
-    host: 'localhost'
-  });
-
-  // Crear instancia del logger
-  const logger = new Logger({ level: 'info' });
-
-  try {
-    // Crear instancia del adaptador de tokens MariaDB
-    const tokenAdapter = new MariaDBTokenAdapter({
-      host: 'localhost',
-      user: 'root',
-      password: '', // Dejar vacío si no hay contraseña para root
-      database: 'token_db',
-      tableName: 'mariadb_tokens'
-    });
-
-    // Inicializar el adaptador de tokens
-    await tokenAdapter.initialize();
-    logger.info('MariaDB Token Adapter inicializado correctamente');
-
-    // Crear instancia del autenticador
-    const authenticator = new Authenticator({ logger });
-
-    // Registrar estrategia de autenticación JWT que utiliza el adaptador MariaDB
-    authenticator.use('jwt-mariadb', async (req, options = {}) => {
-      const authHeader = req.headers.authorization;
-      const token = authHeader && authHeader.split(' ')[1]; // Bearer TOKEN
-
-      if (!token) {
-        return false;
-      }
-
-      // Validar el token contra la base de datos MariaDB
-      const tokenRecord = await tokenAdapter.validateToken(token);
-      
-      if (tokenRecord) {
-        // Agregar información del usuario a la solicitud
-        req.user = { 
-          userId: tokenRecord.user_id, 
-          tokenType: tokenRecord.token_type,
-          expiresAt: tokenRecord.expires_at
-        };
-        return true;
-      }
-
-      return false;
-    });
-
-    // Agregar el autenticador al servidor para que pueda ser usado por el RouteLoader
-    server.authenticator = authenticator;
-
-    // Cargar rutas desde archivo JSON
-    const routeLoader = new RouteLoader();
-    await routeLoader.loadRoutes(server, './routes.json');
-
-    // Iniciar el servidor
-    server.start();
-
-    logger.info('Servidor iniciado en http://localhost:8090');
-  } catch (error) {
-    logger.error('Error iniciando el servidor:', error.message);
-    process.exit(1);
-  }
-}
-
-// Iniciar el servidor
-startServer();
-
-module.exports = { startServer };

package/examples/v2_mariadb_auth/controllers/authController.js

@@ -1,95 +0,0 @@
-const jwt = require('jsonwebtoken');
-const { MariaDBTokenAdapter } = require('../../../index.js');
-
-// Adaptador de tokens para este controlador
-const tokenAdapter = new MariaDBTokenAdapter({
-  host: 'localhost',
-  user: 'root',
-  password: '',
-  database: 'token_db',
-  tableName: 'mariadb_tokens'
-});
-
-// Asegurarse de que el adaptador esté inicializado
-tokenAdapter.initialize().catch(console.error);
-
-const authController = {
-  login: async (req, res) => {
-    try {
-      const { username, password } = req.body;
-
-      // Validación simple de credenciales (esto debería ser más robusto en producción)
-      if (!username || !password) {
-        res.writeHead(400, { 'Content-Type': 'application/json' });
-        res.end(JSON.stringify({ error: 'Nombre de usuario y contraseña requeridos' }));
-        return;
-      }
-
-      // Simulación de autenticación (en una aplicación real, esto verificaría contra una base de datos)
-      if (username === 'admin' && password === 'password') {
-        // Generar un token JWT
-        const payload = { 
-          userId: 1, 
-          username: username,
-          role: 'admin'
-        };
-        
-        // Secret para firmar el token (en producción, debería estar en variables de entorno)
-        const secret = 'super-secret-key-for-mariadb-example';
-        const token = jwt.sign(payload, secret, { expiresIn: '1h' });
-
-        // Guardar el token en la base de datos MariaDB
-        await tokenAdapter.saveToken(
-          token,
-          { userId: 1 },
-          'access',
-          new Date(Date.now() + 60 * 60 * 1000) // 1 hora
-        );
-
-        res.writeHead(200, { 'Content-Type': 'application/json' });
-        res.end(JSON.stringify({ 
-          message: 'Inicio de sesión exitoso',
-          token: token,
-          user: payload
-        }));
-      } else {
-        res.writeHead(401, { 'Content-Type': 'application/json' });
-        res.end(JSON.stringify({ error: 'Credenciales inválidas' }));
-      }
-    } catch (error) {
-      console.error('Error en login:', error);
-      res.writeHead(500, { 'Content-Type': 'application/json' });
-      res.end(JSON.stringify({ error: 'Error interno del servidor' }));
-    }
-  },
-
-  logout: async (req, res) => {
-    try {
-      const authHeader = req.headers.authorization;
-      const token = authHeader && authHeader.split(' ')[1]; // Bearer TOKEN
-
-      if (!token) {
-        res.writeHead(400, { 'Content-Type': 'application/json' });
-        res.end(JSON.stringify({ error: 'Token no proporcionado' }));
-        return;
-      }
-
-      // Revocar el token en la base de datos MariaDB
-      const revoked = await tokenAdapter.revokeToken(token);
-
-      if (revoked) {
-        res.writeHead(200, { 'Content-Type': 'application/json' });
-        res.end(JSON.stringify({ message: 'Sesión cerrada exitosamente' }));
-      } else {
-        res.writeHead(400, { 'Content-Type': 'application/json' });
-        res.end(JSON.stringify({ error: 'No se pudo revocar el token' }));
-      }
-    } catch (error) {
-      console.error('Error en logout:', error);
-      res.writeHead(500, { 'Content-Type': 'application/json' });
-      res.end(JSON.stringify({ error: 'Error interno del servidor' }));
-    }
-  }
-};
-
-module.exports = authController;

package/examples/v2_mariadb_auth/controllers/mainController.js

@@ -1,31 +0,0 @@
-const jwt = require('jsonwebtoken');
-const { MariaDBTokenAdapter } = require('../../../index.js');
-
-// Adaptador de tokens para este controlador
-const tokenAdapter = new MariaDBTokenAdapter({
-  host: 'localhost',
-  user: 'root',
-  password: '',
-  database: 'token_db',
-  tableName: 'mariadb_tokens'
-});
-
-// Asegurarse de que el adaptador esté inicializado
-tokenAdapter.initialize().catch(console.error);
-
-const mainController = {
-  home: (req, res) => {
-    res.writeHead(200, { 'Content-Type': 'application/json' });
-    res.end(JSON.stringify({ 
-      message: 'Bienvenido a la API de ejemplo con autenticación MariaDB',
-      endpoints: {
-        'POST /login': 'Iniciar sesión y obtener token',
-        'GET /protected': 'Contenido protegido (requiere token)',
-        'GET /profile': 'Perfil de usuario (requiere token)',
-        'POST /logout': 'Cerrar sesión y revocar token (requiere token)'
-      }
-    }));
-  }
-};
-
-module.exports = mainController;

package/examples/v2_mariadb_auth/controllers/protectedController.js

@@ -1,12 +0,0 @@
-const protectedController = {
-  getProtectedData: (req, res) => {
-    res.writeHead(200, { 'Content-Type': 'application/json' });
-    res.end(JSON.stringify({ 
-      message: 'Datos protegidos accesados exitosamente',
-      user: req.user,
-      timestamp: new Date().toISOString()
-    }));
-  }
-};
-
-module.exports = protectedController;

package/examples/v2_mariadb_auth/controllers/userController.js

@@ -1,17 +0,0 @@
-const userController = {
-  getProfile: (req, res) => {
-    res.writeHead(200, { 'Content-Type': 'application/json' });
-    res.end(JSON.stringify({ 
-      profile: {
-        id: req.user.userId,
-        username: req.user.username || 'Usuario',
-        role: req.user.role || 'guest',
-        tokenType: req.user.tokenType,
-        expiresAt: req.user.expiresAt
-      },
-      message: 'Perfil de usuario obtenido exitosamente'
-    }));
-  }
-};
-
-module.exports = userController;

package/examples/v2_mariadb_auth/package.json

@@ -1,27 +0,0 @@
-{
-  "name": "jerk-mariadb-example",
-  "version": "1.0.0",
-  "description": "Ejemplo de API con autenticación MariaDB usando el Framework JERK",
-  "main": "app.js",
-  "scripts": {
-    "start": "node app.js",
-    "dev": "nodemon app.js"
-  },
-  "keywords": [
-    "api",
-    "sdk",
-    "authentication",
-    "mariadb",
-    "jwt",
-    "framework"
-  ],
-  "author": "JERK Framework",
-  "license": "MIT",
-  "dependencies": {
-    "jsonwebtoken": "^9.0.0",
-    "mariadb": "^3.0.0"
-  },
-  "devDependencies": {
-    "nodemon": "^3.0.0"
-  }
-}

package/examples/v2_mariadb_auth/routes.json

@@ -1,37 +0,0 @@
-[
-  {
-    "path": "/",
-    "method": "GET",
-    "controller": "./controllers/mainController.js",
-    "handler": "home",
-    "auth": "none"
-  },
-  {
-    "path": "/login",
-    "method": "POST",
-    "controller": "./controllers/authController.js",
-    "handler": "login",
-    "auth": "none"
-  },
-  {
-    "path": "/protected",
-    "method": "GET",
-    "controller": "./controllers/protectedController.js",
-    "handler": "getProtectedData",
-    "auth": "jwt-mariadb"
-  },
-  {
-    "path": "/profile",
-    "method": "GET",
-    "controller": "./controllers/userController.js",
-    "handler": "getProfile",
-    "auth": "jwt-mariadb"
-  },
-  {
-    "path": "/logout",
-    "method": "POST",
-    "controller": "./controllers/authController.js",
-    "handler": "logout",
-    "auth": "jwt-mariadb"
-  }
-]

package/examples/v2_no_auth/README.md

@@ -1,75 +0,0 @@
-# Ejemplo API Pública sin Autenticación
-
-Este ejemplo demuestra cómo crear una API pública sin autenticación utilizando el Framework JERK.
-
-## Características
-
-- API completamente pública sin requerir tokens o autenticación
-- Rutas para diferentes tipos de datos
-- Documentación OpenAPI generada automáticamente
-- Endpoints de ejemplo para productos y datos públicos
-
-## Configuración
-
-No se requieren dependencias adicionales más allá del Framework JERK.
-
-## Uso
-
-1. Inicia el servidor:
-   ```bash
-   node app.js
-   ```
-
-2. El servidor escuchará en `http://localhost:8089`
-
-## Endpoints
-
-- `GET /` - Página de inicio
-- `GET /public` - Datos públicos de ejemplo
-- `GET /products` - Lista de productos
-- `GET /products/:id` - Producto específico por ID
-- `GET /health` - Estado del servicio
-- `GET /docs` - Documentación interactiva de la API
-- `GET /openapi.json` - Especificación OpenAPI
-
-## Ejemplo de uso
-
-1. Consultar productos:
-   ```bash
-   curl http://localhost:8089/products
-   ```
-
-2. Consultar producto específico:
-   ```bash
-   curl http://localhost:8089/products/1
-   ```
-
-3. Consultar datos públicos:
-   ```bash
-   curl http://localhost:8089/public
-   ```
-
-4. Ver estado del servicio:
-   ```bash
-   curl http://localhost:8089/health
-   ```
-
-## Estructura del proyecto
-
-```
-examples/v2_no_auth/
-├── app.js              # Punto de entrada de la aplicación
-├── routes.json         # Definición de rutas
-├── controllers/        # Controladores de las rutas
-│   ├── mainController.js
-│   ├── publicController.js
-│   ├── productController.js
-│   └── healthController.js
-└── README.md
-```
-
-## Notas
-
-- Esta API no requiere autenticación, por lo que todos los endpoints son públicos
-- Adecuada para servicios públicos, APIs de datos abiertos o prototipos
-- La documentación OpenAPI se genera automáticamente y está disponible en `/docs`

package/examples/v2_no_auth/app.js

@@ -1,72 +0,0 @@
-const {
-  APIServer,
-  RouteLoader,
-  Logger,
-  OpenApiGenerator
-} = require('../../index.js');
-
-async function startServer() {
-  // Crear instancia del servidor
-  const server = new APIServer({
-    port: 8089,
-    host: 'localhost'
-  });
-
-  // Crear instancia del logger
-  const logger = new Logger({ level: 'info' });
-
-  try {
-    // Cargar rutas desde archivo JSON
-    const routeLoader = new RouteLoader();
-    await routeLoader.loadRoutes(server, './routes.json');
-
-    // Crear instancia del generador de OpenAPI
-    const openApiGenerator = new OpenApiGenerator({
-      title: 'API Pública de Ejemplo',
-      description: 'Una API pública sin autenticación',
-      version: '1.0.0'
-    });
-
-    // Agregar rutas a la documentación OpenAPI
-    openApiGenerator.addRoute({
-      path: '/public',
-      method: 'GET',
-      config: {
-        summary: 'Endpoint público de ejemplo',
-        description: 'Devuelve datos públicos sin requerir autenticación',
-        responses: {
-          '200': {
-            description: 'Datos públicos',
-            content: {
-              'application/json': {
-                schema: {
-                  type: 'object',
-                  properties: {
-                    message: { type: 'string' },
-                    timestamp: { type: 'string' }
-                  }
-                }
-              }
-            }
-          }
-        }
-      }
-    });
-
-    // Agregar ruta de documentación al servidor
-    openApiGenerator.addDocumentationRoute(server);
-
-    // Iniciar el servidor
-    server.start();
-
-    logger.info('Servidor iniciado en http://localhost:8089');
-  } catch (error) {
-    logger.error('Error iniciando el servidor:', error.message);
-    process.exit(1);
-  }
-}
-
-// Iniciar el servidor
-startServer();
-
-module.exports = { startServer };

package/examples/v2_no_auth/controllers/healthController.js

@@ -1,14 +0,0 @@
-const healthController = {
-  getStatus: (req, res) => {
-    res.writeHead(200, { 'Content-Type': 'application/json' });
-    res.end(JSON.stringify({ 
-      status: 'healthy',
-      uptime: process.uptime(),
-      timestamp: new Date().toISOString(),
-      service: 'API Pública de Ejemplo',
-      version: '1.0.0'
-    }));
-  }
-};
-
-module.exports = healthController;

package/examples/v2_no_auth/controllers/mainController.js

@@ -1,19 +0,0 @@
-const mainController = {
-  home: (req, res) => {
-    res.writeHead(200, { 'Content-Type': 'application/json' });
-    res.end(JSON.stringify({ 
-      message: 'Bienvenido a la API pública de ejemplo',
-      endpoints: {
-        'GET /': 'Esta página de inicio',
-        'GET /public': 'Datos públicos de ejemplo',
-        'GET /products': 'Lista de productos',
-        'GET /products/:id': 'Producto por ID',
-        'GET /health': 'Estado del servicio',
-        'GET /docs': 'Documentación interactiva de la API',
-        'GET /openapi.json': 'Especificación OpenAPI'
-      }
-    }));
-  }
-};
-
-module.exports = mainController;

package/examples/v2_no_auth/controllers/productController.js

@@ -1,31 +0,0 @@
-// Datos de ejemplo de productos
-const products = [
-  { id: 1, name: 'Laptop', price: 999.99, category: 'Electronics' },
-  { id: 2, name: 'Mouse', price: 29.99, category: 'Electronics' },
-  { id: 3, name: 'Keyboard', price: 79.99, category: 'Electronics' },
-  { id: 4, name: 'Monitor', price: 299.99, category: 'Electronics' },
-  { id: 5, name: 'Webcam', price: 89.99, category: 'Electronics' }
-];
-
-const productController = {
-  getAllProducts: (req, res) => {
-    res.writeHead(200, { 'Content-Type': 'application/json' });
-    res.end(JSON.stringify(products));
-  },
-
-  getProductById: (req, res) => {
-    const productId = parseInt(req.params.id);
-    const product = products.find(p => p.id === productId);
-
-    if (!product) {
-      res.writeHead(404, { 'Content-Type': 'application/json' });
-      res.end(JSON.stringify({ error: 'Producto no encontrado' }));
-      return;
-    }
-
-    res.writeHead(200, { 'Content-Type': 'application/json' });
-    res.end(JSON.stringify(product));
-  }
-};
-
-module.exports = productController;

package/examples/v2_no_auth/controllers/publicController.js

@@ -1,16 +0,0 @@
-const publicController = {
-  getPublicData: (req, res) => {
-    res.writeHead(200, { 'Content-Type': 'application/json' });
-    res.end(JSON.stringify({ 
-      message: 'Este es un endpoint público sin autenticación',
-      timestamp: new Date().toISOString(),
-      data: {
-        randomValue: Math.floor(Math.random() * 100),
-        serverStatus: 'operational',
-        publicInfo: 'Esta información es accesible para todos'
-      }
-    }));
-  }
-};
-
-module.exports = publicController;

package/examples/v2_no_auth/package.json

@@ -1,22 +0,0 @@
-{
-  "name": "jerk-public-example",
-  "version": "1.0.0",
-  "description": "Ejemplo de API pública sin autenticación usando el Framework JERK",
-  "main": "app.js",
-  "scripts": {
-    "start": "node app.js",
-    "dev": "nodemon app.js"
-  },
-  "keywords": [
-    "api",
-    "sdk",
-    "public",
-    "no-authentication",
-    "framework"
-  ],
-  "author": "JERK Framework",
-  "license": "MIT",
-  "devDependencies": {
-    "nodemon": "^3.0.0"
-  }
-}