@pdfme/generator 3.1.5 → 3.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdfme/generator",
-  "version": "3.1.5",
+  "version": "3.2.0",
   "sideEffects": false,
   "author": "hand-dot",
   "license": "MIT",
@@ -32,7 +32,7 @@
     }
   },
   "scripts": {
-    "develop": "tsc -p tsconfig.esm.json -w",
+    "dev": "tsc -p tsconfig.esm.json -w",
     "build": "npm-run-all --parallel build:cjs build:esm",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "build:esm": "tsc -p tsconfig.esm.json",
@@ -43,7 +43,7 @@
     "prettier": "prettier --write 'src/**/*.ts'"
   },
   "dependencies": {
-    "@pdfme/pdf-lib": "^1.17.3",
+    "@pdfme/pdf-lib": "^1.18.3",
     "atob": "^2.1.2",
     "fontkit": "^2.0.2"
   },

package/src/generate.ts

@@ -7,16 +7,21 @@ const generate = async (props: GenerateProps) => {
   checkGenerateProps(props);
   const { inputs, template, options = {}, plugins: userPlugins = {} } = props;
 
-  const { pdfDoc, embeddedPages, embedPdfBoxes, renderObj } = await preprocessing({
-    template,
-    userPlugins,
-  });
+  if (inputs.length === 0) {
+    throw new Error('inputs should not be empty');
+  }
 
-  const _cache = new Map();
+  const { pdfDoc, embeddedPages, embedPdfBoxes, renderObj, readOnlySchemaKeys } =
+    await preprocessing({ template, userPlugins });
+
+  const keys = readOnlySchemaKeys.concat(Object.keys(inputs[0]));
+  if (template.columns) {
+    keys.sort((a, b) => (template.columns ?? []).indexOf(a) - (template.columns ?? []).indexOf(b));
+  }
 
+  const _cache = new Map();
   for (let i = 0; i < inputs.length; i += 1) {
     const inputObj = inputs[i];
-    const keys = Object.keys(inputObj);
     for (let j = 0; j < embeddedPages.length; j += 1) {
       const embeddedPage = embeddedPages[j];
       const { width: pageWidth, height: pageHeight } = embeddedPage;
@@ -29,9 +34,7 @@ const generate = async (props: GenerateProps) => {
         const key = keys[l];
         const schemaObj = template.schemas[j];
         const schema = schemaObj[key];
-        const value = inputObj[key];
-
-        if (!schema || !value) {
+        if (!schema) {
           continue;
         }
 
@@ -39,7 +42,7 @@ const generate = async (props: GenerateProps) => {
         if (!render) {
           continue;
         }
-
+        const value = schema.readOnly ? schema.readOnlyValue || '' : inputObj[key];
         await render({ key, value, schema, pdfLib, pdfDoc, page, options, _cache });
       }
     }

package/src/helper.ts

@@ -55,7 +55,7 @@ export const drawEmbeddedPage = (arg: {
 
 export const preprocessing = async (arg: { template: Template; userPlugins: Plugins }) => {
   const { template, userPlugins } = arg;
-  const { basePdf } = template;
+  const { basePdf, schemas } = template;
 
   const pdfDoc = await pdfLib.PDFDocument.create();
   // @ts-ignore
@@ -70,7 +70,7 @@ export const preprocessing = async (arg: { template: Template; userPlugins: Plug
       : Object.values(builtInPlugins)
   ) as Plugin<Schema>[];
 
-  const schemaTypes = template.schemas.flatMap((schemaObj) =>
+  const schemaTypes = schemas.flatMap((schemaObj) =>
     Object.values(schemaObj).map((schema) => schema.type)
   );
 
@@ -82,9 +82,18 @@ export const preprocessing = async (arg: { template: Template; userPlugins: Plug
 Check this document: https://pdfme.com/docs/custom-schemas`);
     }
     return { ...acc, [type]: render.pdf };
-  }, {} as Record<string, (arg: PDFRenderProps<Schema>) => Promise<void>>);
-
-  return { pdfDoc, embeddedPages, embedPdfBoxes, renderObj };
+  }, {} as Record<string, (arg: PDFRenderProps<Schema>) => Promise<void> | void>);
+
+  const readOnlySchemaKeys = schemas.reduce((acc, schema) => {
+    const entries = Object.entries(schema);
+    const keys = entries.reduce(
+      (acc, [key, value]) => (value.readOnly ? [...acc, key] : acc),
+      [] as string[]
+    );
+    return [...acc, ...keys];
+  }, [] as string[]);
+
+  return { pdfDoc, embeddedPages, embedPdfBoxes, renderObj, readOnlySchemaKeys };
 };
 
 export const postProcessing = (props: {