abstract-document 6.3.2 → 6.6.0

package/src/abstract-document/section-elements/section-element.ts

@@ -1,6 +1,17 @@
-import { Group } from "./group";
-import { Paragraph } from "./paragraph";
-import { Table } from "./table";
-import { PageBreak } from "./page-break";
+import * as Group from "./group";
+import * as Paragraph from "./paragraph";
+import * as Table from "./table";
+import * as PageBreak from "./page-break";
 
-export type SectionElement = Group | Paragraph | Table | PageBreak;
+export type SectionElement = Group.Group | Paragraph.Paragraph | Table.Table | PageBreak.PageBreak;
+export type SectionElementNoPageBreak = Exclude<SectionElement, PageBreak.PageBreak>;
+export type SectionElementStyle = SectionElementNoPageBreak["style"];
+export const SectionElementTypeNoPagebreak = [Group.sectionType, Paragraph.sectionType, Table.sectionType];
+
+export function isSectionElement(value: SectionElement): value is SectionElementNoPageBreak {
+  return SectionElementTypeNoPagebreak.includes(value.type);
+}
+
+export function getSectionStyle(element: SectionElement): SectionElementStyle | undefined {
+  return isSectionElement(element) ? element.style : undefined;
+}

package/src/abstract-document/section-elements/table.ts

@@ -2,36 +2,33 @@ import { Resources } from "../resources";
 import * as TableRow from "../table/table-row";
 import * as TableStyle from "../styles/table-style";
 
+export const sectionType = "Table";
+
 export type Table = Resources & {
-  readonly type: "Table";
+  readonly type: typeof sectionType;
   readonly columnWidths: ReadonlyArray<number>;
   readonly styleName: string;
   readonly style: TableStyle.TableStyle;
+  readonly headerRows: ReadonlyArray<TableRow.TableRow>;
   readonly children: ReadonlyArray<TableRow.TableRow>;
 };
 
 export type TableProps = Resources & {
   readonly columnWidths: ReadonlyArray<number>;
   readonly styleName?: string;
+  readonly headerRows?: ReadonlyArray<TableRow.TableRow>;
   readonly style?: TableStyle.TableStyle;
 };
 
