abstract-document 5.1.7 → 6.0.3

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

@@ -0,0 +1,30 @@
+import React from "react";
+import { ExportTestDef } from "../export-test-def";
+import { Markdown } from "../../../../abstract-document-jsx";
+
+export const test: 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 },
+        textStyle: { type: "TextStyle" },
+        type: "ParagraphStyle",
+      },
+      styleName: "",
+      type: "Paragraph",
+    },
+  ],
+};

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

@@ -0,0 +1,50 @@
+import React from "react";
+import { ExportTestDef } from "../export-test-def";
+import { Markdown, render } from "../../../../abstract-document-jsx";
+
+export const test: 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,
+            },
+            textStyle: {
+              type: "TextStyle",
+            },
+            type: "ParagraphStyle",
+          },
+          styleName: "H3",
+          type: "Paragraph",
+        },
+      ],
+      keepTogether: true,
+      type: "Group",
+    },
+  ],
+};

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

@@ -0,0 +1,44 @@
+import React from "react";
+import { ExportTestDef } from "../export-test-def";
+import { Markdown } from "../../../../abstract-document-jsx";
+
+export const test: 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 },
+        textStyle: { type: "TextStyle" },
+        type: "ParagraphStyle",
+      },
+      styleName: "",
+      type: "Paragraph",
+    },
+  ],
+};

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

@@ -0,0 +1,37 @@
+import React from "react";
+import { ExportTestDef } from "../export-test-def";
+import { Markdown, render } from "../../../../abstract-document-jsx";
+
+export const test: 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 },
+        textStyle: { type: "TextStyle" },
+        type: "ParagraphStyle",
+      },
+      styleName: "",
+      type: "Paragraph",
+    },
+  ],
+};

package/src/{_tests_/abstract-document → abstract-document/__tests__}/model-builder._test.ts

