abstract-document 20.2.0 → 20.2.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "abstract-document",
-  "version": "20.2.0",
-  "gitHead": "09174caac85ce546198a6aefad838b7dff393ea9",
+  "version": "20.2.2",
+  "gitHead": "1f7b1d4af06f5e7e7e16edcec9078c9b852a0dd1",
   "description": "Dynamically create documents using code or JSX and render to any format",
   "license": "MIT",
   "repository": "https://github.com/dividab/abstract-visuals/tree/master/packages/abstract-document",
@@ -41,11 +41,11 @@
     }
   },
   "dependencies": {
-    "abstract-image": "^13.2.0",
+    "abstract-image": "^13.2.1",
     "docx": "^9.7.1",
     "fast-xml-parser": "^4.5.0",
     "handlebars": "4.7.8",
-    "handlebars-xml": "^0.6.0",
+    "handlebars-xml": "^0.6.1",
     "moment": "^2.30.1",
     "pdfkit": "^0.20.2",
     "remark-parse": "^6.0.3",

package/src/abstract-document-jsx/index.ts

@@ -79,9 +79,9 @@ function renderChildren(element: FakeElement): Array<unknown> {
         return [];
       }
       if (Array.isArray(c)) {
-        return c.map(render);
+        return c.map(render) as Array<unknown>;
       }
-      return render(c);
+      return render(c) as unknown;
     });
   } else {
     const elements = render(element.props.children); // Markdown returns an array of elements already

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

@@ -138,6 +138,7 @@ function abstractDocXmlRecursive(creators: Record<string, ADCreatorFn>, xmlEleme
           break;
         case "TextField":
         case "HyperLink":
+        case "LineBreak":
         case "TextRun":
           obj["style"] = { ...obj["style"], type: "TextStyle" };
           break;

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

@@ -4,7 +4,10 @@ import {
   AbstractDoc,
   DefaultStyles,
   Group,
+  HyperLink,
   Image,
+  LineBreak,
+  LinkTarget,
   Markdown,
   PageBreak,
   Paragraph,
@@ -17,8 +20,18 @@ import {
   TocSeparator,
   ImageResource,
 } from "../../abstract-document/index.js";
-import type { TextRowProps, TextCellProps, TextParagraphProps, ImageCellProps, ImageParagraphProps, ImageRowProps } from "./custom-elements.js";
-import { TextRow, TextCell, TextParagraph, ImageCell, ImageParagraph, ImageRow } from "./custom-elements.js";
+import type { ImageCellProps, ImageParagraphProps, ImageRowProps } from "./custom-elements.js";
+import {
+  TextRow,
+  TextCell,
+  TextParagraph,
+  HyperLinkRow,
+  HyperLinkCell,
+  HyperLinkParagraph,
+  ImageCell,
+  ImageParagraph,
+  ImageRow,
+} from "./custom-elements.js";
 
 export type ADCreatorFn = (props?: Record<string, unknown>, children?: ReadonlyArray<unknown>) => unknown;
 
@@ -27,22 +40,30 @@ 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),
+    HyperLinkRow: (props) => HyperLinkRow({ ...props, text: requireText(props), target: requireTarget(props, "HyperLinkRow") }, styleNames),
+    HyperLinkParagraph: (props) =>
+      HyperLinkParagraph({ ...props, text: requireText(props), target: requireTarget(props, "HyperLinkParagraph") }, styleNames),
+    HyperLinkCell: (props) => HyperLinkCell({ ...props, text: requireText(props), target: requireTarget(props, "HyperLinkCell") }, styleNames),
+    TextRun: (props) => TextRun.create({ ...props, text: requireText(props) }),
+    HyperLink: (props) => HyperLink.create({ ...props, text: requireText(props), target: requireTarget(props, "HyperLink") }),
+    LinkTarget: (props) => LinkTarget.create({ name: requireName(props) }),
+    LineBreak: (props) => LineBreak.create(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),
   };
 };
