@legalplace/conditions-runner 2.3.3 → 2.3.4-staging.1

package/dist/ConditionsRunner.d.ts

@@ -14,7 +14,7 @@ declare class ConditionsRunner {
     executeCondition(condition: {
         dataMap: ConditionDataMap;
         conditions: ConditionV3;
-    }, id: number, index: number, conditionType: "options" | "optionValidator" | "variables" | "prefillers" | "variableValidator" | "sections" | "documents"): any;
+    }, id: number, index: number, conditionType: "options" | "optionValidator" | "variables" | "prefillers" | "variableValidator" | "sections" | "documents" | "multiples", documentSlug?: string): any;
     private buildComparatorResolverContext;
 }
 export default ConditionsRunner;

package/dist/ConditionsRunner.js

@@ -11,7 +11,7 @@ const ComparatorResolver_1 = require("./ComparatorResolver");
 class ConditionsRunner {
     constructor(references, ovc) {
         this.executeConditionMemo = {};
-        this.buildMemoizeKey = (condition, id, index, conditionType) => `${JSON.stringify(condition)}-${id}-${index}-${conditionType}`;
+        this.buildMemoizeKey = (condition, id, index, conditionType, documentSlug) => `${JSON.stringify(condition)}-${id}-${index}-${conditionType}-${documentSlug}`;
         this.references = references;
         this.ovc = ovc;
     }
@@ -62,23 +62,26 @@ class ConditionsRunner {
         }
         return false;
     }
