@jasy/pdf 1.0.0-alpha.1 → 1.0.0-alpha.10

package/dist/renderer/image-renderer.js

@@ -1,74 +1,78 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ImageRenderer = void 0;
-const image_element_1 = require("../elements/image-element");
-const image_helper_1 = require("../utils/image-helper");
-class ImageRenderer {
-    static render(imageElement, _objectManager) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // Load the image and convert it in a binary string
-            let { x, y, width, height, image, fit, radius } = imageElement.getProps();
-            yield image.init(); // Load and initialize the image
-            const imageType = yield image.getImageType(); // For the moment we can handle `png` and `jpg/jpeg` files
-            const fileData = yield image.getFileData();
-            const dimensions = yield image.getImageDimensions();
-            if (!fileData) {
-                throw new Error("File data cannot be `null`");
-            }
-            // JPEG embeds raw (PDF decodes DCTDecode natively). PNG is not a valid Flate stream,
-            // so decode it to raw DeviceRGB samples that the FlateDecode XObject path expects.
-            const embedData = imageType === "FlateDecode"
-                ? (yield (0, image_helper_1.decodePngToRgbFlate)(Buffer.from(fileData, "binary"))).data
-                : fileData;
-            // Now we check the `fit` property and changing the dimensions of the image
-            // Optionally we must add an overflow container
-            let mustCreateOverflowContainer = false;
-            const containerDimensions = JSON.parse(JSON.stringify({ x, y, width, height })); // Deep clone images dimensions
-            switch (fit) {
-                case image_element_1.BoxFit.cover:
-                    mustCreateOverflowContainer = true;
-                    const fitCoverResult = (0, image_helper_1.applyCoverFit)(dimensions.width, dimensions.height, width !== null && width !== void 0 ? width : 0, height !== null && height !== void 0 ? height : 0);
-                    x += fitCoverResult.offsetX;
-                    y += fitCoverResult.offsetY;
-                    width = fitCoverResult.width;
-                    height = fitCoverResult.height;
-                    break;
-                case image_element_1.BoxFit.contain:
-                    mustCreateOverflowContainer = true;
-                    const fitContainResult = (0, image_helper_1.applyContainFit)(dimensions.width, dimensions.height, width !== null && width !== void 0 ? width : 0, height !== null && height !== void 0 ? height : 0);
-                    x += fitContainResult.offsetX;
-                    y += fitContainResult.offsetY;
-                    width = fitContainResult.width;
-                    height = fitContainResult.height;
-                    break;
-                case image_element_1.BoxFit.none:
-                    const fitNoneResult = (0, image_helper_1.applyFitNone)(dimensions.width, dimensions.height, width !== null && width !== void 0 ? width : 0, height !== null && height !== void 0 ? height : 0);
-                    x += fitNoneResult.offsetX;
-                    y += fitNoneResult.offsetY;
-                    width = fitNoneResult.width;
-                    height = fitNoneResult.height;
-                    break;
-                case image_element_1.BoxFit.fill:
-                    const fitFillResult = (0, image_helper_1.applyFillFit)(width !== null && width !== void 0 ? width : 0, height !== null && height !== void 0 ? height : 0);
-                    width = fitFillResult.width;
-                    height = fitFillResult.height;
-            }
-            // A radius rounds the image BOX (the element frame), so it clips to that frame too -
-            // independent of the cover/contain overflow clip.
-            const wantsClip = mustCreateOverflowContainer || (radius !== null && radius !== void 0 ? radius : 0) > 0;
-            // The fitted geometry becomes a display-list primitive; the backend registers
-            // the XObject and emits the placement (+ clip, rounded when a radius is set).
-            const node = Object.assign(Object.assign({ type: "image", x,
-                y, width: width, height: height, intrinsicWidth: dimensions.width, intrinsicHeight: dimensions.height, data: embedData, imageType }, (radius ? { radius } : {})), (wantsClip
+import { BoxFit } from "../elements/image-element.js";
+import { bytesFromLatin1 } from "../utils/bytes.js";
+import { applyContainFit, applyCoverFit, applyFillFit, applyFitNone, decodePngToRgbFlate, } from "../utils/image-helper.js";
+import { isRounded } from "../ir/display-list.js";
+export class ImageRenderer {
+    static async render(imageElement, objectManager) {
+        // Load the image and convert it in a binary string
+        let { x, y, width, height, image, fit, radius, alt } = imageElement.getProps();
+        await image.init(); // Load and initialize the image
+        const imageType = await image.getImageType(); // For the moment we can handle `png` and `jpg/jpeg` files
+        const fileData = await image.getFileData();
+        const dimensions = await image.getImageDimensions();
+        if (!fileData) {
+            throw new Error("File data cannot be `null`");
+        }
+        // JPEG embeds raw (PDF decodes DCTDecode natively). PNG is not a valid Flate stream,
+        // so decode it to raw DeviceRGB samples that the FlateDecode XObject path expects.
+        let embedData = fileData;
+        let smask;
+        if (imageType === "FlateDecode") {
+            const decoded = await decodePngToRgbFlate(bytesFromLatin1(fileData));
+            embedData = decoded.data;
+            smask = decoded.smask;
+        }
+        // Now we check the `fit` property and changing the dimensions of the image
+        // Optionally we must add an overflow container
+        let mustCreateOverflowContainer = false;
+        const containerDimensions = JSON.parse(JSON.stringify({ x, y, width, height })); // Deep clone images dimensions
+        switch (fit) {
+            case BoxFit.cover:
+                mustCreateOverflowContainer = true;
+                const fitCoverResult = applyCoverFit(dimensions.width, dimensions.height, width ?? 0, height ?? 0);
+                x += fitCoverResult.offsetX;
+                y += fitCoverResult.offsetY;
+                width = fitCoverResult.width;
+                height = fitCoverResult.height;
+                break;
+            case BoxFit.contain:
+                mustCreateOverflowContainer = true;
+                const fitContainResult = applyContainFit(dimensions.width, dimensions.height, width ?? 0, height ?? 0);
+                x += fitContainResult.offsetX;
+                y += fitContainResult.offsetY;
+                width = fitContainResult.width;
+                height = fitContainResult.height;
+                break;
+            case BoxFit.none:
+                const fitNoneResult = applyFitNone(dimensions.width, dimensions.height, width ?? 0, height ?? 0);
+                x += fitNoneResult.offsetX;
+                y += fitNoneResult.offsetY;
+                width = fitNoneResult.width;
+                height = fitNoneResult.height;
+                break;
+            case BoxFit.fill:
+                const fitFillResult = applyFillFit(width ?? 0, height ?? 0);
+                width = fitFillResult.width;
+                height = fitFillResult.height;
+        }
+        // A radius rounds the image BOX (the element frame), so it clips to that frame too -
+        // independent of the cover/contain overflow clip.
+        const wantsClip = mustCreateOverflowContainer || isRounded(radius);
+        // The fitted geometry becomes a display-list primitive; the backend registers
+        // the XObject and emits the placement (+ clip, rounded when a radius is set).
+        const node = {
+            type: "image",
+            x,
+            y,
+            width: width,
+            height: height,
+            intrinsicWidth: dimensions.width,
+            intrinsicHeight: dimensions.height,
+            data: embedData,
+            imageType,
+            ...(smask ? { smask } : {}),
+            ...(radius ? { radius } : {}),
+            ...(wantsClip
                 ? {
                     clip: {
                         x: containerDimensions.x,
@@ -77,9 +81,16 @@ class ImageRenderer {
                         height: containerDimensions.height,
                     },
                 }
-                : {}));
-            return [node];
-        });
+                : {}),
+        };
+        // Accessible tagging: an image WITH alt text is a Figure; without, it stays untagged and the backend
+        // treats it as decoration (an Artifact). One struct element per image.
+        if (objectManager.struct.enabled && alt) {
+            node.tag = {
+                role: "Figure",
+                key: objectManager.struct.openElement(imageElement.structId, "Figure", { alt }),
+            };
+        }
+        return [node];
     }
 }
