@legalplace/prerenderx 3.8.24 → 3.9.0

package/dist/libs/SectionRender.js

@@ -15,6 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var OptionRender_1 = __importDefault(require("./OptionRender"));
 var SectionRender = (function () {
     function SectionRender(options) {
+        var _a;
         this.outputs = [];
         this.references = options.references;
         this.conditions = options.conditions;
@@ -22,47 +23,88 @@ var SectionRender = (function () {
         this.currentSection = options.currentSection;
         this.ovc = options.ovc;
         this.NumAuto = options.numauto;
+        this.baseIndex = (_a = options.baseIndex) !== null && _a !== void 0 ? _a : 0;
         this.renderSection();
     }
     SectionRender.prototype.getOutputs = function () {
         return this.outputs;
     };
+    SectionRender.prototype.getDocumentMultipleSource = function () {
+        var _a, _b;
+        var docMultiple = (_b = (_a = this.references.documents[this.documentName]) === null || _a === void 0 ? void 0 : _a.params) === null || _b === void 0 ? void 0 : _b.multiple;
+        if ((docMultiple === null || docMultiple === void 0 ? void 0 : docMultiple.enabled) !== true)
+            return undefined;
+        return typeof docMultiple.repeatOption === "number"
+            ? docMultiple.repeatOption
+            : undefined;
+    };
     SectionRender.prototype.renderSection = function () {
         var _this = this;
         var section = this.references.sections[this.documentName][this.currentSection];
         var conditionObject = this.references.conditions.sections[this.documentName][this.currentSection];
         var condition = conditionObject === undefined
             ? true
-            : this.conditions.executeCondition(conditionObject, 0, 0, "sections");
-        if (condition === true) {
-            section.options.forEach(function (optionId) {
-                var option = _this.references.options[optionId];
-                var repeatOption = optionId;
-                if (option.meta.type === "repeated") {
-                    if (option.meta.repeatOption === undefined)
-                        return;
-                    repeatOption =
-                        typeof option.meta.repeatOption === "number"
-                            ? option.meta.repeatOption
-                            : parseInt(option.meta.repeatOption, 10);
-                }
-                var inputs = _this.ovc.options[repeatOption] || [
-                    !["radio", "checkbox"].includes(option.meta.type),
-                ];
-                inputs.forEach(function (value, index) {
-                    if (value !== true)
-                        return;
+            : this.conditions.executeCondition(conditionObject, 0, this.baseIndex, "sections");
+        if (condition !== true)
+            return;
+        var documentMultipleSource = this.getDocumentMultipleSource();
+        section.options.forEach(function (optionId) {
+            var option = _this.references.options[optionId];
+            if (option.meta.type === "repeated" &&
+                documentMultipleSource !== undefined &&
+                option.meta.repeatOption === documentMultipleSource) {
+                option.options.forEach(function (childId) {
                     _this.outputs = __spreadArray(__spreadArray([], _this.outputs, true), new OptionRender_1.default({
                         references: _this.references,
-                        id: optionId,
+                        id: childId,
                         ovc: _this.ovc,
-                        index: index,
+                        index: _this.baseIndex,
                         conditions: _this.conditions,
                         numauto: _this.NumAuto,
                     }).getOutputs(), true);
                 });
+                return;
+            }
+            var repeatOption = optionId;
+            if (option.meta.type === "repeated") {
+                if (option.meta.repeatOption === undefined)
+                    return;
+                repeatOption =
+                    typeof option.meta.repeatOption === "number"
+                        ? option.meta.repeatOption
+                        : parseInt(option.meta.repeatOption, 10);
+            }
+            var inputs = _this.ovc.options[repeatOption] || [
+                !["radio", "checkbox"].includes(option.meta.type),
+            ];
+            if (documentMultipleSource !== undefined &&
+                option.meta.type !== "repeated") {
+                var valueAtIndex = _this.baseIndex < inputs.length ? inputs[_this.baseIndex] : inputs[0];
+                if (valueAtIndex !== true)
+                    return;
+                _this.outputs = __spreadArray(__spreadArray([], _this.outputs, true), new OptionRender_1.default({
+                    references: _this.references,
+                    id: optionId,
+                    ovc: _this.ovc,
+                    index: _this.baseIndex,
+                    conditions: _this.conditions,
+                    numauto: _this.NumAuto,
+                }).getOutputs(), true);
+                return;
+            }
+            inputs.forEach(function (value, index) {
+                if (value !== true)
+                    return;
+                _this.outputs = __spreadArray(__spreadArray([], _this.outputs, true), new OptionRender_1.default({
+                    references: _this.references,
+                    id: optionId,
+                    ovc: _this.ovc,
+                    index: index,
+                    conditions: _this.conditions,
+                    numauto: _this.NumAuto,
+                }).getOutputs(), true);
             });
-        }
+        });
     };
     return SectionRender;
 }());

package/dist/libs/misc/FillPdfFormBase.d.ts

@@ -6,11 +6,11 @@ declare class FillPdfFormBase {
     conditions: ConditionsRunner;
     ovc: InputsType;
     constructor(references: Types.ReferencesType, conditions: ConditionsRunner, ovc: InputsType);
+    private readonly conditionEvaluator;
     isVariableDisplayed(id: number, index: number): boolean;
     isOptionDisplayed(id: number, index: number): boolean;
     private getVariableCondition;
     private getOptionCondition;
     private getSectionCondition;
-    private getOptionParentSection;
 }
 export default FillPdfFormBase;

package/dist/libs/misc/FillPdfFormBase.js

@@ -1,41 +1,25 @@
 "use strict";
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
 Object.defineProperty(exports, "__esModule", { value: true });
+var referencesparser_1 = require("@legalplace/referencesparser");
 var FillPdfFormBase = (function () {
     function FillPdfFormBase(references, conditions, ovc) {
+        var _this = this;
+        this.conditionEvaluator = function (type, id, index) {
+            if (type === "options")
+                return _this.getOptionCondition(id, index);
+            if (type === "variables")
+                return _this.getVariableCondition(id, index);
+            return _this.getSectionCondition(id);
+        };
         this.references = references;
         this.conditions = conditions;
         this.ovc = ovc;
     }
     FillPdfFormBase.prototype.isVariableDisplayed = function (id, index) {
-        var _a;
-        var variableCondition = this.getVariableCondition(id, index);
-        var variableParents = ((_a = this.references.relations.variables[id]) === null || _a === void 0 ? void 0 : _a.parents) || [];
-        var parentOptionIsDisplayed = this.isOptionDisplayed(variableParents[0], index);
-        return ([variableCondition, parentOptionIsDisplayed].filter(function (c) { return c !== true; })
-            .length === 0);
+        return (0, referencesparser_1.isVariableDisplayed)(this.references, this.ovc, this.conditionEvaluator, id, index);
     };
     FillPdfFormBase.prototype.isOptionDisplayed = function (id, index) {
-        var _this = this;
-        var _a;
-        var optionCondition = this.getOptionCondition(id, index);
-        var optionParents = ((_a = this.references.relations.options[id]) === null || _a === void 0 ? void 0 : _a.parents) || [];
-        var parentsConditions = optionParents.map(function (optionId) { return _this.getOptionCondition(optionId, index) !== false; });
-        var parentsInputs = optionParents.map(function (optionId) { return _this.ovc.options[optionId][index]; });
-        var parentSectionId = this.getOptionParentSection(id);
-        var parentSectionCondition = this.getSectionCondition(parentSectionId) !== false;
-        return (__spreadArray(__spreadArray([
-            optionCondition,
-            parentSectionCondition
-        ], parentsConditions, true), parentsInputs, true).filter(function (c) { return c !== true; }).length === 0);
+        return (0, referencesparser_1.isOptionDisplayed)(this.references, this.ovc, this.conditionEvaluator, id, index);
     };
     FillPdfFormBase.prototype.getVariableCondition = function (id, index) {
         var conditionObject = this.references.conditions.variables[id];
@@ -55,16 +39,6 @@ var FillPdfFormBase = (function () {
             ? true
             : this.conditions.executeCondition(conditionObject, id, 0, "sections");
     };
-    FillPdfFormBase.prototype.getOptionParentSection = function (id) {
-        var parents = this.references.relations.options[id].parents;
-        var rootId = parents.length > 0 ? parents[parents.length - 1] : id;
-        var sections = Object.values(this.references.sections.main);
-        for (var i = 0; i < sections.length; i += 1) {
-            if (sections[i].options.includes(rootId))
-                return sections[i].id;
-        }
-        throw new Error("Cannot find parent section for option ".concat(id, " (Root option id: ").concat(rootId, ")"));
-    };
     return FillPdfFormBase;
 }());
 exports.default = FillPdfFormBase;

package/dist/libs/tableOutputExpansion.d.ts

@@ -0,0 +1,20 @@
+import type { ConditionV3 } from "@legalplace/models-v3-types";
+import type ConditionsRunner from "@legalplace/conditions-runner";
+import type { Types } from "@legalplace/referencesparser";
+import { type ExpandTableMarkupContext } from "@legalplace/referencesparser";
+import type InputsType from "@legalplace/types/dist/inputs";
+export declare const evaluateInlineTableCondition: (condition: ConditionV3, contextOptionId: number, occurrenceIndex: number, conditionsRunner: ConditionsRunner, references: Types.ReferencesType, ovc: InputsType) => boolean;
+type CreateTableMarkupContextParams = {
+    references: Types.ReferencesType;
+    ovc: InputsType;
+    conditions: ConditionsRunner;
+    contextOptionId: number;
+    defaultOccurrenceIndex: number;
+};
+export declare const createTableMarkupContext: ({ references, ovc, conditions, contextOptionId, defaultOccurrenceIndex, }: CreateTableMarkupContextParams) => ExpandTableMarkupContext;
+type ExpandOutputTableMarkupParams = CreateTableMarkupContextParams & {
+    output: string;
+};
+export declare const expandOutputTableMarkup: ({ output, references, ovc, conditions, contextOptionId, defaultOccurrenceIndex, }: ExpandOutputTableMarkupParams) => string;
+export declare const cleanupRenderedOutputHtml: (output: string) => string;
+export {};

package/dist/libs/tableOutputExpansion.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cleanupRenderedOutputHtml = exports.expandOutputTableMarkup = exports.createTableMarkupContext = exports.evaluateInlineTableCondition = void 0;
+var lplogic_1 = __importDefault(require("@legalplace/lplogic"));
+var DataPopulator_1 = __importDefault(require("@legalplace/conditions-runner/dist/DataPopulator"));
+var referencesparser_1 = require("@legalplace/referencesparser");
+var OutputParser_1 = require("./OutputParser");
+var extractVariableIds = function (html) {
+    var matches = html.match(/\[var:([0-9]+)\]/gi);
+    if (matches === null)
+        return [];
+    return Array.from(new Set(matches.map(function (tag) {
+        var idMatch = tag.match(/([0-9]+)/);
+        return idMatch ? parseInt(idMatch[1], 10) : 0;
+    }))).filter(function (id) { return id > 0; });
+};
+var evaluateInlineTableCondition = function (condition, contextOptionId, occurrenceIndex, conditionsRunner, references, ovc) {
+    var dataMap = (0, referencesparser_1.extractConditionDataMap)(condition);
+    var currentData = new DataPopulator_1.default(conditionsRunner, references, ovc, dataMap, contextOptionId, occurrenceIndex).getData();
+    var result = (0, lplogic_1.default)((0, referencesparser_1.stripConditionUiMetadata)(condition), currentData);
+    return result !== false;
+};
+exports.evaluateInlineTableCondition = evaluateInlineTableCondition;
+var createTableMarkupContext = function (_a) {
+    var references = _a.references, ovc = _a.ovc, conditions = _a.conditions, contextOptionId = _a.contextOptionId, defaultOccurrenceIndex = _a.defaultOccurrenceIndex;
+    return ({
+        defaultContextOptionId: contextOptionId,
+        defaultOccurrenceIndex: defaultOccurrenceIndex,
+        getOccurrenceInputs: function (multipleOptionId) {
+            return ovc.options[String(multipleOptionId)] || [];
+        },
+        evaluateCondition: function (condition, multipleOptionId, occurrenceIndex) {
+            return (0, exports.evaluateInlineTableCondition)(condition, multipleOptionId, occurrenceIndex, conditions, references, ovc);
+        },
+        substituteVariables: function (html, multipleOptionId, occurrenceIndex) {
+            var variableIds = extractVariableIds(html);
+            var variables = (0, OutputParser_1.getRelatedVariablesValues)(multipleOptionId, occurrenceIndex, variableIds, ovc, references);
+            return (0, OutputParser_1.parseOutputWithVariables)(html, occurrenceIndex, variables, []);
+        },
+    });
+};
+exports.createTableMarkupContext = createTableMarkupContext;
+var expandOutputTableMarkup = function (_a) {
+    var output = _a.output, references = _a.references, ovc = _a.ovc, conditions = _a.conditions, contextOptionId = _a.contextOptionId, defaultOccurrenceIndex = _a.defaultOccurrenceIndex;
+    if (!(0, referencesparser_1.hasTableDynamicMarkup)(output))
+        return output;
+    return (0, referencesparser_1.expandTableMarkup)(output, (0, exports.createTableMarkupContext)({
+        references: references,
+        ovc: ovc,
+        conditions: conditions,
+        contextOptionId: contextOptionId,
+        defaultOccurrenceIndex: defaultOccurrenceIndex,
+    }));
+};
+exports.expandOutputTableMarkup = expandOutputTableMarkup;
+var cleanupRenderedOutputHtml = function (output) {
+    if (output.includes("<table")) {
+        return output.replace(/\xA0/g, " ");
+    }
+    return output
+        .replace(/<\/([a-z]+)>([\n\s]+)</gi, "</$1><")
+        .replace(/\n/g, "<br />")
+        .replace(/\xA0/g, " ");
+};
+exports.cleanupRenderedOutputHtml = cleanupRenderedOutputHtml;

package/dist/types/types.d.ts

@@ -1,17 +1,30 @@
+import type { DocumentLayoutV3 } from "@legalplace/models-v3-types";
 export type DocumentOutputIndex = {
     name: string;
     slug: string;
     pdf: boolean;
     docx: boolean;
+    occurrenceIndex?: number;
 };
 export type DocumentPdfFormIndex = {
     name: string;
     slug: string;
     form: boolean;
     fdf: FDFType;
+    occurrenceIndex?: number;
 };
 export type DocumentIndex = Record<string, DocumentOutputIndex | DocumentPdfFormIndex>;
 export type FDFType = {
     id: string;
     fields: Record<string, string>;
 };
+export type DocumentLayout = {
+    header?: string;
+    footer?: string;
+    firstPageHeader?: string;
+    firstPageFooter?: string;
+    differentFirstPage: boolean;
+    margins?: DocumentLayoutV3["margins"];
+    headerDistance?: number;
+    footerDistance?: number;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@legalplace/prerenderx",
-  "version": "3.8.24",
+  "version": "3.9.0",
   "description": "PrerenderX",
   "main": "dist/index.js",
   "repository": "https://git.legalplace.eu/legalplace/prerenderx",
@@ -16,11 +16,11 @@
     "release": "standard-version -a --no-verify"
   },
   "dependencies": {
-    "@legalplace/conditions-runner": "^2.2.20",
-    "@legalplace/lplogic": "2.3.1",
-    "@legalplace/models-v3-types": "^5.17.22",
-    "@legalplace/ovc-converter": "^2.2.20",
-    "@legalplace/referencesparser": "^3.2.42",
+    "@legalplace/conditions-runner": "^2.3.0",
+    "@legalplace/lplogic": "2.3.3",
+    "@legalplace/models-v3-types": "^5.18.0",
+    "@legalplace/ovc-converter": "^2.2.21",
+    "@legalplace/referencesparser": "^3.3.0",
     "@legalplace/yousign": "^0.9.23",
     "crypto": "^1.0.1"
   },
@@ -29,7 +29,7 @@
     "@babel/preset-typescript": "^7.7.2",
     "@legalplace/eslint-config-base": "^1.2.0",
     "@legalplace/prettier-config": "^2.1.3",
-    "@legalplace/types": "^2.22.12",
+    "@legalplace/types": "^2.22.13",
     "@types/jest": "^24.0.15",
     "jest": "^24.8.0",
     "redux-mock-store": "^1.5.3",
@@ -37,5 +37,5 @@
     "ts-jest": "^24.0.2"
   },
   "prettier": "@legalplace/prettier-config",
-  "gitHead": "717a08baa101e1dcdead28714410c726f6cf9166"
+  "gitHead": "5b5eed67e9a7815f5fa77492782158fa6af0ca13"
 }

package/src/libs/DocumentRender.ts

@@ -1,5 +1,9 @@
-import type { Types } from "@legalplace/referencesparser";
 import type ConditionsRunner from "@legalplace/conditions-runner";
+import {
+  getSectionIdsForRole,
+  type OutputRegionRole,
+  type Types,
+} from "@legalplace/referencesparser";
 import type InputsType from "@legalplace/types/dist/inputs";
 import SectionRender from "./SectionRender";
 import type NumAuto from "./NumAuto";
@@ -25,18 +29,42 @@ class DocumentRender {
     this.NumAuto = numauto;
   }
 
-  public renderDocument(documentName: string) {
+  /**
+   * Renders a document body. When `baseIndex` is provided (document multiple),
+   * the index is propagated through the section/option render pipeline
+   * so that variables referenced anywhere in the document resolve at the
+   * correct occurrence.
+   */
+  public renderDocument(documentName: string, baseIndex = 0) {
+    return this.renderRegion(documentName, "body", baseIndex);
+  }
+
+  /**
+   * Renders a document output region (body, header, footer, first page variants).
+   */
+  public renderRegion(
+    documentName: string,
+    role: OutputRegionRole,
+    baseIndex = 0
+  ) {
     const documentOutputs: string[] = [];
-    this.NumAuto.resetIndexes();
-    Object.keys(this.references.sections[documentName]).forEach((sectionId) => {
+    if (role === "body") this.NumAuto.resetIndexes();
+
+    const sectionIds = getSectionIdsForRole(
+      this.references.sections[documentName],
+      role
+    );
+
+    sectionIds.forEach((sectionId) => {
       documentOutputs.push(
         ...new SectionRender({
           references: this.references,
           conditions: this.conditions,
           documentName,
           ovc: this.ovc,
-          currentSection: parseInt(sectionId, 10),
+          currentSection: sectionId,
           numauto: this.NumAuto,
+          baseIndex,
         }).getOutputs()
       );
     });

package/src/libs/FillPdfForm.ts

@@ -6,7 +6,13 @@ type FDFType = {
   fields: Record<string, string>;
 };
 class FillPdfForm extends FillPdfFormBase {
-  public fillDocument(documentName: string) {
+  /**
+   * Fills a PDF form template with values from `ovc`. When `baseIndex` is
+   * provided (document multiple), variables and options are read at that
+   * occurrence index instead of always reading slot 0. Each occurrence of
+   * a multiple PDF form document yields its own filled FDF.
+   */
+  public fillDocument(documentName: string, baseIndex = 0) {
     const result: FDFType = {
       id: "",
       fields: {},
@@ -24,13 +30,13 @@ class FillPdfForm extends FillPdfFormBase {
     // Filling inputs
     form.inputs.forEach((input) => {
       const id = `${input.name}`;
-      result.fields[id] = this.getInputValue(input);
+      result.fields[id] = this.getInputValue(input, baseIndex);
     });
 
     // Filling boxes
     form.boxes.forEach((box) => {
       const id = `${box.name}`;
-      const value = this.getBoxValue(box);
+      const value = this.getBoxValue(box, baseIndex);
       if (
         !(
           value === "" &&
@@ -44,13 +50,14 @@ class FillPdfForm extends FillPdfFormBase {
   }
 
   /**
-   * Returns an input value
+   * Returns an input value at the given occurrence `index`.
    * @param input Input
+   * @param index Occurrence index (defaults to 0)
    */
-  private getInputValue(input: FDFInputsV3): string {
+  private getInputValue(input: FDFInputsV3, index = 0): string {
     for (let i = 0; i < input.variables.length; i += 1) {
       const variable = input.variables[i];
-      const currentValue = this.getVariableValue(variable.id);
+      const currentValue = this.getVariableValue(variable.id, index);
 
       if (currentValue !== false) {
         // Date values
@@ -110,13 +117,14 @@ class FillPdfForm extends FillPdfFormBase {
   }
 
   /**
-   * Return a box value
+   * Return a box value at the given occurrence `index`.
    * @param box Box
+   * @param index Occurrence index (defaults to 0)
    */
-  private getBoxValue(box: FDFBoxesV3): string {
+  private getBoxValue(box: FDFBoxesV3, index = 0): string {
     for (let i = 0; i < box.options.length; i += 1) {
       const option = box.options[i];
-      const currentValue = this.getOptionValue(option.id);
+      const currentValue = this.getOptionValue(option.id, index);
 
       if (currentValue === true) {
         if (
@@ -132,25 +140,34 @@ class FillPdfForm extends FillPdfFormBase {
   }
 
   /**
-   * Returns a variable's value
+   * Returns a variable's value at the given occurrence `index`. Falls back
+   * to slot 0 when the requested index is missing (e.g. a non-multiple
+   * variable inside a multiple document).
    */
-  private getVariableValue(variableId: number) {
-    // Checking if variable is displayed
-    if (this.isVariableDisplayed(variableId, 0) === false) return false;
+  private getVariableValue(variableId: number, index = 0) {
+    // Checking if variable is displayed at the given occurrence
+    if (this.isVariableDisplayed(variableId, index) === false) return false;
 
-    // Returning variable's value
-    return (this.ovc.variables[variableId]?.[0] || "").toString();
+    const variableValues = this.ovc.variables[variableId];
+    const value =
+      variableValues?.[index] !== undefined
+        ? variableValues[index]
+        : variableValues?.[0] || "";
+
+    return (value ?? "").toString();
   }
 
   /**
-   * Returns a option's value
+   * Returns an option's boolean value at the given occurrence `index`.
    */
-  private getOptionValue(optionId: number) {
-    // Checking if option is displayed
-    if (this.isOptionDisplayed(optionId, 0) === false) return false;
-
-    // Returning option's value
-    return this.ovc.options[optionId]?.[0] === true;
+  private getOptionValue(optionId: number, index = 0) {
+    // Checking if option is displayed at the given occurrence
+    if (this.isOptionDisplayed(optionId, index) === false) return false;
+
+    const optionValues = this.ovc.options[optionId];
+    return optionValues?.[index] !== undefined
+      ? optionValues[index] === true
+      : optionValues?.[0] === true;
   }
 }