docs: add type documentation

src/components/Errors/index.ts

@@ -0,0 +1 @@
+export { HTMLResponseError } from './HTMLResponseError'

src/components/PCE/Adresse.ts

@@ -1,8 +1,26 @@
 export interface Adresse {
+  /**
+   * Numéro de la voie
+   */
   numVoie: string
+  /**
+   * Nom de la voie
+   */
   nomVoie: string
+  /**
+   * Code postal de la commune
+   */
   codePostal: string
+  /**
+   * Nom de la commune
+   */
   localite: string
+  /**
+   * Complément d'adresse
+   */
   complement: string
+  /**
+   * Adresse postale complète
+   */
   fullAddress: string
 }

src/components/PCE/Consommation.ts

@@ -9,43 +9,88 @@ export enum ConsommationType {
 
 export interface Consommation {
   [pce: string]: {
+    /**
+     * Numéro unique identifiant le Point de Comptage et d'Estimation
+     */
     idPce: string
     releves: Array<{
+      /**
+       * Date de début de la relève
+       */
       dateDebutReleve: string
+      /**
+       * Date de fin de la relève
+       */
       dateFinReleve: string
+      /**
+       * Journée gazière concernée par le relevée
+       */
       journeeGaziere: string | null
+      /**
+       * Index du compteur à la date de début de la relève
+       */
       indexDebut: number
+      /**
+       * Index du compteur à la date de fin de la relève
+       */
       indexFin: number
+      /**
+       * Volume brut consommé (en m3)
+       */
       volumeBrutConsomme: number
+      /**
+       * Energie consommée (en kWh)
+       * energie = coeff_pta * coef_pcs * volume_brut = coeff_conversion * volume_brut
+       */
       energieConsomme: number
       /**
-       * PCS : Pouvoir Calorifique Supérieur du Gaz.
-       * Il s'agit de la « quantité d'énergie dégagée par la combustion complète d'une unité de combustible, la vapeur d'eau étant supposée condensée et la chaleur récupérée ».
+       * PCS : Pouvoir Calorifique Supérieur du Gaz
+       * Il s'agit de la « quantité d'énergie dégagée par la combustion complète d'une unité de combustible (1m3).
+       * La vapeur d'eau étant supposée condensée et la chaleur récupérée ».
        */
       pcs: string|number|null
       /**
-       * Volume de gaz consommé sur la période en conditions normales, c'est à dire sous une pression de 1 bar et une température de 0°C.
+       * Volume de gaz consommé sur la période en conditions normales, c'est à dire sous une pression de 1 bar (105 Pa), à une température de 273°K (0°C)
+       * Unité : Nm3 (Normal m3) quantité de gaz exempt de vapeur d'eau.
+       * volume_converti = volume_brut * coeff_pta
        */
       volumeConverti: number|null
       /**
-       * PTA : Pression Température Altitude.
-       * Coefficient lié aux conditions de température, pression et altitude au moment du relevé.
+       * PTA : Pression Température Altitude
+       * Coefficient décrivant les conditions de température, pression et altitude au moment du relevé
+       * coeff_pta = (valeur index_converti_fin - valeur index_converti_début) / (valeur index_brut_fin - valeur index_brut_debut)
        */
       pta: string|number|null
       /**
        * - Publiée : Données de consommation journalières individuelles (uniquement pour les compteurs 1M et les MM).
        * - Informative Journalier : Données de consommation individuelles envoyées aux fournisseurs et permettant la facturation.
        */
       natureReleve: 'Publiée' | 'Informative Journalier' | string
-      qualificationReleve: 'Estimé' | 'Mesuré' | 'Absence de Données' | string
-      status: string|null
+      /**
+       * Qualification du relevé
+       */
+      qualificationReleve: 'Estimé' | 'Corrigé' | 'Mesuré' | 'Absence de Données' | string
+      /**
+       * Statut de la relève
+       */
+      status: 'Provisoire' | 'Définitive' | string|null
       /**
        * Coefficient produit du PTA et du PCS, calculé suivant la valeur moyenne sur la période de consommation.
+       * coeff_conversion = coeff_pta * valeur_pcs
        */
       coeffConversion: number
+      /**
+       * Fréquence de la relève
+       */
       frequenceReleve: string|null
+      /**
+       * Température lors de la relève
+       */
       temperature: string|number|null
     }>
+    /**
+     * Fréquence de la relève
+     */
     frequence: string|null
   }
 }

src/components/PCE/Contrat.ts

@@ -1,52 +1,130 @@
 export interface Contrat {
   /**
-   * - T1 : CAR < 6 MWh
-   * - T2 : CAR < 300 MWh
-   * - T3 : CAR < 5 GWh
-   * - T4 : CAR > 5 GWh
+   * Ce Tarif d'acheminement gaz du titulaire est choisi par le fournisseur en fonction d'une estimation du volume de gaz consommé.
+   * Il représente le tarif d’utilisation du réseau public de distribution du gaz naturel.
+   *
+   * Les tarifs d’acheminement comprennent plusieurs options tarifaires pour les particuliers et professionnels selon leur volume de consommation :
+   * - T1 : Consommation inférieure à 6000 kWh / an.
+   * - T2 : Consommation entre 6000 kWh / an et 300 MWh / an.
+   * - T3 : Consommation entre 300 MWh / an et 5 GWh / an (essentiellement des entreprises tertiaires ou industrielles de taille moyenne).
+   * - T4 : Consommation supérieure à 5 GWh / an (grands sites industriels directement rattachés au réseau de distribution de gaz naturel).
+   * - TP : Tarif de Proximité, il s’agit d’une option tarifaire concernant des clients finaux ayant la possibilité règlementaire de se raccorder au réseau de transport.
+   * - TB : Tarif Biométhane, il s'agit d'une option tarifaire concernant les producteurs de biométhane
    */
   tarifAcheminement: string
   /**
-   * CAR : Consommation Annuelle de Référence.
-   * Il s'agit de l'estimation de la consommation annuelle de gaz naturel en kWh, pour un PCE, dans des conditions climatiques moyennes.
+   * Consommation Annuelle de Référence (CAR) en kWh :
+   * * Quantité de gaz estimée consommée sur une année, dans des conditions climatiques moyennes.
+   * * La CAR d’une année N s’appliquent du 1er avril de l’année N au 31 mars de l’année N+1. Elle est mise à jour de manière systématique par le Gestionnaire de Réseau de Distribution (GRD).
    */
   carActuelle: number
+  /**
+   * Prochaine Consommation Annuelle de Référence (CAR) en kWh
+   */
   carFuture: number
+  /**
+   * Prochain Profil Type
+   */
   profilTypeFutur: string
   /**
-   * CJA : Capacité Journalière d’Acheminement.
-   * Il s'agit de la quantité maximale d'énergie que le Distributeur s'engage à acheminer chaque Jour en un Point de Livraison
+   * Capacité Journalière d’Acheminement (CJA) en kWh/jour :
+   * * Quantité maximale d’énergie que le distributeur s'engage à acheminer chaque jour en un point de livraison.
+   * * Elle se compose d’une souscription annuelle à laquelle peut s’ajouter une souscription mensuelle supplémentaire et/ou une souscription journalière supplémentaire. Ce type de donnée est applicable seulement aux compteurs JJ et pour les clients de tarif T4 ou TP (Tarif de Proximité).
    */
   cja: string|null
+  /**
+   * Souscription mensuelle supplémentaire
+   */
   cjaMensuelle: string|null
+  /**
+   * Souscription journalière supplémentaire
+   */
   cjaJournaliere: string|null
+
   idCad: string
+  /**
+   * Nom du titulaire du contrat de fourniture d'énerge
+   */
   nomTitulaire: string
+  /**
+   * Raison sociale du titulaire (si applicable)
+   */
   raisonSocialeTitulaire: string|null
+  /**
+   * Numéro SIRET du titulaire (si applicable)
+   */
   numeroSiretTitulaire: string|null
+  /**
+   * Date de la Mise En Service (MES) du PCE correspondante au titulaire actif
+   */
   dateMes: string|null
+  /**
+   * Date de la Mise Hors Service (MHS) du PCE correspondante au titulaire actif
+   */
   dateMhs: string|null
+  /**
+   * Statut du contrat
+   */
   statutContractuel: string
+  /**
+   * Plafond de consommation journalière
+   */
   consommationJournalierePlafond: string|null
+  /**
+   * Modulation de Stockage Année N-1
+   */
   modulationN1: string|null
+  /**
+   * Modulation de Stockage Année N-2
+   */
   modulationN2: string|null
+  /**
+   * Modulation de Stockage Année N-3
+   */
   modulationN3: string|null
+  /**
+   * Modulation de Stockage Année N-4
+   */
   modulationN4: string|null
+  /**
+   * Assiette de compensation de stockage. Moyenne des 2 modulation plus petite.
+   */
   assiette: string|null
+  /**
+   * Fournisseur d'énergie souscrit
+   */
   fournisseur: string
   /**
-   * La répartition de la part hiver (PH) dans la consommation annuelle (du 01/11 au 31/03)
-   * - P011 : CAR < 6 MWh
-   * - P012 : CAR > 6 MWh
-   * - P013 : PH < 39%
-   * - P014 : PH < 50%
-   * - P015 : PH < 58%
-   * - P016 : PH < 69%
-   * - P017 : PH < 75%
-   * - P018 : PH < 81%
-   * - P019 : PH > 81%
+   * Le Profil Type (est attribué par le Distributeur) caractérise la répartition de la CAR d’un PCE tout au long de l’année.
+   * Il est notamment utilisé entre deux relevés pour estimer les quantités journalières d'un PCE.
+   * Ce dernier est déterminé automatiquement par le système d’informations de GRDF à partir de la CAR saisie par le fournisseur (puis chaque année à partir de la CAR recalculée par GRDF).
+   *
+   * Dix profils types permettent de définir les usages de consommations du gaz naturel :
+   * - P000 : Client PCE forfait cuisine
+   * - P011 : Client Gazpar (compteur 1M) ou à relevé semestriel avec une CAR inférieure à 6000 kWh/an (compteur 6M)
+   * - P012 : Client Gazpar (compteur 1M) ou à relevé semestriel avec une CAR supérieure ou égale à 6000 kWh/an (compteur 6M)
+   * - P013 : Client à relevé mensuel (compteur MM) ou journalier (compteur JJ) avec une part hiver corrigée moyenne inférieure ou égale à 39%
+   * - P014 : Client à relevé mensuel (compteur MM) ou journalier (compteur JJ) avec une part hiver corrigée moyenne entre 39% et 50%
+   * - P015 : Client à relevé mensuel (compteur MM) ou journalier (compteur JJ) avec une part hiver corrigée moyenne entre 50% et 58%
+   * - P016 : Client à relevé mensuel (compteur MM) ou journalier (compteur JJ) avec une part hiver corrigée moyenne entre 58% et 69%
+   * - P017 : Client à relevé mensuel (compteur MM) ou journalier (compteur JJ) avec une part hiver corrigée moyenne entre 69% et 75%
+   * - P018 : Client à relevé mensuel (compteur MM) ou journalier (compteur JJ) avec une part hiver corrigée moyenne entre 75% et 81%
+   * - P019 : Client à relevé mensuel (compteur MM) ou journalier (compteur JJ) avec une part hiver corrigée moyenne strictement supérieure à 81%
+   *
+   * Le Profil Type d’une année N s’appliquent du 1er avril de l’année N au 31 mars de l’année N+1.
+   * Il est mis à jour de manière systématique par le Gestionnaire de Réseau de Distribution (GRD), une fois par an à date fixe, sauf en cas d'évènement spécifique :
+   * - Premières Mise En Service (MES)
+   * - Changement de fournisseur avec changement de tarif ou de fréquence de relevé
+   * - Changement de données tarifaires
+   * - Corrections d’une erreur manifeste (CAR et/ou profil aberrant)
    */
   profil: string
+  /**
+   * Date de début de validité du Profil Type actuel
+   */
   dateDebutProfil: string
+  /**
+   * Date de fin de validité du Profil Type actuel
+   */
   dateFinProfil: string
 }