abstract-document 20.1.6 → 20.2.1

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

@@ -17,7 +17,7 @@ import {
   TocSeparator,
   ImageResource,
 } from "../../abstract-document/index.js";
-import type { TextRowProps, TextCellProps, TextParagraphProps, ImageCellProps, ImageParagraphProps, ImageRowProps } from "./custom-elements.js";
+import type { 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;
@@ -27,22 +27,23 @@ export const creators: (styleNames: Record<string, string>) => Record<string, AD
     AbstractDoc: ((props, children: ReadonlyArray<Section.Section>) => AbstractDoc.create(props, children)) as ADCreatorFn,
     Section: ((props, children: ReadonlyArray<SectionElement.SectionElement>) => Section.create(props, children)) as ADCreatorFn,
     Paragraph: ((props, children: ReadonlyArray<Atom.Atom>) => Paragraph.create(props, children)) as ADCreatorFn,
-    TextRow: ((props: TextRowProps) => TextRow(props, styleNames)) as ADCreatorFn,
-    TextCell: ((props: TextCellProps) => TextCell(props, styleNames)) as ADCreatorFn,
-    TextParagraph: ((props: TextParagraphProps) => TextParagraph(props, styleNames)) as ADCreatorFn,
-    TextRun: (props) => TextRun.create(props as unknown as TextRun.TextRunProps),
+    TextRow: (props) => TextRow({ ...props, text: requireText(props) }, styleNames),
+    TextCell: (props) => TextCell({ ...props, text: requireText(props) }, styleNames),
+    TextParagraph: (props) => TextParagraph({ ...props, text: requireText(props) }, styleNames),
+    TextRun: (props) => TextRun.create({ ...props, text: requireText(props) }),
     ImageRow: ((props: Record<string, unknown>) => ImageRow(imageProps(props) as unknown as ImageRowProps, styleNames)) as ADCreatorFn,
     ImageCell: ((props: Record<string, unknown>) => ImageCell(imageProps(props) as unknown as ImageCellProps, styleNames)) as ADCreatorFn,
     ImageParagraph: ((props: Record<string, unknown>) =>
       ImageParagraph(imageProps(props) as unknown as ImageParagraphProps, styleNames)) as ADCreatorFn,
     Image: ((props: Record<string, unknown>) => Image.create(imageProps(props) as unknown as Image.ImageProps)) as ADCreatorFn,
-    Table: ((props, children: ReadonlyArray<TableRow.TableRow>) => Table.create(props as unknown as Table.TableProps, children)) as ADCreatorFn,
+    Table: ((props, children: ReadonlyArray<TableRow.TableRow>) =>
+      Table.create({ ...props, columnWidths: props?.["columnWidths"] ?? [] } as unknown as Table.TableProps, children)) as ADCreatorFn,
     TableRow: ((props, children: ReadonlyArray<TableCell.TableCell>) => TableRow.create(props, children)) as ADCreatorFn,
     TableCell: ((props, children: ReadonlyArray<SectionElement.SectionElement>) => TableCell.create(props, children)) as ADCreatorFn,
-    TextField: (props) => TextField.create(props as unknown as TextField.TextFieldProps),
-    Group: (props, children) => Group.create(props, children as ReadonlyArray<Group.Group>),
+    TextField: (props) => TextField.create({ ...props, fieldType: requireFieldType(props) }),
+    Group: (props, children) => Group.create(props, children as ReadonlyArray<SectionElement.SectionElement>),
     PageBreak: () => PageBreak.create(),
-    Markdown: (props) => Markdown.create(props as unknown as Markdown.MarkdownProps),
+    Markdown: (props) => Markdown.create({ ...props, text: requireText(props) }),
     TocSeparator: (props) => TocSeparator.create(props as TocSeparator.TocSeparatorProps),
   };
 };
