@athenna/http 3.0.10 → 3.1.0

package/src/Exceptions/NotFoundException.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 NotFoundException extends HttpException {
-  /**
-   * Creates a new instance of NotFoundException.
-   *
-   * @example
-   *  throw new NotFoundException()
-   *  This exception uses the 404 status code and the "E_NOT_FOUND_ERROR" code.
-   *
-   * @param {string} [content]
-   * @param {string} [code]
-   * @param {string|null} [help]
-   */
-  constructor(
-    content = 'Not found error',
-    code = 'E_NOT_FOUND_ERROR',
-    help = null,
-  ) {
-    super(content, 404, code, help)
-  }
-}

package/src/Exceptions/NotImplementedException.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 NotImplementedException extends HttpException {
-  /**
-   * Creates a new instance of NotImplementedException.
-   *
-   * @example
-   *  throw new NotImplementedException()
-   *  This exception uses the 501 status code and the "E_NOT_IMPLEMENTED_ERROR" code.
-   *
-   * @param {string} [content]
-   * @param {string} [code]
-   * @param {string|null} [help]
-   */
-  constructor(
-    content = 'Not implemented error',
-    code = 'E_NOT_IMPLEMENTED_ERROR',
-    help = null,
-  ) {
-    super(content, 501, code, help)
-  }
-}

package/src/Exceptions/PayloadTooLargeException.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 PayloadTooLargeException extends HttpException {
-  /**
-   * Creates a new instance of PayloadTooLargeException.
-   *
-   * @example
-   *  throw new PayloadTooLargeException()
-   *  This exception uses the 413 status code and the "E_PAYLOAD_TOO_LARGE_ERROR" code.
-   *
-   * @param {string} [content]
-   * @param {string} [code]
-   * @param {string|null} [help]
-   */
-  constructor(
-    content = 'Payload too large error',
-    code = 'E_PAYLOAD_TOO_LARGE_ERROR',
-    help = null,
-  ) {
-    super(content, 413, code, help)
-  }
-}

package/src/Exceptions/RequestTimeoutException.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 RequestTimeoutException extends HttpException {
-  /**
-   * Creates a new instance of RequestTimeoutException.
-   *
-   * @example
-   *  throw new RequestTimeoutException()
-   *  This exception uses the 408 status code and the "E_REQUEST_TIMEOUT_ERROR" code.
-   *
-   * @param {string} [content]
-   * @param {string} [code]
-   * @param {string|null} [help]
-   */
-  constructor(
-    content = 'Request timeout error',
-    code = 'E_REQUEST_TIMEOUT_ERROR',
-    help = null,
-  ) {
-    super(content, 408, code, help)
-  }
-}

package/src/Exceptions/ServiceUnavailableException.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 ServiceUnavailableException extends HttpException {
-  /**
-   * Creates a new instance of ServiceUnavailableException.
-   *
-   * @example
-   *  throw new ServiceUnavailableException()
-   *  This exception uses the 503 status code and the "E_SERVICE_UNAVAILABLE_ERROR" code.
-   *
-   * @param {string} [content]
-   * @param {string} [code]
-   * @param {string|null} [help]
-   */
-  constructor(
-    content = 'Service unavailable error',
-    code = 'E_SERVICE_UNAVAILABLE_ERROR',
-    help = null,
-  ) {
-    super(content, 503, code, help)
-  }
-}

package/src/Exceptions/UnauthorizedException.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 UnauthorizedException extends HttpException {
-  /**
-   * Creates a new instance of UnauthorizedException.
-   *
-   * @example
-   *  throw new UnauthorizedException()
-   *  This exception uses the 401 status code and the "E_UNAUTHORIZED_ERROR" code.
-   *
-   * @param {string} [content]
-   * @param {string} [code]
-   * @param {string|null} [help]
-   */
-  constructor(
-    content = 'Unauthorized error',
-    code = 'E_UNAUTHORIZED_ERROR',
-    help = null,
-  ) {
-    super(content, 401, code, help)
-  }
-}

package/src/Exceptions/UndefinedMethodException.js

@@ -1,30 +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 UndefinedMethodException extends Exception {
-  /**
-   * Creates a new instance of UndefinedMethodException.
-   *
-   * @param {string} method
-   * @param {string} className
-   * @return {UndefinedMethodException}
-   */
-  constructor(method, className) {
-    const content = `The method ${method} is not defined inside your class ${className}.`
-
-    super(
-      content,
-      500,
-      'E_UNDEFINED_METHOD',
-      `Remember defining the method ${method} inside your class ${className}`,
-    )
-  }
-}

package/src/Exceptions/UnprocessableEntityException.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 UnprocessableEntityException extends HttpException {
-  /**
-   * Creates a new instance of UnprocessableEntityException.
-   *
-   * @example
-   *  throw new UnprocessableEntityException()
-   *  This exception uses the 422 status code and the "E_UNPROCESSABLE_ENTITY_ERROR" code.
-   *
-   * @param {string} [content]
-   * @param {string} [code]
-   * @param {string|null} [help]
-   */
-  constructor(
-    content = 'Unprocessable entity error',
-    code = 'E_UNPROCESSABLE_ENTITY_ERROR',
-    help = null,
-  ) {
-    super(content, 422, code, help)
-  }
-}

package/src/Handlers/FastifyHandler.js

