@legalplace/tagextractor 2.0.0 → 2.2.0

package/dist/libs/Extractor.test.js

@@ -0,0 +1,278 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Extractor_1 = __importDefault(require("./Extractor"));
+const ovc_json_1 = __importDefault(require("./fixtures/ovc.json"));
+const inputs_json_1 = __importDefault(require("./fixtures/inputs.json"));
+const references_json_1 = __importDefault(require("./fixtures/references.json"));
+const model_json_1 = __importDefault(require("./fixtures/model.json"));
+const simpleReferences = references_json_1.default;
+const simpleModel = model_json_1.default;
+const simpleOvc = ovc_json_1.default;
+const simpleInputs = inputs_json_1.default;
+describe("TagsExtractor", () => {
+    const tagExtractor = new Extractor_1.default(simpleReferences, simpleInputs);
+    afterEach(() => {
+        jest.clearAllMocks();
+        jest.restoreAllMocks();
+    });
+    describe("IsVariableDisplayed", () => {
+        it("should return false when variable condition is false", () => {
+            const getVariableCondition = jest.spyOn(Extractor_1.default.prototype, "getVariableCondition");
+            getVariableCondition.mockImplementation(() => false);
+            expect(tagExtractor.isVariableDisplayed(1, 0)).toBeFalsy();
+            expect(getVariableCondition).toHaveBeenCalledWith(1, 0);
+        });
+        it("should return false when parent Option is not displayed", () => {
+            const isOptionDisplayed = jest.spyOn(Extractor_1.default.prototype, "isOptionDisplayed");
+            isOptionDisplayed.mockImplementation(() => false);
+            expect(tagExtractor.isVariableDisplayed(1, 0)).toBeFalsy();
+            expect(isOptionDisplayed).toHaveBeenCalledWith(6, 0);
+        });
+        it("should return false when parent Option is not truthful", () => {
+            const inputsWithParentsFalse = {
+                ...simpleInputs,
+                options: { ...simpleInputs.options, "6": [false] }
+            };
+            const customTagExtractor = new Extractor_1.default(simpleReferences, inputsWithParentsFalse);
+            expect(customTagExtractor.isVariableDisplayed(1, 0)).toBeFalsy();
+        });
+        it("should return true when all checks are okay", () => {
+            const inputsWithAllChecks = {
+                ...simpleInputs,
+                options: { ...simpleInputs.options, "8": [true] }
+            };
+            const customTagExtractor = new Extractor_1.default(simpleReferences, inputsWithAllChecks);
+            expect(customTagExtractor.isVariableDisplayed(1, 0)).toBeTruthy();
+        });
+    });
+    describe("IsOptionDisplayed", () => {
+        it("should return false when option condition is false", () => {
+            const getOptionCondition = jest.spyOn(Extractor_1.default.prototype, "getOptionCondition");
+            getOptionCondition.mockImplementation((id, index) => {
+                return !(id === 24 && index === 0);
+            });
+            expect(tagExtractor.isOptionDisplayed(24, 0)).toBeFalsy();
+            expect(getOptionCondition).toHaveBeenCalledWith(24, 0);
+        });
+        it("should return false when parentSectionCondition is false", () => {
+            const getSectionCondition = jest.spyOn(Extractor_1.default.prototype, "getSectionCondition");
+            getSectionCondition.mockImplementation(() => false);
+            expect(tagExtractor.isOptionDisplayed(24, 0)).toBeFalsy();
+            expect(getSectionCondition).toHaveBeenCalledWith(1);
+        });
+        it("should return false when parentCondition contains false value", () => {
+            const getOptionCondition = jest.spyOn(Extractor_1.default.prototype, "getOptionCondition");
+            getOptionCondition.mockImplementation((id, index) => {
+                return !(id === 6 && index === 0);
+            });
+            expect(tagExtractor.isOptionDisplayed(24, 0)).toBeFalsy();
+            expect(getOptionCondition).toHaveBeenCalledWith(24, 0);
+        });
+        it("should return false when parentsInputs list contains false value", () => {
+            const inputsWithParentsInputsFalse = {
+                ...simpleInputs,
+                options: { ...simpleInputs.options, "6": [false] }
+            };
+            const customTagExtractor = new Extractor_1.default(simpleReferences, inputsWithParentsInputsFalse);
+            expect(customTagExtractor.isOptionDisplayed(24, 0)).toBeFalsy();
+        });
+        it("should not return errors when parentsInputs is undefined", () => {
+            const inputsWithParentsInputsUndefined = {
+                ...simpleInputs,
+                options: { ...simpleInputs.options }
+            };
+            delete inputsWithParentsInputsUndefined.options["6"];
+            const customTagExtractor = new Extractor_1.default(simpleReferences, inputsWithParentsInputsUndefined);
+            expect(customTagExtractor.isOptionDisplayed(24, 0)).toBeFalsy();
+        });
+        it("should return true when all checks are okay", () => {
+            expect(tagExtractor.isOptionDisplayed(24, 0)).toBeTruthy();
+        });
+    });
+    describe("convertToOptionVariables", () => {
+        it("should tag extraction match when instanciating TagExtractor with ovc or inputs", () => {
+            const customTagExtractor = new Extractor_1.default(simpleReferences, simpleOvc);
+            const expectedTags = new Extractor_1.default(simpleReferences, simpleInputs)
+                .getTags;
+            expect(customTagExtractor.getTags).toMatchObject(expectedTags);
+        });
+    });
+    describe("ReferenceParser", () => {
+        it("should tag extraction match when instanciating TagExtractor with model or references", () => {
+            const customTagExtractor = new Extractor_1.default(simpleModel, simpleInputs);
+            const expectedTags = new Extractor_1.default(simpleReferences, simpleInputs)
+                .getTags;
+            expect(customTagExtractor.getTags).toMatchObject(expectedTags);
+        });
+    });
+    describe("extractFromOptions", () => {
+        it("should return empty tag object when tags are undefined", () => {
+            const referencesWithoutOptionTagArray = {
+                ...simpleReferences,
+                options: {
+                    ...simpleReferences.options,
+                    "7": {
+                        ...simpleReferences.options["7"],
+                        meta: { ...simpleReferences.options["7"].meta, tags: undefined }
+                    }
+                }
+            };
+            const customTagExtractor = new Extractor_1.default(referencesWithoutOptionTagArray, simpleInputs);
+            expect(customTagExtractor.getTags.options).toMatchObject({});
+        });
+        it("should return empty tag object when options tags are empty", () => {
+            const referencesWithoutOptionTags = {
+                ...simpleReferences,
+                options: {
+                    ...simpleReferences.options,
+                    "7": {
+                        ...simpleReferences.options["7"],
+                        meta: { ...simpleReferences.options["7"].meta, tags: [] }
+                    }
+                }
+            };
+            const customTagExtractor = new Extractor_1.default(referencesWithoutOptionTags, simpleInputs);
+            expect(customTagExtractor.getTags.options).toMatchObject({});
+        });
+        it("should return empty tags when input's option is undefined", () => {
+            const inputsWithoutOptionTaggedAnswer = {
+                ...simpleInputs,
+                options: { ...simpleInputs.options }
+            };
+            delete inputsWithoutOptionTaggedAnswer.options["7"];
+            const customTagExtractor = new Extractor_1.default(simpleReferences, inputsWithoutOptionTaggedAnswer);
+            expect(customTagExtractor.getTags.options).toMatchObject({});
+        });
+        it("should return option tag when champ multiples", () => {
+            const inputWithChampMultiple = {
+                ...simpleInputs,
+                options: { ...simpleInputs.options, "7": [true, false] }
+            };
+            const customTagExtractor = new Extractor_1.default(simpleReferences, inputWithChampMultiple);
+            const expectedOptionTags = {
+                LP_fan: [
+                    {
+                        id: 7,
+                        index: 0,
+                        label: "Connaissiez-vous déjà LegalPlace ?",
+                        condition: true,
+                        visible: true,
+                        value: true
+                    },
+                    {
+                        id: 7,
+                        index: 1,
+                        label: "Connaissiez-vous déjà LegalPlace ?",
+                        condition: true,
+                        visible: true,
+                        value: false
+                    }
+                ]
+            };
+            expect(customTagExtractor.getTags.options).toMatchObject(expectedOptionTags);
+        });
+        it("should return option tags", () => {
+            const expectedOptionTags = {
+                LP_fan: [
+                    {
+                        id: 7,
+                        index: 0,
+                        label: "Connaissiez-vous déjà LegalPlace ?",
+                        condition: true,
+                        visible: true,
+                        value: true
+                    }
+                ]
+            };
+            expect(tagExtractor.getTags.options).toMatchObject(expectedOptionTags);
+        });
+    });
+    describe("extractFromVariables", () => {
+        it("should return empty tag object when tags are undefined", () => {
+            const referenceWithoutVariableTagArray = {
+                ...simpleReferences,
+                variables: {
+                    ...simpleReferences.variables,
+                    "1": { ...simpleReferences.variables["1"], tags: undefined }
+                }
+            };
+            const customTagExtractor = new Extractor_1.default(referenceWithoutVariableTagArray, simpleInputs);
+            expect(customTagExtractor.getTags.variables).toMatchObject({});
+        });
+        it("should return empty tag object when variables tags are empty", () => {
+            const referenceWithoutTags = {
+                ...simpleReferences,
+                variables: {
+                    ...simpleReferences.variables,
+                    "1": { ...simpleReferences.variables["1"], tags: [] }
+                }
+            };
+            const customTagExtractor = new Extractor_1.default(referenceWithoutTags, simpleInputs);
+            expect(customTagExtractor.getTags.variables).toMatchObject({});
+        });
+        it("should return empty tags when input's variable is undefined", () => {
+            const inputsWithoutVariableTaggedAnswer = {
+                ...simpleInputs,
+                variables: { ...simpleInputs.variables }
+            };
+            delete inputsWithoutVariableTaggedAnswer.variables[1];
+            const customTagExtractor = new Extractor_1.default(simpleReferences, inputsWithoutVariableTaggedAnswer);
+            expect(customTagExtractor.getTags.variables).toMatchObject({});
+        });
+        it("should not throw error when input's variable does not match any references variable", () => {
+            const referenceWithoutMatchingVariable = {
+                ...simpleReferences,
+                variables: { ...simpleReferences.variables }
+            };
+            delete referenceWithoutMatchingVariable.variables["2"];
+            const customTagExtractor = new Extractor_1.default(referenceWithoutMatchingVariable, simpleInputs);
+            const expectedVariableTags = {
+                Company_name: [
+                    {
+                        id: 1,
+                        index: 0,
+                        label: "Nom de l'entreprise",
+                        condition: false,
+                        visible: false,
+                        value: "Company"
+                    }
+                ]
+            };
+            expect(customTagExtractor.getTags.variables).toMatchObject(expectedVariableTags);
+        });
+        it("should return variable tag when champ multiples", () => {
+            const inputVariableWithChampMultiple = {
+                ...simpleInputs,
+                variables: {
+                    ...simpleInputs.variables,
+                    "1": ["Nom de la companie", "Testing Company"]
+                }
+            };
+            const customTagExtractor = new Extractor_1.default(simpleReferences, inputVariableWithChampMultiple);
+            const expectedVariableTags = {
+                Company_name: [
+                    {
+                        id: 1,
+                        index: 0,
+                        label: "Nom de l'entreprise",
+                        condition: false,
+                        visible: false,
+                        value: "Nom de la companie"
+                    },
+                    {
+                        id: 1,
+                        index: 1,
+                        label: "Nom de l'entreprise",
+                        condition: false,
+                        visible: false,
+                        value: "Testing Company"
+                    }
+                ]
+            };
+            expect(customTagExtractor.getTags.variables).toMatchObject(expectedVariableTags);
+        });
+    });
+});

package/dist/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/dist/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/dist/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
+    }
+}