-export function create(
-  props: TableProps,
-  children?: ReadonlyArray<TableRow.TableRow>
-): Table {
-  const {
-    columnWidths,
-    styleName = "",
-    style = TableStyle.create(),
-    ...rest
-  } = props;
+export function create(props: TableProps, children?: ReadonlyArray<TableRow.TableRow>): Table {
+  const { columnWidths, styleName = "", headerRows, style = TableStyle.create(), ...rest } = props;
   return {
-    type: "Table",
+    type: sectionType,
     columnWidths,
     styleName,
     style,
+    headerRows: headerRows || [],
     children: children || [],
-    ...rest
+    ...rest,
   };
 }

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

@@ -0,0 +1,30 @@
+import * as LayoutFoundation from "../primitives/layout-foundation";
+import * as Position from "./position";
+
+export interface GroupStyle {
+  readonly type: "GroupStyle";
+  readonly position: Position.Position;
+  readonly margins: LayoutFoundation.LayoutFoundation;
+}
+
+export interface GroupStyleProps {
+  readonly position?: Position.Position;
+  readonly margins?: LayoutFoundation.LayoutFoundation;
+}
+
+export function create(props?: GroupStyleProps): GroupStyle {
+  const { margins = LayoutFoundation.create(), position = "relative" } = props || {};
+  return {
+    type: "GroupStyle",
+    margins,
+    position,
+  };
+}
+
+export function overrideWith(overrider: GroupStyle | undefined, toOverride: GroupStyle | undefined): GroupStyle {
+  const a: GroupStyleProps = overrider || {};
+  const b: GroupStyleProps = toOverride || {};
+  return create({
+    margins: LayoutFoundation.overrideWith(a.margins, b.margins),
+  });
+}

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

@@ -1,16 +1,19 @@
 import * as TextStyle from "./text-style";
 import * as LayoutFoundation from "../primitives/layout-foundation";
+import * as Position from "./position";
 
 export type TextAlignment = "Start" | "Center" | "End" | "Justify";
 
 export interface ParagraphStyle {
   readonly type: "ParagraphStyle";
+  readonly position: Position.Position;
   readonly alignment?: TextAlignment;
   readonly margins: LayoutFoundation.LayoutFoundation;
   readonly textStyle: TextStyle.TextStyle;
 }
 
 export interface ParagraphStyleProps {
+  readonly position?: Position.Position;
   readonly alignment?: TextAlignment;
   readonly margins?: LayoutFoundation.LayoutFoundation;
   readonly textStyle?: TextStyle.TextStyle;
@@ -20,14 +23,15 @@ export function create(props?: ParagraphStyleProps): ParagraphStyle {
   const {
     alignment = undefined,
     margins = LayoutFoundation.create(),
-    textStyle = TextStyle.create()
-  } =
-    props || {};
+    position = "relative",
+    textStyle = TextStyle.create(),
+  } = props || {};
   return {
     type: "ParagraphStyle",
     alignment,
     margins,
-    textStyle
+    position,
+    textStyle,
   };
 }
 
@@ -40,6 +44,6 @@ export function overrideWith(
   return create({
     alignment: a.alignment || b.alignment,
     margins: LayoutFoundation.overrideWith(a.margins, b.margins),
-    textStyle: TextStyle.overrideWith(a.textStyle, b.textStyle)
+    textStyle: TextStyle.overrideWith(a.textStyle, b.textStyle),
   });
 }

package/src/abstract-document/styles/position.ts

@@ -0,0 +1,8 @@
+import * as SectionElement from "../section-elements/section-element";
+
+export type Position = "absolute" | "relative";
+
+export function isPositionAbsolute(element: SectionElement.SectionElement): boolean {
+  const elementStyle = SectionElement.getSectionStyle(element);
+  return elementStyle?.position === "absolute";
+}

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

@@ -1,16 +1,19 @@
 import * as LayoutFoundation from "../primitives/layout-foundation";
 import * as TableCellStyle from "./table-cell-style";
+import * as Position from "./position";
 
 export type TableAlignment = "Left" | "Center" | "Right";
 
 export interface TableStyle {
   readonly type: "TableStyle";
   readonly margins: LayoutFoundation.LayoutFoundation;
+  readonly position: Position.Position;
   readonly alignment?: TableAlignment;
   readonly cellStyle: TableCellStyle.TableCellStyle;
 }
 
 export interface TableStyleProps {
+  readonly position?: Position.Position;
   readonly margins?: LayoutFoundation.LayoutFoundation;
   readonly alignment?: TableAlignment;
   readonly cellStyle?: TableCellStyle.TableCellStyle;
@@ -20,26 +23,24 @@ export function create(props?: TableStyleProps): TableStyle {
   const {
     margins = LayoutFoundation.create(),
     alignment = undefined,
-    cellStyle = TableCellStyle.create()
-  } =
-    props || {};
+    position = "relative",
+    cellStyle = TableCellStyle.create(),
+  } = props || {};
   return {
     type: "TableStyle",
+    position,
     margins,
     alignment,
-    cellStyle
+    cellStyle,
   };
 }
 
-export function overrideWith(
-  overrider: TableStyle,
-  toOverride: TableStyle
-): TableStyle {
+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)
+    cellStyle: TableCellStyle.overrideWith(a.cellStyle, b.cellStyle),
   });
 }

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

