Schemas com zod

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

As verificações manuais aumentam a cada campo e a cada rota. Um esquema zod descreve a estrutura uma 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 body validado, com name sem espaços nas extremidades

.strict() recusa campos que o esquema não lista. Event.partial() torna todos os campos opcionais, que é o que um PATCH precisa. Event.partial({ seats: true }) torna apenas seats opcional, e const { seats = 1 } = result.data usa 1 quando ele está ausente. z.flattenError(result.error) transforma os problemas em { formErrors, fieldErrors }: formErrors contém problemas com o corpo inteiro, como um campo desconhecido, e fieldErrors contém os problemas de cada 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 500.

Desafio

Fácil

Esta etapa abre o projeto de API do gerenciador de tarefas preparado pelo curso, em vez dos arquivos do seu projeto de Validating Input (incluindo routes/tasks.js). Seu trabalho anterior continua na própria lição. Leia os arquivos fornecidos antes de editar routes/tasks.js. Esta cópia contém rotas CRUD de tarefas e validação de entrada feita manualmente.

Suas verificações manuais aumentam a cada campo e a cada rota. Descreva uma tarefa uma vez com um esquema zod e faça com que as três rotas que recebem um corpo usem esse esquema.

Em routes/tasks.js, importe z de zod e escreva um esquema chamado Task:
- title: uma string, sem espaços no início nem no fim, com 1 a 100 caracteres após a remoção dos espaços.
- done: true ou false (z.boolean()).
- O esquema é estrito, então um campo que ele não lista, como color, é recusado.
Exclua o auxiliar fornecido titleError (a versão do curso da validação de Validating Input).
Crie duas versões de Task com .partial(). A versão do POST torna apenas done opcional. A versão do PATCH torna os dois campos opcionais. O PUT usa o próprio Task, então precisa dos dois campos.
No POST, PATCH e PUT, verifique req.body com safeParse. Quando a verificação falhar, responda com o status 400 e a lista de problemas do zod sob error, criada com z.flattenError(result.error). Para { "title": 123 }, o resultado é assim:
```
{ "error": { "formErrors": [], "fieldErrors": { "title": ["Invalid input: expected string, received number"] } } }
```
Quando a verificação passar, salve os dados de result.data, não de req.body: eles contêm o título sem espaços extras. No POST, um corpo sem done cria a tarefa com "done": false (um campo ausente é undefined em result.data, e ?? fornece um valor alternativo). O PUT ainda mantém id e createdAt da tarefa armazenada.

Experimente: envie por POST { "title": " Order new chairs ", "color": "red" } para /api/tasks. Você recebe 400, e formErrors informa Unrecognized key: "color". Envie novamente sem color: você recebe 201 com "title": "Order new chairs" (sem espaços) e "done": false. PATCH /api/tasks/2 com { "done": "yes" } retorna 400 com uma entrada done em fieldErrors. PUT /api/tasks/2 com { "title": "Book the big room", "done": false } retorna 200, com o createdAt antigo da tarefa 2.

Experimente você mesmo

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

const router = Router();

// O motivo pelo qual title 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;