@athenna/http 1.3.3 → 1.3.6

package/src/Context/Response.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/http
  *
@@ -7,99 +6,108 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Response = void 0;
-class Response {
-    /**
-     * Create a new instance of Response.
-     *
-     * @return Response
-     */
-    constructor(response) {
-        this.response = response;
+
+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)
+  }
+
+  /**
+   * 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)
     }
-    /**
-     * Terminate the request sending the response body.
-     *
-     * @param data
-     * @return void
-     */
-    send(data) {
-        this.response.send(data);
-    }
-    /**
-     * Terminate the request sending the response body.
-     *
-     * @param data
-     * @return void
-     */
-    json(data) {
-        this.response.send(this.response.serialize(data));
-    }
-    /**
-     * Set the response status code.
-     *
-     * @param code
-     * @return Response
-     */
-    status(code) {
-        this.response.status(code);
-        return this;
-    }
-    /**
-     * Remove some header from the response.
-     *
-     * @param header
-     * @return Response
-     */
-    removeHeader(header) {
-        this.response.removeHeader(header);
-        return this;
-    }
-    /**
-     * Add some header to the response.
-     *
-     * @param header
-     * @param 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 header
-     * @param 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 url
-     * @param statusCode
-     * @return void
-     */
-    redirectTo(url, statusCode) {
-        if (statusCode) {
-            this.response.redirect(statusCode, url);
-        }
-        this.response.redirect(url);
-    }
-    /**
-     * Get the default fastify response object.
-     *
-     * @return FastifyReply
-     */
-    getFastifyResponse() {
-        return this.response;
+
+    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)
     }
+
+    this.#response.redirect(url)
+  }
+
+  /**
+   * Get the default fastify response object.
+   *
+   * @return {import('fastify').FastifyReply}
+   */
+  getFastifyResponse() {
+    return this.#response
+  }
 }
-exports.Response = Response;

package/src/Exceptions/UndefinedMethodException.js

@@ -0,0 +1,30 @@
+/**
+ * @athenna/logger
+ *
+ * (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 '@secjs/utils'
+
+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/Facades/Route.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/http
  *
@@ -7,7 +6,10 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Route = void 0;
-const ioc_1 = require("@athenna/ioc");
-exports.Route = ioc_1.Facade.createFor('Athenna/Core/HttpRoute');
+
+import { Facade } from '@athenna/ioc'
+
+/**
+ * @type {Facade & import('../Router/Router.js').Router}
+ */
+export const Route = Facade.createFor('Athenna/Core/HttpRoute')

package/src/Facades/Server.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/http
  *
@@ -7,7 +6,10 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Server = void 0;
-const ioc_1 = require("@athenna/ioc");
-exports.Server = ioc_1.Facade.createFor('Athenna/Core/HttpServer');
+
+import { Facade } from '@athenna/ioc'
+
+/**
+ * @type {Facade & import('../index.js').Http}
+ */
+export const Server = Facade.createFor('Athenna/Core/HttpServer')

package/src/Handlers/FastifyHandler.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/http
  *
@@ -7,123 +6,143 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FastifyHandler = void 0;
-/* eslint-disable @typescript-eslint/no-empty-function */
-const utils_1 = require("@secjs/utils");
-const Request_1 = require("../Context/Request");
-const Response_1 = require("../Context/Response");
-class FastifyHandler {
-    static createOnSendHandler(handler) {
-        return async (req, res, payload) => {
-            const request = new Request_1.Request(req);
-            const response = new Response_1.Response(res);
-            if (!req.data)
-                req.data = {};
-            if (!req.query)
-                req.query = {};
-            if (!req.params)
-                req.params = {};
-            let body = payload;
-            if (utils_1.Is.Json(payload)) {
-                body = JSON.parse(body);
-            }
-            body = await handler({
-                request,
-                response,
-                body,
-                status: res.statusCode,
-                params: req.params,
-                queries: req.query,
-                data: req.data,
-            });
-            if (utils_1.Is.Object(body))
-                body = JSON.stringify(body);
-            return body;
-        };
+
+import { Is } from '@secjs/utils'
+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 = {}
+
+      let body = payload
+
+      if (Is.Json(payload)) {
+        body = JSON.parse(body)
+      }
+
+      body = await handler({
+        request,
+        response,
+        body,
+        status: res.statusCode,
+        params: req.params,
+        queries: req.query,
+        data: req.data,
+      })
+
+      if (Is.Object(body)) body = JSON.stringify(body)
+
+      return body
     }
-    static createDoneHandler(handler) {
-        return (req, res, done) => {
-            const request = new Request_1.Request(req);
-            const response = new Response_1.Response(res);
-            if (!req.data)
-                req.data = {};
-            if (!req.query)
-                req.query = {};
-            if (!req.params)
-                req.params = {};
-            return handler({
-                request,
-                response,
-                params: req.params,
-                queries: req.query,
-                data: req.data,
-                next: done,
-            });
-        };
+  }
+
+  /**
+   * Creates a new done fastify hook.
+   *
+   * @param {any} handler
+   * @return {any}
+   */
+  static createDoneHandler(handler) {
+    return (req, res, done) => {
+      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,
+        next: done,
+      })
     }
