npm - @likewatt/models-front - Versions diffs - 1.104.0 → 1.106.0 - Mend

@likewatt/models-front 1.104.0 → 1.106.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/README.md +122 -122
package/dist/common/Comments.types.d.ts +20 -0
package/dist/core/SiteConstants.d.ts +10 -3
package/dist/core/SiteConstants.js +10 -3
package/dist/site/OpenDataProfile.types.d.ts +22 -61
package/dist/site/OpenDataProfile.types.js +0 -72
package/package.json +1 -1

package/README.md CHANGED Viewed

@@ -1,122 +1,122 @@
-# @likewatt/models
-Package privé contenant les modèles TypeScript FRONTEND partagés pour les applications Likewatt.
-## Installation
-```bash
-npm install @likewatt/models-fronted
-```
-## Description
-Ce package exporte les modèles de données TypeScript utilisés dans l'écosystème Likewatt, incluant :
-- **Entités principales** : `Site`, `Scenario`, `User`, `License`, `CollectiveSite`, `Invitation`, `ScenarioDefaultValue`
-- **Entités TypeORM** : `Analysis`, `Optimization`, `WebhookOutput`, historiques (Co2, Enedis, FCR, Okwind, Pvgis, Spot, Tempo)
-- **Modèles internes** : Paramètres énergétiques (batteries, PV, éolien, hydrogène, stockage thermique, etc.)
-- **Types frontend** : Types TypeScript pour l'interface utilisateur
-- **Énumérations** : Types énumérés partagés
-## Structure
-- `src/core/` : Entités principales et modèles internes
-- `src/frontend/` : Types TypeScript pour le frontend
-- `dist/` : Build compilé (CommonJS)
-## Technologies
-- TypeScript 5.x
-- TypeORM 0.3.x
-- Mongoose 8.x
-- NestJS decorators (Swagger, Mongoose)
-- Class Validator
-## Scripts disponibles
-```bash
-npm run build        # Compile le projet TypeScript
-npm run format       # Formate le code avec Prettier
-npm run lint         # Lint et fixe le code avec ESLint
-npm run lint:quick   # Lint sans auto-fix
-npm run release      # Crée une release automatique (conventional commits)
-npm run release:minor # Crée une release minor
-npm run release:major # Crée une release major
-```
-## Convention de commit
-Le projet utilise **Husky** et **Commitlint** pour enforcer les conventions de commit.
-### Format requis
-```
-<type>(<scope>): <subject>
-<body>
-<footer>
-```
-### Types autorisés
-- `feat`: Nouvelle fonctionnalité
-- `fix`: Correction de bug
-- `docs`: Documentation
-- `style`: Formatage, point-virgules manquants, etc.
-- `refactor`: Refactoring du code
-- `perf`: Amélioration des performances
-- `test`: Ajout de tests
-- `build`: Changements du système de build
-- `ci`: Changements CI/CD
-- `chore`: Tâches de maintenance
-- `revert`: Revert d'un commit précédent
-### Exemples
-```bash
-feat(user): add authentication endpoint
-fix(scenario): correct energy calculation
-docs(readme): update installation instructions
-refactor(battery): simplify params validation
-ci(pipeline): add automatic versioning
-```
-### Impact sur le versioning
-- `feat`: incrémente la version **minor** (1.0.0 → 1.1.0)
-- `fix`: incrémente la version **patch** (1.0.0 → 1.0.1)
-- `BREAKING CHANGE` dans le footer : incrémente la version **major** (1.0.0 → 2.0.0)
-## Release et versioning
-Le package utilise `standard-version` pour le versioning sémantique basé sur les commits conventionnels.
-### Release automatique
-Chaque push sur la branche `main` déclenche automatiquement :
-1. Installation des dépendances
-2. Build du projet
-3. Analyse des commits pour déterminer le type de version (patch/minor/major)
-4. Génération du CHANGELOG
-5. Publication sur le registry NPM privé
-### Release manuelle
-Via Bitbucket Pipelines, possibilité de forcer un type de release :
-- `patch` : Correctifs (1.0.0 → 1.0.1)
-- `minor` : Nouvelles fonctionnalités (1.0.0 → 1.1.0)
-- `major` : Breaking changes (1.0.0 → 2.0.0)
-- `prepatch`, `preminor`, `premajor`, `prerelease` : Versions de pré-release
-## Configuration
-- **Compilation** : ES2019, CommonJS, avec decorators experimentaux
-- **Output** : `dist/index.js` (main), `dist/index.d.ts` (types)
-- **Registry** : NPM privé Likewatt
-## Confidentialité
-Ce package est privé et ne doit pas être partagé en dehors de Likewatt.
+# @likewatt/models
+Package privé contenant les modèles TypeScript FRONTEND partagés pour les applications Likewatt.
+## Installation
+```bash
+npm install @likewatt/models-fronted
+```
+## Description
+Ce package exporte les modèles de données TypeScript utilisés dans l'écosystème Likewatt, incluant :
+- **Entités principales** : `Site`, `Scenario`, `User`, `License`, `CollectiveSite`, `Invitation`, `ScenarioDefaultValue`
+- **Entités TypeORM** : `Analysis`, `Optimization`, `WebhookOutput`, historiques (Co2, Enedis, FCR, Okwind, Pvgis, Spot, Tempo)
+- **Modèles internes** : Paramètres énergétiques (batteries, PV, éolien, hydrogène, stockage thermique, etc.)
+- **Types frontend** : Types TypeScript pour l'interface utilisateur
+- **Énumérations** : Types énumérés partagés
+## Structure
+- `src/core/` : Entités principales et modèles internes
+- `src/frontend/` : Types TypeScript pour le frontend
+- `dist/` : Build compilé (CommonJS)
+## Technologies
+- TypeScript 5.x
+- TypeORM 0.3.x
+- Mongoose 8.x
+- NestJS decorators (Swagger, Mongoose)
+- Class Validator
+## Scripts disponibles
+```bash
+npm run build        # Compile le projet TypeScript
+npm run format       # Formate le code avec Prettier
+npm run lint         # Lint et fixe le code avec ESLint
+npm run lint:quick   # Lint sans auto-fix
+npm run release      # Crée une release automatique (conventional commits)
+npm run release:minor # Crée une release minor
+npm run release:major # Crée une release major
+```
+## Convention de commit
+Le projet utilise **Husky** et **Commitlint** pour enforcer les conventions de commit.
+### Format requis
+```
+<type>(<scope>): <subject>
+<body>
+<footer>
+```
+### Types autorisés
+- `feat`: Nouvelle fonctionnalité
+- `fix`: Correction de bug
+- `docs`: Documentation
+- `style`: Formatage, point-virgules manquants, etc.
+- `refactor`: Refactoring du code
+- `perf`: Amélioration des performances
+- `test`: Ajout de tests
+- `build`: Changements du système de build
+- `ci`: Changements CI/CD
+- `chore`: Tâches de maintenance
+- `revert`: Revert d'un commit précédent
+### Exemples
+```bash
+feat(user): add authentication endpoint
+fix(scenario): correct energy calculation
+docs(readme): update installation instructions
+refactor(battery): simplify params validation
+ci(pipeline): add automatic versioning
+```
+### Impact sur le versioning
+- `feat`: incrémente la version **minor** (1.0.0 → 1.1.0)
+- `fix`: incrémente la version **patch** (1.0.0 → 1.0.1)
+- `BREAKING CHANGE` dans le footer : incrémente la version **major** (1.0.0 → 2.0.0)
+## Release et versioning
+Le package utilise `standard-version` pour le versioning sémantique basé sur les commits conventionnels.
+### Release automatique
+Chaque push sur la branche `main` déclenche automatiquement :
+1. Installation des dépendances
+2. Build du projet
+3. Analyse des commits pour déterminer le type de version (patch/minor/major)
+4. Génération du CHANGELOG
+5. Publication sur le registry NPM privé
+### Release manuelle
+Via Bitbucket Pipelines, possibilité de forcer un type de release :
+- `patch` : Correctifs (1.0.0 → 1.0.1)
+- `minor` : Nouvelles fonctionnalités (1.0.0 → 1.1.0)
+- `major` : Breaking changes (1.0.0 → 2.0.0)
+- `prepatch`, `preminor`, `premajor`, `prerelease` : Versions de pré-release
+## Configuration
+- **Compilation** : ES2019, CommonJS, avec decorators experimentaux
+- **Output** : `dist/index.js` (main), `dist/index.d.ts` (types)
+- **Registry** : NPM privé Likewatt
+## Confidentialité
+Ce package est privé et ne doit pas être partagé en dehors de Likewatt.

