@cj-tech-master/excelts 9.0.0 → 9.1.0

package/dist/esm/modules/pdf/render/pdf-exporter.js

@@ -8,12 +8,13 @@
  * It is used internally by the public `pdf()` and `excelToPdf()` APIs.
  */
 import { PdfWriter } from "../core/pdf-writer.js";
+import { PdfContentStream } from "../core/pdf-stream.js";
 import { PdfDict, pdfRef, pdfNumber, pdfString as pdfStr } from "../core/pdf-object.js";
 import { FontManager, resolvePdfFontName } from "../font/font-manager.js";
 import { parseTtf } from "../font/ttf-parser.js";
 import { initEncryption } from "../core/encryption.js";
 import { layoutSheet } from "./layout-engine.js";
-import { renderPage, alphaGsName } from "./page-renderer.js";
+import { renderPage, alphaGsName, renderWatermark, parseImageDimensions } from "./page-renderer.js";
 import { decodePng } from "./png-decoder.js";
 import { PdfError, PdfRenderError } from "../errors.js";
 import { PageSizes } from "../types.js";
@@ -83,8 +84,21 @@ async function finishExport(ctx, workbook, options) {
     ensureAtLeastOnePage(allPages, documentOptions, sheets);
     fixPageNumbers(allPages);
     trackFontsForHeaders(allPages, fontManager);
+    // Track watermark fonts
+    const watermark = documentOptions.watermark;
+    if (watermark && watermark.type === "text") {
+        const wmFontFamily = watermark.fontFamily ?? "Helvetica";
+        const wmBold = watermark.bold ?? false;
+        const wmItalic = watermark.italic ?? false;
+        if (fontManager.hasEmbeddedFont()) {
+            fontManager.trackText(watermark.text);
+        }
+        else {
+            fontManager.ensureFont(resolvePdfFontName(wmFontFamily, wmBold, wmItalic));
+        }
+    }
     const fontObjectMap = fontManager.writeFontResources(writer);
-    const { pageObjNums, sheetFirstPage, pagesTreeObjNum } = await renderAllPages(allPages, fontManager, writer, fontObjectMap);
+    const { pageObjNums, sheetFirstPage, pagesTreeObjNum } = await renderAllPages(allPages, fontManager, writer, fontObjectMap, watermark);
     return buildFinalPdf(writer, pageObjNums, pagesTreeObjNum, sheetFirstPage, documentOptions, workbook, options);
 }
 function ensureAtLeastOnePage(allPages, documentOptions, sheets) {
@@ -133,20 +147,20 @@ function trackFontsForHeaders(allPages, fontManager) {
         }
     }
 }
