jerkjs 2.1.6 → 2.2.0

package/docs/ARQUITECTURA_ROUTES.md

@@ -1,140 +0,0 @@
-# Arquitectura del Sistema de Rutas en JERK Framework
-
-## Descripción General
-
-El sistema de rutas en JERK Framework permite definir endpoints de API mediante dos métodos principales:
-1. Archivo JSON (`routes.json`) - Carga masiva de rutas
-2. Método `addRoute()` - Definición individual de rutas
-
-## Componentes Principales
-
-### 1. APIServer (lib/core/server.js)
-
-Componente principal que gestiona las rutas y el ciclo de vida de la solicitud HTTP.
-
-**Características:**
-- Almacena rutas en el array `this.routes`
-- Implementa el método `addRoute(method, path, handler)` para definir rutas individuales
-- Maneja el enrutamiento en `findRoute(method, pathname)`
-- Soporta rutas parametrizadas con conversión a expresiones regulares
-- Mantiene un cache de expresiones regulares para rutas parametrizadas
-- Ejecuta middlewares antes de los handlers de rutas
-
-**Método `addRoute`:**
-- Recibe: método HTTP, path y handler
-- No soporta autenticación por ruta
-- No soporta content-type por ruta
-- No carga controladores desde archivos externos
-- Simplemente registra la ruta en el array
-
-### 2. RouteLoader (lib/loader/routeLoader.js)
-
-Componente encargado de cargar rutas desde archivos JSON.
-
-**Características:**
-- Lee y parsea archivos JSON de rutas
-- Valida la estructura del archivo de rutas
-- Carga controladores desde archivos externos
-- Aplica autenticación por ruta
-- Aplica content-type por ruta
-- Dispara hooks antes y después de cargar rutas
-- Soporta recarga automática de rutas
-
-**Método `loadSingleRoute`:**
-- Carga el módulo del controlador
-- Obtiene el handler del controlador
-- Aplica content-type si está especificado
-- Aplica autenticación si está especificada
-- Integra el handler procesado con el servidor usando `server.addRoute`
-
-## Funcionalidades Soportadas por routes.json
-
-### 1. Estructura Básica
-```json
-{
-  "path": "/ruta/ejemplo",
-  "method": "GET",
-  "controller": "./controllers/EjemploController.js",
-  "handler": "metodoHandler"
-}
-```
-
-### 2. Content-Type por Ruta
-```json
-{
-  "contentType": "application/json"
-}
-```
-
-### 3. Autenticación por Ruta
-```json
-{
-  "auth": "jwt",
-  "authOptions": {
-    "jwtSecret": "secreto-ejemplo"
-  }
-}
-```
-
-Tipos de autenticación soportados:
-- `jwt` - Autenticación JWT
-- `apiKey` - Autenticación por API Key
-- `session` - Autenticación por sesión
-- Otros tipos registrados en el authenticator
-
-### 4. Rutas Parametrizadas
-Soporta rutas con parámetros como `/usuarios/:id` que se convierten a expresiones regulares.
-
-## Comparativa: routes.json vs addRoute()
-
-| Característica | routes.json | addRoute() |
-|---|---|---|
-| Definición de rutas | Masiva (archivo JSON) | Individual |
-| Carga de controladores | Automática desde archivos | Manual (función handler) |
-| Autenticación por ruta | ✅ Soportada | ❌ No soportada |
-| Content-Type por ruta | ✅ Soportado | ❌ No soportado |
-| Opciones de autenticación | ✅ Soportadas | ❌ No soportadas |
-| Rutas parametrizadas | ✅ Soportadas | ✅ Soportadas |
-| Integración con hooks | ✅ Soportada | ❌ No soportada |
-
-## Flujo de Procesamiento de Rutas
-
-### Para routes.json:
-1. `RouteLoader.loadRoutes()` lee el archivo JSON
-2. Valida la estructura del archivo
-3. Para cada ruta, `loadSingleRoute()`:
-   - Carga el módulo del controlador
-   - Obtiene el handler
-   - Aplica content-type si existe
-   - Aplica autenticación si existe
-   - Llama a `server.addRoute()` con el handler procesado
-4. El servidor procesa las solicitudes normalmente
-
-### Para addRoute():
-1. Cliente llama directamente `server.addRoute(method, path, handler)`
-2. La ruta se registra directamente en `this.routes`
-3. El servidor procesa las solicitudes normalmente
-
-## Problemas Identificados
-
-### 1. Incompatibilidad entre ambos sistemas
-- No hay coordinación entre rutas definidas vía `routes.json` y `addRoute()`
-- Ambos sistemas operan de forma independiente
-
-### 2. Diferencia de funcionalidades
-- `routes.json` soporta muchas más características que `addRoute()`
-- `addRoute()` es mucho más básico
-
-## Soluciones Potenciales
-
-### 1. Extender el método addRoute()
-Modificar `addRoute()` para que acepte un objeto de opciones similar al usado en `routes.json`, permitiendo:
-- Especificar content-type
-- Configurar autenticación
-- Definir opciones de autenticación
-
-### 2. Crear un método interno común
-Crear un método interno que procese las rutas con todas las funcionalidades y que sea utilizado tanto por `RouteLoader` como por `addRoute()`.
-
-### 3. Mantener compatibilidad
-Cualquier cambio debe mantener la compatibilidad con el sistema existente de `routes.json`.