abstract-document 20.0.3 → 20.1.0

package/src/abstract-document-exporters/pdf/header-footer.ts

@@ -0,0 +1,43 @@
+import * as AD from "../../abstract-document/index.js";
+
+export function getHeaderAndFooter(
+  section: AD.Section.Section,
+  pageNo: number
+): {
+  readonly header: Array<AD.SectionElement.SectionElement>;
+  readonly footer: Array<AD.SectionElement.SectionElement>;
+  readonly headerMargins: Required<AD.LayoutFoundation.LayoutFoundation>;
+  readonly footerMargins: Required<AD.LayoutFoundation.LayoutFoundation>;
+} {
+  const FIRST_PAGE = 1;
+  const EVEN_PAGE = 0;
+  const ODD_PAGE = 1;
+  switch (true) {
+    //first page
+    case pageNo === FIRST_PAGE: {
+      const normalHeader = section.page.frontHeader === undefined || section.page.frontHeader.length === 0;
+      const normalFooter = section.page.frontFooter === undefined || section.page.frontFooter.length === 0;
+      return {
+        footer: normalFooter ? section.page.footer : section.page.frontFooter,
+        header: normalHeader ? section.page.header : section.page.frontHeader,
+        headerMargins: AD.LayoutFoundation.orDefault(
+          normalHeader ? section.page.style.headerMargins : (section.page.style.firstPageHeaderMargins ?? section.page.style.headerMargins)
+        ),
+        footerMargins: AD.LayoutFoundation.orDefault(
+          normalFooter ? section.page.style.footerMargins : (section.page.style.firstPageFooterMargins ?? section.page.style.footerMargins)
+        ),
+      };
+    }
+    case pageNo === 0:
+    case pageNo % 2 === EVEN_PAGE:
+    case pageNo % 2 === ODD_PAGE:
+    default: {
+      return {
+        header: section.page.header,
+        footer: section.page.footer,
+        headerMargins: AD.LayoutFoundation.orDefault(section.page.style.headerMargins),
+        footerMargins: AD.LayoutFoundation.orDefault(section.page.style.footerMargins),
+      };
+    }
+  }
+}

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

@@ -1,16 +1,14 @@
-import * as AD from "../../abstract-document/index.js";
 import { exhaustiveCheck } from "ts-exhaustive-check";
-import type { Page } from "./paginate.js";
-import { getHeaderAndFooter } from "./paginate.js";
+import * as AD from "../../abstract-document/index.js";
 import { registerFonts, getFontNameStyle } from "./font.js";
-
-//tslint:disable:no-any variable-name
+import { getHeaderAndFooter } from "./header-footer.js";
+import type { Page } from "./page.js";
 
 const widthOfStringCache = new Map<string, number>();
 const heightOfStringCache = new Map<string, number>();
 
