@open3cl/engine 1.0.0

package/ficheTechnique.js

@@ -0,0 +1,86 @@
+/**
+ * Retourne si elle existe la fiche technique contenant le texte description et
+ * présente dans la catégorie de fiches techniques ayant pour catégorie categoryFicheTechiqueId
+ * et contenant la valeur classification
+ * @param dpe {FullDpe}
+ * @param categoryFicheTechiqueId {string}
+ * @param description {string}
+ * @param classifications {[string]}
+ * @param field {'description' | 'valeur'}
+ */
+export default function getFicheTechnique(
+  dpe,
+  categoryFicheTechiqueId,
+  description,
+  classifications = [],
+  field = 'description'
+) {
+  /** @type {FicheTechniqueItem[]} */
+  let fichesTechniques = dpe.fiche_technique_collection.fiche_technique;
+
+  if (!Array.isArray(fichesTechniques)) {
+    fichesTechniques = [fichesTechniques];
+  }
+
+  classifications = classifications.filter((classification) => classification);
+
+  fichesTechniques = fichesTechniques
+    .filter((ficheTechnique) => ficheTechnique)
+    .reduce((acc, ficheTechnique) => {
+      if (ficheTechnique.enum_categorie_fiche_technique_id === categoryFicheTechiqueId) {
+        /**
+         * Plusieurs collections de fiches techniques peuvent exister pour la même catégorie (pour 2 systèmes ECS par exemple)
+         * Le champs classification permet de trouver la collection qui convient en filtrant sur une seconde donnée
+         */
+        if (classifications.length) {
+          /** @type {SousFicheTechniqueItem[]} */
+          let sousFichesTechniques =
+            ficheTechnique.sous_fiche_technique_collection.sous_fiche_technique;
+
+          if (!Array.isArray(sousFichesTechniques)) {
+            sousFichesTechniques = [sousFichesTechniques];
+          }
+
+          const allContained = classifications.every((classification) =>
+            sousFichesTechniques.some((ficheTechnique) => {
+              const valeur = ficheTechnique?.valeur;
+
+              if (typeof valeur === 'string') {
+                return (
+                  ficheTechnique.valeur
+                    .toLowerCase()
+                    .indexOf(classification.toString().toLowerCase()) !== -1
+                );
+              }
+
+              return ficheTechnique.valeur === classification;
+            })
+          );
+
+          if (!allContained) {
+            return acc;
+          }
+        }
+
+        return acc.concat(ficheTechnique.sous_fiche_technique_collection.sous_fiche_technique);
+      }
+      return acc;
+    }, []);
+
+  if (!fichesTechniques.length) {
+    return null;
+  }
+
+  const firstFiche = fichesTechniques.filter(
+    (ficheTechnique) =>
+      ficheTechnique &&
+      ficheTechnique[field] &&
+      ficheTechnique[field].toString().toLowerCase().indexOf(description.toLowerCase()) !== -1
+  );
+
+  if (!firstFiche.length) {
+    return null;
+  }
+
+  return firstFiche[0];
+}

package/ficheTechnique.spec.js

