@pdfme/common 6.1.0 → 6.1.1-dev.4

package/dist/dynamicTemplate.d.ts

@@ -1,4 +1,4 @@
-import { Schema, Template, BasePdf, CommonOptions } from './types.js';
+import { Schema, Template, BasePdf, CommonOptions, DynamicLayoutCallbackResult } from './types.js';
 interface ModifyTemplateForDynamicTableArg {
     template: Template;
     input: Record<string, string>;
@@ -9,7 +9,7 @@ interface ModifyTemplateForDynamicTableArg {
         basePdf: BasePdf;
         options: CommonOptions;
         _cache: Map<string | number, unknown>;
-    }) => Promise<number[]>;
+    }) => Promise<DynamicLayoutCallbackResult>;
 }
 /**
  * Process a template containing tables with dynamic heights

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 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 } from './types.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 { 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, };
+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, };

package/dist/index.js

@@ -2,7 +2,7 @@ import { z } from "zod";
 import { Buffer } from "buffer";
 import * as acorn from "acorn";
 //#region src/version.ts
-var PDFME_VERSION = "6.1.0";
+var PDFME_VERSION = "6.1.1";
 //#endregion
 //#region src/constants.ts
 var PT_TO_PX_RATIO = 1.333;
@@ -133,7 +133,18 @@ z.object({
 	"schemas.date.locale": z.string(),
 	"schemas.select.options": z.string(),
 	"schemas.select.optionPlaceholder": z.string(),
-	"schemas.radioGroup.groupName": z.string()
+	"schemas.radioGroup.groupName": z.string(),
+	"schemas.list.listStyle": z.string(),
+	"schemas.list.bullet": z.string(),
+	"schemas.list.ordered": z.string(),
+	"schemas.list.markerWidth": z.string(),
+	"schemas.list.markerGap": z.string(),
+	"schemas.list.indentSize": z.string(),
+	"schemas.list.itemSpacing": z.string(),
+	"schemas.list.addItem": z.string(),
+	"schemas.list.removeItem": z.string(),
+	"schemas.list.indentItem": z.string(),
+	"schemas.list.outdentItem": z.string()
 });
 z.enum([
 	"viewer",
@@ -163,6 +174,10 @@ var Schema = z.object({
 		start: z.number(),
 		end: z.number().optional()
 	}).optional(),
+	__itemRange: z.object({
+		start: z.number(),
+		end: z.number().optional()
+	}).optional(),
 	__isSplit: z.boolean().optional()
 }).passthrough();
 var SchemaForUIAdditionalInfo = z.object({ id: z.string() });
@@ -451,7 +466,7 @@ function normalizePageSchemas(pageSchemas, paddingTop) {
 			schema: cloneDeep(schema),
 			baseY: localY,
 			height: schema.height,
-			dynamicHeights: [schema.height]
+			dynamicLayout: { heights: [schema.height] }
 		});
 		orderMap.set(schema.name, index);
 	});
@@ -465,20 +480,21 @@ function normalizePageSchemas(pageSchemas, paddingTop) {
 	};
 }
 /**
-* Place rows on pages, splitting across pages as needed.
+* Place height units on pages, splitting across pages as needed.
 * @returns The final global Y coordinate after placement
 */
