@openshift-migration-advisor/shared-components 0.25.0 → 0.27.0-5d0cc20d809e

package/dist/report/pdfExport.js

@@ -0,0 +1,131 @@
+import jsPDF from "jspdf";
+import { releaseCanvas, } from "./chartExport.js";
+import { fitPdfImageSize, placePdfBlock, sliceCanvas } from "./pdfPage.js";
+const MARGIN_MM = 10;
+const GAP_MM = 8;
+/** Flatten captures onto white; jsPDF cannot embed transparent PNG alpha cleanly. */
+const PAGE_BACKGROUND = "#ffffff";
+export async function buildPdfFromCharts(charts, documentTitle, extraPages = []) {
+    const pdf = new jsPDF("p", "mm", "a4");
+    const pageWidth = pdf.internal.pageSize.getWidth();
+    const pageHeight = pdf.internal.pageSize.getHeight();
+    const contentWidth = pageWidth - MARGIN_MM * 2;
+    const contentHeight = pageHeight - MARGIN_MM * 2;
+    const pageTop = MARGIN_MM;
+    const pageBottom = pageHeight - MARGIN_MM;
+    addCoverPage(pdf, documentTitle, [...charts.map((chart) => chart.title), ...extraPages.map((p) => p.title)], pageWidth, pageHeight);
+    let cursorY = null;
+    for (const chart of charts) {
+        const canvas = await chart.capture();
+        try {
+            if (canvas.width < 1 || canvas.height < 1) {
+                throw new Error("Chart capture produced an empty image");
+            }
+            const size = fitPdfImageSize(canvas.width, canvas.height, contentWidth, contentHeight);
+            const placement = placePdfBlock(cursorY, size.heightMm, pageTop, pageBottom);
+            if (placement.needsNewPage) {
+                pdf.addPage();
+            }
+            addChartImage(pdf, canvas, MARGIN_MM + (contentWidth - size.widthMm) / 2, placement.y, size.widthMm, size.heightMm);
+            cursorY = placement.y + size.heightMm + GAP_MM;
+        }
+        finally {
+            releaseCanvas(canvas);
+        }
+    }
+    if (extraPages.length > 0) {
+        addExtraPages(pdf, extraPages, pageWidth, pageHeight);
+    }
+    addPageNumbers(pdf, pageWidth, pageHeight);
+    return pdf.output("blob");
+}
+function addCoverPage(pdf, documentTitle, tocItems, pageWidth, pageHeight) {
+    const contentWidth = pageWidth - MARGIN_MM * 2;
+    pdf.setFontSize(18);
+    const titleLines = pdf.splitTextToSize(documentTitle, contentWidth);
+    let titleY = MARGIN_MM + 8;
+    for (const line of titleLines) {
+        pdf.text(line, pageWidth / 2, titleY, { align: "center" });
+        titleY += 8;
+    }
+    pdf.setFontSize(11);
+    const generatedAt = new Date();
+    pdf.text(`Generated: ${generatedAt.toLocaleDateString()} ${generatedAt.toLocaleTimeString()}`, pageWidth / 2, titleY + 4, { align: "center" });
+    pdf.setFontSize(14);
+    pdf.text("Table of contents", MARGIN_MM, titleY + 16);
+    pdf.setFontSize(11);
+    let tocY = titleY + 26;
+    for (const item of tocItems) {
+        if (tocY > pageHeight - MARGIN_MM - 10) {
+            pdf.addPage();
+            tocY = MARGIN_MM;
+        }
+        pdf.text(`- ${item}`, MARGIN_MM, tocY);
+        tocY += 7;
+    }
+}
+function addChartImage(pdf, canvas, x, y, widthMm, heightMm) {
+    const flattened = sliceCanvas(canvas, canvas.width, canvas.height, 0, PAGE_BACKGROUND);
+    try {
+        pdf.addImage(flattened.toDataURL("image/jpeg", 0.92), "JPEG", x, y, widthMm, heightMm);
+    }
+    finally {
+        releaseCanvas(flattened);
+    }
+}
+/**
+ * Append one native-text PDF page per entry in `extraPages`, rendered as
+ * label/value rows rather than a captured image. Each page starts fresh so
+ * its content never bleeds into a chart page.
+ */
+function addExtraPages(pdf, extraPages, pageWidth, pageHeight) {
+    const LABEL_COL_WIDTH = 68; // mm — enough for the longest label
+    const VALUE_COL_X = MARGIN_MM + LABEL_COL_WIDTH;
+    const VALUE_COL_WIDTH = pageWidth - MARGIN_MM - LABEL_COL_WIDTH;
+    const LINE_HEIGHT = 7; // mm between rows
+    for (const page of extraPages) {
+        pdf.addPage();
+        let y = MARGIN_MM + 8;
+        pdf.setFontSize(16);
+        pdf.setFont("helvetica", "bold");
+        pdf.text(page.title, MARGIN_MM, y);
+        y += 10;
+        pdf.setDrawColor(0, 103, 187);
+        pdf.setLineWidth(0.5);
+        pdf.line(MARGIN_MM, y, pageWidth - MARGIN_MM, y);
+        y += 10;
+        pdf.setFontSize(11);
+        for (const item of page.items) {
+            pdf.setFont("helvetica", "bold");
+            const labelLines = pdf.splitTextToSize(item.label, LABEL_COL_WIDTH - 4);
+            pdf.text(labelLines, MARGIN_MM, y);
+            pdf.setFont("helvetica", "normal");
+            const valueLines = pdf.splitTextToSize(item.value, VALUE_COL_WIDTH);
+            pdf.text(valueLines, VALUE_COL_X, y);
+            y += LINE_HEIGHT * Math.max(labelLines.length, valueLines.length);
+            if (y > pageHeight - MARGIN_MM - 25) {
+                pdf.addPage();
+                y = MARGIN_MM + 10;
+            }
+        }
+        if (page.footer) {
+            y += 4;
+            pdf.setFontSize(9);
+            pdf.setFont("helvetica", "bolditalic");
+            const footerLines = pdf.splitTextToSize(page.footer, pageWidth - MARGIN_MM * 2);
+            pdf.text(footerLines, MARGIN_MM, y);
+            pdf.setFont("helvetica", "normal");
+            pdf.setFontSize(11);
+        }
+    }
+}
+function addPageNumbers(pdf, pageWidth, pageHeight) {
+    const totalPages = pdf.getNumberOfPages();
+    pdf.setFontSize(9);
+    for (let page = 1; page <= totalPages; page++) {
+        pdf.setPage(page);
+        pdf.text(`Page ${page} of ${totalPages}`, pageWidth / 2, pageHeight - 6, {
+            align: "center",
+        });
+    }
+}