@@ -1,148 +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 { Is } from '@athenna/common'
-import { Request } from '#src/Context/Request'
-import { Response } from '#src/Context/Response'
-
-export class FastifyHandler {
-  /**
-   * Creates a new onSend fastify hook.
-   *
-   * @param {any} handler
-   * @return {any}
-   */
-  static createOnSendHandler(handler) {
-    return async (req, res, payload) => {
-      const request = new Request(req)
-      const response = new Response(res)
-
-      if (!req.data) req.data = {}
-
-      const isJson = Is.Json(payload)
-
-      if (isJson) {
-        payload = JSON.parse(payload)
-      }
-
-      payload = await handler({
-        request,
-        response,
-        body: payload,
-        status: res.statusCode,
-        params: req.params,
-        queries: req.query,
-        data: req.data,
-      })
-
-      if (isJson) {
-        payload = JSON.stringify(payload)
-      }
-
-      return payload
-    }
-  }
-
-  /**
-   * Creates a new done fastify hook.
-   *
-   * @param {any} handler
-   * @return {any}
-   */
-  static createDoneHandler(handler) {
-    return async (req, res) => {
-      const request = new Request(req)
-      const response = new Response(res)
-
-      if (!req.data) req.data = {}
-
-      return handler({
-        request,
-        response,
-        params: req.params,
-        queries: req.query,
-        data: req.data,
-      })
-    }
-  }
-
-  /**
-   * Creates a new onResponse fastify hook.
-   *
-   * @param {any} handler
-   * @return {any}
-   */
-  static createOnResponseHandler(handler) {
-    return async (req, res) => {
-      const request = new Request(req)
-      const response = new Response(res)
-
-      if (!req.data) req.data = {}
-
-      return handler({
-        request,
-        response,
-        params: req.params,
-        queries: req.query,
-        data: req.data,
-        body: req.body,
-        headers: res.getHeaders(),
-        status: res.statusCode,
-        responseTime: res.getResponseTime(),
-      })
-    }
-  }
-
-  /**
-   * Creates a new error fastify hook.
-   *
-   * @param {any} handler
-   * @return {any}
-   */
-  static createErrorHandler(handler) {
-    return async (error, req, res) => {
-      const request = new Request(req)
-      const response = new Response(res)
-
-      if (!req.data) req.data = {}
-
-      return handler({
-        request,
-        response,
-        params: req.params,
-        queries: req.query,
-        data: req.data,
-        error,
-      })
-    }
-  }
-
-  /**
-   * Creates a new request fastify hook.
-   *
-   * @param {any} handler
-   * @return {any}
-   */
-  static createRequestHandler(handler) {
-    return async (req, res) => {
-      const request = new Request(req)
-      const response = new Response(res)
-
-      if (!req.data) req.data = {}
-
-      return handler({
-        request,
-        response,
-        params: req.params,
-        queries: req.query,
-        data: req.data,
-      })
-    }
-  }
-}

package/src/Handlers/HttpExceptionHandler.js

@@ -1,88 +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 { String } from '@athenna/common'
-import { Log, Logger } from '@athenna/logger'
-
-export class HttpExceptionHandler {
-  /**
-   * Error codes that should be ignored by Log.
-   *
-   * @type {string[]}
-   */
-  get ignoreCodes() {
-    return []
-  }
-
-  /**
-   * Error statuses that should be ignored by Log.
-   *
-   * @type {number[]}
-   */
-  get ignoreStatuses() {
-    return []
-  }
-
-  /**
-   * The global exception handler of all HTTP requests.
-   *
-   * @param {import('#src/index').ErrorContextContract} ctx
-   */
-  async handle({ error, response }) {
-    const code = error.code || error.name
-    const statusCode = error.statusCode || error.status || 500
-
-    const body = {
-      statusCode,
-      code: String.toSnakeCase(`${code}`).toUpperCase(),
-      name: error.name,
-      message: error.message,
-      stack: error.stack,
-    }
-
-    if (error.help) {
-      body.help = error.help
-    }
-
-    const isInternalServerError = statusCode === 500
-    const isDebugMode = Config.get('app.debug', false)
-
-    if (isInternalServerError && !isDebugMode) {
-      body.name = 'Internal server error'
-      body.message = 'An internal server exception has occurred.'
-
-      delete body.stack
-    }
-
-    response.status(statusCode).send(body)
-
-    if (
-      this.ignoreCodes.includes(code) ||
-      this.ignoreStatuses.includes(statusCode)
-    ) {
-      return
-    }
-
-    const logger = Config.exists('logging.channels.exception')
-      ? Log.channel('exception')
-      : Logger.getVanillaLogger({
-          level: 'trace',
-          driver: 'console',
-          streamType: 'stderr',
-          formatter: 'none',
-        })
-
-    if (!error.prettify) {
-      error = error.toAthennaException()
-    }
-
-    logger.error((await error.prettify()).concat('\n'))
-  }
-}

package/src/Helpers/HttpLoader.js

@@ -1,38 +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 { join } from 'node:path'
-import { Folder, Module } from '@athenna/common'
-
-export class HttpLoader {
-  /**
-   * Return all commands from http package.
-   *
-   * @return {any[]}
-   */
-  static loadCommands() {
-    return [
-      import('#src/Commands/Route/List'),
-      import('#src/Commands/Make/Controller'),
-      import('#src/Commands/Make/Middleware'),
-    ]
-  }
-
-  /**
-   * Return all custom templates from http package.
-   *
-   * @return {any[]}
-   */
-  static loadTemplates() {
-    const dirname = Module.createDirname(import.meta.url)
-    const templatesPath = join(dirname, '..', '..', 'templates')
-
-    return new Folder(templatesPath).loadSync().getFilesByPattern('**/*.edge')
-  }
-}