@athenna/http 1.8.0 → 1.8.2

package/package.json

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

package/src/Context/Request.js

@@ -7,8 +7,8 @@
  * file that was distributed with this source code.
  */
 
-import { Is } from '@athenna/common'
 import { Config } from '@athenna/config'
+import { Is, Json } from '@athenna/common'
 
 export class Request {
   /**
@@ -149,15 +149,66 @@ export class Request {
     return this.headers[header] || defaultValue
   }
 
+  /**
+   * Get only the selected values from the request body.
+   *
+   * @param {string} keys
+   * @return {any}
+   */
+  only(...keys) {
+    const body = {}
+
+    Object.keys(this.body).forEach(key => {
+      if (!keys.includes(key)) {
+        return
+      }
+
+      body[key] = this.body[key]
+    })
+
+    return body
+  }
+
+  /**
+   * Get all the values from the request body except the selected ones.
+   *
+   * @param {string[]} keys
+   * @return {any}
+   */
+  except(...keys) {
+    const body = {}
+
+    Object.keys(this.body).forEach(key => {
+      if (keys.includes(key)) {
+        return
+      }
+
+      body[key] = this.body[key]
+    })
+
+    return body
+  }
+
+  /**
+   * Get a value from the request body or the default value.
+   *
+   * @param {string} key
+   * @param {string} [defaultValue]
+   * @return {any}
+   */
+  input(key, defaultValue) {
+    return this.payload(key, defaultValue)
+  }
+
   /**
    * Get a value from the request body or the default value.
    *
-   * @param {string} payload
+   * @param {string} key
    * @param {string} [defaultValue]
    * @return {any}
    */
-  payload(payload, defaultValue) {
-    return this.body[payload] || defaultValue
+  payload(key, defaultValue) {
+    return Json.get(this.body, key, defaultValue)
   }
 
   /**

package/src/Context/Response.js

@@ -119,6 +119,8 @@ export class Response {
   redirectTo(url, statusCode) {
     if (statusCode) {
       this.#response.redirect(statusCode, url)
+
+      return
     }
 
     this.#response.redirect(url)

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

@@ -8,10 +8,11 @@
  */
 
 import { Facade } from '@athenna/ioc'
-import { Exception } from '@athenna/common'
+import { Exception, Json } 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 {
@@ -850,14 +884,42 @@ export interface RequestContract {
    */
   header(header, defaultValue): any
 
+  /**
+   * Get only the selected values from the request body.
+   *
+   * @param {string} keys
+   * @return {any}
+   */
+  only(...keys: string[]): any
+  only(keys: string[]): any
+
+  /**
+   * Get all the values from the request body except the selected ones.
+   *
+   * @param {string[]} keys
+   * @return {any}
+   */
+  except(...keys: string[]): any
+  except(keys: string): any
+
   /**
    * Get a value from the request body or the default value.
    *
-   * @param {string} payload
-   * @param {string} [defaultValue]
+   * @param {string} key
+   * @param {any} [defaultValue]
+   * @return {any}
+   */
+  input(key: string, defaultValue?: any): any
+
+  /**
+   * Get a value from the request body or the default value.
+   *
+   * @param {string} key
+   * @param {any} [defaultValue]
    * @return {any}
    */
-  payload(payload, defaultValue): any
+  payload(key: string, defaultValue?: any): any
+
   /**
    * Get the default fastify request object.
    *
@@ -928,19 +990,10 @@ export interface ResponseContract {
   /**
    * Redirect the response to other url with different status code.
    *
-   * @param {string} url
    * @return {void}
    */
   redirectTo(url: string): Promise<void> | void
-
-  /**
-   * Redirect the response to other url with different status code.
-   *
-   * @param {string} url
-   * @param {number} statusCode
-   * @return {void}
-   */
-  redirectTo(url: string, statusCode: number): Promise<void>
+  redirectTo(url: string, statusCode: number): Promise<void> | void
 
   /**
    * Get the default fastify response object.