@open3cl/engine 1.0.5 → 1.0.7

package/features/engine/domain/enveloppe/ventilation/deperdition-ventilation.service.spec.js

@@ -0,0 +1,393 @@
+import { TvStore } from '../../../../dpe/infrastructure/tv.store.js';
+import { DeperditionVentilationService } from './deperdition-ventilation.service.js';
+import { beforeEach, describe, expect, test, vi } from 'vitest';
+import { TypeHabitation } from '../../../../dpe/domain/models/type-habitation.model.js';
+
+/** @type {DeperditionVentilationService} **/
+let service;
+
+/** @type {TvStore} **/
+let tvStore;
+
+describe('Calcul de déperdition des portes', () => {
+  beforeEach(() => {
+    tvStore = new TvStore();
+    service = new DeperditionVentilationService(tvStore);
+  });
+
+  describe('Determination de q4paConv', () => {
+    /** @type {Contexte} */
+    let ctx = { typeHabitation: TypeHabitation.MAISON };
+
+    test.each([
+      {
+        q4paConvSaisi: undefined,
+        enumPeriodeConstructionId: '1',
+        surfaceIsolee: 0,
+        surfaceNonIsolee: 0,
+        surfaceMenuiserieAvecJoint: 0,
+        surfaceMenuiserieSansJoint: 0,
+        expectedIsolationSurface: '0',
+        expectedPresenceJointsMenuiserie: undefined
+      },
+      {
+        q4paConvSaisi: undefined,
+        enumPeriodeConstructionId: '1',
+        surfaceIsolee: 200,
+        surfaceNonIsolee: 100,
+        surfaceMenuiserieAvecJoint: 0,
+        surfaceMenuiserieSansJoint: 0,
+        expectedIsolationSurface: '1',
+        expectedPresenceJointsMenuiserie: undefined
+      },
+      {
+        q4paConvSaisi: undefined,
+        enumPeriodeConstructionId: '1',
+        surfaceIsolee: 200,
+        surfaceNonIsolee: 300,
+        surfaceMenuiserieAvecJoint: 100,
+        surfaceMenuiserieSansJoint: 0,
+        expectedIsolationSurface: '0',
+        expectedPresenceJointsMenuiserie: '1'
+      },
+      {
+        q4paConvSaisi: undefined,
+        enumPeriodeConstructionId: '1',
+        surfaceIsolee: 200,
+        surfaceNonIsolee: 300,
+        surfaceMenuiserieAvecJoint: 100,
+        surfaceMenuiserieSansJoint: 200,
+        expectedIsolationSurface: '0',
+        expectedPresenceJointsMenuiserie: undefined
+      },
+      {
+        q4paConvSaisi: undefined,
+        enumPeriodeConstructionId: '2',
+        surfaceIsolee: 200,
+        surfaceNonIsolee: 100,
+        surfaceMenuiserieAvecJoint: 0,
+        surfaceMenuiserieSansJoint: 0,
+        expectedIsolationSurface: '1',
+        expectedPresenceJointsMenuiserie: undefined
+      },
+      {
+        q4paConvSaisi: undefined,
+        enumPeriodeConstructionId: '3',
+        surfaceIsolee: 200,
+        surfaceNonIsolee: 100,
+        surfaceMenuiserieAvecJoint: 0,
+        surfaceMenuiserieSansJoint: 0,
+        expectedIsolationSurface: undefined,
+        expectedPresenceJointsMenuiserie: undefined
+      },
+      {
+        q4paConvSaisi: 12.5,
+        enumPeriodeConstructionId: '1',
+        surfaceIsolee: 0,
+        surfaceNonIsolee: 0,
+        surfaceMenuiserieAvecJoint: 0,
+        surfaceMenuiserieSansJoint: 0,
+        expectedIsolationSurface: '0',
+        expectedPresenceJointsMenuiserie: undefined
+      }
+    ])(
+      '$q4paConvSaisi: q4paConvSaisi, $enumPeriodeConstructionId: enumPeriodeConstructionId, $surfaceIsolee: surfaceIsolee,' +
+        '$surfaceNonIsolee: surfaceNonIsolee, $surfaceMenuiserieAvecJoint: surfaceMenuiserieAvecJoint, $surfaceMenuiserieSansJoint: surfaceMenuiserieSansJoint,' +
+        '$expectedIsolationSurface: expectedIsolationSurface, $expectedPresenceJointsMenuiserie: expectedPresenceJointsMenuiserie',
+      ({
+        q4paConvSaisi,
+        enumPeriodeConstructionId,
+        surfaceIsolee,
+        surfaceNonIsolee,
+        surfaceMenuiserieAvecJoint,
+        surfaceMenuiserieSansJoint,
+        expectedIsolationSurface,
+        expectedPresenceJointsMenuiserie
+      }) => {
+        vi.spyOn(tvStore, 'getQ4paConv').mockReturnValue({ q4pa_conv: 18.8 });
+        ctx.enumPeriodeConstructionId = enumPeriodeConstructionId;
+
+        /** @type {VentilationDE} */
+        const de = {
+          q4pa_conv_saisi: q4paConvSaisi
+        };
+
+        const q4paConv = service.q4paConv(
+          de,
+          ctx,
+          surfaceIsolee,
+          surfaceNonIsolee,
+          surfaceMenuiserieAvecJoint,
+          surfaceMenuiserieSansJoint
+        );
+
+        if (q4paConvSaisi) {
+          expect(tvStore.getQ4paConv).not.toHaveBeenCalled();
+          expect(q4paConv).toBe(q4paConvSaisi);
+        } else {
+          expect(tvStore.getQ4paConv).toHaveBeenCalledWith(
+            enumPeriodeConstructionId,
+            TypeHabitation.MAISON,
+            expectedIsolationSurface,
+            expectedPresenceJointsMenuiserie
+          );
+          expect(q4paConv).toBe(18.8);
+        }
+      }
+    );
+
+    test('calcul de hvent', () => {
+      expect(service.hvent(108, { qvarep_conv: 10 })).toBeCloseTo(367.2, 2);
+    });
+  });
+
+  describe('Determination de hperm', () => {
+    /** @type {Contexte} */
+    let ctx = { typeHabitation: TypeHabitation.MAISON, surfaceHabitable: 100 };
+
+    test.each([
+      { plusieursFacadeExposee: false, expectedHperm: 15.04 },
+      { plusieursFacadeExposee: true, expectedHperm: 98.97 }
+    ])(
+      '$plusieursFacadeExposee: plusieursFacadeExposee, $expectedHperm: expectedHperm',
+      ({ plusieursFacadeExposee, expectedHperm }) => {
+        ctx.hauteurSousPlafond = 10;
+
+        /** @type {VentilationDE} */
+        const de = {
+          plusieurs_facade_exposee: plusieursFacadeExposee
+        };
+
+        const hperm = service.hperm(
+          de,
+          { smea_conv: 18, qvasouf_conv: 15.3, qvarep_conv: 13.2 },
+          ctx,
+          10.5,
+          19.6
+        );
+        expect(hperm).toBeCloseTo(expectedHperm, 2);
+      }
+    );
+  });
+
+  describe('Determination de pventMoy', () => {
+    test.each([
+      {
+        label: 'Ventilation par ouverture des fenêtres',
+        typeVentilation: '1',
+        typeHabitation: TypeHabitation.MAISON,
+        ventilationPost2012: true,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 0
+      },
+      {
+        label: 'Ventilation naturelle par conduit',
+        typeVentilation: '25',
+        typeHabitation: TypeHabitation.APPARTEMENT,
+        ventilationPost2012: false,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 0
+      },
+      {
+        label: 'Ventilation Simple flux auto SF AUTO',
+        typeVentilation: '4',
+        typeHabitation: TypeHabitation.MAISON,
+        ventilationPost2012: true,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 35
+      },
+      {
+        label: 'Ventilation Simple flux auto SF AUTO',
+        typeVentilation: '4',
+        typeHabitation: TypeHabitation.MAISON,
+        ventilationPost2012: false,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 65
+      },
+      {
+        label: 'Ventilation Simple flux auto SF AUTO',
+        typeVentilation: '4',
+        typeHabitation: TypeHabitation.APPARTEMENT,
+        ventilationPost2012: true,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 250
+      },
+      {
+        label: 'Ventilation Simple flux auto SF AUTO',
+        typeVentilation: '4',
+        typeHabitation: TypeHabitation.APPARTEMENT,
+        ventilationPost2012: false,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 460
+      },
+      {
+        label: 'Ventilation Simple flux auto SF GAZ',
+        typeVentilation: '10',
+        typeHabitation: TypeHabitation.MAISON,
+        ventilationPost2012: true,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 35
+      },
+      {
+        label: 'Ventilation Simple flux auto SF GAZ',
+        typeVentilation: '11',
+        typeHabitation: TypeHabitation.MAISON,
+        ventilationPost2012: false,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 65
+      },
+      {
+        label: 'Ventilation Simple flux auto SF GAZ',
+        typeVentilation: '10',
+        typeHabitation: TypeHabitation.APPARTEMENT,
+        ventilationPost2012: true,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 250
+      },
+      {
+        label: 'Ventilation Simple flux auto SF GAZ',
+        typeVentilation: '12',
+        typeHabitation: TypeHabitation.APPARTEMENT,
+        ventilationPost2012: false,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 460
+      },
+      {
+        label: 'Ventilation Simple flux hygro SF HYGRO',
+        typeVentilation: '7',
+        typeHabitation: TypeHabitation.MAISON,
+        ventilationPost2012: true,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 15
+      },
+      {
+        label: 'Ventilation Simple flux hygro SF HYGRO',
+        typeVentilation: '8',
+        typeHabitation: TypeHabitation.MAISON,
+        ventilationPost2012: false,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 50
+      },
+      {
+        label: 'Ventilation Simple flux hygro SF HYGRO',
+        typeVentilation: '9',
+        typeHabitation: TypeHabitation.APPARTEMENT,
+        ventilationPost2012: true,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 250
+      },
+      {
+        label: 'Ventilation Simple flux hygro SF HYGRO',
+        typeVentilation: '13',
+        typeHabitation: TypeHabitation.APPARTEMENT,
+        ventilationPost2012: false,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 460
+      },
+      {
+        label: 'Ventilation double flux hygro DF INDIVIDUELLE',
+        typeVentilation: '19',
+        typeHabitation: TypeHabitation.MAISON,
+        ventilationPost2012: true,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 35
+      },
+      {
+        label: 'Ventilation double flux hygro DF INDIVIDUELLE',
+        typeVentilation: '19',
+        typeHabitation: TypeHabitation.MAISON,
+        ventilationPost2012: false,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 80
+      },
+      {
+        label: 'Ventilation double flux hygro DF INDIVIDUELLE',
+        typeVentilation: '19',
+        typeHabitation: TypeHabitation.APPARTEMENT,
+        ventilationPost2012: true,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 600
+      },
+      {
+        label: 'Ventilation double flux hygro DF INDIVIDUELLE',
+        typeVentilation: '19',
+        typeHabitation: TypeHabitation.APPARTEMENT,
+        ventilationPost2012: false,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 1100
+      },
+      {
+        label: 'Ventilation simple flux auto HYBRIDE',
+        typeVentilation: '26',
+        typeHabitation: TypeHabitation.MAISON,
+        ventilationPost2012: true,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 2.92
+      },
+      {
+        label: 'Ventilation simple flux auto HYBRIDE',
+        typeVentilation: '27',
+        typeHabitation: TypeHabitation.MAISON,
+        ventilationPost2012: false,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 5.42
+      },
+      {
+        label: 'Ventilation simple flux auto HYBRIDE',
+        typeVentilation: '28',
+        typeHabitation: TypeHabitation.APPARTEMENT,
+        ventilationPost2012: true,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 41.67
+      },
+      {
+        label: 'Ventilation simple flux auto HYBRIDE',
+        typeVentilation: '29',
+        typeHabitation: TypeHabitation.APPARTEMENT,
+        ventilationPost2012: false,
+        surfaceHabitable: 100,
+        qvarepConv: 10,
+        expectedPventMoy: 76.67
+      }
+    ])(
+      '$typeVentilation: typeVentilation, $typeHabitation: typeHabitation, $ventilationPost2012: ventilationPost2012, $surfaceHabitable: surfaceHabitable, $qvarepConv: qvarepConv',
+      ({
+        typeVentilation,
+        typeHabitation,
+        ventilationPost2012,
+        surfaceHabitable,
+        qvarepConv,
+        expectedPventMoy
+      }) => {
+        const pventMoy = service.pventMoy(
+          typeVentilation,
+          { typeHabitation, surfaceHabitable },
+          ventilationPost2012,
+          { qvarep_conv: qvarepConv }
+        );
+        expect(pventMoy).toBeCloseTo(expectedPventMoy, 2);
+      }
+    );
+  });
+});

