@harbortouch/skytab-analytics-report-utils 0.38.1 → 0.40.0

package/dist/exporters/pdf/index.js

@@ -1,5 +1,7 @@
 // src/exporters/pdf/index.ts
 import PDFDocument from "pdfkit";
+import { join } from "path";
+import { fileURLToPath } from "url";
 
 // src/exporters/pdf/pdf.utils.ts
 var sanitizePdfText = (text) => {
@@ -10,38 +12,75 @@ var sanitizePdfText = (text) => {
   return leadingSpaces + text.trimStart().replace(/€/g, "EUR ").replace(
     /[\u{1F300}-\u{1F9FF}]|[\u{2600}-\u{26FF}]|[\u{2700}-\u{27BF}]|[\u{1F1E0}-\u{1F1FF}]|[\u{1F600}-\u{1F64F}]|[\u{1F680}-\u{1F6FF}]|[\u{1F900}-\u{1F9FF}]|[\u{1FA00}-\u{1FA6F}]|[\u{1FA70}-\u{1FAFF}]|[\u{FE00}-\u{FE0F}]|[\u{1F004}]|[\u{1F0CF}]|[\u{1F18E}]|[\u{1F191}-\u{1F19A}]|[\u{1F1E6}-\u{1F1FF}]|[\u{1F201}-\u{1F251}]/gu,
     ""
-  ).replace(/[\x00-\x1F\x7F]/g, " ").replace(/[^ -ÿ]/g, "").replace(/\s+/g, " ").trim();
+  ).replace(/[\x00-\x1F\x7F-\x9F]/g, " ").replace(/ /g, " ").replace(/[^\x20-\x7E\xA1-\xFF]/g, "").replace(/\s+/g, " ").trim();
 };
 
+// src/exporters/pdf/constants.ts
+var ZOOM_FACTOR = 1.44;
+var FONT_REGULAR = "Lato";
+var FONT_BOLD = "Lato-Bold";
+var DEFAULT_TEXT_COLOR = "#000000";
+var HEADER_BACKGROUND_COLOR = "#f9fafb";
+var ZEBRA_BACKGROUND_COLOR = "#fafbfc";
+var SEPARATOR_COLOR = "#E4E5E5";
+var SECTION_TITLE_FONT_SIZE = 1.17 * 6 * ZOOM_FACTOR;
+var DEFAULT_FONT_SIZE = 5 * ZOOM_FACTOR;
+var BODY_FONT_SIZE = 6 * ZOOM_FACTOR;
+var TABLE_CELL_PADDING = 4;
+var DEFAULT_ROW_HEIGHT = 25;
+var MIN_COLUMN_WIDTH = 35;
+var MARGINS = { top: 30, bottom: 30, left: 30, right: 30 };
+var PAGE_SIZE = "LETTER";
+var PAGE_LAYOUT = "landscape";
+var SECTION_GAP = 18;
+var MIN_SECTION_HEIGHT = 75;
+var HEADER_RULE_COLOR = "#000000";
+var HEADER_RULE_WIDTH = 1.5;
+var HEADER_SPACING_FACTOR = 0.7;
+
 // src/exporters/pdf/index.ts
