@legalplace/tagextractor 2.1.0 → 2.3.0

package/src/libs/Extractor.ts

@@ -1,97 +1,108 @@
-import { ModelV3 } from '@legalplace/models-v3-types'
-import { ReferencesParser, Types } from '@legalplace/referencesparser'
-import { ReferencesType } from '@legalplace/referencesparser/dist/libs/References.type'
-import ConditionsRunner from '@legalplace/conditions-runner'
-import OvcConverter from '@legalplace/ovc-converter'
-import InputsType from '@legalplace/types/dist/inputs'
-import OvcType from '@legalplace/types/dist/ovc'
-import TagsType from '../types/tags.type'
+import { ModelV3 } from "@legalplace/models-v3-types";
+import { ReferencesParser, Types } from "@legalplace/referencesparser";
+import { ReferencesType } from "@legalplace/referencesparser/dist/libs/References.type";
+import ConditionsRunner from "@legalplace/conditions-runner";
+import OvcConverter from "@legalplace/ovc-converter";
+import type InputsType from "@legalplace/types/dist/inputs";
+import type OvcType from "@legalplace/types/dist/ovc";
+import TagsType from "../types/tags.type";
 
 class TagExtractor {
-  private references: Types.ReferencesType
+  private references: Types.ReferencesType;
 
-  private inputs: InputsType
+  private inputs: InputsType;
 
-  private conditionsRunner: ConditionsRunner
+  private conditionsRunner: ConditionsRunner;
 
   private tags: TagsType = {
     options: {},
-    variables: {}
-  }
+    variables: {},
+  };
 
-  private isReferencesType = (_obj: ModelV3 | ReferencesType): _obj is ReferencesType => {
+  private isReferencesType = (
+    _obj: ModelV3 | ReferencesType
+  ): _obj is ReferencesType =>
     // We check if the object contains one of the fields only contained in ReferencesType
-    return Object.keys(_obj).some(key => key === 'boxes')
-  }
+    Object.keys(_obj).some((key) => key === "boxes");
 
