@ironsoftware/ironpdf 2026.4.1 → 2026.6.1

package/src/internal/grpc_layer/pdfium/linearize.ts

@@ -0,0 +1,338 @@
+import * as grpc from "@grpc/grpc-js";
+import {Buffer} from "buffer";
+import * as fs from "fs";
+import * as os from "os";
+import * as path from "path";
+import {PassThrough, Readable} from "stream";
+import {Access} from "../../access";
+import {IronPdfServiceClient} from "../../generated_proto/ironpdfengineproto/IronPdfService";
+import {BytesResultStreamP__Output} from "../../generated_proto/ironpdfengineproto/BytesResultStreamP";
+import {BooleanResultP__Output} from "../../generated_proto/ironpdfengineproto/BooleanResultP";
+import {
+	QPdfIsLinearizedRequestStreamP
+} from "../../generated_proto/ironpdfengineproto/QPdfIsLinearizedRequestStreamP";
+import {
+	QPdfLinearizeInMemoryRequestStreamP
+} from "../../generated_proto/ironpdfengineproto/QPdfLinearizeInMemoryRequestStreamP";
+import {
+	QPdfSaveAsLinearizedFromBytesRequestStreamP
+} from "../../generated_proto/ironpdfengineproto/QPdfSaveAsLinearizedFromBytesRequestStreamP";
+import {LinearizationMode} from "../../../public/render";
+import {chunkBuffer, handleRemoteException} from "../util";
+ 
+/**
+ * Check if the given PDF bytes represent a linearized ("Fast Web View") PDF.
+ */
+export async function isLinearizedFromBytes(
+	pdfBytes: Buffer,
+	password = ""
+): Promise<boolean> {
+	const client: IronPdfServiceClient = await Access.ensureConnection();
+ 
+	return new Promise(
+		(resolve: (_: boolean) => void, reject: (errorMsg: string) => void) => {
+			const stream: grpc.ClientWritableStream<QPdfIsLinearizedRequestStreamP> =
+				client.QPdf_Linearization_IsLinearized(
+					(err: grpc.ServiceError | null, value: BooleanResultP__Output | undefined) => {
+						if (err) {
+							reject(`${err.name}/n${err.message}`);
+						} else if (value) {
+							if (value.exception) {
+								handleRemoteException(value.exception, reject);
+								return;
+							}
+							resolve(value.result ?? false);
+						} else {
+							reject("No response from IronPdfEngine for isLinearized");
+						}
+					}
+				);
+ 
+			stream.write({info: {password: password ?? ""}});
+			chunkBuffer(pdfBytes).forEach((chunk) => {
+				stream.write({pdfBytesChunk: chunk});
+			});
+			stream.end();
+		}
+	);
+}
+ 
+/**
+ * Linearize a PDF held by the engine (by document id) and return the linearized bytes
+ * via the {@code QPdf_Linearization_LinearizeInMemoryFromId} unary-request/server-streaming RPC.
+ */
+export async function linearizeInMemoryFromId(
+	id: string,
+	password = ""
+): Promise<Buffer> {
+	const client: IronPdfServiceClient = await Access.ensureConnection();
+ 
+	return new Promise(
+		(resolve: (_: Buffer) => void, reject: (errorMsg: string) => void) => {
+			const stream: grpc.ClientReadableStream<BytesResultStreamP__Output> =
+				client.QPdf_Linearization_LinearizeInMemoryFromId({
+					document: {documentId: id},
+					password: password ?? "",
+				});
+ 
+			const buffers: Buffer[] = [];
+			stream.on("data", (data: BytesResultStreamP__Output) => {
+				if (data.exception) {
+					handleRemoteException(data.exception, reject);
+				} else if (data.resultChunk) {
+					buffers.push(data.resultChunk);
+				}
+			});
+ 
+			stream.on("error", (err: Error) => {
+				reject(`${err.name}/n${err.message}`);
+			});
+ 
+			stream.on("end", () => {
+				resolve(Buffer.concat(buffers));
+			});
+		}
+	);
+}
+ 
+/**
+ * Linearize a PDF held by the engine (by document id) and stream the linearized bytes
+ * as a {@link Readable}. Useful for piping to HTTP responses or file streams without
+ * buffering the entire PDF in memory.
+ */
+export async function linearizeInMemoryFromIdStream(
+	id: string,
+	password = ""
+): Promise<Readable> {
+	const client: IronPdfServiceClient = await Access.ensureConnection();
+ 
+	const passThrough = new PassThrough();
+ 
+	const stream: grpc.ClientReadableStream<BytesResultStreamP__Output> =
+		client.QPdf_Linearization_LinearizeInMemoryFromId({
+			document: {documentId: id},
+			password: password ?? "",
+		});
+ 
+	stream.on("data", (data: BytesResultStreamP__Output) => {
+		if (data.exception) {
+			passThrough.destroy(
+				new Error(`${data.exception.message}/n${data.exception.remoteStackTrace}`)
+			);
+		} else if (data.resultChunk) {
+			passThrough.write(data.resultChunk);
+		}
+	});
+ 
+	stream.on("error", (err: Error) => {
+		passThrough.destroy(err);
+	});
+ 
+	stream.on("end", () => {
+		passThrough.end();
+	});
+ 
+	return passThrough;
+}
+ 
+/**
+ * Linearize a PDF provided as raw bytes and return the linearized bytes via the
+ * bidirectional streaming {@code QPdf_Linearization_LinearizeInMemory} RPC.
+ */
+export async function linearizeInMemoryFromBytes(
+	pdfBytes: Buffer,
+	password = ""
+): Promise<Buffer> {
+	const client: IronPdfServiceClient = await Access.ensureConnection();
+ 
+	return new Promise(
+		(resolve: (_: Buffer) => void, reject: (errorMsg: string) => void) => {
+			const stream: grpc.ClientDuplexStream<
+				QPdfLinearizeInMemoryRequestStreamP,
+				BytesResultStreamP__Output
+			> = client.QPdf_Linearization_LinearizeInMemory();
+ 
+			const buffers: Buffer[] = [];
+			stream.on("data", (data: BytesResultStreamP__Output) => {
+				if (data.exception) {
+					handleRemoteException(data.exception, reject);
+				} else if (data.resultChunk) {
+					buffers.push(data.resultChunk);
+				}
+			});
+ 
+			stream.on("error", (err: Error) => {
+				reject(`${err.name}/n${err.message}`);
+			});
+ 
+			stream.on("end", () => {
+				resolve(Buffer.concat(buffers));
+			});
+ 
+			stream.write({info: {password: password ?? ""}});
+			chunkBuffer(pdfBytes).forEach((chunk) => {
+				stream.write({pdfBytesChunk: chunk});
+			});
+			stream.end();
+		}
+	);
+}
+ 
+/**
+ * Core linearization logic shared across all linearization entry points. Implements the
+ * {@link LinearizationMode} strategy pattern. Mirrors {@code PdfDocument.LinearizePdfCore}
+ * on the C# side.
+ */
+export async function linearizeCoreFromBytes(
+	pdfBytes: Buffer,
+	password = "",
+	mode: LinearizationMode = LinearizationMode.Automatic
+): Promise<Buffer> {
+	if (!pdfBytes || pdfBytes.length === 0) {
+		throw new Error("The PDF bytes cannot be null or empty.");
+	}
+ 
+	if (mode === LinearizationMode.InMemory) {
+		return linearizeInMemoryFromBytes(pdfBytes, password);
+	}
+ 
+	if (mode === LinearizationMode.FileBased) {
+		// Explicit FileBased — let any disk error bubble up.
+		return linearizeViaTempFile(pdfBytes, password);
+	}
+ 
+	// Automatic mode
+	if (canWriteToTemp()) {
+		try {
+			return await linearizeViaTempFile(pdfBytes, password);
+		} catch (e) {
+			console.warn(
+				`Automatic Linearization: Disk attempt failed (${(e as Error).message}). ` +
+					"Falling back to Memory linearization."
+			);
+			return linearizeInMemoryFromBytes(pdfBytes, password);
+		}
+	}
+	console.warn("Automatic Linearization: No write permission detected. Using Memory linearization.");
+	return linearizeInMemoryFromBytes(pdfBytes, password);
+}
+ 
+/**
+ * Variant of {@link linearizeCoreFromBytes} that starts from an open document on the engine.
+ * For {@link LinearizationMode.InMemory} we use the cheap document-id RPC; for the disk-based
+ * paths we have to fetch the bytes once and delegate to {@link linearizeCoreFromBytes}.
+ */
+export async function linearizeCoreFromId(
+	id: string,
+	getBytes: () => Promise<Buffer>,
+	password = "",
+	mode: LinearizationMode = LinearizationMode.Automatic
+): Promise<Buffer> {
+	if (mode === LinearizationMode.InMemory) {
+		return linearizeInMemoryFromId(id, password);
+	}
+	const pdfBytes = await getBytes();
+	return linearizeCoreFromBytes(pdfBytes, password, mode);
+}
+ 
+/**
+ * Linearize via the engine's file-based RPC and persist the result through a client-side
+ * temporary file. The client-side disk write is the difference between this and
+ * {@link linearizeInMemoryFromBytes} — when the client filesystem is read-only,
+ * {@code FileBased} mode fails here so {@link LinearizationMode.Automatic} can fall back.
+ *
+ * Mirrors C# {@code PdfDocument.LinearizeViaTempFile}.
+ */
+async function linearizeViaTempFile(pdfBytes: Buffer, password: string): Promise<Buffer> {
+	const linearized = await saveAsLinearizedFromBytes(pdfBytes, "", password);
+	const tempPath = path.join(
+		os.tmpdir(),
+		`ironpdf-linearize-${process.pid}-${Date.now()}-${Math.random().toString(36).slice(2, 10)}.pdf`
+	);
+	try {
+		fs.writeFileSync(tempPath, linearized);
+		return fs.readFileSync(tempPath);
+	} finally {
+		try {
+			if (fs.existsSync(tempPath)) {
+				fs.unlinkSync(tempPath);
+			}
+		} catch {
+			// best-effort cleanup
+		}
+	}
+}
+ 
+/**
+ * Probe whether the current process can create files in the system temp directory.
+ */
+function canWriteToTemp(): boolean {
+	const probePath = path.join(
+		os.tmpdir(),
+		`ironpdf-probe-${process.pid}-${Date.now()}-${Math.random().toString(36).slice(2, 10)}.tmp`
+	);
+	try {
+		fs.writeFileSync(probePath, "");
+		return true;
+	} catch {
+		return false;
+	} finally {
+		try {
+			if (fs.existsSync(probePath)) {
+				fs.unlinkSync(probePath);
+			}
+		} catch {
+			// best-effort cleanup
+		}
+	}
+}
+ 
+/**
+ * Linearize a PDF provided as raw bytes and save the result to disk via the file-based
+ * streaming {@code QPdf_Linearization_SaveAsLinearizedFromBytes} RPC.
+ *
+ * Mirrors the in-memory behavior used by {@link compressInMemory} in {@code compress.ts}:
+ * the engine streams the linearized bytes back, and we concatenate and persist them
+ * locally at {@code outputPath}.
+ */
+export async function saveAsLinearizedFromBytes(
+	pdfBytes: Buffer,
+	outputPath: string,
+	password = ""
+): Promise<Buffer> {
+	const client: IronPdfServiceClient = await Access.ensureConnection();
+ 
+	return new Promise(
+		(resolve: (_: Buffer) => void, reject: (errorMsg: string) => void) => {
+			const stream: grpc.ClientDuplexStream<
+				QPdfSaveAsLinearizedFromBytesRequestStreamP,
+				BytesResultStreamP__Output
+			> = client.QPdf_Linearization_SaveAsLinearizedFromBytes();
+ 
+			const buffers: Buffer[] = [];
+			stream.on("data", (data: BytesResultStreamP__Output) => {
+				if (data.exception) {
+					handleRemoteException(data.exception, reject);
+				} else if (data.resultChunk) {
+					buffers.push(data.resultChunk);
+				}
+			});
+ 
+			stream.on("error", (err: Error) => {
+				reject(`${err.name}/n${err.message}`);
+			});
+ 
+			stream.on("end", () => {
+				resolve(Buffer.concat(buffers));
+			});
+ 
+			stream.write({
+				info: {outputPath: outputPath, password: password ?? ""},
+			});
+			chunkBuffer(pdfBytes).forEach((chunk) => {
+				stream.write({pdfBytesChunk: chunk});
+			});
+			stream.end();
+		}
+	);
+}

