abstract-document 5.1.7 → 6.0.3

package/src/abstract-document/styles/table-style.ts

@@ -1,45 +1,45 @@
-import * as LayoutFoundation from "../primitives/layout-foundation";
-import * as TableCellStyle from "./table-cell-style";
-
-export type TableAlignment = "Left" | "Center" | "Right";
-
-export interface TableStyle {
-  readonly type: "TableStyle";
-  readonly margins: LayoutFoundation.LayoutFoundation;
-  readonly alignment?: TableAlignment;
-  readonly cellStyle: TableCellStyle.TableCellStyle;
-}
-
-export interface TableStyleProps {
-  readonly margins?: LayoutFoundation.LayoutFoundation;
-  readonly alignment?: TableAlignment;
-  readonly cellStyle?: TableCellStyle.TableCellStyle;
-}
-
-export function create(props?: TableStyleProps): TableStyle {
-  const {
-    margins = LayoutFoundation.create(),
-    alignment = undefined,
-    cellStyle = TableCellStyle.create()
-  } =
-    props || {};
-  return {
-    type: "TableStyle",
-    margins,
-    alignment,
-    cellStyle
-  };
-}
-
-export function overrideWith(
-  overrider: TableStyle,
-  toOverride: TableStyle
-): TableStyle {
-  const a: TableStyleProps = overrider || {};
-  const b: TableStyleProps = toOverride || {};
-  return create({
-    margins: LayoutFoundation.overrideWith(a.margins, b.margins),
-    alignment: a.alignment || b.alignment,
-    cellStyle: TableCellStyle.overrideWith(a.cellStyle, b.cellStyle)
-  });
-}
+import * as LayoutFoundation from "../primitives/layout-foundation";
+import * as TableCellStyle from "./table-cell-style";
+
+export type TableAlignment = "Left" | "Center" | "Right";
+
+export interface TableStyle {
+  readonly type: "TableStyle";
+  readonly margins: LayoutFoundation.LayoutFoundation;
+  readonly alignment?: TableAlignment;
+  readonly cellStyle: TableCellStyle.TableCellStyle;
+}
+
+export interface TableStyleProps {
+  readonly margins?: LayoutFoundation.LayoutFoundation;
+  readonly alignment?: TableAlignment;
+  readonly cellStyle?: TableCellStyle.TableCellStyle;
+}
+
+export function create(props?: TableStyleProps): TableStyle {
+  const {
+    margins = LayoutFoundation.create(),
+    alignment = undefined,
+    cellStyle = TableCellStyle.create()
+  } =
+    props || {};
+  return {
+    type: "TableStyle",
+    margins,
+    alignment,
+    cellStyle
+  };
+}
+
+export function overrideWith(
+  overrider: TableStyle,
+  toOverride: TableStyle
+): TableStyle {
+  const a: TableStyleProps = overrider || {};
+  const b: TableStyleProps = toOverride || {};
+  return create({
+    margins: LayoutFoundation.overrideWith(a.margins, b.margins),
+    alignment: a.alignment || b.alignment,
+    cellStyle: TableCellStyle.overrideWith(a.cellStyle, b.cellStyle)
+  });
+}

package/src/abstract-document/styles/text-style.ts