-var FONT_BOLD = "Helvetica-Bold";
-var FONT_REGULAR = "Helvetica";
-var COLOR_BLACK = "#000000";
-var COLOR_HEADER_BACKGROUND = "#D3D3D3";
-var COLOR_ROW_BACKGROUND_ALTERNATE = "#F5F5F5";
+var FONTS_DIR = fileURLToPath(new URL("./fonts", import.meta.url));
 var PdfExporter = class {
+  registerFonts(doc) {
+    doc.registerFont(FONT_REGULAR, join(FONTS_DIR, "Lato-Regular.ttf"));
+    doc.registerFont(FONT_BOLD, join(FONTS_DIR, "Lato-Bold.ttf"));
+  }
   generate(content) {
-    const doc = new PDFDocument({ margin: 30, size: "A4", layout: "landscape" });
+    const doc = new PDFDocument({
+      margin: MARGINS.top,
+      size: PAGE_SIZE,
+      layout: PAGE_LAYOUT
+    });
+    this.registerFonts(doc);
     const buffers = [];
     return new Promise((resolve, reject) => {
       doc.on("data", (chunk) => buffers.push(chunk));
       doc.on("end", () => resolve(Buffer.concat(buffers)));
       doc.on("error", reject);
       try {
+        const pageBottom = doc.page.height - doc.page.margins.bottom;
+        let currentY = doc.page.margins.top;
         content.sections.forEach((section, index) => {
-          const sanitizedSections = this.sanitizeSections(section);
+          const sanitized = this.sanitizeSections(section);
           if (index > 0) {
-            doc.addPage();
+            if (currentY + SECTION_GAP + MIN_SECTION_HEIGHT > pageBottom) {
+              doc.addPage();
+              currentY = doc.page.margins.top;
+            } else {
+              currentY += SECTION_GAP;
+            }
+          }
+          if (sanitized.filters && sanitized.filters.length > 0) {
+            currentY = this.drawFilters(doc, sanitized.filters, currentY);
           }
-          let currentY = doc.y;
-          if (sanitizedSections.title) {
-            currentY = this.drawSectionTitle(doc, sanitizedSections.title);
+          if (sanitized.appliedFilters !== void 0) {
+            currentY = this.drawAppliedFilters(doc, sanitized.appliedFilters, currentY);
           }
-          if (sanitizedSections.filters && sanitizedSections.filters.length > 0) {
-            currentY = this.drawFilters(doc, sanitizedSections.filters);
+          if (sanitized.title && sanitized.table) {
+            currentY = this.drawSectionTitle(doc, sanitized.title, currentY);
           }
-          if (sanitizedSections.table) {
-            this.drawTable(doc, sanitizedSections.table, currentY);
+          if (sanitized.table) {
+            currentY = this.drawTable(doc, sanitized.table, currentY);
           }
         });
         doc.end();
@@ -50,21 +89,27 @@ var PdfExporter = class {
       }
     });
   }
-  sanitizeSections(sections) {
-    const sanitized = { title: sanitizePdfText(sections.title) };
-    if (sections.filters) {
-      sanitized.filters = sections.filters.map((filter) => ({
+  sanitizeSections(section) {
+    const sanitized = { title: sanitizePdfText(section.title) };
+    if (section.filters) {
+      sanitized.filters = section.filters.map((filter) => ({
+        label: sanitizePdfText(filter.label),
+        value: sanitizePdfText(filter.value)
+      }));
+    }
+    if (section.appliedFilters !== void 0) {
+      sanitized.appliedFilters = section.appliedFilters.map((filter) => ({
         label: sanitizePdfText(filter.label),
         value: sanitizePdfText(filter.value)
       }));
     }
-    if (sections.table) {
+    if (section.table) {
       sanitized.table = {
-        columns: sections.table.columns.map((col) => ({
+        columns: section.table.columns.map((col) => ({
           ...col,
           header: sanitizePdfText(col.header)
         })),
-        rows: sections.table.rows.map((row) => {
+        rows: section.table.rows.map((row) => {
           const sanitizedRow = {};
           for (const [key, value] of Object.entries(row)) {
             sanitizedRow[key] = typeof value === "string" ? sanitizePdfText(value) : value;
@@ -75,26 +120,45 @@ var PdfExporter = class {
     }
     return sanitized;
   }
-  drawSectionTitle(doc, title) {
-    doc.fillColor(COLOR_BLACK).font(FONT_BOLD).fontSize(13).text(title, { align: "left" });
-    doc.moveDown(0.5);
-    return doc.y;
+  drawSectionTitle(doc, title, startY) {
+    const left = doc.page.margins.left;
+    const usableWidth = doc.page.width - doc.page.margins.left - doc.page.margins.right;
+    doc.fillColor(DEFAULT_TEXT_COLOR).font(FONT_REGULAR).fontSize(SECTION_TITLE_FONT_SIZE).text(title, left, startY, { align: "left", width: usableWidth });
+    const spacing = SECTION_TITLE_FONT_SIZE * HEADER_SPACING_FACTOR;
+    const ruleY = doc.y + spacing;
+    doc.strokeColor(HEADER_RULE_COLOR).lineWidth(HEADER_RULE_WIDTH).moveTo(left, ruleY).lineTo(left + usableWidth, ruleY).stroke();
+    return ruleY + spacing;
   }
-  drawFilters(doc, filters) {
-    doc.fillColor(COLOR_BLACK).font(FONT_BOLD).fontSize(11).text("Applied Filters", { align: "left" });
-    doc.moveDown(0.5);
-    filters.forEach((filter) => {
-      doc.font(FONT_BOLD).fontSize(11).text(filter.label, { continued: true });
+  drawFilters(doc, filters, startY) {
+    const left = doc.page.margins.left;
+    doc.fillColor(DEFAULT_TEXT_COLOR).font(FONT_BOLD).fontSize(BODY_FONT_SIZE);
+    filters.forEach((filter, i) => {
+      if (i === 0) {
+        doc.text(filter.label, left, startY, { continued: true });
+      } else {
+        doc.font(FONT_BOLD).fontSize(BODY_FONT_SIZE).text(filter.label, { continued: true });
+      }
       doc.font(FONT_REGULAR).text(`: ${filter.value}`);
     });
+    doc.moveDown(0.5);
+    return doc.y;
+  }
+  drawAppliedFilters(doc, filters, startY) {
+    doc.fillColor(DEFAULT_TEXT_COLOR).font(FONT_BOLD).fontSize(BODY_FONT_SIZE).text("Applied Filters:", doc.page.margins.left, startY, { continued: filters.length === 0 });
+    if (filters.length === 0) {
+      doc.font(FONT_REGULAR).text(" None");
+    } else {
+      filters.forEach((filter) => {
+        doc.font(FONT_BOLD).fontSize(BODY_FONT_SIZE).text(filter.label, { continued: true });
+        doc.font(FONT_REGULAR).text(`: ${filter.value}`);
+      });
+    }
     doc.moveDown(1);
     return doc.y;
   }
-  drawTable(doc, table, startY = doc.y) {
+  drawTable(doc, table, startY) {
     const columns = table.columns.length > 0 ? table.columns.map((c) => ({ ...c })) : [{ header: "No data", key: "no_data", width: 100 }];
     const rows = table.rows ?? [];
-    const baseCellPadding = 4;
-    const minColumnWidth = 35;
     const columnCount = columns.length;
     const headerFontSize = columnCount > 13 ? 8 : columnCount > 10 ? 9 : columnCount > 7 ? 10 : 11;
     const dataFontSize = columnCount > 13 ? 7 : columnCount > 10 ? 8 : columnCount > 7 ? 9 : 10;
@@ -115,19 +179,26 @@ var PdfExporter = class {
         }
       });
       const contentWidth = Math.max(headerTextWidth, maxDataWidth);
-      col.width = Math.max(contentWidth + baseCellPadding * 2 + headerWidthSlack, minColumnWidth);
-      headerMinWidths.set(col, headerMinWidth + baseCellPadding * 2 + headerWidthSlack);
+      col.width = Math.max(contentWidth + TABLE_CELL_PADDING * 2 + headerWidthSlack, MIN_COLUMN_WIDTH);
+      headerMinWidths.set(col, headerMinWidth + TABLE_CELL_PADDING * 2 + headerWidthSlack);
     });
     const usableWidth = doc.page.width - doc.page.margins.left - doc.page.margins.right;
-    const totalColumnWidth = columns.reduce((sum, c) => sum + (c.width ?? minColumnWidth), 0);
+    const totalColumnWidth = columns.reduce((sum, c) => sum + (c.width ?? MIN_COLUMN_WIDTH), 0);
     if (totalColumnWidth > usableWidth) {
       const scale = usableWidth / totalColumnWidth;
       columns.forEach((c) => {
-        const headerMin = headerMinWidths.get(c) ?? minColumnWidth;
-        c.width = Math.max(Math.floor((c.width ?? minColumnWidth) * scale), headerMin, minColumnWidth);
+        const headerMin = headerMinWidths.get(c) ?? MIN_COLUMN_WIDTH;
+        c.width = Math.max(Math.floor((c.width ?? MIN_COLUMN_WIDTH) * scale), headerMin, MIN_COLUMN_WIDTH);
+      });
+    } else if (totalColumnWidth < usableWidth) {
+      const scale = usableWidth / totalColumnWidth;
+      columns.forEach((c) => {
+        c.width = Math.floor((c.width ?? MIN_COLUMN_WIDTH) * scale);
       });
+      const expanded = columns.reduce((sum, c) => sum + (c.width ?? 0), 0);
+      columns[columns.length - 1].width = (columns[columns.length - 1].width ?? 0) + (usableWidth - expanded);
     }
-    const tableWidth = columns.reduce((sum, c) => sum + (c.width ?? minColumnWidth), 0);
+    const tableWidth = columns.reduce((sum, c) => sum + (c.width ?? MIN_COLUMN_WIDTH), 0);
     const pageBottom = doc.page.height - doc.page.margins.bottom;
     const calculateRowHeight = (row, isHeader = false) => {
       const fontSize = isHeader ? headerFontSize : dataFontSize;
@@ -136,17 +207,22 @@ var PdfExporter = class {
       columns.forEach((col) => {
         const cellValue = isHeader ? col.header : row?.[col.key] !== void 0 ? String(row[col.key]) : "";
         const textWidth = doc.widthOfString(cellValue);
-        const availableWidth = (col.width ?? minColumnWidth) - baseCellPadding * 2;
+        const availableWidth = (col.width ?? MIN_COLUMN_WIDTH) - TABLE_CELL_PADDING * 2;
         const lines = Math.ceil(textWidth / availableWidth);
         if (lines > maxLines) {
           maxLines = lines;
         }
       });
-      return Math.max(maxLines * (fontSize + 2) + baseCellPadding * 2, 25);
+      return Math.max(maxLines * (fontSize + 2) + TABLE_CELL_PADDING * 2, DEFAULT_ROW_HEIGHT);
     };
     const headerHeight = calculateRowHeight(null, true);
-    const drawTableHeader = (y) => this.drawHeader(doc, columns, y, tableWidth, headerHeight, baseCellPadding, headerFontSize, minColumnWidth);
-    let currentY = drawTableHeader(startY);
+    const drawTableHeader = (y) => this.drawHeader(doc, columns, y, tableWidth, headerHeight, TABLE_CELL_PADDING, headerFontSize, MIN_COLUMN_WIDTH);
+    let tableStartY = startY;
+    if (tableStartY + headerHeight > pageBottom) {
+      doc.addPage();
+      tableStartY = doc.page.margins.top;
+    }
+    let currentY = drawTableHeader(tableStartY);
     doc.font(FONT_REGULAR).fontSize(dataFontSize);
     rows.forEach((row, rowIndex) => {
       const currentRowHeight = calculateRowHeight(row, false);
@@ -158,56 +234,68 @@ var PdfExporter = class {
       currentY = this.drawRow(
         doc,
         row,
-        rowIndex,
         columns,
         currentY,
-        tableWidth,
         currentRowHeight,
-        baseCellPadding,
+        TABLE_CELL_PADDING,
         dataFontSize,
-        minColumnWidth
+        MIN_COLUMN_WIDTH,
+        rowIndex
       );
     });
+    const left = doc.page.margins.left;
+    const closingRuleY = currentY + SECTION_TITLE_FONT_SIZE * HEADER_SPACING_FACTOR;
+    doc.strokeColor(HEADER_RULE_COLOR).lineWidth(HEADER_RULE_WIDTH).moveTo(left, closingRuleY).lineTo(left + tableWidth, closingRuleY).stroke();
+    return closingRuleY;
   }
   drawHeader(doc, columns, startY, tableWidth, headerHeight, cellPadding, headerFontSize, minColumnWidth) {
-    doc.strokeColor(COLOR_BLACK).lineWidth(0.5).moveTo(doc.page.margins.left, startY).lineTo(doc.page.margins.left + tableWidth, startY).stroke();
-    doc.fillColor(COLOR_HEADER_BACKGROUND).rect(doc.page.margins.left, startY, tableWidth, headerHeight).fill();
-    let xPosition = doc.page.margins.left;
-    doc.fillColor(COLOR_BLACK).font(FONT_BOLD).fontSize(headerFontSize);
+    const left = doc.page.margins.left;
+    doc.rect(left, startY, tableWidth, headerHeight).fill(HEADER_BACKGROUND_COLOR);
+    doc.strokeColor(SEPARATOR_COLOR).lineWidth(0.5).moveTo(left, startY).lineTo(left + tableWidth, startY).stroke();
+    let xPosition = left;
+    doc.fillColor(DEFAULT_TEXT_COLOR).font(FONT_BOLD).fontSize(headerFontSize);
+    const headerLineHeight = doc.currentLineHeight(true);
+    const headerTextY = startY + Math.max((headerHeight - headerLineHeight) / 2, 0);
     columns.forEach((col) => {
-      doc.strokeColor(COLOR_BLACK).lineWidth(0.5).moveTo(xPosition, startY).lineTo(xPosition, startY + headerHeight).stroke();
-      doc.text(col.header, xPosition + cellPadding, startY + cellPadding, {
+      doc.text(col.header, xPosition + cellPadding, headerTextY, {
         width: (col.width ?? minColumnWidth) - cellPadding * 2,
+        height: headerLineHeight,
         align: "left",
-        lineBreak: false
+        lineBreak: false,
+        ellipsis: true
       });
       xPosition += col.width ?? minColumnWidth;
     });
-    doc.moveTo(xPosition, startY).lineTo(xPosition, startY + headerHeight).stroke();
-    doc.moveTo(doc.page.margins.left, startY + headerHeight).lineTo(xPosition, startY + headerHeight).stroke();
+    doc.strokeColor(SEPARATOR_COLOR).lineWidth(0.5).moveTo(left, startY + headerHeight).lineTo(left + tableWidth, startY + headerHeight).stroke();
     return startY + headerHeight;
   }
-  drawRow(doc, row, rowIndex, columns, currentY, tableWidth, rowHeight, cellPadding, dataFontSize, minColumnWidth) {
-    doc.font(FONT_REGULAR).fontSize(dataFontSize);
-    if (rowIndex % 2 === 0) {
-      doc.fillColor(COLOR_ROW_BACKGROUND_ALTERNATE).rect(doc.page.margins.left, currentY, tableWidth, rowHeight).fill();
+  drawRow(doc, row, columns, currentY, rowHeight, cellPadding, dataFontSize, minColumnWidth, rowIndex = 0) {
+    const left = doc.page.margins.left;
+    const tableWidth = columns.reduce((sum, c) => sum + (c.width ?? minColumnWidth), 0);
+    if (rowIndex % 2 === 1) {
+      doc.rect(left, currentY, tableWidth, rowHeight).fill(ZEBRA_BACKGROUND_COLOR);
     }
-    let xPosition = doc.page.margins.left;
-    doc.fillColor(COLOR_BLACK);
-    columns.forEach((col) => {
-      doc.strokeColor(COLOR_BLACK).lineWidth(0.5).moveTo(xPosition, currentY).lineTo(xPosition, currentY + rowHeight).stroke();
+    doc.font(FONT_REGULAR).fontSize(dataFontSize).fillColor(DEFAULT_TEXT_COLOR);
+    const dataLineHeight = doc.currentLineHeight(true);
+    const dataTextY = currentY + Math.max((rowHeight - dataLineHeight) / 2, 0);
+    let xPosition = left;
+    columns.forEach((col, i) => {
       const rawValue = row[col.key];
       const cellValue = typeof rawValue === "string" || typeof rawValue === "number" || typeof rawValue === "boolean" ? String(rawValue) : "";
       const isNumeric = typeof rawValue === "number" || typeof rawValue === "string" && rawValue !== "" && !isNaN(Number(rawValue));
-      doc.text(cellValue, xPosition + cellPadding, currentY + cellPadding, {
+      doc.text(cellValue, xPosition + cellPadding, dataTextY, {
         width: (col.width ?? minColumnWidth) - cellPadding * 2,
+        height: dataLineHeight,
         align: isNumeric ? "right" : "left",
-        lineBreak: false
+        lineBreak: false,
+        ellipsis: true
       });
       xPosition += col.width ?? minColumnWidth;
+      if (i < columns.length - 1) {
+        doc.strokeColor(SEPARATOR_COLOR).lineWidth(0.5).moveTo(xPosition, currentY).lineTo(xPosition, currentY + rowHeight).stroke();
+      }
     });
-    doc.moveTo(xPosition, currentY).lineTo(xPosition, currentY + rowHeight).stroke();
-    doc.moveTo(doc.page.margins.left, currentY + rowHeight).lineTo(xPosition, currentY + rowHeight).stroke();
+    doc.strokeColor(SEPARATOR_COLOR).lineWidth(0.5).moveTo(left, currentY + rowHeight).lineTo(left + tableWidth, currentY + rowHeight).stroke();
     return currentY + rowHeight;
   }
 };