From e0a3f59d08eaad5fcdcd756a96ecc7c3d0ce150e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Gangloff?= <contact@maelgangloff.fr>
Date: Sat, 27 Apr 2024 15:46:05 +0200
Subject: [PATCH] docs: add type documentation

---
 src/components/PCE/Consommation.ts | 17 +++++++++++++++++
 src/components/PCE/Contrat.ts      | 26 ++++++++++++++++++++++++++
 src/components/PCE/PCE.ts          | 23 ++++++++++++++++++++++-
 3 files changed, 65 insertions(+), 1 deletion(-)

diff --git a/src/components/PCE/Consommation.ts b/src/components/PCE/Consommation.ts
index 7183b6e..37491e2 100644
--- a/src/components/PCE/Consommation.ts
+++ b/src/components/PCE/Consommation.ts
@@ -1,3 +1,7 @@
+/**
+ * Les données publiées sont envoyées au fournisseur et permettent la facturation.
+ * Les données informatives sont journalières et individuelles (seulement pour les compteurs 1M et MM).
+ */
 export enum ConsommationType {
   informatives = 'informatives',
   publiees = 'publiees'
@@ -14,12 +18,25 @@ export interface Consommation {
       indexFin: number
       volumeBrutConsomme: number
       energieConsomme: number
+      /**
+       * 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: any
+      /**
+       * 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.
+       */
       volumeConverti: number|null
+      /**
+       * Coefficient lié aux conditions de température, pression et altitude au moment du relevé
+       */
       pta: any
       natureReleve: 'Publiée' | 'Informative Journalier' | string
       qualificationReleve: 'Estimé' | 'Mesuré' | 'Absence de Données' | string
       status: any
+      /**
+       * Coefficient produit du PTA et du PCS, calculé suivant la valeur moyenne sur la période de consommation.
+       */
       coeffConversion: number
       frequenceReleve: any
       temperature: any
diff --git a/src/components/PCE/Contrat.ts b/src/components/PCE/Contrat.ts
index 7e4bf9e..6db492a 100644
--- a/src/components/PCE/Contrat.ts
+++ b/src/components/PCE/Contrat.ts
@@ -1,8 +1,22 @@
 export interface Contrat {
+  /**
+   * - T1 : CAR < 6 MWh
+   * - T2 : CAR < 300 MWh
+   * - T3 : CAR < 5 GWh
+   * - T4 : CAR > 5 GWh
+   */
   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.
+   */
   carActuelle: number
   carFuture: number
   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
+   */
   cja: string|null
   cjaMensuelle: string|null
   cjaJournaliere: string|null
@@ -20,6 +34,18 @@ export interface Contrat {
   modulationN4: string|null
   assiette: string|null
   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%
+   */
   profil: string
   dateDebutProfil: string
   dateFinProfil: string
diff --git a/src/components/PCE/PCE.ts b/src/components/PCE/PCE.ts
index 0660753..fb6617b 100644
--- a/src/components/PCE/PCE.ts
+++ b/src/components/PCE/PCE.ts
@@ -8,8 +8,14 @@ import { Contrat } from './Contrat'
 export interface PCE {
   idObject: string
   role: string
+  /**
+   * Identification du compteur choisi par le client
+   */
   alias: string
   teleReleve: boolean
+  /**
+   * Point de Comptage et d'Estimation (identification du compteur)
+   */
   pce: string
   dateActivation: string
   dateMhs: string|null
@@ -22,6 +28,13 @@ export interface PCE {
   frequenceMMOrJJ?: boolean
   numeroSerie?: string
   numeroMatricule?: string
+  /**
+   * Il existe plusieurs fréquences de relève pour les compteurs :
+   * - 6M : Relevé semestriel par un technicien GRDF
+   * - 1M : Relevé mensuel
+   * - MM : Relevé mensuel des clients « haut de portefeuille »
+   * - JJ : Relevé journalier des plus gros clients « haut de portefeuille »
+   */
   frequenceReleve: '6M' | '1M' | 'MM' | 'JJ'
   etat: string
   datePremiereAccreditation: string
@@ -34,6 +47,9 @@ export interface PCE {
       codeDebit: string
       frequence: string
       idPitd: string
+      /**
+       * PITD : Point d’Interface Transport et Distribution
+       */
       libellePitd: string
       clientSensibleMig: string
       proprieteCompteur: string
@@ -42,13 +58,18 @@ export interface PCE {
       proprieteEnregistreur: string|null
       roues: number
       debit: string
-      pressionAval: string | object | null
+      /**
+       * La pression de livraison du gaz en bar
+       */
+      pressionAval: string | null
+
       numeroRue: string|null,
       nomRue: string|null,
       complementAdresse: string|null,
       codePostal: string|null,
       codeInseeCommune: string|null,
       commune: string|null,
+
       situationCompteur: string|null,
       accessibiliteCompteur: string|null,
       reperageRobinetGaz: string|null,