@pdfme/common 6.1.13 → 6.2.0

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.
package/dist/schema.d.ts CHANGED
@@ -10,6 +10,7 @@ export declare const Lang: z.ZodEnum<{
10
10
  ko: "ko";
11
11
  pl: "pl";
12
12
  th: "th";
13
+ tr: "tr";
13
14
  zh: "zh";
14
15
  "zh-TW": "zh-TW";
15
16
  }>;
@@ -65,6 +66,19 @@ export declare const Dict: z.ZodObject<{
65
66
  'schemas.middle': z.ZodString;
66
67
  'schemas.bottom': z.ZodString;
67
68
  'schemas.padding': z.ZodString;
69
+ 'schemas.image.objectFit': z.ZodString;
70
+ 'schemas.image.fit.contain': z.ZodString;
71
+ 'schemas.image.fit.cover': z.ZodString;
72
+ 'schemas.image.objectPosition': z.ZodString;
73
+ 'schemas.image.position.left.top': z.ZodString;
74
+ 'schemas.image.position.center.top': z.ZodString;
75
+ 'schemas.image.position.right.top': z.ZodString;
76
+ 'schemas.image.position.left.center': z.ZodString;
77
+ 'schemas.image.position.center.center': z.ZodString;
78
+ 'schemas.image.position.right.center': z.ZodString;
79
+ 'schemas.image.position.left.bottom': z.ZodString;
80
+ 'schemas.image.position.center.bottom': z.ZodString;
81
+ 'schemas.image.position.right.bottom': z.ZodString;
68
82
  'schemas.text.fontName': z.ZodString;
69
83
  'schemas.text.size': z.ZodString;
70
84
  'schemas.text.spacing': z.ZodString;
@@ -181,6 +195,17 @@ export declare const SchemaForUI: z.ZodObject<{
181
195
  __isSplit: z.ZodOptional<z.ZodBoolean>;
182
196
  id: z.ZodString;
183
197
  }, z.core.$strip>;
198
+ /**
199
+ * PDF / font bytes with a definite ArrayBuffer backing store.
200
+ *
201
+ * Printed by name in declaration emit so published .d.ts stays valid on
202
+ * TypeScript ≤5.6, where Uint8Array is not generic. A generic typed-array
203
+ * annotation poisons `z.infer` unions such as `Template['basePdf']` on
204
+ * those compilers (see #1021).
205
+ */
206
+ export interface PdfBytes extends Uint8Array {
207
+ readonly buffer: ArrayBuffer;
208
+ }
184
209
  export declare const BlankPdf: z.ZodObject<{
185
210
  width: z.ZodNumber;
186
211
  height: z.ZodNumber;
@@ -207,8 +232,8 @@ export declare const BlankPdf: z.ZodObject<{
207
232
  __isSplit: z.ZodOptional<z.ZodBoolean>;
208
233
  }, z.core.$loose>>>;
209
234
  }, z.core.$strip>;
210
- export declare const CustomPdf: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<Uint8Array<ArrayBuffer>, unknown, z.core.$ZodTypeInternals<Uint8Array<ArrayBuffer>, unknown>>]>;
211
- export declare const BasePdf: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<Uint8Array<ArrayBuffer>, unknown, z.core.$ZodTypeInternals<Uint8Array<ArrayBuffer>, unknown>>]>, z.ZodObject<{
235
+ export declare const CustomPdf: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<PdfBytes, unknown, z.core.$ZodTypeInternals<PdfBytes, unknown>>]>;
236
+ export declare const BasePdf: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<PdfBytes, unknown, z.core.$ZodTypeInternals<PdfBytes, unknown>>]>, z.ZodObject<{
212
237
  width: z.ZodNumber;
213
238
  height: z.ZodNumber;
214
239
  padding: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
@@ -298,7 +323,7 @@ export declare const Template: z.ZodObject<{
298
323
  }, z.core.$strip>>;
299
324
  __isSplit: z.ZodOptional<z.ZodBoolean>;
300
325
  }, z.core.$loose>>>;
