deco-express 0.1.6 → 0.2.0

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { Express, RequestHandler } from 'express';
+import { RequestHandler, Express } from 'express';
 import Joi from 'joi';
 
 /**
@@ -34,19 +34,24 @@ declare function Route(method: keyof Express, path?: string, ...middleware: Requ
  * and is prepended to every route path registered by {@link Route} decorators
  * on the class's methods.
  *
+ * Controller-level middleware is stored under the `"controllerMiddleware"` key
+ * and is prepended to every route handler in the controller.
+ *
  * @param baseRoute - The base path prefix for all routes in the controller
  *   (e.g. `"/users"`). Defaults to `""` (no prefix).
+ * @param middleware - Zero or more Express middleware functions that are
+ *   executed **before** every route handler in the controller.
  *
  * @example
  * ```ts
- * \@Controller('/users')
+ * \@Controller('/users', authMiddleware)
  * class UserController {
  *   \@Route('get', '/:id')
  *   getUser(req: Request, res: Response) { ... }
  * }
  * ```
  */
-declare function Controller(baseRoute?: string): (target: object) => void;
+declare function Controller(baseRoute?: string, ...middleware: RequestHandler[]): (target: object) => void;
 
 /**
  * Method decorator that validates `req.body` against a Joi schema before the
@@ -91,8 +96,10 @@ type Constructor<T = object> = new (...args: unknown[]) => T;
  * For each controller the function:
  * 1. Instantiates the class with `new`.
  * 2. Reads the `"baseRoute"` metadata set by {@link Controller}.
- * 3. Reads the `"routeHandlers"` metadata set by {@link Route}.
- * 4. Mounts each handler at the resolved full path on the Express app.
+ * 3. Reads the `"controllerMiddleware"` metadata set by {@link Controller}.
+ * 4. Reads the `"routeHandlers"` metadata set by {@link Route}.
+ * 5. Mounts each handler at the resolved full path on the Express app,
+ *    with controller-level middleware prepended to each route's handlers.
  *
  * The full path is built as:
  * ```
@@ -105,6 +112,8 @@ type Constructor<T = object> = new (...args: unknown[]) => T;
  * @param version - API version number. When `addApi` is `true` and `version`
  *   is non-zero, a `/v{version}` segment is inserted after `/api`.
  *   Defaults to `1`.
+ * @param log - When `true`, prints each registered route to the console.
+ *   Defaults to `false`.
  *
  * @example
  * ```ts
@@ -113,11 +122,11 @@ type Constructor<T = object> = new (...args: unknown[]) => T;
  * import { UserController } from './controllers/user';
  *
  * const app = express();
- * defineRoutes([UserController], app);
- * // Routes are now available at /api/v1/...
+ * defineRoutes([UserController], app, true, 1, true);
+ * // [deco-express] GET /api/v1/users/:id
  * ```
  */
-declare function defineRoutes(controllers: Constructor[], application: Express, addApi?: boolean, version?: number): void;
+declare function defineRoutes(controllers: Constructor[], application: Express, addApi?: boolean, version?: number, log?: boolean): void;
 
 /**
  * A nested map that stores route handlers organised by HTTP method and path.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Express, RequestHandler } from 'express';
+import { RequestHandler, Express } from 'express';
 import Joi from 'joi';
 
 /**
@@ -34,19 +34,24 @@ declare function Route(method: keyof Express, path?: string, ...middleware: Requ
  * and is prepended to every route path registered by {@link Route} decorators
  * on the class's methods.
  *
+ * Controller-level middleware is stored under the `"controllerMiddleware"` key
+ * and is prepended to every route handler in the controller.
+ *
  * @param baseRoute - The base path prefix for all routes in the controller
  *   (e.g. `"/users"`). Defaults to `""` (no prefix).
+ * @param middleware - Zero or more Express middleware functions that are
+ *   executed **before** every route handler in the controller.
  *
  * @example
  * ```ts
- * \@Controller('/users')
+ * \@Controller('/users', authMiddleware)
  * class UserController {
  *   \@Route('get', '/:id')
  *   getUser(req: Request, res: Response) { ... }
  * }
  * ```
  */
