@athenna/http 3.0.11 → 3.1.0

package/build/Exceptions/InternalServerException.js

@@ -0,0 +1,22 @@
+/**
+ * @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 {
+    /**
+     * This exception uses the 500 status code and the "E_INTERNAL_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new InternalServerException()
+     * ```
+     */
+    constructor(message = 'Internal server error happened.', help = null) {
+        super({ help, message, status: 500, code: 'E_INTERNAL_ERROR' });
+    }
+}

package/build/Exceptions/MethodNotAllowedException.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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 declare class MethodNotAllowedException extends HttpException {
+    /**
+     * This exception uses the 405 status code and the "E_METHOD_NOT_ALLOWED_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new MethodNotAllowedException()
+     * ```
+     */
+    constructor(message?: string, help?: any);
+}

package/build/Exceptions/MethodNotAllowedException.js

@@ -0,0 +1,22 @@
+/**
+ * @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 {
+    /**
+     * This exception uses the 405 status code and the "E_METHOD_NOT_ALLOWED_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new MethodNotAllowedException()
+     * ```
+     */
+    constructor(message = 'Method not allowed error happened.', help = null) {
+        super({ help, message, status: 405, code: 'E_METHOD_NOT_ALLOWED_ERROR' });
+    }
+}

package/build/Exceptions/NotAcceptableException.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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 declare class NotAcceptableException extends HttpException {
+    /**
+     * This exception uses the 406 status code and the "E_NOT_ACCEPTABLE_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new NotAcceptableException()
+     * ```
+     */
+    constructor(message?: string, help?: any);
+}

package/build/Exceptions/NotAcceptableException.js

@@ -0,0 +1,22 @@
+/**
+ * @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 {
+    /**
+     * This exception uses the 406 status code and the "E_NOT_ACCEPTABLE_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new NotAcceptableException()
+     * ```
+     */
+    constructor(message = 'Not acceptable error happened.', help = null) {
+        super({ help, message, status: 406, code: 'E_NOT_ACCEPTABLE_ERROR' });
+    }
+}

package/build/Exceptions/NotFoundException.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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 declare class NotFoundException extends HttpException {
+    /**
+     * This exception uses the 404 status code and the "E_NOT_FOUND_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new NotFoundException()
+     * ```
+     */
+    constructor(message?: string, help?: any);
+}

package/build/Exceptions/NotFoundException.js

@@ -0,0 +1,22 @@
+/**
+ * @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 {
+    /**
+     * This exception uses the 404 status code and the "E_NOT_FOUND_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new NotFoundException()
+     * ```
+     */
+    constructor(message = 'Not found error happened.', help = null) {
+        super({ help, message, status: 404, code: 'E_NOT_FOUND_ERROR' });
+    }
+}

package/build/Exceptions/NotImplementedException.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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 declare class NotImplementedException extends HttpException {
+    /**
+     * This exception uses the 501 status code and the "E_NOT_IMPLEMENTED_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new NotImplementedException()
+     * ```
+     */
+    constructor(message?: string, help?: any);
+}

package/build/Exceptions/NotImplementedException.js

@@ -0,0 +1,22 @@
+/**
+ * @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 {
+    /**
+     * This exception uses the 501 status code and the "E_NOT_IMPLEMENTED_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new NotImplementedException()
+     * ```
+     */
+    constructor(message = 'Not implemented error happened.', help = null) {
+        super({ help, message, status: 501, code: 'E_NOT_IMPLEMENTED_ERROR' });
+    }
+}

package/build/Exceptions/PayloadTooLargeException.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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 declare class PayloadTooLargeException extends HttpException {
+    /**
+     * This exception uses the 413 status code and the "E_PAYLOAD_TOO_LARGE_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new PayloadTooLargeException()
+     * ```
+     */
+    constructor(message?: string, help?: any);
+}

package/build/Exceptions/PayloadTooLargeException.js

@@ -0,0 +1,22 @@
+/**
+ * @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 {
+    /**
+     * This exception uses the 413 status code and the "E_PAYLOAD_TOO_LARGE_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new PayloadTooLargeException()
+     * ```
+     */
+    constructor(message = 'Payload to large error happened.', help = null) {
+        super({ help, message, status: 413, code: 'E_PAYLOAD_TOO_LARGE_ERROR' });
+    }
+}

package/build/Exceptions/RequestTimeoutException.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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 declare class RequestTimeoutException extends HttpException {
+    /**
+     * This exception uses the 408 status code and the "E_REQUEST_TIMEOUT_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new RequestTimeoutException()
+     * ```
+     */
+    constructor(message?: string, help?: any);
+}

