@legalplace/prerenderx 3.8.24 → 3.9.0

package/tests/Prerender.documentMultiple.test.ts

@@ -0,0 +1,278 @@
+import type { ModelV3 } from "@legalplace/models-v3-types";
+import Prerender from "../src/libs/Prerender";
+
+/**
+ * Builds a Model V3 with one document `main` configured as multiple
+ * (`params.multiple.enabled = true`, source = option #2). The output
+ * `[var:3]` interpolates the partner name at each occurrence.
+ */
+const buildMultipleDocumentModel = (
+  filenameTemplate?: string
+): ModelV3 => ({
+  documents: {
+    main: {
+      name: "Contract",
+      sections: [
+        {
+          id: 1,
+          label: "Section",
+          options: [2, 5],
+        },
+      ],
+      params: {
+        multiple: {
+          enabled: true,
+          repeatOption: 2,
+          ...(filenameTemplate ? { filenameTemplate } : {}),
+        },
+      },
+    },
+  },
+  options: {
+    "2": {
+      meta: {
+        id: 2,
+        type: "static",
+        label: "Partner",
+        step: "*",
+        multiple: {
+          enabled: true,
+          incrementationStart: 1,
+        },
+      },
+      options: [],
+      variables: [3],
+    },
+    "5": {
+      meta: {
+        id: 5,
+        type: "hidden",
+        label: "Body",
+        step: "*",
+        output: "<p>Hello [var:3]</p>",
+      },
+      options: [],
+      variables: [3],
+    },
+  },
+  variables: {
+    "3": {
+      id: 3,
+      type: "text",
+      label: "Partner name",
+      step: "*",
+    },
+  },
+  customization: {},
+});
+
+const ovcWithThreePartners = {
+  options: {
+    "2": [true, true, true],
+  },
+  variables: {
+    "3": ["Alice", "Bob", "Charlie"],
+  },
+};
+
+describe("Prerender — document multiple", () => {
+  it("emits one entry per occurrence with distinct hashes", () => {
+    const prerender = new Prerender(
+      buildMultipleDocumentModel(),
+      ovcWithThreePartners
+    );
+
+    const index = prerender.getDocumentsIndex();
+    const entries = Object.entries(index);
+
+    expect(entries).toHaveLength(3);
+    const slugs = entries.map(([, e]) => e.slug);
+    expect(slugs).toEqual(["main", "main", "main"]);
+
+    const occurrenceIndexes = entries.map(([, e]) => e.occurrenceIndex);
+    expect(occurrenceIndexes.sort()).toEqual([0, 1, 2]);
+
+    // Hashes must be distinct across occurrences
+    const hashes = entries.map(([h]) => h);
+    expect(new Set(hashes).size).toBe(hashes.length);
+  });
+
+  it("uses the document title for each occurrence when no template is set", () => {
+    const prerender = new Prerender(
+      buildMultipleDocumentModel(),
+      ovcWithThreePartners
+    );
+    const index = prerender.getDocumentsIndex();
+    const names = Object.values(index)
+      .map((e) => e.name)
+      .sort();
+
+    expect(names).toEqual(["Contract", "Contract", "Contract"]);
+  });
+
+  it("interpolates document name with variables at each occurrence", () => {
+    const model = buildMultipleDocumentModel();
+    model.documents.main.name = "Contract - [var:3]";
+    if (model.documents.main.params?.multiple) {
+      delete model.documents.main.params.multiple.filenameTemplate;
+    }
+
+    const prerender = new Prerender(model, ovcWithThreePartners);
+    const index = prerender.getDocumentsIndex();
+    const names = Object.values(index)
+      .map((e) => e.name)
+      .sort();
+
+    expect(names).toEqual([
+      "Contract - Alice",
+      "Contract - Bob",
+      "Contract - Charlie",
+    ]);
+  });
+
+  it("interpolates filenameTemplate with the variable value at each occurrence", () => {
+    const prerender = new Prerender(
+      buildMultipleDocumentModel("Contract - [var:3]"),
+      ovcWithThreePartners
+    );
+    const index = prerender.getDocumentsIndex();
+    const names = Object.values(index)
+      .map((e) => e.name)
+      .sort();
+
+    expect(names).toEqual([
+      "Contract - Alice",
+      "Contract - Bob",
+      "Contract - Charlie",
+    ]);
+  });
+
+  it("renders the body with the right variable for each occurrence", () => {
+    const prerender = new Prerender(
+      buildMultipleDocumentModel(),
+      ovcWithThreePartners
+    );
+    const index = prerender.getDocumentsIndex();
+
+    const entries = Object.entries(index).sort(
+      (a, b) =>
+        ((a[1].occurrenceIndex ?? 0) as number) -
+        ((b[1].occurrenceIndex ?? 0) as number)
+    );
+
+    const rendered = entries.map(([hash]) =>
+      prerender.getDocument(hash) as string
+    );
+
+    expect(rendered[0]).toContain("Hello Alice");
+    expect(rendered[1]).toContain("Hello Bob");
+    expect(rendered[2]).toContain("Hello Charlie");
+  });
+
+  it("returns a single entry when params.multiple.enabled is false", () => {
+    const model = buildMultipleDocumentModel();
+    if (model.documents.main.params?.multiple) {
+      model.documents.main.params.multiple.enabled = false;
+    }
+
+    const prerender = new Prerender(model, ovcWithThreePartners);
+    const index = prerender.getDocumentsIndex();
+
+    expect(Object.keys(index)).toHaveLength(1);
+    const [entry] = Object.values(index);
+    expect(entry.slug).toBe("main");
+    // No occurrenceIndex when not multiple
+    expect(entry.occurrenceIndex).toBeUndefined();
+  });
+
+  it("emits only related occurrences that pass a selected document condition", () => {
+    const model: ModelV3 = {
+      documents: {
+        main: {
+          name: "Main",
+          sections: [
+            {
+              id: 1,
+              label: "Section",
+              options: [2],
+            },
+          ],
+        },
+        annex: {
+          name: "Annex",
+          sections: [
+            {
+              id: 2,
+              label: "Annex section",
+              options: [],
+            },
+          ],
+          params: {
+            multiple: {
+              enabled: true,
+              repeatOption: 2,
+            },
+            conditions: {
+              selected: [{ var: "o.3" }],
+              scope: "related",
+            },
+          },
+        },
+      },
+      options: {
+        "2": {
+          meta: {
+            id: 2,
+            type: "static",
+            label: "Partner",
+            step: "*",
+            multiple: {
+              enabled: true,
+              incrementationStart: 1,
+            },
+          },
+          options: [3, 4],
+          variables: [],
+        },
+        "3": {
+          meta: {
+            id: 3,
+            type: "radio",
+            label: "Yes",
+            step: "*",
+          },
+          options: [],
+          variables: [],
+        },
+        "4": {
+          meta: {
+            id: 4,
+            type: "radio",
+            label: "No",
+            step: "*",
+          },
+          options: [],
+          variables: [],
+        },
+      },
+      variables: {},
+      customization: {},
+    };
+
+    const prerender = new Prerender(model, {
+      options: {
+        "2": [true, true],
+        "3": [true, false],
+        "4": [false, true],
+      },
+      variables: {},
+    });
+
+    const annexEntries = Object.values(prerender.getDocumentsIndex()).filter(
+      (entry) => entry.slug === "annex"
+    );
+
+    expect(annexEntries).toHaveLength(1);
+    expect(annexEntries[0].occurrenceIndex).toBe(0);
+  });
+});

