jerkjs 2.1.6 → 2.2.0
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 +36 -0
- package/README.md +202 -5
- package/index.js +29 -4
- package/lib/core/server.js +328 -27
- package/lib/loader/routeLoader.js +148 -117
- package/lib/middleware/compressor.js +87 -18
- package/lib/mvc/GenericAdapter.js +136 -0
- package/lib/mvc/MariaDBAdapter.js +315 -0
- package/lib/mvc/MemoryAdapter.js +269 -0
- package/lib/mvc/ModelControllerExample.js +285 -0
- package/lib/mvc/controllerBase.js +60 -0
- package/lib/mvc/modelBase.js +383 -0
- package/lib/mvc/modelManager.js +284 -0
- package/lib/mvc/userModel.js +265 -0
- package/lib/mvc/viewEngine.js +32 -1
- package/lib/utils/mimeType.js +62 -0
- package/package.json +5 -3
- package/JERK_FRAMEWORK_DIAGRAM.txt +0 -492
- package/JERK_FRAMEWORK_DIAGRAM_MERMAID.mmd +0 -124
- package/JERK_FRAMEWORK_DOCUMENTATION.md +0 -527
- package/LICENSE +0 -201
- package/README_EN.md +0 -230
- package/README_PT.md +0 -230
- package/docs/ARQUITECTURA_ROUTES.md +0 -140
- package/docs/EXTENSION_MANUAL.md +0 -955
- package/docs/FIREWALL_MANUAL.md +0 -416
- package/docs/HOOK-2.0.md +0 -512
- package/docs/HOOKS_REFERENCE_IMPROVED.md +0 -596
- package/docs/MANUAL_API_SDK.md +0 -536
- package/docs/MARIADB_TOKENS_IMPLEMENTATION.md +0 -110
- package/docs/MIDDLEWARE_MANUAL.md +0 -518
- package/docs/OAUTH2_GOOGLE_MANUAL.md +0 -405
- package/docs/ROUTING_WITHOUT_JSON_GUIDE.md +0 -454
- package/docs/frontend-and-sessions.md +0 -353
- package/docs/guia_inicio_rapido_jerkjs.md +0 -113
- package/examples/examples.arj +0 -0
- package/standard/CompressionTestController.js +0 -56
- package/standard/HealthController.js +0 -16
- package/standard/HomeController.js +0 -12
- package/standard/ProductController.js +0 -18
- package/standard/README.md +0 -47
- package/standard/UserController.js +0 -23
- package/standard/package.json +0 -22
- package/standard/routes.json +0 -65
- package/standard/server.js +0 -140
- package/standardA/controllers/AuthController.js +0 -82
- package/standardA/controllers/HomeController.js +0 -19
- package/standardA/controllers/UserController.js +0 -41
- package/standardA/server.js +0 -311
- package/standardA/views/auth/dashboard.html +0 -51
- package/standardA/views/auth/login.html +0 -47
- package/standardA/views/index.html +0 -32
- package/standardA/views/users/detail.html +0 -28
- package/standardA/views/users/list.html +0 -36
package/LICENSE
DELETED
|
@@ -1,201 +0,0 @@
|
|
|
1
|
-
Apache License
|
|
2
|
-
Version 2.0, January 2004
|
|
3
|
-
http://www.apache.org/licenses/
|
|
4
|
-
|
|
5
|
-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
-
|
|
7
|
-
1. Definitions.
|
|
8
|
-
|
|
9
|
-
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
-
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
-
|
|
12
|
-
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
-
the copyright owner that is granting the License.
|
|
14
|
-
|
|
15
|
-
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
-
other entities that control, are controlled by, or are under common
|
|
17
|
-
control with that entity. For the purposes of this definition,
|
|
18
|
-
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
-
direction or management of such entity, whether by contract or
|
|
20
|
-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
-
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
-
|
|
23
|
-
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
-
exercising permissions granted by this License.
|
|
25
|
-
|
|
26
|
-
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
-
including but not limited to software source code, documentation
|
|
28
|
-
source, and configuration files.
|
|
29
|
-
|
|
30
|
-
"Object" form shall mean any form resulting from mechanical
|
|
31
|
-
transformation or translation of a Source form, including but
|
|
32
|
-
not limited to compiled object code, generated documentation,
|
|
33
|
-
and conversions to other media types.
|
|
34
|
-
|
|
35
|
-
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
-
Object form, made available under the License, as indicated by a
|
|
37
|
-
copyright notice that is included in or attached to the work
|
|
38
|
-
(an example is provided in the Appendix below).
|
|
39
|
-
|
|
40
|
-
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
-
form, that is based on (or derived from) the Work and for which the
|
|
42
|
-
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
-
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
-
of this License, Derivative Works shall not include works that remain
|
|
45
|
-
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
-
the Work and Derivative Works thereof.
|
|
47
|
-
|
|
48
|
-
"Contribution" shall mean any work of authorship, including
|
|
49
|
-
the original version of the Work and any modifications or additions
|
|
50
|
-
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
-
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
-
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
-
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
-
means any form of electronic, verbal, or written communication sent
|
|
55
|
-
to the Licensor or its representatives, including but not limited to
|
|
56
|
-
communication on electronic mailing lists, source code control systems,
|
|
57
|
-
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
-
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
-
excluding communication that is conspicuously marked or otherwise
|
|
60
|
-
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
-
|
|
62
|
-
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
-
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
-
subsequently incorporated within the Work.
|
|
65
|
-
|
|
66
|
-
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
-
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
-
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
-
Work and such Derivative Works in Source or Object form.
|
|
72
|
-
|
|
73
|
-
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
-
(except as stated in this section) patent license to make, have made,
|
|
77
|
-
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
-
where such license applies only to those patent claims licensable
|
|
79
|
-
by such Contributor that are necessarily infringed by their
|
|
80
|
-
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
-
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
-
institute patent litigation against any entity (including a
|
|
83
|
-
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
-
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
-
or contributory patent infringement, then any patent licenses
|
|
86
|
-
granted to You under this License for that Work shall terminate
|
|
87
|
-
as of the date such litigation is filed.
|
|
88
|
-
|
|
89
|
-
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
-
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
-
modifications, and in Source or Object form, provided that You
|
|
92
|
-
meet the following conditions:
|
|
93
|
-
|
|
94
|
-
(a) You must give any other recipients of the Work or
|
|
95
|
-
Derivative Works a copy of this License; and
|
|
96
|
-
|
|
97
|
-
(b) You must cause any modified files to carry prominent notices
|
|
98
|
-
stating that You changed the files; and
|
|
99
|
-
|
|
100
|
-
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
-
that You distribute, all copyright, patent, trademark, and
|
|
102
|
-
attribution notices from the Source form of the Work,
|
|
103
|
-
excluding those notices that do not pertain to any part of
|
|
104
|
-
the Derivative Works; and
|
|
105
|
-
|
|
106
|
-
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
-
distribution, then any Derivative Works that You distribute must
|
|
108
|
-
include a readable copy of the attribution notices contained
|
|
109
|
-
within such NOTICE file, excluding those notices that do not
|
|
110
|
-
pertain to any part of the Derivative Works, in at least one
|
|
111
|
-
of the following places: within a NOTICE text file distributed
|
|
112
|
-
as part of the Derivative Works; within the Source form or
|
|
113
|
-
documentation, if provided along with the Derivative Works; or,
|
|
114
|
-
within a display generated by the Derivative Works, if and
|
|
115
|
-
wherever such third-party notices normally appear. The contents
|
|
116
|
-
of the NOTICE file are for informational purposes only and
|
|
117
|
-
do not modify the License. You may add Your own attribution
|
|
118
|
-
notices within Derivative Works that You distribute, alongside
|
|
119
|
-
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
-
that such additional attribution notices cannot be construed
|
|
121
|
-
as modifying the License.
|
|
122
|
-
|
|
123
|
-
You may add Your own copyright statement to Your modifications and
|
|
124
|
-
may provide additional or different license terms and conditions
|
|
125
|
-
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
-
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
-
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
-
the conditions stated in this License.
|
|
129
|
-
|
|
130
|
-
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
-
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
-
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
-
this License, without any additional terms or conditions.
|
|
134
|
-
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
-
the terms of any separate license agreement you may have executed
|
|
136
|
-
with Licensor regarding such Contributions.
|
|
137
|
-
|
|
138
|
-
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
-
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
-
except as required for reasonable and customary use in describing the
|
|
141
|
-
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
-
|
|
143
|
-
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
-
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
-
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
-
implied, including, without limitation, any warranties or conditions
|
|
148
|
-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
-
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
-
appropriateness of using or redistributing the Work and assume any
|
|
151
|
-
risks associated with Your exercise of permissions under this License.
|
|
152
|
-
|
|
153
|
-
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
-
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
-
unless required by applicable law (such as deliberate and grossly
|
|
156
|
-
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
-
liable to You for damages, including any direct, indirect, special,
|
|
158
|
-
incidental, or consequential damages of any character arising as a
|
|
159
|
-
result of this License or out of the use or inability to use the
|
|
160
|
-
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
-
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
-
other commercial damages or losses), even if such Contributor
|
|
163
|
-
has been advised of the possibility of such damages.
|
|
164
|
-
|
|
165
|
-
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
-
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
-
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
-
or other liability obligations and/or rights consistent with this
|
|
169
|
-
License. However, in accepting such obligations, You may act only
|
|
170
|
-
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
-
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
-
defend, and hold each Contributor harmless for any liability
|
|
173
|
-
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
-
of your accepting any such warranty or additional liability.
|
|
175
|
-
|
|
176
|
-
END OF TERMS AND CONDITIONS
|
|
177
|
-
|
|
178
|
-
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
-
|
|
180
|
-
To apply the Apache License to your work, attach the following
|
|
181
|
-
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
-
replaced with your own identifying information. (Don't include
|
|
183
|
-
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
-
comment syntax for the file format. We also recommend that a
|
|
185
|
-
file or class name and description of purpose be included on the
|
|
186
|
-
same "printed page" as the copyright notice for easier
|
|
187
|
-
identification within third-party archives.
|
|
188
|
-
|
|
189
|
-
Copyright [yyyy] [name of copyright owner]
|
|
190
|
-
|
|
191
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
-
you may not use this file except in compliance with the License.
|
|
193
|
-
You may obtain a copy of the License at
|
|
194
|
-
|
|
195
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
-
|
|
197
|
-
Unless required by applicable law or agreed to in writing, software
|
|
198
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
-
See the License for the specific language governing permissions and
|
|
201
|
-
limitations under the License.
|
package/README_EN.md
DELETED
|
@@ -1,230 +0,0 @@
|
|
|
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
DELETED
|
@@ -1,230 +0,0 @@
|
|
|
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).
|