av6-pdf-engine 1.0.3 → 1.0.4

package/dist/index.d.mts

@@ -1,3 +1,5 @@
+import PDFDocument from 'pdfkit';
+
 interface SignatureBlock extends BaseBlock {
     type: "signature";
     height: number;
@@ -151,6 +153,7 @@ interface TextBlock extends BaseBlock {
     marginRight?: number;
 }
 
+type PDFDoc = typeof PDFDocument;
 type Alignment = "left" | "right" | "center" | "justify";
 type Orientation = "horizontal" | "vertical";
 type Width = number | "*";
@@ -212,7 +215,7 @@ interface FontRegistration {
     src: string | Buffer;
 }
 interface CustomDocDefinition {
-    pageSize?: PDFKit.PDFDocumentOptions["size"];
+    pageSize?: string;
     margins: PageMargins;
     /** Optional font registrations (custom TTF/OTF) */
     fonts?: FontRegistration[];
@@ -293,4 +296,4 @@ interface RenderEnv {
 declare function renderCustomPdf(def: CustomDocDefinition, outputPath: string): Promise<void>;
 declare function renderCustomPdfToBuffer(def: CustomDocDefinition): Promise<Buffer>;
 
-export { type Alignment, BARCODE_TYPES, type BarcodeBlock, type BarcodeType, type BaseBlock, type Block, type BuiltInFont, type ColumnsBlock, type CustomDocDefinition, type FontName, type FontRegistration, type FooterDef, type FooterInput, type HeaderDef, type ImageBlock, type InlineTextStyle, type KeyValueGridBlock, type KeyValueItem, type LineBlock, type Orientation, type PageBackgroundDef, type PageBreakBlock, type PageContext, type PageMargins, type QRErrorLevel, QR_ERROR_LEVEL, type QrCodeBlock, type RenderEnv, type SignatureBlock, type StyleDef, type StyleRef, type TableBlock, type TableCell, type TextBlock, type WatermarkDef, type WatermarkMode, type Width, renderCustomPdf, renderCustomPdfToBuffer };
+export { type Alignment, BARCODE_TYPES, type BarcodeBlock, type BarcodeType, type BaseBlock, type Block, type BuiltInFont, type ColumnsBlock, type CustomDocDefinition, type FontName, type FontRegistration, type FooterDef, type FooterInput, type HeaderDef, type ImageBlock, type InlineTextStyle, type KeyValueGridBlock, type KeyValueItem, type LineBlock, type Orientation, type PDFDoc, type PageBackgroundDef, type PageBreakBlock, type PageContext, type PageMargins, type QRErrorLevel, QR_ERROR_LEVEL, type QrCodeBlock, type RenderEnv, type SignatureBlock, type StyleDef, type StyleRef, type TableBlock, type TableCell, type TextBlock, type WatermarkDef, type WatermarkMode, type Width, renderCustomPdf, renderCustomPdfToBuffer };

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import PDFDocument from 'pdfkit';
+
 interface SignatureBlock extends BaseBlock {
     type: "signature";
     height: number;
@@ -151,6 +153,7 @@ interface TextBlock extends BaseBlock {
     marginRight?: number;
 }
 
+type PDFDoc = typeof PDFDocument;
 type Alignment = "left" | "right" | "center" | "justify";
 type Orientation = "horizontal" | "vertical";
 type Width = number | "*";
@@ -212,7 +215,7 @@ interface FontRegistration {
     src: string | Buffer;
 }
 interface CustomDocDefinition {
-    pageSize?: PDFKit.PDFDocumentOptions["size"];
+    pageSize?: string;
     margins: PageMargins;
     /** Optional font registrations (custom TTF/OTF) */
     fonts?: FontRegistration[];
@@ -293,4 +296,4 @@ interface RenderEnv {
 declare function renderCustomPdf(def: CustomDocDefinition, outputPath: string): Promise<void>;
 declare function renderCustomPdfToBuffer(def: CustomDocDefinition): Promise<Buffer>;
 
-export { type Alignment, BARCODE_TYPES, type BarcodeBlock, type BarcodeType, type BaseBlock, type Block, type BuiltInFont, type ColumnsBlock, type CustomDocDefinition, type FontName, type FontRegistration, type FooterDef, type FooterInput, type HeaderDef, type ImageBlock, type InlineTextStyle, type KeyValueGridBlock, type KeyValueItem, type LineBlock, type Orientation, type PageBackgroundDef, type PageBreakBlock, type PageContext, type PageMargins, type QRErrorLevel, QR_ERROR_LEVEL, type QrCodeBlock, type RenderEnv, type SignatureBlock, type StyleDef, type StyleRef, type TableBlock, type TableCell, type TextBlock, type WatermarkDef, type WatermarkMode, type Width, renderCustomPdf, renderCustomPdfToBuffer };
+export { type Alignment, BARCODE_TYPES, type BarcodeBlock, type BarcodeType, type BaseBlock, type Block, type BuiltInFont, type ColumnsBlock, type CustomDocDefinition, type FontName, type FontRegistration, type FooterDef, type FooterInput, type HeaderDef, type ImageBlock, type InlineTextStyle, type KeyValueGridBlock, type KeyValueItem, type LineBlock, type Orientation, type PDFDoc, type PageBackgroundDef, type PageBreakBlock, type PageContext, type PageMargins, type QRErrorLevel, QR_ERROR_LEVEL, type QrCodeBlock, type RenderEnv, type SignatureBlock, type StyleDef, type StyleRef, type TableBlock, type TableCell, type TextBlock, type WatermarkDef, type WatermarkMode, type Width, renderCustomPdf, renderCustomPdfToBuffer };

package/dist/index.js

@@ -235,9 +235,7 @@ var processKeyValueGridBlock = (doc, ctx, styles, block, y, env, computeColumnPi
   const widthForCols = Math.max(totalWidth - totalGapWidth, 1);
   let colWidths;
   if (block.columnWidths && block.columnWidths.length === colCount) {
-    const safeWidths = block.columnWidths.map(
-      (w) => w === void 0 ? "*" : w
-    );
+    const safeWidths = block.columnWidths.map((w) => w === void 0 ? "*" : w);
     colWidths = computeColumnPixelWidths2(safeWidths, widthForCols);
   } else {
     const equal = widthForCols / colCount;
@@ -641,20 +639,9 @@ var processTextBlock = (doc, ctx, styles, block, y, env, ensureSpaceFor) => {
 
 // src/renderer-engine/utils/block-renderer.ts
 function createBlockRenderer(deps) {
-  const {
-    doc,
-    ctx,
-    styles,
-    computeColumnPixelWidths: computeColumnPixelWidths2,
-    finishPage: finishPage2,
-    processSignatureBlock
-  } = deps;
+  const { doc, ctx, styles, computeColumnPixelWidths: computeColumnPixelWidths2, finishPage: finishPage2, processSignatureBlock } = deps;
   const bottomLimitForContent = createBottomLimitForContent(doc, ctx);
-  const ensureSpaceFor = createEnsureSpaceFor(
-    ctx,
-    bottomLimitForContent,
-    finishPage2
-  );
+  const ensureSpaceFor = createEnsureSpaceFor(ctx, bottomLimitForContent, finishPage2);
   const measureBlockHeight = createMeasureBlockHeight({
     doc,
     styles,
@@ -666,24 +653,9 @@ function createBlockRenderer(deps) {
     }
     switch (block.type) {
       case "text":
-        return processTextBlock(
-          doc,
-          ctx,
-          styles,
-          block,
-          y,
-          env,
-          ensureSpaceFor
-        );
+        return processTextBlock(doc, ctx, styles, block, y, env, ensureSpaceFor);
       case "image":
-        return processImageBlock(
-          doc,
-          ctx,
-          block,
-          y,
-          env,
-          ensureSpaceFor
-        );
+        return processImageBlock(doc, ctx, block, y, env, ensureSpaceFor);
       case "qr": {
         const qb = block;
         const imageLike = {
@@ -702,14 +674,7 @@ function createBlockRenderer(deps) {
       case "barcode":
         return processBarcodeBlock(doc, ctx, block, y, env, ensureSpaceFor);
       case "line":
-        return processLineBlock(
-          doc,
-          ctx,
-          block,
-          y,
-          env,
-          ensureSpaceFor
-        );
+        return processLineBlock(doc, ctx, block, y, env, ensureSpaceFor);
       case "table":
         return processTableBlock(
           doc,
@@ -746,14 +711,10 @@ function createBlockRenderer(deps) {
         );
       case "signature":
         if (!env.allowPageBreak) {
-          throw new Error(
-            "Signature block is only allowed in main content flow."
-          );
+          throw new Error("Signature block is only allowed in main content flow.");
         }
         if (y !== null) {
-          throw new Error(
-            "Signature block must be part of main flow, not drawn at explicit Y."
-          );
+          throw new Error("Signature block must be part of main flow, not drawn at explicit Y.");
         }
         processSignatureBlock(block);
         return ctx.currentY;
@@ -832,13 +793,7 @@ function finishPage({
   }
   if (ctx.signatureBlock && ctx.signatureTopY !== null) {
     const env = contentEnv(doc);
-    drawSignatureBlock(
-      doc,
-      ctx.signatureBlock,
-      ctx.signatureTopY,
-      env,
-      renderBlockArray
-    );
+    drawSignatureBlock(doc, ctx.signatureBlock, ctx.signatureTopY, env, renderBlockArray);
   }
   drawFooter(doc, def, ctx, footerBandHeight, renderBlockArray);
   if (addNewPage) {
@@ -1142,13 +1097,7 @@ function createMeasureBlockHeight(deps) {
       innerWidth,
       allowPageBreak: false
     };
-    const h = measureTableHeight(
-      doc,
-      b,
-      fakeEnv,
-      styles,
-      computeColumnPixelWidths2
-    );
+    const h = measureTableHeight(doc, b, fakeEnv, styles, computeColumnPixelWidths2);
     return mt + h + mb;
   };
   const measureColumns = (b, env) => {
@@ -1238,14 +1187,8 @@ function createMeasureBlockHeight(deps) {
         const colWidth = colWidths[colIndex];
         let colHeight = 0;
         for (const item of col) {
-          const keyH = measureKVText(
-            { type: "text", text: item.key ?? "" },
-            colWidth
-          );
-          const valH = measureKVText(
-            { type: "text", text: item.value ?? "" },
-            colWidth
-          );
+          const keyH = measureKVText({ type: "text", text: item.key ?? "" }, colWidth);
+          const valH = measureKVText({ type: "text", text: item.value ?? "" }, colWidth);
           colHeight += keyH + keyValueGap + valH + rowGap;
         }
         if (colHeight > maxColHeight) maxColHeight = colHeight;
@@ -1260,16 +1203,10 @@ function createMeasureBlockHeight(deps) {
           if (!item) continue;
           const colWidth = colWidths[colIndex];
           const keyWidthPx = b.keyWidth === "*" ? Math.max(colWidth * baseKeyWidthRatio, 20) : b.keyWidth ?? 80;
-          const keyH = measureKVText(
-            { type: "text", text: item.key ?? "" },
-            keyWidthPx
-          );
+          const keyH = measureKVText({ type: "text", text: item.key ?? "" }, keyWidthPx);
           const valueXInsideCol = keyWidthPx + (separatorText ? sepBoxWidth + 4 : 4);
           const valueWidth = Math.max(colWidth - valueXInsideCol, 1);
-          const valH = measureKVText(
-            { type: "text", text: item.value ?? "" },
-            valueWidth
-          );
+          const valH = measureKVText({ type: "text", text: item.value ?? "" }, valueWidth);
           rowHeight = Math.max(rowHeight, Math.max(keyH, valH));
         }
         if (rowHeight > 0) totalHeight += rowHeight + rowGap;
@@ -1507,13 +1444,7 @@ function drawSignatureBlock(doc, block, y, env, renderBlockArray) {
   }
   doc.restore();
 }
-function createProcessSignatureBlock({
-  doc,
-  ctx,
-  styles,
-  finishPage: finishPage2,
-  contentEnvFn
-}) {
+function createProcessSignatureBlock({ doc, ctx, styles, finishPage: finishPage2, contentEnvFn }) {
   return (block) => {
     if (ctx.signatureBlock) {
       finishPage2(true);
@@ -1588,10 +1519,7 @@ function createProcessSignatureBlock({
             const tb = resolveTextBlock(styles, b);
             const localLeft2 = tb.marginLeft ?? 0;
             const localRight2 = tb.marginRight ?? 0;
-            const width = Math.max(
-              envForColumns.innerWidth - localLeft2 - localRight2,
-              1
-            );
+            const width = Math.max(envForColumns.innerWidth - localLeft2 - localRight2, 1);
             doc.fontSize(tb.fontSize ?? 10);
             const isBold = !!tb.bold;
             const isItalic = !!tb.italic;
@@ -1636,13 +1564,7 @@ function createProcessSignatureBlock({
               innerWidth: bandWidth - (t.marginLeft ?? 0) - (t.marginRight ?? 0),
               allowPageBreak: false
             };
-            return measureTableHeight(
-              doc,
-              t,
-              fakeEnv,
-              styles,
-              computeColumnPixelWidths
-            );
+            return measureTableHeight(doc, t, fakeEnv, styles, computeColumnPixelWidths);
           }
           case "columns":
             return measureColumns(b);
@@ -1674,22 +1596,10 @@ function createProcessSignatureBlock({
 }
 
 // src/renderer-engine/utils/start-page-layout.ts
-function createStartNewPageLayout({
-  doc,
-  def,
-  ctx,
-  headerBandHeight,
-  renderBlockArray
-}) {
+function createStartNewPageLayout({ doc, def, ctx, headerBandHeight, renderBlockArray }) {
   return () => {
     drawPageBackground(doc, def.pageBackground);
-    drawHeader(
-      doc,
-      def,
-      headerBandHeight,
-      def.header ?? void 0,
-      renderBlockArray
-    );
+    drawHeader(doc, def, headerBandHeight, def.header ?? void 0, renderBlockArray);
     const mode = def.watermark?.mode;
     if (def.watermark && !watermarkUsesLast(mode)) {
       drawWatermarkForPage(doc, def.watermark, ctx.pageNumber, false);
@@ -1708,14 +1618,7 @@ function watermarkUsesLast(mode) {
   return mode === "last" || mode === "firstLast" || mode === "exceptLast" || mode === "exceptFirstLast";
 }
 function drawWatermarkForPage(doc, watermark, pageNumber, isLast) {
-  const {
-    text,
-    opacity = 0.06,
-    fontSize = 60,
-    color = "gray",
-    angle = 45,
-    mode = "all"
-  } = watermark;
+  const { text, opacity = 0.06, fontSize = 60, color = "gray", angle = 45, mode = "all" } = watermark;
   const shouldDraw = (() => {
     switch (mode) {
       case "all":

package/dist/index.mjs

@@ -196,9 +196,7 @@ var processKeyValueGridBlock = (doc, ctx, styles, block, y, env, computeColumnPi
   const widthForCols = Math.max(totalWidth - totalGapWidth, 1);
   let colWidths;
   if (block.columnWidths && block.columnWidths.length === colCount) {
-    const safeWidths = block.columnWidths.map(
-      (w) => w === void 0 ? "*" : w
-    );
+    const safeWidths = block.columnWidths.map((w) => w === void 0 ? "*" : w);
     colWidths = computeColumnPixelWidths2(safeWidths, widthForCols);
   } else {
     const equal = widthForCols / colCount;
@@ -602,20 +600,9 @@ var processTextBlock = (doc, ctx, styles, block, y, env, ensureSpaceFor) => {
 
 // src/renderer-engine/utils/block-renderer.ts
 function createBlockRenderer(deps) {
-  const {
-    doc,
-    ctx,
-    styles,
-    computeColumnPixelWidths: computeColumnPixelWidths2,
-    finishPage: finishPage2,
-    processSignatureBlock
-  } = deps;
+  const { doc, ctx, styles, computeColumnPixelWidths: computeColumnPixelWidths2, finishPage: finishPage2, processSignatureBlock } = deps;
   const bottomLimitForContent = createBottomLimitForContent(doc, ctx);
-  const ensureSpaceFor = createEnsureSpaceFor(
-    ctx,
-    bottomLimitForContent,
-    finishPage2
-  );
+  const ensureSpaceFor = createEnsureSpaceFor(ctx, bottomLimitForContent, finishPage2);
   const measureBlockHeight = createMeasureBlockHeight({
     doc,
     styles,
@@ -627,24 +614,9 @@ function createBlockRenderer(deps) {
     }
     switch (block.type) {
       case "text":
-        return processTextBlock(
-          doc,
-          ctx,
-          styles,
-          block,
-          y,
-          env,
-          ensureSpaceFor
-        );
+        return processTextBlock(doc, ctx, styles, block, y, env, ensureSpaceFor);
       case "image":
-        return processImageBlock(
-          doc,
-          ctx,
-          block,
-          y,
-          env,
-          ensureSpaceFor
-        );
+        return processImageBlock(doc, ctx, block, y, env, ensureSpaceFor);
       case "qr": {
         const qb = block;
         const imageLike = {
@@ -663,14 +635,7 @@ function createBlockRenderer(deps) {
       case "barcode":
         return processBarcodeBlock(doc, ctx, block, y, env, ensureSpaceFor);
       case "line":
-        return processLineBlock(
-          doc,
-          ctx,
-          block,
-          y,
-          env,
-          ensureSpaceFor
-        );
+        return processLineBlock(doc, ctx, block, y, env, ensureSpaceFor);
       case "table":
         return processTableBlock(
           doc,
@@ -707,14 +672,10 @@ function createBlockRenderer(deps) {
         );
       case "signature":
         if (!env.allowPageBreak) {
-          throw new Error(
-            "Signature block is only allowed in main content flow."
-          );
+          throw new Error("Signature block is only allowed in main content flow.");
         }
         if (y !== null) {
-          throw new Error(
-            "Signature block must be part of main flow, not drawn at explicit Y."
-          );
+          throw new Error("Signature block must be part of main flow, not drawn at explicit Y.");
         }
         processSignatureBlock(block);
         return ctx.currentY;
@@ -793,13 +754,7 @@ function finishPage({
   }
   if (ctx.signatureBlock && ctx.signatureTopY !== null) {
     const env = contentEnv(doc);
-    drawSignatureBlock(
-      doc,
-      ctx.signatureBlock,
-      ctx.signatureTopY,
-      env,
-      renderBlockArray
-    );
+    drawSignatureBlock(doc, ctx.signatureBlock, ctx.signatureTopY, env, renderBlockArray);
   }
   drawFooter(doc, def, ctx, footerBandHeight, renderBlockArray);
   if (addNewPage) {
@@ -1103,13 +1058,7 @@ function createMeasureBlockHeight(deps) {
       innerWidth,
       allowPageBreak: false
     };
-    const h = measureTableHeight(
-      doc,
-      b,
-      fakeEnv,
-      styles,
-      computeColumnPixelWidths2
-    );
+    const h = measureTableHeight(doc, b, fakeEnv, styles, computeColumnPixelWidths2);
     return mt + h + mb;
   };
   const measureColumns = (b, env) => {
@@ -1199,14 +1148,8 @@ function createMeasureBlockHeight(deps) {
         const colWidth = colWidths[colIndex];
         let colHeight = 0;
         for (const item of col) {
-          const keyH = measureKVText(
-            { type: "text", text: item.key ?? "" },
-            colWidth
-          );
-          const valH = measureKVText(
-            { type: "text", text: item.value ?? "" },
-            colWidth
-          );
+          const keyH = measureKVText({ type: "text", text: item.key ?? "" }, colWidth);
+          const valH = measureKVText({ type: "text", text: item.value ?? "" }, colWidth);
           colHeight += keyH + keyValueGap + valH + rowGap;
         }
         if (colHeight > maxColHeight) maxColHeight = colHeight;
@@ -1221,16 +1164,10 @@ function createMeasureBlockHeight(deps) {
           if (!item) continue;
           const colWidth = colWidths[colIndex];
           const keyWidthPx = b.keyWidth === "*" ? Math.max(colWidth * baseKeyWidthRatio, 20) : b.keyWidth ?? 80;
-          const keyH = measureKVText(
-            { type: "text", text: item.key ?? "" },
-            keyWidthPx
-          );
+          const keyH = measureKVText({ type: "text", text: item.key ?? "" }, keyWidthPx);
           const valueXInsideCol = keyWidthPx + (separatorText ? sepBoxWidth + 4 : 4);
           const valueWidth = Math.max(colWidth - valueXInsideCol, 1);
-          const valH = measureKVText(
-            { type: "text", text: item.value ?? "" },
-            valueWidth
-          );
+          const valH = measureKVText({ type: "text", text: item.value ?? "" }, valueWidth);
           rowHeight = Math.max(rowHeight, Math.max(keyH, valH));
         }
         if (rowHeight > 0) totalHeight += rowHeight + rowGap;
@@ -1468,13 +1405,7 @@ function drawSignatureBlock(doc, block, y, env, renderBlockArray) {
   }
   doc.restore();
 }
-function createProcessSignatureBlock({
-  doc,
-  ctx,
-  styles,
-  finishPage: finishPage2,
-  contentEnvFn
-}) {
+function createProcessSignatureBlock({ doc, ctx, styles, finishPage: finishPage2, contentEnvFn }) {
   return (block) => {
     if (ctx.signatureBlock) {
       finishPage2(true);
@@ -1549,10 +1480,7 @@ function createProcessSignatureBlock({
             const tb = resolveTextBlock(styles, b);
             const localLeft2 = tb.marginLeft ?? 0;
             const localRight2 = tb.marginRight ?? 0;
-            const width = Math.max(
-              envForColumns.innerWidth - localLeft2 - localRight2,
-              1
-            );
+            const width = Math.max(envForColumns.innerWidth - localLeft2 - localRight2, 1);
             doc.fontSize(tb.fontSize ?? 10);
             const isBold = !!tb.bold;
             const isItalic = !!tb.italic;
@@ -1597,13 +1525,7 @@ function createProcessSignatureBlock({
               innerWidth: bandWidth - (t.marginLeft ?? 0) - (t.marginRight ?? 0),
               allowPageBreak: false
             };
-            return measureTableHeight(
-              doc,
-              t,
-              fakeEnv,
-              styles,
-              computeColumnPixelWidths
-            );
+            return measureTableHeight(doc, t, fakeEnv, styles, computeColumnPixelWidths);
           }
           case "columns":
             return measureColumns(b);
@@ -1635,22 +1557,10 @@ function createProcessSignatureBlock({
 }
 
 // src/renderer-engine/utils/start-page-layout.ts
-function createStartNewPageLayout({
-  doc,
-  def,
-  ctx,
-  headerBandHeight,
-  renderBlockArray
-}) {
+function createStartNewPageLayout({ doc, def, ctx, headerBandHeight, renderBlockArray }) {
   return () => {
     drawPageBackground(doc, def.pageBackground);
-    drawHeader(
-      doc,
-      def,
-      headerBandHeight,
-      def.header ?? void 0,
-      renderBlockArray
-    );
+    drawHeader(doc, def, headerBandHeight, def.header ?? void 0, renderBlockArray);
     const mode = def.watermark?.mode;
     if (def.watermark && !watermarkUsesLast(mode)) {
       drawWatermarkForPage(doc, def.watermark, ctx.pageNumber, false);
@@ -1669,14 +1579,7 @@ function watermarkUsesLast(mode) {
   return mode === "last" || mode === "firstLast" || mode === "exceptLast" || mode === "exceptFirstLast";
 }
 function drawWatermarkForPage(doc, watermark, pageNumber, isLast) {
-  const {
-    text,
-    opacity = 0.06,
-    fontSize = 60,
-    color = "gray",
-    angle = 45,
-    mode = "all"
-  } = watermark;
+  const { text, opacity = 0.06, fontSize = 60, color = "gray", angle = 45, mode = "all" } = watermark;
   const shouldDraw = (() => {
     switch (mode) {
       case "all":

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "av6-pdf-engine",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "module": "dist/index.mjs",
@@ -10,6 +10,7 @@
   "scripts": {
     "clean": "rm -rf dist",
     "build": "npm run clean && npm run format && tsup",
+    "prebuild": "tsc",
     "format": "prettier --write **/*.ts"
   },
   "dependencies": {