@ironsoftware/ironpdf 2026.3.1 → 2026.5.1

package/src/public/render.ts

@@ -8,6 +8,69 @@ import {
         TableOfContentsTypes,
 } from "./types";
 
+/**
+ * Represents the rendered location of an HTML element within a PDF document.
+ *
+ * Returned by {@code PdfDocument.getElementLocations()} after rendering HTML with
+ * {@link ChromePdfRenderOptions.elementQuerySelectors} configured.
+ *
+ * Mirrors {@code IronPdf.RenderedElementLocation} on the C# side.
+ */
+export interface RenderedElementLocation {
+	/**
+	 * The text content of the matched element.
+	 */
+	text: string;
+	/**
+	 * The zero-based page index where the element was rendered.
+	 */
+	pageIndex: number;
+	/**
+	 * The bounding rectangle of the annotation marker on the page, in PDF points (1/72 inch).
+	 * Coordinate origin is the bottom-left corner of the page. The rectangle corresponds to
+	 * the injected anchor marker placed at the start of the matched element.
+	 */
+	rectangle: { x: number; y: number; width: number; height: number };
+	/**
+	 * The original index of the element in document order among all matched elements.
+	 */
+	elementIndex: number;
+}
+ 
+/**
+ * Specifies the linearization strategy to use when producing a linearized
+ * (web-optimized) PDF.
+ *
+ * Mirrors {@code IronPdf.LinearizationMode} on the C# side.
+ */
+export enum LinearizationMode {
+	/**
+	 * Automatically selects the optimal linearization method based on system capabilities.
+	 *
+	 * Behavior:
+	 *   1. First attempts {@link FileBased} linearization.
+	 *   2. If disk access is restricted (e.g. limited permissions, sandboxed environment),
+	 *      automatically falls back to {@link InMemory}.
+	 *
+	 * Recommended default for most applications.
+	 */
+	Automatic = 0,
+	/**
+	 * Performs linearization entirely in memory without any disk I/O operations.
+	 *
+	 * Use when:
+	 *   - Compliance requirements mandate zero disk I/O (e.g. HIPAA, PCI-DSS)
+	 *   - Sandboxed or restricted environments without disk write permissions
+	 *   - Cloud-based environments where disk I/O introduces latency
+	 */
+	InMemory = 1,
+	/**
+	 * Performs linearization using temporary file operations on disk.
+	 * Requires write permissions to the system temporary directory.
+	 */
+	FileBased = 2,
+}
+
 /**
  * Html or Url To PDF output options for {@link PdfGenerator} and {@link PdfDocument} static method.
  * Specify options such as Paper-Size, DPI and other Chromium specific browser setup options.
@@ -112,6 +175,44 @@ export interface ChromePdfRenderOptions {
 	 *  @default {@link UseMargins.LeftAndRight}
 	 */
 	useMarginsOnHeaderAndFooter?: UseMargins | undefined;
+	/**
+	 * If true, auto-generate PDF outline (bookmarks) from the HTML heading structure.
+	 * Use {@link autoBookmarkMinHeadingLevel} / {@link autoBookmarkMaxHeadingLevel} to control
+	 * which heading levels are included (1 = h1, 6 = h6). Use {@link autoBookmarkCssSelectors}
+	 * to include additional non-heading elements (e.g. {@code ".chapter-title"}).
+	 *
+	 * @default false
+	 */
+	autoBookmarksFromHeadings?: boolean | undefined;
+	/**
+	 * Minimum heading level (inclusive) to include in auto-generated bookmarks.
+	 * Only used when {@link autoBookmarksFromHeadings} is true.
+	 *
+	 * @default 1
+	 */
+	autoBookmarkMinHeadingLevel?: number | undefined;
+	/**
+	 * Maximum heading level (inclusive) to include in auto-generated bookmarks.
+	 * Only used when {@link autoBookmarksFromHeadings} is true.
+	 *
+	 * @default 6
+	 */
+	autoBookmarkMaxHeadingLevel?: number | undefined;
+	/**
+	 * Additional CSS selectors whose matching elements will be included as auto-bookmarks
+	 * (in addition to the heading range). Only used when {@link autoBookmarksFromHeadings} is true.
+	 * Example: {@code [".chapter-title", "[data-bookmark]"]}.
+	 */
+	autoBookmarkCssSelectors?: string[] | undefined;
+	/**
+	 * CSS selectors whose matching HTML elements should be tracked during rendering so their
+	 * rendered page positions can later be retrieved by the engine.
+	 *
+	 * <b>Note:</b> retrieval of the per-element locations from the Node client is not yet
+	 * supported. Setting this option still enables engine-side tracking (and any downstream
+	 * effects such as auto-bookmarks for those selectors).
+	 */
+	elementQuerySelectors?: string[] | undefined;
 }
 
 /**

package/src/public/signature.d.ts

@@ -63,4 +63,37 @@ export interface SignatureImage {
      */
     SignatureImagePageIndex?: number | undefined;
 }
+/**
+ * Represents a verified digital signature extracted from a signed PDF document.
+ */
+export interface VerifiedSignature {
+    /**
+     * The name of the signature (form field name or signature identifier).
+     */
+    signatureName: string;
+    /**
+     * The contact information of the signer.
+     */
+    signingContact: string;
+    /**
+     * The reason the PDF was signed.
+     */
+    signingReason: string;
+    /**
+     * The physical location where the PDF was signed.
+     */
+    signingLocation: string;
+    /**
+     * The date and time the signature was applied.
+     */
+    signingDate?: Date | undefined;
+    /**
+     * Whether the signature is valid.
+     */
+    isValid: boolean;
+    /**
+     * The signature filter type (e.g. "Adobe.PPKLite").
+     */
+    filter: string;
+}
 //# sourceMappingURL=signature.d.ts.map

package/src/public/signature.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signature.d.ts","sourceRoot":"","sources":["signature.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,SAAS,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,YAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,eAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,iBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,mBAAoB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C;;OAEG;IACH,aAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,eAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC;;;OAGG;IACH,aAAc,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IAClC;;;;OAIG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,kBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,oBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,sBAAsB,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACnD;;OAEG;IACH,uBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9C"}
+{"version":3,"file":"signature.d.ts","sourceRoot":"","sources":["signature.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,SAAS,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,YAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,eAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,iBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,mBAAoB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C;;OAEG;IACH,aAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,eAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC;;;OAGG;IACH,aAAc,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IAClC;;;;OAIG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,kBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,oBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,sBAAsB,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACnD;;OAEG;IACH,uBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IACjC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,WAAW,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CACf"}

package/src/public/signature.ts

@@ -63,3 +63,37 @@ export interface SignatureImage {
 	 */
 	SignatureImagePageIndex ?: number | undefined;
 }
+
+/**
+ * Represents a verified digital signature extracted from a signed PDF document.
+ */
+export interface VerifiedSignature {
+	/**
+	 * The name of the signature (form field name or signature identifier).
+	 */
+	signatureName: string;
+	/**
+	 * The contact information of the signer.
+	 */
+	signingContact: string;
+	/**
+	 * The reason the PDF was signed.
+	 */
+	signingReason: string;
+	/**
+	 * The physical location where the PDF was signed.
+	 */
+	signingLocation: string;
+	/**
+	 * The date and time the signature was applied.
+	 */
+	signingDate?: Date | undefined;
+	/**
+	 * Whether the signature is valid.
+	 */
+	isValid: boolean;
+	/**
+	 * The signature filter type (e.g. "Adobe.PPKLite").
+	 */
+	filter: string;
+}