abstract-document 20.0.1 → 20.0.4

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

@@ -1,8 +1,18 @@
 import * as AD from "../../abstract-document/index.js";
+import type {
+  ISectionOptions,
+  ImageRun,
+  SymbolRun,
+  PageBreak,
+  SequentialIdentifier,
+  FootnoteReferenceRun,
+  InsertedTextRun,
+  DeletedTextRun,
+  Math as MathDocX,
+} from "docx";
 import {
   Packer,
   Document,
-  ISectionOptions,
   Paragraph,
   Table,
   Bookmark,
@@ -19,14 +29,6 @@ import {
   TableRow,
   TableCell,
   VerticalAlign,
-  ImageRun,
-  SymbolRun,
-  PageBreak,
-  SequentialIdentifier,
-  FootnoteReferenceRun,
-  InsertedTextRun,
-  DeletedTextRun,
-  Math as MathDocX,
   PageNumber,
 } from "docx";
 import { renderImage } from "./render-image.js";
@@ -37,23 +39,27 @@ const abstractDocPixelToDocxDXARatio = 20;
 const abstractDocBorderToDocxBorderSizeRatio = 8;
 
 export function exportToHTML5Blob(doc: AD.AbstractDoc.AbstractDoc): Promise<Blob> {
-  return new Promise((resolve) => {
+  return new Promise((resolve, reject) => {
     const docx = createDocument(doc);
-    Packer.toBlob(docx).then((blob) => {
-      resolve(blob);
-    });
+    Packer.toBlob(docx)
+      .then((blob) => {
+        resolve(blob);
+      })
+      .catch(reject);
   });
 }
 
 export function exportToStream(blobStream: NodeJS.WritableStream, doc: AD.AbstractDoc.AbstractDoc): void {
   const docx = createDocument(doc);
 
-  Packer.toBuffer(docx).then((buffer) => {
-    const readableStream = new Readable();
-    readableStream.push(buffer);
-    readableStream.push(null);
-    readableStream.pipe(blobStream);
-  });
+  Packer.toBuffer(docx)
+    .then((buffer) => {
+      const readableStream = new Readable();
+      readableStream.push(buffer);
+      readableStream.push(null);
+      readableStream.pipe(blobStream);
+    })
+    .catch((err: unknown) => blobStream.emit("error", err instanceof Error ? err : new Error(String(err))));
 }
 
 /**
@@ -72,38 +78,52 @@ function createDocument(doc: AD.AbstractDoc.AbstractDoc): Document {
 
 function renderSection(section: AD.Section.Section, parentResources: AD.Resources.Resources): ISectionOptions {
   const pageWidth = AD.PageStyle.getWidth(section.page.style);
-  const pageHeight = AD.PageStyle.getHeight(section.page.style);
-  const pageHeaderMargins = AD.LayoutFoundation.orDefault(section.page.style.headerMargins)
-  const pageFooterMargins = AD.LayoutFoundation.orDefault(section.page.style.footerMargins)
+  const pageHeaderMargins = AD.LayoutFoundation.orDefault(section.page.style.headerMargins);
+  const pageFooterMargins = AD.LayoutFoundation.orDefault(section.page.style.footerMargins);
   const pageContentMargins = AD.LayoutFoundation.orDefault(section.page.style.contentMargins);
 
   const hasFrontHeader = section.page.frontHeader !== undefined && section.page.frontHeader.length !== 0;
   const hasFrontFooter = section.page.frontFooter !== undefined && section.page.frontFooter.length !== 0;
-  
-  const contentAvailableWidth =
-    pageWidth - (pageContentMargins.left + pageContentMargins.right);
+
+  const contentAvailableWidth = pageWidth - (pageContentMargins.left + pageContentMargins.right);
 
   const resources = AD.Resources.mergeResources([parentResources, section]);
 
-  const headerChildren = section.page.header.reduce((sofar, c) => {
-    sofar.push(...renderSectionElement(c, resources, contentAvailableWidth));
-    return sofar;
-  }, [] as Array<Paragraph | Table>);
+  const headerChildren = section.page.header.reduce(
+    (sofar, c) => {
+      sofar.push(...renderSectionElement(c, resources, contentAvailableWidth));
+      return sofar;
+    },
+    [] as Array<Paragraph | Table>
+  );
 
-  const firstpageHeaderChildren = hasFrontHeader ? section.page.frontHeader.reduce((sofar, c) => {
-    sofar.push(...renderSectionElement(c, resources, contentAvailableWidth));
-    return sofar;
-  }, [] as Array<Paragraph | Table>) : [];
+  const firstpageHeaderChildren = hasFrontHeader
+    ? section.page.frontHeader.reduce(
+        (sofar, c) => {
+          sofar.push(...renderSectionElement(c, resources, contentAvailableWidth));
+          return sofar;
+        },
+        [] as Array<Paragraph | Table>
+      )
+    : [];
 
-  const footerChildren = section.page.footer.reduce((sofar, c) => {
-    sofar.push(...renderSectionElement(c, resources, contentAvailableWidth));
-    return sofar;
-  }, [] as Array<Paragraph | Table>);
+  const footerChildren = section.page.footer.reduce(
+    (sofar, c) => {
+      sofar.push(...renderSectionElement(c, resources, contentAvailableWidth));
+      return sofar;
+    },
+    [] as Array<Paragraph | Table>
+  );
 
-  const firstPageFooterChildren = hasFrontFooter ? section.page.frontFooter.reduce((sofar, c) => {
-    sofar.push(...renderSectionElement(c, resources, contentAvailableWidth));
-    return sofar;
-  }, [] as Array<Paragraph | Table>) : [];
+  const firstPageFooterChildren = hasFrontFooter
+    ? section.page.frontFooter.reduce(
+        (sofar, c) => {
+          sofar.push(...renderSectionElement(c, resources, contentAvailableWidth));
+          return sofar;
+        },
+        [] as Array<Paragraph | Table>
+      )
+    : [];
 
   const contentChildren = [
     new Paragraph({
@@ -115,10 +135,13 @@ function renderSection(section: AD.Section.Section, parentResources: AD.Resource
         }),
       ],
     }),
-    ...section.children.reduce((sofar, c) => {
-      sofar.push(...renderSectionElement(c, resources, contentAvailableWidth));
-      return sofar;
-    }, [] as Array<Paragraph | Table>),
+    ...section.children.reduce(
+      (sofar, c) => {
+        sofar.push(...renderSectionElement(c, resources, contentAvailableWidth));
+        return sofar;
+      },
+      [] as Array<Paragraph | Table>
+    ),
   ];
 
   return {
@@ -146,17 +169,21 @@ function renderSection(section: AD.Section.Section, parentResources: AD.Resource
       default: new Header({
         children: headerChildren,
       }),
-      first: hasFrontHeader ? new Header({
-        children: firstpageHeaderChildren
-      }) : undefined
+      first: hasFrontHeader
+        ? new Header({
+            children: firstpageHeaderChildren,
+          })
+        : undefined,
     },
     footers: {
       default: new Footer({
-        children: footerChildren
+        children: footerChildren,
       }),
-      first: hasFrontFooter ? new Footer({
-        children: firstPageFooterChildren
-      }) : undefined
+      first: hasFrontFooter
+        ? new Footer({
+            children: firstPageFooterChildren,
+          })
+        : undefined,
     },
     children: contentChildren,
   };
@@ -176,9 +203,9 @@ function renderHyperLink(
     characterSpacing: style.characterSpacing,
     underline: style.underline
       ? {
-        color: style.color || "#0000ff",
-        type: UnderlineType.SINGLE,
-      }
+          color: style.color || "#0000ff",
+          type: UnderlineType.SINGLE,
+        }
       : undefined,
   });
 
@@ -302,7 +329,9 @@ function renderTable(
         style: BorderStyle.NONE,
       },
     },
-    rows: table.headerRows.concat(table.children).map((c) => renderRow(c, resources, style.cellStyle, columnWidths, keepNext)),
+    rows: table.headerRows
+      .concat(table.children)
+      .map((c) => renderRow(c, resources, style.cellStyle, columnWidths, keepNext)),
   });
 }
 
@@ -317,16 +346,11 @@ function renderRow(
     (acc, cell) => {
       const span = cell.columnSpan ?? 1;
 
-      const width = columnWidths
-        .slice(acc.columnIndex, acc.columnIndex + span)
-        .reduce((a, b) => a + b, 0);
+      const width = columnWidths.slice(acc.columnIndex, acc.columnIndex + span).reduce((a, b) => a + b, 0);
 
       return {
         columnIndex: acc.columnIndex + span,
-        children: [
-          ...acc.children,
-          renderCell(cell, resources, tableCellStyle, width, keepNext),
-        ],
+        children: [...acc.children, renderCell(cell, resources, tableCellStyle, width, keepNext)],
       };
     },
     { columnIndex: 0, children: [] as TableCell[] }
@@ -346,7 +370,7 @@ function renderCell(
   keepNext: boolean
 ): TableCell {
   const abstractDocPxCellWidth = width / abstractDocPixelToDocxDXARatio;
-  
+
   const style = AD.Resources.getStyle(
     tableCellStyle,
     cell.style,
@@ -403,10 +427,13 @@ function renderCell(
       },
     },
 
-    children: cell.children.reduce((sofar, c) => {
-      sofar.push(...renderSectionElement(c, resources, abstractDocPxCellWidth, keepNext));
-      return sofar;
-    }, [] as Array<Paragraph | Table>),
+    children: cell.children.reduce(
+      (sofar, c) => {
+        sofar.push(...renderSectionElement(c, resources, abstractDocPxCellWidth, keepNext));
+        return sofar;
+      },
+      [] as Array<Paragraph | Table>
+    ),
   });
 }
 
@@ -494,9 +521,9 @@ function renderPageNumber(style: AD.TextStyle.TextStyle): TextRun {
     characterSpacing: style.characterSpacing,
     underline: style.underline
       ? {
-        color: style.color,
-        type: UnderlineType.SINGLE,
-      }
+          color: style.color,
+          type: UnderlineType.SINGLE,
+        }
       : undefined,
     children: [PageNumber.CURRENT],
   });
@@ -512,9 +539,9 @@ function renderTotalPages(style: AD.TextStyle.TextStyle): TextRun {
     characterSpacing: style.characterSpacing,
     underline: style.underline
       ? {
-        color: style.color,
-        type: UnderlineType.SINGLE,
-      }
+          color: style.color,
+          type: UnderlineType.SINGLE,
+        }
       : undefined,
     children: [PageNumber.TOTAL_PAGES],
   });
@@ -532,9 +559,9 @@ function renderText(style: AD.TextStyle.TextStyle, text: string): TextRun {
     characterSpacing: style.characterSpacing,
     underline: style.underline
       ? {
-        color: style.color,
-        type: UnderlineType.SINGLE,
-      }
+          color: style.color,
+          type: UnderlineType.SINGLE,
+        }
       : undefined,
   });
 }

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

@@ -1,6 +1,6 @@
 import * as AD from "../../abstract-document/index.js";
-import { Font } from "../../abstract-document/primitives/font.js";
-import { TextFontWeight } from "../../abstract-document/styles/text-style.js";
+import type { Font } from "../../abstract-document/primitives/font.js";
+import type { TextFontWeight } from "../../abstract-document/styles/text-style.js";
 import { getResources } from "../shared/get_resources.js";
 
 export function registerFonts(
@@ -33,16 +33,16 @@ function getFontWeightFromStyle(textStyle: AD.TextStyle.TextStyle): TextFontWeig
   return textStyle.fontWeight
     ? textStyle.fontWeight
     : textStyle.light
-    ? "light"
-    : textStyle.normal
-    ? "normal"
-    : textStyle.bold
-    ? "bold"
-    : textStyle.mediumBold
-    ? "mediumBold"
-    : textStyle.extraBold
-    ? "extraBold"
-    : "normal";
+      ? "light"
+      : textStyle.normal
+        ? "normal"
+        : textStyle.bold
+          ? "bold"
+          : textStyle.mediumBold
+            ? "mediumBold"
+            : textStyle.extraBold
+              ? "extraBold"
+              : "normal";
 }
 
 function getFontWeightFromAttributes(attribs: Record<string, string>): TextFontWeight {
@@ -57,12 +57,13 @@ export function getFontNameStyle(textStyle: AD.TextStyle.TextStyle): string {
 
 export function getFontStyleName(attributes: Record<string, string>): keyof Font {
   const fontWeight = getFontWeightFromAttributes(attributes);
-  const stringifiedItalic = `${attributes.italic}`;
+  // oxlint-disable-next-line typescript/no-unnecessary-template-expression
+  const stringifiedItalic = `${attributes["italic"]}`;
   const italic = stringifiedItalic === "true" || stringifiedItalic === "1";
-  if(fontWeight === "normal") {
+  if (fontWeight === "normal") {
     return italic ? "italic" : fontWeight;
   }
-  return `${fontWeight === "mediumBold" ? "medium" : fontWeight}${italic ? "Italic": ""}`;
+  return `${fontWeight === "mediumBold" ? "medium" : fontWeight}${italic ? "Italic" : ""}`;
 }
 
 export function getFontName(

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

@@ -1,6 +1,9 @@
 import * as AD from "../../abstract-document/index.js";
 import { exhaustiveCheck } from "ts-exhaustive-check";
-import { getHeaderAndFooter, Page } from "./paginate.js";
+// oxlint-disable-next-line import/no-cycle -- type-only, erased at compile time
+import type { Page } from "./paginate.js";
+// oxlint-disable-next-line import/no-cycle -- both sides only call each other from function bodies
+import { getHeaderAndFooter } from "./paginate.js";
 import { registerFonts, getFontNameStyle } from "./font.js";
 
 //tslint:disable:no-any variable-name
@@ -302,7 +305,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;
@@ -487,7 +490,7 @@ function measureImage(
   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;

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

@@ -1,6 +1,7 @@
 import * as AD from "../../abstract-document/index.js";
 import { getResources } from "../shared/get_resources.js";
 import { registerFonts } from "./font.js";
+// oxlint-disable-next-line import/no-cycle -- both sides only call each other from function bodies
 import { measureTable } from "./measure.js";
 
 export interface PageColumn {
@@ -280,12 +281,16 @@ export function getHeaderAndFooter(
       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),
+        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:

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

@@ -1,7 +1,6 @@
 import { exhaustiveCheck } from "ts-exhaustive-check";
 import * as AD from "../../abstract-document/index.js";
 import * as TextStyle from "../../abstract-document/styles/text-style.js";
-import { checkServerIdentity } from "node:tls";
 
 const alphabet = [
   "a",
@@ -184,7 +183,8 @@ function adjustParagraph(paragraph: AD.Paragraph.Paragraph): Array<AD.SectionEle
     if (child.type === "TextRun") {
       // Pdfkit will automatically split texts on "\n", which would not match with out measuring.
       // Fix this by replacing "\n" with a LineBreak
-      const text = `${child.text}`; //for some reason the text is not always a string(when the textrun just contain a number for example).. so we need to make it into one. TODO: make sure it is always a string?
+      // oxlint-disable-next-line typescript/no-unnecessary-type-conversion -- text isn't always a string at runtime
+      const text = String(child.text);
       const lines = text.split("\n");
 
       for (let i = 0; i < lines.length; i++) {
@@ -201,7 +201,7 @@ function adjustParagraph(paragraph: AD.Paragraph.Paragraph): Array<AD.SectionEle
             type: "LineBreak",
             style: child.style,
             nestedStyleNames: child.nestedStyleNames,
-            styleName: child.styleName
+            styleName: child.styleName,
           };
           newChildren.push(lineBreak);
         }

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

@@ -1,4 +1,4 @@
-import * as AbstractImage from "abstract-image";
+import type * as AbstractImage from "abstract-image";
 import svgToPdfKit from "svg-to-pdfkit";
 import * as AD from "../../abstract-document/index.js";
 import { getFontNameStyle, getFontName, isFontAvailable } from "./font.js";
@@ -17,7 +17,7 @@ export function renderImage(
   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;
 
   const position = AD.Point.create(finalRect.x, finalRect.y);
@@ -37,15 +37,15 @@ export function renderImage(
     image.horizontalAlignment === "Center"
       ? (rect.width - drawnW) / 2
       : image.horizontalAlignment === "Right"
-      ? rect.width - drawnW
-      : 0;
+        ? rect.width - drawnW
+        : 0;
 
   const offsetY =
     image.verticalAlignment === "Center"
       ? (rect.height - drawnH) / 2
       : image.verticalAlignment === "Bottom"
-      ? rect.height - drawnH
-      : 0;
+        ? rect.height - drawnH
+        : 0;
 
   pdf.save();
   pdf.translate(position.x + offsetX, position.y + offsetY).scale(scale);
@@ -162,14 +162,14 @@ function abstractComponentToPdf(
         component.horizontalGrowthDirection === "left"
           ? -stringWidth
           : component.horizontalGrowthDirection === "uniform"
-          ? -stringWidth * 0.5
-          : 0;
+            ? -stringWidth * 0.5
+            : 0;
       const dy =
         component.verticalGrowthDirection === "up"
           ? -stringHeight
           : component.verticalGrowthDirection === "uniform"
-          ? -stringHeight * 0.5
-          : 0;
+            ? -stringHeight * 0.5
+            : 0;
       pdf
         .font(font)
         .fontSize(component.fontSize)
@@ -230,7 +230,6 @@ function addWithSvgToPdfKit(
   let svgUpdated = svg;
   ["fill=", "stroke=", "color="].forEach((t) => {
     let index = 0;
-    // eslint-disable-next-line no-constant-condition
     while (true) {
       index = svgUpdated.indexOf(t, index);
       if (index === -1) break;
@@ -247,7 +246,6 @@ function addWithSvgToPdfKit(
 
   ["stroke-dasharray="].forEach((t) => {
     let index = 0;
-    // eslint-disable-next-line no-constant-condition
     while (true) {
       index = svgUpdated.indexOf(t, index);
       if (index === -1) break;

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

@@ -1,14 +1,17 @@
 import * as AD from "../../abstract-document/index.js";
 import { preProcess } from "./pre-process.js";
 import { measure, measurePages } from "./measure.js";
-import { paginate, Page, getHeaderAndFooter } from "./paginate.js";
+import type { Page } from "./paginate.js";
+import { paginate, getHeaderAndFooter } from "./paginate.js";
 import { updatePageRefs } from "./update-refs.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";
+// oxlint-disable-next-line import/no-named-as-default -- standard pdfkit import idiom
 import PDFDocument from "pdfkit";
-import { PdfKitAlignment, rowsCombineTextRuns, rowsSplit } from "./textRunRow.js";
+import type { PdfKitAlignment } from "./textRunRow.js";
+import { rowsCombineTextRuns, rowsSplit } from "./textRunRow.js";
 
 export type PdfExportOptions = {
   compress: boolean;

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

@@ -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 {