@@ -1,73 +1,73 @@
-export type TextAlignment = "left" | "center" | "right" | "justify";
-
-export interface TextStyle {
-  readonly type: "TextStyle";
-  readonly fontFamily?: string;
-  readonly bold?: boolean;
-  readonly mediumBold?: boolean;
-  readonly color?: string;
-  readonly fontSize?: number;
-  readonly fontScale?: number;
-  readonly italic?: boolean;
-  readonly subScript?: boolean;
-  readonly superScript?: boolean;
-  readonly underline?: boolean;
-  readonly verticalPosition?: number;
-  readonly indent?: number;
-  readonly lineGap?: number;
-  readonly lineBreak?: boolean;
-  readonly alignment?: TextAlignment;
-}
-
-export interface TextStyleProps {
-  readonly fontFamily?: string;
-  readonly bold?: boolean;
-  readonly mediumBold?: boolean;
-  readonly color?: string;
-  readonly fontSize?: number;
-  readonly fontScale?: number;
-  readonly italic?: boolean;
-  readonly subScript?: boolean;
-  readonly superScript?: boolean;
-  readonly underline?: boolean;
-  readonly verticalPosition?: number;
-  readonly indent?: number;
-  readonly lineGap?: number;
-  readonly lineBreak?: boolean;
-  readonly alignment?: TextAlignment;
-}
-
-export function create(props?: TextStyleProps): TextStyle {
-  return {
-    type: "TextStyle",
-    ...(props || {}),
-  };
-}
-
-export function overrideWith(overrider: TextStyle | undefined, toOverride: TextStyle | undefined): TextStyle {
-  const a: TextStyleProps = overrider || {};
-  const b: TextStyleProps = toOverride || {};
-  return create({
-    fontFamily: a.fontFamily || b.fontFamily,
-    bold: a.bold || b.bold,
-    mediumBold: a.mediumBold || b.mediumBold,
-    color: a.color || b.color,
-    fontSize: a.fontSize || b.fontSize,
-    fontScale: a.fontScale || b.fontScale,
-    italic: a.italic || b.italic,
-    subScript: a.subScript || b.subScript,
-    superScript: a.superScript || b.superScript,
-    underline: a.underline || b.underline,
-    verticalPosition: a.verticalPosition || b.verticalPosition,
-    indent: a.indent || b.indent,
-    lineGap: a.lineGap || b.lineGap,
-    lineBreak: a.lineBreak ?? b.lineBreak,
-    alignment: a.alignment ?? b.alignment,
-  });
-}
-
-export function calculateFontSize(textStyle: TextStyle | undefined, defaultFontSize: number): number {
-  const fontSize = textStyle && textStyle.fontSize ? textStyle.fontSize : defaultFontSize;
-  const fontScale = textStyle && textStyle.fontScale ? textStyle.fontScale : 1.0;
-  return fontSize * fontScale;
-}
+export type TextAlignment = "left" | "center" | "right" | "justify";
+
+export interface TextStyle {
+  readonly type: "TextStyle";
+  readonly fontFamily?: string;
+  readonly bold?: boolean;
+  readonly mediumBold?: boolean;
+  readonly color?: string;
+  readonly fontSize?: number;
+  readonly fontScale?: number;
+  readonly italic?: boolean;
+  readonly subScript?: boolean;
+  readonly superScript?: boolean;
+  readonly underline?: boolean;
+  readonly verticalPosition?: number;
+  readonly indent?: number;
+  readonly lineGap?: number;
+  readonly lineBreak?: boolean;
+  readonly alignment?: TextAlignment;
+}
+
+export interface TextStyleProps {
+  readonly fontFamily?: string;
+  readonly bold?: boolean;
+  readonly mediumBold?: boolean;
+  readonly color?: string;
+  readonly fontSize?: number;
+  readonly fontScale?: number;
+  readonly italic?: boolean;
+  readonly subScript?: boolean;
+  readonly superScript?: boolean;
+  readonly underline?: boolean;
+  readonly verticalPosition?: number;
+  readonly indent?: number;
+  readonly lineGap?: number;
+  readonly lineBreak?: boolean;
+  readonly alignment?: TextAlignment;
+}
+
+export function create(props?: TextStyleProps): TextStyle {
+  return {
+    type: "TextStyle",
+    ...(props || {}),
+  };
+}
+
+export function overrideWith(overrider: TextStyle | undefined, toOverride: TextStyle | undefined): TextStyle {
+  const a: TextStyleProps = overrider || {};
+  const b: TextStyleProps = toOverride || {};
+  return create({
+    fontFamily: a.fontFamily || b.fontFamily,
+    bold: a.bold || b.bold,
+    mediumBold: a.mediumBold || b.mediumBold,
+    color: a.color || b.color,
+    fontSize: a.fontSize || b.fontSize,
+    fontScale: a.fontScale || b.fontScale,
+    italic: a.italic || b.italic,
+    subScript: a.subScript || b.subScript,
+    superScript: a.superScript || b.superScript,
+    underline: a.underline || b.underline,
+    verticalPosition: a.verticalPosition || b.verticalPosition,
+    indent: a.indent || b.indent,
+    lineGap: a.lineGap || b.lineGap,
+    lineBreak: a.lineBreak ?? b.lineBreak,
+    alignment: a.alignment ?? b.alignment,
+  });
+}
+
+export function calculateFontSize(textStyle: TextStyle | undefined, defaultFontSize: number): number {
+  const fontSize = textStyle && textStyle.fontSize ? textStyle.fontSize : defaultFontSize;
+  const fontScale = textStyle && textStyle.fontScale ? textStyle.fontScale : 1.0;
+  return fontSize * fontScale;
+}