301
- basePdf: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<Uint8Array<ArrayBuffer>, unknown, z.core.$ZodTypeInternals<Uint8Array<ArrayBuffer>, unknown>>]>, z.ZodObject<{
326
+ basePdf: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<PdfBytes, unknown, z.core.$ZodTypeInternals<PdfBytes, unknown>>]>, z.ZodObject<{
302
327
  width: z.ZodNumber;
303
328
  height: z.ZodNumber;
304
329
  padding: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
@@ -328,7 +353,7 @@ export declare const Template: z.ZodObject<{
328
353
  }, z.core.$loose>;
329
354
  export declare const Inputs: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>>;
330
355
  export declare const Font: z.ZodRecord<z.ZodString, z.ZodObject<{
331
- data: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<Uint8Array<ArrayBuffer>, unknown, z.core.$ZodTypeInternals<Uint8Array<ArrayBuffer>, unknown>>]>;
356
+ data: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<PdfBytes, unknown, z.core.$ZodTypeInternals<PdfBytes, unknown>>]>;
332
357
  fallback: z.ZodOptional<z.ZodBoolean>;
333
358
  subset: z.ZodOptional<z.ZodBoolean>;
334
359
  }, z.core.$strip>>;
@@ -364,14 +389,14 @@ export declare const Plugin: z.ZodObject<{
364
389
  }, z.core.$loose>;
365
390
  export declare const CommonOptions: z.ZodObject<{
366
391
  font: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
367
- data: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<Uint8Array<ArrayBuffer>, unknown, z.core.$ZodTypeInternals<Uint8Array<ArrayBuffer>, unknown>>]>;
392
+ data: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<PdfBytes, unknown, z.core.$ZodTypeInternals<PdfBytes, unknown>>]>;
368
393
  fallback: z.ZodOptional<z.ZodBoolean>;
369
394
  subset: z.ZodOptional<z.ZodBoolean>;
370
395
  }, z.core.$strip>>>;
371
396
  }, z.core.$loose>;
372
397
  export declare const GeneratorOptions: z.ZodObject<{
373
398
  font: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
374
- data: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<Uint8Array<ArrayBuffer>, unknown, z.core.$ZodTypeInternals<Uint8Array<ArrayBuffer>, unknown>>]>;
399
+ data: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<PdfBytes, unknown, z.core.$ZodTypeInternals<PdfBytes, unknown>>]>;
375
400
  fallback: z.ZodOptional<z.ZodBoolean>;
376
401
  subset: z.ZodOptional<z.ZodBoolean>;
377
402
  }, z.core.$strip>>>;
@@ -395,6 +420,7 @@ export declare const GeneratorOptions: z.ZodObject<{
395
420
  ko: "ko";
396
421
  pl: "pl";
397
422
  th: "th";
423
+ tr: "tr";
398
424
  zh: "zh";
399
425
  "zh-TW": "zh-TW";
400
426
  }>>;
@@ -426,7 +452,7 @@ export declare const GenerateProps: z.ZodObject<{
426
452
  }, z.core.$strip>>;
427
453
  __isSplit: z.ZodOptional<z.ZodBoolean>;
428
454
  }, z.core.$loose>>>;
429
- basePdf: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<Uint8Array<ArrayBuffer>, unknown, z.core.$ZodTypeInternals<Uint8Array<ArrayBuffer>, unknown>>]>, z.ZodObject<{
455
+ basePdf: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<PdfBytes, unknown, z.core.$ZodTypeInternals<PdfBytes, unknown>>]>, z.ZodObject<{
430
456
  width: z.ZodNumber;
431
457
  height: z.ZodNumber;
432
458
  padding: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
@@ -487,7 +513,7 @@ export declare const GenerateProps: z.ZodObject<{
487
513
  inputs: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>>;
488
514
  options: z.ZodOptional<z.ZodObject<{
489
515
  font: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
490
- data: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<Uint8Array<ArrayBuffer>, unknown, z.core.$ZodTypeInternals<Uint8Array<ArrayBuffer>, unknown>>]>;
516
+ data: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<PdfBytes, unknown, z.core.$ZodTypeInternals<PdfBytes, unknown>>]>;
491
517
  fallback: z.ZodOptional<z.ZodBoolean>;
492
518
  subset: z.ZodOptional<z.ZodBoolean>;
493
519
  }, z.core.$strip>>>;
