@pdfme/generator 3.4.3 → 4.0.0

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

@@ -1,32 +1,26 @@
-import * as pdfLib from '@pdfme/pdf-lib';
-import type { GeneratorOptions, Template, PDFRenderProps } from '@pdfme/common';
-import type { Schema, Plugins } from '@pdfme/common';
+import { Schema, Plugins, GeneratorOptions, Template, PDFRenderProps } from '@pdfme/common';
 import { PDFPage, PDFDocument, PDFEmbeddedPage } from '@pdfme/pdf-lib';
-import { BasePdf } from '@pdfme/common';
 import type { EmbedPdfBox } from './types';
-export declare const getEmbeddedPagesAndEmbedPdfBoxes: (arg: {
+export declare const getEmbedPdfPages: (arg: {
+    template: Template;
     pdfDoc: PDFDocument;
-    basePdf: BasePdf;
 }) => Promise<{
-    embeddedPages: pdfLib.PDFEmbeddedPage[];
+    basePages: (PDFEmbeddedPage | PDFPage)[];
     embedPdfBoxes: EmbedPdfBox[];
 }>;
-export declare const drawEmbeddedPage: (arg: {
-    page: PDFPage;
-    embeddedPage: PDFEmbeddedPage;
-    embedPdfBox: EmbedPdfBox;
-}) => void;
 export declare const preprocessing: (arg: {
     template: Template;
     userPlugins: Plugins;
 }) => Promise<{
-    pdfDoc: pdfLib.PDFDocument;
-    embeddedPages: pdfLib.PDFEmbeddedPage[];
-    embedPdfBoxes: EmbedPdfBox[];
+    pdfDoc: PDFDocument;
     renderObj: Record<string, (arg: PDFRenderProps<Schema>) => Promise<void> | void>;
-    readOnlySchemaKeys: string[];
 }>;
 export declare const postProcessing: (props: {
-    pdfDoc: pdfLib.PDFDocument;
+    pdfDoc: PDFDocument;
     options: GeneratorOptions;
 }) => void;
+export declare const insertPage: (arg: {
+    basePage: PDFEmbeddedPage | PDFPage;
+    embedPdfBox: EmbedPdfBox;
+    pdfDoc: PDFDocument;
+}) => PDFPage;

package/package.json

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

package/src/generate.ts

@@ -1,38 +1,51 @@
 import * as pdfLib from '@pdfme/pdf-lib';
 import type { GenerateProps } from '@pdfme/common';
-import { checkGenerateProps } from '@pdfme/common';
-import { drawEmbeddedPage, preprocessing, postProcessing } from './helper.js';
+import { checkGenerateProps, getDynamicTemplate } from '@pdfme/common';
+import { modifyTemplateForTable, getDynamicHeightForTable } from '@pdfme/schemas';
+import { insertPage, preprocessing, postProcessing, getEmbedPdfPages } from './helper.js';
 
 const generate = async (props: GenerateProps) => {
   checkGenerateProps(props);
   const { inputs, template, options = {}, plugins: userPlugins = {} } = props;
+  const basePdf = template.basePdf;
 
   if (inputs.length === 0) {
     throw new Error('inputs should not be empty');
   }
 
-  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 { pdfDoc, renderObj } = await preprocessing({ template, userPlugins });
 
   const _cache = new Map();
+
   for (let i = 0; i < inputs.length; i += 1) {
-    const inputObj = inputs[i];
-    for (let j = 0; j < embeddedPages.length; j += 1) {
-      const embeddedPage = embeddedPages[j];
-      const { width: pageWidth, height: pageHeight } = embeddedPage;
-      const embedPdfBox = embedPdfBoxes[j];
+    const input = inputs[i];
 
-      const page = pdfDoc.addPage([pageWidth, pageHeight]);
+    const dynamicTemplate = await getDynamicTemplate({
+      template,
+      input,
+      options,
+      _cache,
+      modifyTemplate: (arg) => {
+        return modifyTemplateForTable(arg);
+      },
+      getDynamicHeight: (value, args) => {
+        if (args.schema.type !== 'table') return Promise.resolve(args.schema.height);
+        return getDynamicHeightForTable(value, args);
+      },
+    });
+    const { basePages, embedPdfBoxes } = await getEmbedPdfPages({
+      template: dynamicTemplate,
+      pdfDoc,
+    });
+    const keys = dynamicTemplate.schemas.flatMap((schemaObj) => Object.keys(schemaObj));
 
-      drawEmbeddedPage({ page, embeddedPage, embedPdfBox });
+    for (let j = 0; j < basePages.length; j += 1) {
+      const basePage = basePages[j];
+      const embedPdfBox = embedPdfBoxes[j];
+      const page = insertPage({ basePage, embedPdfBox, pdfDoc });
       for (let l = 0; l < keys.length; l += 1) {
         const key = keys[l];
-        const schemaObj = template.schemas[j];
+        const schemaObj = dynamicTemplate.schemas[j] || {};
         const schema = schemaObj[key];
         if (!schema) {
           continue;
@@ -42,8 +55,8 @@ 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 });
+        const value = schema.readOnly ? schema.content || '' : input[key];
+        await render({ key, value, schema, basePdf, pdfLib, pdfDoc, page, options, _cache });
       }
     }
   }

package/src/helper.ts

@@ -1,69 +1,71 @@
 import * as fontkit from 'fontkit';
-import * as pdfLib from '@pdfme/pdf-lib';
-import type { GeneratorOptions, Template, PDFRenderProps, Plugin } from '@pdfme/common';
-import type { Schema, Plugins } from '@pdfme/common';
+import {
+  Schema,
+  Plugins,
+  GeneratorOptions,
+  Template,
+  PDFRenderProps,
+  Plugin,
+  getB64BasePdf,
+  isBlankPdf,
+  mm2pt,
+} from '@pdfme/common';
 import { builtInPlugins } from '@pdfme/schemas';
 import { PDFPage, PDFDocument, PDFEmbeddedPage, TransformationMatrix } from '@pdfme/pdf-lib';
-import { getB64BasePdf, BasePdf } from '@pdfme/common';
 import { TOOL_NAME } from './constants.js';
 import type { EmbedPdfBox } from './types';
 
-export const getEmbeddedPagesAndEmbedPdfBoxes = async (arg: {
-  pdfDoc: PDFDocument;
-  basePdf: BasePdf;
-}) => {
-  const { pdfDoc, basePdf } = arg;
-  let embeddedPages: PDFEmbeddedPage[] = [];
+export const getEmbedPdfPages = async (arg: { template: Template; pdfDoc: PDFDocument }) => {
+  const {
+    template: { schemas, basePdf },
+    pdfDoc,
+  } = arg;
+  let basePages: (PDFEmbeddedPage | PDFPage)[] = [];
   let embedPdfBoxes: EmbedPdfBox[] = [];
-  const willLoadPdf = typeof basePdf === 'string' ? await getB64BasePdf(basePdf) : basePdf;
-  const embedPdf = await PDFDocument.load(willLoadPdf);
-  const embedPdfPages = embedPdf.getPages();
-
-  embedPdfBoxes = embedPdfPages.map((p) => ({
-    mediaBox: p.getMediaBox(),
-    bleedBox: p.getBleedBox(),
-    trimBox: p.getTrimBox(),
-  }));
-
-  const boundingBoxes = embedPdfPages.map((p) => {
-    const { x, y, width, height } = p.getMediaBox();
-
-    return { left: x, bottom: y, right: width, top: height + y };
-  });
 
-  const transformationMatrices = embedPdfPages.map(
-    () => [1, 0, 0, 1, 0, 0] as TransformationMatrix
-  );
-
-  embeddedPages = await pdfDoc.embedPages(embedPdfPages, boundingBoxes, transformationMatrices);
-
-  return { embeddedPages, embedPdfBoxes };
-};
-
-export const drawEmbeddedPage = (arg: {
-  page: PDFPage;
-  embeddedPage: PDFEmbeddedPage;
-  embedPdfBox: EmbedPdfBox;
-}) => {
-  const { page, embeddedPage, embedPdfBox } = arg;
-  page.drawPage(embeddedPage);
-  const { mediaBox: mb, bleedBox: bb, trimBox: tb } = embedPdfBox;
-  page.setMediaBox(mb.x, mb.y, mb.width, mb.height);
-  page.setBleedBox(bb.x, bb.y, bb.width, bb.height);
-  page.setTrimBox(tb.x, tb.y, tb.width, tb.height);
+  if (isBlankPdf(basePdf)) {
+    const { width: _width, height: _height } = basePdf;
+    const width = mm2pt(_width);
+    const height = mm2pt(_height);
+    basePages = schemas.map(() => {
+      const page = PDFPage.create(pdfDoc);
+      page.setSize(width, height);
+      return page;
+    });
+    embedPdfBoxes = schemas.map(() => ({
+      mediaBox: { x: 0, y: 0, width, height },
+      bleedBox: { x: 0, y: 0, width, height },
+      trimBox: { x: 0, y: 0, width, height },
+    }));
+  } else {
+    const willLoadPdf = typeof basePdf === 'string' ? await getB64BasePdf(basePdf) : basePdf;
+    const embedPdf = await PDFDocument.load(willLoadPdf as ArrayBuffer | Uint8Array | string);
+    const embedPdfPages = embedPdf.getPages();
+    embedPdfBoxes = embedPdfPages.map((p) => ({
+      mediaBox: p.getMediaBox(),
+      bleedBox: p.getBleedBox(),
+      trimBox: p.getTrimBox(),
+    }));
+    const boundingBoxes = embedPdfPages.map((p) => {
+      const { x, y, width, height } = p.getMediaBox();
+      return { left: x, bottom: y, right: width, top: height + y };
+    });
+    const transformationMatrices = embedPdfPages.map(
+      () => [1, 0, 0, 1, 0, 0] as TransformationMatrix
+    );
+    basePages = await pdfDoc.embedPages(embedPdfPages, boundingBoxes, transformationMatrices);
+  }
+  return { basePages, embedPdfBoxes };
 };
 
 export const preprocessing = async (arg: { template: Template; userPlugins: Plugins }) => {
   const { template, userPlugins } = arg;
-  const { basePdf, schemas } = template;
+  const { schemas } = template;
 
-  const pdfDoc = await pdfLib.PDFDocument.create();
+  const pdfDoc = await PDFDocument.create();
   // @ts-ignore
   pdfDoc.registerFontkit(fontkit);
 
-  const pagesAndBoxes = await getEmbeddedPagesAndEmbedPdfBoxes({ pdfDoc, basePdf });
-  const { embeddedPages, embedPdfBoxes } = pagesAndBoxes;
-
   const pluginValues = (
     Object.values(userPlugins).length > 0
       ? Object.values(userPlugins)
@@ -84,22 +86,10 @@ Check this document: https://pdfme.com/docs/custom-schemas`);
     return { ...acc, [type]: render.pdf };
   }, {} 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 };
+  return { pdfDoc, renderObj };
 };
 
-export const postProcessing = (props: {
-  pdfDoc: pdfLib.PDFDocument;
-  options: GeneratorOptions;
-}) => {
+export const postProcessing = (props: { pdfDoc: PDFDocument; options: GeneratorOptions }) => {
   const { pdfDoc, options } = props;
   const {
     author = TOOL_NAME,
@@ -122,3 +112,23 @@ export const postProcessing = (props: {
   pdfDoc.setSubject(subject);
   pdfDoc.setTitle(title);
 };
+
+export const insertPage = (arg: {
+  basePage: PDFEmbeddedPage | PDFPage;
+  embedPdfBox: EmbedPdfBox;
+  pdfDoc: PDFDocument;
+}) => {
+  const { basePage, embedPdfBox, pdfDoc } = arg;
+  const size = basePage instanceof PDFEmbeddedPage ? basePage.size() : basePage.getSize();
+  const insertedPage = pdfDoc.addPage([size.width, size.height]);
+
+  if (basePage instanceof PDFEmbeddedPage) {
+    insertedPage.drawPage(basePage);
+    const { mediaBox, bleedBox, trimBox } = embedPdfBox;
+    insertedPage.setMediaBox(mediaBox.x, mediaBox.y, mediaBox.width, mediaBox.height);
+    insertedPage.setBleedBox(bleedBox.x, bleedBox.y, bleedBox.width, bleedBox.height);
+    insertedPage.setTrimBox(trimBox.x, trimBox.y, trimBox.width, trimBox.height);
+  }
+
+  return insertedPage;
+};