package/src/abstract-document/table/table-cell.ts

@@ -1,29 +1,29 @@
-import * as SectionElement from "../section-elements/section-element";
-import * as TableCellStyle from "../styles/table-cell-style";
-
-export interface TableCell {
-  readonly styleName: string;
-  readonly columnSpan: number;
-  readonly style?: TableCellStyle.TableCellStyle;
-  readonly children: ReadonlyArray<SectionElement.SectionElement>;
-}
-
-export interface TableCellProps {
-  readonly styleName?: string;
-  readonly columnSpan?: number;
-  readonly style?: TableCellStyle.TableCellStyle;
-}
-
-export function create(
-  props?: TableCellProps,
-  children?: ReadonlyArray<SectionElement.SectionElement>
-): TableCell {
-  const { styleName = "", columnSpan = 1, style = TableCellStyle.create() } =
-    props || {};
-  return {
-    styleName,
-    columnSpan,
-    style,
-    children: children || []
-  };
-}
+import * as SectionElement from "../section-elements/section-element";
+import * as TableCellStyle from "../styles/table-cell-style";
+
+export interface TableCell {
+  readonly styleName: string;
+  readonly columnSpan: number;
+  readonly style?: TableCellStyle.TableCellStyle;
+  readonly children: ReadonlyArray<SectionElement.SectionElement>;
+}
+
+export interface TableCellProps {
+  readonly styleName?: string;
+  readonly columnSpan?: number;
+  readonly style?: TableCellStyle.TableCellStyle;
+}
+
+export function create(
+  props?: TableCellProps,
+  children?: ReadonlyArray<SectionElement.SectionElement>
+): TableCell {
+  const { styleName = "", columnSpan = 1, style = TableCellStyle.create() } =
+    props || {};
+  return {
+    styleName,
+    columnSpan,
+    style,
+    children: children || []
+  };
+}

package/src/abstract-document/table/table-row.ts

@@ -1,17 +1,17 @@
-import { TableCell } from "./table-cell";
-
-export interface TableRow {
-  readonly children: ReadonlyArray<TableCell>;
-}
-
-export interface TableRowProps {}
-
-export function create(
-  props?: TableRowProps,
-  children?: ReadonlyArray<TableCell>
-): TableRow {
-  const {} = props || {};
-  return {
-    children: children || []
-  };
-}
+import { TableCell } from "./table-cell";
+
+export interface TableRow {
+  readonly children: ReadonlyArray<TableCell>;
+}
+
+export interface TableRowProps {}
+
+export function create(
+  props?: TableRowProps,
+  children?: ReadonlyArray<TableCell>
+): TableRow {
+  const {} = props || {};
+  return {
+    children: children || []
+  };
+}

package/src/abstract-document/types.ts