@@ -511,6 +537,7 @@ export declare const GenerateProps: z.ZodObject<{
511
537
  ko: "ko";
512
538
  pl: "pl";
513
539
  th: "th";
540
+ tr: "tr";
514
541
  zh: "zh";
515
542
  "zh-TW": "zh-TW";
516
543
  }>>;
@@ -522,7 +549,7 @@ export declare const GenerateProps: z.ZodObject<{
522
549
  }, z.core.$strict>;
523
550
  export declare const UIOptions: z.ZodObject<{
524
551
  font: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
525
- data: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<Uint8Array<ArrayBuffer>, unknown, z.core.$ZodTypeInternals<Uint8Array<ArrayBuffer>, unknown>>]>;
552
+ data: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<PdfBytes, unknown, z.core.$ZodTypeInternals<PdfBytes, unknown>>]>;
526
553
  fallback: z.ZodOptional<z.ZodBoolean>;
527
554
  subset: z.ZodOptional<z.ZodBoolean>;
528
555
  }, z.core.$strip>>>;
@@ -537,6 +564,7 @@ export declare const UIOptions: z.ZodObject<{
537
564
  ko: "ko";
538
565
  pl: "pl";
539
566
  th: "th";
567
+ tr: "tr";
540
568
  zh: "zh";
541
569
  "zh-TW": "zh-TW";
542
570
  }>>;
@@ -571,7 +599,7 @@ export declare const UIProps: z.ZodObject<{
571
599
  }, z.core.$strip>>;
572
600
  __isSplit: z.ZodOptional<z.ZodBoolean>;
573
601
  }, z.core.$loose>>>;
574
- basePdf: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<Uint8Array<ArrayBuffer>, unknown, z.core.$ZodTypeInternals<Uint8Array<ArrayBuffer>, unknown>>]>, z.ZodObject<{
602
+ basePdf: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<PdfBytes, unknown, z.core.$ZodTypeInternals<PdfBytes, unknown>>]>, z.ZodObject<{
575
603
  width: z.ZodNumber;
576
604
  height: z.ZodNumber;
577
605
  padding: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
@@ -632,7 +660,7 @@ export declare const UIProps: z.ZodObject<{
632
660
  domContainer: z.ZodSchema<HTMLElement, unknown, z.core.$ZodTypeInternals<HTMLElement, unknown>>;
633
661
  options: z.ZodOptional<z.ZodObject<{
634
662
  font: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
635
- data: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<Uint8Array<ArrayBuffer>, unknown, z.core.$ZodTypeInternals<Uint8Array<ArrayBuffer>, unknown>>]>;
663
+ data: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<PdfBytes, unknown, z.core.$ZodTypeInternals<PdfBytes, unknown>>]>;
636
664
  fallback: z.ZodOptional<z.ZodBoolean>;
637
665
  subset: z.ZodOptional<z.ZodBoolean>;
638
666
  }, z.core.$strip>>>;
@@ -647,6 +675,7 @@ export declare const UIProps: z.ZodObject<{
647
675
  ko: "ko";
648
676
  pl: "pl";
649
677
  th: "th";
678
+ tr: "tr";
650
679
  zh: "zh";
651
680
  "zh-TW": "zh-TW";
652
681
  }>>;
@@ -682,7 +711,7 @@ export declare const PreviewProps: z.ZodObject<{
682
711
  }, z.core.$strip>>;
683
712
  __isSplit: z.ZodOptional<z.ZodBoolean>;
684
713
  }, z.core.$loose>>>;
685
- basePdf: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<Uint8Array<ArrayBuffer>, unknown, z.core.$ZodTypeInternals<Uint8Array<ArrayBuffer>, unknown>>]>, z.ZodObject<{
714
+ basePdf: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<PdfBytes, unknown, z.core.$ZodTypeInternals<PdfBytes, unknown>>]>, z.ZodObject<{
686
715
  width: z.ZodNumber;
687
716
  height: z.ZodNumber;
688
717
  padding: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
@@ -743,7 +772,7 @@ export declare const PreviewProps: z.ZodObject<{
743
772
  domContainer: z.ZodSchema<HTMLElement, unknown, z.core.$ZodTypeInternals<HTMLElement, unknown>>;
744
773
  options: z.ZodOptional<z.ZodObject<{
745
774
  font: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
746
- data: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<Uint8Array<ArrayBuffer>, unknown, z.core.$ZodTypeInternals<Uint8Array<ArrayBuffer>, unknown>>]>;
775
+ data: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<PdfBytes, unknown, z.core.$ZodTypeInternals<PdfBytes, unknown>>]>;
747
776
  fallback: z.ZodOptional<z.ZodBoolean>;
748
777
  subset: z.ZodOptional<z.ZodBoolean>;
749
778
  }, z.core.$strip>>>;