-exports.ImageRenderer = ImageRenderer;

package/dist/renderer/index.d.ts

@@ -1,10 +1,10 @@
-export * from "./container-renderer";
-export * from "./page-renderer";
-export * from "./pdf-document-class";
-export * from "./pdf-document-renderer";
-export * from "./pdf-renderer";
-export * from "./rectangle-renderer";
-export * from "./text-renderer";
-export * from "./expanded-renderer";
-export * from "./line-renderer";
-export * from "./row-renderer";
+export * from "./container-renderer.js";
+export * from "./page-renderer.js";
+export * from "./pdf-document-class.js";
+export * from "./pdf-document-renderer.js";
+export * from "./pdf-renderer.js";
+export * from "./rectangle-renderer.js";
+export * from "./text-renderer.js";
+export * from "./expanded-renderer.js";
+export * from "./line-renderer.js";
+export * from "./row-renderer.js";

package/dist/renderer/index.js

@@ -1,26 +1,10 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./container-renderer"), exports);
-__exportStar(require("./page-renderer"), exports);
-__exportStar(require("./pdf-document-class"), exports);
-__exportStar(require("./pdf-document-renderer"), exports);
-__exportStar(require("./pdf-renderer"), exports);
-__exportStar(require("./rectangle-renderer"), exports);
-__exportStar(require("./text-renderer"), exports);
-__exportStar(require("./expanded-renderer"), exports);
-__exportStar(require("./line-renderer"), exports);
-__exportStar(require("./row-renderer"), exports);
+export * from "./container-renderer.js";
+export * from "./page-renderer.js";
+export * from "./pdf-document-class.js";
+export * from "./pdf-document-renderer.js";
+export * from "./pdf-renderer.js";
+export * from "./rectangle-renderer.js";
+export * from "./text-renderer.js";
+export * from "./expanded-renderer.js";
+export * from "./line-renderer.js";
+export * from "./row-renderer.js";