package/build/Exceptions/RequestTimeoutException.js

@@ -0,0 +1,22 @@
+/**
+ * @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 {
+    /**
+     * This exception uses the 408 status code and the "E_REQUEST_TIMEOUT_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new RequestTimeoutException()
+     * ```
+     */
+    constructor(message = 'Request timeout error happened.', help = null) {
+        super({ help, message, status: 408, code: 'E_REQUEST_TIMEOUT_ERROR' });
+    }
+}

package/build/Exceptions/ServiceUnavailableException.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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 declare class ServiceUnavailableException extends HttpException {
+    /**
+     * This exception uses the 503 status code and the "E_SERVICE_UNAVAILABLE_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new ServiceUnavailableException()
+     * ```
+     */
+    constructor(message?: string, help?: any);
+}

package/build/Exceptions/ServiceUnavailableException.js

@@ -0,0 +1,22 @@
+/**
+ * @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 {
+    /**
+     * This exception uses the 503 status code and the "E_SERVICE_UNAVAILABLE_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new ServiceUnavailableException()
+     * ```
+     */
+    constructor(message = 'Service unavailable error happened.', help = null) {
+        super({ help, message, status: 503, code: 'E_SERVICE_UNAVAILABLE_ERROR' });
+    }
+}

package/build/Exceptions/UnauthorizedException.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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 declare class UnauthorizedException extends HttpException {
+    /**
+     * This exception uses the 401 status code and the "E_UNAUTHORIZED_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new UnauthorizedException()
+     * ```
+     */
+    constructor(message?: string, help?: any);
+}

package/build/Exceptions/UnauthorizedException.js

@@ -0,0 +1,22 @@
+/**
+ * @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 {
+    /**
+     * This exception uses the 401 status code and the "E_UNAUTHORIZED_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new UnauthorizedException()
+     * ```
+     */
+    constructor(message = 'Unauthorized error happened.', help = null) {
+        super({ help, message, status: 401, code: 'E_UNAUTHORIZED_ERROR' });
+    }
+}

package/build/Exceptions/UndefinedMethodException.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @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 declare class UndefinedMethodException extends Exception {
+    constructor(method: string, className: string);
+}

package/build/Exceptions/UndefinedMethodException.js

@@ -0,0 +1,19 @@
+/**
+ * @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 {
+    constructor(method, className) {
+        super({
+            status: 500,
+            code: 'E_UNDEFINED_METHOD',
+            message: `Cannot register the ${method} method in your Route because it's not defined inside your ${className} class.`,
+            help: `Remember defining the method ${method} inside your ${className} class.`,
+        });
+    }
+}

package/build/Exceptions/UnprocessableEntityException.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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 declare class UnprocessableEntityException extends HttpException {
+    /**
+     * This exception uses the 422 status code and the "E_UNPROCESSABLE_ENTITY_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new UnprocessableEntityException()
+     * ```
+     */
+    constructor(message?: string, help?: any);
+}

package/build/Exceptions/UnprocessableEntityException.js

@@ -0,0 +1,22 @@
+/**
+ * @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 {
+    /**
+     * This exception uses the 422 status code and the "E_UNPROCESSABLE_ENTITY_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new UnprocessableEntityException()
+     * ```
+     */
+    constructor(message = 'Unprocessable entity error happened.', help = null) {
+        super({ help, message, status: 422, code: 'E_UNPROCESSABLE_ENTITY_ERROR' });
+    }
+}

package/build/Facades/Route.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @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 { Router } from '#src/Router/Router';
+export declare const Route: import("@athenna/ioc").FacadeType<Router>;

package/{src → build}/Facades/Route.js

@@ -6,10 +6,5 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
-import { Facade } from '@athenna/ioc'
-
-/**
- * @type {typeof Facade & import('../Router/Router.js').Router}
- */
-export const Route = Facade.createFor('Athenna/Core/HttpRoute')
+import { Facade } from '@athenna/ioc';
+export const Route = Facade.createFor('Athenna/Core/HttpRoute');

package/build/Facades/Server.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @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 { ServerImpl } from '#src/Server/ServerImpl';
+export declare const Server: import("@athenna/ioc").FacadeType<ServerImpl>;

package/{src → build}/Facades/Server.js

