Merge branch 'feat/add-response-type' into 'dev'

chore(type): add response types

See merge request !29

.vscode/settings.json

@@ -39,9 +39,11 @@
     "energie",
     "etat",
     "firstname",
+    "gaziere",
     "grandlyon",
     "grdf",
     "grdfgrandlyon",
+    "journee",
     "konnector",
     "konnectors",
     "lastname",
@@ -49,7 +51,8 @@
     "numero",
     "perim",
     "periode",
-    "publiees"
+    "publiees",
+    "releve"
   ],
   "prettier.semi": true
 }

src/index.js

@@ -188,7 +188,8 @@ async function getData(token, idPCE, startDate, endDate) {
     })
     .then(result => {
       return result.match(/.+/g).map(s => {
-        result = JSON.parse(s)
+        /** @type {import('./types').GRDFDataRange} */
+        const result = JSON.parse(s)
         if (result.statut_restitution !== null) {
           /**
            * Handle no data issue when retrieving grdf data.

src/types.ts

@@ -65,3 +65,50 @@ export type Account = {
 export type AccountData = {
   consentId: string | undefined
 }
+
+/** Data response for donnees_consos_informatives?date_debut=2023-05-03&date_fin=2024-05-03 */
+export type GRDFDataRange = {
+  pce: { id_pce: string }
+  periode: {
+    valeur: null
+    date_debut: Date
+    date_fin: Date
+  }
+  releve_debut: {
+    date_releve: Date
+    index_brut_debut: Index
+    index_converti_debut: Index
+  }
+  releve_fin: {
+    date_releve: Date
+    index_brut_fin: Index
+    index_converti_fin: Index
+  }
+  consommation: {
+    date_debut_consommation: Date
+    date_fin_consommation: Date
+    flag_retour_zero: boolean
+    volume_brut: number
+    coeff_calcul: {
+      coeff_pta: null
+      valeur_pcs: null
+      coeff_conversion: number
+    }
+    volume_converti: number
+    energie: number
+    type_qualif_conso: string
+    sens_flux_gaz: string
+    statut_conso: string
+    journee_gaziere: Date
+    type_conso: string
+  }
+  statut_restitution: null | {
+    code: string
+    message: string
+  }
+}
+
+type Index = {
+  valeur_index: number
+  horodate_Index: Date
+}