package/tests/Prerender.repeated.test.ts

@@ -0,0 +1,115 @@
+import type { ModelV3 } from "@legalplace/models-v3-types";
+import Prerender from "../src/libs/Prerender";
+
+/**
+ * Builds a Model V3 whose body is a `repeated` block linked to multiple
+ * option #2. The hidden child interpolates `[var:3]` at each occurrence.
+ *
+ * @param multipleType Type of the linked multiple source option
+ */
+const buildRepeatedContentModel = (
+  multipleType: "static" | "checkbox" = "static"
+): ModelV3 => ({
+  documents: {
+    main: {
+      name: "Contract",
+      sections: [
+        {
+          id: 1,
+          label: "Section",
+          options: [10],
+        },
+      ],
+    },
+  },
+  options: {
+    "2": {
+      meta: {
+        id: 2,
+        type: multipleType,
+        label: "Partner",
+        step: "*",
+        multiple: {
+          enabled: true,
+          incrementationStart: 1,
+        },
+      },
+      options: [],
+      variables: [3],
+    },
+    "10": {
+      meta: {
+        id: 10,
+        type: "repeated",
+        label: "Repeated partners",
+        step: "*",
+        repeatOption: 2,
+      },
+      options: [11],
+      variables: [],
+    },
+    "11": {
+      meta: {
+        id: 11,
+        type: "hidden",
+        label: "Partner line",
+        step: "*",
+        output: "<p>Hello [var:3]</p>",
+      },
+      options: [],
+      variables: [3],
+    },
+  },
+  variables: {
+    "3": {
+      id: 3,
+      type: "text",
+      label: "Partner name",
+      step: "*",
+    },
+  },
+  customization: {},
+});
+
+const ovcWithThreePartners = {
+  options: {
+    "2": [true, true, true],
+  },
+  variables: {
+    "3": ["Alice", "Bob", "Charlie"],
+  },
+};
+
+describe("Prerender — repeated content", () => {
+  it("renders every occurrence of a repeated block", () => {
+    const prerender = new Prerender(
+      buildRepeatedContentModel(),
+      ovcWithThreePartners
+    );
+    const index = prerender.getDocumentsIndex();
+    const [hash] = Object.keys(index);
+    const rendered = prerender.getDocument(hash) as string;
+
+    expect(rendered).toContain("Hello Alice");
+    expect(rendered).toContain("Hello Bob");
+    expect(rendered).toContain("Hello Charlie");
+  });
+
+  it("skips inactive occurrences of the linked multiple", () => {
+    const prerender = new Prerender(buildRepeatedContentModel("checkbox"), {
+      options: {
+        "2": [true, false, true],
+      },
+      variables: {
+        "3": ["Alice", "Bob", "Charlie"],
+      },
+    });
+    const index = prerender.getDocumentsIndex();
+    const [hash] = Object.keys(index);
+    const rendered = prerender.getDocument(hash) as string;
+
+    expect(rendered).toContain("Hello Alice");
+    expect(rendered).not.toContain("Hello Bob");
+    expect(rendered).toContain("Hello Charlie");
+  });
+});