All files / lib/api/service disciplineService.ts

100% Statements 20/20
100% Branches 7/7
100% Functions 2/2
100% Lines 15/15

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 723x                                                   3x   3x                       3x     3x 1x 1x 1x 1x 1x 1x   1x 1x       3x                         2x    
import {fetchApi} from '@/lib/api/core/fetchWrappers';
import {Discipline} from '@/type/evenement/discipline';
 
/**
 * @group Services
 */
 
/**
 * Interface définissant les filtres disponibles pour les disciplines
 */
export interface DisciplineFilters {
  /** Filtrage par nom (recherche partielle) */
  nom?: string;
  /** Numéro de page pour la pagination */
  page?: number;
  /** Nombre d'éléments par page */
  limit?: number;
  /** Champ de tri (actuellement seul 'nom' est supporté) */
  sortBy?: 'nom';
  /** Ordre de tri (ascendant ou descendant) */
  sortOrder?: 'asc' | 'desc';
}
 
/**
 * Service pour la gestion des disciplines sportives
 */
export class DisciplineService {
  // Chemin de base pour les endpoints des disciplines
  private static readonly BASE_PATH = '/discipline';
 
  /**
   * Récupère toutes les disciplines avec filtres optionnels
   *
   * @param filters - Filtres optionnels pour la recherche et la pagination
   * @returns Promise<Discipline[]> - Liste des disciplines
   * @throws Error - En cas d'erreur de l'API ou de réseau
   *
   * Route Django : path('discipline/', DisciplineListView.as_view(), name='discipline-list')
   */
  static async getAllDisciplines(filters?: DisciplineFilters): Promise<Discipline[]> {
    let url = `${this.BASE_PATH}/`;
 
    // Construction des paramètres de requête si des filtres sont fournis
    if (filters) {
      const params = new URLSearchParams();
      if (filters.nom) params.append('search', filters.nom);
      if (filters.page) params.append('page', filters.page.toString());
      if (filters.limit) params.append('limit', filters.limit.toString());
      if (filters.sortBy) params.append('sortBy', filters.sortBy);
      if (filters.sortOrder) params.append('sortOrder', filters.sortOrder);
 
      if (params.toString()) {
        url += `?${params.toString()}`;
      }
    }
 
    return fetchApi<Discipline[]>(url, {}, false);
  }
 
  /**
   * Récupère une discipline par son ID
   *
   * @param id - ID de la discipline à récupérer
   * @returns Promise<Discipline> - La discipline correspondante
   * @throws Error - En cas d'erreur de l'API ou si la discipline n'existe pas
   *
   * Route Django: path('discipline/<int:pk>/', DisciplineDetailView.as_view(), name='discipline-detail')
   */
  static async getDisciplineById(id: number): Promise<Discipline> {
    return fetchApi<Discipline>(`${this.BASE_PATH}/${id}/`);
  }
}