package/dist/common/Comments.types.d.ts CHANGED Viewed

@@ -1,15 +1,35 @@
+/**
+ * Commentaires libres saisis par l'utilisateur, indexés par emplacement dans
+ * l'application.
+ *
+ * La signature d'index n'est pas une commodité : le front génère des clés
+ * dynamiquement, une par technologie du mix (`PV_EnergeticMix_${techName}`), et
+ * la liste des technologies n'est pas connue à la compilation. Le schéma
+ * Mongoose côté `likewatt-models` est passé en `strict: false` pour la même
+ * raison ; ce typage s'aligne dessus.
+ *
+ * Les clés ci-dessous sont celles effectivement utilisées aujourd'hui, gardées
+ * explicites à titre de documentation. Elles ne sont pas exhaustives et le
+ * typage ne les contraint pas : en ajouter une n'est jamais un changement
+ * cassant.
+ */
 export interface Comments {
+    [key: string]: string | undefined;
+    ConsumerEnergyBalance?: string;
     CostPerMonth?: string;
     DailyProfile?: string;
     EnergyBalance?: string;
     LineBalanceSheet?: string;
     LoadCurve?: string;
+    Report?: string;
     ScenarioTable?: string;
+    TechModeling?: string;
     TotalCost?: string;
     TotalEnergy?: string;
     Grid_EnergeticMix?: string;
     LineBalanceSheetFromPopUp?: string;
     Opex?: string;
+    /** Le mix global. Les mix par technologie sont sous `PV_EnergeticMix_<techName>`. */
     PV_EnergeticMix?: string;
     TechSummary?: string;
     VanFromPopUp?: string;

package/dist/core/SiteConstants.d.ts CHANGED Viewed

@@ -409,9 +409,16 @@ export declare const SiteConstants: {
         readonly HYBRID: "HYBRIDE";
         readonly STRASBOURG: "STRASBOURG";
         /**
-         * Courbe de charge reconstituée depuis un profil de l'Open Data Enedis
-         * (moyenne des 500 courbes fictives du secteur, mise à l'échelle). Les
-         * détails de la récupération sont dans `Site.openDataProfile`.
+         * Courbe de charge reconstituée depuis l'Open Data Enedis : moyenne des
+         * 500 courbes fictives du secteur, re-datée sur une année civile. Aucune
+         * mise à l'échelle — le niveau est celui du secteur.
+         *
+         * Distincte de `PROFILE`, qui reste le flux des fichiers de coefficients.
+         * Les deux partagent le même onglet côté front, mais surtout pas le même
+         * traitement : `normalizeDataSourceTab` doit mapper `OPENDATA` vers l'onglet
+         * `PROFILE`, sans confondre les deux valeurs stockées.
+         *
+         * Détails de la récupération dans `Site.openDataProfile`.
          */
         readonly OPENDATA: "OPENDATA";
     };

package/dist/core/SiteConstants.js CHANGED Viewed

@@ -77,9 +77,16 @@ exports.SiteConstants = {
         HYBRID: 'HYBRIDE',
         STRASBOURG: 'STRASBOURG',
         /**
-         * Courbe de charge reconstituée depuis un profil de l'Open Data Enedis
-         * (moyenne des 500 courbes fictives du secteur, mise à l'échelle). Les
-         * détails de la récupération sont dans `Site.openDataProfile`.
+         * Courbe de charge reconstituée depuis l'Open Data Enedis : moyenne des
+         * 500 courbes fictives du secteur, re-datée sur une année civile. Aucune
+         * mise à l'échelle — le niveau est celui du secteur.
+         *
+         * Distincte de `PROFILE`, qui reste le flux des fichiers de coefficients.
+         * Les deux partagent le même onglet côté front, mais surtout pas le même
+         * traitement : `normalizeDataSourceTab` doit mapper `OPENDATA` vers l'onglet
+         * `PROFILE`, sans confondre les deux valeurs stockées.
+         *
+         * Détails de la récupération dans `Site.openDataProfile`.
          */
         OPENDATA: 'OPENDATA',
     },

package/dist/site/OpenDataProfile.types.d.ts CHANGED Viewed

@@ -25,62 +25,15 @@ export type EnedisOpenDataProfileType = 'RES1' | 'RES11' | 'RES2' | 'PRO1' | 'PR
  *
  * Union plate plutôt que produit (catégorie × segment × code) parce que le
  * catalogue Enedis est creux : `ENT1` n'a pas la tranche 50-120 kVA alors que
- * `ENT3` a 36-120, et les codes NAF diffèrent d'un segment à l'autre. Utiliser
- * `ENEDIS_OPENDATA_CATALOG` pour construire des listes en cascade sans jamais
- * proposer une combinaison inexistante.
- */
-export type EnedisOpenDataProfile = 'pro-naf3600' | 'pro-naf3700' | 'pro-naf5510' | 'pro-naf5610' | 'pro-naf6831' | 'pro-naf7010' | 'pro-naf8411' | 'pro-naf8413' | 'pro-naf8790' | 'ent-naf10' | 'ent-naf55' | 'ent-naf3600' | 'ent-naf4711' | 'ent-naf7010' | 'ent-naf8411' | 'res1-3-6' | 'res11-6-9' | 'res11-9-18' | 'res2-3-6' | 'res2-6-9' | 'res2-9-12' | 'pro1-0-6' | 'pro1-6-12' | 'pro1-12-sup' | 'pro2-0-6' | 'pro2-6-12' | 'pro2-12-24' | 'pro2-24-sup' | 'ent1-36-50' | 'ent1-120-250' | 'ent1-250-sup' | 'ent3-36-120' | 'ent3-120-250' | 'ent3-250-sup';
-/**
- * Catalogue réel des 34 datasets exploitables, pour bâtir des listes en cascade.
- *
- * Confronté au portail le 2026-08-19 (diff vide). Les 15 variantes `-gan` en sont
- * absentes : elles sont titrées « – archives » (ancien modèle GAN, remplacé par
- * diffusion latente).
- *
- * Noter les asymétries, qui sont la raison d'être de cette table : 5510 et 5610
- * n'existent qu'en `PRO`, 4711 qu'en `ENT`, et `ENT1` saute la tranche
- * 50-120 kVA que `ENT3` couvre.
- */
-export declare const ENEDIS_OPENDATA_CATALOG: {
-    readonly NAF: {
-        readonly PRO: readonly ["3600", "3700", "5510", "5610", "6831", "7010", "8411", "8413", "8790"];
-        readonly ENT: readonly ["10", "55", "3600", "4711", "7010", "8411"];
-    };
-    readonly PROFILE: {
-        readonly RES1: readonly ["3-6"];
-        readonly RES11: readonly ["6-9", "9-18"];
-        readonly RES2: readonly ["3-6", "6-9", "9-12"];
-        readonly PRO1: readonly ["0-6", "6-12", "12-sup"];
-        readonly PRO2: readonly ["0-6", "6-12", "12-24", "24-sup"];
-        readonly ENT1: readonly ["36-50", "120-250", "250-sup"];
-        readonly ENT3: readonly ["36-120", "120-250", "250-sup"];
-    };
-};
-/**
- * Bornes réelles de chaque plage de puissance souscrite, en kVA, indexées par la
- * valeur `powerRange` du slug.
+ * `ENT3` a 36-120, et les codes NAF diffèrent d'un segment à l'autre.
  *
- * Nécessaire parce que trois plages sont notées `-sup` dans les slugs sans que la
- * borne haute y figure : le front ne peut pas la deviner. Elle est bornée, pas
- * infinie — `12-sup` s'arrête à 36 kVA, `24-sup` à 36 également, `250-sup` à
- * 25 000.
- *
- * `label` reprend **verbatim** la chaîne du champ `plage_ps` d'Enedis, à titre
- * indicatif ; l'affichage reste libre côté front, qui dispose de `min`/`max`
- * pour composer le sien.
- *
- * Provenance : les 13 valeurs distinctes du champ `plage_ps` du dataset
- * `courbes-de-charges-fictives-caracteristiques`. Dix s'apparient directement aux
- * plages non-`sup` des slugs ; les trois restantes (`]12-36]`, `]24-36]`,
- * `]250-25000]`) s'apparient sans ambiguïté aux trois `-sup` par leur borne basse.
- * La borne 25 000 est corroborée par le nom du fichier source côté Enedis,
- * `ENT3-250-25000.csv`.
+ * Pour bâtir des listes en cascade, appeler `GET /profile/opendata/catalog` sur
+ * la gateway : elle dérive l'arbre de l'enum et reste donc la seule source de
+ * vérité. Ne pas en tenir une copie ici — les deux paquets sont versionnés
+ * séparément, et une divergence se manifesterait par un secteur sélectionnable
+ * qui renvoie un 404 Enedis.
  */
-export declare const ENEDIS_OPENDATA_POWER_RANGES: Record<string, {
-    min: number;
-    max: number;
-    label: string;
-}>;
+export type EnedisOpenDataProfile = 'pro-naf3600' | 'pro-naf3700' | 'pro-naf5510' | 'pro-naf5610' | 'pro-naf6831' | 'pro-naf7010' | 'pro-naf8411' | 'pro-naf8413' | 'pro-naf8790' | 'ent-naf10' | 'ent-naf55' | 'ent-naf3600' | 'ent-naf4711' | 'ent-naf7010' | 'ent-naf8411' | 'res1-3-6' | 'res11-6-9' | 'res11-9-18' | 'res2-3-6' | 'res2-6-9' | 'res2-9-12' | 'pro1-0-6' | 'pro1-6-12' | 'pro1-12-sup' | 'pro2-0-6' | 'pro2-6-12' | 'pro2-12-24' | 'pro2-24-sup' | 'ent1-36-50' | 'ent1-120-250' | 'ent1-250-sup' | 'ent3-36-120' | 'ent3-120-250' | 'ent3-250-sup';
 /**
  * Trace de la récupération d'une courbe de charge depuis l'Open Data Enedis.
  * Écrit par le back, jamais par le front.
@@ -98,19 +51,27 @@ export interface OpenDataProfile {
     /** Slug du dataset Data Fair, clé externe immuable. */
     datasetSlug: string;
     /**
-     * Bornes de la fenêtre réellement couverte.
+     * Bornes de la fenêtre réellement publiée par Enedis — 2023-11-01 → 2024-10-29.
+     * Traçabilité et attribution Etalab. Ce n'est **pas** la période de l'étude.
+     */
+    sourcePeriodStart?: Date | string;
+    sourcePeriodEnd?: Date | string;
+    /**
+     * Bornes de l'année civile servie, toujours 1er janvier → 31 décembre.
      *
-     * À afficher : l'Open Data ne publie **pas** d'année civile, la seule fenêtre
-     * disponible court du 2023-11-01 au 2024-10-29 (364 jours). Les composants qui
-     * raisonnent en années civiles doivent en tenir compte.
+     * C'est la période de l'étude, et celle que les composants raisonnant en
+     * années civiles doivent utiliser. Figée à la création du projet.
      */
     periodStart?: Date | string;
     periodEnd?: Date | string;
     retrievedAt?: Date | string;
     /** Nombre de courbes agrégées pour produire la moyenne (500 nominalement). */
     curveCount?: number;
-    /** Consommation annuelle typique du secteur, en kWh, avant mise à l'échelle. */
+    /**
+     * Consommation annuelle du secteur, en kWh. Niveau livré, non surchargeable.
+     * Ordre de grandeur : l'écart intra-secteur mesuré va de 1 à 24.
+     */
     referenceAnnualConsumptionKwh?: number;
-    /** Consommation annuelle réellement appliquée, en kWh. */
-    appliedAnnualConsumptionKwh?: number;
+    /** Puissance souscrite déduite, en kVA, arrondie au palier normalisé. */
+    deducedSubscribedPowerKva?: number;
 }