-declare function Controller(baseRoute?: string): (target: object) => void;
+declare function Controller(baseRoute?: string, ...middleware: RequestHandler[]): (target: object) => void;
 
 /**
  * Method decorator that validates `req.body` against a Joi schema before the
@@ -91,8 +96,10 @@ type Constructor<T = object> = new (...args: unknown[]) => T;
  * For each controller the function:
  * 1. Instantiates the class with `new`.
  * 2. Reads the `"baseRoute"` metadata set by {@link Controller}.
- * 3. Reads the `"routeHandlers"` metadata set by {@link Route}.
- * 4. Mounts each handler at the resolved full path on the Express app.
+ * 3. Reads the `"controllerMiddleware"` metadata set by {@link Controller}.
+ * 4. Reads the `"routeHandlers"` metadata set by {@link Route}.
+ * 5. Mounts each handler at the resolved full path on the Express app,
+ *    with controller-level middleware prepended to each route's handlers.
  *
  * The full path is built as:
  * ```
@@ -105,6 +112,8 @@ type Constructor<T = object> = new (...args: unknown[]) => T;
  * @param version - API version number. When `addApi` is `true` and `version`
  *   is non-zero, a `/v{version}` segment is inserted after `/api`.
  *   Defaults to `1`.
+ * @param log - When `true`, prints each registered route to the console.
+ *   Defaults to `false`.
  *
  * @example
  * ```ts
@@ -113,11 +122,11 @@ type Constructor<T = object> = new (...args: unknown[]) => T;
  * import { UserController } from './controllers/user';
  *
  * const app = express();
- * defineRoutes([UserController], app);
- * // Routes are now available at /api/v1/...
+ * defineRoutes([UserController], app, true, 1, true);
+ * // [deco-express] GET /api/v1/users/:id
  * ```
  */
-declare function defineRoutes(controllers: Constructor[], application: Express, addApi?: boolean, version?: number): void;
+declare function defineRoutes(controllers: Constructor[], application: Express, addApi?: boolean, version?: number, log?: boolean): void;
 
 /**
  * A nested map that stores route handlers organised by HTTP method and path.

package/dist/index.js

@@ -41,9 +41,10 @@ function Route(method, path = "", ...middleware) {
   };
 }
 __name(Route, "Route");
-function Controller(baseRoute = "") {
+function Controller(baseRoute = "", ...middleware) {
   return (target) => {
     Reflect.defineMetadata("baseRoute", baseRoute, target);
+    Reflect.defineMetadata("controllerMiddleware", middleware, target);
   };
 }
 __name(Controller, "Controller");
@@ -66,7 +67,7 @@ function Validate(schema) {
 __name(Validate, "Validate");
 
 // src/functions/routes.ts
-function defineRoutes(controllers, application, addApi = true, version = 1) {
+function defineRoutes(controllers, application, addApi = true, version = 1, log = false) {
   for (const ControllerClass of controllers) {
     const controller = new ControllerClass();
     const routeHandlers = Reflect.getMetadata(
@@ -74,12 +75,14 @@ function defineRoutes(controllers, application, addApi = true, version = 1) {
       controller
     );
     const controllerPath = Reflect.getMetadata("baseRoute", controller.constructor) ?? "";
+    const controllerMiddleware = Reflect.getMetadata("controllerMiddleware", controller.constructor) ?? [];
     if (!routeHandlers) continue;
     for (const [method, routes] of routeHandlers) {
       for (const [routePath, handlers] of routes) {
         const versionSegment = addApi && version ? `/v${version}` : "";
         const fullPath = `${addApi ? "/api" : ""}${versionSegment}${controllerPath}${routePath}`;
-        application[method](fullPath, handlers);
+        application[method](fullPath, [...controllerMiddleware, ...handlers]);
+        if (log) console.log(`[deco-express] ${method.toUpperCase()} ${fullPath}`);
       }
     }
   }

package/dist/index.mjs

@@ -16,9 +16,10 @@ function Route(method, path = "", ...middleware) {
   };
 }
 __name(Route, "Route");
-function Controller(baseRoute = "") {
+function Controller(baseRoute = "", ...middleware) {
   return (target) => {
     Reflect.defineMetadata("baseRoute", baseRoute, target);
+    Reflect.defineMetadata("controllerMiddleware", middleware, target);
   };
 }
 __name(Controller, "Controller");
@@ -41,7 +42,7 @@ function Validate(schema) {
 __name(Validate, "Validate");
 
 // src/functions/routes.ts
-function defineRoutes(controllers, application, addApi = true, version = 1) {
+function defineRoutes(controllers, application, addApi = true, version = 1, log = false) {
   for (const ControllerClass of controllers) {
     const controller = new ControllerClass();
     const routeHandlers = Reflect.getMetadata(
@@ -49,12 +50,14 @@ function defineRoutes(controllers, application, addApi = true, version = 1) {
       controller
     );
     const controllerPath = Reflect.getMetadata("baseRoute", controller.constructor) ?? "";
+    const controllerMiddleware = Reflect.getMetadata("controllerMiddleware", controller.constructor) ?? [];
     if (!routeHandlers) continue;
     for (const [method, routes] of routeHandlers) {
       for (const [routePath, handlers] of routes) {
         const versionSegment = addApi && version ? `/v${version}` : "";
         const fullPath = `${addApi ? "/api" : ""}${versionSegment}${controllerPath}${routePath}`;
-        application[method](fullPath, handlers);
+        application[method](fullPath, [...controllerMiddleware, ...handlers]);
+        if (log) console.log(`[deco-express] ${method.toUpperCase()} ${fullPath}`);
       }
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "deco-express",
-    "version": "0.1.6",
+    "version": "0.2.0",
     "author": "ndrolp",
     "description": "Decorator-based utilities for building Express.js REST APIs in TypeScript",
     "main": "./dist/index.js",