@athenna/http 4.22.0 → 4.24.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "4.22.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,17 +72,18 @@
     "#tests": "./tests/index.js"
   },
   "devDependencies": {
-    "@athenna/artisan": "^4.35.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.14.0",
+    "@athenna/view": "^4.20.0",
     "@fastify/cors": "^8.4.2",
     "@fastify/helmet": "^11.1.1",
     "@fastify/rate-limit": "^8.1.1",
+    "@fastify/static": "^7.0.1",
     "@fastify/swagger": "^8.12.2",
     "@fastify/swagger-ui": "^3.0.0",
     "@typescript-eslint/eslint-plugin": "^6.7.4",

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.
      */