@athenna/http 5.40.0 → 5.41.0

package/package.json

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

package/src/router/Route.d.ts

@@ -15,6 +15,7 @@ export declare class Route extends Macroable {
      */
     route: {
         url?: string;
+        data?: Record<string, any>;
         methods: HTTPMethods[];
         handler?: RequestHandler;
         name?: string;
@@ -42,6 +43,19 @@ export declare class Route extends Macroable {
      * ```
      */
     vanillaOptions(options: Partial<RouteOptions>): Route;
+    /**
+     * Define data values for the route. Data values will be available in the
+     * request context.
+     *
+     * @example
+     * ```ts
+     * Route.data({ permission: 'post:create' }).post('/posts', ({ data }) => {
+     *  console.log(data.permission)
+     * })
+     * ```
+     *
+     */
+    data(data: Record<string, any> | string, value?: any): Route;
     /**
      * Set a prefix for the route.
      *

package/src/router/Route.js

@@ -16,6 +16,7 @@ export class Route extends Macroable {
         this.route = {
             url,
             methods,
+            data: {},
             deleted: false,
             prefixes: [],
             middlewares: {
@@ -74,6 +75,26 @@ export class Route extends Macroable {
         };
         return this;
     }
+    /**
+     * Define data values for the route. Data values will be available in the
+     * request context.
+     *
+     * @example
+     * ```ts
+     * Route.data({ permission: 'post:create' }).post('/posts', ({ data }) => {
+     *  console.log(data.permission)
+     * })
+     * ```
+     *
+     */
+    data(data, value) {
+        if (Is.String(data)) {
+            this.route.data[data] = value;
+            return this;
+        }
+        this.route.data = data;
+        return this;
+    }
     /**
      * Set a prefix for the route.
      *
@@ -468,6 +489,7 @@ export class Route extends Macroable {
     toJSON() {
         return {
             url: this.getUrl(),
+            data: this.route.data,
             methods: this.route.methods,
             name: this.route.name,
             deleted: this.route.deleted,

package/src/server/ServerImpl.js

@@ -7,7 +7,7 @@
  * file that was distributed with this source code.
  */
 import fastify from 'fastify';
-import { Options, Macroable } from '@athenna/common';
+import { Options, Macroable, Is } from '@athenna/common';
 import { FastifyHandler } from '#src/handlers/FastifyHandler';
 export class ServerImpl extends Macroable {
     constructor(options) {
@@ -188,6 +188,9 @@ export class ServerImpl extends Macroable {
         }
         const { middlewares, interceptors, terminators } = options.middlewares;
         const route = {
+            onSend: [],
+            preHandler: [],
+            onResponse: [],
             url: options.url,
             method: options.methods,
             handler: FastifyHandler.request(options.handler)
@@ -201,6 +204,12 @@ export class ServerImpl extends Macroable {
         if (terminators.length) {
             route.onResponse = terminators.map(t => FastifyHandler.terminate(t));
         }
+        if (options.data && Is.Array(route.preHandler)) {
+            route.preHandler?.unshift((req, _, done) => {
+                req.data = options.data;
+                done();
+            });
+        }
         this.fastify.route({ ...route, ...options.fastify });
     }
     /**

package/src/types/router/RouteJson.d.ts

@@ -10,6 +10,7 @@ import type { HTTPMethods, RouteOptions } from 'fastify';
 import type { RequestHandler, MiddlewareRecord } from '#src/types';
 export type RouteJson = {
     url: string;
+    data?: Record<string, any>;
     methods?: HTTPMethods[];
     name?: string;
     deleted?: boolean;