@athenna/http 3.0.11 → 3.1.0

package/build/Context/Response.d.ts

@@ -0,0 +1,67 @@
+/**
+ * @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 { FastifyReply } from 'fastify';
+import { FastifyHelmetOptions } from '@fastify/helmet';
+export declare class Response {
+    /**
+     * The fastify response object.
+     */
+    response: FastifyReply;
+    constructor(response: FastifyReply);
+    /**
+     * Verify if the response has been already sent.
+     */
+    get sent(): boolean;
+    /**
+     * Get the status code sent in response.
+     */
+    get statusCode(): number;
+    /**
+     * Get the headers sent in response.
+     */
+    get headers(): any;
+    /**
+     * Get the time in MS of how much the request has taken to response.
+     */
+    get responseTime(): number;
+    /**
+     * Terminate the request sending the response body or not.
+     */
+    send(data?: any): Promise<Response>;
+    /**
+     * Set the response status code.
+     */
+    status(code: number): Response;
+    /**
+     * Add some header to the response.
+     */
+    header(header: string, value: any): Response;
+    /**
+     * Verify if response has some header.
+     */
+    hasHeader(header: string): boolean;
+    /**
+     * Add some header safelly to the response. This means that the header is not
+     * going to be added if is already set.
+     */
+    safeHeader(header: string, value: any): Response;
+    /**
+     * Remove some header from the response.
+     */
+    removeHeader(header: string): Response;
+    /**
+     * Redirect the response to other url. You can also set a different status code
+     * for the redirect.
+     */
+    redirectTo(url: string, status?: number): Promise<Response>;
+    /**
+     * Apply helmet in response.
+     */
+    helmet(options: FastifyHelmetOptions): Response;
+}

package/build/Context/Response.js

@@ -0,0 +1,102 @@
+/**
+ * @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 {
+    /**
+     * The fastify response object.
+     */
+    response;
+    constructor(response) {
+        this.response = response;
+    }
+    /**
+     * Verify if the response has been already sent.
+     */
+    get sent() {
+        return this.response.sent;
+    }
+    /**
+     * Get the status code sent in response.
+     */
+    get statusCode() {
+        return this.response.statusCode;
+    }
+    /**
+     * Get the headers sent in response.
+     */
+    get headers() {
+        return this.response.getHeaders();
+    }
+    /**
+     * Get the time in MS of how much the request has taken to response.
+     */
+    get responseTime() {
+        return this.response.getResponseTime();
+    }
+    /**
+     * Terminate the request sending the response body or not.
+     */
+    async send(data) {
+        await this.response.send(data);
+        return this;
+    }
+    /**
+     * Set the response status code.
+     */
+    status(code) {
+        this.response.status(code);
+        return this;
+    }
+    /**
+     * Add some header to the response.
+     */
+    header(header, value) {
+        this.response.header(header, value);
+        return this;
+    }
+    /**
+     * Verify if response has some header.
+     */
+    hasHeader(header) {
+        return this.response.hasHeader(header);
+    }
+    /**
+     * Add some header safelly to the response. This means that the header is not
+     * going to be added if is already set.
+     */
+    safeHeader(header, value) {
+        this.response.header(header, value);
+        return this;
+    }
+    /**
+     * Remove some header from the response.
+     */
+    removeHeader(header) {
+        this.response.removeHeader(header);
+        return this;
+    }
+    /**
+     * Redirect the response to other url. You can also set a different status code
+     * for the redirect.
+     */
+    async redirectTo(url, status) {
+        if (status) {
+            await this.response.redirect(status, url);
+            return this;
+        }
+        await this.response.redirect(url);
+        return this;
+    }
+    /**
+     * Apply helmet in response.
+     */
+    helmet(options) {
+        this.response.helmet(options);
+        return this;
+    }
+}

package/build/Contracts/InterceptorContract.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @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 { InterceptContext } from '#src/Types/Contexts/InterceptContext';
+export interface InterceptorContract {
+    /**
+     * Intercept the request at the end, before returning the response.
+     */
+    intercept(ctx: InterceptContext): unknown | Promise<unknown>;
+}

package/build/Contracts/InterceptorContract.js

@@ -0,0 +1,9 @@
+/**
+ * @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 {};

package/build/Contracts/MiddlewareContract.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @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 { Context } from '#src/Types/Contexts/Context';
+export interface MiddlewareContract {
+    /**
+     * Handle the request before going to the route handler.
+     */
+    handle(ctx: Context): any | Promise<any>;
+}