package/dist/renderer/keep-together-renderer.d.ts

@@ -0,0 +1,10 @@
+import { KeepTogetherElement } from "../elements/layout/keep-together-element.js";
+import { PDFObjectManager } from "../utils/pdf-object-manager.js";
+import { IRNode } from "../ir/display-list.js";
+/**
+ * A `keepTogether` is layout-transparent: it just renders its child. All of its work happens in the
+ * layout pass (`fragment`), never here.
+ */
+export declare class KeepTogetherRenderer {
+    static render(group: KeepTogetherElement, objectManager: PDFObjectManager): Promise<IRNode[]>;
+}

package/dist/renderer/keep-together-renderer.js

@@ -0,0 +1,12 @@
+import { RendererRegistry } from "../utils/renderer-registry.js";
+/**
+ * A `keepTogether` is layout-transparent: it just renders its child. All of its work happens in the
+ * layout pass (`fragment`), never here.
+ */
+export class KeepTogetherRenderer {
+    static async render(group, objectManager) {
+        const { child } = group.getProps();
+        const renderer = RendererRegistry.getRenderer(child);
+        return renderer(child, objectManager);
+    }
+}

package/dist/renderer/line-renderer.d.ts

@@ -1,6 +1,6 @@
-import { PDFObjectManager } from "../utils/pdf-object-manager";
-import { LineElement } from "../elements";
-import { IRNode } from "../ir/display-list";
+import { PDFObjectManager } from "../utils/pdf-object-manager.js";
+import { LineElement } from "../elements/index.js";
+import { IRNode } from "../ir/display-list.js";
 export declare class LineRenderer {
     static render(lineElement: LineElement, _objectManager: PDFObjectManager): Promise<IRNode[]>;
 }

package/dist/renderer/line-renderer.js

@@ -1,30 +1,15 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LineRenderer = void 0;
-class LineRenderer {
-    static render(lineElement, _objectManager) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { x, y, xEnd, yEnd, color, strokeWidth } = lineElement.getProps();
-            const node = {
-                type: "line",
-                x1: x,
-                y1: y,
-                x2: xEnd,
-                y2: yEnd,
-                stroke: color,
-                strokeWidth: strokeWidth,
-            };
-            return [node];
-        });
+export class LineRenderer {
+    static async render(lineElement, _objectManager) {
+        const { x, y, xEnd, yEnd, color, strokeWidth } = lineElement.getProps();
+        const node = {
+            type: "line",
+            x1: x,
+            y1: y,
+            x2: xEnd,
+            y2: yEnd,
+            stroke: color,
+            strokeWidth: strokeWidth,
+        };
+        return [node];
     }
 }
-exports.LineRenderer = LineRenderer;

package/dist/renderer/link-renderer.d.ts

@@ -0,0 +1,6 @@
+import { PDFObjectManager } from "../utils/pdf-object-manager.js";
+import { LinkElement } from "../elements/layout/link-element.js";
+import { IRNode } from "../ir/display-list.js";
+export declare class LinkRenderer {
+    static render(element: LinkElement, objectManager: PDFObjectManager): Promise<IRNode[]>;
+}

package/dist/renderer/link-renderer.js

@@ -0,0 +1,11 @@
+import { RendererRegistry } from "../utils/renderer-registry.js";
+export class LinkRenderer {
+    static async render(element, objectManager) {
+        const { href, dest, child, x, y, width, height } = element.getProps();
+        const renderer = RendererRegistry.getRenderer(child);
+        const childNodes = await renderer(child, objectManager);
+        // The child draws normally; a Link IR node carries the clickable rect + target (external href or
+        // internal dest) for the page renderer to emit as a /Link annotation (no content-stream ops itself).
+        return [...childNodes, { type: "link", x, y, width, height, href, dest }];
+    }
+}

package/dist/renderer/padding-renderer.d.ts

