abstract-document 20.0.3 → 20.1.0

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

@@ -1,51 +1,44 @@
+// oxlint-disable-next-line import/no-named-as-default -- standard pdfkit import idiom
+import PDFDocument from "pdfkit";
+import { toBlob, toBytes } from "pdfkit/output";
 import * as AD from "../../abstract-document/index.js";
-import { preProcess } from "./pre-process.js";
+import { registerFonts, getFontNameStyle } from "./font.js";
+import { getHeaderAndFooter } from "./header-footer.js";
 import { measure, measurePages } from "./measure.js";
-import type { Page } from "./paginate.js";
-import { paginate, getHeaderAndFooter } from "./paginate.js";
-import { updatePageRefs } from "./update-refs.js";
+import type { Page } from "./page.js";
+import { paginate } from "./paginate.js";
+import { preProcess } from "./pre-process.js";
 import { renderImage } from "./render-image.js";
-import { registerFonts, getFontNameStyle } from "./font.js";
 import { registerDefaultStdFonts } from "./std-fonts.js";
-import { toBlob, toBytes } from "pdfkit/output";
-import PDFDocument from "pdfkit";
 import type { PdfKitAlignment } from "./textRunRow.js";
 import { rowsCombineTextRuns, rowsSplit } from "./textRunRow.js";
+import { updatePageRefs } from "./update-refs.js";
 
 export type PdfExportOptions = {
   compress: boolean;
 };
 
