@pdfme/common 6.1.1-dev.4 → 6.1.1-dev.7

package/dist/helper.d.ts

@@ -1,3 +1,4 @@
+import type { PDFDocument, PDFPage } from '@pdfme/pdf-lib';
 import { Template, Font, BasePdf, Plugins, BlankPdf } from './types.js';
 export declare const cloneDeep: typeof structuredClone;
 export declare const getFallbackFontName: (font: Font) => string;
@@ -16,6 +17,35 @@ export declare const getInputFromTemplate: (template: Template) => {
     [key: string]: string;
 }[];
 export declare const isUrlSafeToFetch: (urlString: string) => boolean;
+export type PdfLinkAnnotationRect = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+export declare const normalizeSafeLinkUri: (uri: string) => string | undefined;
+export declare const getInternalLinkTarget: (href: string) => string | undefined;
+export declare const normalizeInternalLinkHref: (href: string) => string | undefined;
+export declare const normalizeLinkHref: (href: string) => string | undefined;
+export declare const resetInternalLinkAnnotations: (_cache: Map<string | number, unknown>) => void;
+export declare const registerInternalLinkAnchor: (arg: {
+    _cache: Map<string | number, unknown>;
+    name: string;
+    page: PDFPage;
+    x: number;
+    y: number;
+}) => void;
+export declare const registerInternalLinkAnnotation: (arg: {
+    _cache: Map<string | number, unknown>;
+    page: PDFPage;
+    targetName: string;
+    rect: PdfLinkAnnotationRect;
+    borderWidth?: number;
+}) => void;
+export declare const applyInternalLinkAnnotations: (arg: {
+    _cache: Map<string | number, unknown>;
+    pdfDoc: PDFDocument;
+}) => void;
 export declare const getB64BasePdf: (customPdf: ArrayBuffer | Uint8Array | string) => Promise<string>;
 export declare const isBlankPdf: (basePdf: BasePdf) => basePdf is BlankPdf;
 export declare const b64toUint8Array: (base64: string) => Uint8Array<ArrayBuffer>;

package/dist/index.d.ts

@@ -1,9 +1,12 @@
 import { PDFME_VERSION } from './version.js';
 import { MM_TO_PT_RATIO, PT_TO_MM_RATIO, PT_TO_PX_RATIO, BLANK_PDF, BLANK_A4_PDF, CUSTOM_A4_PDF, ZOOM, DEFAULT_FONT_NAME } from './constants.js';
 import type { ChangeSchemaItem, ChangeSchemas, SchemaPageArray, PropPanel, PropPanelSchema, PropPanelWidgetProps, PDFRenderProps, Mode, UIRenderProps, Plugin, Lang, Dict, Size, Schema, SchemaForUI, Font, ColorType, BasePdf, BlankPdf, CustomPdf, Template, CommonOptions, GeneratorOptions, Plugins, PluginRegistry, GenerateProps, UIOptions, UIProps, PreviewProps, DesignerProps, DynamicLayoutArgs, DynamicLayoutCallbackResult, DynamicLayoutPatchArgs, DynamicLayoutResult, GetDynamicLayout } from './types.js';
-import { cloneDeep, getFallbackFontName, getDefaultFont, getB64BasePdf, b64toUint8Array, checkFont, checkInputs, checkUIOptions, checkTemplate, checkUIProps, checkPreviewProps, checkDesignerProps, checkGenerateProps, mm2pt, pt2mm, pt2px, px2mm, isHexValid, getInputFromTemplate, isBlankPdf, isUrlSafeToFetch } from './helper.js';
+import type { PdfLinkAnnotationRect } from './helper.js';
+import type { PageOrientation, PageSize, PageSizePreset } from './pageSize.js';
+import { cloneDeep, getFallbackFontName, getDefaultFont, getB64BasePdf, b64toUint8Array, checkFont, checkInputs, checkUIOptions, checkTemplate, checkUIProps, checkPreviewProps, checkDesignerProps, checkGenerateProps, mm2pt, pt2mm, pt2px, px2mm, isHexValid, getInputFromTemplate, isBlankPdf, isUrlSafeToFetch, getInternalLinkTarget, normalizeInternalLinkHref, normalizeLinkHref, normalizeSafeLinkUri, registerInternalLinkAnchor, registerInternalLinkAnnotation, resetInternalLinkAnnotations, applyInternalLinkAnnotations } from './helper.js';
+import { PAGE_SIZE_PRESETS, detectPaperSize, resolvePageSize } from './pageSize.js';
 import { getDynamicTemplate } from './dynamicTemplate.js';
 import { replacePlaceholders } from './expression.js';
 import { pluginRegistry } from './pluginRegistry.js';
