@athenna/http 1.3.3 → 1.3.6

package/src/index.js

@@ -0,0 +1,284 @@
+/**
+ * @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 { Options } from '@secjs/utils'
+
+import fastify from 'fastify'
+import fastifyCors from 'fastify-cors'
+import fastifyRateLimit from 'fastify-rate-limit'
+import { FastifyHandler } from '#src/Handlers/FastifyHandler'
+
+export * from './Facades/Route.js'
+export * from './Facades/Server.js'
+export * from './Kernels/HttpKernel.js'
+export * from './Handlers/HttpExceptionHandler.js'
+
+export class Http {
+  /**
+   * Holds the fastify server instance.
+   *
+   * @type {import('fastify').FastifyInstance}
+   */
+  #server
+
+  /**
+   * Creates a new instance of Http class.
+   *
+   * @return {Http}
+   */
+  constructor() {
+    this.#server = fastify()
+  }
+
+  /**
+   * Set the fastify error handler.
+   *
+   * @param {any} handler
+   * @return {Http}
+   */
+  setErrorHandler(handler) {
+    const fastifyErrorHandler = FastifyHandler.createErrorHandler(handler)
+
+    this.#server.setErrorHandler(fastifyErrorHandler)
+
+    return this
+  }
+
+  /**
+   * Register a new fastify plugin.
+   *
+   * @param {import('fastify').FastifyPluginCallback<import('fastify').FastifyPluginOptions>} plugin
+   * @param {import('fastify').FastifyRegisterOptions<import('fastify').FastifyPluginOptions>} [options]
+   * @return {Http}
+   */
+  register(plugin, options) {
+    this.#server.register(plugin, options)
+
+    return this
+  }
+
+  /**
+   * Register the cors plugin to fastify server.
+   *
+   * @param {import('fastify-cors').FastifyCorsOptions} [options]
+   * @return {Http}
+   */
+  registerCors(options) {
+    this.register(fastifyCors, options)
+
+    return this
+  }
+
+  /**
+   * Register the rate limit plugin to fastify server.
+   *
+   * @param {import('fastify-rate-limit').RateLimitPluginOptions} [options]
+   * @return {Http}
+   */
+  registerRateLimit(options) {
+    this.register(fastifyRateLimit, options)
+
+    return this
+  }
+
+  /**
+   * Get the fastify server instance.
+   *
+   * @return {import('fastify').FastifyInstance}
+   */
+  getFastify() {
+    return this.#server
+  }
+
+  /**
+   * Print all routes registered.
+   *
+   * @param {import('fastify').PrintRoutesOptions} [options]
+   * @return {string}
+   */
+  getRoutes(options) {
+    return this.#server.printRoutes(options)
+  }
+
+  /**
+   * Print all routes registered.
+   *
+   * @param {any} handler
+   * @param {'handle'|'intercept'|'terminate'} type
+   * @return void
+   */
+  use(handler, type = 'handle') {
+    let hookName = 'preHandler'
+    let handlerType = 'createDoneHandler'
+
+    switch (type) {
+      case 'intercept':
+        hookName = 'onSend'
+        handlerType = 'createOnSendHandler'
+        break
+      case 'terminate':
+        hookName = 'onResponse'
+        handlerType = 'createOnResponseHandler'
+        break
+    }
+
+    this.#server.addHook(hookName, FastifyHandler[handlerType](handler))
+  }
+
+  /**
+   * Return a request handler to make internal requests to the Http server.
+   *
+   * @param {import('fastify').InjectOptions|string} [options]
+   * @return {import('light-my-request').Chain,Promise<import('light-my-request').Response>}
+   */
+  request(options) {
+    const server = this.getFastify()
+
+    if (!options) {
+      return server.inject()
+    }
+
+    return server.inject(options)
+  }
+
+  /**
+   * Boot the http server to start listening on port and host defined.
+   *
+   * @param {string|number} [port]
+   * @param {string} [host]
+   * @return {Promise<string>}
+   */
+  async listen(port = 1335, host = '0.0.0.0') {
+    return this.#server.listen(port, host)
+  }
+
+  /**
+   * Close the http server.
+   *
+   * @return {Promise<void>}
+   */
+  async close() {
+    return this.#server.close()
+  }
+
+  /**
+   * Add a new route to the http server.
+   *
+   * @param {string} url
+   * @param {string[]} methods
+   * @param {any} handler
+   * @param {any} [middlewares]
+   * @return {void}
+   */
+  route(url, methods, handler, middlewares) {
+    const { handlers, terminators, interceptors } = Options.create(
+      middlewares,
+      {
+        handlers: [],
+        terminators: [],
+        interceptors: [],
+      },
+    )
+
+    this.#server.route({
+      url,
+      method: methods,
+      onResponse: terminators.map(m =>
+        FastifyHandler.createOnResponseHandler(m),
+      ),
+      handler: FastifyHandler.createRequestHandler(handler),
+      preHandler: handlers.map(m => FastifyHandler.createDoneHandler(m)),
+      onSend: interceptors.map(m => FastifyHandler.createOnSendHandler(m)),
+    })
+  }
+
+  /**
+   * Add a new GET route to the http server.
+   *
+   * @param {string} url
+   * @param {any} handler
+   * @param {any} [middlewares]
+   * @return {void}
+   */
+  get(url, handler, middlewares) {
+    this.route(url, ['GET'], handler, middlewares)
+  }
+
+  /**
+   * Add a new HEAD route to the http server.
+   *
+   * @param {string} url
+   * @param {any} handler
+   * @param {any} [middlewares]
+   * @return {void}
+   */
+  head(url, handler, middlewares) {
+    this.route(url, ['HEAD'], handler, middlewares)
+  }
+
+  /**
+   * Add a new POST route to the http server.
+   *
+   * @param {string} url
+   * @param {any} handler
+   * @param {any} [middlewares]
+   * @return {void}
+   */
+  post(url, handler, middlewares) {
+    this.route(url, ['POST'], handler, middlewares)
+  }
+
+  /**
+   * Add a new PUT route to the http server.
+   *
+   * @param {string} url
+   * @param {any} handler
+   * @param {any} [middlewares]
+   * @return {void}
+   */
+  put(url, handler, middlewares) {
+    this.route(url, ['PUT'], handler, middlewares)
+  }
+
+  /**
+   * Add a new PATCH route to the http server.
+   *
+   * @param {string} url
+   * @param {any} handler
+   * @param {any} [middlewares]
+   * @return {void}
+   */
+  patch(url, handler, middlewares) {
+    this.route(url, ['PATCH'], handler, middlewares)
+  }
+
+  /**
+   * Add a new DELETE route to the http server.
+   *
+   * @param {string} url
+   * @param {any} handler
+   * @param {any} [middlewares]
+   * @return {void}
+   */
+  delete(url, handler, middlewares) {
+    this.route(url, ['DELETE'], handler, middlewares)
+  }
+
+  /**
+   * Add a new OPTIONS route to the http server.
+   *
+   * @param {string} url
+   * @param {any} handler
+   * @param {any} [middlewares]
+   * @return {void}
+   */
+  options(url, handler, middlewares) {
+    this.route(url, ['OPTIONS'], handler, middlewares)
+  }
+}