-export function exportToHTML5Blob(
-  doc: AD.AbstractDoc.AbstractDoc,
-  options: PdfExportOptions = { compress: false }
-): Promise<Blob> {
+export function exportToHTML5Blob(doc: AD.AbstractDoc.AbstractDoc, options: PdfExportOptions = { compress: false }): Promise<Blob> {
   const pdf = createDocument(options, doc);
   return toBlob(pdf);
 }
 
-export function exportToBytes(
-  doc: AD.AbstractDoc.AbstractDoc,
-  options: PdfExportOptions = { compress: false }
-): Promise<Uint8Array> {
+export function exportToBytes(doc: AD.AbstractDoc.AbstractDoc, options: PdfExportOptions = { compress: false }): Promise<Uint8Array> {
   const pdf = createDocument(options, doc);
   return toBytes(pdf);
 }
 
 /**
- * On the client side the stream can be a BlobStream from the blob-stream package.
- * On the server-side the stream can be a file stream from the fs package.
+ * On the client side the stream can be a BlobStream from the blob-stream package. On the server-side the stream can be a file stream from the fs
+ * package.
+ *
  * @param blobStream
  * @param doc
  * @param options
  */
-export function exportToStream(
-  blobStream: any,
-  doc: AD.AbstractDoc.AbstractDoc,
-  options: PdfExportOptions = { compress: false }
-): void {
-  let pdf = createDocument(options, doc);
-  pdf.pipe(blobStream);
+export function exportToStream(blobStream: unknown, doc: AD.AbstractDoc.AbstractDoc, options: PdfExportOptions = { compress: false }): void {
+  const pdf = createDocument(options, doc);
+  pdf.pipe(blobStream as NodeJS.WritableStream);
 }
 
 function createDocument(options: PdfExportOptions, ad: AD.AbstractDoc.AbstractDoc): PDFKit.PDFDocument {
@@ -59,19 +52,14 @@ function createDocument(options: PdfExportOptions, ad: AD.AbstractDoc.AbstractDo
   const updatedPages = updatePageRefs(pages);
   const pageDesiredSizes = measurePages(PDFDocument, document, updatedPages);
 
-  for (let page of updatedPages) {
+  for (const page of updatedPages) {
     renderPage(document, pdf, pageDesiredSizes, page);
   }
   pdf.end();
   return pdf;
 }
 
-function renderPage(
-  parentResources: AD.Resources.Resources,
-  pdfKit: PDFKit.PDFDocument,
-  desiredSizes: Map<{}, AD.Size.Size>,
-  page: Page
-): void {
+function renderPage(parentResources: AD.Resources.Resources, pdfKit: PDFKit.PDFDocument, desiredSizes: Map<object, AD.Size.Size>, page: Page): void {
   const section = page.section;
   const style = section.page.style;
   const resources = AD.Resources.mergeResources([parentResources, section]);
@@ -79,8 +67,8 @@ function renderPage(
   const contentRect = addPage(pdfKit, page);
 
   page.namedDestionations.forEach((dest) => {
-    if ((pdfKit as any).addNamedDestination) {
-      (pdfKit as any).addNamedDestination(dest);
+    if (pdfKit.addNamedDestination) {
+      pdfKit.addNamedDestination(dest);
     }
   });
 
@@ -88,7 +76,7 @@ function renderPage(
   const headerX = headerMargins.left;
   const headerStart = headerMargins.top;
   let headerY = headerStart;
-  for (let element of page.header) {
+  for (const element of page.header) {
     const elementSize = getDesiredSize(element, desiredSizes);
     const isAbsolute = AD.Position.isPositionAbsolute(element);
     renderSectionElement(
@@ -111,7 +99,7 @@ function renderPage(
   const footerX = footerMargins.left;
   const footerStart = pageHeight - (footerHeight - footerMargins.top);
   let footerY = footerStart;
-  for (let element of page.footer) {
+  for (const element of page.footer) {
     const elementSize = getDesiredSize(element, desiredSizes);
     const isAbsolute = AD.Position.isPositionAbsolute(element);
     renderSectionElement(
@@ -127,8 +115,7 @@ function renderPage(
   }
 
   const elementStart = contentRect.y;
-  const columnStep =
-    contentRect.width / section.page.style.columnLayout.columnCount + section.page.style.columnLayout.columnGap;
+  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;
@@ -169,7 +156,7 @@ function addPage(pdf: PDFKit.PDFDocument, page: Page): AD.Rect.Rect {
 function renderSectionElement(
   parentResources: AD.Resources.Resources,
   pdf: PDFKit.PDFDocument,
-  desiredSizes: Map<{}, AD.Size.Size>,
+  desiredSizes: Map<object, AD.Size.Size>,
   finalRect: AD.Rect.Rect,
   element: AD.SectionElement.SectionElement
 ): void {
@@ -177,20 +164,22 @@ function renderSectionElement(
   switch (element.type) {
     case "Paragraph":
       renderParagraph(resources, pdf, desiredSizes, finalRect, element);
-      return;
+      break;
     case "Table":
       renderTable(resources, pdf, desiredSizes, finalRect, element);
-      return;
+      break;
     case "Group":
       renderGroup(resources, pdf, desiredSizes, finalRect, element);
-      return;
+      break;
+    default:
+      break;
   }
 }
 
 function renderGroup(
   resources: AD.Resources.Resources,
   pdfKit: PDFKit.PDFDocument,
-  desiredSizes: Map<{}, AD.Size.Size>,
+  desiredSizes: Map<object, AD.Size.Size>,
   finalRect: AD.Rect.Rect,
   group: AD.Group.Group
 ): void {
@@ -217,7 +206,7 @@ function renderGroup(
 function renderParagraph(
   resources: AD.Resources.Resources,
   pdfKit: PDFKit.PDFDocument,
-  desiredSizes: Map<{}, AD.Size.Size>,
+  desiredSizes: Map<object, AD.Size.Size>,
   finalRect: AD.Rect.Rect,
   paragraph: AD.Paragraph.Paragraph
 ): void {
@@ -231,10 +220,10 @@ function renderParagraph(
   const styleMargins = AD.LayoutFoundation.orDefault(style.margins);
   const availableWidth = finalRect.width - (styleMargins.left + styleMargins.right);
 
-  let rows: Array<Array<AD.Atom.Atom>> = [];
+  const rows: Array<Array<AD.Atom.Atom>> = [];
   let currentRow: Array<AD.Atom.Atom> = [];
   let currentWidth = 0;
-  let previousAtomType: string | undefined;
+  let previousAtomType: string | undefined = undefined;
   for (const atom of paragraph.children) {
     if (atom.type === "LineBreak") {
       currentRow.push(atom);
@@ -296,14 +285,7 @@ function renderParagraph(
   let newHeight = styleMargins.top + styleMargins.bottom;
   const alignment = parseAlignment(style.alignment);
   const newRows = rowsSplit(rows, availableWidth, desiredSizes, alignment, pdfKit, resources, style.textStyle);
-  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;
@@ -397,25 +379,15 @@ function renderAtom(
       renderImage(resources, pdfKit, finalRect, textStyle, atom);
       return;
     case "HyperLink":
-      renderHyperLink(
-        resources,
-        pdfKit,
-        finalRect,
-        textStyle,
-        atom,
-        alignment,
-        isFirstAtom,
-        isLastAtom,
-        availableWidth
-      );
+      renderHyperLink(resources, pdfKit, finalRect, textStyle, atom, alignment, isFirstAtom, isLastAtom, availableWidth);
       return;
     case "TocSeparator":
       renderTocSeparator(pdfKit, finalRect, textStyle, atom);
-      return;
+      break;
     case "LinkTarget":
-      return;
     case "LineBreak":
-      return;
+    default:
+      break;
   }
 }
 
@@ -429,13 +401,7 @@ function renderTextField(
   isFirstAtom: boolean,
   isLastAtom: boolean
 ): void {
-  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":
       drawText(pdfKit, finalRect, style, new Date(Date.now()).toDateString(), alignment, isFirstAtom, isLastAtom);
@@ -446,7 +412,9 @@ function renderTextField(
       if (textField.text) {
         drawText(pdfKit, finalRect, style, textField.text, alignment, isFirstAtom, isLastAtom);
       }
-      return;
+      break;
+    default:
+      break;
   }
 }
 
@@ -466,7 +434,7 @@ function renderTextRun(
     "TextStyle",
     textRun.styleName,
     resources,
-    textRun.nestedStyleNames || []
+    textRun.nestedStyleNames ?? []
   ) as AD.TextStyle.TextStyle;
   drawText(pdf, finalRect, style, textRun.text, alignment, isFirstAtom, isLastAtom);
 }
@@ -482,13 +450,7 @@ function renderHyperLink(
   isLastAtom: boolean,
   availableWidth: number
 ): void {
-  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;
   drawHyperLink(pdf, finalRect, style, hyperLink, alignment, isFirstAtom, isLastAtom, availableWidth);
 }
 
@@ -525,7 +487,7 @@ function drawHyperLink(
   pdf
     .font(font)
     .fontSize(fontSize)
-    .fillColor(textStyle.color || "blue");
+    .fillColor(textStyle.color ?? "blue");
 
   applyTextOffset(pdf, textStyle);
 
@@ -538,25 +500,25 @@ function drawHyperLink(
       width: availableWidth,
       align: isSingleAtom ? alignment : "left",
       goTo: isInternalLink ? hyperLink.target.substr(1) : undefined,
-      indent: textStyle.indent || 0,
+      indent: textStyle.indent ?? 0,
       continued: alignment !== "left" ? false : !isLastAtom,
-      baseline: textStyle.baseline || "top",
+      baseline: textStyle.baseline ?? "top",
       ...(textStyle.characterSpacing !== undefined ? { characterSpacing: textStyle.characterSpacing } : {}),
       ...(textStyle.lineGap !== undefined ? { lineGap: textStyle.lineGap } : {}),
     });
-    if (textStyle.underline === undefined ? true : textStyle.underline) {
+    if (textStyle.underline ?? true) {
       pdf.underline(xUnderline, finalRect.y + 2, finalRect.width, finalRect.height, { color: "blue" });
     }
   } else {
     pdf.text(hyperLink.text, {
       align: "left",
       goTo: isInternalLink ? hyperLink.target.substr(1) : undefined,
-      indent: textStyle.indent || 0,
+      indent: textStyle.indent ?? 0,
       continued: !isLastAtom,
       ...(textStyle.characterSpacing !== undefined ? { characterSpacing: textStyle.characterSpacing } : {}),
       ...(textStyle.lineGap !== undefined ? { lineGap: textStyle.lineGap } : {}),
     });
-    if (textStyle.underline === undefined ? true : textStyle.underline) {
+    if (textStyle.underline ?? true) {
       pdf.underline(xUnderline, finalRect.y + 2, finalRect.width, finalRect.height, {
         color: "blue",
       });
@@ -635,17 +597,17 @@ function drawText(
   pdf
     .font(font)
     .fontSize(fontSize)
-    .fillColor(textStyle.color || "black", textStyle.opacity ?? 1.0);
+    .fillColor(textStyle.color ?? "black", textStyle.opacity ?? 1.0);
   applyTextOffset(pdf, textStyle);
 
   switch (alignment) {
     case "justify": {
       pdf.text(text, finalRect.x, finalRect.y, {
         width: Infinity,
-        underline: textStyle.underline || false,
+        underline: textStyle.underline ?? false,
         continued: false,
-        indent: textStyle.indent || 0,
-        baseline: textStyle.baseline || "top",
+        indent: textStyle.indent ?? 0,
+        baseline: textStyle.baseline ?? "top",
         strike: textStyle.strike,
         ...(textStyle.characterSpacing !== undefined ? { characterSpacing: textStyle.characterSpacing } : {}),
         ...(textStyle.lineGap !== undefined ? { lineGap: textStyle.lineGap } : {}),
@@ -657,10 +619,10 @@ function drawText(
       if (isFirst) {
         pdf.text(text, finalRect.x, finalRect.y, {
           width: Infinity,
-          underline: textStyle.underline || false,
+          underline: textStyle.underline ?? false,
           continued: !isEnd,
-          indent: textStyle.indent || 0,
-          baseline: textStyle.baseline || "top",
+          indent: textStyle.indent ?? 0,
+          baseline: textStyle.baseline ?? "top",
           strike: textStyle.strike,
           ...(textStyle.characterSpacing !== undefined ? { characterSpacing: textStyle.characterSpacing } : {}),
           ...(textStyle.lineGap !== undefined ? { lineGap: textStyle.lineGap } : {}),
@@ -668,10 +630,10 @@ function drawText(
       } else {
         pdf.text(text, {
           width: Infinity,
-          underline: textStyle.underline || false,
+          underline: textStyle.underline ?? false,
           continued: !isEnd,
-          indent: textStyle.indent || 0,
-          baseline: textStyle.baseline || "top",
+          indent: textStyle.indent ?? 0,
+          baseline: textStyle.baseline ?? "top",
           strike: textStyle.strike,
           ...(textStyle.characterSpacing !== undefined ? { characterSpacing: textStyle.characterSpacing } : {}),
           ...(textStyle.lineGap !== undefined ? { lineGap: textStyle.lineGap } : {}),
@@ -692,7 +654,7 @@ function drawDottedLine(
   const font = getFontNameStyle(textStyle);
   const fontSize = AD.TextStyle.calculateFontSize(textStyle, 10);
 
-  const charSpacing = tocSeparator.width ? tocSeparator.width : 5;
+  const charSpacing = tocSeparator.width ?? 5;
 
   const oneDotW = pdf.widthOfString(".", {
     width: finalRect.width,
@@ -713,7 +675,7 @@ function drawDottedLine(
   pdf
     .font(font)
     .fontSize(fontSize)
-    .fillColor(textStyle.color || "black");
+    .fillColor(textStyle.color ?? "black");
 
   applyTextOffset(pdf, textStyle);
 
@@ -734,26 +696,23 @@ function drawDottedLine(
 function renderTable(
   resources: AD.Resources.Resources,
   pdf: PDFKit.PDFDocument,
-  desiredSizes: Map<{}, AD.Size.Size>,
+  desiredSizes: Map<object, AD.Size.Size>,
   finalRect: AD.Rect.Rect,
   table: AD.Table.Table
 ): void {
-  const style = AD.Resources.getStyle(
-    undefined,
-    table.style,
-    "TableStyle",
-    table.styleName,
-    resources
-  ) as AD.TableStyle.TableStyle;
+  const style = AD.Resources.getStyle(undefined, table.style, "TableStyle", table.styleName, resources) as AD.TableStyle.TableStyle;
   const styleMargins = AD.LayoutFoundation.orDefault(style.margins);
   const availableWidth = finalRect.width;
   let y = finalRect.y + styleMargins.top;
   const rows = [...table.headerRows, ...table.children];
-  for (let [index, row] of rows.entries()) {
+  for (const [index, row] of rows.entries()) {
     const rowSize = getDesiredSize(row, desiredSizes);
     let x = finalRect.x + styleMargins.left;
-    if (style.alignment === "Center") x += 0.5 * (availableWidth - rowSize.width);
-    else if (style.alignment === "Right") x += availableWidth - rowSize.width;
+    if (style.alignment === "Center") {
+      x += 0.5 * (availableWidth - rowSize.width);
+    } else if (style.alignment === "Right") {
+      x += availableWidth - rowSize.width;
+    }
     const rowRect = AD.Rect.create(x, y, rowSize.width, rowSize.height);
     const isTop = index === 0;
     const isBottom = index === rows.length - 1;
@@ -765,7 +724,7 @@ function renderTable(
 function renderRow(
   resources: AD.Resources.Resources,
   pdf: PDFKit.PDFDocument,
-  desiredSizes: Map<{}, AD.Size.Size>,
+  desiredSizes: Map<object, AD.Size.Size>,
   finalRect: AD.Rect.Rect,
   tableCellStyle: AD.TableCellStyle.TableCellStyle,
   table: AD.Table.Table,
@@ -801,7 +760,7 @@ function renderRow(
 function renderCell(
   resources: AD.Resources.Resources,
   pdf: PDFKit.PDFDocument,
-  desiredSizes: Map<{}, AD.Size.Size>,
+  desiredSizes: Map<object, AD.Size.Size>,
   finalRect: AD.Rect.Rect,
   tableCellStyle: AD.TableCellStyle.TableCellStyle,
   cell: AD.TableCell.TableCell,
@@ -810,13 +769,7 @@ function renderCell(
   isTop: boolean,
   isBottom: boolean
 ): void {
-  const style = AD.Resources.getStyle(
-    tableCellStyle,
-    cell.style,
-    "TableCellStyle",
-    cell.styleName,
-    resources
-  ) as AD.TableCellStyle.TableCellStyle;
+  const style = AD.Resources.getStyle(tableCellStyle, cell.style, "TableCellStyle", cell.styleName, resources) as AD.TableCellStyle.TableCellStyle;
   if (style.background) {
     pdf.rect(finalRect.x, finalRect.y, finalRect.width, finalRect.height).fill(style.background);
   }
@@ -824,15 +777,18 @@ function renderCell(
   const borders = AD.LayoutFoundation.orDefault(style.borders);
   const padding = AD.LayoutFoundation.orDefault(style.padding);
 
-  let x = finalRect.x + padding.left;
+  const x = finalRect.x + padding.left;
   const availableHeight = finalRect.height;
-  let contentHeight = cell.children
+  const contentHeight = cell.children
     .map((c) => (AD.Position.isPositionAbsolute(c) ? 0 : getDesiredSize(c, desiredSizes).height))
     .reduce((a, b) => a + b, 0);
   const startY = finalRect.y + padding.top;
   let y = startY;
-  if (style.verticalAlignment === "Middle") y += 0.5 * (availableHeight - contentHeight - padding.top - padding.bottom);
-  else if (style.verticalAlignment === "Bottom") y += availableHeight - contentHeight - padding.top - padding.bottom;
+  if (style.verticalAlignment === "Middle") {
+    y += 0.5 * (availableHeight - contentHeight - padding.top - padding.bottom);
+  } else if (style.verticalAlignment === "Bottom") {
+    y += availableHeight - contentHeight - padding.top - padding.bottom;
+  }
 
   for (const element of cell.children) {
     const elementSize = getDesiredSize(element, desiredSizes);
@@ -888,7 +844,7 @@ function renderCell(
 }
 
 function borderColor(style: AD.TableCellStyle.TableCellStyle, edge: "top" | "bottom" | "left" | "right"): string {
-  if (style.borderColors && style.borderColors[edge]) {
+  if (style.borderColors?.[edge]) {
     return style.borderColors[edge];
   }
   if (style.borderColor) {
@@ -897,7 +853,7 @@ function borderColor(style: AD.TableCellStyle.TableCellStyle, edge: "top" | "bot
   return "black";
 }
 
-function getDesiredSize(element: {}, desiredSizes: Map<{}, 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;
@@ -925,6 +881,6 @@ function resetTextOffset(pdf: PDFKit.PDFDocument, textStyle: AD.TextStyle.TextSt
 
 function calculateTextOffset(textStyle: AD.TextStyle.TextStyle): number {
   const defaultPosition = textStyle.superScript ? 0.5 : textStyle.subScript ? -0.5 : 0;
-  const position = textStyle.verticalPosition !== undefined ? textStyle.verticalPosition : defaultPosition;
+  const position = textStyle.verticalPosition ?? defaultPosition;
   return position;
 }

package/src/abstract-document-exporters/pdf/std-fonts.ts

@@ -1,8 +1,8 @@
 import * as PdfkitModule from "pdfkit";
 import Helvetica from "pdfkit/standard-fonts/Helvetica";
 import HelveticaBold from "pdfkit/standard-fonts/HelveticaBold";
-import HelveticaOblique from "pdfkit/standard-fonts/HelveticaOblique";
 import HelveticaBoldOblique from "pdfkit/standard-fonts/HelveticaBoldOblique";
+import HelveticaOblique from "pdfkit/standard-fonts/HelveticaOblique";
 
 // pdfkit 0.20's browser build stopped bundling standard font data and requires
 // registering it explicitly via `registerStdFonts` before it's used, or `.font("Helvetica")`
@@ -14,7 +14,7 @@ const pdfkitExports = PdfkitModule as unknown as {
   registerStdFonts?: (...fonts: ReadonlyArray<unknown>) => void;
 };
 
-// eslint-disable-next-line functional/no-let
+// oxlint-disable-next-line functional/no-let
 let registered = false;
 
 export function registerDefaultStdFonts(): void {