jerkjs 2.1.4 → 2.1.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +30 -0
- package/README.md +1 -1
- package/README_EN.md +230 -0
- package/README_PT.md +230 -0
- package/docs/ARQUITECTURA_ROUTES.md +140 -0
- package/docs/HOOK-2.0.md +512 -0
- package/docs/ROUTING_WITHOUT_JSON_GUIDE.md +454 -0
- package/lib/core/hooks.js +421 -59
- package/lib/core/server.js +201 -9
- package/lib/mvc/viewEngine.js +45 -5
- package/package.json +6 -3
- package/standardA/controllers/AuthController.js +82 -0
- package/standardA/controllers/HomeController.js +19 -0
- package/standardA/controllers/UserController.js +41 -0
- package/standardA/server.js +311 -0
- package/standardA/views/auth/dashboard.html +51 -0
- package/standardA/views/auth/login.html +47 -0
- package/standardA/views/index.html +32 -0
- package/standardA/views/users/detail.html +28 -0
- package/standardA/views/users/list.html +36 -0
- /package/{examples.arj → examples/examples.arj} +0 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,35 @@
|
|
|
1
1
|
# CHANGELOG
|
|
2
2
|
|
|
3
|
+
## v2.1.6 - 18 de enero de 2026
|
|
4
|
+
|
|
5
|
+
### Actualizaciones
|
|
6
|
+
|
|
7
|
+
- **Actualización de la biblioteca Hooked Lib a versión 2.0**: Se ha actualizado la biblioteca de hooks existente (@lib/core/hooks.js) a la versión 2.0, que ahora permite implementar patrones de extensibilidad mediante hooks y filtros, similar a los utilizados en WordPress. Incluye soporte para namespaces (namespace::hookName), prioridades, identificadores de callbacks, operaciones síncronas y asíncronas (doActionAsync, applyFiltersAsync), y validación de entradas.
|
|
8
|
+
|
|
9
|
+
### Mejoras
|
|
10
|
+
|
|
11
|
+
- **Sistema de extensibilidad mejorado**: La actualización a Hooked Lib 2.0 proporciona capacidades avanzadas de hooks y filtros con soporte para namespaces, operaciones asíncronas, y gestión flexible de prioridades e identificadores de callbacks.
|
|
12
|
+
|
|
13
|
+
## v2.1.5 - 17 de enero de 2026
|
|
14
|
+
|
|
15
|
+
### Nuevas características
|
|
16
|
+
|
|
17
|
+
- **Implementación completa del sistema MVC**: Se ha completado la implementación del sistema MVC con soporte para controladores que extienden ControllerBase, vistas con procesamiento de variables anidadas en bucles y condiciones, y sistema de layouts. Esta funcionalidad está disponible tanto para aplicaciones que usan `routes.json` como para aquellas que utilizan `addRoute()` directamente.
|
|
18
|
+
|
|
19
|
+
- **Soporte completo para vistas con variables anidadas**: El ViewEngine ahora soporta completamente el procesamiento de variables anidadas en bucles `{{foreach}}` y estructuras condicionales `{{if}}`, permitiendo construir interfaces complejas con datos dinámicos. Esta funcionalidad es accesible tanto en la arquitectura basada en `routes.json` como en la basada en `addRoute()`.
|
|
20
|
+
|
|
21
|
+
- **Ejemplo completo de servidor sin routes.json**: Se ha implementado un ejemplo completo (`@standardA/`) que demuestra cómo usar el framework sin el archivo `routes.json`, utilizando `addRoute()` con todas las funcionalidades equivalentes a las disponibles con `routes.json`.
|
|
22
|
+
|
|
23
|
+
### Mejoras
|
|
24
|
+
|
|
25
|
+
- **Sistema MVC más robusto**: Se ha mejorado la integración entre controladores, vistas y modelos, permitiendo un desarrollo más estructurado y mantenible en ambas arquitecturas (con y sin `routes.json`).
|
|
26
|
+
- **Procesamiento de variables anidadas**: Se ha mejorado el procesamiento de variables como `{{item.property}}` dentro de bucles `{{foreach}}`, permitiendo el uso completo de estructuras de datos complejas en las vistas, tanto en aplicaciones que usan `routes.json` como en aquellas que utilizan `addRoute()` directamente.
|
|
27
|
+
|
|
28
|
+
### Correcciones
|
|
29
|
+
|
|
30
|
+
- **Corrección en el procesamiento de variables anidadas**: Se resolvieron problemas con el procesamiento de variables como `{{item.property}}` dentro de bucles `{{foreach}}`, permitiendo el uso completo de estructuras de datos complejas en las vistas, tanto en la arquitectura con `routes.json` como en la arquitectura sin `routes.json`.
|
|
31
|
+
- **Corrección en el manejo de rutas sin routes.json**: Se resolvió el problema con el sistema de rutas cuando se utiliza `addRoute()` directamente sin el archivo `routes.json`, permitiendo que ambas arquitecturas funcionen correctamente con el sistema MVC y vistas.
|
|
32
|
+
|
|
3
33
|
## v2.1.4 - 17 de enero de 2026
|
|
4
34
|
|
|
5
35
|
### README
|
package/README.md
CHANGED
package/README_EN.md
ADDED
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
# JERK Framework v2.1.4
|
|
2
|
+
|
|
3
|
+