package/index.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.
- */
-export * from './src/Facades/Route';
-export * from './src/Facades/Server';
-export * from './src/Http';
-export * from './src/Router/Router';
-export * from './src/Kernels/HttpKernel';
-export * from './src/Providers/HttpRouteProvider';
-export * from './src/Providers/HttpServerProvider';
-export * from './src/Handlers/HttpExceptionHandler';
-export * from './src/Contracts/MiddlewareContract';
-export * from './src/Contracts/Context/ContextContract';
-export * from './src/Contracts/Context/HandlerContract';
-export * from './src/Contracts/Context/RequestContract';
-export * from './src/Contracts/Context/ResponseContract';
-export * from './src/Contracts/Context/Error/ErrorContextContract';
-export * from './src/Contracts/Context/Error/ErrorHandlerContract';
-export * from './src/Contracts/Context/Middlewares/Handle/HandleContextContract';
-export * from './src/Contracts/Context/Middlewares/Handle/HandleHandlerContract';
-export * from './src/Contracts/Context/Middlewares/Intercept/InterceptContextContract';
-export * from './src/Contracts/Context/Middlewares/Intercept/InterceptHandlerContract';
-export * from './src/Contracts/Context/Middlewares/Terminate/TerminateContextContract';
-export * from './src/Contracts/Context/Middlewares/Terminate/TerminateHandlerContract';