@@ -1,48 +1,48 @@
-/*
-import {assert} from "chai";
-import {DocumentBuilder} from "../../src/abstract-document-builder/index";
-import {create as createPageStyle} from "../../src/abstract-document/styles/page-style";
-import {create as createHeaderStyle} from "../../src/abstract-document/styles/header-style";
-import {create as createMasterPage} from "../../src/abstract-document/page/master-page";
-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);
-  // });
-
-});
-*/
+/*
+import {assert} from "chai";
+import {DocumentBuilder} from "../../src/abstract-document-builder/index";
+import {create as createPageStyle} from "../../src/abstract-document/styles/page-style";
+import {create as createHeaderStyle} from "../../src/abstract-document/styles/header-style";
+import {create as createMasterPage} from "../../src/abstract-document/page/master-page";
+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/abstract-doc.ts

@@ -1,19 +1,19 @@
-import { Section } from "./page/section";
-import { Resources } from "./resources";
-
-export type AbstractDoc = Resources & {
-  readonly children: ReadonlyArray<Section>;
-};
-
-export type AbstractDocProps = Resources & {};
-
-export function create(
-  props?: AbstractDocProps,
-  children?: ReadonlyArray<Section>
-): AbstractDoc {
-  const { ...rest } = props || {};
-  return {
-    children: children || [],
-    ...rest
-  };
-}
+import { Section } from "./page/section";
+import { Resources } from "./resources";
+
+export type AbstractDoc = Resources & {
+  readonly children: ReadonlyArray<Section>;
+};
+
+export type AbstractDocProps = Resources & {};
+
+export function create(
+  props?: AbstractDocProps,
+  children?: ReadonlyArray<Section>
+): AbstractDoc {
+  const { ...rest } = props || {};
+  return {
+    children: children || [],
+    ...rest
+  };
+}

package/src/abstract-document/atoms/atom.ts

@@ -1,14 +1,14 @@
-import { Image } from "./image";
-import { TextField } from "./text-field";
-import { TextRun } from "./text-run";
-import { HyperLink } from "./hyper-link";
-import { TocSeparator } from "./toc-separator";
-import { LinkTarget } from "./link-target";
-
-export type Atom =
-  | Image
-  | TextField
-  | TextRun
-  | HyperLink
-  | TocSeparator
-  | LinkTarget;
+import { Image } from "./image";
+import { TextField } from "./text-field";
+import { TextRun } from "./text-run";
+import { HyperLink } from "./hyper-link";
+import { TocSeparator } from "./toc-separator";
+import { LinkTarget } from "./link-target";
+
+export type Atom =
+  | Image
+  | TextField
+  | TextRun
+  | HyperLink
+  | TocSeparator
+  | LinkTarget;

package/src/abstract-document/atoms/hyper-link.ts

@@ -1,27 +1,27 @@
-import * as TextStyle from "../styles/text-style";
-
-export interface HyperLink {
-  readonly type: "HyperLink";
-  readonly styleName: string;
-  readonly text: string;
-  readonly target: string;
-  readonly style: TextStyle.TextStyle;
-}
-
-export interface HyperLinkProps {
-  readonly styleName?: string;
-  readonly text: string;
-  readonly target: string;
-  readonly style?: TextStyle.TextStyle;
-}
-
-export function create(props: HyperLinkProps): HyperLink {
-  const { styleName = "", text, target, style = TextStyle.create() } = props;
-  return {
-    type: "HyperLink",
-    styleName,
-    text,
-    target,
-    style
-  };
-}
+import * as TextStyle from "../styles/text-style";
+
+export interface HyperLink {
+  readonly type: "HyperLink";
+  readonly styleName: string;
+  readonly text: string;
+  readonly target: string;
+  readonly style: TextStyle.TextStyle;
+}
+
+export interface HyperLinkProps {
+  readonly styleName?: string;
+  readonly text: string;
+  readonly target: string;
+  readonly style?: TextStyle.TextStyle;
+}
+
+export function create(props: HyperLinkProps): HyperLink {
+  const { styleName = "", text, target, style = TextStyle.create() } = props;
+  return {
+    type: "HyperLink",
+    styleName,
+    text,
+    target,
+    style
+  };
+}

package/src/abstract-document/atoms/image.ts

@@ -1,21 +1,21 @@
-import { ImageResource } from "../primitives/image-resource";
-
-export interface Image {
-  readonly type: "Image";
-  readonly imageResource: ImageResource;
-  readonly width: number;
-  readonly height: number;
-}
-
-export interface ImageProps {
-  readonly imageResource: ImageResource;
-  readonly width: number;
-  readonly height: number;
-}
-
-export function create(props: ImageProps): Image {
-  return {
-    type: "Image",
-    ...props
-  };
-}
+import { ImageResource } from "../primitives/image-resource";
+
+export interface Image {
+  readonly type: "Image";
+  readonly imageResource: ImageResource;
+  readonly width: number;
+  readonly height: number;
+}
+
+export interface ImageProps {
+  readonly imageResource: ImageResource;
+  readonly width: number;
+  readonly height: number;
+}
+
+export function create(props: ImageProps): Image {
+  return {
+    type: "Image",
+    ...props
+  };
+}

package/src/abstract-document/atoms/link-target.ts

@@ -1,15 +1,15 @@
-export interface LinkTarget {
-  readonly type: "LinkTarget";
-  readonly name: string;
-}
-
-export interface LinkTargetProps {
-  readonly name: string;
-}
-
-export function create(props: LinkTargetProps): LinkTarget {
-  return {
-    type: "LinkTarget",
-    name: props.name
-  };
-}
+export interface LinkTarget {
+  readonly type: "LinkTarget";
+  readonly name: string;
+}
+
+export interface LinkTargetProps {
+  readonly name: string;
+}
+
+export function create(props: LinkTargetProps): LinkTarget {
+  return {
+    type: "LinkTarget",
+    name: props.name
+  };
+}

package/src/abstract-document/atoms/text-field.ts

@@ -1,36 +1,36 @@
-import * as TextStyle from "../styles/text-style";
-
-export type FieldType = "Date" | "PageNumber" | "TotalPages" | "PageNumberOf";
-
-export interface TextField {
-  readonly type: "TextField";
-  readonly styleName: string;
-  readonly fieldType: FieldType;
-  readonly style: TextStyle.TextStyle;
-  readonly target: string;
-  readonly text: string;
-}
-
-export interface TextFieldProps {
-  readonly styleName?: string;
-  readonly fieldType: FieldType;
-  readonly style?: TextStyle.TextStyle;
-  readonly target?: string;
-}
-
-export function create(props: TextFieldProps): TextField {
-  const {
-    styleName = "",
-    fieldType,
-    style = TextStyle.create(),
-    target = ""
-  } = props;
-  return {
-    type: "TextField",
-    styleName,
-    fieldType,
-    style,
-    target,
-    text: ""
-  };
-}
+import * as TextStyle from "../styles/text-style";
+
+export type FieldType = "Date" | "PageNumber" | "TotalPages" | "PageNumberOf";
+
+export interface TextField {
+  readonly type: "TextField";
+  readonly styleName: string;
+  readonly fieldType: FieldType;
+  readonly style: TextStyle.TextStyle;
+  readonly target: string;
+  readonly text: string;
+}
+
+export interface TextFieldProps {
+  readonly styleName?: string;
+  readonly fieldType: FieldType;
+  readonly style?: TextStyle.TextStyle;
+  readonly target?: string;
+}
+
+export function create(props: TextFieldProps): TextField {
+  const {
+    styleName = "",
+    fieldType,
+    style = TextStyle.create(),
+    target = ""
+  } = props;
+  return {
+    type: "TextField",
+    styleName,
+    fieldType,
+    style,
+    target,
+    text: ""
+  };
+}

package/src/abstract-document/atoms/text-run.ts

@@ -1,25 +1,25 @@
-import * as TextStyle from "../styles/text-style";
-
-export interface TextRun {
-  readonly type: "TextRun";
-  readonly styleName: string;
-  readonly nestedStyleNames?: ReadonlyArray<string>;
-  readonly text: string;
-  readonly style?: TextStyle.TextStyle;
-}
-
-export interface TextRunProps {
-  readonly styleName?: string;
-  readonly text: string;
-  readonly style?: TextStyle.TextStyle;
-}
-
-export function create(props: TextRunProps): TextRun {
-  const { styleName = "", text, style = TextStyle.create() } = props;
-  return {
-    type: "TextRun",
-    styleName,
-    text,
-    style
-  };
-}
+import * as TextStyle from "../styles/text-style";
+
+export interface TextRun {
+  readonly type: "TextRun";
+  readonly styleName: string;
+  readonly nestedStyleNames?: ReadonlyArray<string>;
+  readonly text: string;
+  readonly style?: TextStyle.TextStyle;
+}
+
+export interface TextRunProps {
+  readonly styleName?: string;
+  readonly text: string;
+  readonly style?: TextStyle.TextStyle;
+}
+
+export function create(props: TextRunProps): TextRun {
+  const { styleName = "", text, style = TextStyle.create() } = props;
+  return {
+    type: "TextRun",
+    styleName,
+    text,
+    style
+  };
+}

package/src/abstract-document/atoms/toc-separator.ts

@@ -1,14 +1,14 @@
-// TODO: This should be part of some kind of table of content API that better maps to Word file generation.
-//       TocSeparator would correspond to docx <w:fldChar w:fldCharType="separate"/> element.
-
-export interface TocSeparator {
-  readonly type: "TocSeparator";
-}
-
-export interface TocSeparatorProps {}
-
-export function create(_props: TocSeparatorProps): TocSeparator {
-  return {
-    type: "TocSeparator"
-  };
-}
+// TODO: This should be part of some kind of table of content API that better maps to Word file generation.
+//       TocSeparator would correspond to docx <w:fldChar w:fldCharType="separate"/> element.
+
+export interface TocSeparator {
+  readonly type: "TocSeparator";
+}
+
+export interface TocSeparatorProps {}
+
+export function create(_props: TocSeparatorProps): TocSeparator {
+  return {
+    type: "TocSeparator"
+  };
+}