Etichette

Fa parte della sezione API REST del percorso Node.js di Coddy. Lezione 24 di 25.

Alle attività vengono assegnate etichette come office o money, e l'app della bacheca vuole un menu con tutte le etichette e il numero di attività associate a ciascuna. Questo passaggio aggiunge tre elementi: una regola dello schema per un elenco, un filtro e una route che conta le etichette. Il conteggio in un oggetto, qui sotto, è una novità.

// genres: z.array(z.string()).max(3).optional() nello schema
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) trasforma quell'oggetto in coppie come [["poetry", 2], ...], pronte per essere mappate in un elenco. Un riepilogo come questo è una risorsa a sé stante, con un URL dedicato.

optional() permette che questo campo sia assente, continuando comunque a verificarne il valore quando è presente. Trasforma le coppie in voci in oggetti con Object.entries(counts).map(([genre, count]) => ({ genre, count })): le parentesi quadre estraggono i valori di ogni coppia; le parentesi tonde restituiscono un oggetto.

Sfida

Facile

L’app della bacheca vuole raggruppare le attività per etichette come office o money e mostrare un menu con tutte le etichette e il numero di attività a cui è assegnata ciascuna. Aggiungi le etichette alla tua API.

In routes/tasks.js, aggiungi un campo labels facoltativo allo schema Task: un elenco di massimo 5 etichette, ciascuna composta da una stringa di 1-20 caratteri dopo aver rimosso gli spazi iniziali e finali. Anche POST e PATCH lo acquisiscono, poiché i relativi schemi sono creati a partire da Task. Un elenco non valido genera il consueto errore 400 invalid_body. Gli elenchi non validi includono "labels": "office" (testo, non un elenco), "labels": [""] e sei etichette.
Ogni attività salvata ha un elenco labels:
- Quando una richiesta POST o PUT non invia labels, salva []. PUT sostituisce l’intera attività, quindi una richiesta PUT senza etichette le elimina.
- PATCH modifica labels solo se le invia.
In store.js, assegna le etichette alle attività iniziali: ["office"] per le attività 1 e 2, e ["money"] per l’attività 3.
Sempre in routes/tasks.js, aggiungi un filtro alla route dell’elenco: GET /api/v1/tasks?label=office restituisce solo le attività il cui campo labels include esattamente office. Funziona insieme agli altri filtri e con le pagine, come prima.
In server.js, aggiungi GET /api/v1/labels accanto al montaggio del router e importa anche tasks da store.js. Restituisce tutte le etichette in uso con il numero di attività a cui è assegnata ciascuna, ordinate dalla A alla Z per etichetta. Con le attività iniziali:
```
[
  { "label": "money", "count": 1 },
  { "label": "office", "count": 2 }
]
```

Prova:

GET /api/v1/labels restituisce l’elenco qui sopra.
Invia POST { "title": "Order chairs", "labels": ["office"] } a /api/v1/tasks: ottieni 201 e la nuova attività ha "labels": ["office"]. GET /api/v1/labels ora mostra "count": 3 per office.
Invia POST { "title": "Water the plants" }: la nuova attività ha "labels": [].
GET /api/v1/tasks?label=money restituisce solo l’attività 3. GET /api/v1/tasks?label=nope restituisce "items": [] e "total": 0.
PUT /api/v1/tasks/2 con { "title": "Book the meeting room", "done": false } restituisce l’attività 2 con "labels": [].

Provalo tu

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();

// Un'attività completa, come viene inviata da PUT. .strict() rifiuta i campi che non elenca.
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 se un'altra attività ha già questo titolo, indipendentemente dalle maiuscole e minuscole.
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;