package/index.js

@@ -1,41 +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 __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./src/Facades/Route"), exports);
-__exportStar(require("./src/Facades/Server"), exports);
-__exportStar(require("./src/Http"), exports);
-__exportStar(require("./src/Router/Router"), exports);
-__exportStar(require("./src/Kernels/HttpKernel"), exports);
-__exportStar(require("./src/Providers/HttpRouteProvider"), exports);
-__exportStar(require("./src/Providers/HttpServerProvider"), exports);
-__exportStar(require("./src/Handlers/HttpExceptionHandler"), exports);
-__exportStar(require("./src/Contracts/MiddlewareContract"), exports);
-__exportStar(require("./src/Contracts/Context/ContextContract"), exports);
-__exportStar(require("./src/Contracts/Context/HandlerContract"), exports);
-__exportStar(require("./src/Contracts/Context/RequestContract"), exports);
-__exportStar(require("./src/Contracts/Context/ResponseContract"), exports);
-__exportStar(require("./src/Contracts/Context/Error/ErrorContextContract"), exports);
-__exportStar(require("./src/Contracts/Context/Error/ErrorHandlerContract"), exports);
-__exportStar(require("./src/Contracts/Context/Middlewares/Handle/HandleContextContract"), exports);
-__exportStar(require("./src/Contracts/Context/Middlewares/Handle/HandleHandlerContract"), exports);
-__exportStar(require("./src/Contracts/Context/Middlewares/Intercept/InterceptContextContract"), exports);
-__exportStar(require("./src/Contracts/Context/Middlewares/Intercept/InterceptHandlerContract"), exports);
-__exportStar(require("./src/Contracts/Context/Middlewares/Terminate/TerminateContextContract"), exports);
-__exportStar(require("./src/Contracts/Context/Middlewares/Terminate/TerminateHandlerContract"), exports);

package/src/Context/Request.d.ts

@@ -1,103 +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 { FastifyRequest } from 'fastify';
-import { RequestContract } from '../Contracts/Context/RequestContract';
-export declare class Request implements RequestContract {
-    private readonly request;
-    /**
-     * Create a new instance of Request.
-     *
-     * @return Request
-     */
-    constructor(request: FastifyRequest);
-    /**
-     * Get the request ip.
-     *
-     * @return string
-     */
-    get ip(): string;
-    /**
-     * Get the request method.
-     *
-     * @return string
-     */
-    get method(): string;
-    /**
-     * Get the host url from request.
-     *
-     * @return string
-     */
-    get hostUrl(): string;
-    /**
-     * Get the base request url.
-     *
-     * @return string
-     */
-    get baseUrl(): string;
-    /**
-     * Get the original request url.
-     *
-     * @return string
-     */
-    get originalUrl(): string;
-    /**
-     * Get all body from request.
-     *
-     * @return any
-     */
-    get body(): any;
-    /**
-     * Get all params from request.
-     *
-     * @return any
-     */
-    get params(): any;
-    /**
-     * Get all queries from request.
-     *
-     * @return any
-     */
-    get queries(): any;
-    /**
-     * Get all headers from request.
-     *
-     * @return any
-     */
-    get headers(): any;
-    /**
-     * Get a value from the request params or the default value.
-     *
-     * @return any
-     */
-    param(param: string, defaultValue?: string): any;
-    /**
-     * Get a value from the request query param or the default value.
-     *
-     * @return any
-     */
-    query(query: string, defaultValue?: string): any;
-    /**
-     * Get a value from the request header or the default value.
-     *
-     * @return any
-     */
-    header(header: string, defaultValue?: string): any;
-    /**
-     * Get a value from the request body or the default value.
-     *
-     * @return any
-     */
-    payload(payload: string, defaultValue?: string): any;
-    /**
-     * Get the default fastify request object.
-     *
-     * @return FastifyRequest
-     */
-    getFastifyRequest(): FastifyRequest;
-}

