@athenna/http 3.0.10 → 3.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "3.0.10",
+  "version": "3.0.11",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -57,7 +57,7 @@
     "fastify": "4.9.2"
   },
   "devDependencies": {
-    "@athenna/artisan": "3.0.9",
+    "@athenna/artisan": "3.0.10",
     "@athenna/common": "3.0.2",
     "@athenna/config": "3.0.4",
     "@athenna/ioc": "3.0.2",
@@ -71,6 +71,7 @@
     "@japa/run-failed-tests": "1.0.7",
     "@japa/runner": "2.0.7",
     "@japa/spec-reporter": "1.1.12",
+    "@types/commander": "2.12.2",
     "c8": "7.11.2",
     "cls-rtracer": "2.6.2",
     "commitizen": "4.2.5",

package/src/Commands/Make/Controller.js

@@ -33,8 +33,8 @@ export class MakeController extends Command {
    * Set additional flags in the commander instance.
    * This method is executed when registering your command.
    *
-   * @param {import('commander').Command} commander
-   * @return {import('commander').Command}
+   * @param {import('@athenna/artisan').Commander} commander
+   * @return {import('@athenna/artisan').Commander}
    */
   addFlags(commander) {
     return commander.option(

package/src/Commands/Make/Middleware.js

@@ -33,8 +33,8 @@ export class MakeMiddleware extends Command {
    * Set additional flags in the commander instance.
    * This method is executed when registering your command.
    *
-   * @param {import('commander').Command} commander
-   * @return {import('commander').Command}
+   * @param {import('@athenna/artisan').Commander} commander
+   * @return {import('@athenna/artisan').Commander}
    */
   addFlags(commander) {
     return commander

package/src/Commands/Route/List.js

@@ -35,8 +35,8 @@ export class RouteList extends Command {
    * Set additional flags in the commander instance.
    * This method is executed when registering your command.
    *
-   * @param {import('commander').Command} commander
-   * @return {import('commander').Command}
+   * @param {import('@athenna/artisan').Commander} commander
+   * @return {import('@athenna/artisan').Commander}
    */
   addFlags(commander) {
     return commander.option(

package/src/Context/Request.js

@@ -29,6 +29,15 @@ export class Request {
     this.#request = request
   }
 
+  /**
+   * Get the request id.
+   *
+   * @return {string}
+   */
+  get id() {
+    return this.#request.id
+  }
+
   /**
    * Get the request ip.
    *
@@ -38,6 +47,24 @@ export class Request {
     return this.#request.ip
   }
 
+  /**
+   * Get the request hostname.
+   *
+   * @return {string}
+   */
+  get hostname() {
+    return this.#request.hostname
+  }
+
+  /**
+   * Get the request protocol.
+   *
+   * @return {"http"|"https"}
+   */
+  get protocol() {
+    return this.#request.protocol
+  }
+
   /**
    * Get the request method.
    *
@@ -47,6 +74,15 @@ export class Request {
     return this.#request.method
   }
 
+  /**
+   * Get the route url from request.
+   *
+   * @return {string}
+   */
+  get routeUrl() {
+    return this.#request.routerPath
+  }
+
   /**
    * Get the host url from request.
    *
@@ -117,6 +153,15 @@ export class Request {
     return this.#request.headers || {}
   }
 
+  /**
+   * Get the server version.
+   *
+   * @return {string}
+   */
+  get version() {
+    return this.#request.server.version
+  }
+
   /**
    * Get a value from the request params or the default value.
    *

package/src/Context/Response.js

@@ -25,6 +25,42 @@ export class Response {
     this.#response = response
   }
 
+  /**
+   * Verify if response has been already sent.
+   *
+   * @return {boolean}
+   */
+  get sent() {
+    return this.#response.sent
+  }
+
+  /**
+   * Get the status code sent in response.
+   *
+   * @return {number}
+   */
+  get statusCode() {
+    return this.#response.statusCode
+  }
+
+  /**
+   * Get the headers sent in response.
+   *
+   * @return {any}
+   */
+  get headers() {
+    return this.#response.getHeaders()
+  }
+
+  /**
+   * Get the response time.
+   *
+   * @return {number}
+   */
+  get responseTime() {
+    return this.#response.getResponseTime()
+  }
+
   /**
    * Terminate the request sending the response body.
    *

package/src/Router/Route.js

@@ -360,12 +360,6 @@ export class Route {
       this.#swaggerOptions.response = {}
     }
 
-    if (!response) {
-      this.#swaggerOptions.response.default = response
-
-      return this
-    }
-
     this.#swaggerOptions.response[statusCode] = response
 
     return this

package/src/index.d.ts

@@ -8,7 +8,7 @@
  */
 
 import { Facade } from '@athenna/ioc'
-import { Exception, Json } from '@athenna/common'
+import { Exception } from '@athenna/common'
 import { OpenAPIV2, OpenAPIV3 } from 'openapi-types'
 import { FastifyHelmetOptions } from '@fastify/helmet'
 import { RateLimitOptions } from '@fastify/rate-limit'
@@ -817,12 +817,34 @@ declare module Router {
 }
 
 export interface RequestContract {
+  /**
+   * Get the request id.
+   *
+   * @return {string}
+   */
+  get id(): string
+
   /**
    * Get the request ip.
    *
    * @return {string}
    */
   get ip(): string
+
+  /**
+   * Get the request hostname.
+   *
+   * @return {string}
+   */
+  get hostname(): string
+
+  /**
+   * Get the request protocol.
+   *
+   * @return {"http"|"https"}
+   */
+  get protocol(): 'http' | 'https'
+
   /**
    * Get the request method.
    *
@@ -830,6 +852,13 @@ export interface RequestContract {
    */
   get method(): string
 
+  /**
+   * Get the route url from request.
+   *
+   * @return {string}
+   */
+  get routeUrl(): string
+
   /**
    * Get the host url from request.
    *
@@ -879,6 +908,13 @@ export interface RequestContract {
    */
   get headers(): any
 
+  /**
+   * Get the server version.
+   *
+   * @return {string}
+   */
+  get version(): string
+
   /**
    * Get a value from the request params or the default value.
    *
@@ -951,6 +987,34 @@ export interface RequestContract {
 }
 
 export interface ResponseContract {
+  /**
+   * Verify if response has been already sent.
+   *
+   * @return {boolean}
+   */
+  get sent(): boolean
+
+  /**
+   * Get the status code sent in response.
+   *
+   * @return {number}
+   */
+  get statusCode(): number
+
+  /**
+   * Get the headers sent in response.
+   *
+   * @return {any}
+   */
+  get headers(): any
+
+  /**
+   * Get the response time.
+   *
+   * @return {number}
+   */
+  get responseTime(): number
+
   /**
    * Terminate the request sending the response body.
    *