-  constructor(modelOrReferences: ModelV3 | ReferencesType, ovc: OvcType | InputsType) {
-    this.references = this.isReferencesType(modelOrReferences) ? modelOrReferences : new ReferencesParser(modelOrReferences).references
+  constructor(
+    modelOrReferences: ModelV3 | ReferencesType,
+    ovc: OvcType | InputsType
+  ) {
+    this.references = this.isReferencesType(modelOrReferences)
+      ? modelOrReferences
+      : new ReferencesParser(modelOrReferences).references;
 
     // Converting inputs if needed
-    this.inputs = OvcConverter.isOptionsVariables(ovc) ? ovc : OvcConverter.convertToOptionsVariables(ovc, this.references)
+    this.inputs = OvcConverter.isOptionsVariables(ovc)
+      ? ovc
+      : OvcConverter.convertToOptionsVariables(ovc, this.references);
 
     // Initiaing Conditions runner
-    this.conditionsRunner = new ConditionsRunner(this.references, this.inputs)
+    this.conditionsRunner = new ConditionsRunner(this.references, this.inputs);
 
     // Extracting tags from options
-    this.extractFromOptions()
+    this.extractFromOptions();
 
     // Extracting tags from variables
-    this.extractFromVariables()
+    this.extractFromVariables();
   }
 
   public get getTags() {
-    return this.tags
+    return this.tags;
   }
 
   /**
    * Reads Options
    */
   private extractFromOptions() {
-    Object.keys(this.references.options).forEach(id => {
-      const { tags, label } = this.references.options[id].meta
+    Object.keys(this.references.options).forEach((id) => {
+      const { tags, label } = this.references.options[id].meta;
 
       if (Array.isArray(tags) && tags.length > 0 && this.inputs.options[id]) {
         this.inputs.options[id].forEach((v, index) => {
-          tags.forEach(tag => {
-            if (this.tags.options[tag] === undefined) this.tags.options[tag] = []
+          tags.forEach((tag) => {
+            if (this.tags.options[tag] === undefined)
+              this.tags.options[tag] = [];
             this.tags.options[tag].push({
               id: parseInt(id, 10),
               index,
               label,
               condition: this.getOptionCondition(parseInt(id, 10), index),
               visible: this.isOptionDisplayed(parseInt(id, 10), index),
-              value: this.inputs.options[id][index]
-            })
-          })
-        })
+              value: this.inputs.options[id][index],
+            });
+          });
+        });
       }
-    })
+    });
   }
 
   /**
    * Reads Variables
    */
   private extractFromVariables() {
-    Object.keys(this.references.variables).forEach(id => {
-      const { tags, label } = this.references.variables[id]
+    Object.keys(this.references.variables).forEach((id) => {
+      const { tags, label } = this.references.variables[id];
 
       if (Array.isArray(tags) && tags.length > 0 && this.inputs.variables[id]) {
         this.inputs.variables[id].forEach((v, index) => {
-          tags.forEach(tag => {
-            if (this.tags.variables[tag] === undefined) this.tags.variables[tag] = []
+          tags.forEach((tag) => {
+            if (this.tags.variables[tag] === undefined)
+              this.tags.variables[tag] = [];
             this.tags.variables[tag].push({
               id: parseInt(id, 10),
               index,
               label,
-              condition: this.getVariableCondition(parseInt(id, 10), index) !== false,
+              condition:
+                this.getVariableCondition(parseInt(id, 10), index) !== false,
               visible: this.isVariableDisplayed(parseInt(id, 10), index),
-              value: this.inputs.variables[id][index]
-            })
-          })
-        })
+              value: this.inputs.variables[id][index],
+            });
+          });
+        });
       }
-    })
+    });
   }
 
   /**
@@ -101,12 +112,23 @@ class TagExtractor {
    */
   isVariableDisplayed(id: number, index: number) {
     // Getting variable's conditions & executing it if any
-    const variableCondition = this.getVariableCondition(id, index)
-    const variableParents = this.references.relations.variables[id]?.parents || []
-    const parentOptionIsDisplayed = this.isOptionDisplayed(variableParents[0], index)
-    const parentOptionIsTruethful = this.inputs.options[variableParents[0]]?.[index] === true
-
-    return [variableCondition, parentOptionIsDisplayed, parentOptionIsTruethful].filter(c => c !== true).length === 0
+    const variableCondition = this.getVariableCondition(id, index);
+    const variableParents =
+      this.references.relations.variables[id]?.parents || [];
+    const parentOptionIsDisplayed = this.isOptionDisplayed(
+      variableParents[0],
+      index
+    );
+    const parentOptionIsTruethful =
+      this.inputs.options[variableParents[0]]?.[index] === true;
+
+    return (
+      [
+        variableCondition,
+        parentOptionIsDisplayed,
+        parentOptionIsTruethful,
+      ].filter((c) => c !== true).length === 0
+    );
   }
 
   /**
@@ -116,19 +138,29 @@ class TagExtractor {
    */
   isOptionDisplayed(id: number, index: number) {
     // Getting variable's conditions & executing it if any
-    const optionCondition = this.getOptionCondition(id, index)
-    const optionParents = this.references.relations.options[id]?.parents || []
-    const parentsConditions = optionParents.map(optionId => {
-      return this.getOptionCondition(optionId, index) !== false
-    })
-    const parentsInputs = optionParents.map(optionId => {
+    const optionCondition = this.getOptionCondition(id, index);
+    const optionParents = this.references.relations.options[id]?.parents || [];
+    const parentsConditions = optionParents.map(
+      (optionId) => this.getOptionCondition(optionId, index) !== false
+    );
+    const parentsInputs = optionParents.map((optionId) =>
       // If the parent option is not already defined we set the displayed parameter to false
-      return this.inputs.options[optionId]?.[index] || false
-    })
-    const parentSectionId = this.getOptionParentSection(id)
-    const parentSectionCondition = this.getSectionCondition(parentSectionId) !== false
-
-    return [optionCondition, parentSectionCondition, ...parentsConditions, ...parentsInputs].filter(c => c !== true).length === 0
+      this.inputs.options[optionId]
+        ? this.inputs.options[optionId][index]
+        : false
+    );
+    const parentSectionId = this.getOptionParentSection(id);
+    const parentSectionCondition =
+      this.getSectionCondition(parentSectionId) !== false;
+
+    return (
+      [
+        optionCondition,
+        parentSectionCondition,
+        ...parentsConditions,
+        ...parentsInputs,
+      ].filter((c) => c !== true).length === 0
+    );
   }
 
   /**
@@ -137,8 +169,15 @@ class TagExtractor {
    * @param index Variable's index
    */
   private getVariableCondition(id: number, index: number) {
-    const conditionObject = this.references.conditions.variables[id]
-    return conditionObject === undefined ? true : this.conditionsRunner.executeCondition(conditionObject, id, index, 'variables')
+    const conditionObject = this.references.conditions.variables[id];
+    return conditionObject === undefined
+      ? true
+      : this.conditionsRunner.executeCondition(
+          conditionObject,
+          id,
+          index,
+          "variables"
+        );
   }
 
   /**
@@ -147,8 +186,15 @@ class TagExtractor {
    * @param index Option's index
    */
   private getOptionCondition(id: number, index: number) {
-    const conditionObject = this.references.conditions.options[id]
-    return conditionObject === undefined ? true : this.conditionsRunner.executeCondition(conditionObject, id, index, 'options')
+    const conditionObject = this.references.conditions.options[id];
+    return conditionObject === undefined
+      ? true
+      : this.conditionsRunner.executeCondition(
+          conditionObject,
+          id,
+          index,
+          "options"
+        );
   }
 
   /**
@@ -156,8 +202,15 @@ class TagExtractor {
    * @param id Section's id
    */
   private getSectionCondition(id: number) {
-    const conditionObject = this.references.conditions.sections.main[id]
-    return conditionObject === undefined ? true : this.conditionsRunner.executeCondition(conditionObject, id, 0, 'sections')
+    const conditionObject = this.references.conditions.sections.main[id];
+    return conditionObject === undefined
+      ? true
+      : this.conditionsRunner.executeCondition(
+          conditionObject,
+          id,
+          0,
+          "sections"
+        );
   }
 
   /**
@@ -165,20 +218,22 @@ class TagExtractor {
    * @param id Option's id
    */
   private getOptionParentSection(id: number) {
-    const { parents } = this.references.relations.options[id]
+    const { parents } = this.references.relations.options[id];
 
     // Getting root option id
-    const rootId = parents.length > 0 ? parents[parents.length - 1] : id
+    const rootId = parents.length > 0 ? parents[parents.length - 1] : id;
 
     // Looking for section
-    const sections = Object.values(this.references.sections.main)
+    const sections = Object.values(this.references.sections.main);
 
     for (let i = 0; i < sections.length; i += 1) {
-      if (sections[i].options.includes(rootId)) return sections[i].id
+      if (sections[i].options.includes(rootId)) return sections[i].id;
     }
 
-    throw new Error(`Cannot find parent section for option ${id} (Root option id: ${rootId})`)
+    throw new Error(
+      `Cannot find parent section for option ${id} (Root option id: ${rootId})`
+    );
   }
 }
 