@@ -50,23 +51,17 @@ 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 => {
     const fixedStyles: Record<string, Record<string, string | number>> = {};
-    if (props.styles) {
-      Object.keys(props.styles).forEach((key: string) => {
-        fixedStyles[key] = { ...props.styles[key] };
-      });
-    }
+    Object.keys(props.styles).forEach((key: string) => {
+      fixedStyles[key] = { ...props.styles[key] };
+    });
 
     return { ...fixedStyles, ...DefaultStyles.createStandardStyles() };
   }) as 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) => {
-        const number = Number(item);
-        return number === 0 || Number.isNaN(number) ? Infinity : number;
-      });
+    const columnWidths = props.columnWidths.split(",").map((item: string) => {
+      const number = Number(item);
+      return number === 0 || Number.isNaN(number) ? Infinity : number;
+    });
     if (props.columnMultiplier) {
       return columnWidths.map((l) => l * Number(props.columnMultiplier));
     }
@@ -83,11 +78,7 @@ export const propsCreators: Record<string, ADCreatorFn> = {
   }) as ADCreatorFn,
   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;
-    }
+    const propBorders = props.borders.split(" ");
 
     if (propBorders.length === 1) {
       borders["top"] = Number(propBorders[0]);
@@ -150,11 +141,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;
-    }
+    const paddings = props.padding.split(" ");
 
     if (paddings.length === 1) {
       padding["top"] = Number(paddings[0]);
@@ -216,11 +203,7 @@ export const propsCreators: Record<string, ADCreatorFn> = {
   }) as 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;