-export function measure(pdfKit: PDFKit.PDFDocument, document: AD.AbstractDoc.AbstractDoc): Map<any, AD.Size.Size> {
-  let pdf = new pdfKit();
+export function measure(pdfKit: PDFKit.PDFDocument, document: AD.AbstractDoc.AbstractDoc): Map<object, AD.Size.Size> {
+  const pdf = new pdfKit();
   registerFonts((fontName: string, fontSource: AD.Font.FontSource) => pdf.registerFont(fontName, fontSource), document);
   const result = mergeMaps(document.children.map((s) => measureSection(pdf, document, s)));
   widthOfStringCache.clear();
@@ -22,15 +20,11 @@ export function measurePages(
   pdfKit: PDFKit.PDFDocument,
   document: AD.AbstractDoc.AbstractDoc,
   pages: ReadonlyArray<Page>
-): Map<any, AD.Size.Size> {
+): Map<object, AD.Size.Size> {
   const pdf = new pdfKit();
   registerFonts((fontName: string, fontSource: AD.Font.FontSource) => pdf.registerFont(fontName, fontSource), document);
   return mergeMaps(
-    pages.flatMap((page) =>
-      page.columns.map(({ elements }) =>
-        measureSection(pdf, document, page.section, page.header, page.footer, elements)
-      )
-    )
+    pages.flatMap((page) => page.columns.map(({ elements }) => measureSection(pdf, document, page.section, page.header, page.footer, elements)))
   );
 }
 
@@ -41,10 +35,10 @@ function measureSection(
   separateHeader?: ReadonlyArray<AD.SectionElement.SectionElement>,
   separateFooter?: ReadonlyArray<AD.SectionElement.SectionElement>,
   separateChildren?: ReadonlyArray<AD.SectionElement.SectionElement>
-): Map<any, AD.Size.Size> {
-  const header = separateHeader || section.page.header;
-  const footer = separateFooter || section.page.footer;
-  const children = separateChildren || section.children;
+): Map<object, AD.Size.Size> {
+  const header = separateHeader ?? section.page.header;
+  const footer = separateFooter ?? section.page.footer;
+  const children = separateChildren ?? section.children;
 
   const pageWidth = AD.PageStyle.getWidth(section.page.style);
   const pageHeight = AD.PageStyle.getHeight(section.page.style);
@@ -69,9 +63,7 @@ function measureSection(
 
   //header and footer sizes for the first page
   const firstPageHeaderAndFooters = getHeaderAndFooter(section, 1);
-  const firstPageHeaderAndFootersExtracted: ReadonlyArray<
-    [ReadonlyArray<AD.SectionElement.SectionElement>, AD.LayoutFoundation.LayoutFoundation]
-  > = [
+  const firstPageHeaderAndFootersExtracted: ReadonlyArray<[ReadonlyArray<AD.SectionElement.SectionElement>, AD.LayoutFoundation.LayoutFoundation]> = [
     [firstPageHeaderAndFooters.header, firstPageHeaderAndFooters.headerMargins],
     [firstPageHeaderAndFooters.footer, firstPageHeaderAndFooters.footerMargins],
   ];
@@ -90,7 +82,7 @@ function measureSectionElement(
   parentResources: AD.Resources.Resources,
   availableSize: AD.Size.Size,
   element: AD.SectionElement.SectionElement
-): Map<any, AD.Size.Size> {
+): Map<object, AD.Size.Size> {
   const resources = AD.Resources.mergeResources([parentResources, element]);
   switch (element.type) {
     case "Paragraph":
@@ -106,8 +98,8 @@ function measureSectionElement(
   }
 }
 
-function measurePageBreak(availableSize: AD.Size.Size, pageBreak: AD.PageBreak.PageBreak): Map<any, AD.Size.Size> {
-  let desiredSizes = new Map<any, AD.Size.Size>();
+function measurePageBreak(availableSize: AD.Size.Size, pageBreak: AD.PageBreak.PageBreak): Map<object, AD.Size.Size> {
+  const desiredSizes = new Map<object, AD.Size.Size>();
   desiredSizes.set(pageBreak, availableSize);
   return desiredSizes;
 }
@@ -117,7 +109,7 @@ function measureParagraph(
   resources: AD.Resources.Resources,
   availableSize: AD.Size.Size,
   paragraph: AD.Paragraph.Paragraph
-): Map<any, AD.Size.Size> {
+): Map<object, AD.Size.Size> {
   const style = AD.Resources.getStyle(
     undefined,
     paragraph.style,
@@ -131,7 +123,7 @@ function measureParagraph(
   const contentAvailableSize = AD.Size.create(contentAvailableWidth, contentAvailableHeight);
 
   let paragraphHeight = styleMargins.top + styleMargins.bottom;
-  let desiredSizes = new Map<any, AD.Size.Size>();
+  const desiredSizes = new Map<object, AD.Size.Size>();
 
   const rows: Array<Array<AD.Atom.Atom>> = [];
   let currentRow: Array<AD.Atom.Atom> = [];
@@ -152,19 +144,12 @@ function measureParagraph(
     let currentRowHeight = 0;
     let concatenatedText = "";
     let hasAtomImage = false;
-    let textOptions;
+    let textOptions: AD.TextStyle.TextStyle | undefined = undefined;
     for (const atom of row) {
       if (atom.type === "Image") {
         hasAtomImage = true;
       }
-      const atomSize = measureAtom(
-        pdfKit,
-        resources,
-        style.textStyle,
-        contentAvailableSize,
-        contentAvailableSize.width - currentRowWidth,
-        atom
-      );
+      const atomSize = measureAtom(pdfKit, resources, style.textStyle, contentAvailableSize, contentAvailableSize.width - currentRowWidth, atom);
       if (atom.type === "TextRun" || atom.type === "TextField" || atom.type === "HyperLink") {
         concatenatedText += atom.text;
         textOptions = getBiggestStyle(atom, style, resources, textOptions);
@@ -195,7 +180,7 @@ function measureParagraph(
       // );
 
       const height = pdfKit.heightOfString(concatenatedText, {
-        width: textOptions && textOptions.lineBreak === false ? Infinity : availableSize.width,
+        width: textOptions?.lineBreak === false ? Infinity : availableSize.width,
         ...textOptions,
       });
       paragraphHeight += height;
@@ -237,25 +222,19 @@ export function measureTable(
   resources: AD.Resources.Resources,
   availableSize: AD.Size.Size,
   table: AD.Table.Table
-): Map<any, AD.Size.Size> {
-  const style = AD.Resources.getStyle(
-    undefined,
-    table.style,
-    "TableStyle",
-    table.styleName,
-    resources
-  ) as AD.TableStyle.TableStyle;
+): Map<object, AD.Size.Size> {
+  const style = AD.Resources.getStyle(undefined, table.style, "TableStyle", table.styleName, resources) as AD.TableStyle.TableStyle;
   const styleMargins = AD.LayoutFoundation.orDefault(style.margins);
   const tableAvailableWidth = availableSize.width - (styleMargins.left + styleMargins.right);
-  const numInfinityColumns = table.columnWidths.filter((w) => !isFinite(w)).length;
-  const fixedColumnsWidth = table.columnWidths.filter((w) => isFinite(w)).reduce((a, b) => a + b, 0);
+  const numInfinityColumns = table.columnWidths.filter((w) => !Number.isFinite(w)).length;
+  const fixedColumnsWidth = table.columnWidths.filter((w) => Number.isFinite(w)).reduce((a, b) => a + b, 0);
   const infinityWidth = (tableAvailableWidth - fixedColumnsWidth) / numInfinityColumns;
-  const columnWidths = table.columnWidths.map((w) => (isFinite(w) ? w : infinityWidth));
-  const desiredSizes = new Map<any, AD.Size.Size>();
+  const columnWidths = table.columnWidths.map((w) => (Number.isFinite(w) ? w : infinityWidth));
+  const desiredSizes = new Map<object, AD.Size.Size>();
   const rows = [...table.headerRows, ...table.children];
-  for (let row of rows) {
+  for (const row of rows) {
     let column = 0;
-    for (let cell of row.children) {
+    for (const cell of row.children) {
       const cellStyle = AD.Resources.getStyle(
         style.cellStyle,
         cell.style,
@@ -276,7 +255,7 @@ export function measureTable(
       const contentAvailableWidth = cellWidth - (cellStylePadding.left + cellStylePadding.right);
       let cellDesiredHeight = cellStylePadding.top + cellStylePadding.bottom;
 
-      for (let element of cell.children) {
+      for (const element of cell.children) {
         const elementAvailableSize = AD.Size.create(contentAvailableWidth, Infinity);
         const elementSizes = measureSectionElement(pdfKit, resources, elementAvailableSize, element);
         elementSizes.forEach((v, k) => desiredSizes.set(k, v));
@@ -303,7 +282,7 @@ export function measureTable(
       return a.child.rowSpan - b.child.rowSpan;
     }
   });
-  const minRowHeights = new Array(rows.length).fill(0);
+  const minRowHeights = Array.from({ length: rows.length }, () => 0);
   for (const { child, rowIndex } of cells) {
     const rowSpan = child.rowSpan || 1;
     let currentHeight = 0;
@@ -319,7 +298,7 @@ export function measureTable(
     }
   }
 
-  const desiredWidth = table.columnWidths.some((w) => !isFinite(w))
+  const desiredWidth = table.columnWidths.some((w) => !Number.isFinite(w))
     ? availableSize.width
     : table.columnWidths.reduce((a, b) => a + b, styleMargins.left + styleMargins.right);
   let desiredHeight = styleMargins.top + styleMargins.bottom;
@@ -328,8 +307,8 @@ export function measureTable(
     const rowHeight = minRowHeights[i];
     desiredHeight += rowHeight;
     desiredSizes.set(row, AD.Size.create(desiredWidth, rowHeight));
-    for (let cell of row.children) {
-      const cellSize = desiredSizes.get(cell) || AD.Size.create(0, 0);
+    for (const cell of row.children) {
+      const cellSize = desiredSizes.get(cell) ?? AD.Size.create(0, 0);
       desiredSizes.set(cell, AD.Size.create(cellSize.width, rowHeight));
     }
   }
@@ -344,11 +323,9 @@ function measureGroup(
   resources: AD.Resources.Resources,
   availableSize: AD.Size.Size,
   keepTogether: AD.Group.Group
-): Map<any, AD.Size.Size> {
-  let desiredSizes = mergeMaps(
-    keepTogether.children.map((e) => measureSectionElement(pdfKit, resources, availableSize, e))
-  );
-  let desiredHeight = keepTogether.children.reduce(
+): Map<object, AD.Size.Size> {
+  const desiredSizes = mergeMaps(keepTogether.children.map((e) => measureSectionElement(pdfKit, resources, availableSize, e)));
+  const desiredHeight = keepTogether.children.reduce(
     (sum, e) => sum + (AD.Position.isPositionAbsolute(e) ? 0 : getDesiredSize(e, desiredSizes).height),
     0.0
   );
@@ -400,7 +377,7 @@ function measureLineBreak(
     "TextStyle",
     lineBreak.styleName,
     resources,
-    lineBreak.nestedStyleNames || []
+    lineBreak.nestedStyleNames ?? []
   ) as AD.TextStyle.TextStyle;
   return measureText(pdfKit, "A", style, availableSize);
 }
@@ -418,7 +395,7 @@ function measureTextRun(
     "TextStyle",
     textRun.styleName,
     resources,
-    textRun.nestedStyleNames || []
+    textRun.nestedStyleNames ?? []
   ) as AD.TextStyle.TextStyle;
   return measureText(pdf, textRun.text, style, availableSize, true);
 }
@@ -430,13 +407,7 @@ function measureHyperLink(
   hyperLink: AD.HyperLink.HyperLink,
   availableSize: AD.Size.Size
 ): AD.Size.Size {
-  const style = AD.Resources.getStyle(
-    textStyle,
-    hyperLink.style,
-    "TextStyle",
-    hyperLink.styleName,
-    resources
-  ) as AD.TextStyle.TextStyle;
+  const style = AD.Resources.getStyle(textStyle, hyperLink.style, "TextStyle", hyperLink.styleName, resources) as AD.TextStyle.TextStyle;
   return measureText(pdf, hyperLink.text, style, availableSize);
 }
 
@@ -447,13 +418,7 @@ function measureTextField(
   textField: AD.TextField.TextField,
   availableSize: AD.Size.Size
 ): AD.Size.Size {
-  const style = AD.Resources.getStyle(
-    textStyle,
-    textField.style,
-    "TextStyle",
-    textField.styleName,
-    resources
-  ) as AD.TextStyle.TextStyle;
+  const style = AD.Resources.getStyle(textStyle, textField.style, "TextStyle", textField.styleName, resources) as AD.TextStyle.TextStyle;
   switch (textField.fieldType) {
     case "Date":
       return measureText(pdf, new Date(Date.now()).toDateString(), style, availableSize);
@@ -479,20 +444,16 @@ function measureTocSeparator(
   };
 }
 
-function measureImage(
-  resources: AD.Resources.Resources,
-  availableSize: AD.Size.Size,
-  image: AD.Image.Image
-): AD.Size.Size {
+function measureImage(resources: AD.Resources.Resources, availableSize: AD.Size.Size, image: AD.Image.Image): AD.Size.Size {
   const ai = image.imageResource.abstractImage;
   const firstComp = ai.components[0];
   const resource =
     !ai.size.width && !ai.size.height && firstComp?.type === "binaryimage" && firstComp.data.type === "url"
-      ? resources.imageResources?.[firstComp.data.url] ?? image.imageResource
+      ? (resources.imageResources?.[firstComp.data.url] ?? image.imageResource)
       : image.imageResource;
 
   let desiredWidth = availableSize.width;
-  if (!isFinite(image.width)) {
+  if (!Number.isFinite(image.width)) {
     desiredWidth = availableSize.width;
   } else if (image.width) {
     desiredWidth = image.width;
@@ -501,7 +462,7 @@ function measureImage(
   }
 
   let desiredHeight = availableSize.height;
-  if (!isFinite(image.height)) {
+  if (!Number.isFinite(image.height)) {
     desiredHeight = availableSize.height;
   } else if (image.height) {
     desiredHeight = image.height;
@@ -527,11 +488,11 @@ function measureText(
   pdf
     .font(font)
     .fontSize(fontSize)
-    .fillColor(textStyle.color || "black");
+    .fillColor(textStyle.color ?? "black");
 
   const textOptions = {
-    underline: textStyle.underline || false,
-    indent: textStyle.indent || 0,
+    underline: textStyle.underline ?? false,
+    indent: textStyle.indent ?? 0,
     lineBreak: textStyle.lineBreak ?? true,
     ...(textStyle.characterSpacing !== undefined ? { characterSpacing: textStyle.characterSpacing } : {}),
     ...(textStyle.lineGap !== undefined ? { lineGap: textStyle.lineGap } : {}),
@@ -557,13 +518,7 @@ function measureText(
   return AD.Size.create(width, height, availableSize.width);
 }
 
-function widthOfString(
-  pdf: PDFKit.PDFDocument,
-  font: string,
-  fontSize: number,
-  text: string,
-  options: PDFKit.Mixins.TextOptions
-): number {
+function widthOfString(pdf: PDFKit.PDFDocument, font: string, fontSize: number, text: string, options: PDFKit.Mixins.TextOptions): number {
   const key = JSON.stringify({ font, fontSize, text, options });
   const cached = widthOfStringCache.get(key);
   if (cached !== undefined) {
@@ -576,13 +531,7 @@ function widthOfString(
   return width;
 }
 
-function heightOfString(
-  pdf: PDFKit.PDFDocument,
-  font: string,
-  fontSize: number,
-  text: string,
-  options: PDFKit.Mixins.TextOptions
-): number {
+function heightOfString(pdf: PDFKit.PDFDocument, font: string, fontSize: number, text: string, options: PDFKit.Mixins.TextOptions): number {
   const key = JSON.stringify({ font, fontSize, text, options });
   const cached = heightOfStringCache.get(key);
   if (cached !== undefined) {
@@ -595,13 +544,13 @@ function heightOfString(
   return height;
 }
 
-function mergeMaps(maps: Array<Map<any, AD.Size.Size>>): Map<any, AD.Size.Size> {
-  let newMap = new Map<any, AD.Size.Size>();
+function mergeMaps(maps: Array<Map<object, AD.Size.Size>>): Map<object, AD.Size.Size> {
+  const newMap = new Map<object, AD.Size.Size>();
   maps.forEach((m) => m.forEach((v, k) => newMap.set(k, v)));
   return newMap;
 }
 
-function getDesiredSize(element: any, desiredSizes: Map<any, AD.Size.Size>): AD.Size.Size {
+function getDesiredSize(element: object, desiredSizes: Map<object, AD.Size.Size>): AD.Size.Size {
   const size = desiredSizes.get(element);
   if (size) {
     return size;

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

@@ -0,0 +1,16 @@
+import type * as AD from "../../abstract-document/index.js";
+
+export interface PageColumn {
+  readonly elements: ReadonlyArray<AD.SectionElement.SectionElement>;
+}
+
+export interface Page {
+  readonly pageNo: number;
+  readonly namedDestionations: ReadonlyArray<string>;
+  readonly pageOptions: PDFKit.PDFDocumentOptions;
+  readonly section: AD.Section.Section;
+  readonly contentRect: AD.Rect.Rect;
+  readonly columns: ReadonlyArray<PageColumn>;
+  readonly header: ReadonlyArray<AD.SectionElement.SectionElement>;
+  readonly footer: ReadonlyArray<AD.SectionElement.SectionElement>;
+}