@athenna/http 1.3.1 → 1.3.4

package/src/Http.d.ts

@@ -1,167 +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 LightMyRequest from 'light-my-request';
-import { FastifyCorsOptions } from 'fastify-cors';
-import { RateLimitPluginOptions } from 'fastify-rate-limit';
-import { FastifyInstance, FastifyPluginCallback, FastifyPluginOptions, FastifyRegisterOptions, InjectOptions, PrintRoutesOptions } from 'fastify';
-import { HttpMethodTypes } from './Contracts/HttpMethodTypes';
-import { HandlerContract } from './Contracts/Context/HandlerContract';
-import { MiddlewareTypesContract } from './Contracts/MiddlewareTypesContract';
-import { ErrorHandlerContract } from './Contracts/Context/Error/ErrorHandlerContract';
-import { HandleHandlerContract } from './Contracts/Context/Middlewares/Handle/HandleHandlerContract';
-import { InterceptHandlerContract } from './Contracts/Context/Middlewares/Intercept/InterceptHandlerContract';
-import { TerminateHandlerContract } from './Contracts/Context/Middlewares/Terminate/TerminateHandlerContract';
-export declare class Http {
-    /**
-     * Holds the fastify server instance.
-     *
-     * @private
-     */
-    private readonly server;
-    /**
-     * Instantiate Http class and fastify server.
-     *
-     * @return Http
-     */
-    constructor();
-    /**
-     * Set the fastify error handler.
-     *
-     * @return Http
-     */
-    setErrorHandler(handler: ErrorHandlerContract): void;
-    /**
-     * Register a new fastify plugin.
-     *
-     * @return FastifyInstance
-     */
-    register(plugin: FastifyPluginCallback<FastifyPluginOptions>, opts?: FastifyRegisterOptions<FastifyPluginOptions>): void;
-    /**
-     * Register the cors plugin to fastify server.
-     */
-    registerCors(opts?: FastifyCorsOptions): void;
-    /**
-     * Register the rateLimit plugin to fastify server.
-     */
-    registerRateLimit(opts?: RateLimitPluginOptions): void;
-    /**
-     * Get the fastify server instance.
-     *
-     * @return FastifyInstance
-     */
-    getServer(): FastifyInstance;
-    /**
-     * Print all routes registered
-     *
-     * @param options {PrintRoutesOptions}
-     * @return string
-     */
-    getRoutes(options?: PrintRoutesOptions): string;
-    /**
-     * Print all routes registered.
-     *
-     * @param handler {HandleHandlerContract,InterceptHandlerContract,TerminateHandlerContract}
-     * @param type {handle,intercept,terminate}
-     * @return void
-     */
-    use(handler: HandleHandlerContract): any;
-    use(handler: HandleHandlerContract, type: 'handle'): any;
-    use(handler: InterceptHandlerContract, type: 'intercept'): any;
-    use(handler: TerminateHandlerContract, type: 'terminate'): any;
-    request(): LightMyRequest.Chain;
-    request(options: InjectOptions | string): Promise<LightMyRequest.Response>;
-    /**
-     * Boot the http server to start listening on port and host defined.
-     *
-     * @param port {string,number}
-     * @param host {string}
-     * @return void
-     */
-    listen(port?: string | number, host?: string): Promise<string>;
-    /**
-     * Close the http server.
-     *
-     * @param cb {any}
-     * @return Promise<void>
-     */
-    close(cb?: any): Promise<void>;
-    /**
-     * Add a new route to the http server.
-     *
-     * @param url {string}
-     * @param methods {HttpMethodTypes[]}
-     * @param handler {HandlerContract}
-     * @param middlewares {MiddlewareTypesContract}
-     * @return void
-     */
-    route(url: string, methods: HttpMethodTypes[], handler: HandlerContract, middlewares?: MiddlewareTypesContract): void;
-    /**
-     * Add a new GET route to the http server.
-     *
-     * @param url {string}
-     * @param handler {HandlerContract}
-     * @param middlewares {MiddlewareTypesContract}
-     * @return void
-     */
-    get(url: string, handler: HandlerContract, middlewares?: MiddlewareTypesContract): void;
-    /**
-     * Add a new HEAD route to the http server.
-     *
-     * @param url {string}
-     * @param handler {HandlerContract}
-     * @param middlewares {MiddlewareTypesContract}
-     * @return void
-     */
-    head(url: string, handler: HandlerContract, middlewares?: MiddlewareTypesContract): void;
-    /**
-     * Add a new POST route to the http server.
-     *
-     * @param url {string}
-     * @param handler {HandlerContract}
-     * @param middlewares {MiddlewareTypesContract}
-     * @return void
-     */
-    post(url: string, handler: HandlerContract, middlewares?: MiddlewareTypesContract): void;
-    /**
-     * Add a new PUT route to the http server.
-     *
-     * @param url {string}
-     * @param handler {HandlerContract}
-     * @param middlewares {MiddlewareTypesContract}
-     * @return void
-     */
-    put(url: string, handler: HandlerContract, middlewares?: MiddlewareTypesContract): void;
-    /**
-     * Add a new PATCH route to the http server.
-     *
-     * @param url {string}
-     * @param handler {HandlerContract}
-     * @param middlewares {MiddlewareTypesContract}
-     * @return void
-     */
-    patch(url: string, handler: HandlerContract, middlewares?: MiddlewareTypesContract): void;
-    /**
-     * Add a new DELETE route to the http server.
-     *
-     * @param url {string}
-     * @param handler {HandlerContract}
-     * @param middlewares {MiddlewareTypesContract}
-     * @return void
-     */
-    delete(url: string, handler: HandlerContract, middlewares?: MiddlewareTypesContract): void;
-    /**
-     * Add a new OPTIONS route to the http server.
-     *
-     * @param url {string}
-     * @param handler {HandlerContract}
-     * @param middlewares {MiddlewareTypesContract}
-     * @return void
-     */
-    options(url: string, handler: HandlerContract, middlewares?: MiddlewareTypesContract): void;
-}