@@ -340,6 +361,37 @@ 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 : "";
+}
+
+function requireTarget(props: Record<string, unknown> | undefined, element: string): string {
+  const target = props?.["target"];
+  if (typeof target !== "string") {
+    throw new Error(`<${element}> requires a "target" attribute`);
+  }
+  return target;
+}
+
+function requireName(props: Record<string, unknown> | undefined): string {
+  const name = props?.["name"];
+  if (typeof name !== "string") {
+    throw new Error('<LinkTarget> requires a "name" attribute');
+  }
+  return name;
+}
+
+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> {

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

@@ -1,6 +1,6 @@
 import type { ImageProps } from "../../abstract-document/atoms/image.js";
 import type { TextStyle, ParagraphStyle, TableCellStyle } from "../../abstract-document/index.js";
-import { TextRun, Paragraph, TableCell, TableRow, Image } from "../../abstract-document/index.js";
+import { TextRun, Paragraph, TableCell, TableRow, Image, HyperLink } from "../../abstract-document/index.js";
 import type { ParagraphProps } from "../../abstract-document/section-elements/paragraph.js";
 //dummy2
 
@@ -87,6 +87,47 @@ export function TextParagraph(props: TextParagraphProps, styleNameTypes: Record<
   return Paragraph.create({ style, styleName: styleNames.ParagraphStyle }, [textRun]);
 }
 
+export type HyperLinkParagraphProps = TextParagraphProps & {
+  readonly target: string;
+};
+
+export function HyperLinkParagraph(props: HyperLinkParagraphProps, styleNameTypes: Record<string, string>): Paragraph.Paragraph {
+  const { text, target, textStyle, style } = props;
+  const styleNames = extractStyleNames(props.styleNames, styleNameTypes);
+  const hyperLink = HyperLink.create({
+    text,
+    target,
+    style: textStyle ? { ...textStyle, type: "TextStyle" } : undefined,
+    styleName: styleNames.TextStyle,
+  });
+  return Paragraph.create({ style, styleName: styleNames.ParagraphStyle }, [hyperLink]);
+}
+
+export type HyperLinkCellProps = Omit<HyperLinkParagraphProps, "style"> & {
+  readonly columnSpan?: number;
+  readonly rowSpan?: number;
+  readonly style?: TableCellStyle.TableCellStyle;
+  readonly paragraphStyle?: ParagraphStyle.ParagraphStyle;
+};
+
+export function HyperLinkCell(props: HyperLinkCellProps, styleNameTypes: Record<string, string>): TableCell.TableCell {
+  const { paragraphStyle, style, columnSpan, rowSpan } = props;
+  const styleNames = extractStyleNames(props.styleNames, styleNameTypes);
+  const paragraph = HyperLinkParagraph(
+    { ...props, style: paragraphStyle ? { ...paragraphStyle, type: "ParagraphStyle" } : undefined },
+    styleNameTypes
+  );
+  return TableCell.create({ columnSpan, rowSpan, style, styleName: styleNames.TableCellStyle }, [paragraph]);
+}
+
+export type HyperLinkRowProps = Omit<HyperLinkCellProps, "style"> & {
+  readonly cellStyle?: TableCellStyle.TableCellStyle;
+};
+
+export function HyperLinkRow(props: HyperLinkRowProps, styleNameTypes: Record<string, string>): TableRow.TableRow {
+  return TableRow.create({}, [HyperLinkCell({ ...props, style: props.cellStyle }, styleNameTypes)]);
+}
+
 export type ImageRowProps = Omit<ImageCellProps, "style"> & {
   readonly cellStyle?: TableCellStyle.TableCellStyle;
 };

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

@@ -68,6 +68,64 @@ export const textParagraph = `<xs:complexType name="TextParagraph">
 </xs:complexType>`;
 export const textParagraphElement = `<xs:element name="TextParagraph" type="TextParagraph" maxOccurs="unbounded" />`;
 
+export const hyperLinkParagraph = `<xs:complexType name="HyperLinkParagraph">
+	<xs:annotation>
+		<xs:documentation>Shortcut to create \\<Paragraph> \\<HyperLink text="..." target="..." /> \\</Paragraph></xs:documentation>
+	</xs:annotation>
+	<xs:choice minOccurs="0" maxOccurs="1">
+		<xs:element name="style" type="ParagraphStyle" />
+	</xs:choice>
+	<xs:choice minOccurs="0" maxOccurs="1">
+		<xs:element name="textStyle" type="TextStyle" />
+	</xs:choice>
+	<xs:attribute name="styleNames" type="xs:string" />
+	<xs:attribute name="target" type="xs:string" use="required" />
+	<xs:attribute name="text" type="xs:string" use="required" />
+</xs:complexType>`;
+export const hyperLinkParagraphElement = `<xs:element name="HyperLinkParagraph" type="HyperLinkParagraph" maxOccurs="unbounded" />`;
+
+export const hyperLinkCell = `<xs:complexType name="HyperLinkCell">
+	<xs:annotation>
+		<xs:documentation>Shortcut to create a \\<TableCell> \\<Paragraph> \\<HyperLink text="..." target="..." /> \\</Paragraph> \\</TableCell></xs:documentation>
+	</xs:annotation>
+	<xs:choice minOccurs="0" maxOccurs="1">
+		<xs:element name="style" type="TableCellStyle" />
+	</xs:choice>
+	<xs:choice minOccurs="0" maxOccurs="1">
+		<xs:element name="paragraphStyle" type="ParagraphStyle" />
+	</xs:choice>
+	<xs:choice minOccurs="0" maxOccurs="1">
+		<xs:element name="textStyle" type="TextStyle" />
+	</xs:choice>
+	<xs:attribute name="styleNames" type="xs:string" />
+	<xs:attribute name="target" type="xs:string" use="required" />
+	<xs:attribute name="columnSpan" type="xs:integer" />
+	<xs:attribute name="rowSpan" type="xs:integer" />
+	<xs:attribute name="text" type="xs:string" use="required" />
+</xs:complexType>`;
+export const hyperLinkCellElement = `<xs:element name="HyperLinkCell" type="HyperLinkCell" minOccurs="0" maxOccurs="unbounded" />`;
+
+export const hyperLinkRow = `<xs:complexType name="HyperLinkRow">
+	<xs:annotation>
+		<xs:documentation>Shortcut to create a \\<TableRow> \\<TableCell> \\<Paragraph> \\<HyperLink text="..." target="..." /> \\</Paragraph> \\</TableCell> \\</TableRow></xs:documentation>
+	</xs:annotation>
+	<xs:choice minOccurs="0" maxOccurs="1">
+		<xs:element name="cellStyle" type="TableCellStyle" />
+	</xs:choice>
+	<xs:choice minOccurs="0" maxOccurs="1">
+		<xs:element name="paragraphStyle" type="ParagraphStyle" />
+	</xs:choice>
+	<xs:choice minOccurs="0" maxOccurs="1">
+		<xs:element name="textStyle" type="TextStyle" />
+	</xs:choice>
+	<xs:attribute name="styleNames" type="xs:string" />
+	<xs:attribute name="target" type="xs:string" use="required" />
+	<xs:attribute name="columnSpan" type="xs:integer" />
+	<xs:attribute name="rowSpan" type="xs:integer" />
+	<xs:attribute name="text" type="xs:string" use="required" />
+</xs:complexType>`;
+export const hyperLinkRowElement = `<xs:element name="HyperLinkRow" type="HyperLinkRow" maxOccurs="unbounded" />`;
+
 export const imageRow = `<xs:complexType name="ImageRow">
 	<xs:annotation>
 		<xs:documentation>Shortcut to create a \\<TableRow> \\<TableCell> \\<Paragraph> \\<Image src text="..." /> \\</Paragraph> \\</TableCell> \\</TableRow></xs:documentation>

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

@@ -16,6 +16,7 @@ export const section = `<xs:complexType name="Section">
 		<xs:element name="PageBreak" type="PageBreak" minOccurs="0" />
 		<xs:element name="Paragraph" type="Paragraph" minOccurs="0" />
 		${Custom.textParagraphElement}
+		${Custom.hyperLinkParagraphElement}
 		${Custom.imageParagraphElement}
 		<xs:element name="Markdown" type="Markdown" minOccurs="0" />
 		<xs:element name="page" type="page" minOccurs="0" maxOccurs="1"></xs:element>
@@ -38,6 +39,7 @@ const sectionElementBody = `<xs:element name="Table" type="Table" minOccurs="0"
 	<xs:element name="PageBreak" type="PageBreak" minOccurs="0" />
 	<xs:element name="Paragraph" type="Paragraph" minOccurs="0" />
 	${Custom.textParagraphElement}
+	${Custom.hyperLinkParagraphElement}
 	${Custom.imageParagraphElement}
 <xs:element name="Markdown" type="Markdown" minOccurs="0" />`;
 
@@ -61,6 +63,7 @@ export const group = `<xs:complexType name="Group">
 		<xs:element name="PageBreak" type="PageBreak" minOccurs="0" />
 		<xs:element name="Paragraph" type="Paragraph" minOccurs="0" />
 		${Custom.textParagraphElement}
+		${Custom.hyperLinkParagraphElement}
 		${Custom.imageParagraphElement}
 		<xs:element name="style" type="GroupStyle" minOccurs="0" />
 	</xs:choice>
@@ -75,6 +78,7 @@ export const table = `<xs:complexType name="Table">
 			<xs:choice minOccurs="1">
 				<xs:element name="TableRow" type="TableRow"  maxOccurs="unbounded" />
 				${Custom.textRowElement}
+				${Custom.hyperLinkRowElement}
 				${Custom.imageRowElement}
 			</xs:choice>
 		</xs:sequence>
@@ -96,6 +100,7 @@ export const headerRows = `<xs:complexType name="headerRows">
 		<xs:choice minOccurs="1" maxOccurs="unbounded">
 			<xs:element name="TableRow" type="TableRow"/>
 			${Custom.textRowElement}
+			${Custom.hyperLinkRowElement}
 			${Custom.imageRowElement}
 		</xs:choice>
 	</xs:sequence>
@@ -105,6 +110,7 @@ export const tableRow = `<xs:complexType name="TableRow">
 	<xs:choice maxOccurs="unbounded">
 		<xs:element name="TableCell" type="TableCell" minOccurs="0" maxOccurs="unbounded" />
 		${Custom.textCellElement}
+		${Custom.hyperLinkCellElement}
 		${Custom.imageCellElement}
 	</xs:choice>
 </xs:complexType>`;
@@ -117,6 +123,7 @@ export const tableCell = `<xs:complexType name="TableCell">
 		<xs:element name="PageBreak" type="PageBreak" minOccurs="0" maxOccurs="unbounded" />
 		<xs:element name="Paragraph" type="Paragraph" minOccurs="0" maxOccurs="unbounded" />
 		${Custom.textParagraphElement}
+		${Custom.hyperLinkParagraphElement}
 		${Custom.imageParagraphElement}
 		<xs:element name="Markdown" type="Markdown" minOccurs="0" maxOccurs="unbounded" />
 	</xs:choice>
@@ -141,7 +148,8 @@ export const paragraph = `<xs:complexType name="Paragraph">
 		<xs:element name="Image" type="Image" minOccurs="0" maxOccurs="unbounded"></xs:element>
 		<xs:element name="HyperLink" type="HyperLink" minOccurs="0" maxOccurs="unbounded"></xs:element>
 		<xs:element name="LinkTarget" type="LinkTarget" minOccurs="0" maxOccurs="unbounded"></xs:element>
-		<xs:element name="TocSeperator" type="TocSeperator" minOccurs="0" maxOccurs="unbounded"></xs:element>
+		<xs:element name="LineBreak" type="LineBreak" minOccurs="0" maxOccurs="unbounded"></xs:element>
+		<xs:element name="TocSeparator" type="TocSeparator" minOccurs="0" maxOccurs="unbounded"></xs:element>
 		<xs:element name="style" type="ParagraphStyle" minOccurs="0" maxOccurs="1"></xs:element>
 	</xs:choice>
 	<xs:attribute name="styleName" type="xs:string" >
@@ -160,16 +168,23 @@ export const hyperLink = `<xs:complexType name="HyperLink">
 			<xs:documentation>Refrence to a TextStyle that is defined in \\<AbstractDoc> \\<StyleNames> \\<StyleName name="..." /> \\</StyleNames> \\</AbstractDoc></xs:documentation>
 		</xs:annotation>
 	</xs:attribute>
-	<xs:attribute name="target" type="xs:string" />
+	<xs:attribute name="target" type="xs:string" use="required" />
 	<xs:attribute name="text" type="xs:string" />
 </xs:complexType>`;
 
-export const tocSeparator = `<xs:complexType name="TocSeperator">
+export const tocSeparator = `<xs:complexType name="TocSeparator">
 	<xs:attribute name="width" type="xs:decimal" />
 </xs:complexType>`;
 
 export const linkTarget = `<xs:complexType name="LinkTarget">
-	<xs:attribute name="name" type="xs:string" />
+	<xs:attribute name="name" type="xs:string" use="required" />
+</xs:complexType>`;
+
+export const lineBreak = `<xs:complexType name="LineBreak">
+	<xs:choice minOccurs="0" maxOccurs="1">
+		<xs:element name="style" type="TextStyle" />
+	</xs:choice>
+	<xs:attribute name="styleName" type="xs:string" />
 </xs:complexType>`;
 
 export const textRun = `<xs:complexType name="TextRun">

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

@@ -14,6 +14,7 @@ ${Elements.image}
 ${Elements.textField}
 ${Elements.textRun}
 ${Elements.hyperLink}
+${Elements.lineBreak}
 ${Elements.tocSeparator}
 ${Elements.linkTarget}
 ${Styles.position}
@@ -33,6 +34,9 @@ ${Elements.tableCell}
 ${CustomElements.textRow}
 ${CustomElements.textCell}
 ${CustomElements.textParagraph}
+${CustomElements.hyperLinkParagraph}
+${CustomElements.hyperLinkCell}
+${CustomElements.hyperLinkRow}
 ${CustomElements.imageRow}
 ${CustomElements.imageCell}
 ${CustomElements.imageParagraph}`;

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;
+}