package/dist/report/pdfPage.d.ts

@@ -0,0 +1,15 @@
+export interface PdfExportSegment {
+    top: number;
+    height: number;
+}
+export declare function splitSegmentForPageHeight(segment: PdfExportSegment, imgHeight: number, pageHeightPx: number): PdfExportSegment[];
+export declare function fitPdfImageSize(pixelWidth: number, pixelHeight: number, maxWidthMm: number, maxHeightMm: number): {
+    widthMm: number;
+    heightMm: number;
+};
+export declare function placePdfBlock(cursorY: number | null, blockHeightMm: number, pageTopMm: number, pageBottomMm: number): {
+    y: number;
+    needsNewPage: boolean;
+};
+export declare function sliceCanvas(sourceCanvas: HTMLCanvasElement, width: number, height: number, offsetY: number, backgroundColor: string): HTMLCanvasElement;
+//# sourceMappingURL=pdfPage.d.ts.map

package/dist/report/pdfPage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pdfPage.d.ts","sourceRoot":"","sources":["../../src/report/pdfPage.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,yBAAyB,CACvC,OAAO,EAAE,gBAAgB,EACzB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,GACnB,gBAAgB,EAAE,CAcpB;AAED,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,GAClB;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAUvC;AAED,wBAAgB,aAAa,CAC3B,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,GACnB;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,OAAO,CAAA;CAAE,CAKtC;AAED,wBAAgB,WAAW,CACzB,YAAY,EAAE,iBAAiB,EAC/B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,eAAe,EAAE,MAAM,GACtB,iBAAiB,CAsBnB"}