|
|
4
|
+
|
|
5
|
+
**New to JERK? Start your project quickly with our Starter Kit**
|
|
6
|
+
|
|
7
|
+
Our Starter Kit at `@standard/server.js` is the fastest way to get started with JERK. It comes with all framework functionalities already configured, allowing you to focus on developing your application instead of setting up infrastructure.
|
|
8
|
+
|
|
9
|
+
**Features of the Starter Kit:**
|
|
10
|
+
- Ready-to-use configuration with all main components
|
|
11
|
+
- Route loading from JSON file (`routes.json`)
|
|
12
|
+
- Preconfigured controller system
|
|
13
|
+
- Essential middlewares already integrated (authentication, CORS, compression, firewall, etc.)
|
|
14
|
+
- Implemented logging and error handling system
|
|
15
|
+
|
|
16
|
+
**How to get started:**
|
|
17
|
+
1. Edit the `routes.json` file to define your routes and associate them with your controllers
|
|
18
|
+
|
|
19
|
+
Basic example of `routes.json`:
|
|
20
|
+
```json
|
|
21
|
+
[
|
|
22
|
+
{
|
|
23
|
+
"path": "/",
|
|
24
|
+
"method": "GET",
|
|
25
|
+
"controller": "HomeController",
|
|
26
|
+
"handler": "index",
|
|
27
|
+
"contentType": "text/html"
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"path": "/api/users",
|
|
31
|
+
"method": "GET",
|
|
32
|
+
"controller": "UserController",
|
|
33
|
+
"handler": "getAllUsers",
|
|
34
|
+
"contentType": "application/json"
|
|
35
|
+
}
|
|
36
|
+
]
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
2. Create your controllers according to the defined routes
|
|
40
|
+
|
|
41
|
+
For example, for the main route "/", create a `HomeController.js` file:
|
|
42
|
+
```javascript
|
|
43
|
+
class HomeController {
|
|
44
|
+
index(req, res) {
|
|
45
|
+
res.render('index.html', { data: 'Hello' });
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
module.exports = new HomeController();
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
3. Your application is ready to use!
|
|
53
|
+
|
|
54
|
+
The Starter Kit includes sample controllers so you can see how the system works.
|
|
55
|
+
|
|
56
|
+
Visit our website: https://jerk.page.gd/
|
|
57
|
+
Official repository: https://gitlab.com/bytedogssyndicate1/jerk/
|
|
58
|
+
|
|
59
|
+
## Features
|
|
60
|
+
|
|
61
|
+
- **Modular Architecture**: Independent components for greater flexibility
|
|
62
|
+
- **Advanced Security**: Built-in firewall (WAF) with attack detection
|
|
63
|
+
- **Hook System**: Similar to WordPress system for extensibility
|
|
64
|
+
- **Flexible Authentication**: Support for JWT, API Keys, Basic Auth, OAuth2, OpenID Connect
|
|
65
|
+
- **Token Storage**: Support for memory, JSON, SQLite and MariaDB
|
|
66
|
+
- **Advanced Routing**: Support for parameterized and nested routes
|
|
67
|
+
- **Frontend Support**: Ability to serve HTML content and other content types
|
|
68
|
+
- **Content-Type Configuration**: Specification of Content-Type headers in routes.json
|
|
69
|
+
- **Integrated Middlewares**: CORS, rate limiting, compression, firewall, etc.
|
|
70
|
+
- **Controller Management**: Dynamic loading of controllers from files
|
|
71
|
+
- **Route Loading**: Definition of routes from JSON files
|
|
72
|
+
- **Session System**: Complete session management with authentication support
|
|
73
|
+
- **MVC Template Engine**: Professional view system with support for filters, helpers and hooks
|
|
74
|
+
- **Extensibility**: Hook and filter system for customization
|
|
75
|
+
|
|
76
|
+
## Installation
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
npm install jerkjs
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Basic Usage
|
|
83
|
+
|
|
84
|
+
```javascript
|
|
85
|
+
const { APIServer, Router, Logger } = require('jerkjs');
|
|
86
|
+
|
|
87
|
+
// Create server instance
|
|
88
|
+
const server = new APIServer({
|
|
89
|
+
port: 3000,
|
|
90
|
+
host: 'localhost'
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
// Create logger instance
|
|
94
|
+
const logger = new Logger({ level: 'info' });
|
|
95
|
+
|
|
96
|
+
// Define routes
|
|
97
|
+
server.addRoute('GET', '/', (req, res) => {
|
|
98
|
+
res.writeHead(200, { 'Content-Type': 'application/json' });
|
|
99
|
+
res.end(JSON.stringify({ message: 'Hello World!' }));
|
|
100
|
+
});
|
|
101
|
+
|
|
102
|
+
// Start the server
|
|
103
|
+
server.start();
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## Main Components
|
|
107
|
+
|
|
108
|
+
### APIServer
|
|
109
|
+
Basic HTTP/HTTPS server with support for parameterized routes, middlewares and advanced configuration.
|
|
110
|
+
|
|
111
|
+
### Router
|
|
112
|
+
Advanced routing system with support for nested routes and prefixes.
|
|
113
|
+
|
|
114
|
+
### Authenticator
|
|
115
|
+
Authentication middleware with support for multiple methods (JWT, API Keys, Basic Auth, OAuth2, OpenID Connect).
|
|
116
|
+
|
|
117
|
+
### SecurityEnhancedServer
|
|
118
|
+
Server with integrated advanced security features (WAF).
|
|
119
|
+
|
|
120
|
+
### RouteLoader
|
|
121
|
+
Loading of routes from JSON files with support for authentication, controllers and content-type specification.
|
|
122
|
+
|
|
123
|
+
### TokenManager
|
|
124
|
+
JWT token management with different storage types (memory, JSON, SQLite, MariaDB).
|
|
125
|
+
|
|
126
|
+
### Firewall
|
|
127
|
+
Firewall middleware with attack pattern detection and white/black lists.
|
|
128
|
+
|
|
129
|
+
### Hooks System
|
|
130
|
+
Hook and filter system similar to WordPress for extensibility.
|
|
131
|
+
|
|
132
|
+
### SessionManager
|
|
133
|
+
Complete session management system with session-based authentication support.
|
|
134
|
+
|
|
135
|
+
### ViewEngine
|
|
136
|
+
Professional template engine with support for filters, helpers, conditions, loops and hooks.
|
|
137
|
+
|
|
138
|
+
### ControllerBase
|
|
139
|
+
Base controller that facilitates the development of MVC controllers with view support.
|
|
140
|
+
|
|
141
|
+
## Security
|
|
142
|
+
|
|
143
|
+
The framework includes multiple layers of security:
|
|
144
|
+
|
|
145
|
+
- **Web Application Firewall (WAF)**: Detection of SQL injection, XSS, path traversal, etc.
|
|
146
|
+
- **Rate Limiting**: Request limitation by IP or user
|
|
147
|
+
- **Firewall**: Automatic blocking by failed attempts
|
|
148
|
+
- **White/Black Lists**: Access control by IP
|
|
149
|
+
- **Security Auditing**: Event logging
|
|
150
|
+
- **Robust Authentication**: Support for multiple authentication methods
|
|
151
|
+
|
|
152
|
+
## Hook System
|
|
153
|
+
|
|
154
|
+
The framework includes a hook and filter system similar to WordPress:
|
|
155
|
+
|
|
156
|
+
```javascript
|
|
157
|
+
const { hooks } = require('jerkjs');
|
|
158
|
+
|
|
159
|
+
// Register an action
|
|
160
|
+
hooks.addAction('firewall_request_blocked', (rule, clientIP, req, res) => {
|
|
161
|
+
console.log(`Blocked request: ${rule.name} for IP: ${clientIP}`);
|
|
162
|
+
});
|
|
163
|
+
|
|
164
|
+
// Register a filter
|
|
165
|
+
hooks.addFilter('session_create_data', (userData, req) => {
|
|
166
|
+
return {
|
|
167
|
+
...userData,
|
|
168
|
+
ipAddress: req.headers['x-forwarded-for'] || req.connection.remoteAddress,
|
|
169
|
+
createdAt: new Date().toISOString()
|
|
170
|
+
};
|
|
171
|
+
});
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
## MVC Template Engine
|
|
175
|
+
|
|
176
|
+
The framework includes a professional template engine with support for:
|
|
177
|
+
|
|
178
|
+
- Variables: `{{variable}}`
|
|
179
|
+
- Conditions: `{{if variable}}content{{endif}}`
|
|
180
|
+
- Loops: `{{foreach:array}}content{{endforeach}}`
|
|
181
|
+
- Includes: `{{include:header}}`
|
|
182
|
+
- Filters: `{{variable|upper}}`
|
|
183
|
+
- Custom helpers
|
|
184
|
+
|
|
185
|
+
## Session Management
|
|
186
|
+
|
|
187
|
+
The framework includes a complete session management system:
|
|
188
|
+
|
|
189
|
+
```javascript
|
|
190
|
+
const { SessionManager } = require('jerkjs');
|
|
191
|
+
|
|
192
|
+
const sessionManager = new SessionManager({
|
|
193
|
+
secret: 'your-session-secret',
|
|
194
|
+
timeout: 3600000 // 1 hour
|
|
195
|
+
});
|
|
196
|
+
|
|
197
|
+
// Use as middleware
|
|
198
|
+
server.use(sessionManager.middleware());
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
## Examples
|
|
202
|
+
|
|
203
|
+
The project includes several complete examples:
|
|
204
|
+
|
|
205
|
+
- **v2_json_auth**: JWT authentication with tokens stored in JSON
|
|
206
|
+
- **v2_mariadb_auth**: JWT authentication with tokens stored in MariaDB
|
|
207
|
+
- **v2_sqlite_auth**: JWT authentication with tokens stored in SQLite
|
|
208
|
+
- **public**: Sample public API with CORS and rate limiting
|
|
209
|
+
- **frontend**: Server example that combines API and frontend with different content-types
|
|
210
|
+
- **hooks**: Advanced example of hook system usage with logging and request tracking
|
|
211
|
+
|
|
212
|
+
To see the complete examples, visit the `v2examplle/` and `examples/` directories.
|
|
213
|
+
|
|
214
|
+
## Documentation
|
|
215
|
+
|
|
216
|
+
In addition to the documentation in the README, the project includes additional documentation:
|
|
217
|
+
|
|
218
|
+
- **Quick start guide**: `docs/guia_inicio_rapido_jerkjs.md` - A complete guide to getting started quickly with JERKJS, including file formats, controller structure, template engine and hook system.
|
|
219
|
+
|
|
220
|
+
## Contributions
|
|
221
|
+
|
|
222
|
+
Contributions are welcome. Please open an issue or submit a pull request on GitLab.
|
|
223
|
+
|
|
224
|
+
## License
|
|
225
|
+
|
|
226
|
+
Apache 2.0
|
|
227
|
+
|
|
228
|
+
## Framework Documentation
|
|
229
|
+
|
|
230
|
+
For a detailed description of the framework architecture and components, see the [JERK_FRAMEWORK_DOCUMENTATION.md](JERK_FRAMEWORK_DOCUMENTATION.md) file.
|
package/README_PT.md
ADDED
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
# JERK Framework v2.1.4
|
|
2
|
+
|
|
3
|
+

|
|
4
|
+
|
|
5
|
+
**Novo no JERK? Comece seu projeto rapidamente com nosso Kit Inicial**
|
|
6
|
+
|
|
7
|
+
Nosso Kit Inicial em `@standard/server.js` é a forma mais rápida de começar com o JERK. Ele vem com todas as funcionalidades do framework já configuradas, permitindo que você se concentre em desenvolver sua aplicação em vez de configurar infraestrutura.
|
|
8
|
+
|
|
9
|
+
**Recursos do Kit Inicial:**
|
|
10
|
+
- Configuração pronta para uso com todos os componentes principais
|
|
11
|
+
- Carregamento de rotas a partir de arquivo JSON (`routes.json`)
|
|
12
|
+
- Sistema de controladores pré-configurado
|
|
13
|
+
- Middlewares essenciais já integrados (autenticação, CORS, compressão, firewall, etc.)
|
|
14
|
+
- Sistema de logging e tratamento de erros implementado
|
|
15
|
+
|
|
16
|
+
**Como começar:**
|
|
17
|
+
1. Edite o arquivo `routes.json` para definir suas rotas e associá-las aos seus controladores
|
|
18
|
+
|
|
19
|
+
Exemplo básico de `routes.json`:
|
|
20
|
+
```json
|
|
21
|
+
[
|
|
22
|
+
{
|
|
23
|
+
"path": "/",
|
|
24
|
+
"method": "GET",
|
|
25
|
+
"controller": "HomeController",
|
|
26
|
+
"handler": "index",
|
|
27
|
+
"contentType": "text/html"
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"path": "/api/users",
|
|
31
|
+
"method": "GET",
|
|
32
|
+
"controller": "UserController",
|
|
33
|
+
"handler": "getAllUsers",
|
|
34
|
+
"contentType": "application/json"
|
|
35
|
+
}
|
|
36
|
+
]
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
2. Crie seus controladores de acordo com as rotas definidas
|
|
40
|
+
|
|
41
|
+
Por exemplo, para a rota principal "/", crie um arquivo `HomeController.js`:
|
|
42
|
+
```javascript
|
|
43
|
+
class HomeController {
|
|
44
|
+
index(req, res) {
|
|
45
|
+
res.render('index.html', { data: 'Olá' });
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
module.exports = new HomeController();
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
3. Sua aplicação está pronta para usar!
|
|
53
|
+
|
|
54
|
+
O Kit Inicial inclui controladores de exemplo para que você possa ver como o sistema funciona.
|
|
55
|
+
|
|
56
|
+
Visite nosso site: https://jerk.page.gd/
|
|
57
|
+
Repositório oficial: https://gitlab.com/bytedogssyndicate1/jerk/
|
|
58
|
+
|
|
59
|
+
## Recursos
|
|
60
|
+
|
|
61
|
+
- **Arquitetura Modular**: Componentes independentes para maior flexibilidade
|
|
62
|
+
- **Segurança Avançada**: Firewall integrado (WAF) com detecção de ataques
|
|
63
|
+
- **Sistema de Hooks**: Semelhante ao sistema do WordPress para extensibilidade
|
|
64
|
+
- **Autenticação Flexível**: Suporte para JWT, API Keys, Basic Auth, OAuth2, OpenID Connect
|
|
65
|
+
- **Armazenamento de Tokens**: Suporte para memória, JSON, SQLite e MariaDB
|
|
66
|
+
- **Roteamento Avançado**: Suporte para rotas parametrizadas e aninhadas
|
|
67
|
+
- **Suporte para Frontend**: Capacidade de servir conteúdo HTML e outros tipos de conteúdo
|
|
68
|
+
- **Configuração de Content-Type**: Especificação de cabeçalhos Content-Type em routes.json
|
|
69
|
+
- **Middlewares Integrados**: CORS, limitação de taxa, compressão, firewall, etc.
|
|
70
|
+
- **Gerenciamento de Controladores**: Carregamento dinâmico de controladores a partir de arquivos
|
|
71
|
+
- **Carregamento de Rotas**: Definição de rotas a partir de arquivos JSON
|
|
72
|
+
- **Sistema de Sessões**: Gerenciamento completo de sessões com suporte para autenticação
|
|
73
|
+
- **Mecanismo de Templates MVC**: Sistema profissional de visualização com suporte para filtros, helpers e hooks
|
|
74
|
+
- **Extensibilidade**: Sistema de hooks e filtros para personalização
|
|
75
|
+
|
|
76
|
+
## Instalação
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
npm install jerkjs
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Uso Básico
|
|
83
|
+
|
|
84
|
+
```javascript
|
|
85
|
+
const { APIServer, Router, Logger } = require('jerkjs');
|
|
86
|
+
|
|
87
|
+
// Criar instância do servidor
|
|
88
|
+
const server = new APIServer({
|
|
89
|
+
port: 3000,
|
|
90
|
+
host: 'localhost'
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
// Criar instância do logger
|
|
94
|
+
const logger = new Logger({ level: 'info' });
|
|
95
|
+
|
|
96
|
+
// Definir rotas
|
|
97
|
+
server.addRoute('GET', '/', (req, res) => {
|
|
98
|
+
res.writeHead(200, { 'Content-Type': 'application/json' });
|
|
99
|
+
res.end(JSON.stringify({ message: 'Olá Mundo!' }));
|
|
100
|
+
});
|
|
101
|
+
|
|
102
|
+
// Iniciar o servidor
|
|
103
|
+
server.start();
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## Componentes Principais
|
|
107
|
+
|
|
108
|
+
### APIServer
|
|
109
|
+
Servidor HTTP/HTTPS básico com suporte para rotas parametrizadas, middlewares e configuração avançada.
|
|
110
|
+
|
|
111
|
+
### Router
|
|
112
|
+
Sistema de roteamento avançado com suporte para rotas aninhadas e prefixos.
|
|
113
|
+
|
|
114
|
+
### Authenticator
|
|
115
|
+
Middleware de autenticação com suporte para múltiplos métodos (JWT, API Keys, Basic Auth, OAuth2, OpenID Connect).
|
|
116
|
+
|
|
117
|
+
### SecurityEnhancedServer
|
|
118
|
+
Servidor com recursos de segurança avançada (WAF) integrados.
|
|
119
|
+
|
|
120
|
+
### RouteLoader
|
|
121
|
+
Carregamento de rotas a partir de arquivos JSON com suporte para autenticação, controladores e especificação de tipo de conteúdo.
|
|
122
|
+
|
|
123
|
+
### TokenManager
|
|
124
|
+
Gerenciamento de tokens JWT com diferentes tipos de armazenamento (memória, JSON, SQLite, MariaDB).
|
|
125
|
+
|
|
126
|
+
### Firewall
|
|
127
|
+
Middleware de firewall com detecção de padrões de ataque e listas brancas/negras.
|
|
128
|
+
|
|
129
|
+
### Sistema de Hooks
|
|
130
|
+
Sistema de hooks e filtros semelhante ao WordPress para extensibilidade.
|
|
131
|
+
|
|
132
|
+
### SessionManager
|
|
133
|
+
Sistema completo de gerenciamento de sessões com suporte para autenticação baseada em sessões.
|
|
134
|
+
|
|
135
|
+
### ViewEngine
|
|
136
|
+
Mecanismo de templates profissional com suporte para filtros, helpers, condições, loops e hooks.
|
|
137
|
+
|
|
138
|
+
### ControllerBase
|
|
139
|
+
Controlador base que facilita o desenvolvimento de controladores MVC com suporte para visualizações.
|
|
140
|
+
|
|
141
|
+
## Segurança
|
|
142
|
+
|
|
143
|
+
O framework inclui múltiplas camadas de segurança:
|
|
144
|
+
|
|
145
|
+
- **Web Application Firewall (WAF)**: Detecção de injeção SQL, XSS, travessia de caminho, etc.
|
|
146
|
+
- **Limitação de Taxa**: Limitação de requisições por IP ou usuário
|
|
147
|
+
- **Firewall**: Bloqueio automático por tentativas falhas
|
|
148
|
+
- **Listas Brancas/Negras**: Controle de acesso por IP
|
|
149
|
+
- **Auditoria de Segurança**: Registro de eventos de segurança
|
|
150
|
+
- **Autenticação Robusta**: Suporte para múltiplos métodos de autenticação
|
|
151
|
+
|
|
152
|
+
## Sistema de Hooks
|
|
153
|
+
|
|
154
|
+
O framework inclui um sistema de hooks e filtros semelhante ao WordPress:
|
|
155
|
+
|
|
156
|
+
```javascript
|
|
157
|
+
const { hooks } = require('jerkjs');
|
|
158
|
+
|
|
159
|
+
// Registrar uma ação
|
|
160
|
+
hooks.addAction('firewall_request_blocked', (rule, clientIP, req, res) => {
|
|
161
|
+
console.log(`Solicitação bloqueada: ${rule.name} para IP: ${clientIP}`);
|
|
162
|
+
});
|
|
163
|
+
|
|
164
|
+
// Registrar um filtro
|
|
165
|
+
hooks.addFilter('session_create_data', (userData, req) => {
|
|
166
|
+
return {
|
|
167
|
+
...userData,
|
|
168
|
+
ipAddress: req.headers['x-forwarded-for'] || req.connection.remoteAddress,
|
|
169
|
+
createdAt: new Date().toISOString()
|
|
170
|
+
};
|
|
171
|
+
});
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
## Mecanismo de Templates MVC
|
|
175
|
+
|
|
176
|
+
O framework inclui um mecanismo de templates profissional com suporte para:
|
|
177
|
+
|
|
178
|
+
- Variáveis: `{{variable}}`
|
|
179
|
+
- Condições: `{{if variable}}conteúdo{{endif}}`
|
|
180
|
+
- Loops: `{{foreach:array}}conteúdo{{endforeach}}`
|
|
181
|
+
- Inclusões: `{{include:header}}`
|
|
182
|
+
- Filtros: `{{variable|upper}}`
|
|
183
|
+
- Helpers personalizados
|
|
184
|
+
|
|
185
|
+
## Gerenciamento de Sessões
|
|
186
|
+
|
|
187
|
+
O framework inclui um sistema completo de gerenciamento de sessões:
|
|
188
|
+
|
|
189
|
+
```javascript
|
|
190
|
+
const { SessionManager } = require('jerkjs');
|
|
191
|
+
|
|
192
|
+
const sessionManager = new SessionManager({
|
|
193
|
+
secret: 'your-session-secret',
|
|
194
|
+
timeout: 3600000 // 1 hora
|
|
195
|
+
});
|
|
196
|
+
|
|
197
|
+
// Usar como middleware
|
|
198
|
+
server.use(sessionManager.middleware());
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
## Exemplos
|
|
202
|
+
|
|
203
|
+
O projeto inclui vários exemplos completos:
|
|
204
|
+
|
|
205
|
+
- **v2_json_auth**: Autenticação JWT com tokens armazenados em JSON
|
|
206
|
+
- **v2_mariadb_auth**: Autenticação JWT com tokens armazenados em MariaDB
|
|
207
|
+
- **v2_sqlite_auth**: Autenticação JWT com tokens armazenados em SQLite
|
|
208
|
+
- **public**: API pública de exemplo com CORS e limitação de taxa
|
|
209
|
+
- **frontend**: Exemplo de servidor que combina API e frontend com diferentes tipos de conteúdo
|
|
210
|
+
- **hooks**: Exemplo avançado de uso do sistema de hooks com logging e rastreamento de solicitações
|
|
211
|
+
|
|
212
|
+
Para ver os exemplos completos, visite os diretórios `v2examplle/` e `examples/`.
|
|
213
|
+
|
|
214
|
+
## Documentação
|
|
215
|
+
|
|
216
|
+
Além da documentação no README, o projeto inclui documentação adicional:
|
|
217
|
+
|
|
218
|
+
- **Guia de início rápido**: `docs/guia_inicio_rapido_jerkjs.md` - Um guia completo para começar rapidamente com o JERKJS, incluindo formatos de arquivos, estrutura de controladores, mecanismo de templates e sistema de hooks.
|
|
219
|
+
|
|
220
|
+
## Contribuições
|
|
221
|
+
|
|
222
|
+
As contribuições são bem-vindas. Por favor, abra uma issue ou envie um pull request no GitLab.
|
|
223
|
+
|
|
224
|
+
## Licença
|
|
225
|
+
|
|
226
|
+
Apache 2.0
|
|
227
|
+
|
|
228
|
+
## Documentação do Framework
|
|
229
|
+
|
|
230
|
+
Para uma descrição detalhada da arquitetura e componentes do framework, consulte o arquivo [JERK_FRAMEWORK_DOCUMENTATION.md](JERK_FRAMEWORK_DOCUMENTATION.md).
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# Arquitectura del Sistema de Rutas en JERK Framework
|
|
2
|
+
|
|
3
|
+
## Descripción General
|
|
4
|
+
|
|
5
|
+
El sistema de rutas en JERK Framework permite definir endpoints de API mediante dos métodos principales:
|
|
6
|
+
1. Archivo JSON (`routes.json`) - Carga masiva de rutas
|
|
7
|
+
2. Método `addRoute()` - Definición individual de rutas
|
|
8
|
+
|
|
9
|
+
## Componentes Principales
|
|
10
|
+
|
|
11
|
+
### 1. APIServer (lib/core/server.js)
|
|
12
|
+
|
|
13
|
+
Componente principal que gestiona las rutas y el ciclo de vida de la solicitud HTTP.
|
|
14
|
+
|
|
15
|
+
**Características:**
|
|
16
|
+
- Almacena rutas en el array `this.routes`
|
|
17
|
+
- Implementa el método `addRoute(method, path, handler)` para definir rutas individuales
|
|
18
|
+
- Maneja el enrutamiento en `findRoute(method, pathname)`
|
|
19
|
+
- Soporta rutas parametrizadas con conversión a expresiones regulares
|
|
20
|
+
- Mantiene un cache de expresiones regulares para rutas parametrizadas
|
|
21
|
+
- Ejecuta middlewares antes de los handlers de rutas
|
|
22
|
+
|
|
23
|
+
**Método `addRoute`:**
|
|
24
|
+
- Recibe: método HTTP, path y handler
|
|
25
|
+
- No soporta autenticación por ruta
|
|
26
|
+
- No soporta content-type por ruta
|
|
27
|
+
- No carga controladores desde archivos externos
|
|
28
|
+
- Simplemente registra la ruta en el array
|
|
29
|
+
|
|
30
|
+
### 2. RouteLoader (lib/loader/routeLoader.js)
|
|
31
|
+
|
|
32
|
+
Componente encargado de cargar rutas desde archivos JSON.
|
|
33
|
+
|
|
34
|
+
**Características:**
|
|
35
|
+
- Lee y parsea archivos JSON de rutas
|
|
36
|
+
- Valida la estructura del archivo de rutas
|
|
37
|
+
- Carga controladores desde archivos externos
|
|
38
|
+
- Aplica autenticación por ruta
|
|
39
|
+
- Aplica content-type por ruta
|
|
40
|
+
- Dispara hooks antes y después de cargar rutas
|
|
41
|
+
- Soporta recarga automática de rutas
|
|
42
|
+
|
|
43
|
+
**Método `loadSingleRoute`:**
|
|
44
|
+
- Carga el módulo del controlador
|
|
45
|
+
- Obtiene el handler del controlador
|
|
46
|
+
- Aplica content-type si está especificado
|
|
47
|
+
- Aplica autenticación si está especificada
|
|
48
|
+
- Integra el handler procesado con el servidor usando `server.addRoute`
|
|
49
|
+
|
|
50
|
+
## Funcionalidades Soportadas por routes.json
|
|
51
|
+
|
|
52
|
+
### 1. Estructura Básica
|
|
53
|
+
```json
|
|
54
|
+
{
|
|
55
|
+
"path": "/ruta/ejemplo",
|
|
56
|
+
"method": "GET",
|
|
57
|
+
"controller": "./controllers/EjemploController.js",
|
|
58
|
+
"handler": "metodoHandler"
|
|
59
|
+
}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### 2. Content-Type por Ruta
|
|
63
|
+
```json
|
|
64
|
+
{
|
|
65
|
+
"contentType": "application/json"
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### 3. Autenticación por Ruta
|
|
70
|
+
```json
|
|
71
|
+
{
|
|
72
|
+
"auth": "jwt",
|
|
73
|
+
"authOptions": {
|
|
74
|
+
"jwtSecret": "secreto-ejemplo"
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Tipos de autenticación soportados:
|
|
80
|
+
- `jwt` - Autenticación JWT
|
|
81
|
+
- `apiKey` - Autenticación por API Key
|
|
82
|
+
- `session` - Autenticación por sesión
|
|
83
|
+
- Otros tipos registrados en el authenticator
|
|
84
|
+
|
|
85
|
+
### 4. Rutas Parametrizadas
|
|
86
|
+
Soporta rutas con parámetros como `/usuarios/:id` que se convierten a expresiones regulares.
|
|
87
|
+
|
|
88
|
+
## Comparativa: routes.json vs addRoute()
|
|
89
|
+
|
|
90
|
+
| Característica | routes.json | addRoute() |
|
|
91
|
+
|---|---|---|
|
|
92
|
+
| Definición de rutas | Masiva (archivo JSON) | Individual |
|
|
93
|
+
| Carga de controladores | Automática desde archivos | Manual (función handler) |
|
|
94
|
+
| Autenticación por ruta | ✅ Soportada | ❌ No soportada |
|
|
95
|
+
| Content-Type por ruta | ✅ Soportado | ❌ No soportado |
|
|
96
|
+
| Opciones de autenticación | ✅ Soportadas | ❌ No soportadas |
|
|
97
|
+
| Rutas parametrizadas | ✅ Soportadas | ✅ Soportadas |
|
|
98
|
+
| Integración con hooks | ✅ Soportada | ❌ No soportada |
|
|
99
|
+
|
|
100
|
+
## Flujo de Procesamiento de Rutas
|
|
101
|
+
|
|
102
|
+
### Para routes.json:
|
|
103
|
+
1. `RouteLoader.loadRoutes()` lee el archivo JSON
|
|
104
|
+
2. Valida la estructura del archivo
|
|
105
|
+
3. Para cada ruta, `loadSingleRoute()`:
|
|
106
|
+
- Carga el módulo del controlador
|
|
107
|
+
- Obtiene el handler
|
|
108
|
+
- Aplica content-type si existe
|
|
109
|
+
- Aplica autenticación si existe
|
|
110
|
+
- Llama a `server.addRoute()` con el handler procesado
|
|
111
|
+
4. El servidor procesa las solicitudes normalmente
|
|
112
|
+
|
|
113
|
+
### Para addRoute():
|
|
114
|
+
1. Cliente llama directamente `server.addRoute(method, path, handler)`
|
|
115
|
+
2. La ruta se registra directamente en `this.routes`
|
|
116
|
+
3. El servidor procesa las solicitudes normalmente
|
|
117
|
+
|
|
118
|
+
## Problemas Identificados
|
|
119
|
+
|
|
120
|
+
### 1. Incompatibilidad entre ambos sistemas
|
|
121
|
+
- No hay coordinación entre rutas definidas vía `routes.json` y `addRoute()`
|
|
122
|
+
- Ambos sistemas operan de forma independiente
|
|
123
|
+
|
|
124
|
+
### 2. Diferencia de funcionalidades
|
|
125
|
+
- `routes.json` soporta muchas más características que `addRoute()`
|
|
126
|
+
- `addRoute()` es mucho más básico
|
|
127
|
+
|
|
128
|
+
## Soluciones Potenciales
|
|
129
|
+
|
|
130
|
+
### 1. Extender el método addRoute()
|
|
131
|
+
Modificar `addRoute()` para que acepte un objeto de opciones similar al usado en `routes.json`, permitiendo:
|
|
132
|
+
- Especificar content-type
|
|
133
|
+
- Configurar autenticación
|
|
134
|
+
- Definir opciones de autenticación
|
|
135
|
+
|
|
136
|
+
### 2. Crear un método interno común
|
|
137
|
+
Crear un método interno que procese las rutas con todas las funcionalidades y que sea utilizado tanto por `RouteLoader` como por `addRoute()`.
|
|
138
|
+
|
|
139
|
+
### 3. Mantener compatibilidad
|
|
140
|
+
Cualquier cambio debe mantener la compatibilidad con el sistema existente de `routes.json`.
|