abstract-document 20.0.3 → 20.1.0

package/src/abstract-document-xml/abstract-doc-of-xml/abstract-doc-of-xml.ts

@@ -1,16 +1,16 @@
+import { parseHandlebarsXml, type XmlElement } from "handlebars-xml";
+import { getFontStyleName } from "../../abstract-document-exporters/pdf/font.js";
 import { addResources, merge } from "../../abstract-document/abstract-doc.js";
 import type { AbstractDoc } from "../../abstract-document/index.js";
-import * as StyleKey from "../../abstract-document/styles/style-key.js";
+import type { Font } from "../../abstract-document/primitives/font.js";
 import type { Resources } from "../../abstract-document/resources.js";
+import * as StyleKey from "../../abstract-document/styles/style-key.js";
 import type { ADCreatorFn } from "./creator.js";
 import { creators, propsCreators } from "./creator.js";
-import { parseHandlebarsXml, type XmlElement } from "handlebars-xml";
-import { getFontStyleName } from "../../abstract-document-exporters/pdf/font.js";
-import type { Font } from "../../abstract-document/primitives/font.js";
 
 export type TemplateInput = {
   readonly template: string;
-  readonly data: any;
+  readonly data: unknown;
   readonly partials: Record<string, string>;
 };
 
@@ -22,10 +22,7 @@ export type Format = "PDF" | "DOCX";
 
 export async function abstractDocsXml(
   templateInputs: ReadonlyArray<TemplateInput>,
-  getResources: (
-    imageUrls: Record<string, true>,
-    fontFamilies: Record<string, Partial<Record<keyof Font, boolean>>>
-  ) => Promise<Resources>
+  getResources: (imageUrls: Record<string, true>, fontFamilies: Record<string, Partial<Record<keyof Font, boolean>>>) => Promise<Resources>
 ): Promise<AbstractDoxXmlsResult> {
   try {
     const abstractDocs = Array<AbstractDoc.AbstractDoc>();
@@ -35,38 +32,29 @@ export async function abstractDocsXml(
       const [ad, newImageUrls, newFontFamilies] = abstractDocXml(r.template, r.data, r.partials);
       abstractDocs.push(ad);
       imageUrls = { ...imageUrls, ...newImageUrls };
-      Object.entries(newFontFamilies).forEach(
-        ([font, types]) => (fontFamilies[font] = { ...fontFamilies[font], ...types })
-      );
+      Object.entries(newFontFamilies).forEach(([font, types]) => (fontFamilies[font] = { ...fontFamilies[font], ...types }));
     }
     const resources = await getResources(imageUrls, fontFamilies);
     const combinedReport = addResources(merge(...abstractDocs), resources);
     return { type: "Ok", value: combinedReport };
   } catch (e) {
-    return { type: "Err", error: typeof e === "string" ? e : (e as any).message };
+    return { type: "Err", error: typeof e === "string" ? e : e.message };
   }
 }
 
 export function abstractDocXml(
   template: string,
-  data: any,
+  data: unknown,
   partials: Record<string, string>
-): readonly [
-  AbstractDoc.AbstractDoc,
-  imageUrls: Record<string, true>,
-  fontFamilies: Record<string, Partial<Record<keyof Font, boolean>>>
-] {
+): readonly [AbstractDoc.AbstractDoc, imageUrls: Record<string, true>, fontFamilies: Record<string, Partial<Record<keyof Font, boolean>>>] {
   const xml = parseHandlebarsXml(template, data, partials);
   const [imageUrls, fontFamilies, styleNames] = extractImageFontsStyleNames(xml);
-  const doc = abstractDocXmlRecursive(creators(styleNames), xml[0]!);
+  const doc = abstractDocXmlRecursive(creators(styleNames), xml[0]);
   return [doc, imageUrls, fontFamilies];
 }
 