package/src/Context/Response.d.ts

@@ -1,77 +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 { FastifyReply } from 'fastify';
-import { ResponseContract } from '../Contracts/Context/ResponseContract';
-export declare class Response implements ResponseContract {
-    private readonly response;
-    /**
-     * Create a new instance of Response.
-     *
-     * @return Response
-     */
-    constructor(response: FastifyReply);
-    /**
-     * Terminate the request sending the response body.
-     *
-     * @param data
-     * @return void
-     */
-    send(data?: any): void;
-    /**
-     * Terminate the request sending the response body.
-     *
-     * @param data
-     * @return void
-     */
-    json(data?: any): void;
-    /**
-     * Set the response status code.
-     *
-     * @param code
-     * @return Response
-     */
-    status(code: number): this;
-    /**
-     * Remove some header from the response.
-     *
-     * @param header
-     * @return Response
-     */
-    removeHeader(header: string): this;
-    /**
-     * Add some header to the response.
-     *
-     * @param header
-     * @param value
-     * @return Response
-     */
-    header(header: string, value: any): this;
-    /**
-     * Only add some header to the response if it's not defined yet.
-     *
-     * @param header
-     * @param value
-     * @return Response
-     */
-    safeHeader(header: string, value: any): this;
-    /**
-     * Redirect the response to other url with different status code.
-     *
-     * @param url
-     * @param statusCode
-     * @return void
-     */
-    redirectTo(url: string, statusCode?: number): void;
-    /**
-     * Get the default fastify response object.
-     *
-     * @return FastifyReply
-     */
-    getFastifyResponse(): FastifyReply;
-}

package/src/Contracts/Context/ContextContract.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 { RequestContract } from './RequestContract';
-import { ResponseContract } from './ResponseContract';
-export interface ContextContract {
-    request: RequestContract;
-    response: ResponseContract;
-    data: any;
-    params: any;
-    queries: any;
-}

package/src/Contracts/Context/ContextContract.js

@@ -1,10 +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 });

package/src/Contracts/Context/Error/ErrorContextContract.d.ts

@@ -1,18 +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 { RequestContract } from '../RequestContract';
-import { ResponseContract } from '../ResponseContract';
-export interface ErrorContextContract {
-    request: RequestContract;
-    response: ResponseContract;
-    params: any;
-    queries: any;
-    data: any;
-    error: any;
-}

package/src/Contracts/Context/Error/ErrorContextContract.js

@@ -1,10 +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 });

package/src/Contracts/Context/Error/ErrorHandlerContract.d.ts

@@ -1,12 +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 { ErrorContextContract } from './ErrorContextContract';
-export interface ErrorHandlerContract {
-    (ctx?: ErrorContextContract): Promise<any> | any;
-}

package/src/Contracts/Context/Error/ErrorHandlerContract.js

@@ -1,10 +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 });

package/src/Contracts/Context/HandlerContract.d.ts

@@ -1,12 +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 { ContextContract } from './ContextContract';
-export interface HandlerContract {
-    (ctx: ContextContract): Promise<any> | any;
-}

package/src/Contracts/Context/HandlerContract.js

@@ -1,10 +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 });

package/src/Contracts/Context/Middlewares/Handle/HandleContextContract.d.ts

@@ -1,19 +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 { NextContract } from '../../NextContract';
-import { RequestContract } from '../../RequestContract';
-import { ResponseContract } from '../../ResponseContract';
-export interface HandleContextContract {
-    request: RequestContract;
-    response: ResponseContract;
-    data: any;
-    params: any;
-    queries: any;
-    next: NextContract;
-}

package/src/Contracts/Context/Middlewares/Handle/HandleContextContract.js

@@ -1,10 +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 });

package/src/Contracts/Context/Middlewares/Handle/HandleHandlerContract.d.ts

@@ -1,12 +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 { HandleContextContract } from './HandleContextContract';
-export interface HandleHandlerContract {
-    (ctx: HandleContextContract): Promise<any> | any;
-}