abstract-document 17.0.7 → 17.0.9

package/src/abstract-document-exporters/pdf/paginate.ts

@@ -3,13 +3,17 @@ import { getResources } from "../shared/get_resources.js";
 import { registerFonts } from "./font.js";
 import { measureTable } from "./measure.js";
 
+export interface PageColumn {
+  readonly elements: ReadonlyArray<AD.SectionElement.SectionElement>;
+}
+
 export interface Page {
   readonly pageNo: number;
   readonly namedDestionations: ReadonlyArray<string>;
   readonly pageOptions: any;
   readonly section: AD.Section.Section;
   readonly contentRect: AD.Rect.Rect;
-  readonly elements: ReadonlyArray<AD.SectionElement.SectionElement>;
+  readonly columns: ReadonlyArray<PageColumn>;
   readonly header: ReadonlyArray<AD.SectionElement.SectionElement>;
   readonly footer: ReadonlyArray<AD.SectionElement.SectionElement>;
 }
@@ -26,13 +30,13 @@ export function paginate(
   const pages = new Array<Page>();
   for (let section of document.children) {
     const previousPage = pages.length > 0 ? pages[pages.length - 1] : undefined;
-    pages.push(...splitSection(pdfKit, document, resources, desiredSizes, previousPage, section));
+    pages.push(...paginateSection(pdfKit, document, resources, desiredSizes, previousPage, section));
   }
 
   return pages;
 }
 
