@pdfme/common 6.1.0 → 6.1.1-dev.11

package/dist/pageSize.d.ts

@@ -0,0 +1,53 @@
+export type PageOrientation = 'portrait' | 'landscape';
+export declare const PAGE_SIZE_PRESETS: {
+    readonly A3: {
+        readonly width: 297;
+        readonly height: 420;
+    };
+    readonly A4: {
+        readonly width: 210;
+        readonly height: 297;
+    };
+    readonly A5: {
+        readonly width: 148;
+        readonly height: 210;
+    };
+    readonly A6: {
+        readonly width: 105;
+        readonly height: 148;
+    };
+    readonly B4: {
+        readonly width: 250;
+        readonly height: 353;
+    };
+    readonly B5: {
+        readonly width: 176;
+        readonly height: 250;
+    };
+    readonly B6: {
+        readonly width: 125;
+        readonly height: 176;
+    };
+    readonly Letter: {
+        readonly width: 215.9;
+        readonly height: 279.4;
+    };
+    readonly Legal: {
+        readonly width: 215.9;
+        readonly height: 355.6;
+    };
+    readonly Tabloid: {
+        readonly width: 279.4;
+        readonly height: 431.8;
+    };
+};
+export type PageSizePreset = keyof typeof PAGE_SIZE_PRESETS;
+export type PageSize = PageSizePreset | {
+    width: number;
+    height: number;
+};
+export declare const resolvePageSize: (size?: PageSize, orientation?: PageOrientation) => {
+    width: number;
+    height: number;
+};
+export declare const detectPaperSize: (width: number, height: number, tolerance?: number) => `${PageSizePreset} ${PageOrientation}` | null;

package/dist/schema.d.ts