-function placeRowsOnPages(schema, dynamicHeights, startGlobalY, contentHeight, paddingTop, pages) {
-	let currentRowIndex = 0;
+function placeUnitsOnPages(schema, dynamicLayout, startGlobalY, contentHeight, paddingTop, pages) {
+	const dynamicHeights = dynamicLayout.heights;
+	let currentUnitIndex = 0;
 	let currentPageIndex = Math.floor(startGlobalY / contentHeight);
 	let currentYInPage = startGlobalY % contentHeight;
 	if (currentYInPage < 0) currentYInPage = 0;
 	let actualGlobalEndY = 0;
 	const isSplittable = dynamicHeights.length > 1;
-	while (currentRowIndex < dynamicHeights.length) {
+	while (currentUnitIndex < dynamicHeights.length) {
 		while (pages.length <= currentPageIndex) pages.push([]);
 		const spaceLeft = contentHeight - currentYInPage;
-		if (dynamicHeights[currentRowIndex] > spaceLeft + EPSILON) {
+		if (dynamicHeights[currentUnitIndex] > spaceLeft + EPSILON) {
 			if (!(Math.abs(spaceLeft - contentHeight) <= EPSILON)) {
 				currentPageIndex++;
 				currentYInPage = 0;
@@ -486,40 +502,41 @@ function placeRowsOnPages(schema, dynamicHeights, startGlobalY, contentHeight, p
 			}
 		}
 		let chunkHeight = 0;
-		const startRowIndex = currentRowIndex;
-		while (currentRowIndex < dynamicHeights.length) {
-			const h = dynamicHeights[currentRowIndex];
+		const startUnitIndex = currentUnitIndex;
+		while (currentUnitIndex < dynamicHeights.length) {
+			const h = dynamicHeights[currentUnitIndex];
 			if (currentYInPage + chunkHeight + h <= contentHeight + EPSILON) {
 				chunkHeight += h;
-				currentRowIndex++;
+				currentUnitIndex++;
 			} else break;
 		}
 		const isAtPageTop = currentYInPage <= EPSILON;
-		if (isSplittable && startRowIndex === 0 && currentRowIndex === 1 && dynamicHeights.length > 1 && !isAtPageTop) {
-			currentRowIndex = 0;
+		if (dynamicLayout.avoidFirstUnitOnly && isSplittable && startUnitIndex === 0 && currentUnitIndex === 1 && dynamicHeights.length > 1 && !isAtPageTop) {
+			currentUnitIndex = 0;
 			currentPageIndex++;
 			currentYInPage = 0;
 			continue;
 		}
-		if (currentRowIndex === startRowIndex) {
-			chunkHeight += dynamicHeights[currentRowIndex];
-			currentRowIndex++;
+		if (currentUnitIndex === startUnitIndex) {
+			chunkHeight += dynamicHeights[currentUnitIndex];
+			currentUnitIndex++;
 		}
+		const patch = dynamicLayout.patchSplitSchema?.({
+			schema,
+			start: startUnitIndex,
+			end: currentUnitIndex,
+			isSplit: startUnitIndex > 0,
+			chunkHeight
+		}) ?? {};
 		const newSchema = {
 			...schema,
+			...patch,
 			height: chunkHeight,
 			position: {
 				...schema.position,
 				y: currentYInPage + paddingTop
 			}
 		};
-		if (isSplittable) {
-			newSchema.__bodyRange = {
-				start: startRowIndex === 0 ? 0 : startRowIndex - 1,
-				end: currentRowIndex - 1
-			};
-			newSchema.__isSplit = startRowIndex > 0;
-		}
 		pages[currentPageIndex].push(newSchema);
 		currentYInPage += chunkHeight;
 		if (currentYInPage >= contentHeight - EPSILON) {
@@ -550,12 +567,19 @@ function processDynamicPage(items, orderMap, contentHeight, paddingTop) {
 	let totalYOffset = 0;
 	for (const item of items) {
 		const currentGlobalStartY = item.baseY + totalYOffset;
-		totalYOffset = placeRowsOnPages(item.schema, item.dynamicHeights, currentGlobalStartY, contentHeight, paddingTop, pages) - (item.baseY + item.height);
+		totalYOffset = placeUnitsOnPages(item.schema, item.dynamicLayout, currentGlobalStartY, contentHeight, paddingTop, pages) - (item.baseY + item.height);
 	}
 	sortPagesByOrder(pages, orderMap);
 	removeTrailingEmptyPages(pages);
 	return pages;
 }
+var normalizeDynamicLayoutResult = (result) => {
+	const dynamicLayout = Array.isArray(result) ? { heights: result } : result;
+	return {
+		...dynamicLayout,
+		heights: dynamicLayout.heights.length === 0 ? [0] : dynamicLayout.heights
+	};
+};
 /**
 * Process a template containing tables with dynamic heights
 * and generate a new template with proper page breaks.
@@ -587,9 +611,9 @@ var getDynamicTemplate = async (arg) => {
 					basePdf,
 					options,
 					_cache
-				}).then((heights) => heights.length === 0 ? [0] : heights);
+				}).then(normalizeDynamicLayoutResult);
 			}));
-			for (let j = 0; j < chunkResults.length; j++) items[i + j].dynamicHeights = chunkResults[j];
+			for (let j = 0; j < chunkResults.length; j++) items[i + j].dynamicLayout = chunkResults[j];
 		}
 		const processedPages = processDynamicPage(items, orderMap, contentHeight, paddingTop);
 		resultPages.push(...processedPages);