-    executeCondition(condition, id, index, conditionType) {
-        const memoizedKey = this.buildMemoizeKey(condition, id, index, conditionType);
+    executeCondition(condition, id, index, conditionType, documentSlug = "main") {
+        const memoizedKey = this.buildMemoizeKey(condition, id, index, conditionType, documentSlug);
         if (this.executeConditionMemo[memoizedKey] !== undefined) {
             return this.executeConditionMemo[memoizedKey];
         }
         let currentData;
         if (conditionType === "options" || conditionType === "optionValidator") {
-            currentData = new DataPopulator_1.default(this, this.references, this.ovc, condition.dataMap, id, index).getData();
+            currentData = new DataPopulator_1.default(this, this.references, this.ovc, condition.dataMap, id, index, documentSlug).getData();
         }
         else if (conditionType === "variables" ||
             conditionType === "prefillers" ||
             conditionType === "variableValidator") {
             const dataId = this.references.relations.variables[id].parents[0];
-            currentData = new DataPopulator_1.default(this, this.references, this.ovc, condition.dataMap, dataId, index).getData();
+            currentData = new DataPopulator_1.default(this, this.references, this.ovc, condition.dataMap, dataId, index, documentSlug).getData();
         }
         else if (conditionType === "sections" || conditionType === "documents") {
-            currentData = new DataPopulator_1.default(this, this.references, this.ovc, condition.dataMap, id, index).getData();
+            currentData = new DataPopulator_1.default(this, this.references, this.ovc, condition.dataMap, id, index, documentSlug).getData();
+        }
+        else if (conditionType === "multiples") {
+            currentData = new DataPopulator_1.default(this, this.references, this.ovc, condition.dataMap).getData();
         }
         const resolverContext = this.buildComparatorResolverContext(id, index, conditionType);
         const deps = { references: this.references, ovc: this.ovc };

package/dist/ConditionsRunner.test.js

@@ -164,7 +164,7 @@ describe("ConditionsRunner class", () => {
     it("should not raise error when instanciating class", () => {
         expect(new ConditionsRunner_1.default(references_json_1.default, inputs_type_json_1.default)).toBeDefined();
     });
-    it("slices related document conditions to the current occurrence", () => {
+    it("should slice the condition to the current occurrence when the scope is related on a document", () => {
         const runner = new ConditionsRunner_1.default(buildRelatedDocumentReferences(), relatedOvc);
         const condition = mappedCondition({
             selected: [{ var: "o.3" }],
@@ -173,7 +173,17 @@ describe("ConditionsRunner class", () => {
         expect(runner.executeCondition(condition, 2, 0, "documents")).toBe(true);
         expect(runner.executeCondition(condition, 2, 1, "documents")).toBe(false);
     });
-    it("evaluates selected + first against the first row after id/index slicing", () => {
+    it("should evaluate the condition unsliced when the target type is multiples", () => {
+        const runner = new ConditionsRunner_1.default(buildRelatedDocumentReferences(), relatedOvc);
+        const condition = mappedCondition({
+            selected: [{ var: "o.3" }],
+            scope: "any",
+        });
+        expect(runner.executeCondition(condition, 2, 1, "documents")).toBe(false);
+        expect(runner.executeCondition(condition, 2, 1, "multiples")).toBe(true);
+        expect(runner.executeCondition(condition, 2, 0, "multiples")).toBe(true);
+    });
+    it("should evaluate against the first occurrence when the scope is first", () => {
         const runner = new ConditionsRunner_1.default(buildRelatedDocumentReferences(), relatedOvc);
         const condition = mappedCondition({
             selected: [{ var: "o.3" }],
@@ -181,7 +191,7 @@ describe("ConditionsRunner class", () => {
         });
         expect(runner.executeCondition(condition, 2, 1, "documents")).toBe(true);
     });
-    it("related sibling [var:N] uses the current occurrence index", () => {
+    it("should bind a sibling [var:N] to the current occurrence when the scope is related", () => {
         const runner = new ConditionsRunner_1.default(buildSiblingVariableReferences(), siblingOvc);
         const condition = mappedCondition({
             "=": [{ var: "v.3" }, "[var:4]"],
@@ -191,7 +201,7 @@ describe("ConditionsRunner class", () => {
         expect(runner.executeCondition(condition, 3, 1, "variables")).toBe(false);
         expect(runner.executeCondition(condition, 3, 2, "variables")).toBe(true);
     });
-    it("first-scoped sibling [var:N] uses occurrence 0", () => {
+    it("should bind a sibling [var:N] to occurrence 0 when the scope is first", () => {
         const runner = new ConditionsRunner_1.default(buildSiblingVariableReferences(), siblingOvc);
         const condition = mappedCondition({
             "=": [{ var: "v.3" }, "[var:4]"],
@@ -199,7 +209,7 @@ describe("ConditionsRunner class", () => {
         });
         expect(runner.executeCondition(condition, 3, 2, "variables")).toBe(true);
     });
-    it("all-scope sibling [var:N] is pairwise true when every row matches", () => {
+    it("should return true when the scope is all and every pairwise row matches", () => {
         const runner = new ConditionsRunner_1.default(buildSiblingVariableReferences(), {
             options: { 10: [true, true], 20: [true] },
             variables: {
@@ -214,7 +224,7 @@ describe("ConditionsRunner class", () => {
         });
         expect(runner.executeCondition(condition, 3, 0, "options")).toBe(true);
     });
-    it("all-scope sibling [var:N] is pairwise false when a row fails", () => {
+    it("should return false when the scope is all and a pairwise row fails", () => {
         const runner = new ConditionsRunner_1.default(buildSiblingVariableReferences(), {
             options: { 10: [true, true], 20: [true] },
             variables: {
@@ -229,7 +239,7 @@ describe("ConditionsRunner class", () => {
         });
         expect(runner.executeCondition(condition, 3, 0, "options")).toBe(false);
     });
-    it("any-scope sibling [var:N] succeeds on a later pairwise row", () => {
+    it("should return true when the scope is any and a later pairwise row matches", () => {
         const runner = new ConditionsRunner_1.default(buildSiblingVariableReferences(), {
             options: { 10: [true, true], 20: [true] },
             variables: {
@@ -244,7 +254,7 @@ describe("ConditionsRunner class", () => {
         });
         expect(runner.executeCondition(condition, 5, 0, "options")).toBe(true);
     });
-    it("joins non-sibling [var:N] values instead of slicing by row", () => {
+    it("should join every value when the [var:N] reference is not a sibling of the multiple", () => {
         const references = buildSiblingVariableReferences();
         const resolved = (0, ComparatorResolver_1.resolveConditionComparators)((0, referencesparser_1.lowerScope)({
             "=": [{ var: "v.3" }, "[var:5]"],
@@ -258,7 +268,7 @@ describe("ConditionsRunner class", () => {
 describe("resolveConditionComparators", () => {
     const references = buildSiblingVariableReferences();
     const deps = { references, ovc: siblingOvc };
-    it("related leaf: sibling [var:N] uses the current occurrence index", () => {
+    it("should resolve a sibling [var:N] to the current occurrence when the leaf scope is related", () => {
         const resolved = (0, ComparatorResolver_1.resolveConditionComparators)((0, referencesparser_1.lowerScope)({
             "=": [{ var: "v.3" }, "[var:4]"],
             scope: "related",
@@ -267,7 +277,7 @@ describe("resolveConditionComparators", () => {
             "=": [{ var: "v.3" }, "c"],
         });
     });
-    it("first-scoped leaf: sibling [var:N] uses occurrence 0", () => {
+    it("should resolve a sibling [var:N] to occurrence 0 when the leaf scope is first", () => {
         const resolved = (0, ComparatorResolver_1.resolveConditionComparators)((0, referencesparser_1.lowerScope)({
             "=": [{ var: "v.3" }, "[var:4]"],
             scope: "first",
@@ -276,7 +286,7 @@ describe("resolveConditionComparators", () => {
             "=-first": [{ var: "v.3" }, "same"],
         });
     });
-    it("uses empty sentinel for missing sibling values", () => {
+    it("should resolve to the empty sentinel when the sibling value is missing", () => {
         const resolved = (0, ComparatorResolver_1.resolveConditionComparators)((0, referencesparser_1.lowerScope)({
             "=": [{ var: "v.3" }, "[var:4]"],
             scope: "related",
@@ -293,7 +303,7 @@ describe("resolveConditionComparators", () => {
     });
 });
 describe("includes / does-not-include operators", () => {
-    it("lowerScope maps includes + any to includes-any", () => {
+    it("should lower the operator to includes-any when the scope is any", () => {
         expect((0, referencesparser_1.lowerScope)({
             includes: [{ var: "v.1" }, "SARL"],
             scope: "any",
@@ -301,7 +311,7 @@ describe("includes / does-not-include operators", () => {
             "includes-any": [{ var: "v.1" }, "SARL"],
         });
     });
-    it("lowerScope maps does-not-include + first to does-not-include-first", () => {
+    it("should lower the operator to does-not-include-first when the scope is first", () => {
         expect((0, referencesparser_1.lowerScope)({
             "does-not-include": [{ var: "v.1" }, "SARL"],
             scope: "first",

package/dist/DataPopulator.d.ts

@@ -9,8 +9,9 @@ declare class DataPopulator {
     private id?;
     private index?;
     private dataMap;
+    private documentSlug;
     private data;
-    constructor(conditionsRunner: ConditionsRunner, references: Types.ReferencesType, ovc: InputsType, dataMap: ConditionDataMap, id?: number, index?: number);
+    constructor(conditionsRunner: ConditionsRunner, references: Types.ReferencesType, ovc: InputsType, dataMap: ConditionDataMap, id?: number, index?: number, documentSlug?: string);
     getData(): Readonly<ConditionData>;
     private populateConditions;
     private getOptionConditions;

package/dist/DataPopulator.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 class DataPopulator {
-    constructor(conditionsRunner, references, ovc, dataMap, id, index) {
+    constructor(conditionsRunner, references, ovc, dataMap, id, index, documentSlug = "main") {
         this.data = {
             o: {},
             v: {},
@@ -11,6 +11,7 @@ class DataPopulator {
                 v: {},
             },
         };
+        this.documentSlug = documentSlug;
         this.id = id;
         this.ovc = ovc;
         this.index = index;
@@ -156,10 +157,11 @@ class DataPopulator {
         return result;
     }
     sectionConditionValue(sectionId) {
-        const conditions = this.references.conditions.sections.main[sectionId];
+        var _a;
+        const conditions = (_a = this.references.conditions.sections[this.documentSlug]) === null || _a === void 0 ? void 0 : _a[sectionId];
         if (conditions === undefined)
             return undefined;
-        return this.conditionsRunner.executeCondition(conditions, 0, 0, "sections");
+        return this.conditionsRunner.executeCondition(conditions, 0, 0, "sections", this.documentSlug);
     }
 }
 exports.default = DataPopulator;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@legalplace/conditions-runner",
-  "version": "2.3.3",
+  "version": "2.3.4-staging.1",
   "description": "Package containing method to execute conditions",
   "license": "MIT",
   "main": "dist/ConditionsRunner.js",
@@ -22,13 +22,12 @@
   "prettier": "@legalplace/prettier-config",
   "dependencies": {
     "@legalplace/lplogic": "2.4.1",
-    "@legalplace/models-v3-types": "^5.18.2",
-    "@legalplace/referencesparser": "^3.3.4"
+    "@legalplace/models-v3-types": "5.18.3-staging.0",
+    "@legalplace/referencesparser": "3.3.5-staging.0"
   },
   "devDependencies": {
-    "@legalplace/prettier-config": "^2.1.3",
-    "@legalplace/types": "^2.22.13",
+    "@legalplace/prettier-config": "2.1.4-staging.0",
+    "@legalplace/types": "2.22.15-staging.0",
     "ts-node": "^10.8.1"
-  },
-  "gitHead": "051ddec22eba44657f3a7fbab9356209e8ab476a"
+  }
 }

package/src/ConditionsRunner.test.ts

@@ -191,7 +191,7 @@ describe("ConditionsRunner class", () => {
     ).toBeDefined();
   });
 
-  it("slices related document conditions to the current occurrence", () => {
+  it("should slice the condition to the current occurrence when the scope is related on a document", () => {
     const runner = new ConditionsRunner(
       buildRelatedDocumentReferences(),
       relatedOvc
@@ -205,7 +205,22 @@ describe("ConditionsRunner class", () => {
     expect(runner.executeCondition(condition, 2, 1, "documents")).toBe(false);
   });
 
-  it("evaluates selected + first against the first row after id/index slicing", () => {
+  it("should evaluate the condition unsliced when the target type is multiples", () => {
+    const runner = new ConditionsRunner(
+      buildRelatedDocumentReferences(),
+      relatedOvc
+    );
+    const condition = mappedCondition({
+      selected: [{ var: "o.3" }],
+      scope: "any",
+    });
+
+    expect(runner.executeCondition(condition, 2, 1, "documents")).toBe(false);
+    expect(runner.executeCondition(condition, 2, 1, "multiples")).toBe(true);
+    expect(runner.executeCondition(condition, 2, 0, "multiples")).toBe(true);
+  });
+
+  it("should evaluate against the first occurrence when the scope is first", () => {
     const runner = new ConditionsRunner(
       buildRelatedDocumentReferences(),
       relatedOvc
@@ -218,7 +233,7 @@ describe("ConditionsRunner class", () => {
     expect(runner.executeCondition(condition, 2, 1, "documents")).toBe(true);
   });
 
-  it("related sibling [var:N] uses the current occurrence index", () => {
+  it("should bind a sibling [var:N] to the current occurrence when the scope is related", () => {
     const runner = new ConditionsRunner(
       buildSiblingVariableReferences(),
       siblingOvc
@@ -236,7 +251,7 @@ describe("ConditionsRunner class", () => {
     expect(runner.executeCondition(condition, 3, 2, "variables")).toBe(true);
   });
 
-  it("first-scoped sibling [var:N] uses occurrence 0", () => {
+  it("should bind a sibling [var:N] to occurrence 0 when the scope is first", () => {
     const runner = new ConditionsRunner(
       buildSiblingVariableReferences(),
       siblingOvc
@@ -250,7 +265,7 @@ describe("ConditionsRunner class", () => {
     expect(runner.executeCondition(condition, 3, 2, "variables")).toBe(true);
   });
 
-  it("all-scope sibling [var:N] is pairwise true when every row matches", () => {
+  it("should return true when the scope is all and every pairwise row matches", () => {
     const runner = new ConditionsRunner(buildSiblingVariableReferences(), {
       options: { 10: [true, true], 20: [true] },
       variables: {
@@ -267,7 +282,7 @@ describe("ConditionsRunner class", () => {
     expect(runner.executeCondition(condition, 3, 0, "options")).toBe(true);
   });
 
-  it("all-scope sibling [var:N] is pairwise false when a row fails", () => {
+  it("should return false when the scope is all and a pairwise row fails", () => {
     const runner = new ConditionsRunner(buildSiblingVariableReferences(), {
       options: { 10: [true, true], 20: [true] },
       variables: {
@@ -284,7 +299,7 @@ describe("ConditionsRunner class", () => {
     expect(runner.executeCondition(condition, 3, 0, "options")).toBe(false);
   });
 
-  it("any-scope sibling [var:N] succeeds on a later pairwise row", () => {
+  it("should return true when the scope is any and a later pairwise row matches", () => {
     const runner = new ConditionsRunner(buildSiblingVariableReferences(), {
       options: { 10: [true, true], 20: [true] },
       variables: {
@@ -301,7 +316,7 @@ describe("ConditionsRunner class", () => {
     expect(runner.executeCondition(condition, 5, 0, "options")).toBe(true);
   });
 
-  it("joins non-sibling [var:N] values instead of slicing by row", () => {
+  it("should join every value when the [var:N] reference is not a sibling of the multiple", () => {
     const references = buildSiblingVariableReferences();
     const resolved = resolveConditionComparators(
       lowerScope({
@@ -322,7 +337,7 @@ describe("resolveConditionComparators", () => {
   const references = buildSiblingVariableReferences();
   const deps = { references, ovc: siblingOvc };
 
-  it("related leaf: sibling [var:N] uses the current occurrence index", () => {
+  it("should resolve a sibling [var:N] to the current occurrence when the leaf scope is related", () => {
     const resolved = resolveConditionComparators(
       lowerScope({
         "=": [{ var: "v.3" }, "[var:4]"],
@@ -337,7 +352,7 @@ describe("resolveConditionComparators", () => {
     });
   });
 
-  it("first-scoped leaf: sibling [var:N] uses occurrence 0", () => {
+  it("should resolve a sibling [var:N] to occurrence 0 when the leaf scope is first", () => {
     const resolved = resolveConditionComparators(
       lowerScope({
         "=": [{ var: "v.3" }, "[var:4]"],
@@ -352,7 +367,7 @@ describe("resolveConditionComparators", () => {
     });
   });
 
-  it("uses empty sentinel for missing sibling values", () => {
+  it("should resolve to the empty sentinel when the sibling value is missing", () => {
     const resolved = resolveConditionComparators(
       lowerScope({
         "=": [{ var: "v.3" }, "[var:4]"],
@@ -375,7 +390,7 @@ describe("resolveConditionComparators", () => {
 });
 
 describe("includes / does-not-include operators", () => {
-  it("lowerScope maps includes + any to includes-any", () => {
+  it("should lower the operator to includes-any when the scope is any", () => {
     expect(
       lowerScope({
         includes: [{ var: "v.1" }, "SARL"],
@@ -386,7 +401,7 @@ describe("includes / does-not-include operators", () => {
     });
   });
 
-  it("lowerScope maps does-not-include + first to does-not-include-first", () => {
+  it("should lower the operator to does-not-include-first when the scope is first", () => {
     expect(
       lowerScope({
         "does-not-include": [{ var: "v.1" }, "SARL"],

package/src/ConditionsRunner.ts

@@ -114,7 +114,12 @@ class ConditionsRunner {
       | "variableValidator"
       | "sections"
       | "documents"
-  ) => `${JSON.stringify(condition)}-${id}-${index}-${conditionType}`;
+      | "multiples",
+    documentSlug: string
+  ) =>
+    `${JSON.stringify(
+      condition
+    )}-${id}-${index}-${conditionType}-${documentSlug}`;
 
   executeCondition(
     condition: {
@@ -131,12 +136,15 @@ class ConditionsRunner {
       | "variableValidator"
       | "sections"
       | "documents"
+      | "multiples",
+    documentSlug = "main"
   ): any {
     const memoizedKey = this.buildMemoizeKey(
       condition,
       id,
       index,
-      conditionType
+      conditionType,
+      documentSlug
     );
     if (this.executeConditionMemo[memoizedKey] !== undefined) {
       return this.executeConditionMemo[memoizedKey];
@@ -151,7 +159,8 @@ class ConditionsRunner {
         this.ovc,
         condition.dataMap,
         id,
-        index
+        index,
+        documentSlug
       ).getData();
     } else if (
       conditionType === "variables" ||
@@ -165,7 +174,8 @@ class ConditionsRunner {
         this.ovc,
         condition.dataMap,
         dataId,
-        index
+        index,
+        documentSlug
       ).getData();
     } else if (conditionType === "sections" || conditionType === "documents") {
       currentData = new DataPopulator(
@@ -174,7 +184,16 @@ class ConditionsRunner {
         this.ovc,
         condition.dataMap,
         id,
-        index
+        index,
+        documentSlug
+      ).getData();
+    } else if (conditionType === "multiples") {
+      // Multiple CTA conditions are evaluated once for the whole group
+      currentData = new DataPopulator(
+        this,
+        this.references,
+        this.ovc,
+        condition.dataMap
       ).getData();
     }
 

package/src/DataPopulator.ts

@@ -16,6 +16,8 @@ class DataPopulator {
 
   private dataMap: ConditionDataMap;
 
+  private documentSlug: string;
+
   private data: ConditionData = {
     o: {},
     v: {},
@@ -32,8 +34,10 @@ class DataPopulator {
     ovc: InputsType,
     dataMap: ConditionDataMap,
     id?: number,
-    index?: number
+    index?: number,
+    documentSlug = "main"
   ) {
+    this.documentSlug = documentSlug;
     this.id = id;
     this.ovc = ovc;
     this.index = index;
@@ -306,10 +310,17 @@ class DataPopulator {
    */
   private sectionConditionValue(sectionId: number) {
     // Getting section conditions
-    const conditions = this.references.conditions.sections.main[sectionId];
+    const conditions =
+      this.references.conditions.sections[this.documentSlug]?.[sectionId];
     if (conditions === undefined) return undefined;
 
-    return this.conditionsRunner.executeCondition(conditions, 0, 0, "sections");
+    return this.conditionsRunner.executeCondition(
+      conditions,
+      0,
+      0,
+      "sections",
+      this.documentSlug
+    );
   }
 }