@@ -1,3 +1,3 @@
-// tslint:disable-next-line:readonly-keyword
-export type Indexer<T> = { [key: string]: T };
-export type Guid = string;
+// tslint:disable-next-line:readonly-keyword
+export type Indexer<T> = { [key: string]: T };
+export type Guid = string;

package/src/abstract-document-exporters/__tests__/docx2/export-test-def.ts

@@ -0,0 +1,10 @@
+/**
+ * Defines a data-type that represents a single test for the Docx render function
+ */
+export type ExportTestDef = {
+  readonly name: string;
+  readonly only?: boolean;
+  readonly skip?: boolean;
+  readonly abstractDocJsx: JSX.Element;
+  readonly expectedDocxZipContexts: { readonly [filename: string]: string };
+};

package/src/abstract-document-exporters/__tests__/docx2/export.test.tsx

@@ -0,0 +1,67 @@
+import * as S from "stream";
+import path from "path";
+import * as DiffJsXml from "diff-js-xml";
+import { loadTests, onlySkip, saveBufferInTmpDir, streamToBuffer } from "@abstract-visuals/test-utils";
+import { exportToStream } from "../../../abstract-document-exporters/docx2/render";
+import { render } from "../../../abstract-document-jsx";
+import jszip from "jszip";
+import { ExportTestDef } from "./export-test-def";
+
+export const tests = loadTests<ExportTestDef>(path.join(__dirname, "test-defs/"));
+
+describe("export docx", () => {
+  onlySkip(tests).forEach((item) => {
+    test(item.name, async () => {
+      const abstractDoc = render(item.abstractDocJsx);
+      const docxStream = new S.PassThrough();
+      exportToStream(docxStream, abstractDoc);
+      // Get the DOCX (which by defintion is a zipfile following open packaging convention)
+      const docxBuffer = await streamToBuffer(docxStream);
+      saveBufferInTmpDir(path.join(__dirname, "tmp"), item.name + ".docx", docxBuffer);
+      const docxZip = await jszip.loadAsync(docxBuffer);
+      for (const [filename, content] of Object.entries(item.expectedDocxZipContexts)) {
+        const docxWordDocumentXml = await docxZip.file(filename)?.async("string");
+        if (docxWordDocumentXml !== undefined) {
+          if (filename.endsWith(".xml")) {
+            const result = await diffXmlStrings(content, docxWordDocumentXml);
+            // console.log("result", result);
+            expect(result).toEqual([]);
+          } else {
+            expect(docxWordDocumentXml).toEqual(content);
+          }
+        }
+      }
+    });
+  });
+});
+
+type DiffResult = {
+  readonly path: string;
+  readonly resultType: string;
+  readonly message: string;
+};
+
+/**
+ * It can be very handy to compare with wildcards if for exammple you are not interested in all the data.
+ * You can put an * in the first (lhs) xml file. The result of this compare will be no differences.
+ */
+async function diffXmlStrings(lhs: string, rhs: string): Promise<ReadonlyArray<DiffResult>> {
+  return new Promise((resolve) => {
+    try {
+      DiffJsXml.diffAsXml(
+        lhs,
+        rhs,
+        {},
+        {
+          compareElementValues: true,
+          xml2jsOptions: { ignoreAttributes: false },
+        },
+        (result: ReadonlyArray<DiffResult>) => {
+          resolve(result);
+        }
+      );
+    } catch (e) {
+      resolve([{ path: "", resultType: "ERROR", message: "ERROR while calling diffAsXml(): " + e.message }]);
+    }
+  });
+}

package/src/abstract-document-exporters/__tests__/docx2/test-defs/group.tsx

