[api-minor] Add a new getXfaPageViewport helper function to support printing

This patch provides an overall simpler *and* more consistent way of handling the `viewport` parameter during printing of XFA forms, since it's now again guaranteed to always be an instance of `PageViewport`.
Furthermore, for anyone attempting to e.g. implement custom printing of XFA forms this probably cannot hurt either.

src/display/api.js

@@ -743,8 +743,10 @@ class PDFDocumentProxy {
   }
 
   /**
+   * NOTE: This is (mostly) intended to support printing of XFA forms.
+   *
    * @type {Object | null} An object representing a HTML tree structure
-   * to render the XFA, or `null` when no XFA form exists.
+   *   to render the XFA, or `null` when no XFA form exists.
    */
   get allXfaHtml() {
     return this._transport._htmlForXfa;

src/display/display_utils.js

@@ -606,6 +606,20 @@ class PDFDateString {
   }
 }
 
+/**
+ * NOTE: This is (mostly) intended to support printing of XFA forms.
+ */
+function getXfaPageViewport(xfaPage, { scale = 1, rotation = 0 }) {
+  const { width, height } = xfaPage.attributes.style;
+  const viewBox = [0, 0, parseInt(width), parseInt(height)];
+
+  return new PageViewport({
+    viewBox,
+    scale,
+    rotation,
+  });
+}
+
 export {
   addLinkAttributes,
   DEFAULT_LINK_REL,
@@ -616,6 +630,7 @@ export {
   DOMSVGFactory,
   getFilenameFromUrl,
   getPdfFilenameFromUrl,
+  getXfaPageViewport,
   isDataScheme,
   isPdfFile,
   isValidFetchUrl,

src/display/xfa_layer.js

@@ -13,8 +13,6 @@
  * limitations under the License.
  */
 
-import { PageViewport } from "./display_utils.js";
-
 class XfaLayer {
   static setupStorage(html, fieldId, element, storage, intent) {
     const storedData = storage.getValue(fieldId, { value: null });
@@ -134,13 +132,8 @@ class XfaLayer {
 
     const rootDiv = parameters.div;
     rootDiv.appendChild(rootHtml);
-
+    const transform = `matrix(${parameters.viewport.transform.join(",")})`;
-    let { viewport } = parameters;
+    rootDiv.style.transform = transform;
-    if (!(viewport instanceof PageViewport)) {
-      viewport = new PageViewport(viewport);
-    }
-    const coeffs = viewport.transform.join(",");
-    rootDiv.style.transform = `matrix(${coeffs})`;
 
     // Set defaults.
     rootDiv.setAttribute("class", "xfaLayer xfaFont");

src/pdf.js

@@ -18,6 +18,7 @@ import {
   addLinkAttributes,
   getFilenameFromUrl,
   getPdfFilenameFromUrl,
+  getXfaPageViewport,
   isPdfFile,
   isValidFetchUrl,
   LinkTarget,
@@ -108,6 +109,7 @@ export {
   loadScript,
   PDFDateString,
   RenderingCancelledException,
+  getXfaPageViewport,
   // From "./display/api.js":
   build,
   getDocument,

web/print_utils.js

@@ -15,26 +15,26 @@
 
 import { CSS_UNITS } from "./ui_utils.js";
 import { DefaultXfaLayerFactory } from "./xfa_layer_builder.js";
+import { getXfaPageViewport } from "pdfjs-lib";
 
 function getXfaHtmlForPrinting(printContainer, pdfDocument) {
   const xfaHtml = pdfDocument.allXfaHtml;
   const factory = new DefaultXfaLayerFactory();
   const scale = Math.round(CSS_UNITS * 100) / 100;
+
   for (const xfaPage of xfaHtml.children) {
     const page = document.createElement("div");
     page.className = "xfaPrintedPage";
     printContainer.appendChild(page);
 
-    const { width, height } = xfaPage.attributes.style;
-    const viewBox = [0, 0, parseInt(width), parseInt(height)];
-    const viewport = { viewBox, scale, rotation: 0 };
-
     const builder = factory.createXfaLayerBuilder(
       /* pageDiv = */ page,
       /* pdfPage = */ null,
       /* annotationStorage = */ pdfDocument.annotationStorage,
       /* xfaHtml = */ xfaPage
     );
+    const viewport = getXfaPageViewport(xfaPage, { scale });
+
     builder.render(viewport, "print");
   }
 }

web/xfa_layer_builder.js

@@ -44,9 +44,8 @@ class XfaLayerBuilder {
    */
   render(viewport, intent = "display") {
     if (intent === "print") {
-      viewport.dontFlip = true;
       const parameters = {
-        viewport,
+        viewport: viewport.clone({ dontFlip: true }),
         div: this.div,
         xfa: this.xfaHtml,
         page: null,
@@ -76,6 +75,7 @@ class XfaLayerBuilder {
           xfa,
           page: this.pdfPage,
           annotationStorage: this.annotationStorage,
+          intent,
         };
 
         if (this.div) {