Etiquetas

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

As tarefas recebem rótulos como office ou money, e o aplicativo do quadro quer um menu com todos os rótulos e o número de tarefas de cada um. Esta etapa adiciona três coisas: uma regra de esquema para uma lista, um filtro e uma rota que conta os rótulos. Contar em um objeto, abaixo, é novidade.

// genres: z.array(z.string()).max(3).optional() no esquema
const counts = {};
for (const book of books) {
    for (const genre of book.genres) {
        counts[genre] = (counts[genre] ?? 0) + 1;
    }
}
// { poetry: 2, drama: 1 }

Object.entries(counts) transforma esse objeto em pares como [["poetry", 2], ...], prontos para serem mapeados em uma lista. Um resumo como esse é um recurso próprio, com sua própria URL.

optional() permite que esse campo esteja ausente, mas ainda verifica seu valor quando está presente. Transforme os pares de entrada em objetos com Object.entries(counts).map(([genre, count]) => ({ genre, count })): os colchetes desempacotam cada par; os parênteses retornam um objeto.

Desafio

Fácil

O app do quadro quer agrupar tarefas por etiquetas como office ou money e mostrar um menu com todas as etiquetas e o número de tarefas que cada uma contém. Adicione etiquetas à sua API.

Em routes/tasks.js, adicione um campo opcional labels ao esquema Task: uma lista com no máximo 5 etiquetas, cada uma sendo uma string de 1 a 20 caracteres após a remoção de espaços em branco. POST e PATCH também recebem esse campo, pois seus esquemas são construídos a partir de Task. Uma lista inválida gera o erro 400 habitual invalid_body. Listas inválidas incluem "labels": "office" (texto, não uma lista), "labels": [""] e seis etiquetas.
Toda tarefa salva tem uma lista labels:
- Quando um POST ou PUT não envia labels, salve []. PUT substitui a tarefa inteira, então um PUT sem etiquetas as apaga.
- PATCH altera labels somente quando as envia.
Em store.js, atribua etiquetas às tarefas iniciais: ["office"] para as tarefas 1 e 2 e ["money"] para a tarefa 3.
Ainda em routes/tasks.js, adicione um filtro à rota de listagem: GET /api/v1/tasks?label=office retorna somente as tarefas cujas labels incluem exatamente office. Ele funciona com os outros filtros e com a paginação, como antes.
Em server.js, adicione GET /api/v1/labels ao lado da montagem do roteador e importe tasks de store.js nesse arquivo. Ele retorna todas as etiquetas em uso e o número de tarefas que cada uma contém, ordenadas de A a Z pela etiqueta. Com as tarefas iniciais:
```
[
  { "label": "money", "count": 1 },
  { "label": "office", "count": 2 }
]
```

Teste:

GET /api/v1/labels retorna a lista acima.
Envie POST { "title": "Order chairs", "labels": ["office"] } para /api/v1/tasks: você recebe 201, e a nova tarefa tem "labels": ["office"]. GET /api/v1/labels agora mostra "count": 3 para office.
Envie POST { "title": "Water the plants" }: a nova tarefa tem "labels": [].
GET /api/v1/tasks?label=money retorna somente a tarefa 3. GET /api/v1/tasks?label=nope retorna "items": [] e "total": 0.
PUT /api/v1/tasks/2 com { "title": "Book the meeting room", "done": false } retorna a tarefa 2 com "labels": [].

Experimente você mesmo

import { Router } from 'express';
import { z } from 'zod';
import { config } from '../config.js';
import { sendError, sendInvalid } from '../errors.js';
import { nextId, tasks } from '../store.js';

const router = Router();

// Uma tarefa completa, como enviada por PUT. .strict() rejeita campos que não estão listados.
const Task = z
    .object({
        title: z.string().trim().min(1).max(100),
        done: z.boolean(),
    })
    .strict();
const NewTask = Task.partial({ done: true });
const TaskChanges = Task.partial();
const SORT_FIELDS = ['title', 'createdAt'];

// True quando outra tarefa já tem esse título, independentemente de maiúsculas ou minúsculas.
const titleTaken = (title, exceptId) =>
    tasks.some((t) => t.id !== exceptId && t.title.toLowerCase() === title.toLowerCase());

router.get('/', (req, res) => {
    const { done, q, sort } = req.query;
    let list = tasks;
    if (done !== undefined) {
        if (done !== 'true' && done !== 'false') {
            return sendError(res, 400, 'invalid_query', 'done must be true or false');
        }
        list = list.filter((t) => t.done === (done === 'true'));
    }
    if (q !== undefined) {
        const words = String(q).toLowerCase();
        list = list.filter((t) => t.title.toLowerCase().includes(words));
    }
    if (sort !== undefined) {
        const field = String(sort).startsWith('-') ? String(sort).slice(1) : String(sort);
        if (!SORT_FIELDS.includes(field)) {
            return sendError(
                res,
                400,
                'invalid_query',
                'sort must be title or createdAt, with - in front to reverse',
            );
        }
        const direction = String(sort).startsWith('-') ? -1 : 1;
        list = list.toSorted((a, b) => a[field].localeCompare(b[field]) * direction);
    }
    const page = req.query.page === undefined ? 1 : Number(req.query.page);
    const limit = req.query.limit === undefined ? config.pageSize : Number(req.query.limit);
    if (!Number.isInteger(page) || page < 1) {
        return sendError(res, 400, 'invalid_query', 'page must be a whole number from 1');
    }
    if (!Number.isInteger(limit) || limit < 1 || limit > 50) {
        return sendError(res, 400, 'invalid_query', 'limit must be a whole number from 1 to 50');
    }
    const start = (page - 1) * limit;
    res.json({
        items: list.slice(start, start + limit),
        page,
        total: list.length,
        pages: Math.ceil(list.length / limit),
    });
});

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

router.post('/', (req, res) => {
    const result = NewTask.safeParse(req.body);
    if (!result.success) {
        return sendInvalid(res, result.error);
    }
    const { title, done = false } = result.data;
    if (titleTaken(title)) {
        return sendError(res, 409, 'conflict', 'A task with this title already exists');
    }
    const task = { id: nextId(), title, done, createdAt: new Date().toISOString() };
    tasks.push(task);
    res.status(201).location(`/api/v1/tasks/${task.id}`).json(task);
});

router.patch('/:id', (req, res) => {
    const task = tasks.find((t) => t.id === Number(req.params.id));
    if (!task) {
        return sendError(res, 404, 'not_found', 'Task not found');
    }
    const result = TaskChanges.safeParse(req.body);
    if (!result.success) {
        return sendInvalid(res, result.error);
    }
    if (result.data.title !== undefined && titleTaken(result.data.title, task.id)) {
        return sendError(res, 409, 'conflict', 'A task with this title already exists');
    }
    Object.assign(task, result.data);
    res.json(task);
});

router.put('/:id', (req, res) => {
    const index = tasks.findIndex((t) => t.id === Number(req.params.id));
    if (index === -1) {
        return sendError(res, 404, 'not_found', 'Task not found');
    }
    const result = Task.safeParse(req.body);
    if (!result.success) {
        return sendInvalid(res, result.error);
    }
    const { id, createdAt } = tasks[index];
    if (titleTaken(result.data.title, id)) {
        return sendError(res, 409, 'conflict', 'A task with this title already exists');
    }
    tasks[index] = { id, ...result.data, 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 sendError(res, 404, 'not_found', 'Task not found');
    }
    tasks.splice(index, 1);
    res.status(204).end();
});

export default router;