All files / src/helpers apiResponse.js

0% Statements 0/21
0% Branches 0/9
0% Functions 0/6
0% Lines 0/20

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85                                                                                                                                                                         
/**
 * Helper API Response — Format standardise pour les reponses de l'API publique.
 *
 * Succes : { data: ..., meta?: { page, per_page, total } }
 * Erreur : { error: { code, message, details? } }
 *
 * @module helpers/apiResponse
 */
 
const { pool: db } = require('../db');
 
/**
 * Envoie une reponse de succes avec l'enveloppe `data`.
 * @param {import('express').Response} res
 * @param {*} data
 * @param {number} [status=200]
 */
function apiSuccess(res, data, status = 200) {
  res.status(status).json({ data });
}
 
/**
 * Envoie une reponse de succes avec pagination.
 * @param {import('express').Response} res
 * @param {Array} data
 * @param {Object} meta — { page, per_page, total }
 */
function apiPaginated(res, data, meta) {
  res.json({ data, meta });
}
 
/**
 * Envoie une reponse d'erreur avec l'enveloppe `error`.
 * @param {import('express').Response} res
 * @param {number} status
 * @param {string} code
 * @param {string} message
 * @param {Object} [details]
 */
function apiError(res, status, code, message, details) {
  const body = { error: { code, message } };
  if (details) body.error.details = details;
  res.status(status).json(body);
}
 
/**
 * Parse les parametres de pagination depuis la query string.
 * @param {Object} query — req.query
 * @returns {{ page: number, perPage: number, offset: number }}
 */
function parsePagination(query) {
  const rawPage = Number.parseInt(query.page);
  const rawPerPage = Number.parseInt(query.per_page);
  const page = Math.max(1, Number.isNaN(rawPage) ? 1 : rawPage);
  const perPage = Math.min(100, Math.max(1, Number.isNaN(rawPerPage) ? 20 : rawPerPage));
  const offset = (page - 1) * perPage;
  return { page, perPage, offset };
}
 
/**
 * Cree un handler DELETE pour l'API v1 (utilise apiSuccess/apiError).
 *
 * @param {string} table — Nom de la table SQL
 * @param {string} errorMsg — Message d'erreur 404
 * @returns {Function} Express middleware
 */
function makeApiDeleteHandler(table, errorMsg) {
  return async (req, res, next) => {
    try {
      const { rows } = await db.query(
        `DELETE FROM ${table} WHERE id = $1 AND user_id = $2 RETURNING id`,
        [req.params.id, req.user.id],
      );
      if (rows.length === 0) {
        return apiError(res, 404, 'NOT_FOUND', errorMsg);
      }
      apiSuccess(res, { deleted: true, id: rows[0].id });
    } catch (err) {
      next(err);
    }
  };
}
 
module.exports = { apiSuccess, apiPaginated, apiError, parsePagination, makeApiDeleteHandler };