package/src/Http.js

@@ -1,223 +0,0 @@
-"use strict";
-/**
- * @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.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Http = void 0;
-const fastify_cors_1 = __importDefault(require("fastify-cors"));
-const fastify_rate_limit_1 = __importDefault(require("fastify-rate-limit"));
-const fastify_1 = __importDefault(require("fastify"));
-const FastifyHandler_1 = require("./Handlers/FastifyHandler");
-class Http {
-    /**
-     * Instantiate Http class and fastify server.
-     *
-     * @return Http
-     */
-    constructor() {
-        this.server = fastify_1.default();
-    }
-    /**
-     * Set the fastify error handler.
-     *
-     * @return Http
-     */
-    setErrorHandler(handler) {
-        const fastifyErrorHandler = FastifyHandler_1.FastifyHandler.createErrorHandler(handler);
-        this.server.setErrorHandler(fastifyErrorHandler);
-    }
-    /**
-     * Register a new fastify plugin.
-     *
-     * @return FastifyInstance
-     */
-    register(plugin, opts) {
-        this.server.register(plugin, opts);
-    }
-    /**
-     * Register the cors plugin to fastify server.
-     */
-    registerCors(opts) {
-        this.register(fastify_cors_1.default, opts);
-    }
-    /**
-     * Register the rateLimit plugin to fastify server.
-     */
-    registerRateLimit(opts) {
-        this.register(fastify_rate_limit_1.default, opts);
-    }
-    /**
-     * Get the fastify server instance.
-     *
-     * @return FastifyInstance
-     */
-    getServer() {
-        return this.server;
-    }
-    /**
-     * Print all routes registered
-     *
-     * @param options {PrintRoutesOptions}
-     * @return string
-     */
-    getRoutes(options) {
-        return this.server.printRoutes(options);
-    }
-    use(handler, type = 'handle') {
-        let hookName = 'preHandler';
-        let handlerType = 'createDoneHandler';
-        switch (type) {
-            case 'intercept':
-                hookName = 'onSend';
-                handlerType = 'createOnSendHandler';
-                break;
-            case 'terminate':
-                hookName = 'onResponse';
-                handlerType = 'createResponseHandler';
-                break;
-        }
-        this.server.addHook(hookName, FastifyHandler_1.FastifyHandler[handlerType](handler));
-    }
-    /**
-     * Return a request handler to make internal requests to the Http server.
-     *
-     * @param options {InjectOptions,string}
-     * @return {LightMyRequest.Chain,Promise<LightMyRequest.Response>}
-     */
-    request(options) {
-        const server = this.getServer();
-        if (!options) {
-            return server.inject();
-        }
-        return server.inject(options);
-    }
-    /**
-     * Boot the http server to start listening on port and host defined.
-     *
-     * @param port {string,number}
-     * @param host {string}
-     * @return void
-     */
-    async listen(port, host) {
-        return this.server.listen(port || 1335, host || 'localhost');
-    }
-    /**
-     * Close the http server.
-     *
-     * @param cb {any}
-     * @return Promise<void>
-     */
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    async close(cb) {
-        if (cb) {
-            return this.server.close(cb);
-        }
-        return this.server.close();
-    }
-    /**
-     * Add a new route to the http server.
-     *
-     * @param url {string}
-     * @param methods {HttpMethodTypes[]}
-     * @param handler {HandlerContract}
-     * @param middlewares {MiddlewareTypesContract}
-     * @return void
-     */
-    route(url, methods, handler, middlewares) {
-        const { handlers, terminators, interceptors } = Object.assign({}, { handlers: [], terminators: [], interceptors: [] }, middlewares);
-        this.server.route({
-            url,
-            method: methods,
-            handler: FastifyHandler_1.FastifyHandler.createRequestHandler(handler),
-            preHandler: handlers.map(m => FastifyHandler_1.FastifyHandler.createDoneHandler(m)),
-            onResponse: terminators.map(m => FastifyHandler_1.FastifyHandler.createResponseHandler(m)),
-            onSend: interceptors.map(m => FastifyHandler_1.FastifyHandler.createOnSendHandler(m)),
-        });
-    }
-    /**
-     * Add a new GET route to the http server.
-     *
-     * @param url {string}
-     * @param handler {HandlerContract}
-     * @param middlewares {MiddlewareTypesContract}
-     * @return void
-     */
-    get(url, handler, middlewares) {
-        this.route(url, ['GET'], handler, middlewares);
-    }
-    /**
-     * Add a new HEAD route to the http server.
-     *
-     * @param url {string}
-     * @param handler {HandlerContract}
-     * @param middlewares {MiddlewareTypesContract}
-     * @return void
-     */
-    head(url, handler, middlewares) {
-        this.route(url, ['HEAD'], handler, middlewares);
-    }
-    /**
-     * Add a new POST route to the http server.
-     *
-     * @param url {string}
-     * @param handler {HandlerContract}
-     * @param middlewares {MiddlewareTypesContract}
-     * @return void
-     */
-    post(url, handler, middlewares) {
-        this.route(url, ['POST'], handler, middlewares);
-    }
-    /**
-     * Add a new PUT route to the http server.
-     *
-     * @param url {string}
-     * @param handler {HandlerContract}
-     * @param middlewares {MiddlewareTypesContract}
-     * @return void
-     */
-    put(url, handler, middlewares) {
-        this.route(url, ['PUT'], handler, middlewares);
-    }
-    /**
-     * Add a new PATCH route to the http server.
-     *
-     * @param url {string}
-     * @param handler {HandlerContract}
-     * @param middlewares {MiddlewareTypesContract}
-     * @return void
-     */
-    patch(url, handler, middlewares) {
-        this.route(url, ['PATCH'], handler, middlewares);
-    }
-    /**
-     * Add a new DELETE route to the http server.
-     *
-     * @param url {string}
-     * @param handler {HandlerContract}
-     * @param middlewares {MiddlewareTypesContract}
-     * @return void
-     */
-    delete(url, handler, middlewares) {
-        this.route(url, ['DELETE'], handler, middlewares);
-    }
-    /**
-     * Add a new OPTIONS route to the http server.
-     *
-     * @param url {string}
-     * @param handler {HandlerContract}
-     * @param middlewares {MiddlewareTypesContract}
-     * @return void
-     */
-    options(url, handler, middlewares) {
-        this.route(url, ['OPTIONS'], handler, middlewares);
-    }
-}
-exports.Http = Http;

