@athenna/http 4.31.0 → 4.32.0

package/package.json

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

package/src/commands/RouteListCommand.js

@@ -36,7 +36,7 @@ export class RouteListCommand extends BaseCommand {
             table.row([
                 route.methods.map(m => this.paintMethod(m)).join('|'),
                 route.url,
-                route.name || 'Not found',
+                route.name || 'Not defined',
                 route.handler.name || 'closure'
             ]);
         });

package/src/context/Request.d.ts

@@ -76,6 +76,15 @@ export declare class Request {
      * ```
      */
     get method(): string;
+    /**
+     * Get the route name defined in your route file.
+     *
+     * @example
+     * ```ts
+     * console.log(request.routeName) // 'users'
+     * ```
+     */
+    get routeName(): string;
     /**
      * Get the base url from request.
      *

package/src/context/Request.js

@@ -88,6 +88,19 @@ export class Request {
     get method() {
         return this.request.method;
     }
+    /**
+     * Get the route name defined in your route file.
+     *
+     * @example
+     * ```ts
+     * console.log(request.routeName) // 'users'
+     * ```
+     */
+    get routeName() {
+        // eslint-disable-next-line
+        // @ts-ignore
+        return this.request.routeOptions.config.name;
+    }
     /**
      * Get the base url from request.
      *

package/src/router/Route.js

@@ -21,7 +21,7 @@ export class Route {
                 terminators: [],
                 interceptors: []
             },
-            fastify: { schema: {} }
+            fastify: { schema: {}, config: {} }
         };
         if (Is.String(handler)) {
             const [controller, method] = handler.split('.');
@@ -52,6 +52,9 @@ export class Route {
      */
     name(name) {
         this.route.name = name;
+        // eslint-disable-next-line
+        // @ts-ignore
+        this.route.fastify.config.name = name;
         return this;
     }
     /**
@@ -201,9 +204,6 @@ export class Route {
      * ```
      */
     rateLimit(options) {
-        if (!this.route.fastify.config) {
-            this.route.fastify.config = {};
-        }
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
         this.route.fastify.config.rateLimit = options;

package/src/router/RouteGroup.d.ts

@@ -16,7 +16,7 @@ export declare class RouteGroup {
     routes: (Route | RouteGroup | RouteResource)[];
     constructor(routes: (Route | RouteGroup | RouteResource)[]);
     /**
-     * Define prefix all the routes in the group.
+     * Define prefix for all the routes in the group.
      *
      * @example
      * ```ts
@@ -26,6 +26,17 @@ export declare class RouteGroup {
      * ```
      */
     prefix(prefix: string): RouteGroup;
+    /**
+     * Define a name for all the routes in the group.
+     *
+     * @example
+     * ```ts
+     * Route.group(() => {
+     *
+     * }).name('users')
+     * ```
+     */
+    name(name: string): RouteGroup;
     /**
      * Add a middleware to all routes in the group.
      *

package/src/router/RouteGroup.js

@@ -13,7 +13,7 @@ export class RouteGroup {
         this.routes = routes;
     }
     /**
-     * Define prefix all the routes in the group.
+     * Define prefix for all the routes in the group.
      *
      * @example
      * ```ts
@@ -26,6 +26,20 @@ export class RouteGroup {
         this.routes.forEach(route => this.invoke(route, 'prefix', [prefix]));
         return this;
     }
+    /**
+     * Define a name for all the routes in the group.
+     *
+     * @example
+     * ```ts
+     * Route.group(() => {
+     *
+     * }).name('users')
+     * ```
+     */
+    name(name) {
+        this.routes.forEach(route => this.invoke(route, 'name', [name]));
+        return this;
+    }
     /**
      * Add a middleware to all routes in the group.
      *