@@ -0,0 +1,114 @@
+import React from "react";
+import { ExportTestDef } from "../export-test-def";
+import { Paragraph, AbstractDoc, Section, TextRun, Group } from "../../../../abstract-document-jsx";
+
+export const test: ExportTestDef = {
+  name: "Group",
+  abstractDocJsx: (
+    <AbstractDoc>
+      <Section>
+        <Group>
+          <Paragraph>
+            <TextRun text={"Hello"} />
+          </Paragraph>
+          <Paragraph>
+            <TextRun text={"Hello2"} />
+          </Paragraph>
+        </Group>
+      </Section>
+    </AbstractDoc>
+  ),
+  expectedDocxZipContexts: {
+    "word/document.xml": `<w:document
+  xmlns:wpc="http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas"
+  xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+  xmlns:o="urn:schemas-microsoft-com:office:office"
+  xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships"
+  xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math"
+  xmlns:v="urn:schemas-microsoft-com:vml"
+  xmlns:wp14="http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing"
+  xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing"
+  xmlns:w10="urn:schemas-microsoft-com:office:word"
+  xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"
+  xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml"
+  xmlns:w15="http://schemas.microsoft.com/office/word/2012/wordml"
+  xmlns:wpg="http://schemas.microsoft.com/office/word/2010/wordprocessingGroup"
+  xmlns:wpi="http://schemas.microsoft.com/office/word/2010/wordprocessingInk"
+  xmlns:wne="http://schemas.microsoft.com/office/word/2006/wordml"
+  xmlns:wps="http://schemas.microsoft.com/office/word/2010/wordprocessingShape"
+  mc:Ignorable="w14 w15 wp14"
+>
+  <w:background w:color="FFFFFF" />
+  <w:body>
+    <w:p>
+      <w:pPr>
+        <w:spacing w:before="0" w:after="0" w:line="1" />
+      </w:pPr>
+      <w:bookmarkStart w:name="" w:id="*" />
+      <w:bookmarkEnd w:id="*" />
+    </w:p>
+    <w:p>
+      <w:pPr>
+        <w:spacing w:before="0" w:after="0" />
+        <w:jc w:val="start" />
+        <w:ind w:left="0" w:end="0" />
+      </w:pPr>
+      <w:r>
+        <w:rPr>
+          <w:color w:val="black" />
+          <w:sz w:val="20" />
+          <w:szCs w:val="20" />
+          <w:rFonts
+            w:ascii="Arial"
+            w:cs="Arial"
+            w:eastAsia="Arial"
+            w:hAnsi="Arial"
+          />
+        </w:rPr>
+        <w:t xml:space="preserve">Hello</w:t>
+      </w:r>
+    </w:p>
+    <w:p>
+      <w:pPr>
+        <w:spacing w:before="0" w:after="0" />
+        <w:jc w:val="start" />
+        <w:ind w:left="0" w:end="0" />
+      </w:pPr>
+      <w:r>
+        <w:rPr>
+          <w:color w:val="black" />
+          <w:sz w:val="20" />
+          <w:szCs w:val="20" />
+          <w:rFonts
+            w:ascii="Arial"
+            w:cs="Arial"
+            w:eastAsia="Arial"
+            w:hAnsi="Arial"
+          />
+        </w:rPr>
+        <w:t xml:space="preserve">Hello2</w:t>
+      </w:r>
+    </w:p>
+    <w:sectPr>
+      <w:pgSz w:w="11906" w:h="16838" w:orient="portrait" />
+      <w:pgMar
+        w:top="0"
+        w:right="0"
+        w:bottom="0"
+        w:left="0"
+        w:header="0"
+        w:footer="0"
+        w:gutter="0"
+        w:mirrorMargins="false"
+      />
+      <w:cols w:space="708" w:num="1" w:sep="false" />
+      <w:docGrid w:linePitch="360" />
+      <w:headerReference w:type="default" r:id="rId5" />
+      <w:footerReference w:type="default" r:id="rId6" />
+      <w:pgNumType />
+    </w:sectPr>
+  </w:body>
+</w:document>
+`,
+  },
+};

package/src/abstract-document-exporters/__tests__/docx2/test-defs/header-and-footer.tsx

