abstract-document 14.0.3 → 14.0.5

package/src/abstract-document/__tests__/model-builder._test.ts

@@ -1,48 +0,0 @@
-/*
-import {assert} from "chai";
-import {DocumentBuilder} from "../../src/abstract-document-builder/index.js";
-import {create as createPageStyle} from "../../src/abstract-document/styles/page-style.js";
-import {create as createHeaderStyle} from "../../src/abstract-document/styles/header-style";
-import {create as createMasterPage} from "../../src/abstract-document/page/master-page.js";
-import {helloWorldDoc} from "./hello-world-abstract-doc";
-
-describe("model builder", () => {
-
-  it("should build", () => {
-    const builder = new DocumentBuilder();
-    const doc = builder.build();
-    assert.isOk(doc);
-  });
-
-  it("should build hello world", () => {
-    const pageStyle = createPageStyle("A4", "Portrait", createHeaderStyle(undefined, 5.0 * 595.0 / 210.0));
-    const page = createMasterPage(pageStyle, []);
-    const builder = new DocumentBuilder();
-    builder.beginSection(page);
-    builder.beginParagraph();
-    builder.insertTextRun("HELLO WORLD!");
-    builder.endParagraph();
-    builder.endSection();
-    const doc = builder.build();
-    // Get rid of keys that have undefined value before doing comparision
-    // assert.deepEqual(stripUndefinedKeys(doc), helloWorldDoc);
-    assert.deepEqual(doc, helloWorldDoc);
-  });
-
-  // it("should build hello world", () => {
-  //   const pageStyle = createPageStyle("A4", "Portrait", createHeaderStyle(undefined, 5.0 * 595.0 / 210.0));
-  //   const page = createMasterPage(pageStyle, []);
-  //   const builder = new DocumentBuilder();
-  //   builder.beginSection(page);
-  //   builder.beginParagraph();
-  //   builder.insertTextRun("HELLO WORLD!");
-  //   builder.endParagraph();
-  //   builder.endSection();
-  //   const doc = builder.build();
-  //   // Get rid of keys that have undefined value before doing comparision
-  //   // assert.deepEqual(stripUndefinedKeys(doc), helloWorldDoc);
-  //   assert.deepEqual(doc, helloWorldDoc);
-  // });
-
-});
-*/

package/src/abstract-document/__tests__/test-markdown/_export-test-def.ts

@@ -1,8 +0,0 @@
-/**
- * Defines a data-type that represents a single test for the Docx render function
- */
-export type ExportTestDef = {
-  readonly name: string;
-  readonly abstractDocJsx: JSX.Element;
-  readonly expectedMarkdown: {};
-};

package/src/abstract-document/__tests__/test-markdown/markdown-bold-italic.tsx

@@ -1,31 +0,0 @@
-import React from "react";
-import { ExportTestDef } from "./_export-test-def.js";
-import { Markdown } from "../../../abstract-document-jsx/index.js";
-
-export const testMarkdownBoldItalic: ExportTestDef = {
-  name: "Markdown bold italic",
-  abstractDocJsx: <Markdown text="***Italic and Bold***" />,
-  expectedMarkdown: [
-    {
-      children: [
-        {
-          nestedStyleNames: ["Strong", "Emphasis"],
-          styleName: "Emphasis",
-          text: "Italic and Bold",
-          textProperties: {},
-          type: "TextRun",
-        },
-      ],
-      numbering: undefined,
-      style: {
-        alignment: undefined,
-        margins: { bottom: 0, left: 0, right: 0, top: 0 },
-        position: "relative",
-        textStyle: { type: "TextStyle" },
-        type: "ParagraphStyle",
-      },
-      styleName: "",
-      type: "Paragraph",
-    },
-  ],
-};

package/src/abstract-document/__tests__/test-markdown/markdown-bold.tsx