package/dist/report/pdfPage.js

@@ -0,0 +1,44 @@
+export function splitSegmentForPageHeight(segment, imgHeight, pageHeightPx) {
+    const total = Math.max(1, Math.min(segment.height, imgHeight - segment.top));
+    if (pageHeightPx <= 0 || total <= pageHeightPx) {
+        return [{ top: segment.top, height: total }];
+    }
+    const slices = [];
+    let offset = 0;
+    while (offset < total) {
+        const height = Math.min(pageHeightPx, total - offset);
+        slices.push({ top: segment.top + offset, height });
+        offset += height;
+    }
+    return slices;
+}
+export function fitPdfImageSize(pixelWidth, pixelHeight, maxWidthMm, maxHeightMm) {
+    const safeWidth = Math.max(1, pixelWidth);
+    const safeHeight = Math.max(1, pixelHeight);
+    const widthScale = maxWidthMm / safeWidth;
+    const heightAtFullWidth = safeHeight * widthScale;
+    if (heightAtFullWidth <= maxHeightMm) {
+        return { widthMm: maxWidthMm, heightMm: heightAtFullWidth };
+    }
+    const scale = maxHeightMm / safeHeight;
+    return { widthMm: safeWidth * scale, heightMm: maxHeightMm };
+}
+export function placePdfBlock(cursorY, blockHeightMm, pageTopMm, pageBottomMm) {
+    if (cursorY === null || cursorY + blockHeightMm > pageBottomMm) {
+        return { y: pageTopMm, needsNewPage: true };
+    }
+    return { y: cursorY, needsNewPage: false };
+}
+export function sliceCanvas(sourceCanvas, width, height, offsetY, backgroundColor) {
+    const pageCanvas = document.createElement("canvas");
+    pageCanvas.width = width;
+    pageCanvas.height = height;
+    const context = pageCanvas.getContext("2d");
+    if (!context) {
+        throw new Error("Canvas 2D context unavailable");
+    }
+    context.fillStyle = backgroundColor;
+    context.fillRect(0, 0, width, height);
+    context.drawImage(sourceCanvas, 0, offsetY, width, height, 0, 0, width, height);
+    return pageCanvas;
+}

package/dist/report/reportExportOptions.d.ts

@@ -0,0 +1,17 @@
+export interface ReportExportOption {
+    key: string;
+    label: string;
+    description?: string;
+    onSelect: () => void;
+    isDisabled?: boolean;
+}
+export interface StandardReportExportHandlers {
+    onExportPdf?: () => void;
+    onExportPng?: () => void;
+    onExportHtml?: () => void;
+}
+/**
+ * Standard report-download actions. Omit a handler to hide that format.
+ */
+export declare const standardReportExportOptions: ({ onExportPdf, onExportPng, onExportHtml, }: StandardReportExportHandlers) => ReportExportOption[];
+//# sourceMappingURL=reportExportOptions.d.ts.map

package/dist/report/reportExportOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reportExportOptions.d.ts","sourceRoot":"","sources":["../../src/report/reportExportOptions.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,4BAA4B;IAC3C,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,eAAO,MAAM,2BAA2B,GAAI,6CAIzC,4BAA4B,KAAG,kBAAkB,EA+BnD,CAAC"}

package/dist/report/reportExportOptions.js

