@athenna/http 3.0.10 → 3.1.0

package/src/Commands/Route/List.js

@@ -1,107 +0,0 @@
-/**
- * @athenna/http
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { Command } from '@athenna/artisan'
-import { Module, Path, String } from '@athenna/common'
-
-import { Route } from '#src/index'
-
-export class RouteList extends Command {
-  /**
-   * The name and signature of the console command.
-   *
-   * @return {string}
-   */
-  get signature() {
-    return 'route:list'
-  }
-
-  /**
-   * The console command description.
-   *
-   * @return {string}
-   */
-  get description() {
-    return 'List all the routes of your application.'
-  }
-
-  /**
-   * Set additional flags in the commander instance.
-   * This method is executed when registering your command.
-   *
-   * @param {import('commander').Command} commander
-   * @return {import('commander').Command}
-   */
-  addFlags(commander) {
-    return commander.option(
-      '-m, --middleware',
-      'List the middlewares of each route.',
-      false,
-    )
-  }
-
-  /**
-   * Execute the console command.
-   *
-   * @param {any} options
-   * @return {Promise<void>}
-   */
-  async handle(options) {
-    this.title('ROUTE LISTING\n', 'bold', 'green')
-
-    const Kernel = await Module.getFrom(Path.http(`Kernel.${Path.ext()}`))
-
-    const kernel = new Kernel()
-
-    await kernel.registerCors()
-    await kernel.registerTracer()
-    await kernel.registerRateLimit()
-    await kernel.registerMiddlewares()
-    await kernel.registerErrorHandler()
-    await kernel.registerLogMiddleware()
-
-    const routePath = Path.routes(`http.${Path.ext()}`)
-
-    await import(routePath)
-    const routes = Route.listRoutes()
-
-    const header = ['Method', 'Route', 'Handler']
-    const rows = []
-
-    if (options.middleware) header.push('Middlewares')
-
-    routes.forEach(route => {
-      const row = [route.methods.join('|'), route.url, 'Closure']
-
-      if (options.middleware) {
-        let middlewares = ''
-
-        Object.keys(route.middlewares).forEach(key => {
-          if (route.middlewares[key].length) {
-            const number = route.middlewares[key].length
-
-            if (middlewares) {
-              middlewares = middlewares + '\n'
-            }
-
-            middlewares = middlewares + `${String.toPascalCase(key)}: ${number}`
-          }
-        })
-
-        if (!middlewares) middlewares = 'Not found'
-
-        row.push(middlewares)
-      }
-
-      rows.push(row)
-    })
-
-    this.log(this.createTable({ head: header }, ...rows))
-  }
-}

package/src/Context/Request.js

@@ -1,223 +0,0 @@
-/**
- * @athenna/http
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { Config } from '@athenna/config'
-import { Is, Json } from '@athenna/common'
-import { Server } from '#src/index'
-
-export class Request {
-  /**
-   * Fastify request object.
-   *
-   * @type {import('fastify').FastifyRequest}
-   */
-  #request
-
-  /**
-   * Create a new instance of Request.
-   *
-   * @param {import('fastify').FastifyRequest} request
-   * @return {Request}
-   */
-  constructor(request) {
-    this.#request = request
-  }
-
-  /**
-   * Get the request ip.
-   *
-   * @return {string}
-   */
-  get ip() {
-    return this.#request.ip
-  }
-
-  /**
-   * Get the request method.
-   *
-   * @return {string}
-   */
-  get method() {
-    return this.#request.method
-  }
-
-  /**
-   * Get the host url from request.
-   *
-   * @return {string}
-   */
-  get hostUrl() {
-    const port = Config.get('http.port', Server.getPort())
-    let host = Config.get('http.domain', `http://localhost:${port}`)
-
-    if (!Is.Ip(host) && !host.includes('localhost')) {
-      host = host.replace(`:${port}`, '')
-    }
-
-    return host.concat(this.originalUrl)
-  }
-
-  /**
-   * Get the base request url.
-   *
-   * @return {string}
-   */
-  get baseUrl() {
-    return this.#request.url.split('?')[0]
-  }
-
-  /**
-   * Get the original request url.
-   *
-   * @return {string}
-   */
-  get originalUrl() {
-    return this.#request.url
-  }
-
-  /**
-   * Get all body from request.
-   *
-   * @return {any}
-   */
-  get body() {
-    return this.#request.body || {}
-  }
-
-  /**
-   * Get all params from request.
-   *
-   * @return {any}
-   */
-  get params() {
-    return this.#request.params || {}
-  }
-
-  /**
-   * Get all queries from request.
-   *
-   * @return {any}
-   */
-  get queries() {
-    return this.#request.query || {}
-  }
-
-  /**
-   * Get all headers from request.
-   *
-   * @return {any}
-   */
-  get headers() {
-    return this.#request.headers || {}
-  }
-
-  /**
-   * Get a value from the request params or the default value.
-   *
-   * @param {string} param
-   * @param {string} [defaultValue]
-   * @return {any}
-   */
-  param(param, defaultValue) {
-    return this.params[param] || defaultValue
-  }
-
-  /**
-   * Get a value from the request query param or the default value.
-   *
-   * @param {string} query
-   * @param {string} [defaultValue]
-   * @return {any}
-   */
-  query(query, defaultValue) {
-    return this.queries[query] || defaultValue
-  }
-
-  /**
-   * Get a value from the request header or the default value.
-   *
-   * @param {string} header
-   * @param {string} [defaultValue]
-   * @return {any}
-   */
-  header(header, defaultValue) {
-    return this.headers[header] || defaultValue
-  }
-
-  /**
-   * Get only the selected values from the request body.
-   *
-   * @param {string} keys
-   * @return {any}
-   */
-  only(...keys) {
-    const body = {}
-
-    Object.keys(this.body).forEach(key => {
-      if (!keys.includes(key)) {
-        return
-      }
-
-      body[key] = this.body[key]
-    })
-
-    return body
-  }
-
-  /**
-   * Get all the values from the request body except the selected ones.
-   *
-   * @param {string[]} keys
-   * @return {any}
-   */
-  except(...keys) {
-    const body = {}
-
-    Object.keys(this.body).forEach(key => {
-      if (keys.includes(key)) {
-        return
-      }
-
-      body[key] = this.body[key]
-    })
-
-    return body
-  }
-
-  /**
-   * Get a value from the request body or the default value.
-   *
-   * @param {string} key
-   * @param {string} [defaultValue]
-   * @return {any}
-   */
-  input(key, defaultValue) {
-    return this.payload(key, defaultValue)
-  }
-
-  /**
-   * Get a value from the request body or the default value.
-   *
-   * @param {string} key
-   * @param {string} [defaultValue]
-   * @return {any}
-   */
-  payload(key, defaultValue) {
-    return Json.get(this.body, key, defaultValue)
-  }
-
-  /**
-   * Get the default fastify request object.
-   *
-   * @return {import('fastify').FastifyRequest}
-   */
-  getFastifyRequest() {
-    return this.#request
-  }
-}