@@ -0,0 +1,110 @@
+import React from "react";
+import { ExportTestDef } from "../export-test-def";
+import * as AD from "../../../../index";
+import { Paragraph, AbstractDoc, Section, TextRun, TextField, render } from "../../../../abstract-document-jsx";
+
+const header = [
+  render(
+    <Paragraph>
+      <TextRun text="I am a header" />
+      <TextField fieldType="PageNumber" />
+      <TextRun text="/" />
+      <TextField fieldType="TotalPages" />
+    </Paragraph>
+  ),
+];
+
+const footer = [
+  render(
+    <Paragraph>
+      <TextRun text="I am a footer" />
+    </Paragraph>
+  ),
+];
+
+const page = AD.AbstractDoc.MasterPage.create({ header: header, footer: footer });
+
+export const test: ExportTestDef = {
+  name: "Header and footer",
+  abstractDocJsx: (
+    <AbstractDoc>
+      <Section page={page}>
+        <Paragraph>
+          <TextRun text={"I am body"} />
+        </Paragraph>
+      </Section>
+    </AbstractDoc>
+  ),
+  expectedDocxZipContexts: {
+    "word/document.xml": `<w:document
+  xmlns:wpc="http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas"
+  xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+  xmlns:o="urn:schemas-microsoft-com:office:office"
+  xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships"
+  xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math"
+  xmlns:v="urn:schemas-microsoft-com:vml"
+  xmlns:wp14="http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing"
+  xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing"
+  xmlns:w10="urn:schemas-microsoft-com:office:word"
+  xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"
+  xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml"
+  xmlns:w15="http://schemas.microsoft.com/office/word/2012/wordml"
+  xmlns:wpg="http://schemas.microsoft.com/office/word/2010/wordprocessingGroup"
+  xmlns:wpi="http://schemas.microsoft.com/office/word/2010/wordprocessingInk"
+  xmlns:wne="http://schemas.microsoft.com/office/word/2006/wordml"
+  xmlns:wps="http://schemas.microsoft.com/office/word/2010/wordprocessingShape"
+  mc:Ignorable="w14 w15 wp14"
+>
+  <w:background w:color="FFFFFF" />
+  <w:body>
+    <w:p>
+      <w:pPr>
+        <w:spacing w:before="0" w:after="0" w:line="1" />
+      </w:pPr>
+      <w:bookmarkStart w:name="" w:id="*" />
+      <w:bookmarkEnd w:id="*" />
+    </w:p>
+    <w:p>
+      <w:pPr>
+        <w:spacing w:before="0" w:after="0" />
+        <w:jc w:val="start" />
+        <w:ind w:left="0" w:end="0" />
+      </w:pPr>
+      <w:r>
+        <w:rPr>
+          <w:color w:val="black" />
+          <w:sz w:val="20" />
+          <w:szCs w:val="20" />
+          <w:rFonts
+            w:ascii="Arial"
+            w:cs="Arial"
+            w:eastAsia="Arial"
+            w:hAnsi="Arial"
+          />
+        </w:rPr>
+        <w:t xml:space="preserve">I am body</w:t>
+      </w:r>
+    </w:p>
+    <w:sectPr>
+      <w:pgSz w:w="11906" w:h="16838" w:orient="portrait" />
+      <w:pgMar
+        w:top="0"
+        w:right="0"
+        w:bottom="0"
+        w:left="0"
+        w:header="0"
+        w:footer="0"
+        w:gutter="0"
+        w:mirrorMargins="false"
+      />
+      <w:cols w:space="708" w:num="1" w:sep="false" />
+      <w:docGrid w:linePitch="360" />
+      <w:headerReference w:type="default" r:id="rId5" />
+      <w:footerReference w:type="default" r:id="rId6" />
+      <w:pgNumType />
+    </w:sectPr>
+  </w:body>
+</w:document>
+`,
+  },
+};