@athenna/http 4.23.0 → 4.24.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "4.23.0",
+  "version": "4.24.0",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -72,14 +72,14 @@
     "#tests": "./tests/index.js"
   },
   "devDependencies": {
-    "@athenna/artisan": "^4.37.0",
-    "@athenna/common": "^4.34.0",
-    "@athenna/config": "^4.16.0",
-    "@athenna/ioc": "^4.16.0",
-    "@athenna/logger": "^4.17.0",
+    "@athenna/artisan": "^4.38.0",
+    "@athenna/common": "^4.35.0",
+    "@athenna/config": "^4.18.0",
+    "@athenna/ioc": "^4.18.0",
+    "@athenna/logger": "^4.18.0",
     "@athenna/test": "^4.22.0",
     "@athenna/tsconfig": "^4.12.0",
-    "@athenna/view": "^4.18.0",
+    "@athenna/view": "^4.20.0",
     "@fastify/cors": "^8.4.2",
     "@fastify/helmet": "^11.1.1",
     "@fastify/rate-limit": "^8.1.1",

package/src/commands/RouteListCommand.js

@@ -8,8 +8,8 @@
  */
 import { sep } from 'node:path';
 import { Config } from '@athenna/config';
-import { Module } from '@athenna/common';
 import { BaseCommand } from '@athenna/artisan';
+import { Path, Module } from '@athenna/common';
 import { Route, HttpKernel, HttpRouteProvider, HttpServerProvider } from '#src';
 export class RouteListCommand extends BaseCommand {
     static signature() {

package/src/context/Request.d.ts

@@ -16,121 +16,225 @@ export declare class Request {
     /**
      * Get the request id.
      *
-     * @example 12345
+     * @example
+     * ```ts
+     * console.log(request.id) // '12345'
+     * ```
      */
     get id(): string;
     /**
      * Get the request ip.
      *
-     * @example 192.168.0.1
+     * @example
+     * ```ts
+     * console.log(request.ip) // '192.168.0.1'
+     * ```
      */
     get ip(): string;
     /**
      * Get the request hostname.
      *
-     * @example localhost
+     * @example
+     * ```ts
+     * console.log(request.hostname) // 'localhost'
+     * ```
      */
     get hostname(): string;
+    /**
+     * Get the server port.
+     *
+     * @example
+     * ```ts
+     * console.log(request.port) // 3000
+     * ```
+     */
+    get port(): number;
+    /**
+     * Get the http version.
+     *
+     * @example
+     * ```ts
+     * console.log(request.version) // 1
+     * ```
+     */
+    get version(): string;
     /**
      * Get the request protocol.
      *
-     * @example http
+     * @example
+     * ```ts
+     * console.log(request.protocol) // 'http'
+     * ```
      */
     get protocol(): 'http' | 'https';
     /**
      * Get the request method.
      *
-     * @example GET
+     * @example
+     * ```ts
+     * console.log(request.method) // 'GET'
+     * ```
      */
     get method(): string;
     /**
      * Get the base url from request.
      *
-     * @example /users/1
+     * @example
+     * ```ts
+     * console.log(request.baseUrl) // '/users/1'
+     * ```
      */
     get baseUrl(): string;
     /**
      * Get the base url with host and port info from request.
      *
-     * @example http://localhost:3030/users/1
+     * @example
+     * ```ts
+     * console.log(request.baseHostUrl) // 'http://localhost:3030/users/1'
+     * ```
      */
     get baseHostUrl(): string;
     /**
      * Get the route url from request.
      *
-     * @example /users/:id
+     * @example
+     * ```ts
+     * console.log(request.routeUrl) // '/users/:id'
+     * ```
      */
     get routeUrl(): string;
     /**
      * Get the route url with host and port info from request.
      *
-     * @example http://localhost:3030/users/:id
+     * @example
+     * ```ts
+     * console.log(request.routeHostUrl) // 'http://localhost:3030/users/:id'
+     * ```
      */
     get routeHostUrl(): string;
     /**
      * Get the original url from request.
      *
-     * @example /users/1?query=true
+     * @example
+     * ```ts
+     * console.log(request.originalUrl) // '/users/1?query=true'
+     * ```
      */
     get originalUrl(): string;
     /**
      * Get the original url with host and port info from request.
      *
-     * @example /users/1?query=true
+     * @example
+     * ```ts
+     * console.log(request.originalHostUrl) // 'http://localhost:3000/users/1?query=true'
+     * ```
      */
     get originalHostUrl(): string;
     /**
      * Get all body from request.
+     *
+     * @example
+     * ```ts
+     * const { name, email } = request.body
+     * ```
      */
     get body(): any | any[];
     /**
      * Get all params from request.
+     *
+     * @example
+     * ```ts
+     * const { id } = request.params
+     * ```
      */
     get params(): any;
     /**
      * Get all queries from request.
+     *
+     * @example
+     * ```ts
+     * const { page, limit } = request.queries
+     * ```
      */
     get queries(): any;
     /**
      * Get all headers from request.
+     *
+     * @example
+     * ```ts
+     * const { accept } = request.headers
+     * ```
      */
     get headers(): any;
     /**
-     * Get the server port.
-     */
-    get port(): number;
-    /**
-     * Get the http version.
-     */
-    get version(): string;
-    /**
-     * Get a value from the request params or the default value.
+     * Get a value from the request params or return
+     * the default value.
+     *
+     * @example
+     * ```ts
+     * const id = request.param('id', '1')
+     * ```
      */
     param(param: string, defaultValue?: any): any;
     /**
-     * Get a value from the request query param or the default value.
+     * Get a value from the request query param or return
+     * the default value.
+     *
+     * @example
+     * ```ts
+     * const page = request.query('page', '1')
+     * ```
      */
     query(query: string, defaultValue?: any): any;
     /**
-     * Get a value from the request header or the default value.
+     * Get a value from the request header or return
+     * the default value.
+     *
+     * @example
+     * ```ts
+     * const accept = request.header('accept', 'application/json')
+     * ```
      */
     header(header: string, defaultValue?: any): any;
     /**
-     * Get only the selected values from the request body.
+     * Get a value from the request body or return
+     * the default value.
+     *
+     * @example
+     * ```ts
+     * const name = request.input('name', 'lenon')
+     * ```
      */
-    only(keys: string[]): any;
+    input(key: string, defaultValue?: any): any;
     /**
-     * Get all the values from the request body except the selected ones.
+     * Get a value from the request body or return
+     * the default value.
+     *
+     * @example
+     * ```ts
+     * const name = request.payload('name', 'lenon')
+     * ```
      */
-    except(keys: string[]): any;
+    payload(key: string, defaultValue?: any): any;
     /**
-     * Get a value from the request body or the default value.
+     * Get only the selected values from the request body.
+     *
+     * @example
+     * ```ts
+     * const body = request.only(['name', 'email'])
+     * ```
      */
-    input(key: string, defaultValue?: any): any;
+    only(keys: string[]): any;
     /**
-     * Get a value from the request body or the default value.
+     * Get all the values from the request body except the
+     * selected ones.
+     *
+     * @example
+     * ```ts
+     * const body = request.except(['name'])
+     * ```
      */
-    payload(key: string, defaultValue?: any): any;
+    except(keys: string[]): any;
     /**
      * Add the hostname and port to the url.
      */

package/src/context/Request.js

@@ -14,7 +14,10 @@ export class Request {
     /**
      * Get the request id.
      *
-     * @example 12345
+     * @example
+     * ```ts
+     * console.log(request.id) // '12345'
+     * ```
      */
     get id() {
         return this.request.id;
@@ -22,7 +25,10 @@ export class Request {
     /**
      * Get the request ip.
      *
-     * @example 192.168.0.1
+     * @example
+     * ```ts
+     * console.log(request.ip) // '192.168.0.1'
+     * ```
      */
     get ip() {
         return this.request.ip;
@@ -30,15 +36,43 @@ export class Request {
     /**
      * Get the request hostname.
      *
-     * @example localhost
+     * @example
+     * ```ts
+     * console.log(request.hostname) // 'localhost'
+     * ```
      */
     get hostname() {
         return this.request.hostname;
     }
+    /**
+     * Get the server port.
+     *
+     * @example
+     * ```ts
+     * console.log(request.port) // 3000
+     * ```
+     */
+    get port() {
+        return this.getAddressInfo().port;
+    }
+    /**
+     * Get the http version.
+     *
+     * @example
+     * ```ts
+     * console.log(request.version) // 1
+     * ```
+     */
+    get version() {
+        return this.request.raw.httpVersion;
+    }
     /**
      * Get the request protocol.
      *
-     * @example http
+     * @example
+     * ```ts
+     * console.log(request.protocol) // 'http'
+     * ```
      */
     get protocol() {
         return this.request.protocol;
@@ -46,7 +80,10 @@ export class Request {
     /**
      * Get the request method.
      *
-     * @example GET
+     * @example
+     * ```ts
+     * console.log(request.method) // 'GET'
+     * ```
      */
     get method() {
         return this.request.method;
@@ -54,7 +91,10 @@ export class Request {
     /**
      * Get the base url from request.
      *
-     * @example /users/1
+     * @example
+     * ```ts
+     * console.log(request.baseUrl) // '/users/1'
+     * ```
      */
     get baseUrl() {
         return this.request.url.split('?')[0];
@@ -62,7 +102,10 @@ export class Request {
     /**
      * Get the base url with host and port info from request.
      *
-     * @example http://localhost:3030/users/1
+     * @example
+     * ```ts
+     * console.log(request.baseHostUrl) // 'http://localhost:3030/users/1'
+     * ```
      */
     get baseHostUrl() {
         return this.getHostUrlFor(this.baseUrl);
@@ -70,7 +113,10 @@ export class Request {
     /**
      * Get the route url from request.
      *
-     * @example /users/:id
+     * @example
+     * ```ts
+     * console.log(request.routeUrl) // '/users/:id'
+     * ```
      */
     get routeUrl() {
         return this.request.routeOptions.url;
@@ -78,7 +124,10 @@ export class Request {
     /**
      * Get the route url with host and port info from request.
      *
-     * @example http://localhost:3030/users/:id
+     * @example
+     * ```ts
+     * console.log(request.routeHostUrl) // 'http://localhost:3030/users/:id'
+     * ```
      */
     get routeHostUrl() {
         return this.getHostUrlFor(this.routeUrl);
@@ -86,7 +135,10 @@ export class Request {
     /**
      * Get the original url from request.
      *
-     * @example /users/1?query=true
+     * @example
+     * ```ts
+     * console.log(request.originalUrl) // '/users/1?query=true'
+     * ```
      */
     get originalUrl() {
         return this.request.url;
@@ -94,67 +146,125 @@ export class Request {
     /**
      * Get the original url with host and port info from request.
      *
-     * @example /users/1?query=true
+     * @example
+     * ```ts
+     * console.log(request.originalHostUrl) // 'http://localhost:3000/users/1?query=true'
+     * ```
      */
     get originalHostUrl() {
         return this.getHostUrlFor(this.originalUrl);
     }
     /**
      * Get all body from request.
+     *
+     * @example
+     * ```ts
+     * const { name, email } = request.body
+     * ```
      */
     get body() {
         return this.request.body || {};
     }
     /**
      * Get all params from request.
+     *
+     * @example
+     * ```ts
+     * const { id } = request.params
+     * ```
      */
     get params() {
         return this.request.params || {};
     }
     /**
      * Get all queries from request.
+     *
+     * @example
+     * ```ts
+     * const { page, limit } = request.queries
+     * ```
      */
     get queries() {
         return this.request.query || {};
     }
     /**
      * Get all headers from request.
+     *
+     * @example
+     * ```ts
+     * const { accept } = request.headers
+     * ```
      */
     get headers() {
         return this.request.headers || {};
     }
     /**
-     * Get the server port.
+     * Get a value from the request params or return
+     * the default value.
+     *
+     * @example
+     * ```ts
+     * const id = request.param('id', '1')
+     * ```
      */
-    get port() {
-        return this.getAddressInfo().port;
+    param(param, defaultValue) {
+        return Json.get(this.params, param, defaultValue);
     }
     /**
-     * Get the http version.
+     * Get a value from the request query param or return
+     * the default value.
+     *
+     * @example
+     * ```ts
+     * const page = request.query('page', '1')
+     * ```
      */
-    get version() {
-        return this.request.raw.httpVersion;
+    query(query, defaultValue) {
+        return Json.get(this.queries, query, defaultValue);
     }
     /**
-     * Get a value from the request params or the default value.
+     * Get a value from the request header or return
+     * the default value.
+     *
+     * @example
+     * ```ts
+     * const accept = request.header('accept', 'application/json')
+     * ```
      */
-    param(param, defaultValue) {
-        return this.params[param] || defaultValue;
+    header(header, defaultValue) {
+        return Json.get(this.headers, header, defaultValue);
     }
     /**
-     * Get a value from the request query param or the default value.
+     * Get a value from the request body or return
+     * the default value.
+     *
+     * @example
+     * ```ts
+     * const name = request.input('name', 'lenon')
+     * ```
      */
-    query(query, defaultValue) {
-        return this.queries[query] || defaultValue;
+    input(key, defaultValue) {
+        return this.payload(key, defaultValue);
     }
     /**
-     * Get a value from the request header or the default value.
+     * Get a value from the request body or return
+     * the default value.
+     *
+     * @example
+     * ```ts
+     * const name = request.payload('name', 'lenon')
+     * ```
      */
-    header(header, defaultValue) {
-        return this.headers[header] || defaultValue;
+    payload(key, defaultValue) {
+        return Json.get(this.body, key, defaultValue);
     }
     /**
      * Get only the selected values from the request body.
+     *
+     * @example
+     * ```ts
+     * const body = request.only(['name', 'email'])
+     * ```
      */
     only(keys) {
         const body = {};
@@ -167,7 +277,13 @@ export class Request {
         return body;
     }
     /**
-     * Get all the values from the request body except the selected ones.
+     * Get all the values from the request body except the
+     * selected ones.
+     *
+     * @example
+     * ```ts
+     * const body = request.except(['name'])
+     * ```
      */
     except(keys) {
         const body = {};
@@ -179,18 +295,6 @@ export class Request {
         });
         return body;
     }
-    /**
-     * Get a value from the request body or the default value.
-     */
-    input(key, defaultValue) {
-        return this.payload(key, defaultValue);
-    }
-    /**
-     * Get a value from the request body or the default value.
-     */
-    payload(key, defaultValue) {
-        return Json.get(this.body, key, defaultValue);
-    }
     /**
      * Add the hostname and port to the url.
      */

package/src/context/Response.d.ts

@@ -21,67 +21,196 @@ export declare class Response {
     request: Request;
     constructor(response: FastifyReply, request?: Request);
     /**
-     * Verify if the response has been already sent.
+     * Verify if the response has been already sent. Keep
+     * in mind that this method will only return `true`
+     * after `response.send()`, `response.view()`,
+     * `response.sendFile()` or `response.download()` methods
+     * call.
+     *
+     * @example
+     * ```ts
+     * if (response.sent) {
+     *  // do something
+     * }
+     * ```
      */
     get sent(): boolean;
     /**
-     * Get the response body sent in response.
+     * Get the response body sent in response. Keep
+     * in mind that this method will only return `true`
+     * after `response.send()`, `response.view()`,
+     * `response.sendFile()` or `response.download()` methods
+     * call.
+     *
+     * @example
+     * ```ts
+     * const { createdAt, updatedAt } = response.body
+     * ```
      */
     get body(): any | any[];
     /**
-     * Get the status code sent in response.
+     * Get the status code sent in response. Keep
+     * in mind that this method will only return `true`
+     * after `response.send()`, `response.view()`,
+     * `response.sendFile()` or `response.download()` methods
+     * call.
+     *
+     * @example
+     * ```ts
+     * if (response.statusCode !== 200) {
+     *  // do something
+     * }
+     * ```
      */
     get statusCode(): number;
     /**
-     * Get the headers sent in response.
+     * Get the headers set in the response.
+     *
+     * @example
+     * ```ts
+     * const headers = response.headers
+     * ```
      */
     get headers(): any;
     /**
-     * Get the time in MS of how much the request has taken to response.
+     * Get the time in MS of how much the request has
+     * taken to response. Keep in mind that this method
+     * will only return `true` after `response.send()`,
+     * `response.view()`, `response.sendFile()` or
+     * `response.download()` methods call.
+     *
+     * @example
+     * ```ts
+     * console.log(response.responseTime) // 1000
+     * ```
      */
     get responseTime(): number;
     /**
-     * Terminated the request sending a view to be rendered.
+     * Terminate the request sending a view to be rendered.
+     *
+     * @example
+     * ```ts
+     * return response.view('welcome', { name: 'lenon' })
+     * ```
      */
     view(view: string, data?: any): Promise<Response>;
     /**
      * Terminate the request sending the response body or not.
+     *
+     * @example
+     * ```ts
+     * return response.send({ name: 'lenon' })
+     * ```
      */
     send(data?: any): Promise<Response>;
+    /**
+     * @example
+     * ```ts
+     * return response.sendFile('img.png')
+     * ```
+     */
     sendFile(filename: string, filepath?: string): Promise<Response>;
+    /**
+     * @example
+     * ```ts
+     * return response.sendFile('img.png', { cacheControl: false })
+     * ```
+     */
     sendFile(filename: string, options?: string | SendOptions): Promise<Response>;
+    /**
+     * @example
+     * ```ts
+     * return response.sendFile('img.png', Path.tmp(), {
+     *  cacheControl: false
+     * })
+     * ```
+     */
     sendFile(filename: string, filepath?: string, options?: SendOptions): Promise<Response>;
-    download(filepath: string, filename?: string): Promise<Response>;
-    download(filepath: string, options?: string | SendOptions): Promise<Response>;
-    download(filename: string, filepath?: string, options?: SendOptions): Promise<Response>;
+    /**
+     * @example
+     * ```ts
+     * return response.download('img.png', 'custom-img.png')
+     * ```
+     */
+    download(filepath: string, filename: string): Promise<Response>;
+    /**
+     * @example
+     * ```ts
+     * return response.download('img.png', 'custom-img.png', {
+     *  cacheControl: false
+     * })
+     * ```
+     */
+    download(filepath: string, filename: string, options?: SendOptions): Promise<Response>;
     /**
      * Set the response status code.
+     *
+     * @example
+     * ```ts
+     * return response.status(200).send()
+     * ```
      */
     status(code: number): Response;
     /**
      * Add some header to the response.
+     *
+     * @example
+     * ```ts
+     * response.header('content-type', 'application/json')
+     *
+     * return response.header('accept-encoding', 'gzip').send(user)
+     * ```
      */
     header(header: string, value: any): Response;
     /**
      * Verify if response has some header.
+     *
+     * @example
+     * ```ts
+     * if (response.hasHeader('content-type')) {
+     *   // do something
+     * }
+     * ```
      */
     hasHeader(header: string): boolean;
     /**
-     * Add some header safely to the response. This means that the header is not
-     * going to be added if is already set.
+     * Add some header safely to the response. This means that
+     * the header is not going to be added if is already set.
+     *
+     * @example
+     * ```ts
+     * response.safeHeader('content-type', 'application/json')
+     * ```
      */
     safeHeader(header: string, value: any): Response;
     /**
      * Remove some header from the response.
+     *
+     * @example
+     * ```ts
+     * response.removeHeader('content-type')
+     * ```
      */
     removeHeader(header: string): Response;
     /**
-     * Redirect the response to other url. You can also set a different status code
-     * for the redirect.
+     * Redirect the response to other url. You can also set a
+     * different status code for the redirect.
+     *
+     * @example
+     * ```ts
+     * return response.redirect('users', 304)
+     * ```
      */
     redirectTo(url: string, status?: number): Promise<Response>;
     /**
      * Apply helmet in response.
+     *
+     * @example
+     * ```ts
+     * return response
+     *  .helmet({ enableCSPNonces: false })
+     *  .view('profile', user)
+     * ```
      */
     helmet(options: FastifyHelmetOptions): Response;
 }

package/src/context/Response.js

@@ -13,37 +13,87 @@ export class Response {
         this.request = request;
     }
     /**
-     * Verify if the response has been already sent.
+     * Verify if the response has been already sent. Keep
+     * in mind that this method will only return `true`
+     * after `response.send()`, `response.view()`,
+     * `response.sendFile()` or `response.download()` methods
+     * call.
+     *
+     * @example
+     * ```ts
+     * if (response.sent) {
+     *  // do something
+     * }
+     * ```
      */
     get sent() {
         return this.response.sent;
     }
     /**
-     * Get the response body sent in response.
+     * Get the response body sent in response. Keep
+     * in mind that this method will only return `true`
+     * after `response.send()`, `response.view()`,
+     * `response.sendFile()` or `response.download()` methods
+     * call.
+     *
+     * @example
+     * ```ts
+     * const { createdAt, updatedAt } = response.body
+     * ```
      */
     get body() {
         return this.response.body;
     }
     /**
-     * Get the status code sent in response.
+     * Get the status code sent in response. Keep
+     * in mind that this method will only return `true`
+     * after `response.send()`, `response.view()`,
+     * `response.sendFile()` or `response.download()` methods
+     * call.
+     *
+     * @example
+     * ```ts
+     * if (response.statusCode !== 200) {
+     *  // do something
+     * }
+     * ```
      */
     get statusCode() {
         return this.response.statusCode;
     }
     /**
-     * Get the headers sent in response.
+     * Get the headers set in the response.
+     *
+     * @example
+     * ```ts
+     * const headers = response.headers
+     * ```
      */
     get headers() {
         return this.response.getHeaders();
     }
     /**
-     * Get the time in MS of how much the request has taken to response.
+     * Get the time in MS of how much the request has
+     * taken to response. Keep in mind that this method
+     * will only return `true` after `response.send()`,
+     * `response.view()`, `response.sendFile()` or
+     * `response.download()` methods call.
+     *
+     * @example
+     * ```ts
+     * console.log(response.responseTime) // 1000
+     * ```
      */
     get responseTime() {
         return this.response.elapsedTime;
     }
     /**
-     * Terminated the request sending a view to be rendered.
+     * Terminate the request sending a view to be rendered.
+     *
+     * @example
+     * ```ts
+     * return response.view('welcome', { name: 'lenon' })
+     * ```
      */
     async view(view, data) {
         const content = await View.render(view, { ...data, request: this.request });
@@ -53,6 +103,11 @@ export class Response {
     }
     /**
      * Terminate the request sending the response body or not.
+     *
+     * @example
+     * ```ts
+     * return response.send({ name: 'lenon' })
+     * ```
      */
     async send(data) {
         await this.response.send(data);
@@ -60,18 +115,36 @@ export class Response {
         return this;
     }
     /**
-     * Terminated the request sending a file.
+     * Terminate the request sending a file.
+     *
+     * @example
+     * ```ts
+     * return response.sendFile('img.png')
+     * ```
      */
     async sendFile(filename, filepath, options) {
         await this.response.sendFile(filename, filepath, options);
         return this;
     }
+    /**
+     * Terminate the request sending a file with custom name.
+     *
+     * @example
+     * ```ts
+     * return response.download('img.png', 'custom-img.png')
+     * ```
+     */
     async download(filepath, filename, options) {
         await this.response.download(filename, filepath, options);
         return this;
     }
     /**
      * Set the response status code.
+     *
+     * @example
+     * ```ts
+     * return response.status(200).send()
+     * ```
      */
     status(code) {
         this.response.status(code);
@@ -79,6 +152,13 @@ export class Response {
     }
     /**
      * Add some header to the response.
+     *
+     * @example
+     * ```ts
+     * response.header('content-type', 'application/json')
+     *
+     * return response.header('accept-encoding', 'gzip').send(user)
+     * ```
      */
     header(header, value) {
         this.response.header(header, value);
@@ -86,13 +166,25 @@ export class Response {
     }
     /**
      * Verify if response has some header.
+     *
+     * @example
+     * ```ts
+     * if (response.hasHeader('content-type')) {
+     *   // do something
+     * }
+     * ```
      */
     hasHeader(header) {
         return this.response.hasHeader(header);
     }
     /**
-     * Add some header safely to the response. This means that the header is not
-     * going to be added if is already set.
+     * Add some header safely to the response. This means that
+     * the header is not going to be added if is already set.
+     *
+     * @example
+     * ```ts
+     * response.safeHeader('content-type', 'application/json')
+     * ```
      */
     safeHeader(header, value) {
         this.response.header(header, value);
@@ -100,14 +192,24 @@ export class Response {
     }
     /**
      * Remove some header from the response.
+     *
+     * @example
+     * ```ts
+     * response.removeHeader('content-type')
+     * ```
      */
     removeHeader(header) {
         this.response.removeHeader(header);
         return this;
     }
     /**
-     * Redirect the response to other url. You can also set a different status code
-     * for the redirect.
+     * Redirect the response to other url. You can also set a
+     * different status code for the redirect.
+     *
+     * @example
+     * ```ts
+     * return response.redirect('users', 304)
+     * ```
      */
     async redirectTo(url, status) {
         if (status) {
@@ -119,6 +221,13 @@ export class Response {
     }
     /**
      * Apply helmet in response.
+     *
+     * @example
+     * ```ts
+     * return response
+     *  .helmet({ enableCSPNonces: false })
+     *  .view('profile', user)
+     * ```
      */
     helmet(options) {
         this.response.helmet(options);

package/src/handlers/FastifyHandler.js

@@ -16,20 +16,12 @@ export class FastifyHandler {
      */
     static request(handler) {
         return async (req, res) => {
-            const request = new Request(req);
             if (!req.data) {
                 req.data = {};
             }
+            const request = new Request(req);
             const response = new Response(res, request);
-            await handler({
-                request,
-                response,
-                data: req.data,
-                body: req.body,
-                params: req.params,
-                queries: req.query,
-                headers: req.headers
-            });
+            return handler({ request, response, data: req.data });
         };
     }
     /**
@@ -43,10 +35,10 @@ export class FastifyHandler {
      */
     static intercept(handler) {
         return async (req, res, payload) => {
-            const request = new Request(req);
             if (!req.data) {
                 req.data = {};
             }
+            const request = new Request(req);
             const response = new Response(res, request);
             if (Is.Json(payload)) {
                 payload = JSON.parse(payload);
@@ -56,11 +48,7 @@ export class FastifyHandler {
                 request,
                 response,
                 status: response.statusCode,
-                data: req.data,
-                body: res.body,
-                params: req.params,
-                queries: req.query,
-                headers: req.headers
+                data: req.data
             });
             res.body = payload;
             if (Is.Object(payload)) {
@@ -74,19 +62,15 @@ export class FastifyHandler {
      */
     static terminate(handler) {
         return async (req, res) => {
-            const request = new Request(req);
             if (!req.data) {
                 req.data = {};
             }
+            const request = new Request(req);
             const response = new Response(res, request);
             await handler({
                 request,
                 response,
-                params: req.params,
-                queries: req.query,
                 data: req.data,
-                body: res.body || req.body,
-                headers: res.getHeaders(),
                 status: res.statusCode,
                 responseTime: res.elapsedTime
             });
@@ -97,19 +81,15 @@ export class FastifyHandler {
      */
     static error(handler) {
         return async (error, req, res) => {
-            const request = new Request(req);
             if (!req.data) {
                 req.data = {};
             }
+            const request = new Request(req);
             const response = new Response(res, request);
             await handler({
                 request,
                 response,
                 data: req.data,
-                body: res.body || req.body,
-                params: req.params,
-                queries: req.query,
-                headers: req.headers,
                 error
             });
         };

package/src/kernels/HttpKernel.js

@@ -13,7 +13,7 @@ import { Log } from '@athenna/logger';
 import { Config } from '@athenna/config';
 import { sep, isAbsolute, resolve } from 'node:path';
 import { Annotation } from '@athenna/ioc';
-import { File, Exec, Module, String } from '@athenna/common';
+import { File, Path, Exec, Module, String } from '@athenna/common';
 import { HttpExceptionHandler } from '#src/handlers/HttpExceptionHandler';
 const corsPlugin = await Module.safeImport('@fastify/cors');
 const helmetPlugin = await Module.safeImport('@fastify/helmet');

package/src/server/ServerImpl.js

@@ -151,17 +151,22 @@ export class ServerImpl {
             });
             return;
         }
-        this.fastify.route({
+        const { middlewares, interceptors, terminators } = options.middlewares;
+        const route = {
             url: options.url,
             method: options.methods,
-            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-            // @ts-ignore
-            handler: FastifyHandler.request(options.handler),
-            preHandler: options.middlewares.middlewares.map(m => FastifyHandler.handle(m)),
-            onSend: options.middlewares.interceptors.map(m => FastifyHandler.intercept(m)),
-            onResponse: options.middlewares.terminators.map(m => FastifyHandler.terminate(m)),
-            ...options.fastify
-        });
+            handler: FastifyHandler.request(options.handler)
+        };
+        if (middlewares.length) {
+            route.preHandler = middlewares.map(m => FastifyHandler.handle(m));
+        }
+        if (interceptors.length) {
+            route.onSend = interceptors.map(i => FastifyHandler.intercept(i));
+        }
+        if (terminators.length) {
+            route.onResponse = terminators.map(t => FastifyHandler.terminate(t));
+        }
+        this.fastify.route({ ...route, ...options.fastify });
     }
     /**
      * Add a new GET route to the http server.

package/src/types/contexts/Context.d.ts

@@ -12,9 +12,5 @@ export type Context = {
     request: Request;
     response: Response;
     data: any;
-    body: any;
-    params: any;
-    queries: any;
-    headers: any;
 };
 export type RequestHandler = (ctx: Context) => any | Promise<any>;

package/src/types/contexts/ErrorContext.d.ts

@@ -6,16 +6,8 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import { Request } from '#src/context/Request';
-import { Response } from '#src/context/Response';
-export type ErrorContext = {
-    request: Request;
-    response: Response;
-    data: any;
-    body: any;
+import type { Context } from '#src/types/contexts/Context';
+export type ErrorContext = Context & {
     error: any;
-    params: any;
-    queries: any;
-    headers: any;
 };
 export type ErrorHandler = (ctx: ErrorContext) => Promise<void>;

package/src/types/contexts/ErrorContext.js

@@ -6,5 +6,4 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import { Request } from '#src/context/Request';
-import { Response } from '#src/context/Response';
+export {};

package/src/types/contexts/InterceptContext.d.ts

@@ -6,15 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import { Request } from '#src/context/Request';
-import { Response } from '#src/context/Response';
-export type InterceptContext = {
-    request: Request;
-    response: Response;
-    data: any;
-    body: any;
-    params: any;
-    queries: any;
-    headers: any;
+import type { Context } from '#src/types/contexts/Context';
+export type InterceptContext = Context & {
     status: number;
 };

package/src/types/contexts/InterceptContext.js

@@ -6,5 +6,4 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import { Request } from '#src/context/Request';
-import { Response } from '#src/context/Response';
+export {};

package/src/types/contexts/TerminateContext.d.ts

@@ -6,16 +6,8 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import { Request } from '#src/context/Request';
-import { Response } from '#src/context/Response';
-export type TerminateContext = {
-    request: Request;
-    response: Response;
-    data: any;
-    body: any;
-    params: any;
-    queries: any;
-    headers: any;
+import type { Context } from '#src/types/contexts/Context';
+export type TerminateContext = Context & {
     status: number;
     responseTime: number;
 };

package/src/types/contexts/TerminateContext.js

@@ -6,5 +6,4 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import { Request } from '#src/context/Request';
-import { Response } from '#src/context/Response';
+export {};

package/templates/controller.edge

@@ -14,8 +14,8 @@ export class {{ namePascal }} {
       return response.status(200).send({})
     }
 
-    public async update({ response, params }: Context) {
-      return response.status(200).send({ id: params.id })
+    public async update({ request, response }: Context) {
+      return response.status(200).send({ id: request.param('id') })
     }
 
     public async delete({ response }: Context) {

package/templates/interceptor.edge

@@ -4,6 +4,6 @@ import type { InterceptorContract, InterceptContext } from '@athenna/http'
 @Interceptor()
 export class {{ namePascal }} implements InterceptorContract {
     public async intercept(ctx: InterceptContext): Promise<unknown> {
-      return ctx.body
+      return ctx.response.body
     }
 }