-function abstractDocXmlRecursive(
-  creators: Record<string, ADCreatorFn>,
-  xmlElement: XmlElement,
-  onlyChildren: boolean = false
-): any {
+// oxlint-disable-next-line typescript/no-explicit-any -- produces whichever AD model type (or a children array) the caller expects at that recursion site; see the single external call site's tuple return, which assigns this straight to AbstractDoc.AbstractDoc
+function abstractDocXmlRecursive(creators: Record<string, ADCreatorFn>, xmlElement: XmlElement, onlyChildren: boolean = false): any {
   const children = [];
   const props: Record<string, unknown> = {};
   for (const childElement of xmlElement.children ?? []) {
@@ -74,7 +62,7 @@ function abstractDocXmlRecursive(
     if (childName !== undefined) {
       if (childName === "StyleNames") {
         props["styles"] = abstractDocXmlRecursive(creators, childElement);
-      } else if (childName === "StyleName" && childElement.attributes && childElement.attributes["name"]) {
+      } else if (childName === "StyleName" && childElement.attributes?.["name"]) {
         const styleName = StyleKey.create(childElement.attributes["type"], childElement.attributes["name"]);
         const style = abstractDocXmlRecursive(creators, childElement);
         props[styleName] = style;
@@ -110,9 +98,9 @@ function abstractDocXmlRecursive(
   //
   const obj = creator(allProps, children) as { [k: string]: unknown };
 
+  // oxlint-disable-next-line unicorn/no-array-sort
   for (const propName of Object.keys(allProps).sort((a, b) => a.length - b.length)) {
-    const propsCreator =
-      allProps[propName] !== undefined && propsCreators[propName] ? propsCreators[propName] : undefined;
+    const propsCreator = allProps[propName] !== undefined && propsCreators[propName] ? propsCreators[propName] : undefined;
     if (propsCreator) {
       const attributeName = getSuffixedAttributeBaseName(propsCreator.name) ?? propsCreator.name;
       obj[attributeName] = propsCreator(allProps, children);
@@ -189,16 +177,16 @@ function extractImageFontsStyleNames(
   styleNames: Record<string, string> = {},
   images: Record<string, true> = {},
   fonts: Record<string, Partial<Record<keyof Font, boolean>>> = {},
-  currentFontFamily: string | undefined = undefined
+  currentFontFamily?: string
 ): readonly [
   imageUrls: Record<string, true>,
   fontFamilies: Record<string, Partial<Record<keyof Font, boolean>>>,
-  styleNames: Record<string, string>
+  styleNames: Record<string, string>,
 ] {
   let crFntFam = currentFontFamily;
   xmlElement.forEach((item) => {
     if (item.tagName.startsWith("Image") && item.attributes?.["src"]) {
-      images[item.attributes["src"] as string] = true;
+      images[item.attributes["src"]] = true;
     } else if (item.tagName === "style") {
       const fontFamily = crFntFam ?? styleFamilies["Default"];
       if (fontFamily) {
@@ -217,15 +205,15 @@ function extractImageFontsStyleNames(
       }
     } else if (item.attributes?.["fontFamily"]) {
       const styleName = getFontStyleName(item.attributes);
-      (fonts[item.attributes["fontFamily"] as string] ??= {})[styleName] = true;
+      (fonts[item.attributes["fontFamily"]] ??= {})[styleName] = true;
       if (item.tagName === "StyleName" && item.attributes["name"] && item.attributes["type"]) {
-        styleNames[item.attributes["name"] as string] = item.attributes["type"];
+        styleNames[item.attributes["name"]] = item.attributes["type"];
       }
     } else if (item.tagName === "StyleName" && item.attributes["name"] && item.attributes["type"]) {
-      styleNames[item.attributes["name"] as string] = item.attributes["type"];
+      styleNames[item.attributes["name"]] = item.attributes["type"];
       if (item.attributes["type"] === "TextStyle" && item.attributes["fontFamily"]) {
         const styleName = getFontStyleName(item.attributes);
-        styleFamilies[item.attributes["name"] as string] = item.attributes["fontFamily"];
+        styleFamilies[item.attributes["name"]] = item.attributes["fontFamily"];
         (fonts[item.attributes["fontFamily"]] ??= {})[styleName] = true;
       }
     }

package/src/abstract-document-xml/abstract-doc-of-xml/creator.ts

@@ -17,14 +17,7 @@ import {
   TocSeparator,
   ImageResource,
 } from "../../abstract-document/index.js";
-import type {
-  TextRowProps,
-  TextCellProps,
-  TextParagraphProps,
-  ImageCellProps,
-  ImageParagraphProps,
-  ImageRowProps,
-} from "./custom-elements.js";
+import type { TextRowProps, TextCellProps, TextParagraphProps, ImageCellProps, ImageParagraphProps, ImageRowProps } from "./custom-elements.js";
 import { TextRow, TextCell, TextParagraph, ImageCell, ImageParagraph, ImageRow } from "./custom-elements.js";
 
 export type ADCreatorFn = (props?: Record<string, unknown>, children?: ReadonlyArray<unknown>) => unknown;
@@ -39,13 +32,10 @@ export const creators: (styleNames: Record<string, string>) => Record<string, AD
     TextParagraph: (props: TextParagraphProps) => TextParagraph(props, styleNames),
     TextRun: (props) => TextRun.create(props as unknown as TextRun.TextRunProps),
     ImageRow: (props: Record<string, unknown>) => ImageRow(imageProps(props) as unknown as ImageRowProps, styleNames),
-    ImageCell: (props: Record<string, unknown>) =>
-      ImageCell(imageProps(props) as unknown as ImageCellProps, styleNames),
-    ImageParagraph: (props: Record<string, unknown>) =>
-      ImageParagraph(imageProps(props) as unknown as ImageParagraphProps, styleNames),
+    ImageCell: (props: Record<string, unknown>) => ImageCell(imageProps(props) as unknown as ImageCellProps, styleNames),
+    ImageParagraph: (props: Record<string, unknown>) => ImageParagraph(imageProps(props) as unknown as ImageParagraphProps, styleNames),
     Image: (props: Record<string, unknown>) => Image.create(imageProps(props) as unknown as Image.ImageProps),
-    Table: (props, children: ReadonlyArray<TableRow.TableRow>) =>
-      Table.create(props as unknown as Table.TableProps, children),
+    Table: (props, children: ReadonlyArray<TableRow.TableRow>) => Table.create(props as unknown as Table.TableProps, children),
     TableRow: (props, children: ReadonlyArray<TableCell.TableCell>) => TableRow.create(props, children),
     TableCell: (props, children: ReadonlyArray<SectionElement.SectionElement>) => TableCell.create(props, children),
     TextField: (props) => TextField.create(props as unknown as TextField.TextFieldProps),
@@ -57,9 +47,7 @@ export const creators: (styleNames: Record<string, string>) => Record<string, AD
 };
 
 export const propsCreators: Record<string, ADCreatorFn> = {
-  styles: (props: {
-    readonly styles: Record<string, Record<string, string | number> & { readonly type: string }>;
-  }): unknown => {
+  styles: (props: { readonly styles: Record<string, Record<string, string | number> & { readonly type: string }> }): unknown => {
     const fixedStyles: Record<string, Record<string, string | number>> = {};
     if (props.styles) {
       Object.keys(props.styles).forEach((key: string) => {
@@ -71,6 +59,7 @@ export const propsCreators: Record<string, ADCreatorFn> = {
   },
   columnWidths: (props: { readonly columnWidths: string; readonly columnMultiplier: string }): unknown => {
     const columnWidths = (props.columnWidths ?? "")
+      // oxlint-disable-next-line typescript/no-unnecessary-type-conversion -- allProps can carry non-strings
       .toString()
       .split(",")
       .map((item: string) => {
@@ -87,10 +76,13 @@ export const propsCreators: Record<string, ADCreatorFn> = {
       return props.paperSize;
     }
     const parts = props.paperSize.split("x");
-    return { width: Number(parts[0]) ?? 595, height: Number(parts[1]) ?? 842 };
+    const width = Number(parts[0] ?? 595);
+    const height = Number(parts[1] ?? 842);
+    return { width: Number.isNaN(width) ? 595 : width, height: Number.isNaN(height) ? 842 : height };
   },
   borders: (props: { readonly borders: string }): unknown => {
     const borders: { [k: string]: number } = { top: 0, right: 0, bottom: 0, left: 0 };
+    // oxlint-disable-next-line typescript/no-unnecessary-type-conversion -- allProps can carry non-strings
     const propBorders = props.borders.toString().split(" ");
     if (!propBorders) {
       return borders;
@@ -157,6 +149,7 @@ export const propsCreators: Record<string, ADCreatorFn> = {
   padding: (props: { readonly padding: string }): unknown => {
     const padding: { [k: string]: number } = { top: 0, right: 0, bottom: 0, left: 0 };
 
+    // oxlint-disable-next-line typescript/no-unnecessary-type-conversion -- allProps can carry non-strings
     const paddings = props.padding.toString().split(" ");
     if (!paddings) {
       return padding;
@@ -222,6 +215,7 @@ export const propsCreators: Record<string, ADCreatorFn> = {
   },
   margins: (props: { readonly margins: string }): unknown => {
     const margins: { [k: string]: number } = { top: 0, right: 0, bottom: 0, left: 0 };
+    // oxlint-disable-next-line typescript/no-unnecessary-type-conversion -- allProps can carry non-strings
     const propMargins = props.margins.toString().split(" ");
     if (!propMargins) {
       return margins;
@@ -314,22 +308,19 @@ export const propsCreators: Record<string, ADCreatorFn> = {
   },
   borderColorBottom: (props: { readonly borderColorBottom: string }): unknown => {
     const allProps = props as Record<string, unknown>;
-    const boderColors: { top?: string; bottom?: string; left?: string; right?: string } =
-      allProps["borderColors"] ?? {};
+    const boderColors: { top?: string; bottom?: string; left?: string; right?: string } = allProps["borderColors"] ?? {};
     boderColors.bottom = props.borderColorBottom;
     return boderColors;
   },
   borderColorLeft: (props: { readonly borderColorLeft: string }): unknown => {
     const allProps = props as Record<string, unknown>;
-    const boderColors: { top?: string; bottom?: string; left?: string; right?: string } =
-      allProps["borderColors"] ?? {};
+    const boderColors: { top?: string; bottom?: string; left?: string; right?: string } = allProps["borderColors"] ?? {};
     boderColors.left = props.borderColorLeft;
     return boderColors;
   },
   borderColorRight: (props: { readonly borderColorRight: string }): unknown => {
     const allProps = props as Record<string, unknown>;
-    const boderColors: { top?: string; bottom?: string; left?: string; right?: string } =
-      allProps["borderColors"] ?? {};
+    const boderColors: { top?: string; bottom?: string; left?: string; right?: string } = allProps["borderColors"] ?? {};
     boderColors.right = props.borderColorRight;
     return boderColors;
   },
@@ -361,8 +352,7 @@ export const propsCreators: Record<string, ADCreatorFn> = {
   lineBreak: (props: { readonly lineBreak: string }): unknown => strToBool(props.lineBreak),
   mediumBold: (props: { readonly mediumBold: string }): unknown => strToBool(props.mediumBold),
   noTopBottomMargin: (props: { readonly noTopBottomMargin: string }): unknown => strToBool(props.noTopBottomMargin),
-  keepTogetherSections: (props: { readonly keepTogetherSections: string }): unknown =>
-    strToBool(props.keepTogetherSections),
+  keepTogetherSections: (props: { readonly keepTogetherSections: string }): unknown => strToBool(props.keepTogetherSections),
   keepTogether: (props: { readonly keepTogether: string }): unknown => strToBool(props.keepTogether),
   differentFirstPage: (props: { readonly differentFirstPage: string }): unknown => strToBool(props.differentFirstPage),
 };
@@ -376,9 +366,7 @@ function imageProps(props: Record<string, unknown>): Record<string, unknown> {
     height: Number(props["height"]),
     imageResource: ImageResource.create({
       id: props["src"] as string,
-      abstractImage: createAbstractImage(zero, size, white, [
-        createBinaryImage(zero, zero, "png", { type: "url", url: props["src"] as string }),
-      ]),
+      abstractImage: createAbstractImage(zero, size, white, [createBinaryImage(zero, zero, "png", { type: "url", url: props["src"] as string })]),
       renderScale: 1,
     }),
   };

package/src/abstract-document-xml/abstract-doc-of-xml/custom-elements.tsx

@@ -20,11 +20,8 @@ const stylePropsKeys: Record<string, boolean> = {
   GroupStyle: true,
 };
 
-export function extractStyleNames(
-  styleNames: string | undefined,
-  styleNameTypes: Record<string, string>
-): Partial<StyleProps> {
-  const names = (styleNames || "").split(",");
+export function extractStyleNames(styleNames: string | undefined, styleNameTypes: Record<string, string>): Partial<StyleProps> {
+  const names = (styleNames ?? "").split(",");
 
   let styleNameProps = {};
 
@@ -102,27 +99,14 @@ export type ImageCellProps = Omit<ImageParagraphProps, "style"> & {
 };
 
 export function ImageCell(props: ImageCellProps, styleNameTypes: Record<string, string>): TableCell.TableCell {
-  const {
-    imageResource,
-    width,
-    height,
-    horizontalAlignment,
-    verticalAlignment,
-    paragraphStyle,
-    style,
-    columnSpan,
-    rowSpan,
-  } = props;
+  const { imageResource, width, height, horizontalAlignment, verticalAlignment, paragraphStyle, style, columnSpan, rowSpan } = props;
   const styleNames = extractStyleNames(props.styleNames, styleNameTypes);
-  const imageElement =
-    imageResource && Image.create({ imageResource, width, height, horizontalAlignment, verticalAlignment });
+  const imageElement = imageResource && Image.create({ imageResource, width, height, horizontalAlignment, verticalAlignment });
   const pararaphProps = {
     style: paragraphStyle ? { ...paragraphStyle, type: "ParagraphStyle" } : undefined,
     styleName: styleNames.ParagraphStyle,
   } as ParagraphProps;
-  const paragraph = imageElement
-    ? Paragraph.create(pararaphProps, [imageElement])
-    : Paragraph.create(pararaphProps, [ImageMissing]);
+  const paragraph = imageElement ? Paragraph.create(pararaphProps, [imageElement]) : Paragraph.create(pararaphProps, [ImageMissing]);
   return TableCell.create({ columnSpan, rowSpan, style, styleName: styleNames.TableCellStyle }, [paragraph]);
 }
 
@@ -131,18 +115,12 @@ export type ImageParagraphProps = ImageProps & {
   readonly styleNames?: string;
 };
 
-export function ImageParagraph(
-  props: ImageParagraphProps,
-  styleNameTypes: Record<string, string>
-): Paragraph.Paragraph | undefined {
+export function ImageParagraph(props: ImageParagraphProps, styleNameTypes: Record<string, string>): Paragraph.Paragraph | undefined {
   const { imageResource, width, height, style, horizontalAlignment, verticalAlignment } = props;
   const styleNames = extractStyleNames(props.styleNames, styleNameTypes);
-  const imageElement =
-    imageResource && Image.create({ imageResource, width, height, horizontalAlignment, verticalAlignment });
+  const imageElement = imageResource && Image.create({ imageResource, width, height, horizontalAlignment, verticalAlignment });
   const pararaphProps = { style, styleName: styleNames.ParagraphStyle };
-  return imageElement
-    ? Paragraph.create(pararaphProps, [imageElement])
-    : Paragraph.create(pararaphProps, [ImageMissing]);
+  return imageElement ? Paragraph.create(pararaphProps, [imageElement]) : Paragraph.create(pararaphProps, [ImageMissing]);
 }
 
 const ImageMissing = TextRun.create({ text: "Image missing" });

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

@@ -319,4 +319,4 @@ export const layoutFoundation = `<xs:complexType name="LayoutFoundation">
 export const pageColumnLayout = `<xs:complexType name="PageColumnLayout">
 	<xs:attribute name="columnCount" type="xs:decimal" />
 	<xs:attribute name="columnGap" type="xs:decimal" />
-</xs:complexType>`;
+</xs:complexType>`;

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

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

package/lib/abstract-document/table/text-row.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=text-row.d.ts.map

package/lib/abstract-document/table/text-row.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"text-row.d.ts","sourceRoot":"","sources":["../../../src/abstract-document/table/text-row.ts"],"names":[],"mappings":""}

package/lib/abstract-document/table/text-row.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=text-row.js.map

package/lib/abstract-document/table/text-row.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"text-row.js","sourceRoot":"","sources":["../../../src/abstract-document/table/text-row.ts"],"names":[],"mappings":""}

package/lib/abstract-document-exporters/docx/docx-document-renderer.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=docx-document-renderer.d.ts.map

package/lib/abstract-document-exporters/docx/docx-document-renderer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"docx-document-renderer.d.ts","sourceRoot":"","sources":["../../../src/abstract-document-exporters/docx/docx-document-renderer.ts"],"names":[],"mappings":""}