-    }
+    const propMargins = props.margins.split(" ");
 
     if (propMargins.length === 1) {
       margins["top"] = Number(propMargins[0]);
@@ -358,6 +341,21 @@ export const propsCreators: Record<string, ADCreatorFn> = {
   differentFirstPage: ((props: { readonly differentFirstPage: string }): unknown => strToBool(props.differentFirstPage)) as ADCreatorFn,
 };
 
+function requireText(props: Record<string, unknown> | undefined): string {
+  const text = props?.["text"];
+  return typeof text === "string" ? text : "";
+}
+
+const validFieldTypes: ReadonlyArray<TextField.FieldType> = ["Date", "PageNumber", "TotalPages", "PageNumberOf"];
+
+function requireFieldType(props: Record<string, unknown> | undefined): TextField.FieldType {
+  const fieldType = props?.["fieldType"];
+  if (validFieldTypes.includes(fieldType as TextField.FieldType)) {
+    return fieldType as TextField.FieldType;
+  }
+  throw new Error(`<TextField> requires a "fieldType" attribute of ${validFieldTypes.join(", ")}, got: ${String(fieldType)}`);
+}
+
 const zero = createPoint(0, 0);
 const size = createSize(0, 0);
 function imageProps(props: Record<string, unknown>): Record<string, unknown> {
@@ -373,21 +371,10 @@ function imageProps(props: Record<string, unknown>): Record<string, unknown> {
   };
 }
 
-const strToBool = (str: string | undefined): boolean => {
-  if (str === undefined) {
-    return false;
-  }
-  const validBools = {
-    "1": true,
-    true: true,
-  };
-  return str in validBools;
-};
+// bold/italic/etc. are declared `xs:boolean` in the XSD schema; XSD's boolean lexical space is {true, false, 1, 0}
+const strToBool = (str: string | undefined): boolean => str === "true" || str === "1";
 
 const strToNum = (str: string | undefined): number => {
   const num = Number(str);
-  if (Number.isNaN(num)) {
-    return 0;
-  }
-  return num;
+  return Number.isFinite(num) ? num : 0;
 };

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

@@ -35,7 +35,9 @@ export function extractStyleNames(styleNames: string | undefined, styleNameTypes
   return styleNameProps;
 }
 
-export type TextRowProps = Omit<TextCellProps, "style"> & { readonly cellStyle?: TableCellStyle.TableCellStyle };
+export type TextRowProps = Omit<TextCellProps, "style"> & {
+  readonly cellStyle?: TableCellStyle.TableCellStyle;
+};
 
 export function TextRow(props: TextRowProps, styleNameTypes: Record<string, string>): TableRow.TableRow {
   return TableRow.create({}, [TextCell({ ...props, style: props.cellStyle }, styleNameTypes)]);
@@ -85,7 +87,9 @@ export function TextParagraph(props: TextParagraphProps, styleNameTypes: Record<
   return Paragraph.create({ style, styleName: styleNames.ParagraphStyle }, [textRun]);
 }
 
-export type ImageRowProps = Omit<ImageCellProps, "style"> & { readonly cellStyle?: TableCellStyle.TableCellStyle };
+export type ImageRowProps = Omit<ImageCellProps, "style"> & {
+  readonly cellStyle?: TableCellStyle.TableCellStyle;
+};
 
 export function ImageRow(props: ImageRowProps, styleNameTypes: Record<string, string>): TableRow.TableRow {
   return TableRow.create({}, [ImageCell({ ...props, style: props.cellStyle }, styleNameTypes)]);
@@ -101,12 +105,18 @@ 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 styleNames = extractStyleNames(props.styleNames, styleNameTypes);
-  const imageElement = imageResource && Image.create({ imageResource, width, height, horizontalAlignment, verticalAlignment });
+  const imageElement = 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 = Paragraph.create(pararaphProps, [imageElement]);
   return TableCell.create({ columnSpan, rowSpan, style, styleName: styleNames.TableCellStyle }, [paragraph]);
 }
 
@@ -118,9 +128,13 @@ export type ImageParagraphProps = ImageProps & {
 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 = Image.create({
+    imageResource,
+    width,
+    height,
+    horizontalAlignment,
+    verticalAlignment,
+  });
   const pararaphProps = { style, styleName: styleNames.ParagraphStyle };
-  return imageElement ? Paragraph.create(pararaphProps, [imageElement]) : Paragraph.create(pararaphProps, [ImageMissing]);
+  return Paragraph.create(pararaphProps, [imageElement]);
 }
-
-const ImageMissing = TextRun.create({ text: "Image missing" });

package/src/custom_typings/pdf2json/index.d.ts

@@ -1 +1,10 @@
-declare module "pdf2json";
+declare module "pdf2json" {
+  // oxlint-disable-next-line no-redeclare -- value + type share a name, the standard pattern for typing a constructible class from an untyped module
+  interface PDFParser {
+    on: ((event: "pdfParser_dataError", callback: (data: { parserError: string }) => void) => void) &
+      ((event: "pdfParser_dataReady", callback: (data: unknown) => void) => void);
+    parseBuffer: (buffer: Buffer) => void;
+  }
+  const PDFParser: new () => PDFParser;
+  export default PDFParser;
+}

package/src/custom_typings/remark-parse/index.d.ts

@@ -1 +1,4 @@
-declare module "remark-parse";
+declare module "remark-parse" {
+  const remarkParse: unknown;
+  export default remarkParse;
+}

package/src/custom_typings/remark-sub-super/index.d.ts

@@ -1 +1,4 @@
-declare module "remark-sub-super";
+declare module "remark-sub-super" {
+  const remarkSubSuper: unknown;
+  export default remarkSubSuper;
+}

package/src/custom_typings/svg-to-pdfkit/index.d.ts

@@ -1 +1,4 @@
-declare module "svg-to-pdfkit";
+declare module "svg-to-pdfkit" {
+  function svgToPdfKit(doc: PDFKit.PDFDocument, svg: string, x: number, y: number, options?: Record<string, unknown>): void;
+  export default svgToPdfKit;
+}

package/src/custom_typings/unified/index.d.ts

@@ -1 +1,8 @@
-declare module "unified";
+declare module "unified" {
+  interface Processor {
+    use: (plugin: unknown, ...settings: Array<unknown>) => Processor;
+    parse: (source: string) => unknown;
+  }
+  function unified(): Processor;
+  export default unified;
+}