@@ -0,0 +1,181 @@
+import getFicheTechnique from './ficheTechnique.js';
+
+describe('FicheTechnique service tests', () => {
+  const dpe = {
+    fiche_technique_collection: {
+      fiche_technique: [
+        {
+          enum_categorie_fiche_technique_id: '10',
+          sous_fiche_technique_collection: {
+            sous_fiche_technique: [
+              {
+                description: 'Type de ventilation: VMC SF Auto réglable avant 1982',
+                valeur: 'VMC SF Auto réglable avant 1982',
+                detail_origine_donnee: '',
+                enum_origine_donnee_id: '2'
+              },
+              {
+                description: 'Année installation: 1949',
+                valeur: 1949,
+                detail_origine_donnee: '',
+                enum_origine_donnee_id: '1'
+              },
+              {
+                description: 'Energie utilisée: Electrique',
+                valeur: 'Electrique',
+                detail_origine_donnee: '',
+                enum_origine_donnee_id: '2'
+              },
+              {
+                description: 'Façades exposées: plusieurs',
+                valeur: 'plusieurs',
+                detail_origine_donnee: '',
+                enum_origine_donnee_id: '2'
+              },
+              {
+                description: 'Logement Traversant: oui',
+                valeur: 'oui',
+                detail_origine_donnee: '',
+                enum_origine_donnee_id: '2'
+              }
+            ]
+          }
+        },
+        {
+          enum_categorie_fiche_technique_id: '10',
+          sous_fiche_technique_collection: {
+            sous_fiche_technique: [
+              {
+                description: 'Type de ventilation: VMC SF Auto réglable avant 1982',
+                valeur: 'VMC SF Auto réglable avant 1982',
+                detail_origine_donnee: '',
+                enum_origine_donnee_id: '2'
+              },
+              {
+                description: 'Année installation: 1950',
+                valeur: 1950,
+                detail_origine_donnee: '',
+                enum_origine_donnee_id: '1'
+              },
+              {
+                description: 'Energie utilisée: Bois',
+                valeur: 'Bois',
+                detail_origine_donnee: '',
+                enum_origine_donnee_id: '2'
+              },
+              {
+                description: 'Façades exposées: plusieurs',
+                valeur: 'plusieurs',
+                detail_origine_donnee: '',
+                enum_origine_donnee_id: '2'
+              },
+              {
+                description: 'Logement Traversant: oui',
+                valeur: 'oui',
+                detail_origine_donnee: '',
+                enum_origine_donnee_id: '2'
+              }
+            ]
+          }
+        },
+        {
+          enum_categorie_fiche_technique_id: '10',
+          sous_fiche_technique_collection: {
+            sous_fiche_technique: [
+              {
+                description: 'Type de ventilation: VMC SF Auto réglable avant 1982',
+                valeur: 'VMC SF Auto réglable avant 1982',
+                detail_origine_donnee: '',
+                enum_origine_donnee_id: '2'
+              },
+              {
+                description: 'Année installation: 1950',
+                valeur: 1950,
+                detail_origine_donnee: '',
+                enum_origine_donnee_id: '1'
+              },
+              {
+                description: 'Energie utilisée: Gaz',
+                valeur: 'Gaz',
+                detail_origine_donnee: '',
+                enum_origine_donnee_id: '2'
+              },
+              {
+                description: 'Façades exposées: plusieurs',
+                valeur: 'aucune',
+                detail_origine_donnee: '',
+                enum_origine_donnee_id: '2'
+              },
+              {
+                description: 'Logement Traversant: oui',
+                valeur: 'oui',
+                detail_origine_donnee: '',
+                enum_origine_donnee_id: '2'
+              }
+            ]
+          }
+        }
+      ]
+    }
+  };
+
+  it('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');
+    expect(fiche.valeur).toBe('plusieurs');
+
+    // Some DPE have a fiche_technique node which is not an array
+    const dpeWithoutArray = {
+      fiche_technique_collection: {
+        fiche_technique: {
+          enum_categorie_fiche_technique_id: '10',
+          sous_fiche_technique_collection: {
+            sous_fiche_technique: [
+              {
+                description: 'Façades exposées: plusieurs',
+                valeur: 'plusieurs',
+                detail_origine_donnee: '',
+                enum_origine_donnee_id: '2'
+              }
+            ]
+          }
+        }
+      }
+    };
+
+    fiche = getFicheTechnique(dpeWithoutArray, '10', 'exposées');
+    expect(fiche).not.toBeNull();
+  });
+
+  it('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 () => {
+    let fiche = getFicheTechnique(dpe, '40', 'exposées');
+    expect(fiche).toBeNull();
+
+    fiche = getFicheTechnique(dpe, '10', 'non existing');
+    expect(fiche).toBeNull();
+
+    dpe.fiche_technique_collection.fiche_technique[0].sous_fiche_technique_collection.sous_fiche_technique =
+      null;
+
+    fiche = getFicheTechnique(dpe, '11', 'non existing');
+    expect(fiche).toBeNull();
+
+    dpe.fiche_technique_collection.fiche_technique[0].sous_fiche_technique_collection = null;
+
+    fiche = getFicheTechnique(dpe, '11', 'non existing');
+    expect(fiche).toBeNull();
+
+    dpe.fiche_technique_collection.fiche_technique = null;
+
+    fiche = getFicheTechnique(dpe, '10', 'non existing');
+    expect(fiche).toBeNull();
+  });
+});

package/index.js

@@ -0,0 +1,4 @@
+import { calcul_3cl } from './engine.js';
+export { calcul_3cl };
+import { Umur, Uph, Upb, Uporte, Ubv, Upt } from './3_deperdition.js';
+export { Umur, Uph, Upb, Uporte, Ubv, Upt };

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "@open3cl/engine",
+  "version": "1.0.0",
+  "description": "Open Source 3CL-DPE engine",
+  "main": "index.js",
+  "directories": {
+    "test": "test"
+  },
+  "type": "module",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "test:benchmark": "node inspect test/run_benchmark.js",
+    "qa:lint": "eslint .",
+    "qa:lint:fix": "npm run qa:lint -- --fix",
+    "qa:duplication": "jscpd",
+    "qa:format": "prettier --plugin-search-dir . --write .",
+    "release": "semantic-release",
+    "release:dry": "semantic-release --dry-run",
+    "prepare": "husky install",
+    "assets:sync": "node scripts/synchronize_assets.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jzck/Open3CL.git"
+  },
+  "keywords": [
+    "dpe",
+    "3cl"
+  ],
+  "dependencies": {
+    "@jest/globals": "^29.7.0",
+    "fast-xml-parser": "^4.5.0",
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.2.1",
+    "@commitlint/config-conventional": "^19.1.0",
+    "@commitlint/cz-commitlint": "^19.2.0",
+    "@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",
+    "deep-object-diff": "^1.1.9",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-check-file": "^2.7.1",
+    "eslint-plugin-import": "^2.29.1",
+    "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",
+    "xlsx": "^0.18.5"
+  },
+  "author": "Jack Halford",
+  "license": "GPL-3.0",
+  "bugs": {
+    "url": "https://github.com/jzck/Open3CL/issues"
+  },
+  "homepage": "https://github.com/jzck/Open3CL#readme",
+  "jscpd": {
+    "threshold": 0.1,
+    "reporters": [
+      "console",
+      "html"
+    ],
+    "ignore": [
+      "**/*.spec.js"
+    ],
+    "path": [
+      "src"
+    ],
+    "output": "./duplicate",
+    "absolute": true,
+    "gitignore": true
+  }
+}