abstract-document 16.0.33 → 16.0.34

package/src/abstract-document-exporters/pdf/measure.ts

@@ -1,6 +1,6 @@
 import * as AD from "../../abstract-document/index.js";
 import { exhaustiveCheck } from "ts-exhaustive-check";
-import { Page } from "./paginate.js";
+import { getHeaderAndFooter, Page } from "./paginate.js";
 import { registerFonts, getFontNameStyle } from "./font.js";
 
 //tslint:disable:no-any variable-name
@@ -29,7 +29,7 @@ function measureSection(
   section: AD.Section.Section,
   separateHeader?: ReadonlyArray<AD.SectionElement.SectionElement>,
   separateFooter?: ReadonlyArray<AD.SectionElement.SectionElement>,
-  separateChildren?: ReadonlyArray<AD.SectionElement.SectionElement>
+  separateChildren?: ReadonlyArray<AD.SectionElement.SectionElement>,
 ): Map<any, AD.Size.Size> {
   const header = separateHeader || section.page.header;
   const footer = separateFooter || section.page.footer;
@@ -54,7 +54,19 @@ function measureSection(
   const footerAvailableSize = AD.Size.create(footerAvailableWidth, pageHeight);
   const footerSizes = footer.map((e) => measureSectionElement(pdfKit, resources, footerAvailableSize, e));
 
-  return mergeMaps([...sectionSizes, ...headerSizes, ...footerSizes]);
+  // header and footer sizes for the first page
+  const firstPageHeaderAndFooters = getHeaderAndFooter(section, 1);
+  const firstPageHeaderAndFootersExtracted: ReadonlyArray<[ReadonlyArray<AD.SectionElement.SectionElement>, AD.LayoutFoundation.LayoutFoundation]> = [
+    [firstPageHeaderAndFooters.header, firstPageHeaderAndFooters.headerMargins],
+    [firstPageHeaderAndFooters.footer, firstPageHeaderAndFooters.footerMargins]
+  ];
+  const firstPageHeaderAndFooterSizes = firstPageHeaderAndFootersExtracted.reduce((prev, [sections, margins]) => {
+    const availabelWidth = pageWidth - (margins.left + margins.right);
+    const availableSizes = AD.Size.create(availabelWidth, pageHeight);
+    return [...prev, ...sections.map((e) => measureSectionElement(pdfKit, resources, availableSizes, e))];
+  }, []);
+  
+  return mergeMaps([...sectionSizes, ...headerSizes, ...footerSizes, ...firstPageHeaderAndFooterSizes]);
 }
 
 function measureSectionElement(

package/src/abstract-document-exporters/pdf/paginate.ts

@@ -42,13 +42,13 @@ function splitSection(
 ): Array<Page> {
   const resources = AD.Resources.mergeResources([parentResources, section]);
   const pages = new Array<Page>();
-  const contentRect = getPageContentRect(desiredSizes, section);
 
   let children = section.children;
   let elements = new Array<AD.SectionElement.SectionElement>();
   let elementsHeight = 0;
   let currentPage = previousPage;
   for (let i = 0; i < children.length; ++i) {
+    const contentRect = getPageContentRect(desiredSizes, section, pages.length + 1);
     const element = children[i];
     if (element.type === "PageBreak") {
       currentPage = createPage(resources, desiredSizes, currentPage, section, elements, pages.length === 0);
@@ -218,7 +218,7 @@ function createPage(
   const namedDestionations = [...sectionName, ...targetNames];
 
   // Ignore leading space by expanding the content rect upwards
-  const rect = getPageContentRect(desiredSizes, section);
+  const rect = getPageContentRect(desiredSizes, section, pageNo);
   const [leadingSpace] = getLeadingAndTrailingSpace(resources, section, elements);
   const contentRect = AD.Rect.create(rect.x, rect.y - leadingSpace, rect.width, rect.height + leadingSpace);
 
@@ -236,32 +236,67 @@ function createPage(
   };
 }
 
-function getPageContentRect(desiredSizes: Map<{}, AD.Size.Size>, section: AD.Section.Section): AD.Rect.Rect {
+export function getHeaderAndFooter(section: AD.Section.Section, pageNo: number): {
+  readonly header: Array<AD.SectionElement.SectionElement>;
+  readonly footer: Array<AD.SectionElement.SectionElement>;
+  readonly headerMargins: AD.LayoutFoundation.LayoutFoundation;
+  readonly footerMargins: AD.LayoutFoundation.LayoutFoundation;
+} {
+  const FIRST_PAGE = 1;
+  const EVEN_PAGE = 0;
+  const ODD_PAGE = 1;
+  switch(true) {
+    //first page
+    case pageNo === FIRST_PAGE: {
+      const normalHeader = section.page.frontHeader === undefined || section.page.frontHeader.length === 0;
+      const normalFooter = section.page.frontFooter === undefined || section.page.frontFooter.length === 0;
+      return {
+        footer: normalFooter ? section.page.footer : section.page.frontFooter,
+        header: normalHeader ? section.page.header : section.page.frontHeader,
+        headerMargins: normalHeader ? section.page.style.headerMargins : (section.page.style.firstPageHeaderMargins ?? section.page.style.headerMargins),
+        footerMargins: normalFooter ? section.page.style.footerMargins : (section.page.style.firstPageFooterMargins ?? section.page.style.footerMargins),
+      };
+    }
+    case pageNo === 0:
+    case pageNo % 2 === EVEN_PAGE:
+    case pageNo % 2 === ODD_PAGE:
+    default: {
+      return {
+        header: section.page.header,
+        footer: section.page.footer,
+        headerMargins: section.page.style.headerMargins,
+        footerMargins: section.page.style.footerMargins,
+      }
+    }
+  }
+}
+
+function getPageContentRect(desiredSizes: Map<{}, AD.Size.Size>, section: AD.Section.Section, pageNo: number): AD.Rect.Rect {
   const style = section.page.style;
   const pageWidth = AD.PageStyle.getWidth(style);
   const pageHeight = AD.PageStyle.getHeight(style);
 
-  const headerHeight = section.page.header.reduce(
-    (a, b) => a + getDesiredSize(b, desiredSizes).height,
-    style.headerMargins.top + style.headerMargins.bottom
+  const { header, footer, headerMargins, footerMargins } = getHeaderAndFooter(section, pageNo);
+  const headerHeight = header.reduce(
+    (prev, curr) => prev + getDesiredSize(curr, desiredSizes).height,
+    headerMargins.top + headerMargins.bottom
   );
-  const footerHeight = section.page.footer.reduce(
-    (a, b) => a + getDesiredSize(b, desiredSizes).height,
-    style.footerMargins.top + style.footerMargins.bottom
+  const footerHeight = footer.reduce(
+    (prev, curr) => prev + getDesiredSize(curr, desiredSizes).height,
+    footerMargins.top + footerMargins.bottom
   );
 
-  let headerY = style.headerMargins.top;
-  for (let element of section.page.header) {
+  let headerY = headerMargins.top;
+  for (let element of header) {
     const elementSize = getDesiredSize(element, desiredSizes);
     headerY += elementSize.height;
   }
-  headerY += style.headerMargins.bottom;
+  headerY += headerMargins.bottom;
 
   const rectX = style.contentMargins.left;
   const rectY = headerY + style.contentMargins.top;
   const rectWidth = pageWidth - (style.contentMargins.left + style.contentMargins.right);
   const rectHeight = pageHeight - headerHeight - footerHeight - style.contentMargins.top - style.contentMargins.bottom;
-
   return AD.Rect.create(rectX, rectY, rectWidth, rectHeight);
 }
 

package/src/abstract-document-exporters/pdf/render.ts

@@ -1,7 +1,7 @@
 import * as AD from "../../abstract-document/index.js";
 import { preProcess } from "./pre-process.js";
 import { measure, measurePages } from "./measure.js";
-import { paginate, Page } from "./paginate.js";
+import { paginate, Page, getHeaderAndFooter } from "./paginate.js";
 import { updatePageRefs } from "./update-refs.js";
 import { renderImage } from "./render-image.js";
 import { registerFonts, getFontNameStyle } from "./font.js";
@@ -80,8 +80,9 @@ function renderPage(
     }
   });
 
-  const headerX = style.headerMargins.left;
-  const headerStart = style.headerMargins.top;
+  const { headerMargins, footerMargins } = getHeaderAndFooter(section, page.pageNo);
+  const headerX = headerMargins.left;
+  const headerStart = headerMargins.top;
   let headerY = headerStart;
   for (let element of page.header) {
     const elementSize = getDesiredSize(element, desiredSizes);
@@ -97,14 +98,14 @@ function renderPage(
       headerY += elementSize.height;
     }
   }
-  headerY += style.headerMargins.bottom;
+  headerY += headerMargins.bottom;
 
   const footerHeight = page.footer.reduce(
     (a, b) => a + (AD.Position.isPositionAbsolute(b) ? 0 : getDesiredSize(b, desiredSizes).height),
-    style.footerMargins.top + style.footerMargins.bottom
+    footerMargins.top + footerMargins.bottom
   );
-  const footerX = style.footerMargins.left;
-  const footerStart = pageHeight - (footerHeight - style.footerMargins.top);
+  const footerX = footerMargins.left;
+  const footerStart = pageHeight - (footerHeight - footerMargins.top);
   let footerY = footerStart;
   for (let element of page.footer) {
     const elementSize = getDesiredSize(element, desiredSizes);

package/src/abstract-document-xml/abstract-doc-of-xml/abstract-doc-of-xml.ts

@@ -36,9 +36,16 @@ function abstractDocXmlRecursive(
       } else {
         // For lowercase elements we add them as keys using their name
         // Some special keys should directly have an array of children as value instead of an object with children key
-        const arrayedElements = ["frontHeader", "frontFooter", "header", "footer", "headerRows"];
+        const arrayedElements = ["header", "footer", "headerRows"];
         const childrenOnly = arrayedElements.findIndex((e) => e === childName) !== -1;
-        props[childName] = abstractDocXmlRecursive(creators, childElement, childrenOnly);
+        const differentFirstPage = childElement.attributes.differentFirstPage;
+        if(differentFirstPage === "true" && childName === "header") {
+          props.frontHeader = abstractDocXmlRecursive(creators, childElement, childrenOnly);
+        } else if (differentFirstPage === "true" && childName === "footer") {
+          props.frontFooter = abstractDocXmlRecursive(creators, childElement, childrenOnly);
+        } else {
+          props[childName] = abstractDocXmlRecursive(creators, childElement, childrenOnly);
+        }
       }
     }
   }

package/src/abstract-document-xml/xsd-template/elements.ts

@@ -1,10 +1,10 @@
 import * as Custom from "./custom-elements.js";
 
 export const abstractDoc = `<xs:element name="AbstractDoc">
-    <xs:complexType>
+  <xs:complexType>
 		<xs:sequence>
-				<xs:element name="StyleNames" type="StyleNames" minOccurs="0"></xs:element>
-				<xs:element name="Section" type="Section"></xs:element>
+			<xs:element name="StyleNames" type="StyleNames" minOccurs="0"></xs:element>
+			<xs:element name="Section" type="Section"></xs:element>
 		</xs:sequence>
 	</xs:complexType>
 </xs:element>`;
@@ -28,23 +28,30 @@ export const page = `<xs:complexType name="page">
 	</xs:annotation>
 	<xs:all>
 		<xs:element name="style" type="MasterPageStyle" />
-		<xs:element name="header" type="SectionElement" minOccurs="0" />
-		<xs:element name="footer" type="SectionElement" minOccurs="0" />
-		<xs:element name="frontHeader" type="SectionElement" minOccurs="0" />
-		<xs:element name="frontFooter" type="SectionElement" minOccurs="0" />
+		<xs:element name="header" type="HeaderFooter" minOccurs="0" />
+		<xs:element name="footer" type="HeaderFooter" minOccurs="0" />
 	</xs:all>
 </xs:complexType>`;
 
+const sectionElementBody = `<xs:element name="Table" type="Table" minOccurs="0" />
+	<xs:element name="Group" type="Group" minOccurs="0" />
+	<xs:element name="PageBreak" type="PageBreak" minOccurs="0" />
+	<xs:element name="Paragraph" type="Paragraph" minOccurs="0" />
+	${Custom.textParagraphElement}
+	${Custom.imageParagraphElement}
+<xs:element name="Markdown" type="Markdown" minOccurs="0" />`;
+
 export const sectionElement = `<xs:complexType name="SectionElement">
 	<xs:choice maxOccurs="unbounded">
-		<xs:element name="Table" type="Table" minOccurs="0" />
-		<xs:element name="Group" type="Group" minOccurs="0" />
-		<xs:element name="PageBreak" type="PageBreak" minOccurs="0" />
-		<xs:element name="Paragraph" type="Paragraph" minOccurs="0" />
-		${Custom.textParagraphElement}
-		${Custom.imageParagraphElement}
-		<xs:element name="Markdown" type="Markdown" minOccurs="0" />
+		${sectionElementBody}
+	</xs:choice>
+</xs:complexType>`;
+
+export const headerFooter = `<xs:complexType name="HeaderFooter">
+  <xs:choice maxOccurs="unbounded">
+		${sectionElementBody}
 	</xs:choice>
+	<xs:attribute name="differentFirstPage" type="xs:boolean" use="optional"/>
 </xs:complexType>`;
 
 export const group = `<xs:complexType name="Group">

package/src/abstract-document-xml/xsd-template/styles.ts

@@ -244,6 +244,8 @@ export const masterPageStyle = `<xs:complexType name="MasterPageStyle">
 	<xs:all>
 		<xs:element name="headerMargins" type="LayoutFoundation" />
 		<xs:element name="footerMargins" type="LayoutFoundation" />
+		<xs:element name="firstPageHeaderMargins" type="LayoutFoundation" minOccurs="0" />
+		<xs:element name="firstPageFooterMargins" type="LayoutFoundation" minOccurs="0" />
 		<xs:element name="contentMargins" type="LayoutFoundation" />
 	</xs:all>
 	<xs:attribute name="paperSize" use="required">

package/src/abstract-document-xml/xsd-template/xsd-template.ts

@@ -6,6 +6,7 @@ import { parseXsd } from "handlebars-xml";
 const commonParts = `${Styles.layoutFoundation}
 ${Elements.section}
 ${Elements.sectionElement}
+${Elements.headerFooter}
 ${Elements.page}
 ${Elements.pageBreak}
 ${Elements.image}