@@ -0,0 +1,77 @@
+import React from "react";
+import * as AD from "../../../../index";
+import { ExportTestDef } from "../export-test-def";
+import { Paragraph, AbstractDoc, Section, TextRun, Group } from "../../../../abstract-document-jsx";
+
+export const test: 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: {
+    formImage: {
+      Transcoder: "pdf2json@1.2.3 [https://github.com/modesty/pdf2json]",
+      Agency: "",
+      Id: { AgencyId: "", Name: "", MC: false, Max: 1, Parent: "" },
+      Pages: [
+        {
+          Height: 52.625,
+          HLines: [],
+          VLines: [],
+          Fills: [{ x: 0, y: 0, w: 0, h: 0, clr: 1 }],
+          Texts: [
+            {
+              x: 12.25,
+              y: 5.949,
+              w: 187.31,
+              sw: 0.32553125,
+              clr: 0,
+              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,
+              clr: 0,
+              A: "left",
+              R: [
+                {
+                  T: "I%20am%20too%2C%20because%20I%20belong%20in%20the%20same%20group.",
+                  S: -1,
+                  TS: [0, 13, 0, 0],
+                },
+              ],
+            },
+          ],
+          Fields: [],
+          Boxsets: [],
+        },
+      ],
+      Width: 37.188,
+    },
+  },
+};

package/src/abstract-document-exporters/__tests__/pdf/test-defs/absolute-position-header-and-footer.tsx

@@ -0,0 +1,197 @@
+import React from "react";
+import { ExportTestDef } from "../export-test-def";
+import * as AD from "../../../../index";
+import { Paragraph, AbstractDoc, Section, TextRun, TextField, Group, render } from "../../../../abstract-document-jsx";
+
+const header = [
+  render(
+    <Group>
+      <Paragraph>
+        <TextRun text="I am a header" />
+      </Paragraph>
+      <Paragraph
+        style={AD.AbstractDoc.ParagraphStyle.create({
+          position: "absolute",
+          margins: AD.AbstractDoc.LayoutFoundation.create({ right: 20 }),
+          alignment: "End",
+        })}
+      >
+        <TextField fieldType="PageNumber" />
+        <TextRun text="/" />
+        <TextField fieldType="TotalPages" />
+      </Paragraph>
+    </Group>
+  ),
+];
+
+const footer = [
+  render(
+    <Group>
+      <Paragraph>
+        <TextRun text="I am a footer" />
+      </Paragraph>
+      <Paragraph
+        style={AD.AbstractDoc.ParagraphStyle.create({
+          position: "absolute",
+          margins: AD.AbstractDoc.LayoutFoundation.create({ top: 20, left: 20 }),
+        })}
+      >
+        <TextRun text="I am a footer" />
+      </Paragraph>
+    </Group>
+  ),
+];
+
+const page = AD.AbstractDoc.MasterPage.create({ header: header, footer: footer });
+
+export const test: ExportTestDef = {
+  name: "Absolute position header and footer",
+  abstractDocJsx: (
+    <AbstractDoc>
+      <Section page={page}>
+        <Paragraph>
+          <TextRun text={"I am body"} />
+        </Paragraph>
+      </Section>
+    </AbstractDoc>
+  ),
+  expectedPdfJson: {
+    formImage: {
+      Transcoder: "pdf2json@1.2.3 [https://github.com/modesty/pdf2json]",
+      Agency: "",
+      Id: {
+        AgencyId: "",
+        Name: "",
+        MC: false,
+        Max: 1,
+        Parent: "",
+      },
+      Pages: [
+        {
+          Height: 52.625,
+          HLines: [],
+          VLines: [],
+          Fills: [
+            {
+              x: 0,
+              y: 0,
+              w: 0,
+              h: 0,
+              clr: 1,
+            },
+          ],
+          Texts: [
+            {
+              x: -0.25,
+              y: -0.301,
+              w: 61.7,
+              sw: 0.32553125,
+              clr: 0,
+              A: "left",
+              R: [
+                {
+                  T: "I%20am%20a%20header",
+                  S: -1,
+                  TS: [0, 13, 0, 0],
+                },
+              ],
+            },
+            {
+              x: 33.569,
+              y: -0.301,
+              w: 5.56,
+              sw: 0.32553125,
+              clr: 0,
+              A: "left",
+              R: [
+                {
+                  T: "1",
+                  S: -1,
+                  TS: [0, 13, 0, 0],
+                },
+              ],
+            },
+            {
+              x: 33.916,
+              y: -0.301,
+              w: 2.78,
+              sw: 0.32553125,
+              clr: 0,
+              A: "left",
+              R: [
+                {
+                  T: "%2F",
+                  S: -1,
+                  TS: [0, 13, 0, 0],
+                },
+              ],
+            },
+            {
+              x: 34.09,
+              y: -0.301,
+              w: 5.56,
+              sw: 0.32553125,
+              clr: 0,
+              A: "left",
+              R: [
+                {
+                  T: "1",
+                  S: -1,
+                  TS: [0, 13, 0, 0],
+                },
+              ],
+            },
+            {
+              x: -0.25,
+              y: 49.629,
+              w: 56.14,
+              sw: 0.32553125,
+              clr: 0,
+              A: "left",
+              R: [
+                {
+                  T: "I%20am%20a%20footer",
+                  S: -1,
+                  TS: [0, 13, 0, 0],
+                },
+              ],
+            },
+            {
+              x: 1,
+              y: 50.879,
+              w: 56.14,
+              sw: 0.32553125,
+              clr: 0,
+              A: "left",
+              R: [
+                {
+                  T: "I%20am%20a%20footer",
+                  S: -1,
+                  TS: [0, 13, 0, 0],
+                },
+              ],
+            },
+            {
+              x: -0.25,
+              y: 1.144,
+              w: 43.91,
+              sw: 0.32553125,
+              clr: 0,
+              A: "left",
+              R: [
+                {
+                  T: "I%20am%20body",
+                  S: -1,
+                  TS: [0, 13, 0, 0],
+                },
+              ],
+            },
+          ],
+          Fields: [],
+          Boxsets: [],
+        },
+      ],
+      Width: 37.188,
+    },
+  },
+};