package/src/internal/zod/renderSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"renderSchema.d.ts","sourceRoot":"","sources":["renderSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAA;AACrB,OAAO,EACN,sBAAsB,EACtB,oBAAoB,EACpB,OAAO,EACP,wBAAwB,EACxB,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,eAAe,EAAE,kBAAkB,EACnC,WAAW,EACX,MAAM,qBAAqB,CAAC;AAK7B,eAAO,MAAM,iBAAiB,EAAG,CAAC,CAAC,OAAO,CAAC,WAAW,CAA6B,CAAA;AAEnF,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAKjE,CAAA;AAEF,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAK/D,CAAA;AAEF,eAAO,MAAM,yBAAyB,EAAG,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAKpE,CAAA;AAEF,eAAO,MAAM,yBAAyB,EAAG,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAKpE,CAAA;AAEF,eAAO,MAAM,yBAAyB,EAAG,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAKpE,CAAA;AAEF,eAAO,MAAM,qBAAqB,EAAG,CAAC,CAAC,OAAO,CAAC,eAAe,CAE5D,CAAA;AAEF,eAAO,MAAM,8BAA8B,EAAG,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAM9E,CAAA;AAEF,eAAO,MAAM,aAAa,EAAG,CAAC,CAAC,OAAO,CAAC,OAAO,CAQ5C,CAAA;AAEF,eAAO,MAAM,0BAA0B,EAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAKtE,CAAA;AAEF,eAAO,MAAM,4BAA4B,EAAG,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAuB1E,CAAA"}
+{"version":3,"file":"renderSchema.d.ts","sourceRoot":"","sources":["renderSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAA;AACrB,OAAO,EACN,sBAAsB,EACtB,oBAAoB,EACpB,OAAO,EACP,wBAAwB,EACxB,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,eAAe,EAAE,kBAAkB,EACnC,WAAW,EACX,MAAM,qBAAqB,CAAC;AAK7B,eAAO,MAAM,iBAAiB,EAAG,CAAC,CAAC,OAAO,CAAC,WAAW,CAA6B,CAAA;AAEnF,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAKjE,CAAA;AAEF,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAK/D,CAAA;AAEF,eAAO,MAAM,yBAAyB,EAAG,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAKpE,CAAA;AAEF,eAAO,MAAM,yBAAyB,EAAG,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAKpE,CAAA;AAEF,eAAO,MAAM,yBAAyB,EAAG,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAKpE,CAAA;AAEF,eAAO,MAAM,qBAAqB,EAAG,CAAC,CAAC,OAAO,CAAC,eAAe,CAE5D,CAAA;AAEF,eAAO,MAAM,8BAA8B,EAAG,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAM9E,CAAA;AAEF,eAAO,MAAM,aAAa,EAAG,CAAC,CAAC,OAAO,CAAC,OAAO,CAQ5C,CAAA;AAEF,eAAO,MAAM,0BAA0B,EAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAKtE,CAAA;AAEF,eAAO,MAAM,4BAA4B,EAAG,CAAC,CAAC,OAAO,CAAC,sBAAsB,CA4B1E,CAAA"}

package/src/internal/zod/renderSchema.js

@@ -84,6 +84,11 @@ exports.chromePdfRenderOptionsSchema = zod_1.z.object({
     htmlFooter: affixSchema_1.htmlAffixSchema.optional(),
     textHeader: affixSchema_1.textAffixSchema.optional(),
     textFooter: affixSchema_1.textAffixSchema.optional(),
-    useMarginsOnHeaderAndFooter: typeSchema_1.useMarginsSchema.optional()
+    useMarginsOnHeaderAndFooter: typeSchema_1.useMarginsSchema.optional(),
+    autoBookmarksFromHeadings: zod_1.z.boolean().optional(),
+    autoBookmarkMinHeadingLevel: zod_1.z.number().int().min(1).max(6).optional(),
+    autoBookmarkMaxHeadingLevel: zod_1.z.number().int().min(1).max(6).optional(),
+    autoBookmarkCssSelectors: zod_1.z.array(zod_1.z.string()).optional(),
+    elementQuerySelectors: zod_1.z.array(zod_1.z.string()).optional()
 });
 //# sourceMappingURL=renderSchema.js.map

package/src/internal/zod/renderSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"renderSchema.js","sourceRoot":"","sources":["renderSchema.ts"],"names":[],"mappings":";;;AAAA,6BAAqB;AACrB,gDAW6B;AAC7B,6CAAyI;AACzI,+CAA4E;AAC5E,+CAA+D;AAElD,QAAA,iBAAiB,GAA4B,OAAC,CAAC,UAAU,CAAC,oBAAW,CAAC,CAAA;AAEtE,QAAA,wBAAwB,GAAkC,OAAC,CAAC,MAAM,CAAC;IAC/E,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oBAAW,CAAC,WAAW,CAAC;IACxC,KAAK,EAAE,OAAC;SACN,MAAM,EAAE;SACR,QAAQ,EAAE;CACZ,CAAC,CAAA;AAEW,QAAA,uBAAuB,GAAiC,OAAC,CAAC,MAAM,CAAC;IAC7E,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oBAAW,CAAC,UAAU,CAAC;IACvC,WAAW,EAAE,OAAC;SACZ,MAAM,EAAE;SACR,QAAQ,EAAE;CACZ,CAAC,CAAA;AAEW,QAAA,yBAAyB,GAAoC,OAAC,CAAC,MAAM,CAAC;IAClF,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oBAAW,CAAC,YAAY,CAAC;IACzC,mBAAmB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,qBAAqB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5C,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAA;AAEW,QAAA,yBAAyB,GAAoC,OAAC,CAAC,MAAM,CAAC;IAClF,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oBAAW,CAAC,YAAY,CAAC;IACzC,WAAW,EAAE,OAAC;SACZ,MAAM,EAAE;SACR,QAAQ,EAAE;CACZ,CAAC,CAAA;AAEW,QAAA,yBAAyB,GAAoC,OAAC,CAAC,MAAM,CAAC;IAClF,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oBAAW,CAAC,YAAY,CAAC;IACzC,WAAW,EAAE,OAAC;SACZ,MAAM,EAAE;SACR,QAAQ,EAAE;CACZ,CAAC,CAAA;AAEW,QAAA,qBAAqB,GAAgC,OAAC,CAAC,MAAM,CAAC;IAC1E,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oBAAW,CAAC,QAAQ,CAAC;CACrC,CAAC,CAAA;AAEW,QAAA,8BAA8B,GAAyC,OAAC,CAAC,MAAM,CAAC;IAC5F,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oBAAW,CAAC,WAAW,CAAC;IACxC,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE;IACxB,WAAW,EAAE,OAAC;SACZ,MAAM,EAAE;SACR,QAAQ,EAAE;CACZ,CAAC,CAAA;AAEW,QAAA,aAAa,GAAwB,OAAC,CAAC,KAAK,CAAC;IACzD,gCAAwB;IACxB,6BAAqB;IACrB,+BAAuB;IACvB,iCAAyB;IACzB,iCAAyB;IACzB,iCAAyB;IACzB,sCAA8B;CAC9B,CAAC,CAAA;AAEW,QAAA,0BAA0B,GAAqC,OAAC,CAAC,MAAM,CAAC;IACpF,cAAc,EAAE,OAAC,CAAC,GAAG,CAAC,OAAC,CAAC,MAAM,EAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvD,cAAc,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACtC,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAA;AAEW,QAAA,4BAA4B,GAAuC,OAAC,CAAC,MAAM,CAAC;IACxF,sBAAsB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9C,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,gBAAgB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACxC,cAAc,EAAE,kCAAqB,CAAC,QAAQ,EAAE;IAChD,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACjC,MAAM,EAAE,+BAAkB,CAAC,QAAQ,EAAE;IACrC,gBAAgB,EAAE,uCAAyB,CAAC,QAAQ,EAAE;IACtD,SAAS,EAAE,gCAAkB,CAAC,QAAQ,EAAE;IACxC,oBAAoB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC5C,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACzC,OAAO,EAAE,qBAAa,CAAC,QAAQ,EAAE;IACjC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,YAAY,EAAE,+BAAkB,CAAC,QAAQ,EAAE;IAC3C,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,eAAe,EAAE,uCAA0B,CAAC,QAAQ,EAAE;IACtD,UAAU,EAAC,6BAAe,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAC,6BAAe,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAC,6BAAe,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAC,6BAAe,CAAC,QAAQ,EAAE;IACrC,2BAA2B,EAAE,6BAAgB,CAAC,QAAQ,EAAE;CACxD,CAAC,CAAA"}
+{"version":3,"file":"renderSchema.js","sourceRoot":"","sources":["renderSchema.ts"],"names":[],"mappings":";;;AAAA,6BAAqB;AACrB,gDAW6B;AAC7B,6CAAyI;AACzI,+CAA4E;AAC5E,+CAA+D;AAElD,QAAA,iBAAiB,GAA4B,OAAC,CAAC,UAAU,CAAC,oBAAW,CAAC,CAAA;AAEtE,QAAA,wBAAwB,GAAkC,OAAC,CAAC,MAAM,CAAC;IAC/E,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oBAAW,CAAC,WAAW,CAAC;IACxC,KAAK,EAAE,OAAC;SACN,MAAM,EAAE;SACR,QAAQ,EAAE;CACZ,CAAC,CAAA;AAEW,QAAA,uBAAuB,GAAiC,OAAC,CAAC,MAAM,CAAC;IAC7E,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oBAAW,CAAC,UAAU,CAAC;IACvC,WAAW,EAAE,OAAC;SACZ,MAAM,EAAE;SACR,QAAQ,EAAE;CACZ,CAAC,CAAA;AAEW,QAAA,yBAAyB,GAAoC,OAAC,CAAC,MAAM,CAAC;IAClF,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oBAAW,CAAC,YAAY,CAAC;IACzC,mBAAmB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,qBAAqB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5C,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAA;AAEW,QAAA,yBAAyB,GAAoC,OAAC,CAAC,MAAM,CAAC;IAClF,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oBAAW,CAAC,YAAY,CAAC;IACzC,WAAW,EAAE,OAAC;SACZ,MAAM,EAAE;SACR,QAAQ,EAAE;CACZ,CAAC,CAAA;AAEW,QAAA,yBAAyB,GAAoC,OAAC,CAAC,MAAM,CAAC;IAClF,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oBAAW,CAAC,YAAY,CAAC;IACzC,WAAW,EAAE,OAAC;SACZ,MAAM,EAAE;SACR,QAAQ,EAAE;CACZ,CAAC,CAAA;AAEW,QAAA,qBAAqB,GAAgC,OAAC,CAAC,MAAM,CAAC;IAC1E,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oBAAW,CAAC,QAAQ,CAAC;CACrC,CAAC,CAAA;AAEW,QAAA,8BAA8B,GAAyC,OAAC,CAAC,MAAM,CAAC;IAC5F,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oBAAW,CAAC,WAAW,CAAC;IACxC,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE;IACxB,WAAW,EAAE,OAAC;SACZ,MAAM,EAAE;SACR,QAAQ,EAAE;CACZ,CAAC,CAAA;AAEW,QAAA,aAAa,GAAwB,OAAC,CAAC,KAAK,CAAC;IACzD,gCAAwB;IACxB,6BAAqB;IACrB,+BAAuB;IACvB,iCAAyB;IACzB,iCAAyB;IACzB,iCAAyB;IACzB,sCAA8B;CAC9B,CAAC,CAAA;AAEW,QAAA,0BAA0B,GAAqC,OAAC,CAAC,MAAM,CAAC;IACpF,cAAc,EAAE,OAAC,CAAC,GAAG,CAAC,OAAC,CAAC,MAAM,EAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvD,cAAc,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACtC,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAA;AAEW,QAAA,4BAA4B,GAAuC,OAAC,CAAC,MAAM,CAAC;IACxF,sBAAsB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9C,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,gBAAgB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACxC,cAAc,EAAE,kCAAqB,CAAC,QAAQ,EAAE;IAChD,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACjC,MAAM,EAAE,+BAAkB,CAAC,QAAQ,EAAE;IACrC,gBAAgB,EAAE,uCAAyB,CAAC,QAAQ,EAAE;IACtD,SAAS,EAAE,gCAAkB,CAAC,QAAQ,EAAE;IACxC,oBAAoB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC5C,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACzC,OAAO,EAAE,qBAAa,CAAC,QAAQ,EAAE;IACjC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,YAAY,EAAE,+BAAkB,CAAC,QAAQ,EAAE;IAC3C,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,eAAe,EAAE,uCAA0B,CAAC,QAAQ,EAAE;IACtD,UAAU,EAAC,6BAAe,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAC,6BAAe,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAC,6BAAe,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAC,6BAAe,CAAC,QAAQ,EAAE;IACrC,2BAA2B,EAAE,6BAAgB,CAAC,QAAQ,EAAE;IACxD,yBAAyB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACjD,2BAA2B,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACtE,2BAA2B,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACtE,wBAAwB,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACxD,qBAAqB,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACrD,CAAC,CAAA"}