@@ -758,6 +787,7 @@ export declare const PreviewProps: z.ZodObject<{
758
787
  ko: "ko";
759
788
  pl: "pl";
760
789
  th: "th";
790
+ tr: "tr";
761
791
  zh: "zh";
762
792
  "zh-TW": "zh-TW";
763
793
  }>>;
@@ -794,7 +824,7 @@ export declare const DesignerProps: z.ZodObject<{
794
824
  }, z.core.$strip>>;
795
825
  __isSplit: z.ZodOptional<z.ZodBoolean>;
796
826
  }, z.core.$loose>>>;
797
- basePdf: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<Uint8Array<ArrayBuffer>, unknown, z.core.$ZodTypeInternals<Uint8Array<ArrayBuffer>, unknown>>]>, z.ZodObject<{
827
+ basePdf: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<PdfBytes, unknown, z.core.$ZodTypeInternals<PdfBytes, unknown>>]>, z.ZodObject<{
798
828
  width: z.ZodNumber;
799
829
  height: z.ZodNumber;
800
830
  padding: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
@@ -855,7 +885,7 @@ export declare const DesignerProps: z.ZodObject<{
855
885
  domContainer: z.ZodSchema<HTMLElement, unknown, z.core.$ZodTypeInternals<HTMLElement, unknown>>;
856
886
  options: z.ZodOptional<z.ZodObject<{
857
887
  font: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
858
- data: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<Uint8Array<ArrayBuffer>, unknown, z.core.$ZodTypeInternals<Uint8Array<ArrayBuffer>, unknown>>]>;
888
+ data: z.ZodUnion<readonly [z.ZodString, z.ZodSchema<ArrayBuffer, unknown, z.core.$ZodTypeInternals<ArrayBuffer, unknown>>, z.ZodSchema<PdfBytes, unknown, z.core.$ZodTypeInternals<PdfBytes, unknown>>]>;
859
889
  fallback: z.ZodOptional<z.ZodBoolean>;
860
890
  subset: z.ZodOptional<z.ZodBoolean>;
861
891
  }, z.core.$strip>>>;
@@ -870,6 +900,7 @@ export declare const DesignerProps: z.ZodObject<{
870
900
  ko: "ko";
871
901
  pl: "pl";
872
902
  th: "th";
903
+ tr: "tr";
873
904
  zh: "zh";
874
905
  "zh-TW": "zh-TW";
875
906
  }>>;
package/dist/types.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import { z } from 'zod';
2
2
  import type { PDFPage, PDFDocument } from '@pdfme/pdf-lib';
3
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
+ export type { PdfBytes } from './schema.js';
4
5
  export interface UIOptionsThemeToken {
5
6
  colorPrimary?: string;
6
7
  colorPrimaryBg?: string;
@@ -249,4 +250,3 @@ export type DynamicLayoutArgs = {
249
250
  _cache: Map<string | number, unknown>;
250
251
  };
251
252
  export type GetDynamicLayout = (value: string, args: DynamicLayoutArgs) => Promise<DynamicLayoutCallbackResult>;
252
- export {};
package/dist/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const PDFME_VERSION = "6.1.13";
1
+ export declare const PDFME_VERSION = "6.2.0";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pdfme/common",
3
- "version": "6.1.13",
3
+ "version": "6.2.0",
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",
@@ -45,7 +45,8 @@
45
45
  "clean": "rimraf dist",
46
46
  "lint": "vp lint -c ../../.oxlintrc.json src",
47
47
  "fmt": "vp fmt -c ../../.oxfmtrc.json src --write",
48
- "test": "vitest run --config ../../vitest.config.ts"
48
+ "test": "vitest run --config ../../vitest.config.ts",
49
+ "test:types:consumer": "node ./scripts/test-types-consumer.mjs"
49
50
  },
50
51
  "dependencies": {
51
52
  "@pdfme/pdf-lib": "*",