All files / lib/api/services/evenementSports disciplineService.ts

100% Statements 31/31
100% Branches 7/7
100% Functions 12/12
100% Lines 26/26

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 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 1925x                                                                                             5x   5x                       6x     6x 4x 4x 4x 4x 4x 4x   4x 4x       6x                         2x                         2x                               2x                               2x                             3x                   5x       1x         1x         1x         1x         1x         1x    
import { fetchApi } from '@/lib/api/core/fetchWrappers';
import { Discipline } from '@/types/sportEvenement/discipline';
 
/**
 * Service API pour la gestion des disciplines sportives
 * 
 * Ce service encapsule toutes les opérations CRUD pour les disciplines
 * et fournit une interface simple pour interagir avec l'API backend Django.
 * 
 * Authentification : Toutes les opérations nécessitent une authentification
 * via le token JWT géré automatiquement par fetchApi.
 */
 
/**
 * Interface pour les données de création d'une discipline
 */
export interface CreateDisciplineRequest {
  nom: string; // Nom de la discipline (ex: "Athlétisme", "Natation")
  icone: string; // Nom du fichier SVG de l'icône (ex: "ath.svg")
}
 
/**
 * Interface pour les données de mise à jour d'une discipline
 */
export interface UpdateDisciplineRequest {
  id: number; // ID de la discipline à mettre à jour
  nom: string; // Nouveau nom de la discipline
  icone: string; // Nom du fichier SVG de l'icône (ex: "ath.svg")
}
 
/**
 * Interface pour les filtres de recherche des disciplines
 */
export interface DisciplineFilters {
  nom?: string; // Filtrage par nom (recherche partielle)
  page?: number; // Numéro de page pour la pagination
  limit?: number; // Nombre d'éléments par page
  sortBy?: 'nom'; // Champ de tri (actuellement seul 'nom' est supporté)
  sortOrder?: 'asc' | 'desc'; // Ordre de tri (ascendant ou descendant)
}
 
/**
 * Service pour la gestion des disciplines sportives
 * 
 * Fournit une interface pour toutes les opérations CRUD sur les disciplines
 * avec gestion automatique de l'authentification et des erreurs.
 */
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);
  }
 
  /**
   * 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}/`);
  }
 
  /**
   * Crée une nouvelle discipline
   * 
   * @param data - Données de la discipline à créer
   * @returns Promise<Discipline> - La discipline créée
   * @throws Error - En cas d'erreur de l'API ou de validation
   * 
   * Route Django: path('discipline/create/', DisciplineCreateView.as_view(), name='discipline-create')
   */
  static async createDiscipline(data: CreateDisciplineRequest): Promise<Discipline> {
    return fetchApi<Discipline>(`${this.BASE_PATH}/create/`, {
      method: 'POST',
      body: JSON.stringify(data),
    });
  }
 
  /**
   * Met à jour une discipline existante
   * 
   * @param data - Données de la discipline à mettre à jour (incluant l'ID)
   * @returns Promise<Discipline> - La discipline mise à jour
   * @throws Error - En cas d'erreur de l'API ou si la discipline n'existe pas
   * 
   * Route Django: path('discipline/update/<int:pk>/', DisciplineUpdateView.as_view(), name='discipline-update')
   */
  static async updateDiscipline(data: UpdateDisciplineRequest): Promise<Discipline> {
    return fetchApi<Discipline>(`${this.BASE_PATH}/update/${data.id}/`, {
      method: 'PUT',
      body: JSON.stringify(data),
    });
  }
 
  /**
   * Supprime une discipline
   * 
   * @param id - ID de la discipline à supprimer
   * @returns Promise<void> - Promesse qui se résout quand la suppression est terminée
   * @throws Error - En cas d'erreur de l'API ou si la discipline n'existe pas
   * 
   * Route Django: path('discipline/delete/<int:pk>/', DisciplineDeleteView.as_view(), name='discipline-delete')
   */
  static async deleteDiscipline(id: number): Promise<void> {
    return fetchApi<void>(`${this.BASE_PATH}/delete/${id}/`, {
      method: 'DELETE',
    });
  }
 
  /**
   * Recherche des disciplines par nom
   * 
   * @param query - Terme de recherche
   * @returns Promise<Discipline[]> - Liste des disciplines correspondantes
   * @throws Error - En cas d'erreur de l'API ou de réseau
   * 
   * Note: Cette méthode utilise le paramètre 'search' de l'endpoint principal
   */
  static async searchDisciplines(query: string): Promise<Discipline[]> {
    return fetchApi<Discipline[]>(`${this.BASE_PATH}/?search=${encodeURIComponent(query)}`);
  }
}
 
/**
 * API fonctionnelle pour les disciplines
 * 
 * Interface alternative utilisant des fonctions plutôt que des méthodes statiques
 * pour une utilisation plus simple et une meilleure testabilité.
 */
export const disciplineApi = {
  /**
   * Récupère toutes les disciplines avec filtres optionnels
   */
  getAll: (filters?: DisciplineFilters) => DisciplineService.getAllDisciplines(filters),
  
  /**
   * Récupère une discipline par son ID
   */
  getById: (id: number) => DisciplineService.getDisciplineById(id),
  
  /**
   * Crée une nouvelle discipline
   */
  create: (data: CreateDisciplineRequest) => DisciplineService.createDiscipline(data),
  
  /**
   * Met à jour une discipline existante
   */
  update: (data: UpdateDisciplineRequest) => DisciplineService.updateDiscipline(data),
  
  /**
   * Supprime une discipline
   */
  delete: (id: number) => DisciplineService.deleteDiscipline(id),
  
  /**
   * Recherche des disciplines par nom
   */
  search: (query: string) => DisciplineService.searchDisciplines(query),
};