package/src/Kernels/HttpKernel.d.ts

@@ -1,54 +0,0 @@
-import { MiddlewareContract } from '../Contracts/MiddlewareContract';
-export declare type MiddlewareContractClass = {
-    new (container?: any): MiddlewareContract;
-};
-export declare abstract class HttpKernel {
-    /**
-     * The application's global HTTP middlewares.
-     *
-     * This middlewares are run during every request to your http server.
-     */
-    protected abstract globalMiddlewares: MiddlewareContractClass[] | Promise<any>[];
-    /**
-     * The application's named HTTP middlewares.
-     *
-     * Here you define all your named middlewares to use inside routes/http file.
-     */
-    protected abstract namedMiddlewares: Record<string, Promise<any> | MiddlewareContractClass>;
-    /**
-     * Register all global and named middlewares to the server.
-     *
-     * @return void
-     */
-    registerMiddlewares(): Promise<void>;
-    /**
-     * Register cors plugin
-     *
-     * @return void
-     */
-    registerCors(): Promise<void>;
-    /**
-     * Register rate limit plugin
-     *
-     * @return void
-     */
-    registerRateLimit(): Promise<void>;
-    /**
-     * Register the default error handler
-     *
-     * @return void
-     */
-    registerErrorHandler(): Promise<void>;
-    /**
-     * Register log terminate middleware
-     *
-     * @return void
-     */
-    registerLogMiddleware(): Promise<void>;
-    /**
-     * Register the requestId handle middleware.
-     *
-     * @return void
-     */
-    registerRequestIdMiddleware(): Promise<void>;
-}