@@ -1,31 +0,0 @@
-import React from "react";
-import { ExportTestDef } from "./_export-test-def.js";
-import { Markdown } from "../../../abstract-document-jsx/index.js";
-
-export const testMarkdownBold: ExportTestDef = {
-  name: "Markdown bold",
-  abstractDocJsx: <Markdown text="**Bold**" />,
-  expectedMarkdown: [
-    {
-      children: [
-        {
-          nestedStyleNames: ["Strong"],
-          styleName: "Strong",
-          text: "Bold",
-          textProperties: {},
-          type: "TextRun",
-        },
-      ],
-      numbering: undefined,
-      style: {
-        alignment: undefined,
-        margins: { bottom: 0, left: 0, right: 0, top: 0 },
-        position: "relative",
-        textStyle: { type: "TextStyle" },
-        type: "ParagraphStyle",
-      },
-      styleName: "",
-      type: "Paragraph",
-    },
-  ],
-};

package/src/abstract-document/__tests__/test-markdown/markdown-empty-keepTogether.tsx

@@ -1,54 +0,0 @@
-import React from "react";
-import { ExportTestDef } from "./_export-test-def.js";
-import { Markdown, render } from "../../../abstract-document-jsx/index.js";
-
-export const testEmptyKeepTogether: ExportTestDef = {
-  name: "Markdown empty keepTogether",
-  abstractDocJsx: <Markdown text="test" keepTogetherSections={true} />,
-  expectedMarkdown: [
-    {
-      children: [
-        {
-          children: [
-            {
-              nestedStyleNames: [],
-              styleName: undefined,
-              text: "test",
-              textProperties: {},
-              type: "TextRun",
-            },
-          ],
-          numbering: undefined,
-          style: {
-            alignment: undefined,
-            margins: {
-              bottom: 0,
-              left: 0,
-              right: 0,
-              top: 0,
-            },
-            position: "relative",
-            textStyle: {
-              type: "TextStyle",
-            },
-            type: "ParagraphStyle",
-          },
-          styleName: "",
-          type: "Paragraph",
-        },
-      ],
-      keepTogether: true,
-      style: {
-        margins: {
-          bottom: 0,
-          left: 0,
-          right: 0,
-          top: 0,
-        },
-        position: "relative",
-        type: "GroupStyle",
-      },
-      type: "Group",
-    },
-  ],
-};

package/src/abstract-document/__tests__/test-markdown/markdown-header.tsx

@@ -1,38 +0,0 @@
-import React from "react";
-import { ExportTestDef } from "./_export-test-def.js";
-import { Markdown } from "../../../abstract-document-jsx/index.js";
-
-export const testMarkdownHeader: ExportTestDef = {
-  name: "Markdown heading 3",
-  abstractDocJsx: <Markdown text="### Heading 3" />,
-  expectedMarkdown: [
-    {
-      children: [
-        {
-          nestedStyleNames: ["H3"],
-          styleName: "H3",
-          text: "Heading 3",
-          textProperties: {},
-          type: "TextRun",
-        },
-      ],
-      numbering: undefined,
-      style: {
-        alignment: undefined,
-        margins: {
-          bottom: 0,
-          left: 0,
-          right: 0,
-          top: 0,
-        },
-        position: "relative",
-        textStyle: {
-          type: "TextStyle",
-        },
-        type: "ParagraphStyle",
-      },
-      styleName: "H3",
-      type: "Paragraph",
-    },
-  ],
-};

package/src/abstract-document/__tests__/test-markdown/markdown-italic.tsx

@@ -1,31 +0,0 @@
-import React from "react";
-import { ExportTestDef } from "./_export-test-def.js";
-import { Markdown } from "../../../abstract-document-jsx/index.js";
-
-export const testMarkdownItalic: ExportTestDef = {
-  name: "Markdown italic",
-  abstractDocJsx: <Markdown text="*Italic*" />,
-  expectedMarkdown: [
-    {
-      children: [
-        {
-          nestedStyleNames: ["Emphasis"],
-          styleName: "Emphasis",
-          text: "Italic",
-          textProperties: {},
-          type: "TextRun",
-        },
-      ],
-      numbering: undefined,
-      style: {
-        alignment: undefined,
-        margins: { bottom: 0, left: 0, right: 0, top: 0 },
-        position: "relative",
-        textStyle: { type: "TextStyle" },
-        type: "ParagraphStyle",
-      },
-      styleName: "",
-      type: "Paragraph",
-    },
-  ],
-};