package/build/Contracts/MiddlewareContract.js

@@ -0,0 +1,9 @@
+/**
+ * @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 {};

package/build/Contracts/TerminatorContract.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @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 { TerminateContext } from '#src/Types/Contexts/TerminateContext';
+export interface TerminatorContract {
+    /**
+     * Handle the request after the response has been sent.
+     */
+    terminate(ctx: TerminateContext): any | Promise<any>;
+}

package/build/Contracts/TerminatorContract.js

@@ -0,0 +1,9 @@
+/**
+ * @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 {};

package/build/Decorators/Controller.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @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 'reflect-metadata';
+import { ControllerOptions } from '#src/Types/Controllers/ControllerOptions';
+/**
+ * Create a controller inside the service provider.
+ */
+export declare function Controller(options?: ControllerOptions): ClassDecorator;

package/build/Decorators/Controller.js

@@ -0,0 +1,28 @@
+/**
+ * @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 'reflect-metadata';
+import { Options } from '@athenna/common';
+/**
+ * Create a controller inside the service provider.
+ */
+export function Controller(options) {
+    return (target) => {
+        options = Options.create(options, {
+            alias: `App/Http/Controllers/${target.name}`,
+            type: 'transient',
+        });
+        const alias = options.alias;
+        const createCamelAlias = false;
+        if (ioc.hasDependency(alias)) {
+            return;
+        }
+        ioc[options.type](alias, target, createCamelAlias);
+        Reflect.defineMetadata('provider:registered', true, target);
+    };
+}

package/build/Decorators/Interceptor.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @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 'reflect-metadata';
+import { MiddlewareOptions } from '#src/Types/Middlewares/MiddlewareOptions';
+/**
+ * Create a interceptor inside the service provider.
+ */
+export declare function Interceptor(options?: MiddlewareOptions): ClassDecorator;

package/build/Decorators/Interceptor.js

@@ -0,0 +1,37 @@
+/**
+ * @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 'reflect-metadata';
+import { Server } from '#src/Facades/Server';
+import { Options, String } from '@athenna/common';
+/**
+ * Create a interceptor inside the service provider.
+ */
+export function Interceptor(options) {
+    return (target) => {
+        options = Options.create(options, {
+            isGlobal: false,
+            name: String.toCamelCase(target.name),
+            alias: `App/Http/Interceptors/${target.name}`,
+            type: 'transient',
+        });
+        const alias = options.alias;
+        const createCamelAlias = false;
+        if (ioc.hasDependency(alias)) {
+            return;
+        }
+        ioc[options.type](alias, target, createCamelAlias);
+        Reflect.defineMetadata('provider:registered', true, target);
+        if (!options.isGlobal) {
+            ioc.alias(`App/Http/Interceptors/Names/${options.name}`, alias);
+            return;
+        }
+        const Interceptor = ioc.safeUse(alias);
+        Server.intercept(Interceptor.intercept);
+    };
+}

package/build/Decorators/Middleware.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @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 'reflect-metadata';
+import { MiddlewareOptions } from '#src/Types/Middlewares/MiddlewareOptions';
+/**
+ * Create a middleware inside the service provider.
+ */
+export declare function Middleware(options?: MiddlewareOptions): ClassDecorator;

package/build/Decorators/Middleware.js

@@ -0,0 +1,37 @@
+/**
+ * @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 'reflect-metadata';
+import { Server } from '#src/Facades/Server';
+import { Options, String } from '@athenna/common';
+/**
+ * Create a middleware inside the service provider.
+ */
+export function Middleware(options) {
+    return (target) => {
+        options = Options.create(options, {
+            isGlobal: false,
+            name: String.toCamelCase(target.name),
+            alias: `App/Http/Middlewares/${target.name}`,
+            type: 'transient',
+        });
+        const alias = options.alias;
+        const createCamelAlias = false;
+        if (ioc.hasDependency(alias)) {
+            return;
+        }
+        ioc[options.type](alias, target, createCamelAlias);
+        Reflect.defineMetadata('provider:registered', true, target);
+        if (!options.isGlobal) {
+            ioc.alias(`App/Http/Middlewares/Names/${options.name}`, alias);
+            return;
+        }
+        const Middleware = ioc.safeUse(alias);
+        Server.middleware(Middleware.handle);
+    };
+}