@@ -6,10 +6,5 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
-import { Facade } from '@athenna/ioc'
-
-/**
- * @type {typeof Facade & import('../index.js').Http}
- */
-export const Server = Facade.createFor('Athenna/Core/HttpServer')
+import { Facade } from '@athenna/ioc';
+export const Server = Facade.createFor('Athenna/Core/HttpServer');

package/build/Handlers/FastifyHandler.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @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.
+ */
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node/http.js" />
+import { InterceptHandler, TerminateHandler } from '#src/Types/Middlewares/MiddlewareHandler';
+import { RequestHandler } from '#src/Types/Contexts/Context';
+import { ErrorHandler } from '#src/Types/Contexts/ErrorContext';
+import { FastifyReply, FastifyRequest, RouteHandlerMethod } from 'fastify';
+export declare class FastifyHandler {
+    /**
+     * Parse the fastify request handler and the preHandler hook to an Athenna
+     * request handler.
+     */
+    static request(handler: RequestHandler): RouteHandlerMethod;
+    /**
+     * Just and alises for the request handler.
+     */
+    static handle(handler: RequestHandler): RouteHandlerMethod<import("http").Server, import("http").IncomingMessage, import("http").ServerResponse, import("fastify").RouteGenericInterface, unknown, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, import("fastify").FastifyBaseLogger>;
+    /**
+     * Parse the fastify onSend hook to an Athenna intercept handler.
+     */
+    static intercept(handler: InterceptHandler): (req: FastifyRequest, res: FastifyReply, payload: any) => Promise<any>;
+    /**
+     * Parse the fastify onResponse hook to an Athenna terminate handler.
+     */
+    static terminate(handler: TerminateHandler): (req: FastifyRequest, res: FastifyReply) => Promise<void>;
+    /**
+     * Parse the fastify onError hook to an Athenna error handler.
+     */
+    static error(handler: ErrorHandler): (error: any, req: FastifyRequest, res: FastifyReply) => Promise<void>;
+    /**
+     * Set the data object in th
+     */
+    private static setData;
+}

package/build/Handlers/FastifyHandler.js

@@ -0,0 +1,116 @@
+/**
+ * @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 {
+    /**
+     * Parse the fastify request handler and the preHandler hook to an Athenna
+     * request handler.
+     */
+    static request(handler) {
+        return async (req, res) => {
+            const request = new Request(req);
+            const response = new Response(res);
+            this.setData(req);
+            await handler({
+                request,
+                response,
+                data: req.data,
+                body: req.body,
+                params: req.params,
+                queries: req.query,
+                headers: req.headers,
+            });
+        };
+    }
+    /**
+     * Just and alises for the request handler.
+     */
+    static handle(handler) {
+        return this.request(handler);
+    }
+    /**
+     * Parse the fastify onSend hook to an Athenna intercept handler.
+     */
+    static intercept(handler) {
+        return async (req, res, payload) => {
+            const request = new Request(req);
+            const response = new Response(res);
+            this.setData(req);
+            if (Is.Json(payload)) {
+                payload = JSON.parse(payload);
+            }
+            payload = await handler({
+                request,
+                response,
+                status: response.statusCode,
+                data: req.data,
+                body: payload,
+                params: req.params,
+                queries: req.query,
+                headers: req.headers,
+            });
+            if (Is.Object(payload)) {
+                payload = JSON.stringify(payload);
+            }
+            return payload;
+        };
+    }
+    /**
+     * Parse the fastify onResponse hook to an Athenna terminate handler.
+     */
+    static terminate(handler) {
+        return async (req, res) => {
+            const request = new Request(req);
+            const response = new Response(res);
+            this.setData(req);
+            await handler({
+                request,
+                response,
+                params: req.params,
+                queries: req.query,
+                data: req.data,
+                body: req.body,
+                headers: res.getHeaders(),
+                status: res.statusCode,
+                responseTime: res.getResponseTime(),
+            });
+        };
+    }
+    /**
+     * Parse the fastify onError hook to an Athenna error handler.
+     */
+    static error(handler) {
+        return async (error, req, res) => {
+            const request = new Request(req);
+            const response = new Response(res);
+            this.setData(req);
+            await handler({
+                request,
+                response,
+                data: req.data,
+                body: req.body,
+                params: req.params,
+                queries: req.query,
+                headers: req.headers,
+                error,
+            });
+        };
+    }
+    /**
+     * Set the data object in th
+     */
+    static setData(request) {
+        if (request.data) {
+            return;
+        }
+        request.data = {};
+    }
+}