package/src/abstract-document/__tests__/test-markdown/markdown-keepTogether.tsx

@@ -1,61 +0,0 @@
-import React from "react";
-import { ExportTestDef } from "./_export-test-def.js";
-import { Markdown, render } from "../../../abstract-document-jsx/index.js";
-
-export const testMarkdownKeepTogether: ExportTestDef = {
-  name: "Markdown keepTogether",
-  abstractDocJsx: <Markdown text="### Test 2^10^ " keepTogetherSections={true} />,
-  expectedMarkdown: [
-    {
-      children: [
-        {
-          children: [
-            {
-              nestedStyleNames: ["H3"],
-              styleName: "H3",
-              text: "Test 2",
-              textProperties: {},
-              type: "TextRun",
-            },
-            {
-              nestedStyleNames: ["H3", "Superscript"],
-              styleName: "Superscript",
-              text: "10",
-              textProperties: {},
-              type: "TextRun",
-            },
-          ],
-          numbering: undefined,
-          style: {
-            alignment: undefined,
-            margins: {
-              bottom: 0,
-              left: 0,
-              right: 0,
-              top: 0,
-            },
-            position: "relative",
-            textStyle: {
-              type: "TextStyle",
-            },
-            type: "ParagraphStyle",
-          },
-          styleName: "H3",
-          type: "Paragraph",
-        },
-      ],
-      keepTogether: true,
-      style: {
-        margins: {
-          bottom: 0,
-          left: 0,
-          right: 0,
-          top: 0,
-        },
-        position: "relative",
-        type: "GroupStyle",
-      },
-      type: "Group",
-    },
-  ],
-};

package/src/abstract-document/__tests__/test-markdown/markdown-subscript.tsx

@@ -1,45 +0,0 @@
-import React from "react";
-import { ExportTestDef } from "./_export-test-def.js";
-import { Markdown } from "../../../abstract-document-jsx/index.js";
-
-export const testMarkdownSubscript: ExportTestDef = {
-  name: "Markdown subscript",
-  abstractDocJsx: <Markdown text="H~2~O" />,
-  expectedMarkdown: [
-    {
-      children: [
-        {
-          nestedStyleNames: [],
-          styleName: undefined,
-          text: "H",
-          textProperties: {},
-          type: "TextRun",
-        },
-        {
-          nestedStyleNames: ["Subscript"],
-          styleName: "Subscript",
-          text: "2",
-          textProperties: {},
-          type: "TextRun",
-        },
-        {
-          nestedStyleNames: [],
-          styleName: undefined,
-          text: "O",
-          textProperties: {},
-          type: "TextRun",
-        },
-      ],
-      numbering: undefined,
-      style: {
-        alignment: undefined,
-        margins: { bottom: 0, left: 0, right: 0, top: 0 },
-        position: "relative",
-        textStyle: { type: "TextStyle" },
-        type: "ParagraphStyle",
-      },
-      styleName: "",
-      type: "Paragraph",
-    },
-  ],
-};

package/src/abstract-document/__tests__/test-markdown/markdown-superscript.tsx

@@ -1,38 +0,0 @@
-import React from "react";
-import { ExportTestDef } from "./_export-test-def.js";
-import { Markdown, render } from "../../../abstract-document-jsx/index.js";
-
-export const testMarkdownSuperscript: ExportTestDef = {
-  name: "Markdown superscript",
-  abstractDocJsx: <Markdown text="2^10^" />,
-  expectedMarkdown: [
-    {
-      children: [
-        {
-          nestedStyleNames: [],
-          styleName: undefined,
-          text: "2",
-          textProperties: {},
-          type: "TextRun",
-        },
-        {
-          nestedStyleNames: ["Superscript"],
-          styleName: "Superscript",
-          text: "10",
-          textProperties: {},
-          type: "TextRun",
-        },
-      ],
-      numbering: undefined,
-      style: {
-        alignment: undefined,
-        margins: { bottom: 0, left: 0, right: 0, top: 0 },
-        position: "relative",
-        textStyle: { type: "TextStyle" },
-        type: "ParagraphStyle",
-      },
-      styleName: "",
-      type: "Paragraph",
-    },
-  ],
-};

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