@@ -70,6 +70,9 @@ export declare const Dict: z.ZodObject<{
     'schemas.text.max': z.ZodString;
     'schemas.text.fit': z.ZodString;
     'schemas.text.dynamicFontSize': z.ZodString;
+    'schemas.text.overflow': z.ZodString;
+    'schemas.text.overflowVisible': z.ZodString;
+    'schemas.text.overflowExpand': z.ZodString;
     'schemas.text.format': z.ZodString;
     'schemas.text.plain': z.ZodString;
     'schemas.text.inlineMarkdown': z.ZodString;
@@ -100,6 +103,17 @@ export declare const Dict: z.ZodObject<{
     'schemas.select.options': z.ZodString;
     'schemas.select.optionPlaceholder': z.ZodString;
     'schemas.radioGroup.groupName': z.ZodString;
+    'schemas.list.listStyle': z.ZodString;
+    'schemas.list.bullet': z.ZodString;
+    'schemas.list.ordered': z.ZodString;
+    'schemas.list.markerWidth': z.ZodString;
+    'schemas.list.markerGap': z.ZodString;
+    'schemas.list.indentSize': z.ZodString;
+    'schemas.list.itemSpacing': z.ZodString;
+    'schemas.list.addItem': z.ZodString;
+    'schemas.list.removeItem': z.ZodString;
+    'schemas.list.indentItem': z.ZodString;
+    'schemas.list.outdentItem': z.ZodString;
 }, z.core.$strip>;
 export declare const Mode: z.ZodEnum<{
     viewer: "viewer";
@@ -114,6 +128,11 @@ export declare const Size: z.ZodObject<{
     height: z.ZodNumber;
     width: z.ZodNumber;
 }, z.core.$strip>;
+export declare const DynamicLayoutSplitRange: z.ZodObject<{
+    unit: z.ZodString;
+    start: z.ZodNumber;
+    end: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
 export declare const Schema: z.ZodObject<{
     name: z.ZodString;
     type: z.ZodString;
@@ -128,7 +147,8 @@ export declare const Schema: z.ZodObject<{
     opacity: z.ZodOptional<z.ZodNumber>;
     readOnly: z.ZodOptional<z.ZodBoolean>;
     required: z.ZodOptional<z.ZodBoolean>;
-    __bodyRange: z.ZodOptional<z.ZodObject<{
+    __splitRange: z.ZodOptional<z.ZodObject<{
+        unit: z.ZodString;
         start: z.ZodNumber;
         end: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>;
@@ -148,7 +168,8 @@ export declare const SchemaForUI: z.ZodObject<{
     opacity: z.ZodOptional<z.ZodNumber>;
     readOnly: z.ZodOptional<z.ZodBoolean>;
     required: z.ZodOptional<z.ZodBoolean>;
-    __bodyRange: z.ZodOptional<z.ZodObject<{
+    __splitRange: z.ZodOptional<z.ZodObject<{
+        unit: z.ZodString;
         start: z.ZodNumber;
         end: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>;
@@ -173,7 +194,8 @@ export declare const BlankPdf: z.ZodObject<{
         opacity: z.ZodOptional<z.ZodNumber>;
         readOnly: z.ZodOptional<z.ZodBoolean>;
         required: z.ZodOptional<z.ZodBoolean>;
-        __bodyRange: z.ZodOptional<z.ZodObject<{
+        __splitRange: z.ZodOptional<z.ZodObject<{
+            unit: z.ZodString;
             start: z.ZodNumber;
             end: z.ZodOptional<z.ZodNumber>;
         }, z.core.$strip>>;
@@ -199,7 +221,8 @@ export declare const BasePdf: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodStr
         opacity: z.ZodOptional<z.ZodNumber>;
         readOnly: z.ZodOptional<z.ZodBoolean>;
         required: z.ZodOptional<z.ZodBoolean>;
-        __bodyRange: z.ZodOptional<z.ZodObject<{
+        __splitRange: z.ZodOptional<z.ZodObject<{
+            unit: z.ZodString;
             start: z.ZodNumber;
             end: z.ZodOptional<z.ZodNumber>;
         }, z.core.$strip>>;
@@ -220,7 +243,8 @@ export declare const LegacySchemaPageArray: z.ZodArray<z.ZodRecord<z.ZodString,
     opacity: z.ZodOptional<z.ZodNumber>;
     readOnly: z.ZodOptional<z.ZodBoolean>;
     required: z.ZodOptional<z.ZodBoolean>;
-    __bodyRange: z.ZodOptional<z.ZodObject<{
+    __splitRange: z.ZodOptional<z.ZodObject<{
+        unit: z.ZodString;
         start: z.ZodNumber;
         end: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>;
@@ -240,7 +264,8 @@ export declare const SchemaPageArray: z.ZodArray<z.ZodArray<z.ZodObject<{
     opacity: z.ZodOptional<z.ZodNumber>;
     readOnly: z.ZodOptional<z.ZodBoolean>;
     required: z.ZodOptional<z.ZodBoolean>;
-    __bodyRange: z.ZodOptional<z.ZodObject<{
+    __splitRange: z.ZodOptional<z.ZodObject<{
+        unit: z.ZodString;
         start: z.ZodNumber;
         end: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>;
@@ -261,7 +286,8 @@ export declare const Template: z.ZodObject<{
         opacity: z.ZodOptional<z.ZodNumber>;
         readOnly: z.ZodOptional<z.ZodBoolean>;
         required: z.ZodOptional<z.ZodBoolean>;
-        __bodyRange: z.ZodOptional<z.ZodObject<{
+        __splitRange: z.ZodOptional<z.ZodObject<{
+            unit: z.ZodString;
             start: z.ZodNumber;
             end: z.ZodOptional<z.ZodNumber>;
         }, z.core.$strip>>;
@@ -285,7 +311,8 @@ export declare const Template: z.ZodObject<{
             opacity: z.ZodOptional<z.ZodNumber>;
             readOnly: z.ZodOptional<z.ZodBoolean>;
             required: z.ZodOptional<z.ZodBoolean>;
-            __bodyRange: z.ZodOptional<z.ZodObject<{
+            __splitRange: z.ZodOptional<z.ZodObject<{
+                unit: z.ZodString;
                 start: z.ZodNumber;
                 end: z.ZodOptional<z.ZodNumber>;
             }, z.core.$strip>>;
@@ -320,7 +347,8 @@ export declare const Plugin: z.ZodObject<{
             opacity: z.ZodOptional<z.ZodNumber>;
             readOnly: z.ZodOptional<z.ZodBoolean>;
             required: z.ZodOptional<z.ZodBoolean>;
-            __bodyRange: z.ZodOptional<z.ZodObject<{
+            __splitRange: z.ZodOptional<z.ZodObject<{
+                unit: z.ZodString;
                 start: z.ZodNumber;
                 end: z.ZodOptional<z.ZodNumber>;
             }, z.core.$strip>>;
@@ -384,7 +412,8 @@ export declare const GenerateProps: z.ZodObject<{
             opacity: z.ZodOptional<z.ZodNumber>;
             readOnly: z.ZodOptional<z.ZodBoolean>;
             required: z.ZodOptional<z.ZodBoolean>;
-            __bodyRange: z.ZodOptional<z.ZodObject<{
+            __splitRange: z.ZodOptional<z.ZodObject<{
+                unit: z.ZodString;
                 start: z.ZodNumber;
                 end: z.ZodOptional<z.ZodNumber>;
             }, z.core.$strip>>;
@@ -408,7 +437,8 @@ export declare const GenerateProps: z.ZodObject<{
                 opacity: z.ZodOptional<z.ZodNumber>;
                 readOnly: z.ZodOptional<z.ZodBoolean>;
                 required: z.ZodOptional<z.ZodBoolean>;
-                __bodyRange: z.ZodOptional<z.ZodObject<{
+                __splitRange: z.ZodOptional<z.ZodObject<{
+                    unit: z.ZodString;
                     start: z.ZodNumber;
                     end: z.ZodOptional<z.ZodNumber>;
                 }, z.core.$strip>>;
@@ -437,7 +467,8 @@ export declare const GenerateProps: z.ZodObject<{
                 opacity: z.ZodOptional<z.ZodNumber>;
                 readOnly: z.ZodOptional<z.ZodBoolean>;
                 required: z.ZodOptional<z.ZodBoolean>;
-                __bodyRange: z.ZodOptional<z.ZodObject<{
+                __splitRange: z.ZodOptional<z.ZodObject<{
+                    unit: z.ZodString;
                     start: z.ZodNumber;
                     end: z.ZodOptional<z.ZodNumber>;
                 }, z.core.$strip>>;
@@ -523,7 +554,8 @@ export declare const UIProps: z.ZodObject<{
             opacity: z.ZodOptional<z.ZodNumber>;
             readOnly: z.ZodOptional<z.ZodBoolean>;
             required: z.ZodOptional<z.ZodBoolean>;
-            __bodyRange: z.ZodOptional<z.ZodObject<{
+            __splitRange: z.ZodOptional<z.ZodObject<{
+                unit: z.ZodString;
                 start: z.ZodNumber;
                 end: z.ZodOptional<z.ZodNumber>;
             }, z.core.$strip>>;
@@ -547,7 +579,8 @@ export declare const UIProps: z.ZodObject<{
                 opacity: z.ZodOptional<z.ZodNumber>;
                 readOnly: z.ZodOptional<z.ZodBoolean>;
                 required: z.ZodOptional<z.ZodBoolean>;
-                __bodyRange: z.ZodOptional<z.ZodObject<{
+                __splitRange: z.ZodOptional<z.ZodObject<{
+                    unit: z.ZodString;
                     start: z.ZodNumber;
                     end: z.ZodOptional<z.ZodNumber>;
                 }, z.core.$strip>>;
@@ -576,7 +609,8 @@ export declare const UIProps: z.ZodObject<{
                 opacity: z.ZodOptional<z.ZodNumber>;
                 readOnly: z.ZodOptional<z.ZodBoolean>;
                 required: z.ZodOptional<z.ZodBoolean>;
-                __bodyRange: z.ZodOptional<z.ZodObject<{
+                __splitRange: z.ZodOptional<z.ZodObject<{
+                    unit: z.ZodString;
                     start: z.ZodNumber;
                     end: z.ZodOptional<z.ZodNumber>;
                 }, z.core.$strip>>;
@@ -630,7 +664,8 @@ export declare const PreviewProps: z.ZodObject<{
             opacity: z.ZodOptional<z.ZodNumber>;
             readOnly: z.ZodOptional<z.ZodBoolean>;
             required: z.ZodOptional<z.ZodBoolean>;
-            __bodyRange: z.ZodOptional<z.ZodObject<{
+            __splitRange: z.ZodOptional<z.ZodObject<{
+                unit: z.ZodString;
                 start: z.ZodNumber;
                 end: z.ZodOptional<z.ZodNumber>;
             }, z.core.$strip>>;
@@ -654,7 +689,8 @@ export declare const PreviewProps: z.ZodObject<{
                 opacity: z.ZodOptional<z.ZodNumber>;
                 readOnly: z.ZodOptional<z.ZodBoolean>;
                 required: z.ZodOptional<z.ZodBoolean>;
-                __bodyRange: z.ZodOptional<z.ZodObject<{
+                __splitRange: z.ZodOptional<z.ZodObject<{
+                    unit: z.ZodString;
                     start: z.ZodNumber;
                     end: z.ZodOptional<z.ZodNumber>;
                 }, z.core.$strip>>;
@@ -683,7 +719,8 @@ export declare const PreviewProps: z.ZodObject<{
                 opacity: z.ZodOptional<z.ZodNumber>;
                 readOnly: z.ZodOptional<z.ZodBoolean>;
                 required: z.ZodOptional<z.ZodBoolean>;
-                __bodyRange: z.ZodOptional<z.ZodObject<{
+                __splitRange: z.ZodOptional<z.ZodObject<{
+                    unit: z.ZodString;
                     start: z.ZodNumber;
                     end: z.ZodOptional<z.ZodNumber>;
                 }, z.core.$strip>>;
@@ -738,7 +775,8 @@ export declare const DesignerProps: z.ZodObject<{
             opacity: z.ZodOptional<z.ZodNumber>;
             readOnly: z.ZodOptional<z.ZodBoolean>;
             required: z.ZodOptional<z.ZodBoolean>;
-            __bodyRange: z.ZodOptional<z.ZodObject<{
+            __splitRange: z.ZodOptional<z.ZodObject<{
+                unit: z.ZodString;
                 start: z.ZodNumber;
                 end: z.ZodOptional<z.ZodNumber>;
             }, z.core.$strip>>;
@@ -762,7 +800,8 @@ export declare const DesignerProps: z.ZodObject<{
                 opacity: z.ZodOptional<z.ZodNumber>;
                 readOnly: z.ZodOptional<z.ZodBoolean>;
                 required: z.ZodOptional<z.ZodBoolean>;
-                __bodyRange: z.ZodOptional<z.ZodObject<{
+                __splitRange: z.ZodOptional<z.ZodObject<{
+                    unit: z.ZodString;
                     start: z.ZodNumber;
                     end: z.ZodOptional<z.ZodNumber>;
                 }, z.core.$strip>>;
@@ -791,7 +830,8 @@ export declare const DesignerProps: z.ZodObject<{
                 opacity: z.ZodOptional<z.ZodNumber>;
                 readOnly: z.ZodOptional<z.ZodBoolean>;
                 required: z.ZodOptional<z.ZodBoolean>;
-                __bodyRange: z.ZodOptional<z.ZodObject<{
+                __splitRange: z.ZodOptional<z.ZodObject<{
+                    unit: z.ZodString;
                     start: z.ZodNumber;
                     end: z.ZodOptional<z.ZodNumber>;
                 }, z.core.$strip>>;

package/dist/splitRange.d.ts

@@ -0,0 +1,5 @@
+import type { DynamicLayoutRange, DynamicLayoutSplitRange } from './types.js';
+export declare const createDynamicLayoutSplitRange: (unit: string, start: number, end?: number) => DynamicLayoutSplitRange;
+export declare const getDynamicLayoutSplitRange: (schema: {
+    __splitRange?: DynamicLayoutSplitRange;
+}, unit: string) => DynamicLayoutRange | undefined;

package/dist/types.d.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import type { PDFPage, PDFDocument } from '@pdfme/pdf-lib';
-import { Lang, Dict, Mode, Size, Schema, Font, SchemaForUI, BasePdf, BlankPdf, CustomPdf, CommonOptions, Template, GeneratorOptions, GenerateProps, UIOptions, UIProps, PreviewProps, DesignerProps, ColorType, LegacySchemaPageArray, SchemaPageArray } from './schema.js';
+import { Lang, Dict, Mode, Size, DynamicLayoutSplitRange, Schema, Font, SchemaForUI, BasePdf, BlankPdf, CustomPdf, CommonOptions, Template, GeneratorOptions, GenerateProps, UIOptions, UIProps, PreviewProps, DesignerProps, ColorType, LegacySchemaPageArray, SchemaPageArray } from './schema.js';
 export interface UIOptionsThemeToken {
     colorPrimary?: string;
     colorPrimaryBg?: string;
@@ -121,6 +121,7 @@ export type UIRenderProps<T extends Schema> = {
  * @property {HTMLElement[]} activeElements - Array of currently active HTML elements in the UI.
  * @property {ChangeSchemas} changeSchemas - Function to change multiple schemas simultaneously.
  * @property {SchemaForUI[]} schemas - Array of schemas for UI rendering.
+ * @property {BasePdf} basePdf - The base PDF used by the current template.
  * @property {Size} pageSize - The size of the page being edited.
  * @property {UIOptions} options - UI options for the property panel.
  * @property {UITheme} theme - The theme token used in the UI.
@@ -132,6 +133,7 @@ type PropPanelProps = {
     activeElements: HTMLElement[];
     changeSchemas: ChangeSchemas;
     schemas: SchemaForUI[];
+    basePdf?: BasePdf;
     options: UIOptions;
     theme: UITheme;
     i18n: (key: string) => string;
@@ -191,6 +193,8 @@ export type Lang = z.infer<typeof Lang>;
 export type Dict = z.infer<typeof Dict>;
 export type Mode = z.infer<typeof Mode>;
 export type Size = z.infer<typeof Size>;
+export type DynamicLayoutSplitRange = z.infer<typeof DynamicLayoutSplitRange>;
+export type DynamicLayoutRange = Omit<DynamicLayoutSplitRange, 'unit'>;
 export type Schema = z.infer<typeof Schema>;
 export type SchemaForUI = z.infer<typeof SchemaForUI>;
 /**
@@ -225,4 +229,24 @@ export type DesignerProps = Omit<z.infer<typeof DesignerProps>, 'plugins'> & {
 };
 export type SchemaPageArray = z.infer<typeof SchemaPageArray>;
 export type LegacySchemaPageArray = z.infer<typeof LegacySchemaPageArray>;
+export type DynamicLayoutPatchArgs = {
+    schema: Schema;
+    start: number;
+    end: number;
+    isSplit: boolean;
+    chunkHeight: number;
+};
+export type DynamicLayoutResult = {
+    heights: number[];
+    avoidFirstUnitOnly?: boolean;
+    patchSplitSchema?: (args: DynamicLayoutPatchArgs) => Partial<Schema>;
+};
+export type DynamicLayoutCallbackResult = DynamicLayoutResult | number[];
+export type DynamicLayoutArgs = {
+    schema: Schema;
+    basePdf: BasePdf;
+    options: CommonOptions;
+    _cache: Map<string | number, unknown>;
+};
+export type GetDynamicLayout = (value: string, args: DynamicLayoutArgs) => Promise<DynamicLayoutCallbackResult>;
 export {};

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const PDFME_VERSION = "6.1.0";
+export declare const PDFME_VERSION = "6.1.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdfme/common",
-  "version": "6.1.0",
+  "version": "6.1.1-dev.11",
   "description": "TypeScript base PDF generator and React base UI. Open source, developed by the community, and completely free to use under the MIT license!",
   "keywords": [
     "pdf",