package/src/Providers/ControllerProvider.d.ts

@@ -1,17 +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 { ServiceProvider } from '@athenna/ioc';
-export declare class ControllerProvider extends ServiceProvider {
-    /**
-     * Bootstrap any application services.
-     *
-     * @return void
-     */
-    boot(): Promise<void>;
-}

package/src/Providers/HttpRouteProvider.d.ts

@@ -1,17 +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 { ServiceProvider } from '@athenna/ioc';
-export declare class HttpRouteProvider extends ServiceProvider {
-    /**
-     * Bootstrap any application services.
-     *
-     * @return void
-     */
-    boot(): void;
-}

package/src/Providers/HttpServerProvider.d.ts

@@ -1,17 +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 { ServiceProvider } from '@athenna/ioc';
-export declare class HttpServerProvider extends ServiceProvider {
-    /**
-     * Register any application services.
-     *
-     * @return void
-     */
-    register(): void;
-}

package/src/Providers/MiddlewareProvider.d.ts

@@ -1,17 +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 { ServiceProvider } from '@athenna/ioc';
-export declare class MiddlewareProvider extends ServiceProvider {
-    /**
-     * Bootstrap any application services.
-     *
-     * @return void
-     */
-    boot(): Promise<void>;
-}

package/src/Router/Route.d.ts

@@ -1,32 +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 '@athenna/ioc';
-import { MiddlewareTypes } from '../Contracts/MiddlewareTypes';
-import { HttpMethodTypes } from '../Contracts/HttpMethodTypes';
-import { MiddlewareContract } from '../Contracts/MiddlewareContract';
-import { HandlerContract } from '../Contracts/Context/HandlerContract';
-import { InterceptHandlerContract } from '../Contracts/Context/Middlewares/Intercept/InterceptHandlerContract';
-import { TerminateHandlerContract } from '../Contracts/Context/Middlewares/Terminate/TerminateHandlerContract';
-export declare class Route {
-    name: string;
-    deleted: boolean;
-    private readonly url;
-    private readonly handler;
-    private readonly methods;
-    private routeMiddlewares;
-    private routeNamespace;
-    private prefixes;
-    constructor(url: string, methods: HttpMethodTypes[], handler: HandlerContract | string);
-    prefix(prefix: any): this;
-    as(name: string, prepend?: boolean): this;
-    namespace(namespace: string, overwrite?: boolean): this;
-    middleware(middleware: HandlerContract | MiddlewareContract | InterceptHandlerContract | TerminateHandlerContract | string, type?: MiddlewareTypes, prepend?: boolean): this;
-    toJSON(): any;
-    private getUrl;
-}

package/src/Router/RouteGroup.d.ts