-export { PDFME_VERSION, MM_TO_PT_RATIO, PT_TO_MM_RATIO, PT_TO_PX_RATIO, BLANK_PDF, BLANK_A4_PDF, CUSTOM_A4_PDF, ZOOM, DEFAULT_FONT_NAME, cloneDeep, getFallbackFontName, getDefaultFont, getB64BasePdf, b64toUint8Array, mm2pt, pt2mm, pt2px, px2mm, isHexValid, getInputFromTemplate, isBlankPdf, getDynamicTemplate, replacePlaceholders, checkFont, checkInputs, checkUIOptions, checkTemplate, checkUIProps, checkPreviewProps, checkDesignerProps, checkGenerateProps, pluginRegistry, isUrlSafeToFetch, };
-export type { Lang, Dict, Size, Schema, SchemaForUI, Font, ColorType, BasePdf, BlankPdf, CustomPdf, Template, CommonOptions, GeneratorOptions, Plugin, Plugins, PluginRegistry, GenerateProps, UIOptions, UIProps, PreviewProps, DesignerProps, ChangeSchemaItem, ChangeSchemas, SchemaPageArray, PropPanel, PropPanelSchema, PropPanelWidgetProps, PDFRenderProps, UIRenderProps, Mode, DynamicLayoutArgs, DynamicLayoutCallbackResult, DynamicLayoutPatchArgs, DynamicLayoutResult, GetDynamicLayout, };
+export { PDFME_VERSION, MM_TO_PT_RATIO, PT_TO_MM_RATIO, PT_TO_PX_RATIO, BLANK_PDF, BLANK_A4_PDF, CUSTOM_A4_PDF, ZOOM, DEFAULT_FONT_NAME, cloneDeep, getFallbackFontName, getDefaultFont, getB64BasePdf, b64toUint8Array, mm2pt, pt2mm, pt2px, px2mm, isHexValid, getInputFromTemplate, isBlankPdf, getDynamicTemplate, replacePlaceholders, checkFont, checkInputs, checkUIOptions, checkTemplate, checkUIProps, checkPreviewProps, checkDesignerProps, checkGenerateProps, pluginRegistry, isUrlSafeToFetch, getInternalLinkTarget, normalizeInternalLinkHref, normalizeLinkHref, normalizeSafeLinkUri, registerInternalLinkAnchor, registerInternalLinkAnnotation, resetInternalLinkAnnotations, applyInternalLinkAnnotations, PAGE_SIZE_PRESETS, detectPaperSize, resolvePageSize, };
+export type { Lang, Dict, Size, Schema, SchemaForUI, Font, ColorType, BasePdf, BlankPdf, CustomPdf, Template, CommonOptions, GeneratorOptions, Plugin, Plugins, PluginRegistry, GenerateProps, UIOptions, UIProps, PreviewProps, DesignerProps, ChangeSchemaItem, ChangeSchemas, SchemaPageArray, PropPanel, PropPanelSchema, PropPanelWidgetProps, PDFRenderProps, UIRenderProps, Mode, DynamicLayoutArgs, DynamicLayoutCallbackResult, DynamicLayoutPatchArgs, DynamicLayoutResult, GetDynamicLayout, PdfLinkAnnotationRect, PageOrientation, PageSize, PageSizePreset, };

package/dist/index.js

@@ -1,9 +1,74 @@
 import { z } from "zod";
 import { Buffer } from "buffer";
+import { PDFName } from "@pdfme/pdf-lib";
 import * as acorn from "acorn";
 //#region src/version.ts
 var PDFME_VERSION = "6.1.1";
 //#endregion