package/src/Context/Response.js

@@ -1,137 +0,0 @@
-/**
- * @athenna/http
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-export class Response {
-  /**
-   * Fastify response object.
-   *
-   * @type {import('fastify').FastifyReply}
-   */
-  #response
-
-  /**
-   * Create a new instance of Response.
-   *
-   * @param {import('fastify').FastifyReply} response
-   * @return {Response}
-   */
-  constructor(response) {
-    this.#response = response
-  }
-
-  /**
-   * Terminate the request sending the response body.
-   *
-   * @param {any} [data]
-   * @return {void}
-   */
-  send(data) {
-    this.#response.send(data)
-  }
-
-  /**
-   * Terminate the request sending the response body.
-   *
-   * @param {any} [data]
-   * @return {void}
-   */
-  json(data) {
-    this.#response.send(data)
-  }
-
-  /**
-   * Apply helmet in response.
-   *
-   * @param {import('@fastify/helmet').FastifyHelmetOptions} [options]
-   * @return {void}
-   */
-  async helmet(options) {
-    await this.#response.helmet(options)
-
-    return this
-  }
-
-  /**
-   * Set the response status code.
-   *
-   * @param {number} code
-   * @return {Response}
-   */
-  status(code) {
-    this.#response.status(code)
-
-    return this
-  }
-
-  /**
-   * Remove some header from the response.
-   *
-   * @param {string} header
-   * @return {Response}
-   */
-  removeHeader(header) {
-    this.#response.removeHeader(header)
-
-    return this
-  }
-
-  /**
-   * Add some header to the response.
-   *
-   * @param {string} header
-   * @param {any} value
-   * @return {Response}
-   */
-  header(header, value) {
-    this.#response.header(header, value)
-
-    return this
-  }
-
-  /**
-   * Only add some header to the response if it's not defined yet.
-   *
-   * @param {string} header
-   * @param {any} value
-   * @return {Response}
-   */
-  safeHeader(header, value) {
-    if (!this.#response.hasHeader(header)) {
-      this.#response.header(header, value)
-    }
-
-    return this
-  }
-
-  /**
-   * Redirect the response to other url with different status code.
-   *
-   * @param {string} url
-   * @param {number} [statusCode]
-   * @return {void}
-   */
-  redirectTo(url, statusCode) {
-    if (statusCode) {
-      this.#response.redirect(statusCode, url)
-
-      return
-    }
-
-    this.#response.redirect(url)
-  }
-
-  /**
-   * Get the default fastify response object.
-   *
-   * @return {import('fastify').FastifyReply}
-   */
-  getFastifyResponse() {
-    return this.#response
-  }
-}

package/src/Exceptions/BadGatewayException.js

