feat(validation): added model-state-validation to the template

package.json

@@ -17,7 +17,8 @@
     "mysql2": "^3.5.2",
     "reflect-metadata": "^0.1.13",
     "sequelize": "^6.32.1",
-    "sequelize-typescript": "^2.1.5"
+    "sequelize-typescript": "^2.1.5",
+    "zod": "^3.21.4"
   },
   "devDependencies": {
     "@types/dotenv": "^8.2.0",

src/Dtos/HelloWorldDto.ts

@@ -0,0 +1,14 @@
+import { z } from "zod";
+
+export type HelloWorldDto = {
+  name: string;
+};
+
+export const helloWorldDTOSchema = z.object({
+  body: z.object({
+    name: z.string({
+      required_error: "Name is required",
+      description: "Name of the world",
+    }),
+  }),
+});

src/Dtos/index.ts

@@ -0,0 +1 @@
+export * from "./HelloWorldDto";

src/controllers/helloWorld.ts

@@ -1,8 +1,17 @@
 import { Request, Response } from "express";
+import { HelloWorldDto } from "../Dtos";
 
 // Placeholder code for this template
 const get = async (_: Request, res: Response): Promise<void> => {
   res.status(200).send("Hello World");
 };
 
-export const helloWorld = { get };
+const create = async (
+  req: Request<any, any, HelloWorldDto>,
+  res: Response
+): Promise<void> => {
+  const { name } = req.body;
+  res.send(`Hello ${name}`);
+};
+
+export const helloWorld = { get, create };

src/enums/ServerCode.ts

@@ -0,0 +1,11 @@
+export enum ServerCode {
+    Ok = 200,
+    Created = 201,
+    Unauthorized = 401,
+    Forbidden = 403,
+    NotFound = 404,
+    BadRequest = 400,
+    Conflict = 409,
+    InternalServerError = 500,
+  }
+

src/enums/index.ts

@@ -0,0 +1 @@
+export * from './ServerCode';

src/index.ts

@@ -1,11 +1,13 @@
 import express, { Express } from "express";
+import bodyParser from "body-parser";
 import "./config/env";
 import { DBConnection } from "./config/database";
 import { routes } from "./routes";
 
 const app: Express = express();
 const port = process.env.PORT;
 
+app.use(bodyParser.json());
 app.use("/v1", routes);
 
 const start = async (): Promise<void> => {

src/middleware/index.ts

@@ -0,0 +1 @@
+export * from './modelValidation';

src/middleware/modelValidation.ts

@@ -0,0 +1,22 @@
+import { Request, Response, NextFunction } from "express";
+import { AnyZodObject } from "zod";
+import { ServerCode } from "../enums/ServerCode";
+
+// Middleware to validate the request body, query and params against a schema
+const validateModel =
+  (schema: AnyZodObject) =>
+  async (req: Request, res: Response, next: NextFunction): Promise<void> => {
+    try {
+      await schema.parseAsync({
+        body: req.body,
+        query: req.query,
+        params: req.params,
+      });
+      return next();
+    } catch (error) {
+      res.status(ServerCode.BadRequest).json(error);
+      return;
+    }
+  };
+
+export { validateModel };

src/routes/helloWorldRouter.ts

@@ -1,8 +1,15 @@
 import express from "express";
 import { helloWorld } from "../controllers/helloWorld";
+import { validateModel } from "../middleware";
+import { helloWorldDTOSchema } from "../Dtos";
 
 const helloWorldRouter = express.Router();
 
 helloWorldRouter.get("/", helloWorld.get);
+helloWorldRouter.post(
+  "/create",
+  validateModel(helloWorldDTOSchema),
+  helloWorld.create
+);
 
 export { helloWorldRouter };

yarn.lock

@@ -1267,3 +1267,8 @@ yn@3.1.1:
   version "3.1.1"
   resolved "https://registry.yarnpkg.com/yn/-/yn-3.1.1.tgz#1e87401a09d767c1d5eab26a6e4c185182d2eb50"
   integrity sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==
+
+zod@^3.21.4:
+  version "3.21.4"
+  resolved "https://registry.yarnpkg.com/zod/-/zod-3.21.4.tgz#10882231d992519f0a10b5dd58a38c9dabbb64db"
+  integrity sha512-m46AKbrzKVzOzs/DZgVnG5H55N1sv1M8qZU3A8RIKbs3mrACDNeIOeilDymVb2HdmP8uwshOCF4uJ8uM9rCqJw==