package/build/Decorators/Terminator.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @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 'reflect-metadata';
+import { MiddlewareOptions } from '#src/Types/Middlewares/MiddlewareOptions';
+/**
+ * Create a middleware inside the service provider.
+ */
+export declare function Terminator(options?: MiddlewareOptions): ClassDecorator;

package/build/Decorators/Terminator.js

@@ -0,0 +1,37 @@
+/**
+ * @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 'reflect-metadata';
+import { Server } from '#src/Facades/Server';
+import { Options, String } from '@athenna/common';
+/**
+ * Create a middleware inside the service provider.
+ */
+export function Terminator(options) {
+    return (target) => {
+        options = Options.create(options, {
+            isGlobal: false,
+            name: String.toCamelCase(target.name),
+            alias: `App/Http/Terminators/${target.name}`,
+            type: 'transient',
+        });
+        const alias = options.alias;
+        const createCamelAlias = false;
+        if (ioc.hasDependency(alias)) {
+            return;
+        }
+        ioc[options.type](alias, target, createCamelAlias);
+        Reflect.defineMetadata('provider:registered', true, target);
+        if (!options.isGlobal) {
+            ioc.alias(`App/Http/Terminators/Names/${options.name}`, alias);
+            return;
+        }
+        const Terminator = ioc.safeUse(alias);
+        Server.middleware(Terminator.terminate);
+    };
+}

package/build/Exceptions/BadGatewayException.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 BadGatewayException extends HttpException {
+    /**
+     * This exception uses the 502 status code and the "E_BAD_GATEWAY_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new BadGatewayException()
+     * ```
+     */
+    constructor(message?: string, help?: any);
+}

package/build/Exceptions/BadGatewayException.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 BadGatewayException extends HttpException {
+    /**
+     * This exception uses the 502 status code and the "E_BAD_GATEWAY_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new BadGatewayException()
+     * ```
+     */
+    constructor(message = 'Bad gateway error happened.', help = null) {
+        super({ help, message, status: 502, code: 'E_BAD_GATEWAY_ERROR' });
+    }
+}

package/build/Exceptions/BadRequestException.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 BadRequestException extends HttpException {
+    /**
+     * This exception uses the 400 status code and the "E_BAD_REQUEST_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new BadRequestException()
+     * ```
+     */
+    constructor(message?: string, help?: any);
+}

package/build/Exceptions/BadRequestException.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 BadRequestException extends HttpException {
+    /**
+     * This exception uses the 400 status code and the "E_BAD_REQUEST_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new BadRequestException()
+     * ```
+     */
+    constructor(message = 'Bad request error happened.', help = null) {
+        super({ help, message, status: 400, code: 'E_BAD_REQUEST_ERROR' });
+    }
+}

package/build/Exceptions/ForbiddenException.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 ForbiddenException extends HttpException {
+    /**
+     * This exception uses the 403 status code and the "E_FORBIDDEN_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new ForbiddenException()
+     * ```
+     */
+    constructor(message?: string, help?: any);
+}

package/build/Exceptions/ForbiddenException.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 ForbiddenException extends HttpException {
+    /**
+     * This exception uses the 403 status code and the "E_FORBIDDEN_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new ForbiddenException()
+     * ```
+     */
+    constructor(message = 'Forbidden request error happened.', help = null) {
+        super({ help, message, status: 403, code: 'E_FORBIDDEN_ERROR' });
+    }
+}

package/build/Exceptions/HttpException.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 { Exception, ExceptionJSON } from '@athenna/common';
+export declare class HttpException extends Exception {
+    /**
+     * This exception uses the 500 status code and the "E_HTTP_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new HttpException()
+     * ```
+     */
+    constructor(options?: ExceptionJSON);
+}

package/build/Exceptions/HttpException.js

@@ -0,0 +1,27 @@
+/**
+ * @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, Options } from '@athenna/common';
+export class HttpException extends Exception {
+    /**
+     * This exception uses the 500 status code and the "E_HTTP_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new HttpException()
+     * ```
+     */
+    constructor(options = {}) {
+        options = Options.create(options, {
+            status: 500,
+            code: 'E_HTTP_ERROR',
+            message: 'An http exception has ocurred.',
+        });
+        super(options);
+    }
+}

package/build/Exceptions/InternalServerException.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 InternalServerException extends HttpException {
+    /**
+     * This exception uses the 500 status code and the "E_INTERNAL_ERROR" code.
+     *
+     * @example
+     * ```js
+     * throw new InternalServerException()
+     * ```
+     */
+    constructor(message?: string, help?: any);
+}