@@ -1,6 +1,6 @@
-import { PDFObjectManager } from "../utils/pdf-object-manager";
-import { PaddingElement } from "../elements/layout/padding-element";
-import { IRNode } from "../ir/display-list";
+import { PDFObjectManager } from "../utils/pdf-object-manager.js";
+import { PaddingElement } from "../elements/layout/padding-element.js";
+import { IRNode } from "../ir/display-list.js";
 export declare class PaddingRenderer {
     static render(paddingElement: PaddingElement, objectManager: PDFObjectManager): Promise<IRNode[]>;
 }

package/dist/renderer/padding-renderer.js

@@ -1,23 +1,8 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PaddingRenderer = void 0;
-const renderer_registry_1 = require("../utils/renderer-registry");
-class PaddingRenderer {
-    static render(paddingElement, objectManager) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { child } = paddingElement.getProps();
-            const renderer = renderer_registry_1.RendererRegistry.getRenderer(child);
-            return renderer ? yield renderer(child, objectManager) : [];
-        });
+import { RendererRegistry } from "../utils/renderer-registry.js";
+export class PaddingRenderer {
+    static async render(paddingElement, objectManager) {
+        const { child } = paddingElement.getProps();
+        const renderer = RendererRegistry.getRenderer(child);
+        return renderer(child, objectManager);
     }
 }
-exports.PaddingRenderer = PaddingRenderer;

package/dist/renderer/page-break-renderer.d.ts

@@ -0,0 +1,14 @@
+import { PDFObjectManager } from "../utils/pdf-object-manager.js";
+import { PageBreakElement } from "../elements/layout/page-break-element.js";
+import { IRNode } from "../ir/display-list.js";
+/**
+ * A `PageBreak` draws nothing - the pagination packer consumes it at the cut, so in a vertical flow it
+ * never reaches this pass. Reaching it therefore means the break was ineffective: it sat somewhere that
+ * does not paginate, like inside a horizontal `Row` (a row is one line, you cannot split it across
+ * pages - CSS and react-pdf ignore a forced break there too). We degrade to drawing nothing, but warn
+ * once so the mistake is not silent. This one choke-point catches every ineffective break; no element
+ * needs a special case.
+ */
+export declare class PageBreakRenderer {
+    static render(_element: PageBreakElement, _objectManager: PDFObjectManager): Promise<IRNode[]>;
+}

package/dist/renderer/page-break-renderer.js

@@ -0,0 +1,15 @@
+/**
+ * A `PageBreak` draws nothing - the pagination packer consumes it at the cut, so in a vertical flow it
+ * never reaches this pass. Reaching it therefore means the break was ineffective: it sat somewhere that
+ * does not paginate, like inside a horizontal `Row` (a row is one line, you cannot split it across
+ * pages - CSS and react-pdf ignore a forced break there too). We degrade to drawing nothing, but warn
+ * once so the mistake is not silent. This one choke-point catches every ineffective break; no element
+ * needs a special case.
+ */
+export class PageBreakRenderer {
+    static async render(_element, _objectManager) {
+        console.warn("PageBreak had no effect: it is not in a paginating flow (e.g. it is inside a Row, which is a " +
+            "single horizontal line). Put the break as a sibling in a Column to break after that content.");
+        return [];
+    }
+}

package/dist/renderer/page-builder-renderer.d.ts

@@ -0,0 +1,6 @@
+import { PDFObjectManager } from "../utils/pdf-object-manager.js";
+import { PageBuilderElement } from "../elements/layout/page-builder-element.js";
+import { IRNode } from "../ir/display-list.js";
+export declare class PageBuilderRenderer {
+    static render(element: PageBuilderElement, objectManager: PDFObjectManager): Promise<IRNode[]>;
+}

package/dist/renderer/page-builder-renderer.js

@@ -0,0 +1,11 @@
+import { RendererRegistry } from "../utils/renderer-registry.js";
+export class PageBuilderRenderer {
+    static async render(element, objectManager) {
+        // `composed` is whatever the closure built for THIS page during the render pass's layout.
+        const { composed } = element.getProps();
+        if (!composed)
+            return [];
+        const renderer = RendererRegistry.getRenderer(composed);
+        return renderer(composed, objectManager);
+    }
+}

package/dist/renderer/page-renderer.d.ts

@@ -1,5 +1,5 @@
-import { PageElement } from "../elements/page-element";
-import { PDFObjectManager } from "../utils/pdf-object-manager";
+import { PageElement } from "../elements/page-element.js";
+import { PDFObjectManager } from "../utils/pdf-object-manager.js";
 export declare class PageRenderer {
     static render(page: PageElement, objectManager: PDFObjectManager): Promise<number>;
 }