+//#region src/pageSize.ts
+var PAGE_SIZE_PRESETS = {
+	A3: {
+		width: 297,
+		height: 420
+	},
+	A4: {
+		width: 210,
+		height: 297
+	},
+	A5: {
+		width: 148,
+		height: 210
+	},
+	A6: {
+		width: 105,
+		height: 148
+	},
+	B4: {
+		width: 250,
+		height: 353
+	},
+	B5: {
+		width: 176,
+		height: 250
+	},
+	B6: {
+		width: 125,
+		height: 176
+	},
+	Letter: {
+		width: 215.9,
+		height: 279.4
+	},
+	Legal: {
+		width: 215.9,
+		height: 355.6
+	},
+	Tabloid: {
+		width: 279.4,
+		height: 431.8
+	}
+};
+var resolvePageSize = (size = "A4", orientation = "portrait") => {
+	const resolved = typeof size === "string" ? PAGE_SIZE_PRESETS[size] : {
+		width: size.width,
+		height: size.height
+	};
+	if (!resolved) throw new Error(`@pdfme/common: unknown page size preset "${String(size)}"`);
+	if (orientation === "landscape") return {
+		width: resolved.height,
+		height: resolved.width
+	};
+	return {
+		width: resolved.width,
+		height: resolved.height
+	};
+};
+var detectPaperSize = (width, height, tolerance = 2) => {
+	const entries = Object.entries(PAGE_SIZE_PRESETS);
+	for (const [name, size] of entries) if (Math.abs(width - size.width) <= tolerance && Math.abs(height - size.height) <= tolerance || Math.abs(width - size.height) <= tolerance && Math.abs(height - size.width) <= tolerance) return `${name} ${width < height ? "portrait" : "landscape"}`;
+	return null;
+};
+//#endregion
 //#region src/constants.ts
 var PT_TO_PX_RATIO = 1.333;
 var PT_TO_MM_RATIO = .3528;