@@ -1,24 +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 { Route } from './Route';
-import { RouteResource } from './RouteResource';
-import { MiddlewareTypes } from '../Contracts/MiddlewareTypes';
-import { MiddlewareContract } from '../Contracts/MiddlewareContract';
-import { HandlerContract } from '../Contracts/Context/HandlerContract';
-import { InterceptHandlerContract } from '../Contracts/Context/Middlewares/Intercept/InterceptHandlerContract';
-import { TerminateHandlerContract } from '../Contracts/Context/Middlewares/Terminate/TerminateHandlerContract';
-export declare class RouteGroup {
-    routes: (Route | RouteResource | RouteGroup)[];
-    constructor(routes: (Route | RouteResource | RouteGroup)[]);
-    prefix(prefix: string): this;
-    as(name: string): this;
-    namespace(namespace: string): this;
-    middleware(middleware: HandlerContract | MiddlewareContract | InterceptHandlerContract | TerminateHandlerContract | string, type?: MiddlewareTypes, prepend?: boolean): this;
-    private invoke;
-}

package/src/Router/RouteResource.d.ts

@@ -1,29 +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 { Route } from './Route';
-import { MiddlewareTypes } from '../Contracts/MiddlewareTypes';
-import { MiddlewareContract } from '../Contracts/MiddlewareContract';
-import { HandlerContract } from '../Contracts/Context/HandlerContract';
-import { InterceptHandlerContract } from '../Contracts/Context/Middlewares/Intercept/InterceptHandlerContract';
-import { TerminateHandlerContract } from '../Contracts/Context/Middlewares/Terminate/TerminateHandlerContract';
-export declare class RouteResource {
-    routes: Route[];
-    private resource;
-    private readonly controller;
-    private resourceName;
-    constructor(resource: string, controller: any);
-    middleware(middleware: HandlerContract | MiddlewareContract | InterceptHandlerContract | TerminateHandlerContract | string, type?: MiddlewareTypes): this;
-    only(names: string[]): this;
-    except(names: string[]): this;
-    namespace(namespace: string): this;
-    as(name: string): this;
-    private makeRoute;
-    private buildRoutes;
-    private filter;
-}

package/src/Router/Router.d.ts

@@ -1,39 +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 '@athenna/ioc';
-import { Http } from '../Http';
-import { Route } from './Route';
-import { RouteGroup } from './RouteGroup';
-import { RouteResource } from './RouteResource';
-import { HttpMethodTypes } from '../Contracts/HttpMethodTypes';
-import { HandlerContract } from '../Contracts/Context/HandlerContract';
-export declare class Router {
-    routes: (Route | RouteResource | RouteGroup)[];
-    private readonly openedGroups;
-    private readonly http;
-    private controllerInstance;
-    constructor(http: Http);
-    listRoutes(): any;
-    controller(controller: any): this;
-    route(url: string, methods: HttpMethodTypes[], handler: HandlerContract | string): Route;
-    group(callback: () => void): RouteGroup;
-    resource(resource: string, controller: any): RouteResource;
-    redirect(url: string, redirectTo: string, status?: number): Route;
-    get(url: string, handler: HandlerContract | string): Route;
-    head(url: string, handler: HandlerContract | string): Route;
-    post(url: string, handler: HandlerContract | string): Route;
-    put(url: string, handler: HandlerContract | string): Route;
-    patch(url: string, handler: HandlerContract | string): Route;
-    delete(url: string, handler: HandlerContract | string): Route;
-    options(url: string, handler: HandlerContract | string): Route;
-    any(url: string, handler: HandlerContract | string): Route;
-    register(): void;
-    toRoutesJSON(routes?: any): any;
-    private getRecentGroup;
-}

package/src/Utils/getAppFiles.d.ts

@@ -1,10 +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 { File } from '@secjs/utils';
-export declare function getAppFiles(path: string): File[];

package/src/Utils/getAppFiles.js

@@ -1,22 +0,0 @@
-"use strict";
-/**
- * @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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAppFiles = void 0;
-const fs_1 = require("fs");
-const utils_1 = require("@secjs/utils");
-function getAppFiles(path) {
-    if (!fs_1.existsSync(path))
-        return [];
-    return (new utils_1.Folder(path)
-        .loadSync()
-        // Get all .js and .ts files but not the .d.ts.
-        .getFilesByPattern('!(*.d)*.*(js|ts)'));
-}
-exports.getAppFiles = getAppFiles;

package/src/Utils/isMiddlewareContract.d.ts

@@ -1,10 +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 { MiddlewareContract } from '../Contracts/MiddlewareContract';
-export declare function isMiddlewareContract(object: any): object is MiddlewareContract;