package/src/abstract-document-exporters/__tests__/pdf/test-defs/absolute-position-paragraph.tsx

@@ -0,0 +1,51 @@
+import React from "react";
+import * as AD from "../../../../index";
+import { ExportTestDef } from "../export-test-def";
+import { Paragraph, AbstractDoc, Section, TextRun } from "../../../../abstract-document-jsx";
+
+export const test: ExportTestDef = {
+  name: "Absolute position paragraph",
+  abstractDocJsx: (
+    <AbstractDoc>
+      <Section>
+        <Paragraph
+          style={AD.AbstractDoc.ParagraphStyle.create({
+            position: "absolute",
+            margins: AD.AbstractDoc.LayoutFoundation.create({ top: 100, left: 200 }),
+          })}
+        >
+          <TextRun text={"Hello! I am absolutely absolute positioned."} />
+        </Paragraph>
+      </Section>
+    </AbstractDoc>
+  ),
+  expectedPdfJson: {
+    formImage: {
+      Transcoder: "pdf2json@1.2.3 [https://github.com/modesty/pdf2json]",
+      Agency: "",
+      Id: { AgencyId: "", Name: "", MC: false, Max: 1, Parent: "" },
+      Pages: [
+        {
+          Height: 52.625,
+          HLines: [],
+          VLines: [],
+          Fills: [{ x: 0, y: 0, w: 0, h: 0, clr: 1 }],
+          Texts: [
+            {
+              x: 12.25,
+              y: 5.949,
+              w: 187.31,
+              sw: 0.32553125,
+              clr: 0,
+              A: "left",
+              R: [{ T: "Hello!%20I%20am%20absolutely%20absolute%20positioned.", S: -1, TS: [0, 13, 0, 0] }],
+            },
+          ],
+          Fields: [],
+          Boxsets: [],
+        },
+      ],
+      Width: 37.188,
+    },
+  },
+};