package/features/engine/domain/models/contexte.model.ts

@@ -0,0 +1,10 @@
+import { TypeHabitation } from '../../../dpe/domain/models/dpe.model';
+
+export interface Contexte {
+  typeHabitation: TypeHabitation;
+  enumPeriodeConstructionId: string;
+  surfaceHabitable: string;
+  hauteurSousPlafond: string;
+  zoneClimatiqueId: string;
+  effetJoule: boolean;
+}

package/features/engine/domain/models/deperdition.model.ts

@@ -0,0 +1,8 @@
+export interface DeperditionData {
+  enumTypeAdjacenceId?: string;
+  surfaceAiu?: number;
+  surfaceAue?: number;
+  enumCfgIsolationLncId?: string;
+  tvCoefReductionDeperditionId?: string;
+  zoneClimatiqueId?: string;
+}

package/features/normalizer/domain/dpe-normalizer.service.js

@@ -0,0 +1,24 @@
+import { DpePreProcessor } from '../../../../../preprocessor/index.js';
+
+/**
+ * Service de normalisation du DPE d'entrée
+ * Permet de redresser / complèter des données d'entrées
+ */
+export class DpeNormalizerService {
+  /**
+   * @param dpe {Dpe}
+   * @return {Dpe} Normalized DPE
+   */
+  normalize(dpe) {
+    /**
+     * On clone le DPE d'origine pour ne pas le modifier
+     * @type {Dpe}
+     */
+    let normalizedDpe = JSON.parse(JSON.stringify(dpe));
+
+    const dpePreProcessor = new DpePreProcessor();
+    dpePreProcessor.preprocess(normalizedDpe);
+
+    return normalizedDpe;
+  }
+}

