@athenna/http 1.7.9 → 1.8.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "1.7.9",
+  "version": "1.8.1",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",

package/src/Handlers/FastifyHandler.js

@@ -25,25 +25,27 @@ export class FastifyHandler {
 
       if (!req.data) req.data = {}
 
-      let body = payload
+      const isJson = Is.Json(payload)
 
-      if (Is.Json(payload)) {
-        body = JSON.parse(body)
+      if (isJson) {
+        payload = JSON.parse(payload)
       }
 
-      body = await handler({
+      payload = await handler({
         request,
         response,
-        body,
+        body: payload,
         status: res.statusCode,
         params: req.params,
         queries: req.query,
         data: req.data,
       })
 
-      if (Is.Object(body)) body = JSON.stringify(body)
+      if (isJson) {
+        payload = JSON.stringify(payload)
+      }
 
-      return body
+      return payload
     }
   }
 

package/src/Router/Route.js

@@ -76,6 +76,13 @@ export class Route {
    */
   #swaggerOptions
 
+  /**
+   * Rate limit options of this route.
+   *
+   * @type {any}
+   */
+  #rateLimitOptions
+
   /**
    * Creates a new instance of Route.
    *
@@ -95,6 +102,7 @@ export class Route {
 
     this.#helmetOptions = {}
     this.#swaggerOptions = {}
+    this.#rateLimitOptions = {}
 
     RouteHelper.getParamsName(url).forEach(param => this.param(param))
 
@@ -221,6 +229,25 @@ export class Route {
     return this
   }
 
+  /**
+   * Set up all rate limit options for route.
+   *
+   * @param {any} options
+   * @param {boolean} [override]
+   * @return {Route}
+   */
+  rateLimit(options, override = true) {
+    if (!override) {
+      this.#rateLimitOptions = Options.create(this.#rateLimitOptions, options)
+
+      return this
+    }
+
+    this.#rateLimitOptions = options
+
+    return this
+  }
+
   /**
    * Set a summary for the route swagger docs.
    *
@@ -351,6 +378,7 @@ export class Route {
       middlewares: this.#routeMiddlewares,
       helmetOptions: this.#helmetOptions,
       swaggerOptions: this.#swaggerOptions,
+      rateLimitOptions: this.#rateLimitOptions,
     }
 
     if (Is.String(this.#handler)) {

package/src/Router/RouteGroup.js

@@ -82,6 +82,20 @@ export class RouteGroup {
     return this
   }
 
+  /**
+   * Set up rate limit options for route group.
+   *
+   * @param {any} options
+   * @return {RouteGroup}
+   */
+  rateLimit(options) {
+    this.routes.forEach(route => {
+      this.#invoke(route, 'rateLimit', [options, false])
+    })
+
+    return this
+  }
+
   /**
    * Invoke a method from route.
    *

package/src/Router/RouteResource.js

@@ -106,7 +106,7 @@ export class RouteResource {
    */
   helmet(action, options) {
     if (!options) {
-      this.routes.forEach(route => route.helmet(options))
+      this.routes.forEach(route => route.helmet(action))
 
       return this
     }
@@ -133,7 +133,7 @@ export class RouteResource {
    */
   swagger(action, options) {
     if (!options) {
-      this.routes.forEach(route => route.swagger(options))
+      this.routes.forEach(route => route.swagger(action))
 
       return this
     }
@@ -151,6 +151,33 @@ export class RouteResource {
     return this
   }
 
+  /**
+   * Set up rate limit options for route resource method.
+   *
+   * @param {string|any} action
+   * @param {any} [options]
+   * @return {RouteResource}
+   */
+  rateLimit(action, options) {
+    if (!options) {
+      this.routes.forEach(route => route.rateLimit(action))
+
+      return this
+    }
+
+    const resourceName = `${this.#resourceName}.${action}`
+
+    this.routes.forEach(route => {
+      if (route.name !== resourceName) {
+        return
+      }
+
+      route.rateLimit(options)
+    })
+
+    return this
+  }
+
   /**
    * Create the route.
    *

package/src/Router/Router.js

@@ -270,6 +270,7 @@ export class Router {
           {
             helmet: route.helmetOptions,
             schema: route.swaggerOptions,
+            config: { rateLimit: route.rateLimitOptions },
           },
         )
       })

package/src/index.d.ts

@@ -12,6 +12,7 @@ import { Exception } from '@athenna/common'
 import { OpenAPIV2, OpenAPIV3 } from 'openapi-types'
 import { FastifyHelmetOptions } from '@fastify/helmet'
 import { FastifyReply, FastifyRequest, RouteOptions } from 'fastify'
+import { RateLimitOptions } from '@fastify/rate-limit'
 
 export const Server: Facade & Http
 export const Route: Facade & Router.Router
@@ -390,6 +391,14 @@ declare module Router {
      */
     swagger(options: FastifySwaggerSchema): this
 
+    /**
+     * Set up all rate limit options for route.
+     *
+     * @param {any} options
+     * @return {Route}
+     */
+    rateLimit(options: RateLimitOptions): this
+
     /**
      * Set a summary for the route swagger docs.
      *
@@ -550,6 +559,23 @@ declare module Router {
      * @return {RouteResource}
      */
     swagger(action: string, options: FastifySwaggerSchema): this
+
+    /**
+     * Set up rate limit options for route resource method.
+     *
+     * @param {RateLimitOptions} options
+     * @return {RouteResource}
+     */
+    rateLimit(options: RateLimitOptions): this
+
+    /**
+     * Set up rate limit options for route resource method.
+     *
+     * @param {string} action
+     * @param {RateLimitOptions} options
+     * @return {RouteResource}
+     */
+    rateLimit(action: string, options: RateLimitOptions): this
   }
 
   export class RouteGroup {
@@ -604,6 +630,14 @@ declare module Router {
      * @return {RouteGroup}
      */
     swagger(options: FastifySwaggerSchema): this
+
+    /**
+     * Set up rate limit options for route group.
+     *
+     * @param {any} options
+     * @return {RouteGroup}
+     */
+    rateLimit(options: RateLimitOptions): this
   }
 
   export class Router {