package/src/internal/zod/renderSchema.ts

@@ -103,6 +103,11 @@ export const chromePdfRenderOptionsSchema : z.ZodType<ChromePdfRenderOptions> =
 	htmlFooter:htmlAffixSchema.optional(),
 	textHeader:textAffixSchema.optional(),
 	textFooter:textAffixSchema.optional(),
-	useMarginsOnHeaderAndFooter: useMarginsSchema.optional()
+	useMarginsOnHeaderAndFooter: useMarginsSchema.optional(),
+	autoBookmarksFromHeadings: z.boolean().optional(),
+	autoBookmarkMinHeadingLevel: z.number().int().min(1).max(6).optional(),
+	autoBookmarkMaxHeadingLevel: z.number().int().min(1).max(6).optional(),
+	autoBookmarkCssSelectors: z.array(z.string()).optional(),
+	elementQuerySelectors: z.array(z.string()).optional()
 })
 

package/src/public/annotation.d.ts

@@ -0,0 +1,166 @@
+/**
+ * Destination type that controls how a PDF reader displays the target page when a
+ * bookmark or internal hyperlink is followed.
+ *
+ * Mirrors {@code IronPdf.Bookmarks.BookmarkDestinations} on the C# side. The numeric
+ * value of each entry is what the engine expects on the wire, so the order must match
+ * the C# enum.
+ *
+ * Corresponds to the PDF 1.7 specification §12.3.2 "Explicit Destinations".
+ */
+export declare enum BookmarkDestinations {
+    /**
+     * Fit the entire destination page within the window (PDF {@code /Fit}).
+     * No additional coordinates are used.
+     */
+    Page = 0,
+    /**
+     * Scroll to a specific Y coordinate on the destination page while fitting the
+     * page width to the window (PDF {@code /FitH}).
+     * Uses {@link LinkAnnotation.destinationTop}.
+     */
+    PageY = 1,
+    /**
+     * Scroll to a specific X coordinate on the destination page while fitting the
+     * page height to the window (PDF {@code /FitV}).
+     * Uses {@link LinkAnnotation.destinationLeft}.
+     */
+    PageX = 2,
+    /**
+     * Scroll to a specific position and zoom level (PDF {@code /XYZ}).
+     * Uses {@link LinkAnnotation.destinationLeft}, {@link LinkAnnotation.destinationTop},
+     * and {@link LinkAnnotation.destinationZoom}. A {@code destinationZoom} of 0 means
+     * "inherit the current zoom".
+     */
+    PageZoom = 3,
+    /**
+     * Fit the specified rectangle of the destination page into the window (PDF {@code /FitR}).
+     * Uses {@link LinkAnnotation.destinationLeft}, {@link LinkAnnotation.destinationBottom},
+     * {@link LinkAnnotation.destinationRight}, and {@link LinkAnnotation.destinationTop}.
+     */
+    PageRect = 4,
+    /**
+     * Fit the bounding box of the destination page into the window (PDF {@code /FitB}).
+     */
+    PageBounds = 5,
+    /**
+     * Scroll to a Y coordinate while fitting the bounding box width to the window
+     * (PDF {@code /FitBH}). Uses {@link LinkAnnotation.destinationTop}.
+     */
+    PageBoundsY = 6,
+    /**
+     * Scroll to an X coordinate while fitting the bounding box height to the window
+     * (PDF {@code /FitBV}). Uses {@link LinkAnnotation.destinationLeft}.
+     */
+    PageBoundsX = 7
+}
+/**
+ * Defines a clickable link annotation that navigates to a specific page within the same
+ * PDF document. Useful for building custom tables of contents, cross-references, and
+ * in-document navigation.
+ *
+ * Mirrors {@code IronPdf.Annotations.LinkAnnotation} on the C# side.
+ *
+ * @example
+ * ```ts
+ * // Simple TOC link: from page 0 to page 3
+ * await pdf.addLinkAnnotation({
+ *     pageIndex: 0,
+ *     destinationPageIndex: 3,
+ *     x: 72, y: 700,
+ *     width: 300, height: 18,
+ *     contents: "Chapter 1 - Introduction",
+ * });
+ *
+ * // Scroll-to-position link: jump to y=400 on page 1
+ * await pdf.addLinkAnnotation({
+ *     pageIndex: 0,
+ *     destinationPageIndex: 1,
+ *     destinationType: BookmarkDestinations.PageZoom,
+ *     destinationTop: 400,
+ *     destinationZoom: 100,
+ *     x: 72, y: 650,
+ *     width: 300, height: 18,
+ * });
+ * ```
+ *
+ * <b>Coordinate note:</b> {@code y} sets the <em>bottom</em> edge of the clickable area
+ * using PDF coordinates (origin at bottom-left of page).
+ */
+export interface LinkAnnotation {
+    /** Zero-based index of the page where the link is placed. */
+    pageIndex: number;
+    /** Zero-based index of the page to navigate to when clicked. */
+    destinationPageIndex: number;
+    /**
+     * Destination type controlling how the target page is displayed.
+     * @default BookmarkDestinations.Page
+     */
+    destinationType?: BookmarkDestinations;
+    /**
+     * Left coordinate of the destination position, in points.
+     * Used by {@link BookmarkDestinations.PageZoom}, {@link BookmarkDestinations.PageX},
+     * {@link BookmarkDestinations.PageRect}, and {@link BookmarkDestinations.PageBoundsX}.
+     */
+    destinationLeft?: number;
+    /**
+     * Right coordinate of the destination position, in points.
+     * Used by {@link BookmarkDestinations.PageRect}.
+     */
+    destinationRight?: number;
+    /**
+     * Top coordinate of the destination position, in points.
+     * Used by {@link BookmarkDestinations.PageZoom}, {@link BookmarkDestinations.PageY},
+     * {@link BookmarkDestinations.PageRect}, and {@link BookmarkDestinations.PageBoundsY}.
+     */
+    destinationTop?: number;
+    /**
+     * Bottom coordinate of the destination position, in points.
+     * Used by {@link BookmarkDestinations.PageRect}.
+     */
+    destinationBottom?: number;
+    /**
+     * Zoom level (in percent) for the destination. Used by
+     * {@link BookmarkDestinations.PageZoom}. A value of 0 means inherit the current zoom.
+     */
+    destinationZoom?: number;
+    /**
+     * Horizontal X position from the LEFT edge of the page, in points.
+     */
+    x: number;
+    /**
+     * Vertical Y position from the BOTTOM edge of the page, in points.
+     * PDF coordinate system places Y=0 at the bottom of the page.
+     */
+    y: number;
+    /** Width of the clickable link area, in points. */
+    width: number;
+    /** Height of the clickable link area, in points. */
+    height: number;
+    /**
+     * Color code for the link border in CSS `#RRGGBB` format.
+     * @default undefined (no explicit color)
+     */
+    colorCode?: string;
+    /**
+     * Whether the link annotation is hidden from users.
+     * @default false
+     */
+    hidden?: boolean;
+    /**
+     * Descriptive text content for this link annotation.
+     * @default ""
+     */
+    contents?: string;
+    /**
+     * Title for this link annotation.
+     * @default ""
+     */
+    title?: string;
+    /**
+     * Whether the link annotation displays a visible border when clicked.
+     * @default false
+     */
+    showBorder?: boolean;
+}
+//# sourceMappingURL=annotation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"annotation.d.ts","sourceRoot":"","sources":["annotation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,oBAAY,oBAAoB;IAC/B;;;OAGG;IACH,IAAI,IAAI;IACR;;;;OAIG;IACH,KAAK,IAAI;IACT;;;;OAIG;IACH,KAAK,IAAI;IACT;;;;;OAKG;IACH,QAAQ,IAAI;IACZ;;;;OAIG;IACH,QAAQ,IAAI;IACZ;;OAEG;IACH,UAAU,IAAI;IACd;;;OAGG;IACH,WAAW,IAAI;IACf;;;OAGG;IACH,WAAW,IAAI;CACf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,WAAW,cAAc;IAC9B,6DAA6D;IAC7D,SAAS,EAAE,MAAM,CAAC;IAClB,gEAAgE;IAChE,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,eAAe,CAAC,EAAE,oBAAoB,CAAC;IACvC;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,CAAC,EAAE,MAAM,CAAC;IACV;;;OAGG;IACH,CAAC,EAAE,MAAM,CAAC;IACV,mDAAmD;IACnD,KAAK,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACrB"}