@@ -13,8 +78,7 @@ var ZOOM = 3.7795275591;
 * Blank A4 PDF size.
 */
 var BLANK_A4_PDF = {
-	width: 210,
-	height: 297,
+	...PAGE_SIZE_PRESETS.A4,
 	padding: [
 		10,
 		10,
@@ -365,6 +429,130 @@ var isUrlSafeToFetch = (urlString) => {
 	}
 	return true;
 };
+var SAFE_LINK_URI_PROTOCOLS = new Set([
+	"http:",
+	"https:",
+	"mailto:"
+]);
+var INTERNAL_LINK_CACHE_KEY = "pdfme-internal-link-cache";
+var normalizeSafeLinkUri = (uri) => {
+	const trimmed = uri.trim();
+	if (!trimmed) return void 0;
+	let parsed;
+	try {
+		parsed = new URL(trimmed);
+	} catch {
+		return;
+	}
+	return SAFE_LINK_URI_PROTOCOLS.has(parsed.protocol.toLowerCase()) ? trimmed : void 0;
+};
+var getInternalLinkTarget = (href) => {
+	const trimmed = href.trim();
+	if (!trimmed.startsWith("#") || trimmed.length === 1) return void 0;
+	let target = trimmed.slice(1);
+	try {
+		target = decodeURIComponent(target);
+	} catch {}
+	target = target.trim();
+	if (!target || Array.from(target).some((char) => {
+		const code = char.charCodeAt(0);
+		return code < 32 || code === 127;
+	})) return;
+	return target;
+};
+var normalizeInternalLinkHref = (href) => {
+	const target = getInternalLinkTarget(href);
+	return target ? `#${target}` : void 0;
+};
+var normalizeLinkHref = (href) => normalizeSafeLinkUri(href) ?? normalizeInternalLinkHref(href);
+var getInternalLinkCache = (_cache) => {
+	let cache = _cache.get(INTERNAL_LINK_CACHE_KEY);
+	if (!cache) {
+		cache = {
+			anchors: /* @__PURE__ */ new Map(),
+			annotations: []
+		};
+		_cache.set(INTERNAL_LINK_CACHE_KEY, cache);
+	}
+	return cache;
+};
+var resetInternalLinkAnnotations = (_cache) => {
+	_cache.set(INTERNAL_LINK_CACHE_KEY, {
+		anchors: /* @__PURE__ */ new Map(),
+		annotations: []
+	});
+};
+var registerInternalLinkAnchor = (arg) => {
+	const { _cache, name, page, x, y } = arg;
+	if (!name) return;
+	const cache = getInternalLinkCache(_cache);
+	const anchors = cache.anchors.get(name) ?? [];
+	anchors.push({
+		name,
+		page,
+		x,
+		y
+	});
+	cache.anchors.set(name, anchors);
+};
+var registerInternalLinkAnnotation = (arg) => {
+	const { _cache, page, targetName, rect, borderWidth } = arg;
+	if (!targetName || rect.width <= 0 || rect.height <= 0) return;
+	getInternalLinkCache(_cache).annotations.push({
+		page,
+		targetName,
+		rect,
+		borderWidth
+	});
+};
+var addGoToLinkAnnotation = (arg) => {
+	const { pdfDoc, page, target, rect, borderWidth = 0 } = arg;
+	if (rect.width <= 0 || rect.height <= 0) return;
+	const annotationRef = pdfDoc.context.register(pdfDoc.context.obj({
+		Type: PDFName.of("Annot"),
+		Subtype: PDFName.of("Link"),
+		Rect: [
+			rect.x,
+			rect.y,
+			rect.x + rect.width,
+			rect.y + rect.height
+		],
+		Border: [
+			0,
+			0,
+			borderWidth
+		],
+		A: {
+			Type: PDFName.of("Action"),
+			S: PDFName.of("GoTo"),
+			D: [
+				target.page.ref,
+				PDFName.of("XYZ"),
+				target.x,
+				target.y,
+				null
+			]
+		}
+	}));
+	page.node.addAnnot(annotationRef);
+};
+var applyInternalLinkAnnotations = (arg) => {
+	const { _cache, pdfDoc } = arg;
+	const cache = getInternalLinkCache(_cache);
+	cache.annotations.forEach((annotation) => {
+		const anchors = cache.anchors.get(annotation.targetName) ?? [];
+		if (anchors.length === 0) throw new Error(`[@pdfme/generator] Internal link target "#${annotation.targetName}" was not found.`);
+		if (anchors.length > 1) throw new Error(`[@pdfme/generator] Internal link target "#${annotation.targetName}" is ambiguous because multiple schemas use that name.`);
+		addGoToLinkAnnotation({
+			pdfDoc,
+			page: annotation.page,
+			target: anchors[0],
+			rect: annotation.rect,
+			borderWidth: annotation.borderWidth
+		});
+	});
+	resetInternalLinkAnnotations(_cache);
+};
 var getB64BasePdf = async (customPdf) => {
 	if (typeof customPdf === "string" && !customPdf.startsWith("data:application/pdf;") && typeof window !== "undefined") {
 		if (!isUrlSafeToFetch(customPdf)) throw Error("[@pdfme/common] Invalid or unsafe URL for basePdf. Only http: and https: URLs pointing to public hosts are allowed.");
@@ -985,6 +1173,6 @@ var pluginRegistry = (plugins) => {
 	};
 };
 //#endregion
-export { BLANK_A4_PDF, BLANK_PDF, CUSTOM_A4_PDF, DEFAULT_FONT_NAME, MM_TO_PT_RATIO, PDFME_VERSION, PT_TO_MM_RATIO, PT_TO_PX_RATIO, ZOOM, b64toUint8Array, checkDesignerProps, checkFont, checkGenerateProps, checkInputs, checkPreviewProps, checkTemplate, checkUIOptions, checkUIProps, cloneDeep, getB64BasePdf, getDefaultFont, getDynamicTemplate, getFallbackFontName, getInputFromTemplate, isBlankPdf, isHexValid, isUrlSafeToFetch, mm2pt, pluginRegistry, pt2mm, pt2px, px2mm, replacePlaceholders };
+export { BLANK_A4_PDF, BLANK_PDF, CUSTOM_A4_PDF, DEFAULT_FONT_NAME, MM_TO_PT_RATIO, PAGE_SIZE_PRESETS, PDFME_VERSION, PT_TO_MM_RATIO, PT_TO_PX_RATIO, ZOOM, applyInternalLinkAnnotations, b64toUint8Array, checkDesignerProps, checkFont, checkGenerateProps, checkInputs, checkPreviewProps, checkTemplate, checkUIOptions, checkUIProps, cloneDeep, detectPaperSize, getB64BasePdf, getDefaultFont, getDynamicTemplate, getFallbackFontName, getInputFromTemplate, getInternalLinkTarget, isBlankPdf, isHexValid, isUrlSafeToFetch, mm2pt, normalizeInternalLinkHref, normalizeLinkHref, normalizeSafeLinkUri, pluginRegistry, pt2mm, pt2px, px2mm, registerInternalLinkAnchor, registerInternalLinkAnnotation, replacePlaceholders, resetInternalLinkAnnotations, resolvePageSize };
 
 //# sourceMappingURL=index.js.map