Schemas com zod

Parte da seção APIs REST do Journey de Node.js da Coddy. Lição 7 de 18.

As verificações manuais aumentam a cada campo e a cada rota. Um esquema zod descreve a estrutura uma única vez, e safeParse testa um valor em relação a ela:

import { z } from 'zod';

const Event = z.object({
    name: z.string().trim().min(1).max(80),
    seats: z.number().int().min(1),
}).strict();

const result = Event.safeParse(req.body);
if (!result.success) {
    return res.status(400).json({ error: z.flattenError(result.error) });
}
// result.data contém o corpo validado, com name sem espaços nas extremidades

.strict() rejeita campos que não estão listados no esquema. Event.partial() torna todos os campos opcionais, que é o que uma solicitação PATCH precisa, e Event.partial({ seats: true }) torna opcional apenas seats. z.flattenError lista os problemas por campo. Event.parse faz a mesma verificação, mas lança uma exceção para um valor inválido, e uma exceção em uma rota resulta em um erro 500.

Desafio

Fácil

Substitua as verificações manuais por um esquema Task: title é uma string sem espaços nas extremidades, de 1 a 100 caracteres, done é um booleano, .strict().
POST (done opcional, padrão false), PATCH (todos opcionais) e PUT usam safeParse; um corpo inválido retorna 400 com z.flattenError(result.error) como error.

Envie uma solicitação POST com { "title": " Order new chairs ", "color": "red" } e, em seguida, sem color.

Experimente você mesmo

import { Router } from 'express';
import { nextId, tasks } from '../store.js';

const router = Router();

// O motivo pelo qual um título não pode ser armazenado, ou null quando pode.
const titleError = (title) => {
    if (typeof title !== 'string' || title.trim() === '' || title.length > 100) {
        return 'title must be a string of 1 to 100 characters';
    }
    return null;
};

router.get('/', (req, res) => {
    res.json(tasks);
});

router.get('/:id', (req, res) => {
    const task = tasks.find((t) => t.id === Number(req.params.id));
    if (!task) {
        return res.status(404).json({ error: 'Task not found' });
    }
    res.json(task);
});

router.post('/', (req, res) => {
    const { title } = req.body ?? {};
    const problem = titleError(title);
    if (problem) {
        return res.status(400).json({ error: problem });
    }
    const task = { id: nextId(), title, done: false, createdAt: new Date().toISOString() };
    tasks.push(task);
    res.status(201).location(`/api/tasks/${task.id}`).json(task);
});

router.patch('/:id', (req, res) => {
    const task = tasks.find((t) => t.id === Number(req.params.id));
    if (!task) {
        return res.status(404).json({ error: 'Task not found' });
    }
    const { title, done } = req.body ?? {};
    if (title !== undefined && titleError(title)) {
        return res.status(400).json({ error: titleError(title) });
    }
    if (done !== undefined && typeof done !== 'boolean') {
        return res.status(400).json({ error: 'done must be true or false' });
    }
    if (title !== undefined) task.title = title;
    if (done !== undefined) task.done = done;
    res.json(task);
});

router.put('/:id', (req, res) => {
    const index = tasks.findIndex((t) => t.id === Number(req.params.id));
    if (index === -1) {
        return res.status(404).json({ error: 'Task not found' });
    }
    const { title, done } = req.body ?? {};
    if (title === undefined || done === undefined) {
        return res.status(400).json({ error: 'PUT needs every field: title and done' });
    }
    const { id, createdAt } = tasks[index];
    tasks[index] = { id, title, done, createdAt };
    res.json(tasks[index]);
});

router.delete('/:id', (req, res) => {
    const index = tasks.findIndex((t) => t.id === Number(req.params.id));
    if (index === -1) {
        return res.status(404).json({ error: 'Task not found' });
    }
    tasks.splice(index, 1);
    res.status(204).end();
});

export default router;