كيفية التحقق من مدخلات API في Node.js باستخدام Zod

npm install zod

// src/schemas/user.schema.ts (أو .js)
import { z } from "zod"

export const createUserSchema = z.object({
  name: z.string().min(2).max(100).trim(),
  email: z.string().email().toLowerCase(),
  age: z.number().int().min(18).max(120),
  role: z.enum(["admin", "user"]).default("user"),
})

// TypeScript: استنتج النوع — لا حاجة لـ interface منفصل
export type CreateUserInput = z.infer<typeof createUserSchema>
// { name: string; email: string; age: number; role: "admin" | "user" }

// src/controllers/usersController.ts
import { createUserSchema } from "../schemas/user.schema"

export const create = (req: Request, res: Response) => {
  const result = createUserSchema.safeParse(req.body)

  if (!result.success) {
    return res.status(422).json({
      error: "Validation failed",
      issues: result.error.issues.map((issue) => ({
        field: issue.path.join("."),
        message: issue.message,
      })),
    })
  }

  // result.data مكتوب بأنواع كاملة وآمن للاستخدام
  const { name, email, age, role } = result.data
  // ... احفظ في قاعدة البيانات
  res.status(201).json({ name, email, age, role })
}

// مثال على body الاستجابة عند فشل التحقق
// POST /api/users  {"name":"A","email":"not-an-email","age":15}
{
  "error": "Validation failed",
  "issues": [
    {
      "field": "name",
      "message": "String must contain at least 2 character(s)"
    },
    {
      "field": "email",
      "message": "Invalid email"
    },
    {
      "field": "age",
      "message": "Number must be greater than or equal to 18"
    }
  ]
}

// src/middleware/validate.ts
import { ZodSchema } from "zod"
import { Request, Response, NextFunction } from "express"

export function validate(schema: ZodSchema) {
  return (req: Request, res: Response, next: NextFunction) => {
    const result = schema.safeParse(req.body)
    if (!result.success) {
      return res.status(422).json({
        error: "Validation failed",
        issues: result.error.issues.map((issue) => ({
          field: issue.path.join("."),
          message: issue.message,
        })),
      })
    }
    req.body = result.data // استبدل body الخام بالبيانات المحللة والمُنظّفة
    next()
  }
}

// الاستخدام في ملف route:
import { validate } from "../middleware/validate"
import { createUserSchema } from "../schemas/user.schema"

router.post("/", validate(createUserSchema), usersController.create)

export const createPostSchema = z.object({
  title: z
    .string()
    .min(5, "Title must be at least 5 characters")
    .max(200, "Title cannot exceed 200 characters")
    .trim(),                    // أزل المسافات البيضاء من الطرفين

  slug: z
    .string()
    .toLowerCase()              // وحّد الحالة قبل التخزين
    .regex(/^[a-z0-9-]+$/, "Slug can only contain lowercase letters, numbers, and hyphens"),

  content: z
    .string()
    .min(20)
    .max(50_000),               // امنع payloads بحجم ميغابايتات

  published: z.boolean().default(false),

  tags: z
    .array(z.string().trim().max(50))
    .max(10, "No more than 10 tags allowed")
    .default([]),
})

// التحقق من params المسار
const idParamSchema = z.object({
  id: z.coerce.number().int().positive(), // يحول "42" → 42
})

// التحقق من query strings
const listQuerySchema = z.object({
  page: z.coerce.number().int().positive().default(1),
  limit: z.coerce.number().int().min(1).max(100).default(20),
  search: z.string().trim().max(100).optional(),
})

// middleware التحقق موسّع للـ params:
export function validateParams(schema: ZodSchema) {
  return (req: Request, res: Response, next: NextFunction) => {
    const result = schema.safeParse(req.params)
    if (!result.success) {
      return res.status(400).json({ error: "Invalid URL parameter", issues: result.error.issues })
    }
    req.params = result.data
    next()
  }
}