package/src/public/annotation.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BookmarkDestinations = void 0;
+/**
+ * Destination type that controls how a PDF reader displays the target page when a
+ * bookmark or internal hyperlink is followed.
+ *
+ * Mirrors {@code IronPdf.Bookmarks.BookmarkDestinations} on the C# side. The numeric
+ * value of each entry is what the engine expects on the wire, so the order must match
+ * the C# enum.
+ *
+ * Corresponds to the PDF 1.7 specification §12.3.2 "Explicit Destinations".
+ */
+var BookmarkDestinations;
+(function (BookmarkDestinations) {
+    /**
+     * Fit the entire destination page within the window (PDF {@code /Fit}).
+     * No additional coordinates are used.
+     */
+    BookmarkDestinations[BookmarkDestinations["Page"] = 0] = "Page";
+    /**
+     * Scroll to a specific Y coordinate on the destination page while fitting the
+     * page width to the window (PDF {@code /FitH}).
+     * Uses {@link LinkAnnotation.destinationTop}.
+     */
+    BookmarkDestinations[BookmarkDestinations["PageY"] = 1] = "PageY";
+    /**
+     * Scroll to a specific X coordinate on the destination page while fitting the
+     * page height to the window (PDF {@code /FitV}).
+     * Uses {@link LinkAnnotation.destinationLeft}.
+     */
+    BookmarkDestinations[BookmarkDestinations["PageX"] = 2] = "PageX";
+    /**
+     * Scroll to a specific position and zoom level (PDF {@code /XYZ}).
+     * Uses {@link LinkAnnotation.destinationLeft}, {@link LinkAnnotation.destinationTop},
+     * and {@link LinkAnnotation.destinationZoom}. A {@code destinationZoom} of 0 means
+     * "inherit the current zoom".
+     */
+    BookmarkDestinations[BookmarkDestinations["PageZoom"] = 3] = "PageZoom";
+    /**
+     * Fit the specified rectangle of the destination page into the window (PDF {@code /FitR}).
+     * Uses {@link LinkAnnotation.destinationLeft}, {@link LinkAnnotation.destinationBottom},
+     * {@link LinkAnnotation.destinationRight}, and {@link LinkAnnotation.destinationTop}.
+     */
+    BookmarkDestinations[BookmarkDestinations["PageRect"] = 4] = "PageRect";
+    /**
+     * Fit the bounding box of the destination page into the window (PDF {@code /FitB}).
+     */
+    BookmarkDestinations[BookmarkDestinations["PageBounds"] = 5] = "PageBounds";
+    /**
+     * Scroll to a Y coordinate while fitting the bounding box width to the window
+     * (PDF {@code /FitBH}). Uses {@link LinkAnnotation.destinationTop}.
+     */
+    BookmarkDestinations[BookmarkDestinations["PageBoundsY"] = 6] = "PageBoundsY";
+    /**
+     * Scroll to an X coordinate while fitting the bounding box height to the window
+     * (PDF {@code /FitBV}). Uses {@link LinkAnnotation.destinationLeft}.
+     */
+    BookmarkDestinations[BookmarkDestinations["PageBoundsX"] = 7] = "PageBoundsX";
+})(BookmarkDestinations = exports.BookmarkDestinations || (exports.BookmarkDestinations = {}));
+//# sourceMappingURL=annotation.js.map

package/src/public/annotation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotation.js","sourceRoot":"","sources":["annotation.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;GASG;AACH,IAAY,oBA6CX;AA7CD,WAAY,oBAAoB;IAC/B;;;OAGG;IACH,+DAAQ,CAAA;IACR;;;;OAIG;IACH,iEAAS,CAAA;IACT;;;;OAIG;IACH,iEAAS,CAAA;IACT;;;;;OAKG;IACH,uEAAY,CAAA;IACZ;;;;OAIG;IACH,uEAAY,CAAA;IACZ;;OAEG;IACH,2EAAc,CAAA;IACd;;;OAGG;IACH,6EAAe,CAAA;IACf;;;OAGG;IACH,6EAAe,CAAA;AAChB,CAAC,EA7CW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QA6C/B"}