-    static createResponseHandler(handler) {
-        return (req, res, done) => {
-            const request = new Request_1.Request(req);
-            const response = new Response_1.Response(res);
-            if (!req.data)
-                req.data = {};
-            if (!req.query)
-                req.query = {};
-            if (!req.params)
-                req.params = {};
-            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(),
-                next: done,
-            });
-        };
+  }
+
+  /**
+   * Creates a new onResponse fastify hook.
+   *
+   * @param {any} handler
+   * @return {any}
+   */
+  static createOnResponseHandler(handler) {
+    return (req, res, done) => {
+      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(),
+        next: done,
+      })
     }
-    static createErrorHandler(handler) {
-        return (error, req, res) => {
-            const request = new Request_1.Request(req);
-            const response = new Response_1.Response(res);
-            if (!req.data)
-                req.data = {};
-            if (!req.query)
-                req.query = {};
-            if (!req.params)
-                req.params = {};
-            return handler({
-                request,
-                response,
-                params: req.params,
-                queries: req.query,
-                data: req.data,
-                error,
-            });
-        };
+  }
+
+  /**
+   * Creates a new error fastify hook.
+   *
+   * @param {any} handler
+   * @return {any}
+   */
+  static createErrorHandler(handler) {
+    return (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,
+      })
     }
-    static createRequestHandler(handler) {
-        return async (req, res) => {
-            const request = new Request_1.Request(req);
-            const response = new Response_1.Response(res);
-            if (!req.data)
-                req.data = {};
-            if (!req.query)
-                req.query = {};
-            if (!req.params)
-                req.params = {};
-            return handler({
-                request,
-                response,
-                params: req.params,
-                queries: req.query,
-                data: req.data,
-            });
-        };
+  }
+
+  /**
+   * 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,
+      })
     }
+  }
 }
-exports.FastifyHandler = FastifyHandler;

package/src/Handlers/HttpExceptionHandler.js

@@ -1,71 +1,75 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpExceptionHandler = void 0;
-const logger_1 = require("@athenna/logger");
-const utils_1 = require("@secjs/utils");
-const config_1 = require("@athenna/config");
-class HttpExceptionHandler {
-    constructor() {
-        /**
-         * Set if error logs will come with stack.
-         *
-         * @protected
-         */
-        this.addStack = false;
-        /**
-         * Error codes that should be ignored by Log.
-         *
-         * @protected
-         */
-        this.ignoreCodes = [];
-        /**
-         * Error statuses that should be ignored by Log.
-         *
-         * @protected
-         */
-        this.ignoreStatuses = [];
+import { Log } from '@athenna/logger'
+import { Config, Exception, String } from '@secjs/utils'
+
+export class HttpExceptionHandler {
+  /**
+   * Error codes that should be ignored by Log.
+   *
+   * @type {string[]}
+   */
+  ignoreCodes = []
+
+  /**
+   * Error statuses that should be ignored by Log.
+   *
+   * @type {number[]}
+   */
+  ignoreStatuses = []
+
+  /**
+   * 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,
     }
-    /**
-     * The global exception handler of all HTTP requests.
-     *
-     * @param ctx
-     */
-    async handle({ error, response }) {
-        const code = error.code || error.name;
-        const statusCode = error.statusCode || error.status || 500;
-        const body = {
-            statusCode,
-            code: utils_1.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_1.Config.get('app.debug');
-        if (isInternalServerError && !isDebugMode) {
-            body.name = 'Internal server error';
-            body.message = 'An internal server exception has occurred.';
-            delete body.stack;
-        }
-        if (this.ignoreCodes.includes(code) ||
-            this.ignoreStatuses.includes(statusCode)) {
-            return response.status(statusCode).send(body);
-        }
-        const logConfig = {
-            formatterConfig: {
-                context: 'ExceptionHandler',
-            },
-        };
-        if (this.addStack) {
-            logger_1.Log.error(`(${body.statusCode}) ${body.code}: ${body.message}\nStack: ${body.stack}`, logConfig);
-        }
-        else {
-            logger_1.Log.error(`(${body.statusCode}) ${body.code}: ${body.message}`, logConfig);
-        }
-        return response.status(statusCode).send(body);
+
+    if (error.help) {
+      body.help = error.help
     }
+
+    const isInternalServerError = statusCode === 500
+    const isDebugMode = Config.get('app.debug')
+
+    if (isInternalServerError && !isDebugMode) {
+      body.name = 'Internal server error'
+      body.message = 'An internal server exception has occurred.'
+
+      delete body.stack
+    }
+
+    if (
+      this.ignoreCodes.includes(code) ||
+      this.ignoreStatuses.includes(statusCode)
+    ) {
+      return response.status(statusCode).send(body)
+    }
+
+    response.status(statusCode).send(body)
+
+    if (error.prettify) {
+      const prettyError = await error.prettify()
+
+      Log.channel('exception').error(prettyError.concat('\n'))
+
+      return
+    }
+
+    const prettyError = await new Exception(
+      body.message,
+      body.statusCode,
+      body.code,
+    ).prettify()
+
+    Log.channel('exception').error(prettyError.concat('\n'))
+  }
 }
-exports.HttpExceptionHandler = HttpExceptionHandler;