pols-pdf 1.1.4 → 1.2.1

package/dist/index.d.ts

@@ -31,10 +31,17 @@ export type PBorderColorParams = string | {
     left?: string;
     leftTop?: string;
 };
+export type PPageMarginsParams = number | {
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+    show?: boolean;
+};
 export type PPage = {
     size: 'A4' | 'LETTER';
     layout: 'portrait' | 'landscape';
-    margins: PBoundParams;
+    margins: PPageMarginsParams;
 };
 export type PFont = {
     name: string;
@@ -157,6 +164,7 @@ export declare class PPdf {
     private configPage;
     engine: typeof pdfkit;
     template?: () => void;
+    private templateIsRunning;
     private currentFont;
     get title(): string;
     set title(value: string);
@@ -176,6 +184,7 @@ export declare class PPdf {
         addFirstPage?: boolean;
     });
     addPage(config?: Partial<PPage>): void;
+    private drawMarginLines;
     rectangleTo(params: Omit<PRectangle, 'width' | 'height'>): void;
     rectangle(params: PRectangle): void;
     build(): PDFKit.PDFDocument;
@@ -198,6 +207,7 @@ export declare class PPdf {
     cell(params: PCellParams): void;
     image(params: PImage): void;
     private prepareBoundValues;
+    private prepareMarginsValues;
     private prepareRadiusValues;
     private prepareBorderValues;
     private prepareBorderColorValues;

package/dist/index.js

@@ -31,6 +31,7 @@ class PPdf {
     configPage;
     engine;
     template;
+    templateIsRunning = false;
     currentFont = {
         name: 'Helvetica',
         bold: false,
@@ -95,31 +96,47 @@ class PPdf {
             size: 'A4',
             layout: 'portrait',
             ...(params?.page ?? {}),
-            margins: this.prepareBoundValues(params?.page?.margins, {
+            margins: this.prepareMarginsValues(params?.page?.margins, {
                 left: 20,
                 top: 20,
                 right: 20,
-                bottom: 20
+                bottom: 20,
+                show: false
             })
         };
         if (params?.addFirstPage == null || params.addFirstPage)
             this.addPage();
     }
     addPage(config) {
+        if (this.templateIsRunning)
+            throw new Error(`Intento de inserción de página dentro de una llamada a la función 'template'`);
         const finalConfig = {
             ...this.configPage,
             ...(config ?? {}),
-            margins: this.prepareBoundValues(config?.margins ?? this.configPage.margins, {
-                left: 20,
-                top: 20,
-                right: 20,
-                bottom: 20
-            })
+            margins: this.prepareMarginsValues(config?.margins ?? this.configPage.margins, this.configPage.margins)
         };
         this.engine.addPage(finalConfig);
         this.configPage = finalConfig;
         this.cursor.top = finalConfig.margins.top;
-        this.template?.();
+        this.drawMarginLines();
+        this.templateIsRunning = true;
+        try {
+            this.template?.();
+        }
+        finally {
+            this.templateIsRunning = false;
+        }
+    }
+    /* Dibuja líneas grises en los márgenes de la hoja actual, sin alterar el cursor */
+    drawMarginLines() {
+        if (!this.configPage.margins.show)
+            return;
+        const left = this.configPage.margins.left;
+        const top = this.configPage.margins.top;
+        const right = this.engine.page.width - this.configPage.margins.right;
+        const bottom = this.engine.page.height - this.configPage.margins.bottom;
+        this.engine.lineWidth(0.5);
+        this.engine.path(`M${left},${top} L${right},${top} L${right},${bottom} L${left},${bottom} Z`).stroke('#999999');
     }
     rectangleTo(params) {
         this.rectangle({
@@ -374,6 +391,9 @@ class PPdf {
         if (value == 'left') {
             n = this.engine.page.margins.left;
         }
+        else if (value < 0) {
+            n = this.engine.page.width + value;
+        }
         else {
             n = value;
         }
@@ -389,6 +409,9 @@ class PPdf {
         if (value == 'top') {
             n = this.engine.page.margins.top;
         }
+        else if (value < 0) {
+            n = this.engine.page.height + value;
+        }
         else {
             n = value;
         }
@@ -757,6 +780,12 @@ class PPdf {
             return defa;
         }
     }
+    prepareMarginsValues(value, defa) {
+        return {
+            ...this.prepareBoundValues(value, defa),
+            show: (typeof value == 'object' ? value.show : undefined) ?? defa.show,
+        };
+    }
     prepareRadiusValues(value, defa = {
         leftTop: 0,
         leftBottom: 0,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "pols-pdf",
-	"version": "1.1.4",
+	"version": "1.2.1",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"scripts": {