@pdfme/generator 4.2.4 → 4.2.5

package/dist/types/src/helper.d.ts

@@ -8,6 +8,7 @@ export declare const getEmbedPdfPages: (arg: {
     basePages: (PDFEmbeddedPage | PDFPage)[];
     embedPdfBoxes: EmbedPdfBox[];
 }>;
+export declare const validateRequiredFields: (template: Template, inputs: Record<string, any>[]) => void;
 export declare const preprocessing: (arg: {
     template: Template;
     userPlugins: Plugins;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdfme/generator",
-  "version": "4.2.4",
+  "version": "4.2.5",
   "sideEffects": false,
   "author": "hand-dot",
   "license": "MIT",

package/src/generate.ts

@@ -2,7 +2,7 @@ import * as pdfLib from '@pdfme/pdf-lib';
 import type { GenerateProps } from '@pdfme/common';
 import { checkGenerateProps, getDynamicTemplate } from '@pdfme/common';
 import { modifyTemplateForTable, getDynamicHeightForTable } from '@pdfme/schemas';
-import { insertPage, preprocessing, postProcessing, getEmbedPdfPages } from './helper.js';
+import { insertPage, preprocessing, postProcessing, getEmbedPdfPages, validateRequiredFields } from './helper.js';
 
 const generate = async (props: GenerateProps) => {
   checkGenerateProps(props);
@@ -10,9 +10,11 @@ const generate = async (props: GenerateProps) => {
   const basePdf = template.basePdf;
 
   if (inputs.length === 0) {
-    throw new Error('inputs should not be empty');
+    throw new Error('[@pdfme/generator] inputs should not be empty, pass at least an empty object in the array');
   }
 
+  validateRequiredFields(template, inputs);
+
   const { pdfDoc, renderObj } = await preprocessing({ template, userPlugins });
 
   const _cache = new Map();

package/src/helper.ts

@@ -58,6 +58,16 @@ export const getEmbedPdfPages = async (arg: { template: Template; pdfDoc: PDFDoc
   return { basePages, embedPdfBoxes };
 };
 
+export const validateRequiredFields = (template: Template, inputs: Record<string, any>[]) => {
+  template.schemas.forEach((schemaObj) =>
+    Object.entries(schemaObj).forEach(([fieldName, schema]) => {
+      if (schema.required && !schema.readOnly && !inputs.some((input) => input[fieldName])) {
+        throw new Error(`[@pdfme/generator] input for '${fieldName}' is required to generate this PDF`);
+      }
+    })
+  );
+}
+
 export const preprocessing = async (arg: { template: Template; userPlugins: Plugins }) => {
   const { template, userPlugins } = arg;
   const { schemas } = template;

package/tsconfig.json

@@ -2,13 +2,13 @@
   "extends": "./tsconfig.esm",
   "compilerOptions": {
     "outDir": "./dist",
-  },
-  "paths": {
-    "@pdfme/common": [
-      "packages/common/dist/esm/src"
-    ],
-    "@pdfme/schemas": [
-      "packages/schemas/dist/esm/src"
-    ]
+    "paths": {
+      "@pdfme/common": [
+        "packages/common/dist/esm/src"
+      ],
+      "@pdfme/schemas": [
+        "packages/schemas/dist/esm/src"
+      ]
+    }
   },
 }