abstract-document 5.1.7 → 6.0.3

package/src/{_tests_/abstract-document → abstract-document/__tests__}/hello-world-abstract-doc.ts

@@ -1,245 +1,245 @@
-/*
-import {AbstractDoc} from "../../src/abstract-document/index";
-
-export const helloWorldDoc: AbstractDoc.AbstractDoc = {
-  "imageResources": {},
-  "numberingDefinitions": {},
-  "numberings": {},
-  "sections": [
-    {
-      "page": {
-        "footer": [],
-        "header": [],
-        "style": {
-          "header": {
-            "fixedHeight": undefined,
-            "margins": {
-              "bottom": 14.166666666666666,
-              "left": 0,
-              "right": 0,
-              "top": 0,
-            }
-          },
-          "margins": {
-            "bottom": 22.666666666666668,
-            "left": 56.666666666666664,
-            "right": 42.5,
-            "top": 22.666666666666668,
-          },
-          "orientation": "Portrait",
-          "paperSize": "A4",
-        }
-      },
-      "sectionElements": [
-        {
-          "atoms": [
-            {
-              "styleName": undefined,
-              "text": "HELLO WORLD!",
-              "textProperties": {
-                "bold": false,
-                "color": undefined,
-                "fontFamily": "Lucida Grande/Lucida Sans Unicode",
-                "fontSize": 10,
-                "italic": false,
-                "subScript": false,
-                "superScript": false,
-                "underline": false,
-              },
-              "type": "TextRun",
-            }
-          ],
-          "numbering": undefined,
-          "paragraphProperties": {
-            "alignment": undefined,
-            "spacingAfter": undefined,
-            "spacingBefore": undefined,
-          },
-          "styleName": undefined,
-          "textProperties": {
-            "bold": undefined,
-            "color": undefined,
-            "fontFamily": undefined,
-            "fontSize": undefined,
-            "italic": undefined,
-            "subScript": undefined,
-            "superScript": undefined,
-            "underline": undefined,
-          },
-          "type": "Paragraph"
-        }
-      ]
-    }
-  ],
-  "styles": {
-    "ParagraphStyle_Default": {
-      "basedOn": undefined,
-      "paragraphProperties": {
-        "alignment": "Start",
-        "spacingAfter": {
-          "twips": 0,
-        },
-        "spacingBefore": {
-          "twips": 0,
-        }
-      },
-      "textProperties": {
-        "bold": false,
-        "color": undefined,
-        "fontFamily": "Lucida Grande/Lucida Sans Unicode",
-        "fontSize": 10,
-        "italic": false,
-        "subScript": false,
-        "superScript": false,
-        "underline": false,
-      },
-      "type": "ParagraphStyle"
-    },
-    "ParagraphStyle_HeaderHeading": {
-      "basedOn": undefined,
-      "paragraphProperties": {
-        "alignment": "Center",
-        "spacingAfter": undefined,
-        "spacingBefore": undefined,
-      },
-      "textProperties": {
-        "bold": true,
-        "color": undefined,
-        "fontFamily": undefined,
-        "fontSize": undefined,
-        "italic": undefined,
-        "subScript": undefined,
-        "superScript": undefined,
-        "underline": undefined,
-      },
-      "type": "ParagraphStyle"
-    },
-    "ParagraphStyle_Heading1": {
-      "basedOn": undefined,
-      "paragraphProperties": {
-        "alignment": undefined,
-        "spacingAfter": undefined,
-        "spacingBefore": undefined,
-      },
-      "textProperties": {
-        "bold": true,
-        "color": undefined,
-        "fontFamily": undefined,
-        "fontSize": 12,
-        "italic": undefined,
-        "subScript": undefined,
-        "superScript": undefined,
-        "underline": undefined,
-      },
-      "type": "ParagraphStyle",
-    },
-    "ParagraphStyle_Heading2": {
-      "basedOn": undefined,
-      "paragraphProperties": {
-        "alignment": undefined,
-        "spacingAfter": undefined,
-        "spacingBefore": undefined,
-      },
-      "textProperties": {
-        "bold": true,
-        "color": undefined,
-        "fontFamily": undefined,
-        "fontSize": 10,
-        "italic": undefined,
-        "subScript": undefined,
-        "superScript": undefined,
-        "underline": undefined,
-      },
-      "type": "ParagraphStyle",
-    },
-    "TableCellStyle_Default": {
-      "basedOn": undefined,
-      "tableCellProperties": {
-        "background": {
-          "a": 0,
-          "b": 255,
-          "g": 255,
-          "r": 255,
-        },
-        "borders": {
-          "bottom": 0,
-          "left": 0,
-          "right": 0,
-          "top": 0,
-        },
-        "padding": {
-          "bottom": 0,
-          "left": 0,
-          "right": 0,
-          "top": 0,
-        },
-        "verticalAlignment": "Middle",
-      },
-      "type": "TableCellStyle",
-    },
-    "TableStyle_Default": {
-      "basedOn": undefined,
-      "tableProperties": {
-        "alignment": "Left"
-      },
-      "type": "TableStyle",
-    },
-    "TextStyle_Default": {
-      "basedOn": undefined,
-      "textProperties": {
-        "bold": false,
-        "color": undefined,
-        "fontFamily": "Lucida Grande/Lucida Sans Unicode",
-        "fontSize": 10,
-        "italic": false,
-        "subScript": false,
-        "superScript": false,
-        "underline": false,
-      },
-      "type": "TextStyle",
-    },
-    "TextStyle_HeaderHeading": {
-      "basedOn": undefined,
-      "textProperties": {
-        "bold": true,
-        "color": undefined,
-        "fontFamily": undefined,
-        "fontSize": undefined,
-        "italic": undefined,
-        "subScript": undefined,
-        "superScript": undefined,
-        "underline": undefined,
-      },
-      "type": "TextStyle",
-    },
-    "TextStyle_Heading1": {
-      "basedOn": undefined,
-      "textProperties": {
-        "bold": true,
-        "color": undefined,
-        "fontFamily": undefined,
-        "fontSize": 12,
-        "italic": undefined,
-        "subScript": undefined,
-        "superScript": undefined,
-        "underline": undefined,
-      },
-      "type": "TextStyle",
-    },
-    "TextStyle_Heading2": {
-      "basedOn": undefined,
-      "textProperties": {
-        "bold": true,
-        "color": undefined,
-        "fontFamily": undefined,
-        "fontSize": 10,
-        "italic": undefined,
-        "subScript": undefined,
-        "superScript": undefined,
-        "underline": undefined,
-      },
-      "type": "TextStyle"
-    }
-  }
-};
-*/
+/*
+import {AbstractDoc} from "../../src/abstract-document/index";
+
+export const helloWorldDoc: AbstractDoc.AbstractDoc = {
+  "imageResources": {},
+  "numberingDefinitions": {},
+  "numberings": {},
+  "sections": [
+    {
+      "page": {
+        "footer": [],
+        "header": [],
+        "style": {
+          "header": {
+            "fixedHeight": undefined,
+            "margins": {
+              "bottom": 14.166666666666666,
+              "left": 0,
+              "right": 0,
+              "top": 0,
+            }
+          },
+          "margins": {
+            "bottom": 22.666666666666668,
+            "left": 56.666666666666664,
+            "right": 42.5,
+            "top": 22.666666666666668,
+          },
+          "orientation": "Portrait",
+          "paperSize": "A4",
+        }
+      },
+      "sectionElements": [
+        {
+          "atoms": [
+            {
+              "styleName": undefined,
+              "text": "HELLO WORLD!",
+              "textProperties": {
+                "bold": false,
+                "color": undefined,
+                "fontFamily": "Lucida Grande/Lucida Sans Unicode",
+                "fontSize": 10,
+                "italic": false,
+                "subScript": false,
+                "superScript": false,
+                "underline": false,
+              },
+              "type": "TextRun",
+            }
+          ],
+          "numbering": undefined,
+          "paragraphProperties": {
+            "alignment": undefined,
+            "spacingAfter": undefined,
+            "spacingBefore": undefined,
+          },
+          "styleName": undefined,
+          "textProperties": {
+            "bold": undefined,
+            "color": undefined,
+            "fontFamily": undefined,
+            "fontSize": undefined,
+            "italic": undefined,
+            "subScript": undefined,
+            "superScript": undefined,
+            "underline": undefined,
+          },
+          "type": "Paragraph"
+        }
+      ]
+    }
+  ],
+  "styles": {
+    "ParagraphStyle_Default": {
+      "basedOn": undefined,
+      "paragraphProperties": {
+        "alignment": "Start",
+        "spacingAfter": {
+          "twips": 0,
+        },
+        "spacingBefore": {
+          "twips": 0,
+        }
+      },
+      "textProperties": {
+        "bold": false,
+        "color": undefined,
+        "fontFamily": "Lucida Grande/Lucida Sans Unicode",
+        "fontSize": 10,
+        "italic": false,
+        "subScript": false,
+        "superScript": false,
+        "underline": false,
+      },
+      "type": "ParagraphStyle"
+    },
+    "ParagraphStyle_HeaderHeading": {
+      "basedOn": undefined,
+      "paragraphProperties": {
+        "alignment": "Center",
+        "spacingAfter": undefined,
+        "spacingBefore": undefined,
+      },
+      "textProperties": {
+        "bold": true,
+        "color": undefined,
+        "fontFamily": undefined,
+        "fontSize": undefined,
+        "italic": undefined,
+        "subScript": undefined,
+        "superScript": undefined,
+        "underline": undefined,
+      },
+      "type": "ParagraphStyle"
+    },
+    "ParagraphStyle_Heading1": {
+      "basedOn": undefined,
+      "paragraphProperties": {
+        "alignment": undefined,
+        "spacingAfter": undefined,
+        "spacingBefore": undefined,
+      },
+      "textProperties": {
+        "bold": true,
+        "color": undefined,
+        "fontFamily": undefined,
+        "fontSize": 12,
+        "italic": undefined,
+        "subScript": undefined,
+        "superScript": undefined,
+        "underline": undefined,
+      },
+      "type": "ParagraphStyle",
+    },
+    "ParagraphStyle_Heading2": {
+      "basedOn": undefined,
+      "paragraphProperties": {
+        "alignment": undefined,
+        "spacingAfter": undefined,
+        "spacingBefore": undefined,
+      },
+      "textProperties": {
+        "bold": true,
+        "color": undefined,
+        "fontFamily": undefined,
+        "fontSize": 10,
+        "italic": undefined,
+        "subScript": undefined,
+        "superScript": undefined,
+        "underline": undefined,
+      },
+      "type": "ParagraphStyle",
+    },
+    "TableCellStyle_Default": {
+      "basedOn": undefined,
+      "tableCellProperties": {
+        "background": {
+          "a": 0,
+          "b": 255,
+          "g": 255,
+          "r": 255,
+        },
+        "borders": {
+          "bottom": 0,
+          "left": 0,
+          "right": 0,
+          "top": 0,
+        },
+        "padding": {
+          "bottom": 0,
+          "left": 0,
+          "right": 0,
+          "top": 0,
+        },
+        "verticalAlignment": "Middle",
+      },
+      "type": "TableCellStyle",
+    },
+    "TableStyle_Default": {
+      "basedOn": undefined,
+      "tableProperties": {
+        "alignment": "Left"
+      },
+      "type": "TableStyle",
+    },
+    "TextStyle_Default": {
+      "basedOn": undefined,
+      "textProperties": {
+        "bold": false,
+        "color": undefined,
+        "fontFamily": "Lucida Grande/Lucida Sans Unicode",
+        "fontSize": 10,
+        "italic": false,
+        "subScript": false,
+        "superScript": false,
+        "underline": false,
+      },
+      "type": "TextStyle",
+    },
+    "TextStyle_HeaderHeading": {
+      "basedOn": undefined,
+      "textProperties": {
+        "bold": true,
+        "color": undefined,
+        "fontFamily": undefined,
+        "fontSize": undefined,
+        "italic": undefined,
+        "subScript": undefined,
+        "superScript": undefined,
+        "underline": undefined,
+      },
+      "type": "TextStyle",
+    },
+    "TextStyle_Heading1": {
+      "basedOn": undefined,
+      "textProperties": {
+        "bold": true,
+        "color": undefined,
+        "fontFamily": undefined,
+        "fontSize": 12,
+        "italic": undefined,
+        "subScript": undefined,
+        "superScript": undefined,
+        "underline": undefined,
+      },
+      "type": "TextStyle",
+    },
+    "TextStyle_Heading2": {
+      "basedOn": undefined,
+      "textProperties": {
+        "bold": true,
+        "color": undefined,
+        "fontFamily": undefined,
+        "fontSize": 10,
+        "italic": undefined,
+        "subScript": undefined,
+        "superScript": undefined,
+        "underline": undefined,
+      },
+      "type": "TextStyle"
+    }
+  }
+};
+*/

package/src/abstract-document/__tests__/markdown/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 expectedMarkdown: {};
+};

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

@@ -0,0 +1,15 @@
+import path from "path";
+import { loadTests, onlySkip } from "@abstract-visuals/test-utils";
+import { ExportTestDef } from "./export-test-def";
+import { render } from "../../../abstract-document-jsx";
+
+export const tests = loadTests<ExportTestDef>(path.join(__dirname, "test-defs/"));
+
+describe("markdown", () => {
+  onlySkip(tests).forEach((item) => {
+    test(item.name, async () => {
+      const abstractDoc = render(item.abstractDocJsx);
+      expect(abstractDoc).toEqual(item.expectedMarkdown);
+    });
+  });
+});

package/src/abstract-document/__tests__/markdown/test-defs/markdown-bold-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 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 },
+        textStyle: { type: "TextStyle" },
+        type: "ParagraphStyle",
+      },
+      styleName: "",
+      type: "Paragraph",
+    },
+  ],
+};

package/src/abstract-document/__tests__/markdown/test-defs/markdown-bold.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 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 },
+        textStyle: { type: "TextStyle" },
+        type: "ParagraphStyle",
+      },
+      styleName: "",
+      type: "Paragraph",
+    },
+  ],
+};

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

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

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

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