-function splitSection(
+function paginateSection(
   pdfKit: PDFKit.PDFDocument,
   document: AD.AbstractDoc.AbstractDoc,
   parentResources: AD.Resources.Resources,
@@ -44,6 +48,7 @@ function splitSection(
   const pages = new Array<Page>();
 
   let children = section.children;
+  let columns = new Array<PageColumn>();
   let elements = new Array<AD.SectionElement.SectionElement>();
   let elementsHeight = 0;
   let currentPage = previousPage;
@@ -51,8 +56,10 @@ function splitSection(
     const contentRect = getPageContentRect(desiredSizes, section, pages.length + 1);
     const element = children[i];
     if (element.type === "PageBreak") {
-      currentPage = createPage(resources, desiredSizes, currentPage, section, elements, pages.length === 0);
+      columns.push({ elements });
+      currentPage = createPage(resources, desiredSizes, currentPage, section, columns, pages.length === 0);
       pages.push(currentPage);
+      columns = [];
       elements = [];
       elementsHeight = 0;
       continue;
@@ -103,28 +110,26 @@ function splitSection(
 
         //Add split table to children to process tableTail in next iteration
         children = [...children.slice(0, i), ...tableSplit, ...children.slice(i + 1)];
-
-        currentPage = createPage(resources, desiredSizes, currentPage, section, elements, pages.length === 0);
-        pages.push(currentPage);
-        elements = [];
-        elementsHeight = 0;
-
-        continue;
-      }
-
-      if (elements.length > 1) {
+      } else if (elements.length > 1) {
         elements.pop();
         i--;
       }
-      currentPage = createPage(resources, desiredSizes, currentPage, section, elements, pages.length === 0);
-      pages.push(currentPage);
+
+      columns.push({ elements });
       elements = [];
       elementsHeight = 0;
+
+      if (columns.length === section.page.style.columnLayout.columnCount) {
+        currentPage = createPage(resources, desiredSizes, currentPage, section, columns, pages.length === 0);
+        pages.push(currentPage);
+        columns = [];
+      }
     }
   }
 
   if (elements.length > 0) {
-    pages.push(createPage(resources, desiredSizes, currentPage, section, elements, pages.length === 0));
+    columns.push({ elements });
+    pages.push(createPage(resources, desiredSizes, currentPage, section, columns, pages.length === 0));
   }
 
   return pages;
@@ -191,7 +196,7 @@ function createPage(
   desiredSizes: Map<{}, AD.Size.Size>,
   previousPage: Page | undefined,
   section: AD.Section.Section,
-  elements: ReadonlyArray<AD.SectionElement.SectionElement>,
+  columns: ReadonlyArray<PageColumn>,
   isFirst: boolean
 ): Page {
   const style = section.page.style;
@@ -210,33 +215,55 @@ function createPage(
   };
   const pageNo = previousPage ? previousPage.pageNo + 1 : 1;
 
+  const namedDestionations = [];
+
   const sectionName = isFirst && section.id !== "" ? [section.id] : [];
+  namedDestionations.push(...sectionName);
+
   // For now, only support link targets at base level. Tree search would be needed to find all targets.
-  const targetNames = elements
-    .flatMap((e) => (e.type === "Paragraph" ? e.children.map((c) => (c.type === "LinkTarget" ? c.name : "")) : []))
-    .filter((t) => t !== "");
-  const namedDestionations = [...sectionName, ...targetNames];
+  for (const { elements } of columns) {
+    const targetNames = elements
+      .flatMap((e) => (e.type === "Paragraph" ? e.children.map((c) => (c.type === "LinkTarget" ? c.name : "")) : []))
+      .filter((t) => t !== "");
+    namedDestionations.push(...targetNames);
+  }
 
   // Ignore leading space by expanding the content rect upwards
   const rect = getPageContentRect(desiredSizes, section, pageNo);
-  const [leadingSpace] = getLeadingAndTrailingSpace(resources, section, elements);
+  let leadingSpace = undefined;
+  for (const { elements } of columns) {
+    const [columnLeadingSpace] = getLeadingAndTrailingSpace(resources, section, elements);
+    leadingSpace = Math.min(leadingSpace ?? columnLeadingSpace, columnLeadingSpace);
+  }
+  leadingSpace ||= 0;
   const contentRect = AD.Rect.create(rect.x, rect.y - leadingSpace, rect.width, rect.height + leadingSpace);
 
-  const frontHeader = (section.page.frontHeader === undefined || section.page.frontHeader.length === 0) ? section.page.header : section.page.frontHeader;
-  const frontFooter = (section.page.frontFooter === undefined || section.page.frontFooter.length === 0) ? section.page.footer : section.page.frontFooter;
+  const frontHeader =
+    section.page.frontHeader === undefined || section.page.frontHeader.length === 0
+      ? section.page.header
+      : section.page.frontHeader;
+
+  const frontFooter =
+    section.page.frontFooter === undefined || section.page.frontFooter.length === 0
+      ? section.page.footer
+      : section.page.frontFooter;
+
   return {
     pageNo: pageNo,
     namedDestionations: namedDestionations,
     pageOptions: pageOptions,
     section: section,
     contentRect: contentRect,
-    elements: elements,
+    columns: columns,
     header: isFirst ? frontHeader : section.page.header,
     footer: isFirst ? frontFooter : section.page.footer,
   };
 }
 
-export function getHeaderAndFooter(section: AD.Section.Section, pageNo: number): {
+export function getHeaderAndFooter(
+  section: AD.Section.Section,
+  pageNo: number
+): {
   readonly header: Array<AD.SectionElement.SectionElement>;
   readonly footer: Array<AD.SectionElement.SectionElement>;
   readonly headerMargins: AD.LayoutFoundation.LayoutFoundation;
@@ -245,7 +272,7 @@ export function getHeaderAndFooter(section: AD.Section.Section, pageNo: number):
   const FIRST_PAGE = 1;
   const EVEN_PAGE = 0;
   const ODD_PAGE = 1;
-  switch(true) {
+  switch (true) {
     //first page
     case pageNo === FIRST_PAGE: {
       const normalHeader = section.page.frontHeader === undefined || section.page.frontHeader.length === 0;
@@ -253,8 +280,12 @@ export function getHeaderAndFooter(section: AD.Section.Section, pageNo: number):
       return {
         footer: normalFooter ? section.page.footer : section.page.frontFooter,
         header: normalHeader ? section.page.header : section.page.frontHeader,
-        headerMargins: normalHeader ? section.page.style.headerMargins : (section.page.style.firstPageHeaderMargins ?? section.page.style.headerMargins),
-        footerMargins: normalFooter ? section.page.style.footerMargins : (section.page.style.firstPageFooterMargins ?? section.page.style.footerMargins),
+        headerMargins: normalHeader
+          ? section.page.style.headerMargins
+          : section.page.style.firstPageHeaderMargins ?? section.page.style.headerMargins,
+        footerMargins: normalFooter
+          ? section.page.style.footerMargins
+          : section.page.style.firstPageFooterMargins ?? section.page.style.footerMargins,
       };
     }
     case pageNo === 0:
@@ -266,12 +297,16 @@ export function getHeaderAndFooter(section: AD.Section.Section, pageNo: number):
         footer: section.page.footer,
         headerMargins: section.page.style.headerMargins,
         footerMargins: section.page.style.footerMargins,
-      }
+      };
     }
   }
 }
 
-function getPageContentRect(desiredSizes: Map<{}, AD.Size.Size>, section: AD.Section.Section, pageNo: number): AD.Rect.Rect {
+function getPageContentRect(
+  desiredSizes: Map<{}, AD.Size.Size>,
+  section: AD.Section.Section,
+  pageNo: number
+): AD.Rect.Rect {
   const style = section.page.style;
   const pageWidth = AD.PageStyle.getWidth(style);
   const pageHeight = AD.PageStyle.getHeight(style);

package/src/abstract-document-exporters/pdf/pre-process.ts

@@ -55,7 +55,7 @@ function preProcessSection(s: AD.Section.Section, parentResources: AD.Resources.
   const frontHeader = (s.page.frontHeader ?? []).flatMap((e) => preProcessSectionElement(e, resources));
   const frontFooter = (s.page.frontFooter ?? []).flatMap((e) => preProcessSectionElement(e, resources));
   const page = AD.MasterPage.create({
-    style: s.page.style,
+    style: AD.PageStyle.create(s.page.style),
     header: header,
     footer: footer,
     frontHeader: frontHeader,

package/src/abstract-document-exporters/pdf/render.ts

@@ -124,19 +124,24 @@ function renderPage(
   }
 
   const elementStart = contentRect.y;
-  let y = elementStart;
-  for (const element of page.elements) {
-    const elementSize = getDesiredSize(element, desiredSizes);
-    const isAbsolute = AD.Position.isPositionAbsolute(element);
-    renderSectionElement(
-      resources,
-      pdfKit,
-      desiredSizes,
-      AD.Rect.create(contentRect.x, isAbsolute ? elementStart : y, elementSize.width, elementSize.height),
-      element
-    );
-    if (!isAbsolute) {
-      y += elementSize.height;
+  const columnStep =
+    contentRect.width / section.page.style.columnLayout.columnCount + section.page.style.columnLayout.columnGap;
+  for (let columnIndex = 0; columnIndex < page.columns.length; columnIndex++) {
+    const x = contentRect.x + columnStep * columnIndex;
+    let y = elementStart;
+    for (const element of page.columns[columnIndex].elements) {
+      const elementSize = getDesiredSize(element, desiredSizes);
+      const isAbsolute = AD.Position.isPositionAbsolute(element);
+      renderSectionElement(
+        resources,
+        pdfKit,
+        desiredSizes,
+        AD.Rect.create(x, isAbsolute ? elementStart : y, elementSize.width, elementSize.height),
+        element
+      );
+      if (!isAbsolute) {
+        y += elementSize.height;
+      }
     }
   }
 }
@@ -284,14 +289,21 @@ function renderParagraph(
   let y = finalRect.y + style.margins.top;
   const alignment = parseAlignment(style.alignment);
   const newRows = rowsSplit(rows, availableWidth, desiredSizes, alignment);
-  const { newDesiredSizes, combinedRows } = rowsCombineTextRuns(resources, pdfKit, newRows, desiredSizes, alignment, style.textStyle);
+  const { newDesiredSizes, combinedRows } = rowsCombineTextRuns(
+    resources,
+    pdfKit,
+    newRows,
+    desiredSizes,
+    alignment,
+    style.textStyle
+  );
   for (let r = 0; r < combinedRows.length; r++) {
     const row = combinedRows[r];
     const isLast = r === combinedRows.length - 1;
     if (row.length === 0) {
       continue;
     }
-    
+
     const rowWidth = row.reduce((a, b) => a + getDesiredSize(b, newDesiredSizes).width, 0);
     const remainingWidth = availableWidth - rowWidth;
     const justificationWidth = !isLast && row.length > 1 ? remainingWidth / (row.length - 1) : 0;
@@ -368,16 +380,7 @@ function renderAtom(
 ): void {
   switch (atom.type) {
     case "TextField":
-      renderTextField(
-        resources,
-        pdfKit,
-        finalRect,
-        textStyle,
-        atom,
-        alignment,
-        isFirstAtom,
-        isLastAtom,
-      );
+      renderTextField(resources, pdfKit, finalRect, textStyle, atom, alignment, isFirstAtom, isLastAtom);
       return;
     case "TextRun":
       renderTextRun(resources, pdfKit, finalRect, textStyle, atom, alignment, isFirstAtom, isLastAtom);
@@ -416,7 +419,7 @@ function renderTextField(
   textField: AD.TextField.TextField,
   alignment: PdfKitAlignment,
   isFirstAtom: boolean,
-  isLastAtom: boolean,
+  isLastAtom: boolean
 ): void {
   const style = AD.Resources.getStyle(
     textStyle,
@@ -427,15 +430,7 @@ function renderTextField(
   ) as AD.TextStyle.TextStyle;
   switch (textField.fieldType) {
     case "Date":
-      drawText(
-        pdfKit,
-        finalRect,
-        style,
-        new Date(Date.now()).toDateString(),
-        alignment,
-        isFirstAtom,
-        isLastAtom,
-      );
+      drawText(pdfKit, finalRect, style, new Date(Date.now()).toDateString(), alignment, isFirstAtom, isLastAtom);
       return;
     case "PageNumber":
     case "TotalPages":
@@ -455,7 +450,7 @@ function renderTextRun(
   textRun: AD.TextRun.TextRun,
   alignment: PdfKitAlignment,
   isFirstAtom: boolean,
-  isLastAtom: boolean,
+  isLastAtom: boolean
 ): void {
   const style = AD.Resources.getNestedStyle(
     textStyle,
@@ -625,7 +620,7 @@ function drawText(
   text: string,
   alignment: PdfKitAlignment,
   isFirst: boolean,
-  isEnd: boolean,
+  isEnd: boolean
 ): void {
   const font = getFontNameStyle(textStyle);
   const fontSize = AD.TextStyle.calculateFontSize(textStyle, 10);
@@ -635,7 +630,7 @@ function drawText(
     .fillColor(textStyle.color || "black", textStyle.opacity ?? 1.0);
   applyTextOffset(pdf, textStyle);
 
-  switch(alignment) {
+  switch (alignment) {
     case "justify": {
       pdf.text(text, finalRect.x, finalRect.y, {
         width: Infinity,
@@ -644,14 +639,14 @@ function drawText(
         indent: textStyle.indent || 0,
         baseline: textStyle.baseline || "top",
         strike: textStyle.strike,
-          ...(textStyle.characterSpacing !== undefined ? { characterSpacing: textStyle.characterSpacing } : {}),
-          ...(textStyle.lineGap !== undefined ? { lineGap: textStyle.lineGap } : {}),
+        ...(textStyle.characterSpacing !== undefined ? { characterSpacing: textStyle.characterSpacing } : {}),
+        ...(textStyle.lineGap !== undefined ? { lineGap: textStyle.lineGap } : {}),
       });
       break;
     }
 
     default: {
-      if(isFirst) {
+      if (isFirst) {
         pdf.text(text, finalRect.x, finalRect.y, {
           width: Infinity,
           underline: textStyle.underline || false,
@@ -659,8 +654,8 @@ function drawText(
           indent: textStyle.indent || 0,
           baseline: textStyle.baseline || "top",
           strike: textStyle.strike,
-            ...(textStyle.characterSpacing !== undefined ? { characterSpacing: textStyle.characterSpacing } : {}),
-            ...(textStyle.lineGap !== undefined ? { lineGap: textStyle.lineGap } : {}),
+          ...(textStyle.characterSpacing !== undefined ? { characterSpacing: textStyle.characterSpacing } : {}),
+          ...(textStyle.lineGap !== undefined ? { lineGap: textStyle.lineGap } : {}),
         });
       } else {
         pdf.text(text, {
@@ -670,8 +665,8 @@ function drawText(
           indent: textStyle.indent || 0,
           baseline: textStyle.baseline || "top",
           strike: textStyle.strike,
-            ...(textStyle.characterSpacing !== undefined ? { characterSpacing: textStyle.characterSpacing } : {}),
-            ...(textStyle.lineGap !== undefined ? { lineGap: textStyle.lineGap } : {}),
+          ...(textStyle.characterSpacing !== undefined ? { characterSpacing: textStyle.characterSpacing } : {}),
+          ...(textStyle.lineGap !== undefined ? { lineGap: textStyle.lineGap } : {}),
         });
       }
       break;

package/src/abstract-document-exporters/pdf/update-refs.ts

@@ -6,12 +6,12 @@ export function updatePageRefs(pages: ReadonlyArray<Page>): Array<Page> {
 }
 
 export function updateRefsOnPage(page: Page, pages: ReadonlyArray<Page>): Page {
-  const updatedElements = updateRefsInElements(page.elements, page, pages);
+  const updatedColumns = page.columns.map((c) => ({ ...c, elements: updateRefsInElements(c.elements, page, pages) }));
   const updatedHeader = updateRefsInElements(page.header, page, pages);
   const updatedFooter = updateRefsInElements(page.footer, page, pages);
   return {
     ...page,
-    elements: updatedElements,
+    columns: updatedColumns,
     header: updatedHeader,
     footer: updatedFooter,
   };

package/src/abstract-document-xml/xsd-template/styles.ts

@@ -237,6 +237,7 @@ export const masterPageStyle = `<xs:complexType name="MasterPageStyle">
 		<xs:element name="firstPageHeaderMargins" type="LayoutFoundation" minOccurs="0" />
 		<xs:element name="firstPageFooterMargins" type="LayoutFoundation" minOccurs="0" />
 		<xs:element name="contentMargins" type="LayoutFoundation" />
+		<xs:element name="columnLayout" type="PageColumnLayout" minOccurs="0" maxOccurs="1" />
 	</xs:all>
 	<xs:attribute name="paperSize" use="required">
 		<xs:simpleType>
@@ -276,3 +277,8 @@ export const layoutFoundation = `<xs:complexType name="LayoutFoundation">
 	<xs:attribute name="left" type="xs:decimal" />
 	<xs:attribute name="right" type="xs:decimal" />
 </xs:complexType>`;
+
+export const pageColumnLayout = `<xs:complexType name="PageColumnLayout">
+	<xs:attribute name="columnCount" type="xs:decimal" />
+	<xs:attribute name="columnGap" type="xs:decimal" />
+</xs:complexType>`;

package/src/abstract-document-xml/xsd-template/xsd-template.ts

@@ -4,6 +4,7 @@ import * as CustomElements from "./custom-elements.js";
 import { parseXsd } from "handlebars-xml";
 
 const commonParts = `${Styles.layoutFoundation}
+${Styles.pageColumnLayout}
 ${Elements.section}
 ${Elements.sectionElement}
 ${Elements.headerFooter}