-export default TagExtractor
+export default TagExtractor;

package/src/libs/fixtures/inputs.json

@@ -0,0 +1,60 @@
+    {
+        "options": {
+            "1": [
+                true
+            ],
+            "2": [
+                true
+            ],
+            "5": [
+                true
+            ],
+            "6": [
+                true
+            ],
+            "7": [
+                true
+            ],
+            "8": [
+                false
+            ],
+            "10": [
+                false
+            ],
+            "11": [
+                true
+            ],
+            "12": [
+                true
+            ],
+            "13": [
+                false
+            ],
+            "14": [
+                false
+            ],
+            "15": [
+                false
+            ],
+            "16": [
+                true
+            ],
+            "18": [
+                false
+            ],
+            "24": [
+                true
+            ]
+        },
+        "variables": {
+            "1": [
+                "Company"
+            ],
+            "2": [
+                ""
+            ],
+            "5": [
+                "Non merci"
+            ]
+        }
+    }

package/src/libs/fixtures/model.json

@@ -0,0 +1,291 @@
+{
+    "documents": {
+        "main": {
+            "name": "main",
+            "sections": [
+                {
+                    "id": 1,
+                    "label": "Première section",
+                    "options": [
+                        1,
+                        2,
+                        5,
+                        6,
+                        7,
+                        11
+                    ]
+                },
+                {
+                    "id": 2,
+                    "label": "Deuxième section ",
+                    "options": [
+                        15,
+                        16
+                    ],
+                    "grantLevel": "ADMIN"
+                }
+            ]
+        }
+    },
+    "options": {
+        "1": {
+            "meta": {
+                "type": "hidden",
+                "label": "Text de la question",
+                "output": "<p></p>",
+                "step": "*",
+                "id": 1
+            },
+            "variables": [],
+            "options": []
+        },
+        "2": {
+            "meta": {
+                "type": "box",
+                "id": 2,
+                "step": "*",
+                "box": {
+                    "type": "light",
+                    "content": "<p>Ceci est du texte de présentation de la première section</p>"
+                },
+                "label": ""
+            },
+            "options": [],
+            "variables": []
+        },
+        "5": {
+            "meta": {
+                "type": "checkbox",
+                "id": 5,
+                "step": "*",
+                "label": "J'ai déjà choisi le nom de mon entreprise (conditionne la question sur le nom de l'entreprise)",
+                "conditions": {
+                    "and": [
+                        {
+                            "selected": [
+                                {
+                                    "var": "o.12"
+                                }
+                            ]
+                        }
+                    ]
+                }
+            },
+            "options": [],
+            "variables": []
+        },
+        "6": {
+            "meta": {
+                "type": "static",
+                "id": 6,
+                "label": "Quel est le nom de votre entreprise ?",
+                "step": "*",
+                "conditions": {
+                    "and": [
+                        {
+                            "selected": [
+                                {
+                                    "var": "o.5"
+                                }
+                            ]
+                        }
+                    ]
+                },
+                "multiple": {
+                    "enabled": false
+                },
+                "style": "full"
+            },
+            "options": [
+                18,
+                24
+            ],
+            "variables": [
+                1
+            ]
+        },
+        "7": {
+            "meta": {
+                "type": "static",
+                "id": 7,
+                "label": "Connaissiez-vous déjà LegalPlace ?",
+                "step": "*",
+                "hidden": false,
+                "tags": [
+                    "LP_fan"
+                ]
+            },
+            "options": [
+                8,
+                10
+            ],
+            "variables": []
+        },
+        "8": {
+            "meta": {
+                "type": "radio",
+                "id": 8,
+                "step": "*",
+                "label": "Oui j'adore"
+            },
+            "options": [],
+            "variables": []
+        },
+        "10": {
+            "meta": {
+                "type": "radio",
+                "id": 10,
+                "step": "*",
+                "label": "Non"
+            },
+            "options": [],
+            "variables": []
+        },
+        "11": {
+            "meta": {
+                "type": "static",
+                "id": 11,
+                "label": "Quel type d'entreprise ? ",
+                "step": "*"
+            },
+            "options": [
+                12,
+                13,
+                14
+            ],
+            "variables": []
+        },
+        "12": {
+            "meta": {
+                "type": "radio",
+                "id": 12,
+                "step": "*",
+                "label": "SAS"
+            },
+            "options": [],
+            "variables": []
+        },
+        "13": {
+            "meta": {
+                "type": "radio",
+                "id": 13,
+                "step": "*",
+                "label": "SASU"
+            },
+            "options": [],
+            "variables": []
+        },
+        "14": {
+            "meta": {
+                "type": "radio",
+                "id": 14,
+                "step": "*",
+                "label": "Autre"
+            },
+            "options": [],
+            "variables": []
+        },
+        "15": {
+            "meta": {
+                "type": "checkbox",
+                "id": 15,
+                "step": "*",
+                "label": "Je souhaite avoir des questions supplémentaires"
+            },
+            "options": [],
+            "variables": []
+        },
+        "16": {
+            "meta": {
+                "type": "static",
+                "id": 16,
+                "label": "Choisissez le jour de la semaine",
+                "step": "*",
+                "conditions": {
+                    "and": [
+                        {
+                            "selected": [
+                                {
+                                    "var": "o.15"
+                                }
+                            ]
+                        }
+                    ]
+                }
+            },
+            "options": [],
+            "variables": [
+                2
+            ]
+        },
+        "18": {
+            "meta": {
+                "type": "checkbox",
+                "id": 18,
+                "step": "*",
+                "label": "Orange"
+            },
+            "options": [],
+            "variables": []
+        },
+        "24": {
+            "meta": {
+                "type": "static",
+                "id": 24,
+                "label": "Voulez-vous changer de nom ? ",
+                "step": "*"
+            },
+            "options": [],
+            "variables": [
+                5
+            ]
+        }
+    },
+    "variables": {
+        "1": {
+            "type": "text",
+            "id": 1,
+            "label": "Nom de l'entreprise",
+            "step": "*",
+            "mandatory": false,
+            "placeholder": "",
+            "conditions": {
+                "and": [
+                    {
+                        "selected": [
+                            {
+                                "var": "o.8"
+                            }
+                        ]
+                    }
+                ]
+            },
+            "tags": [
+                "Company_name"
+            ],
+            "hidden": false
+        },
+        "2": {
+            "type": "list",
+            "id": 2,
+            "label": "Dropdown",
+            "step": "*",
+            "selectValues": [
+                "Lundi",
+                "Mardi",
+                "Mercredi",
+                "Jeudi",
+                "Vendredi"
+            ]
+        },
+        "5": {
+            "type": "text",
+            "id": 5,
+            "label": "Field",
+            "step": "*",
+            "mandatory": false,
+            "placeholder": ""
+        }
+    },
+    "customization": {}
+}

package/src/libs/fixtures/ovc.json

@@ -0,0 +1,15 @@
+{
+    "o": {
+        "11": 12
+    },
+    "v": {
+        "1": "Company",
+        "2": "",
+        "5": "Non merci"
+    },
+    "c": {
+        "5": true,
+        "15": false,
+        "18": false
+    }
+}