abstract-document 18.2.5 → 18.2.9

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

@@ -3,7 +3,7 @@ import { AbstractDoc } from "../../abstract-document/index.js";
 import * as StyleKey from "../../abstract-document/styles/style-key.js";
 import { Resources } from "../../abstract-document/resources.js";
 import { ADCreatorFn, creators, propsCreators } from "./creator.js";
-import { parseHandlebarsXml, parseMustacheXml, type XmlElement } from "handlebars-xml";
+import { parseHandlebarsXml, type XmlElement } from "handlebars-xml";
 import { getFontStyleName } from "../../abstract-document-exporters/pdf/font.js";
 import { Font } from "../../abstract-document/primitives/font.js";
 
@@ -21,19 +21,27 @@ export type Format = "PDF" | "DOCX";
 
 export async function abstractDocsXml(
   templateInputs: ReadonlyArray<TemplateInput>,
-  getResources: (imageUrls: Record<string, true>, fontFamilies: Record<string, true>) => Promise<Resources>
+  getResources: (
+    imageUrls: Record<string, true>,
+    fontFamilies: Record<string, ReadonlyArray<keyof Font>>
+  ) => Promise<Resources>
 ): Promise<AbstractDoxXmlsResult> {
   try {
     const abstractDocs = Array<AbstractDoc.AbstractDoc>();
     let imageUrls: Record<string, true> = {};
-    let fontFamilies: Record<string, true> = {};
+    const fontFamilies: Record<string, Partial<Record<keyof Font, boolean>>> = {};
     for (const r of templateInputs) {
-      const [ad, newImageUrls, newFontFamilies] = abstractDocXml(r.template, r.data, r.partials, "Handlebars");
+      const [ad, newImageUrls, newFontFamilies] = abstractDocXml(r.template, r.data, r.partials);
       abstractDocs.push(ad);
       imageUrls = { ...imageUrls, ...newImageUrls };
-      fontFamilies = { ...fontFamilies, ...newFontFamilies };
+      Object.entries(newFontFamilies).forEach(
+        ([font, types]) => (fontFamilies[font] = { ...fontFamilies[font], ...types })
+      );
     }
-    const resources = await getResources(imageUrls, fontFamilies);
+    const resources = await getResources(
+      imageUrls,
+      Object.fromEntries(Object.entries(fontFamilies).map(([f, s]) => [f, Object.keys(s) as Array<keyof Font>]))
+    );
     const combinedReport = addResources(merge(...abstractDocs), resources);
     return { type: "Ok", value: combinedReport };
   } catch (e) {
@@ -44,14 +52,16 @@ export async function abstractDocsXml(
 export function abstractDocXml(
   template: string,
   data: any,
-  partials: Record<string, string>,
-  rendered: "Mustache" | "Handlebars" = "Handlebars"
-): readonly [AbstractDoc.AbstractDoc, imageUrls: Record<string, true>, fontFamilies: Record<string, true>, fontStyles: Record<string, ReadonlyArray<keyof Font>>] {
-  const xml =
-    rendered === "Mustache" ? parseMustacheXml(template, data, partials) : parseHandlebarsXml(template, data, partials);
-  const [imageUrls, fontFamilies, styleNames, fontStyles] = extractImageFontsStyleNames(xml);
+  partials: Record<string, string>
+): 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]!);
-  return [doc, imageUrls, fontFamilies, fontStyles];
+  return [doc, imageUrls, fontFamilies];
 }
 
 function abstractDocXmlRecursive(
@@ -103,7 +113,8 @@ function abstractDocXmlRecursive(
   const obj = creator(allProps, children) as { [k: string]: unknown };
 
   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);
@@ -156,8 +167,8 @@ function abstractDocXmlRecursive(
 function getSuffixedAttributeBaseName(attributeName: string): string | undefined {
   const suffixRemoved = (() => {
     const suffixes = ["Top", "Bottom", "Left", "Right"];
-    for(const suffix of suffixes) {
-      if(attributeName.endsWith(suffix)) {
+    for (const suffix of suffixes) {
+      if (attributeName.endsWith(suffix)) {
         return attributeName.slice(0, -suffix.length);
       }
     }
@@ -178,29 +189,26 @@ function extractImageFontsStyleNames(
   xmlElement: ReadonlyArray<XmlElement>,
   styleNames: Record<string, string> = {},
   images: Record<string, true> = {},
-  fonts: Record<string, true> = {},
-  fontStyles: Record<string, ReadonlyArray<keyof Font>> = {},
-): readonly [imageUrls: Record<string, true>, fontFamilies: Record<string, true>, styleNames: Record<string, string>, fontStyles: Record<string, ReadonlyArray<keyof Font>>] {
+  fonts: Record<string, Partial<Record<keyof Font, boolean>>> = {}
+): readonly [
+  imageUrls: Record<string, true>,
+  fontFamilies: Record<string, Partial<Record<keyof Font, boolean>>>,
+  styleNames: Record<string, string>
+] {
   xmlElement.forEach((item) => {
     if (item.tagName.startsWith("Image") && item.attributes?.src) {
       images[item.attributes.src as string] = true;
     } else if (item.attributes?.fontFamily) {
-      fonts[item.attributes.fontFamily as string] = true;
-
       const styleName = getFontStyleName(item.attributes);
-      const currentStyleNames = fontStyles[item.attributes.fontFamily as string] ?? [];
-      if(currentStyleNames.findIndex((v) => v === styleName) === -1) {
-        fontStyles[item.attributes.fontFamily as string] = [...currentStyleNames, styleName];
-      }
-
+      (fonts[item.attributes.fontFamily as string] ??= {})[styleName] = true;
       if (item.tagName === "StyleName" && item.attributes.name && item.attributes.type) {
         styleNames[item.attributes.name as string] = item.attributes.type;
       }
     } else if (item.tagName === "StyleName" && item.attributes.name && item.attributes.type) {
       styleNames[item.attributes.name as string] = item.attributes.type;
     } else {
-      extractImageFontsStyleNames(item.children, styleNames, images, fonts, fontStyles);
+      extractImageFontsStyleNames(item.children, styleNames, images, fonts);
     }
   });
-  return [images, fonts, styleNames, fontStyles];
+  return [images, fonts, styleNames];
 }

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

@@ -46,9 +46,10 @@ export const creators: (styleNames: Record<string, string>) => Record<string, AD
     TextCell: (props: TextCellProps) => TextCell(props, styleNames),
     TextParagraph: (props: TextParagraphProps) => TextParagraph(props, styleNames),
     TextRun: (props) => TextRun.create(props as unknown as TextRun.TextRunProps),
-    ImageRow: (props: ImageRowProps) => ImageRow(imageProps(props) as unknown as ImageRowProps, styleNames),
-    ImageCell: (props: ImageCellProps) => ImageCell(imageProps(props) as unknown as ImageCellProps, styleNames),
-    ImageParagraph: (props: ImageParagraphProps) =>
+    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),
     Image: (props: Record<string, unknown>) => Image.create(imageProps(props) as unknown as Image.ImageProps),
     Table: (props, children: ReadonlyArray<TableRow.TableRow>) =>
@@ -139,27 +140,27 @@ export const propsCreators: Record<string, ADCreatorFn> = {
   },
   borderTop: (props: { readonly borderTop: string }): unknown => {
     const allProps = props as Record<string, unknown>;
-    const borders: { top?: number, bottom?: number, left?: number, right?: number } = allProps.borders ?? {};
+    const borders: { top?: number; bottom?: number; left?: number; right?: number } = allProps.borders ?? {};
     borders.top = Number(props.borderTop);
-    return borders; 
+    return borders;
   },
   borderBottom: (props: { readonly borderBottom: string }): unknown => {
     const allProps = props as Record<string, unknown>;
-    const borders: { top?: number, bottom?: number, left?: number, right?: number } = allProps.borders ?? {};
+    const borders: { top?: number; bottom?: number; left?: number; right?: number } = allProps.borders ?? {};
     borders.bottom = Number(props.borderBottom);
-    return borders; 
+    return borders;
   },
   borderLeft: (props: { readonly borderLeft: string }): unknown => {
     const allProps = props as Record<string, unknown>;
-    const borders: { top?: number, bottom?: number, left?: number, right?: number } = allProps.borders ?? {};
+    const borders: { top?: number; bottom?: number; left?: number; right?: number } = allProps.borders ?? {};
     borders.left = Number(props.borderLeft);
-    return borders; 
+    return borders;
   },
   borderRight: (props: { readonly borderRight: string }): unknown => {
     const allProps = props as Record<string, unknown>;
-    const borders: { top?: number, bottom?: number, left?: number, right?: number } = allProps.borders ?? {};
+    const borders: { top?: number; bottom?: number; left?: number; right?: number } = allProps.borders ?? {};
     borders.right = Number(props.borderRight);
-    return borders; 
+    return borders;
   },
   padding: (props: { readonly padding: string }): unknown => {
     const padding: { [k: string]: number } = { top: 0, right: 0, bottom: 0, left: 0 };
@@ -205,27 +206,27 @@ export const propsCreators: Record<string, ADCreatorFn> = {
   },
   paddingTop: (props: { readonly paddingTop: string }): unknown => {
     const allProps = props as Record<string, unknown>;
-    const padding: { top?: number, bottom?: number, left?: number, right?: number } = allProps.padding ?? {};
+    const padding: { top?: number; bottom?: number; left?: number; right?: number } = allProps.padding ?? {};
     padding.top = Number(props.paddingTop);
-    return padding; 
+    return padding;
   },
   paddingBottom: (props: { readonly paddingBottom: string }): unknown => {
     const allProps = props as Record<string, unknown>;
-    const padding: { top?: number, bottom?: number, left?: number, right?: number } = allProps.padding ?? {};
+    const padding: { top?: number; bottom?: number; left?: number; right?: number } = allProps.padding ?? {};
     padding.bottom = Number(props.paddingBottom);
-    return padding; 
+    return padding;
   },
   paddingLeft: (props: { readonly paddingLeft: string }): unknown => {
     const allProps = props as Record<string, unknown>;
-    const padding: { top?: number, bottom?: number, left?: number, right?: number } = allProps.padding ?? {};
+    const padding: { top?: number; bottom?: number; left?: number; right?: number } = allProps.padding ?? {};
     padding.left = Number(props.paddingLeft);
-    return padding; 
+    return padding;
   },
   paddingRight: (props: { readonly paddingRight: string }): unknown => {
     const allProps = props as Record<string, unknown>;
-    const padding: { top?: number, bottom?: number, left?: number, right?: number } = allProps.padding ?? {};
+    const padding: { top?: number; bottom?: number; left?: number; right?: number } = allProps.padding ?? {};
     padding.right = Number(props.paddingRight);
-    return padding; 
+    return padding;
   },
   margins: (props: { readonly margins: string }): unknown => {
     const margins: { [k: string]: number } = { top: 0, right: 0, bottom: 0, left: 0 };
@@ -269,27 +270,27 @@ export const propsCreators: Record<string, ADCreatorFn> = {
   },
   marginTop: (props: { readonly marginTop: string }): unknown => {
     const allProps = props as Record<string, unknown>;
-    const margins: { top?: number, bottom?: number, left?: number, right?: number } = allProps.margins ?? {};
+    const margins: { top?: number; bottom?: number; left?: number; right?: number } = allProps.margins ?? {};
     margins.top = Number(props.marginTop);
-    return margins; 
+    return margins;
   },
   marginBottom: (props: { readonly marginBottom: string }): unknown => {
     const allProps = props as Record<string, unknown>;
-    const margins: { top?: number, bottom?: number, left?: number, right?: number } = allProps.margins ?? {};
+    const margins: { top?: number; bottom?: number; left?: number; right?: number } = allProps.margins ?? {};
     margins.bottom = Number(props.marginBottom);
-    return margins; 
+    return margins;
   },
   marginLeft: (props: { readonly marginLeft: string }): unknown => {
     const allProps = props as Record<string, unknown>;
-    const margins: { top?: number, bottom?: number, left?: number, right?: number } = allProps.margins ?? {};
+    const margins: { top?: number; bottom?: number; left?: number; right?: number } = allProps.margins ?? {};
     margins.left = Number(props.marginLeft);
-    return margins; 
+    return margins;
   },
   marginRight: (props: { readonly marginRight: string }): unknown => {
     const allProps = props as Record<string, unknown>;
-    const margins: { top?: number, bottom?: number, left?: number, right?: number } = allProps.margins ?? {};
+    const margins: { top?: number; bottom?: number; left?: number; right?: number } = allProps.margins ?? {};
     margins.right = Number(props.marginRight);
-    return margins; 
+    return margins;
   },
   borderColors: (props: { readonly borderColors: string }): unknown => {
     const borderColors: { [k: string]: string } = { top: "", right: "", bottom: "", left: "" };
@@ -315,27 +316,27 @@ export const propsCreators: Record<string, ADCreatorFn> = {
   },
   borderColorTop: (props: { readonly borderColorTop: string }): unknown => {
     const allProps = props as Record<string, unknown>;
-    const margins: { top?: string, bottom?: string, left?: string, right?: string } = allProps.borderColors ?? {};
+    const margins: { top?: string; bottom?: string; left?: string; right?: string } = allProps.borderColors ?? {};
     margins.top = props.borderColorTop;
-    return margins; 
+    return margins;
   },
   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; 
+    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; 
+    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; 
+    return boderColors;
   },
 };
 

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

@@ -1,3 +1,4 @@
+import { ImageProps } from "../../abstract-document/atoms/image.js";
 import {
   TextStyle,
   ParagraphStyle,
@@ -110,9 +111,20 @@ export type ImageCellProps = Omit<ImageParagraphProps, "style"> & {
 };
 
 export function ImageCell(props: ImageCellProps, styleNameTypes: Record<string, string>): TableCell.TableCell {
-  const { imageResource, width, height, 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 });
+  const imageElement =
+    imageResource && Image.create({ imageResource, width, height, horizontalAlignment, verticalAlignment });
   const pararaphProps = {
     style: paragraphStyle ? { ...paragraphStyle, type: "ParagraphStyle" } : undefined,
     styleName: styleNames.ParagraphStyle,
@@ -123,10 +135,7 @@ export function ImageCell(props: ImageCellProps, styleNameTypes: Record<string,
   return TableCell.create({ columnSpan, rowSpan, style, styleName: styleNames.TableCellStyle }, [paragraph]);
 }
 
-export type ImageParagraphProps = {
-  readonly imageResource: ImageResource.ImageResource;
-  readonly width: number;
-  readonly height: number;
+export type ImageParagraphProps = ImageProps & {
   readonly style?: ParagraphStyle.ParagraphStyle;
   readonly styleNames?: string;
 };
@@ -135,9 +144,10 @@ export function ImageParagraph(
   props: ImageParagraphProps,
   styleNameTypes: Record<string, string>
 ): Paragraph.Paragraph | undefined {
-  const { imageResource, width, height, style } = props;
+  const { imageResource, width, height, style, horizontalAlignment, verticalAlignment } = props;
   const styleNames = extractStyleNames(props.styleNames, styleNameTypes);
-  const imageElement = imageResource && Image.create({ imageResource, width, height });
+  const imageElement =
+    imageResource && Image.create({ imageResource, width, height, horizontalAlignment, verticalAlignment });
   const pararaphProps = { style, styleName: styleNames.ParagraphStyle };
   return imageElement
     ? Paragraph.create(pararaphProps, [imageElement])

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

@@ -212,6 +212,24 @@ export const image = `<xs:complexType name="Image">
         <xs:attribute name="src" type="xs:string" use="required" />
         <xs:attribute name="width" type="xs:decimal" use="required" />
         <xs:attribute name="height" type="xs:decimal" use="required" />
+		<xs:attribute name="verticalAlignment">
+			<xs:simpleType>
+				<xs:restriction base="xs:string">
+					<xs:enumeration value="Top" />
+					<xs:enumeration value="Center" />
+					<xs:enumeration value="Bottom" />
+				</xs:restriction>
+			</xs:simpleType>
+		</xs:attribute>
+		<xs:attribute name="horizontalAlignment">
+			<xs:simpleType>
+				<xs:restriction base="xs:string">
+					<xs:enumeration value="Left" />
+					<xs:enumeration value="Center" />
+					<xs:enumeration value="Right" />
+				</xs:restriction>
+			</xs:simpleType>
+		</xs:attribute>
 </xs:complexType>`;
 
 export const pageBreak = `<xs:complexType name="PageBreak" />`;