@@ -1,31 +0,0 @@
-/**
- * @athenna/http
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { HttpException } from '#src/Exceptions/HttpException'
-
-export class BadGatewayException extends HttpException {
-  /**
-   * Creates a new instance of BadGatewayException.
-   *
-   * @example
-   *  throw new BadGatewayException()
-   *  This exception uses the 502 status code and the "E_BAD_GATEWAY_ERROR" code.
-   *
-   * @param {string} [content]
-   * @param {string} [code]
-   * @param {string|null} [help]
-   */
-  constructor(
-    content = 'Bad gateway error',
-    code = 'E_BAD_GATEWAY_ERROR',
-    help = null,
-  ) {
-    super(content, 502, code, help)
-  }
-}

package/src/Exceptions/BadRequestException.js

@@ -1,31 +0,0 @@
-/**
- * @athenna/http
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { HttpException } from '#src/Exceptions/HttpException'
-
-export class BadRequestException extends HttpException {
-  /**
-   * Creates a new instance of BadRequestException.
-   *
-   * @example
-   *  throw new BadRequestException()
-   *  This exception uses the 400 status code and the "E_BAD_REQUEST_ERROR" code.
-   *
-   * @param {string} [content]
-   * @param {string} [code]
-   * @param {string|null} [help]
-   */
-  constructor(
-    content = 'Bad request error',
-    code = 'E_BAD_REQUEST_ERROR',
-    help = null,
-  ) {
-    super(content, 400, code, help)
-  }
-}

package/src/Exceptions/ForbiddenException.js

@@ -1,31 +0,0 @@
-/**
- * @athenna/http
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { HttpException } from '#src/Exceptions/HttpException'
-
-export class ForbiddenException extends HttpException {
-  /**
-   * Creates a new instance of ForbiddenException.
-   *
-   * @example
-   *  throw new ForbiddenException()
-   *  This exception uses the 403 status code and the "E_FORBIDDEN_ERROR" code.
-   *
-   * @param {string} [content]
-   * @param {string} [code]
-   * @param {string|null} [help]
-   */
-  constructor(
-    content = 'Forbidden error',
-    code = 'E_FORBIDDEN_ERROR',
-    help = null,
-  ) {
-    super(content, 403, code, help)
-  }
-}

package/src/Exceptions/HttpException.js

@@ -1,33 +0,0 @@
-/**
- * @athenna/http
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { Exception } from '@athenna/common'
-
-export class HttpException extends Exception {
-  /**
-   * Creates a new instance of HttpException.
-   *
-   * @example
-   *  throw new HttpException()
-   *  This exception uses the 500 status code and the "E_HTTP_ERROR" code.
-   *
-   * @param {string} [content]
-   * @param {number} [status]
-   * @param {string} [code]
-   * @param {string|null} [help]
-   */
-  constructor(
-    content = 'Http error',
-    status = 500,
-    code = 'E_HTTP_ERROR',
-    help = null,
-  ) {
-    super(content, status, code, help)
-  }
-}

package/src/Exceptions/InternalServerException.js

@@ -1,31 +0,0 @@
-/**
- * @athenna/http
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { HttpException } from '#src/Exceptions/HttpException'
-
-export class InternalServerException extends HttpException {
-  /**
-   * Creates a new instance of InternalServerException.
-   *
-   * @example
-   *  throw new InternalServerException()
-   *  This exception uses the 500 status code and the "E_INTERNAL_ERROR" code.
-   *
-   * @param {string} [content]
-   * @param {string} [code]
-   * @param {string|null} [help]
-   */
-  constructor(
-    content = 'Internal server error',
-    code = 'E_INTERNAL_ERROR',
-    help = null,
-  ) {
-    super(content, 500, code, help)
-  }
-}

package/src/Exceptions/MethodNotAllowedException.js

@@ -1,31 +0,0 @@
-/**
- * @athenna/http
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { HttpException } from '#src/Exceptions/HttpException'
-
-export class MethodNotAllowedException extends HttpException {
-  /**
-   * Creates a new instance of MethodNotAllowedException.
-   *
-   * @example
-   *  throw new MethodNotAllowedException()
-   *  This exception uses the 405 status code and the "E_METHOD_NOT_ALLOWED_ERROR" code.
-   *
-   * @param {string} [content]
-   * @param {string} [code]
-   * @param {string|null} [help]
-   */
-  constructor(
-    content = 'Method not allowed error',
-    code = 'E_METHOD_NOT_ALLOWED_ERROR',
-    help = null,
-  ) {
-    super(content, 405, code, help)
-  }
-}

package/src/Exceptions/NotAcceptableException.js

@@ -1,31 +0,0 @@
-/**
- * @athenna/http
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { HttpException } from '#src/Exceptions/HttpException'
-
-export class NotAcceptableException extends HttpException {
-  /**
-   * Creates a new instance of NotAcceptableException.
-   *
-   * @example
-   *  throw new NotAcceptableException()
-   *  This exception uses the 406 status code and the "E_NOT_ACCEPTABLE_ERROR" code.
-   *
-   * @param {string} [content]
-   * @param {string} [code]
-   * @param {string|null} [help]
-   */
-  constructor(
-    content = 'Not acceptable error',
-    code = 'E_NOT_ACCEPTABLE_ERROR',
-    help = null,
-  ) {
-    super(content, 406, code, help)
-  }
-}