package/dist/site/OpenDataProfile.types.js CHANGED Viewed

@@ -1,74 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ENEDIS_OPENDATA_POWER_RANGES = exports.ENEDIS_OPENDATA_CATALOG = void 0;
-/**
- * Catalogue réel des 34 datasets exploitables, pour bâtir des listes en cascade.
- *
- * Confronté au portail le 2026-08-19 (diff vide). Les 15 variantes `-gan` en sont
- * absentes : elles sont titrées « – archives » (ancien modèle GAN, remplacé par
- * diffusion latente).
- *
- * Noter les asymétries, qui sont la raison d'être de cette table : 5510 et 5610
- * n'existent qu'en `PRO`, 4711 qu'en `ENT`, et `ENT1` saute la tranche
- * 50-120 kVA que `ENT3` couvre.
- */
-exports.ENEDIS_OPENDATA_CATALOG = {
-    NAF: {
-        PRO: [
-            '3600',
-            '3700',
-            '5510',
-            '5610',
-            '6831',
-            '7010',
-            '8411',
-            '8413',
-            '8790',
-        ],
-        ENT: ['10', '55', '3600', '4711', '7010', '8411'],
-    },
-    PROFILE: {
-        RES1: ['3-6'],
-        RES11: ['6-9', '9-18'],
-        RES2: ['3-6', '6-9', '9-12'],
-        PRO1: ['0-6', '6-12', '12-sup'],
-        PRO2: ['0-6', '6-12', '12-24', '24-sup'],
-        ENT1: ['36-50', '120-250', '250-sup'],
-        ENT3: ['36-120', '120-250', '250-sup'],
-    },
-};
-/**
- * Bornes réelles de chaque plage de puissance souscrite, en kVA, indexées par la
- * valeur `powerRange` du slug.
- *
- * Nécessaire parce que trois plages sont notées `-sup` dans les slugs sans que la
- * borne haute y figure : le front ne peut pas la deviner. Elle est bornée, pas
- * infinie — `12-sup` s'arrête à 36 kVA, `24-sup` à 36 également, `250-sup` à
- * 25 000.
- *
- * `label` reprend **verbatim** la chaîne du champ `plage_ps` d'Enedis, à titre
- * indicatif ; l'affichage reste libre côté front, qui dispose de `min`/`max`
- * pour composer le sien.
- *
- * Provenance : les 13 valeurs distinctes du champ `plage_ps` du dataset
- * `courbes-de-charges-fictives-caracteristiques`. Dix s'apparient directement aux
- * plages non-`sup` des slugs ; les trois restantes (`]12-36]`, `]24-36]`,
- * `]250-25000]`) s'apparient sans ambiguïté aux trois `-sup` par leur borne basse.
- * La borne 25 000 est corroborée par le nom du fichier source côté Enedis,
- * `ENT3-250-25000.csv`.
- */
-exports.ENEDIS_OPENDATA_POWER_RANGES = {
-    '0-6': { min: 0, max: 6, label: ']0-6 kVA]' },
-    '3-6': { min: 3, max: 6, label: ']3-6 kVA]' },
-    '6-9': { min: 6, max: 9, label: ']6-9 kVA]' },
-    '6-12': { min: 6, max: 12, label: ']6-12 kVA]' },
-    '9-12': { min: 9, max: 12, label: ']9-12 kVA]' },
-    '9-18': { min: 9, max: 18, label: ']9-18 kVA]' },
-    '12-24': { min: 12, max: 24, label: ']12-24 kVA]' },
-    '12-sup': { min: 12, max: 36, label: ']12-36 kVA]' },
-    '24-sup': { min: 24, max: 36, label: ']24-36 kVA]' },
-    '36-50': { min: 36, max: 50, label: ']36-50 kVA]' },
-    '36-120': { min: 36, max: 120, label: ']36-120 kVA]' },
-    '120-250': { min: 120, max: 250, label: ']120-250 kVA]' },
-    '250-sup': { min: 250, max: 25000, label: ']250-25000 kVA]' },
-};

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@likewatt/models-front",
-  "version": "1.104.0",
+  "version": "1.106.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",