-async function renderAllPages(allPages, fontManager, writer, fontObjectMap) {
+async function renderAllPages(allPages, fontManager, writer, fontObjectMap, watermark) {
     const pageObjNums = [];
     const pagesTreeObjNum = writer.allocObject();
     const sheetFirstPage = new Map();
     const totalPages = allPages.length;
     for (let i = 0; i < allPages.length; i++) {
-        renderSinglePage(allPages[i], fontManager, writer, fontObjectMap, totalPages, pageObjNums, pagesTreeObjNum, sheetFirstPage);
+        renderSinglePage(allPages[i], fontManager, writer, fontObjectMap, totalPages, pageObjNums, pagesTreeObjNum, sheetFirstPage, watermark);
         if (i < allPages.length - 1) {
             await yieldToEventLoop();
         }
     }
     return { pageObjNums, sheetFirstPage, pagesTreeObjNum };
 }
-function renderSinglePage(page, fontManager, writer, fontObjectMap, totalPages, pageObjNums, pagesTreeObjNum, sheetFirstPage) {
+function renderSinglePage(page, fontManager, writer, fontObjectMap, totalPages, pageObjNums, pagesTreeObjNum, sheetFirstPage, watermark) {
     try {
         const { stream: contentStream, alphaValues } = renderPage(page, page.options, fontManager, totalPages);
         // Handle images: create XObject Image entries and draw them
@@ -160,10 +174,46 @@ function renderSinglePage(page, fontManager, writer, fontObjectMap, totalPages,
                 contentStream.drawImage(imgName, img.rect.x, img.rect.y, img.rect.width, img.rect.height);
             }
         }
-        // Add content stream object
+        // --- Render watermark into a separate content stream ---
+        // PDF supports Contents as an array of stream references. The watermark stream
+        // is placed BEFORE the main content stream so it renders behind everything.
+        let watermarkContentObjNum;
+        const shouldApplyWatermark = watermark && isWatermarkApplicable(watermark, page);
+        if (shouldApplyWatermark) {
+            const wmContentStream = new PdfContentStream();
+            const wmResult = renderWatermark(wmContentStream, page, watermark, fontManager);
+            // Register watermark alpha values in the shared set
+            for (const alpha of wmResult.alphaValues) {
+                alphaValues.add(alpha);
+            }
+            // Register watermark image XObjects
+            for (const wmImg of wmResult.imageXObjects) {
+                const imgObjNum = writeImageXObject(writer, wmImg.data, wmImg.format);
+                imageXObjects.set(wmImg.name, imgObjNum);
+            }
+            // Write watermark content stream object
+            watermarkContentObjNum = writer.allocObject();
+            writer.addStreamObject(watermarkContentObjNum, new PdfDict(), wmContentStream);
+        }
+        // Add main content stream object
         const contentObjNum = writer.allocObject();
-        const contentDict = new PdfDict();
-        writer.addStreamObject(contentObjNum, contentDict, contentStream);
+        writer.addStreamObject(contentObjNum, new PdfDict(), contentStream);
+        // Build Contents reference — array if watermark exists, single ref otherwise.
+        // placement "under" (default): watermark stream first, then content
+        // placement "over": content first, then watermark stream on top
+        let contentsRef;
+        if (watermarkContentObjNum) {
+            const placement = watermark?.placement ?? "under";
+            if (placement === "over") {
+                contentsRef = `[${pdfRef(contentObjNum)} ${pdfRef(watermarkContentObjNum)}]`;
+            }
+            else {
+                contentsRef = `[${pdfRef(watermarkContentObjNum)} ${pdfRef(contentObjNum)}]`;
+            }
+        }
+        else {
+            contentsRef = pdfRef(contentObjNum);
+        }
         // Add resources dictionary object
         const resourcesObjNum = writer.allocObject();
         const fontDictStr = fontManager.buildFontDictString(fontObjectMap);
@@ -212,7 +262,7 @@ function renderSinglePage(page, fontManager, writer, fontObjectMap, totalPages,
             parentRef: pagesTreeObjNum,
             width: page.width,
             height: page.height,
-            contentsRef: contentObjNum,
+            contentsRef: contentsRef,
             resourcesRef: resourcesObjNum,
             annotRefs: annotRefs.length > 0 ? annotRefs : undefined
         });
@@ -337,7 +387,8 @@ function resolveOptions(options, sheet) {
         title: options?.title ?? "",
         author: options?.author ?? "",
         subject: options?.subject ?? "",
-        creator: options?.creator ?? "excelts"
+        creator: options?.creator ?? "excelts",
+        watermark: options?.watermark
     };
 }
 /** Map PaperSize enum values to PDF page sizes. */
@@ -428,6 +479,28 @@ function buildOutlines(writer, sheetFirstPage, pageObjNums) {
     return outlinesObjNum;
 }
 // =============================================================================
+// Watermark Filtering
+// =============================================================================
+/**
+ * Check if a watermark should be applied to a specific page based on
+ * optional page number and sheet name filters.
+ */
+function isWatermarkApplicable(watermark, page) {
+    if (watermark.pages && watermark.pages.length > 0) {
+        if (!watermark.pages.includes(page.pageNumber)) {
+            return false;
+        }
+    }
+    if (watermark.sheets && watermark.sheets.length > 0) {
+        // Case-insensitive sheet name matching, consistent with the rest of the API
+        const sheetLower = page.sheetName.toLowerCase();
+        if (!watermark.sheets.some(s => s.toLowerCase() === sheetLower)) {
+            return false;
+        }
+    }
+    return true;
+}
+// =============================================================================
 // Image XObject
 // =============================================================================
 /**
@@ -444,7 +517,7 @@ function writeImageXObject(writer, data, format) {
  */
 function writeJpegImageXObject(writer, data) {
     const objNum = writer.allocObject();
-    const dims = getJpegDimensions(data);
+    const dims = parseImageDimensions(data, "jpeg");
     const dict = new PdfDict()
         .set("Type", "/XObject")
         .set("Subtype", "/Image")
@@ -486,39 +559,3 @@ function writePngImageXObject(writer, data) {
     writer.addStreamObject(objNum, dict, png.pixels);
     return objNum;
 }
-/**
- * Extract width and height from a JPEG file header.
- * Scans for SOF markers (SOF0-SOF3, SOF5-SOF7, SOF9-SOF11, SOF13-SOF15)
- * which all share the same frame header layout.
- * Handles 0xFF padding bytes per JPEG spec.
- */
-function getJpegDimensions(data) {
-    let offset = 2; // skip SOI marker (0xFFD8)
-    while (offset < data.length - 1) {
-        // Skip any 0xFF fill bytes
-        while (offset < data.length && data[offset] === 0xff && data[offset + 1] === 0xff) {
-            offset++;
-        }
-        if (offset >= data.length - 1 || data[offset] !== 0xff) {
-            break;
-        }
-        const marker = data[offset + 1];
-        // SOF markers: C0-C3, C5-C7, C9-CB, CD-CF (excluding C4=DHT, C8=JPG, CC=DAC)
-        const isSof = marker >= 0xc0 && marker <= 0xcf && marker !== 0xc4 && marker !== 0xc8 && marker !== 0xcc;
-        if (isSof) {
-            if (offset + 8 < data.length) {
-                const height = (data[offset + 5] << 8) | data[offset + 6];
-                const width = (data[offset + 7] << 8) | data[offset + 8];
-                return { width, height };
-            }
-            break;
-        }
-        // Skip segment: 2 byte marker + segment length (includes the 2 length bytes)
-        if (offset + 3 >= data.length) {
-            break;
-        }
-        const segLen = (data[offset + 2] << 8) | data[offset + 3];
-        offset += 2 + segLen;
-    }
-    return { width: 1, height: 1 };
-}