@pdfme/common 6.1.1 → 6.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,53 @@
1
+ export type PageOrientation = 'portrait' | 'landscape';
2
+ export declare const PAGE_SIZE_PRESETS: {
3
+ readonly A3: {
4
+ readonly width: 297;
5
+ readonly height: 420;
6
+ };
7
+ readonly A4: {
8
+ readonly width: 210;
9
+ readonly height: 297;
10
+ };
11
+ readonly A5: {
12
+ readonly width: 148;
13
+ readonly height: 210;
14
+ };
15
+ readonly A6: {
16
+ readonly width: 105;
17
+ readonly height: 148;
18
+ };
19
+ readonly B4: {
20
+ readonly width: 250;
21
+ readonly height: 353;
22
+ };
23
+ readonly B5: {
24
+ readonly width: 176;
25
+ readonly height: 250;
26
+ };
27
+ readonly B6: {
28
+ readonly width: 125;
29
+ readonly height: 176;
30
+ };
31
+ readonly Letter: {
32
+ readonly width: 215.9;
33
+ readonly height: 279.4;
34
+ };
35
+ readonly Legal: {
36
+ readonly width: 215.9;
37
+ readonly height: 355.6;
38
+ };
39
+ readonly Tabloid: {
40
+ readonly width: 279.4;
41
+ readonly height: 431.8;
42
+ };
43
+ };
44
+ export type PageSizePreset = keyof typeof PAGE_SIZE_PRESETS;
45
+ export type PageSize = PageSizePreset | {
46
+ width: number;
47
+ height: number;
48
+ };
49
+ export declare const resolvePageSize: (size?: PageSize, orientation?: PageOrientation) => {
50
+ width: number;
51
+ height: number;
52
+ };
53
+ export declare const detectPaperSize: (width: number, height: number, tolerance?: number) => `${PageSizePreset} ${PageOrientation}` | null;
package/dist/schema.d.ts CHANGED
@@ -70,6 +70,9 @@ export declare const Dict: z.ZodObject<{
70
70
  'schemas.text.max': z.ZodString;
71
71
  'schemas.text.fit': z.ZodString;
72
72
  'schemas.text.dynamicFontSize': z.ZodString;
73
+ 'schemas.text.overflow': z.ZodString;
74
+ 'schemas.text.overflowVisible': z.ZodString;
75
+ 'schemas.text.overflowExpand': z.ZodString;
73
76
  'schemas.text.format': z.ZodString;
74
77
  'schemas.text.plain': z.ZodString;
75
78
  'schemas.text.inlineMarkdown': z.ZodString;
@@ -125,6 +128,11 @@ export declare const Size: z.ZodObject<{
125
128
  height: z.ZodNumber;
126
129
  width: z.ZodNumber;
127
130
  }, z.core.$strip>;
131
+ export declare const DynamicLayoutSplitRange: z.ZodObject<{
132
+ unit: z.ZodString;
133
+ start: z.ZodNumber;
134
+ end: z.ZodOptional<z.ZodNumber>;
135
+ }, z.core.$strip>;
128
136
  export declare const Schema: z.ZodObject<{
129
137
  name: z.ZodString;
130
138
  type: z.ZodString;
@@ -139,11 +147,8 @@ export declare const Schema: z.ZodObject<{
139
147
  opacity: z.ZodOptional<z.ZodNumber>;
140
148
  readOnly: z.ZodOptional<z.ZodBoolean>;
141
149
  required: z.ZodOptional<z.ZodBoolean>;
142
- __bodyRange: z.ZodOptional<z.ZodObject<{
143
- start: z.ZodNumber;
144
- end: z.ZodOptional<z.ZodNumber>;
145
- }, z.core.$strip>>;
146
- __itemRange: z.ZodOptional<z.ZodObject<{
150
+ __splitRange: z.ZodOptional<z.ZodObject<{
151
+ unit: z.ZodString;
147
152
  start: z.ZodNumber;
148
153
  end: z.ZodOptional<z.ZodNumber>;
149
154
  }, z.core.$strip>>;
@@ -163,11 +168,8 @@ export declare const SchemaForUI: z.ZodObject<{
163
168
  opacity: z.ZodOptional<z.ZodNumber>;
164
169
  readOnly: z.ZodOptional<z.ZodBoolean>;
165
170
  required: z.ZodOptional<z.ZodBoolean>;
166
- __bodyRange: z.ZodOptional<z.ZodObject<{
167
- start: z.ZodNumber;
168
- end: z.ZodOptional<z.ZodNumber>;
169
- }, z.core.$strip>>;
170
- __itemRange: z.ZodOptional<z.ZodObject<{
171
+ __splitRange: z.ZodOptional<z.ZodObject<{
172
+ unit: z.ZodString;
171
173
  start: z.ZodNumber;
172
174
  end: z.ZodOptional<z.ZodNumber>;
173
175
  }, z.core.$strip>>;
@@ -192,11 +194,8 @@ export declare const BlankPdf: z.ZodObject<{
192
194
  opacity: z.ZodOptional<z.ZodNumber>;
193
195
  readOnly: z.ZodOptional<z.ZodBoolean>;
194
196
  required: z.ZodOptional<z.ZodBoolean>;
195
- __bodyRange: z.ZodOptional<z.ZodObject<{
196
- start: z.ZodNumber;
197
- end: z.ZodOptional<z.ZodNumber>;
198
- }, z.core.$strip>>;
199
- __itemRange: z.ZodOptional<z.ZodObject<{
197
+ __splitRange: z.ZodOptional<z.ZodObject<{
198
+ unit: z.ZodString;
200
199
  start: z.ZodNumber;
201
200
  end: z.ZodOptional<z.ZodNumber>;
202
201
  }, z.core.$strip>>;
@@ -222,11 +221,8 @@ export declare const BasePdf: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodStr
222
221
  opacity: z.ZodOptional<z.ZodNumber>;
223
222
  readOnly: z.ZodOptional<z.ZodBoolean>;
224
223
  required: z.ZodOptional<z.ZodBoolean>;
225
- __bodyRange: z.ZodOptional<z.ZodObject<{
226
- start: z.ZodNumber;
227
- end: z.ZodOptional<z.ZodNumber>;
228
- }, z.core.$strip>>;
229
- __itemRange: z.ZodOptional<z.ZodObject<{
224
+ __splitRange: z.ZodOptional<z.ZodObject<{
225
+ unit: z.ZodString;
230
226
  start: z.ZodNumber;
231
227
  end: z.ZodOptional<z.ZodNumber>;
232
228
  }, z.core.$strip>>;
@@ -247,11 +243,8 @@ export declare const LegacySchemaPageArray: z.ZodArray<z.ZodRecord<z.ZodString,
247
243
  opacity: z.ZodOptional<z.ZodNumber>;
248
244
  readOnly: z.ZodOptional<z.ZodBoolean>;
249
245
  required: z.ZodOptional<z.ZodBoolean>;
250
- __bodyRange: z.ZodOptional<z.ZodObject<{
251
- start: z.ZodNumber;
252
- end: z.ZodOptional<z.ZodNumber>;
253
- }, z.core.$strip>>;
254
- __itemRange: z.ZodOptional<z.ZodObject<{
246
+ __splitRange: z.ZodOptional<z.ZodObject<{
247
+ unit: z.ZodString;
255
248
  start: z.ZodNumber;
256
249
  end: z.ZodOptional<z.ZodNumber>;
257
250
  }, z.core.$strip>>;
@@ -271,11 +264,8 @@ export declare const SchemaPageArray: z.ZodArray<z.ZodArray<z.ZodObject<{
271
264
  opacity: z.ZodOptional<z.ZodNumber>;
272
265
  readOnly: z.ZodOptional<z.ZodBoolean>;
273
266
  required: z.ZodOptional<z.ZodBoolean>;
274
- __bodyRange: z.ZodOptional<z.ZodObject<{
275
- start: z.ZodNumber;
276
- end: z.ZodOptional<z.ZodNumber>;
277
- }, z.core.$strip>>;
278
- __itemRange: z.ZodOptional<z.ZodObject<{
267
+ __splitRange: z.ZodOptional<z.ZodObject<{
268
+ unit: z.ZodString;
279
269
  start: z.ZodNumber;
280
270
  end: z.ZodOptional<z.ZodNumber>;
281
271
  }, z.core.$strip>>;
@@ -296,11 +286,8 @@ export declare const Template: z.ZodObject<{
296
286
  opacity: z.ZodOptional<z.ZodNumber>;
297
287
  readOnly: z.ZodOptional<z.ZodBoolean>;
298
288
  required: z.ZodOptional<z.ZodBoolean>;
299
- __bodyRange: z.ZodOptional<z.ZodObject<{
300
- start: z.ZodNumber;
301
- end: z.ZodOptional<z.ZodNumber>;
302
- }, z.core.$strip>>;
303
- __itemRange: z.ZodOptional<z.ZodObject<{
289
+ __splitRange: z.ZodOptional<z.ZodObject<{
290
+ unit: z.ZodString;
304
291
  start: z.ZodNumber;
305
292
  end: z.ZodOptional<z.ZodNumber>;
306
293
  }, z.core.$strip>>;
@@ -324,11 +311,8 @@ export declare const Template: z.ZodObject<{
324
311
  opacity: z.ZodOptional<z.ZodNumber>;
325
312
  readOnly: z.ZodOptional<z.ZodBoolean>;
326
313
  required: z.ZodOptional<z.ZodBoolean>;
327
- __bodyRange: z.ZodOptional<z.ZodObject<{
328
- start: z.ZodNumber;
329
- end: z.ZodOptional<z.ZodNumber>;
330
- }, z.core.$strip>>;
331
- __itemRange: z.ZodOptional<z.ZodObject<{
314
+ __splitRange: z.ZodOptional<z.ZodObject<{
315
+ unit: z.ZodString;
332
316
  start: z.ZodNumber;
333
317
  end: z.ZodOptional<z.ZodNumber>;
334
318
  }, z.core.$strip>>;
@@ -363,11 +347,8 @@ export declare const Plugin: z.ZodObject<{
363
347
  opacity: z.ZodOptional<z.ZodNumber>;
364
348
  readOnly: z.ZodOptional<z.ZodBoolean>;
365
349
  required: z.ZodOptional<z.ZodBoolean>;
366
- __bodyRange: z.ZodOptional<z.ZodObject<{
367
- start: z.ZodNumber;
368
- end: z.ZodOptional<z.ZodNumber>;
369
- }, z.core.$strip>>;
370
- __itemRange: z.ZodOptional<z.ZodObject<{
350
+ __splitRange: z.ZodOptional<z.ZodObject<{
351
+ unit: z.ZodString;
371
352
  start: z.ZodNumber;
372
353
  end: z.ZodOptional<z.ZodNumber>;
373
354
  }, z.core.$strip>>;
@@ -431,11 +412,8 @@ export declare const GenerateProps: z.ZodObject<{
431
412
  opacity: z.ZodOptional<z.ZodNumber>;
432
413
  readOnly: z.ZodOptional<z.ZodBoolean>;
433
414
  required: z.ZodOptional<z.ZodBoolean>;
434
- __bodyRange: z.ZodOptional<z.ZodObject<{
435
- start: z.ZodNumber;
436
- end: z.ZodOptional<z.ZodNumber>;
437
- }, z.core.$strip>>;
438
- __itemRange: z.ZodOptional<z.ZodObject<{
415
+ __splitRange: z.ZodOptional<z.ZodObject<{
416
+ unit: z.ZodString;
439
417
  start: z.ZodNumber;
440
418
  end: z.ZodOptional<z.ZodNumber>;
441
419
  }, z.core.$strip>>;
@@ -459,11 +437,8 @@ export declare const GenerateProps: z.ZodObject<{
459
437
  opacity: z.ZodOptional<z.ZodNumber>;
460
438
  readOnly: z.ZodOptional<z.ZodBoolean>;
461
439
  required: z.ZodOptional<z.ZodBoolean>;
462
- __bodyRange: z.ZodOptional<z.ZodObject<{
463
- start: z.ZodNumber;
464
- end: z.ZodOptional<z.ZodNumber>;
465
- }, z.core.$strip>>;
466
- __itemRange: z.ZodOptional<z.ZodObject<{
440
+ __splitRange: z.ZodOptional<z.ZodObject<{
441
+ unit: z.ZodString;
467
442
  start: z.ZodNumber;
468
443
  end: z.ZodOptional<z.ZodNumber>;
469
444
  }, z.core.$strip>>;
@@ -492,11 +467,8 @@ export declare const GenerateProps: z.ZodObject<{
492
467
  opacity: z.ZodOptional<z.ZodNumber>;
493
468
  readOnly: z.ZodOptional<z.ZodBoolean>;
494
469
  required: z.ZodOptional<z.ZodBoolean>;
495
- __bodyRange: z.ZodOptional<z.ZodObject<{
496
- start: z.ZodNumber;
497
- end: z.ZodOptional<z.ZodNumber>;
498
- }, z.core.$strip>>;
499
- __itemRange: z.ZodOptional<z.ZodObject<{
470
+ __splitRange: z.ZodOptional<z.ZodObject<{
471
+ unit: z.ZodString;
500
472
  start: z.ZodNumber;
501
473
  end: z.ZodOptional<z.ZodNumber>;
502
474
  }, z.core.$strip>>;
@@ -582,11 +554,8 @@ export declare const UIProps: z.ZodObject<{
582
554
  opacity: z.ZodOptional<z.ZodNumber>;
583
555
  readOnly: z.ZodOptional<z.ZodBoolean>;
584
556
  required: z.ZodOptional<z.ZodBoolean>;
585
- __bodyRange: z.ZodOptional<z.ZodObject<{
586
- start: z.ZodNumber;
587
- end: z.ZodOptional<z.ZodNumber>;
588
- }, z.core.$strip>>;
589
- __itemRange: z.ZodOptional<z.ZodObject<{
557
+ __splitRange: z.ZodOptional<z.ZodObject<{
558
+ unit: z.ZodString;
590
559
  start: z.ZodNumber;
591
560
  end: z.ZodOptional<z.ZodNumber>;
592
561
  }, z.core.$strip>>;
@@ -610,11 +579,8 @@ export declare const UIProps: z.ZodObject<{
610
579
  opacity: z.ZodOptional<z.ZodNumber>;
611
580
  readOnly: z.ZodOptional<z.ZodBoolean>;
612
581
  required: z.ZodOptional<z.ZodBoolean>;
613
- __bodyRange: z.ZodOptional<z.ZodObject<{
614
- start: z.ZodNumber;
615
- end: z.ZodOptional<z.ZodNumber>;
616
- }, z.core.$strip>>;
617
- __itemRange: z.ZodOptional<z.ZodObject<{
582
+ __splitRange: z.ZodOptional<z.ZodObject<{
583
+ unit: z.ZodString;
618
584
  start: z.ZodNumber;
619
585
  end: z.ZodOptional<z.ZodNumber>;
620
586
  }, z.core.$strip>>;
@@ -643,11 +609,8 @@ export declare const UIProps: z.ZodObject<{
643
609
  opacity: z.ZodOptional<z.ZodNumber>;
644
610
  readOnly: z.ZodOptional<z.ZodBoolean>;
645
611
  required: z.ZodOptional<z.ZodBoolean>;
646
- __bodyRange: z.ZodOptional<z.ZodObject<{
647
- start: z.ZodNumber;
648
- end: z.ZodOptional<z.ZodNumber>;
649
- }, z.core.$strip>>;
650
- __itemRange: z.ZodOptional<z.ZodObject<{
612
+ __splitRange: z.ZodOptional<z.ZodObject<{
613
+ unit: z.ZodString;
651
614
  start: z.ZodNumber;
652
615
  end: z.ZodOptional<z.ZodNumber>;
653
616
  }, z.core.$strip>>;
@@ -701,11 +664,8 @@ export declare const PreviewProps: z.ZodObject<{
701
664
  opacity: z.ZodOptional<z.ZodNumber>;
702
665
  readOnly: z.ZodOptional<z.ZodBoolean>;
703
666
  required: z.ZodOptional<z.ZodBoolean>;
704
- __bodyRange: z.ZodOptional<z.ZodObject<{
705
- start: z.ZodNumber;
706
- end: z.ZodOptional<z.ZodNumber>;
707
- }, z.core.$strip>>;
708
- __itemRange: z.ZodOptional<z.ZodObject<{
667
+ __splitRange: z.ZodOptional<z.ZodObject<{
668
+ unit: z.ZodString;
709
669
  start: z.ZodNumber;
710
670
  end: z.ZodOptional<z.ZodNumber>;
711
671
  }, z.core.$strip>>;
@@ -729,11 +689,8 @@ export declare const PreviewProps: z.ZodObject<{
729
689
  opacity: z.ZodOptional<z.ZodNumber>;
730
690
  readOnly: z.ZodOptional<z.ZodBoolean>;
731
691
  required: z.ZodOptional<z.ZodBoolean>;
732
- __bodyRange: z.ZodOptional<z.ZodObject<{
733
- start: z.ZodNumber;
734
- end: z.ZodOptional<z.ZodNumber>;
735
- }, z.core.$strip>>;
736
- __itemRange: z.ZodOptional<z.ZodObject<{
692
+ __splitRange: z.ZodOptional<z.ZodObject<{
693
+ unit: z.ZodString;
737
694
  start: z.ZodNumber;
738
695
  end: z.ZodOptional<z.ZodNumber>;
739
696
  }, z.core.$strip>>;
@@ -762,11 +719,8 @@ export declare const PreviewProps: z.ZodObject<{
762
719
  opacity: z.ZodOptional<z.ZodNumber>;
763
720
  readOnly: z.ZodOptional<z.ZodBoolean>;
764
721
  required: z.ZodOptional<z.ZodBoolean>;
765
- __bodyRange: z.ZodOptional<z.ZodObject<{
766
- start: z.ZodNumber;
767
- end: z.ZodOptional<z.ZodNumber>;
768
- }, z.core.$strip>>;
769
- __itemRange: z.ZodOptional<z.ZodObject<{
722
+ __splitRange: z.ZodOptional<z.ZodObject<{
723
+ unit: z.ZodString;
770
724
  start: z.ZodNumber;
771
725
  end: z.ZodOptional<z.ZodNumber>;
772
726
  }, z.core.$strip>>;
@@ -821,11 +775,8 @@ export declare const DesignerProps: z.ZodObject<{
821
775
  opacity: z.ZodOptional<z.ZodNumber>;
822
776
  readOnly: z.ZodOptional<z.ZodBoolean>;
823
777
  required: z.ZodOptional<z.ZodBoolean>;
824
- __bodyRange: z.ZodOptional<z.ZodObject<{
825
- start: z.ZodNumber;
826
- end: z.ZodOptional<z.ZodNumber>;
827
- }, z.core.$strip>>;
828
- __itemRange: z.ZodOptional<z.ZodObject<{
778
+ __splitRange: z.ZodOptional<z.ZodObject<{
779
+ unit: z.ZodString;
829
780
  start: z.ZodNumber;
830
781
  end: z.ZodOptional<z.ZodNumber>;
831
782
  }, z.core.$strip>>;
@@ -849,11 +800,8 @@ export declare const DesignerProps: z.ZodObject<{
849
800
  opacity: z.ZodOptional<z.ZodNumber>;
850
801
  readOnly: z.ZodOptional<z.ZodBoolean>;
851
802
  required: z.ZodOptional<z.ZodBoolean>;
852
- __bodyRange: z.ZodOptional<z.ZodObject<{
853
- start: z.ZodNumber;
854
- end: z.ZodOptional<z.ZodNumber>;
855
- }, z.core.$strip>>;
856
- __itemRange: z.ZodOptional<z.ZodObject<{
803
+ __splitRange: z.ZodOptional<z.ZodObject<{
804
+ unit: z.ZodString;
857
805
  start: z.ZodNumber;
858
806
  end: z.ZodOptional<z.ZodNumber>;
859
807
  }, z.core.$strip>>;
@@ -882,11 +830,8 @@ export declare const DesignerProps: z.ZodObject<{
882
830
  opacity: z.ZodOptional<z.ZodNumber>;
883
831
  readOnly: z.ZodOptional<z.ZodBoolean>;
884
832
  required: z.ZodOptional<z.ZodBoolean>;
885
- __bodyRange: z.ZodOptional<z.ZodObject<{
886
- start: z.ZodNumber;
887
- end: z.ZodOptional<z.ZodNumber>;
888
- }, z.core.$strip>>;
889
- __itemRange: z.ZodOptional<z.ZodObject<{
833
+ __splitRange: z.ZodOptional<z.ZodObject<{
834
+ unit: z.ZodString;
890
835
  start: z.ZodNumber;
891
836
  end: z.ZodOptional<z.ZodNumber>;
892
837
  }, z.core.$strip>>;
@@ -0,0 +1,5 @@
1
+ import type { DynamicLayoutRange, DynamicLayoutSplitRange } from './types.js';
2
+ export declare const createDynamicLayoutSplitRange: (unit: string, start: number, end?: number) => DynamicLayoutSplitRange;
3
+ export declare const getDynamicLayoutSplitRange: (schema: {
4
+ __splitRange?: DynamicLayoutSplitRange;
5
+ }, unit: string) => DynamicLayoutRange | undefined;
package/dist/types.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { z } from 'zod';
2
2
  import type { PDFPage, PDFDocument } from '@pdfme/pdf-lib';
3
- 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';
3
+ 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';
4
4
  export interface UIOptionsThemeToken {
5
5
  colorPrimary?: string;
6
6
  colorPrimaryBg?: string;
@@ -121,6 +121,7 @@ export type UIRenderProps<T extends Schema> = {
121
121
  * @property {HTMLElement[]} activeElements - Array of currently active HTML elements in the UI.
122
122
  * @property {ChangeSchemas} changeSchemas - Function to change multiple schemas simultaneously.
123
123
  * @property {SchemaForUI[]} schemas - Array of schemas for UI rendering.
124
+ * @property {BasePdf} basePdf - The base PDF used by the current template.
124
125
  * @property {Size} pageSize - The size of the page being edited.
125
126
  * @property {UIOptions} options - UI options for the property panel.
126
127
  * @property {UITheme} theme - The theme token used in the UI.
@@ -132,6 +133,7 @@ type PropPanelProps = {
132
133
  activeElements: HTMLElement[];
133
134
  changeSchemas: ChangeSchemas;
134
135
  schemas: SchemaForUI[];
136
+ basePdf?: BasePdf;
135
137
  options: UIOptions;
136
138
  theme: UITheme;
137
139
  i18n: (key: string) => string;
@@ -191,6 +193,8 @@ export type Lang = z.infer<typeof Lang>;
191
193
  export type Dict = z.infer<typeof Dict>;
192
194
  export type Mode = z.infer<typeof Mode>;
193
195
  export type Size = z.infer<typeof Size>;
196
+ export type DynamicLayoutSplitRange = z.infer<typeof DynamicLayoutSplitRange>;
197
+ export type DynamicLayoutRange = Omit<DynamicLayoutSplitRange, 'unit'>;
194
198
  export type Schema = z.infer<typeof Schema>;
195
199
  export type SchemaForUI = z.infer<typeof SchemaForUI>;
196
200
  /**
package/dist/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const PDFME_VERSION = "6.1.1";
1
+ export declare const PDFME_VERSION = "6.1.2";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pdfme/common",
3
- "version": "6.1.1",
3
+ "version": "6.1.2",
4
4
  "description": "TypeScript base PDF generator and React base UI. Open source, developed by the community, and completely free to use under the MIT license!",
5
5
  "keywords": [
6
6
  "pdf",