@@ -1,126 +0,0 @@
-import * as S from "stream";
-import path from "path";
-import * as DiffJsXml from "diff-js-xml";
-import { describe, test, expect } from "vitest";
-import { saveBufferInTmpDir, streamToBuffer } from "./test-utils/index.js";
-import { exportToStream } from "../docx2/render.js";
-import { render } from "../../abstract-document-jsx/index.js";
-import jszip from "jszip";
-import { testGroup } from "./tests-docx2/group.js";
-import { testHeaderAndFooter } from "./tests-docx2/header-and-footer.js";
-import { testHelloArialFont } from "./tests-docx2/hello-arial-font.js";
-import { testHello } from "./tests-docx2/hello.js";
-import { testLetterDimensions } from "./tests-docx2/letter-dimensions.js";
-import { testMixedHyperLinkAndTextRun } from "./tests-docx2/mixed-hyperlink-and-textrun.js";
-import { testMixedTextRunAndImages } from "./tests-docx2/mixed-textrun-and-images.js";
-import { testMultipleImages } from "./tests-docx2/multiple-images.js";
-import { testMultipleTables } from "./tests-docx2/multiple-tables.js";
-import { testMultipleTextrunWithCenterAlignment } from "./tests-docx2/multiple-textrun-with-center-alignment.js";
-import { textMultipleTextRunWithEndAlignmnet } from "./tests-docx2/multiple-textrun-with-end-alignment.js";
-import { testMultipleTextRunWithStartAlignmnetThatLineBreaks } from "./tests-docx2/multiple-textrun-with-start-alignment-that-linebreaks.js";
-import { testMultipleTextRunWithStartAlignmnet } from "./tests-docx2/multiple-textrun-with-start-alignment.js";
-import { testPageNumbering } from "./tests-docx2/page-numbering.js";
-import { testPageOrientationLandscape } from "./tests-docx2/page-orientation-landscape.js";
-import { testPageOrienationPortrait } from "./tests-docx2/page-orientation-portrait.js";
-import { testSimpleTableColSpanAndRowSpan } from "./tests-docx2/simple-table-colSpan-and-rowSpan.js";
-import { testSimpleTableWithoutRows } from "./tests-docx2/simple-table-without-rows.js";
-import { testSimpleTable } from "./tests-docx2/simple-table.js";
-import { testSingleHyperLink } from "./tests-docx2/single-hyperlink.js";
-import { testSingleImage } from "./tests-docx2/single-image.js";
-import { testSingleTextRunWithCenterAlignmentThatLineBreaks } from "./tests-docx2/single-textrun-with-center-alignment-that-linebreaks.js";
-import { testSingleTextRunWithCenterAlignment } from "./tests-docx2/single-textrun-with-center-alignment.js";
-import { testSingleTextRunWithEndAlignmentThatLineBreaks } from "./tests-docx2/single-textrun-with-end-alignment-that-linebreaks.js";
-import { testSingleTextRunWithEndAlignment } from "./tests-docx2/single-textrun-with-end-alignment.js";
-import { testSingleTextRunWithStartAlignmentThatLineBreaks } from "./tests-docx2/single-textrun-with-start-alignment-that-linebreaks.js";
-import { testSingleTextRunWithStartAlignment } from "./tests-docx2/single-textrun-with-start-alignment.js";
-import { testSingleTextRun } from "./tests-docx2/single-textrun.js";
-import { testTocSeparator } from "./tests-docx2/toc-separator.js";
-import { testWorld } from "./tests-docx2/world.js";
-
-describe("export docx", () => {
-  [
-    testGroup,
-    testHeaderAndFooter,
-    testHelloArialFont,
-    testHello,
-    testLetterDimensions,
-    testMixedHyperLinkAndTextRun,
-    testMixedTextRunAndImages,
-    testMultipleImages,
-    testMultipleTables,
-    testMultipleTextrunWithCenterAlignment,
-    textMultipleTextRunWithEndAlignmnet,
-    testMultipleTextRunWithStartAlignmnetThatLineBreaks,
-    testMultipleTextRunWithStartAlignmnet,
-    testPageNumbering,
-    testPageOrientationLandscape,
-    testPageOrienationPortrait,
-    testSimpleTableColSpanAndRowSpan,
-    testSimpleTableWithoutRows,
-    testSimpleTable,
-    testSingleHyperLink,
-    testSingleImage,
-    testSingleTextRunWithCenterAlignmentThatLineBreaks,
-    testSingleTextRunWithCenterAlignment,
-    testSingleTextRunWithEndAlignmentThatLineBreaks,
-    testSingleTextRunWithEndAlignment,
-    testSingleTextRunWithStartAlignmentThatLineBreaks,
-    testSingleTextRunWithStartAlignment,
-    testSingleTextRun,
-    testTocSeparator,
-    testWorld,
-  ].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", docxWordDocumentXml);
-            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__/pdf/_export-test-def.ts

@@ -1,10 +0,0 @@
-/**
- * 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 expectedPdfJson: {};
-};

package/src/abstract-document-exporters/__tests__/pdf/absolute-position-group.tsx

@@ -1,82 +0,0 @@
-import React from "react";
-import * as AD from "../../../index.js";
-import { ExportTestDef } from "./_export-test-def.js";
-import { Paragraph, AbstractDoc, Section, TextRun, Group } from "../../../abstract-document-jsx/index.js";
-
-export const testAbsolutePositionGroup: ExportTestDef = {
-  name: "Absolute position group",
-  abstractDocJsx: (
-    <AbstractDoc>
-      <Section>
-        <Group
-          style={AD.AbstractDoc.GroupStyle.create({
-            position: "absolute",
-            margins: AD.AbstractDoc.LayoutFoundation.create({ top: 100, left: 200 }),
-          })}
-        >
-          <Paragraph>
-            <TextRun text={"Hello! I am absolutely absolute positioned."} />
-          </Paragraph>
-          <Paragraph>
-            <TextRun text={"I am too, because I belong in the same group."} />
-          </Paragraph>
-        </Group>
-      </Section>
-    </AbstractDoc>
-  ),
-  expectedPdfJson: {
-    Transcoder: "pdf2json@2.0.1 [https://github.com/modesty/pdf2json]",
-    Meta: {
-      CreationDate: "*",
-      Creator: "PDFKit",
-      IsAcroFormPresent: false,
-      IsXFAPresent: false,
-      Metadata: {},
-      PDFFormatVersion: "1.3",
-      Producer: "PDFKit",
-    },
-    Pages: [
-      {
-        Width: 37.188,
-        Height: 52.625,
-        HLines: [],
-        VLines: [],
-        Fills: [],
-        Texts: [
-          {
-            x: 12.25,
-            y: 5.949,
-            w: 187.31,
-            sw: 0.32553125,
-            oc: undefined,
-            A: "left",
-            R: [
-              {
-                T: "Hello!%20I%20am%20absolutely%20absolute%20positioned.",
-                S: -1,
-                TS: [0, 13, 0, 0],
-              },
-            ],
-          },
-          {
-            x: 12.25,
-            y: 6.671,
-            w: 203.45,
-            sw: 0.32553125,
-            oc: undefined,
-            A: "left",
-            R: [
-              {
-                T: "I%20am%20too%2C%20because%20I%20belong%20in%20the%20same%20group.",
-                S: -1,
-                TS: [0, 13, 0, 0],
-              },
-            ],
-          },
-        ],
-        Fields: [],
-        Boxsets: [],
-      },
-    ],
-  },
-};