@@ -0,0 +1,31 @@
+/**
+ * Standard report-download actions. Omit a handler to hide that format.
+ */
+export const standardReportExportOptions = ({ onExportPdf, onExportPng, onExportHtml, }) => {
+    const options = [];
+    if (onExportPdf) {
+        options.push({
+            key: "pdf",
+            label: "PDF",
+            description: "Export the report as a PDF",
+            onSelect: onExportPdf,
+        });
+    }
+    if (onExportHtml) {
+        options.push({
+            key: "html",
+            label: "HTML",
+            description: "Export the report as HTML",
+            onSelect: onExportHtml,
+        });
+    }
+    if (onExportPng) {
+        options.push({
+            key: "png",
+            label: "PNG",
+            description: "Download all charts as PNG files",
+            onSelect: onExportPng,
+        });
+    }
+    return options;
+};

package/dist/report/zipChartPngs.d.ts

@@ -0,0 +1,3 @@
+import type { ChartExportFile } from "./chartExport.js";
+export declare function zipChartPngs(files: ChartExportFile[]): Promise<Blob>;
+//# sourceMappingURL=zipChartPngs.d.ts.map

package/dist/report/zipChartPngs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zipChartPngs.d.ts","sourceRoot":"","sources":["../../src/report/zipChartPngs.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD,wBAAsB,YAAY,CAAC,KAAK,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAM1E"}

package/dist/report/zipChartPngs.js

@@ -0,0 +1,8 @@
+import JSZip from "jszip";
+export async function zipChartPngs(files) {
+    const zip = new JSZip();
+    for (const file of files) {
+        zip.file(file.filename, file.blob);
+    }
+    return zip.generateAsync({ type: "blob", compression: "STORE" });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openshift-migration-advisor/shared-components",
-  "version": "0.25.0",
+  "version": "0.27.0-5d0cc20d809e",
   "description": "Shared React UI components for Migration Advisor apps (report charts, forms, OS support tiers)",
   "author": "Montse Ortega <mortegag@redhat.com>",
   "license": "Apache-2.0",
@@ -44,5 +44,10 @@
     "src",
     "LICENSE",
     "README.md"
-  ]
+  ],
+  "dependencies": {
+    "html2canvas-pro": "^2.5.0",
+    "jspdf": "^4.2.1",
+    "jszip": "^3.10.2"
+  }
 }

package/src/report/ChartDownloadButton.tsx

@@ -0,0 +1,59 @@
+import { Button, Flex, FlexItem } from "@patternfly/react-core";
+import { DownloadIcon } from "@patternfly/react-icons";
+import type { FC, ReactNode } from "react";
+import { chartExportHideProps } from "./chartExport.js";
+import { useChartExport } from "./chartExportContext.js";
+
+export const ChartDownloadButton: FC<{
+  chartId: string;
+  title?: string;
+}> = ({ chartId, title }) => {
+  const exportApi = useChartExport();
+  if (!exportApi) {
+    return null;
+  }
+
+  const label = title ? `Download ${title} as PNG` : "Download chart as PNG";
+
+  return (
+    <Button
+      variant="plain"
+      icon={<DownloadIcon />}
+      aria-label={label}
+      isLoading={exportApi.downloadingChartId === chartId}
+      isDisabled={exportApi.isBusy}
+      onClick={() => {
+        void exportApi.downloadChart(chartId);
+      }}
+    />
+  );
+};
+
+ChartDownloadButton.displayName = "ChartDownloadButton";
+
+export const ChartHeaderActions: FC<{
+  chartId: string;
+  title?: string;
+  children?: ReactNode;
+}> = ({ chartId, title, children }) => {
+  const exportApi = useChartExport();
+  if (!exportApi && !children) {
+    return null;
+  }
+
+  return (
+    <FlexItem {...chartExportHideProps}>
+      <Flex
+        alignItems={{ default: "alignItemsCenter" }}
+        spaceItems={{ default: "spaceItemsSm" }}
+      >
+        {children}
+        {exportApi ? (
+          <ChartDownloadButton chartId={chartId} title={title} />
+        ) : null}
+      </Flex>
+    </FlexItem>
+  );
+};
+
+ChartHeaderActions.displayName = "ChartHeaderActions";