package/features/normalizer/domain/dpe-normalizer.service.spec.js

@@ -0,0 +1,3 @@
+import { describe } from 'vitest';
+
+describe.skip('Normalisation des DPE', () => {});

package/ficheTechnique.spec.js

@@ -1,4 +1,5 @@
 import getFicheTechnique from './ficheTechnique.js';
+import { describe, expect, test } from 'vitest';
 
 describe('FicheTechnique service tests', () => {
   const dpe = {
@@ -119,7 +120,7 @@ describe('FicheTechnique service tests', () => {
     }
   };
 
-  it('should return a fiche technique', async () => {
+  test('should return a fiche technique', async () => {
     let fiche = getFicheTechnique(dpe, '10', 'exposées');
     expect(fiche).not.toBeNull();
     expect(fiche.description).toBe('Façades exposées: plusieurs');
@@ -148,14 +149,14 @@ describe('FicheTechnique service tests', () => {
     expect(fiche).not.toBeNull();
   });
 
-  it('should return a fiche technique with multiple criteria', async () => {
+  test('should return a fiche technique with multiple criteria', async () => {
     let fiche = getFicheTechnique(dpe, '10', 'exposées', [1950, 'Gaz']);
     expect(fiche).not.toBeNull();
     expect(fiche.description).toBe('Façades exposées: plusieurs');
     expect(fiche.valeur).toBe('aucune');
   });
 
-  it('should not return a non existing fiche technique', async () => {
+  test('should not return a non existing fiche technique', async () => {
     let fiche = getFicheTechnique(dpe, '40', 'exposées');
     expect(fiche).toBeNull();
 

package/output.js

@@ -0,0 +1 @@
+filecontent

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open3cl/engine",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Open Source 3CL-DPE engine",
   "main": "index.js",
   "directories": {
@@ -12,7 +12,8 @@
     "access": "public"
   },
   "scripts": {
-    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "test": "vitest run",
+    "test:ci": "vitest run --coverage",
     "test:benchmark": "node inspect test/run_benchmark.js",
     "qa:lint": "eslint .",
     "qa:lint:fix": "npm run qa:lint -- --fix",
@@ -32,9 +33,10 @@
     "3cl"
   ],
   "dependencies": {
-    "@jest/globals": "^29.7.0",
+    "dioma": "^0.4.6",
     "fast-xml-parser": "^4.5.0",
-    "lodash": "^4.17.21"
+    "lodash": "^4.17.21",
+    "winston": "3.13.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.2.1",
@@ -43,8 +45,8 @@
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^10.0.2",
-    "@types/jest": "^29.5.12",
     "@types/node": "^20.12.4",
+    "@vitest/coverage-v8": "^3.0.6",
     "deep-object-diff": "^1.1.9",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
@@ -54,15 +56,14 @@
     "eslint-plugin-n": "^16.6.2",
     "eslint-plugin-promise": "^6.1.1",
     "husky": "^9.0.11",
-    "jest": "^29.7.0",
-    "jest-html-reporter": "^3.10.2",
     "jscpd": "^3.5.10",
     "prettier": "^3.2.5",
     "pretty-quick": "^4.0.0",
     "semantic-release": "^23.0.6",
+    "vitest": "3.0.6",
     "xlsx": "^0.18.5"
   },
-  "author": "Jack Halford",
+  "author": "Open3Cl",
   "license": "GPL-3.0",
   "bugs": {
     "url": "https://github.com/Open3CL/engine/issues"