jspdf-dynamo 1.0.4 → 1.0.6

package/README.md

@@ -4,7 +4,7 @@ jsPdf-Dynamo is a wrapper around the open-source JavaScript PDF generation libra
 template driven approach, it enables the separation of layout and formatting logic from the placement of
 data.
 
-jsPdf-Dynamo can be used with browser or NodeJs JavaScript or TypeScript applications.
+jsPdf-Dynamo can be used with browser or NodeJs applications written in JavaScript or TypeScript.
 
 Advantages of using jsPdf-Dynamo include:
 
@@ -31,8 +31,8 @@ yarn add jspdf
 There are a few basic concepts to be aware of when using jsPdf-Dynamo:
 
 - The functionality of jsPdf-Dynamo is implemented through the JsPdfDynamo class.
-- The initial page size, orientation and units of measure are set when the JsPdfDynamo instance is instantiated.
-- Output is driven by a series of plain text 'commands'. These commands can be provided as a list of strings from multiple sources, including the JavaScript or TypeScript application, or loaded from 'templates' retrieved from a URL (browser or NodeJs) or from local text files (NodeJs only).
+- The initial page size, orientation and unit of measure are set when the JsPdfDynamo instance is instantiated.
+- Output is driven by a series of plain text 'commands'. These commands can be provided as a list of strings from multiple sources, including the JavaScript or TypeScript application, or loaded from 'templates' retrieved from a URL (browser only) or from local text files (NodeJs only).
 - Positions are specified relative to the left and top margin. The exception to this are margins which are measured from the appropriate edge of the page.
 - All measurements and positions are in the unit of measure specified when the instance
   of JsPdfDynamo is created. This can be millimeters, inches, or points. The exception to this are fonts, which are always specified in points.

package/dist/index.cjs

@@ -75,19 +75,19 @@ var AppLogger = class {
       this._logger = console;
     }
   }
-  trace(message, ...args) {
+  trace(message, args) {
     this.canLog(0) ? this._logger.trace(message, args) : null;
   }
-  debug(message, ...args) {
+  debug(message, args) {
     this.canLog(1) ? this._logger.debug(message, args) : null;
   }
-  info(message, ...args) {
+  info(message, args) {
     this.canLog(2) ? this._logger.info(message, args) : null;
   }
-  warn(message, ...args) {
+  warn(message, args) {
     this.canLog(3) ? this._logger.warn(message, args) : null;
   }
-  error(message, ...args) {
+  error(message, args) {
     this.canLog(4) ? this._logger.error(message, args) : null;
   }
   logLevel(newLevel) {
@@ -264,6 +264,8 @@ function isValidFontStyle(fontStyle) {
 // src/models/jsPdfOptions.ts
 var JsPdfOptions = class {
   constructor(options = {}) {
+    this.compress = true;
+    this.putOnlyUsedFonts = true;
     var _a, _b, _c;
     this.pageSize = ((_a = options.pageSize) == null ? void 0 : _a.toLocaleLowerCase()) || "a4";
     this.orientation = ((_b = options.orientation) == null ? void 0 : _b.toLocaleLowerCase()) || "portrait";
@@ -343,15 +345,37 @@ var JsPdfProcessor = class {
     this.pageOrientation = optn.orientation;
     this.currentUom = optn.unit;
     this._pdfDocument.setLineHeightFactor(1);
+    const now = /* @__PURE__ */ new Date();
     this._variables.set(
       "_TIMEHM",
-      (/* @__PURE__ */ new Date()).toLocaleTimeString("en-US", {
+      now.toLocaleTimeString(void 0, {
         hour12: false,
         hour: "2-digit",
         minute: "2-digit"
       })
     );
-    this._variables.set("_DATEDMY", (/* @__PURE__ */ new Date()).toLocaleDateString("en-GB"));
+    this._variables.set(
+      "_DATEDDMMYYYY",
+      now.toLocaleDateString("en-GB", {
+        day: "2-digit",
+        month: "2-digit",
+        year: "numeric"
+      })
+    );
+    this._variables.set(
+      "_DATEMMDDYYYY",
+      now.toLocaleDateString("en-US", {
+        day: "2-digit",
+        month: "2-digit",
+        year: "numeric"
+      })
+    );
+    this._variables.set("_DATEISO", now.toISOString().substring(0, 10));
+    this._variables.set("_IMAGEASPECT", "1");
+    this._variables.set("_IMAGEHEIGHT", "0");
+    this._variables.set("_IMAGEHEIGHTPX", "0");
+    this._variables.set("_IMAGEWIDTH", "0");
+    this._variables.set("_IMAGEWIDTHPX", "0");
     this._variables.set("_PAGENO", "1");
     this._variables.set("_PAGES", "1");
     this.posnX = 0;
@@ -716,8 +740,8 @@ var JsPdfProcessor = class {
       this.pageWidth = document.internal.pageSize.width - this._marginLeft - this._marginRight;
     }
   }
-  addImageFromFile(input) {
-    const subs = this.logAndParseCommand(".addImageFromFile", input);
+  LoadImageFromFile(input) {
+    const subs = this.logAndParseCommand(".LoadImageFromFile", input);
     let fileName = subs;
     if (!fileName) {
       this.lastError = "A file name is required.";
@@ -738,9 +762,9 @@ var JsPdfProcessor = class {
       this.lastResult = "0";
     }
   }
-  addImageFromUrl(input) {
+  LoadImageFromUrl(input) {
     return __async(this, null, function* () {
-      const subs = this.logAndParseCommand(".addImageFromUrl", input);
+      const subs = this.logAndParseCommand(".LoadImageFromUrl", input);
       let url = subs;
       if (!url) {
         this.lastError = "A URL is required.";
@@ -783,6 +807,10 @@ var JsPdfProcessor = class {
       this.setFixedDec(this.pixelsToUom(info.height), 3)
     );
     this._variables.set("_IMAGEHEIGHTPX", info.height.toString());
+    this._variables.set(
+      "_IMAGEASPECT",
+      info.height > 0 ? this.setFixedDec(info.width / info.height, 3) : "1"
+    );
   }
   getContentType(fileName) {
     const mediaType = fileName.split(".").pop();
@@ -846,6 +874,8 @@ var JsPdfProcessor = class {
     const subs = this.logAndParseCommand(".drawDebugGrid", input);
     const savedLineColour = this.lineColour;
     const savedLineWidth = this.lineWidth;
+    const savedX = this.posnX;
+    const savedY = this.posnY;
     const mm = 0.1;
     const pts = mmToPoints(mm);
     const lineWidth = this.pointsToUom(pts);
@@ -902,6 +932,8 @@ var JsPdfProcessor = class {
     }
     this.lineColour = savedLineColour;
     this.lineWidth = savedLineWidth;
+    this.posnX = savedX;
+    this.posnY = savedY;
   }
   drawLine(input) {
     const subs = this.logAndParseCommand(".drawLine", input);
@@ -941,7 +973,7 @@ var JsPdfProcessor = class {
       return;
     }
     if (isNaN(imageNo) || imageNo < 0 || imageNo > this._images.length - 1) {
-      this.lastError = this._images.length ? "The image number must be in the range of 0 to " + (this._images.length - 1).toString() : "Only one image has been loaded, the image number can only be 0";
+      this.lastError = this._images.length > 1 ? `The image number ${imageNo} must be in the range of 0 to ${(this._images.length - 1).toString()}` : "Only one image has been loaded, the image number can only be 0";
       this.lastResult = "0";
       return;
     }
@@ -992,7 +1024,6 @@ var JsPdfProcessor = class {
     this.lastResult = "1";
   }
   drawText(input) {
-    var _a;
     const subs = this.logAndParseCommand(".drawText", input);
     const { first: left, rest: rest1 } = getNextNumber(subs);
     const { first: top, rest: rest2 } = getNextNumber(rest1);
@@ -1004,7 +1035,7 @@ var JsPdfProcessor = class {
     this.lastObjectWidth = 0;
     this.lastResult = "1";
     if (lines.length > 1) {
-      this.lastError = `Text was truncated to fit within the available width (${(_a = lines[0]) == null ? void 0 : _a.substring(0, 20)}...)`;
+      this.lastError = `Text was truncated to fit within the available width (${rest2.substring(0, 20)}...) on page ${this._currentPageNumber}.`;
       this.lastResult = "0";
       if (lines[0]) {
         if (this._pdfDocument.getTextWidth(lines[0]) < maxWidth) {
@@ -1310,10 +1341,11 @@ var JsPdfProcessor = class {
   }
   ifNotBlank(jsPdfDynamo, input) {
     return __async(this, null, function* () {
-      let { first: variable, rest } = getNextString(input);
+      let { first: value1, rest } = getNextString(input);
       const subs = this.substitute(rest.trim());
-      this._logger.debug(".ifNotBlank " + variable + " " + subs);
-      let value = this._variables.get(variable.toLocaleUpperCase()) || "";
+      this._logger.debug(".ifNotBlank " + value1 + " " + subs);
+      const variable1 = this.substitute(value1);
+      let value = this._variables.get(variable1.toLocaleUpperCase()) || "";
       this.lastResult = "-1";
       if (value.trim() !== "") {
         yield jsPdfDynamo.processDot(this, rest);
@@ -1396,6 +1428,51 @@ var JsPdfProcessor = class {
       "Variable " + varName + " incremented to " + this._variables.get(varName)
     );
   }
+  divVar(input) {
+    let subs = this.substitute(input.trim());
+    this._logger.debug(".divVar " + subs);
+    let { first: varName, rest } = getNextString(subs.toLocaleUpperCase());
+    if (varName === "") {
+      this.lastResult = "0";
+      this.lastError = "DivVar must reference a variable";
+      return;
+    }
+    if (varName.startsWith("_")) {
+      this.lastResult = "0";
+      this.lastError = "DivVar can not be used to update system maintained variables";
+      return;
+    }
+    let varValue = this._variables.get(varName);
+    if (!varValue) {
+      this.lastResult = "0";
+      this.lastError = "Variable '" + varName + "' is not defined";
+      return;
+    }
+    if (isNaN(Number(varValue))) {
+      this._variables.set(varName, "0");
+    }
+    while (rest.length > 0) {
+      const { first: nextOp, rest: remainder } = getNextNumber(rest, 4);
+      rest = remainder;
+      let varValue2 = this._variables.get(varName);
+      if (!isNaN(Number(nextOp)) && Number(nextOp) === 0) {
+        this.lastResult = "0";
+        this.lastError = "Divide by zero error";
+        return;
+      }
+      if (!isNaN(Number(varValue2)) && !isNaN(Number(nextOp))) {
+        this._variables.set(
+          varName,
+          removeTrailingZeros((Number(varValue2) / Number(nextOp)).toFixed(4))
+        );
+      }
+      varValue2 = this._variables.get(varName);
+    }
+    this.lastResult = "1";
+    this._logger.trace(
+      "Variable " + varName + " incremented to " + this._variables.get(varName)
+    );
+  }
   multVar(input) {
     let subs = this.substitute(input.trim());
     this._logger.debug(".multVar " + subs);
@@ -1522,9 +1599,14 @@ var JsPdfProcessor = class {
     }
   }
   setFillColour(input) {
-    let subs = this.substitute(input);
-    this._logger.debug(".setFillColour " + subs);
-    this.fillColour = subs;
+    const subs = this.logAndParseCommand(".setFillColour", input);
+    const { first: fillColour } = getNextString(subs);
+    if (fillColour === "") {
+      this.lastResult = "0";
+      this.lastError = "A fill colour must be specified";
+      return;
+    }
+    this.fillColour = fillColour;
     this.lastResult = "1";
   }
   setFontName(input) {
@@ -1540,14 +1622,25 @@ var JsPdfProcessor = class {
   }
   setFontSize(input) {
     const subs = this.logAndParseCommand(".setFontSize", input);
-    let { first: size } = getNextNumber(subs);
-    if (size > 0) {
-      this.fontPointSize = size;
-      this.lastResult = "1";
-    } else {
+    if (subs === "") {
+      this.lastResult = "0";
+      this.lastError = "A font size must be specified";
+      return;
+    }
+    let { first: sizeAlpha } = getNextNumber(subs);
+    const size = Number(sizeAlpha);
+    if (Number.isNaN(size)) {
+      this.lastResult = "0";
+      this.lastError = `A font size must be a number. '${sizeAlpha}' is not a number.`;
+      return;
+    }
+    if (size <= 0) {
       this.lastResult = "0";
-      this.lastError = "Invalid font size " + size;
+      this.lastError = "A font size must be greater than 0";
+      return;
     }
+    this.fontPointSize = size;
+    this.lastResult = "1";
   }
   setFontStyle(input) {
     const subs = this.logAndParseCommand(".setFontStyle", input);
@@ -1566,9 +1659,14 @@ var JsPdfProcessor = class {
     this.lastResult = "1";
   }
   setLineColour(input) {
-    let subs = this.substitute(input);
-    this._logger.debug(".setLineColour " + subs);
-    this.lineColour = subs;
+    const subs = this.logAndParseCommand(".setFontStyle", input);
+    const { first: lineColour } = getNextString(subs);
+    if (lineColour === "") {
+      this.lastResult = "0";
+      this.lastError = "A line colour must be specified";
+      return;
+    }
+    this.lineColour = lineColour;
     this.lastResult = "1";
   }
   setLineWidth(input) {
@@ -1674,7 +1772,13 @@ var JsPdfProcessor = class {
   }
   setTextColour(input) {
     const subs = this.logAndParseCommand(".setTextColour", input);
-    this.textColour = subs;
+    const { first: textColour } = getNextString(subs);
+    if (textColour === "") {
+      this.lastResult = "0";
+      this.lastError = "A text colour must be specified";
+      return;
+    }
+    this.textColour = textColour;
     this.lastResult = "1";
   }
   copyVar(input) {
@@ -1844,11 +1948,9 @@ var JsPdfDynamo = class {
       return null;
     }
   }
-  toBlobUrl(fileName) {
+  toBlobUrl() {
     try {
-      const result = this._processor.PdfDocument.output("bloburi", {
-        filename: fileName
-      });
+      const result = this._processor.PdfDocument.output("bloburi");
       return result;
     } catch (e) {
       __privateGet(this, _appLogger).warn(
@@ -1879,7 +1981,7 @@ var JsPdfDynamo = class {
   }
   processTemplate(processor, input) {
     return __async(this, null, function* () {
-      let inGroupProcessing = false;
+      let inGroupLoading = false;
       let grpName = "";
       let currGroup = [];
       for (let ix = 0; ix < input.length; ix++) {
@@ -1888,12 +1990,8 @@ var JsPdfDynamo = class {
           continue;
         }
         if (currLine.startsWith("[")) {
-          if (inGroupProcessing) {
-            inGroupProcessing = false;
-            __privateGet(this, _appLogger).debug(
-              `Finished loading group ${grpName}   (${currLine})
-`
-            );
+          if (inGroupLoading) {
+            inGroupLoading = false;
           } else {
             if (currLine.length === 1) continue;
             grpName = currLine.substring(1);
@@ -1902,15 +2000,14 @@ var JsPdfDynamo = class {
               grpName = grpName.substring(0, iy);
             }
             grpName = grpName.trim().toLocaleUpperCase();
-            inGroupProcessing = true;
-            __privateGet(this, _appLogger).debug(`Loading group ${grpName}   (${currLine})
-`);
+            inGroupLoading = true;
+            __privateGet(this, _appLogger).debug(`Loading group ${grpName}`);
             currGroup = [];
             __privateGet(this, _groups)[grpName] = currGroup;
           }
           continue;
         }
-        if (inGroupProcessing) {
+        if (inGroupLoading) {
           currGroup.push(currLine);
           __privateGet(this, _appLogger).trace(`  ${currLine}`);
           continue;
@@ -1934,12 +2031,6 @@ var JsPdfDynamo = class {
         case "AddBookmark".toLowerCase():
           processor.addBookmark(parameters);
           return;
-        case "AddImageFromFile".toLowerCase():
-          processor.addImageFromFile(parameters);
-          return;
-        case "AddImageFromUrl".toLowerCase():
-          yield processor.addImageFromUrl(parameters);
-          return;
         case "AddPage".toLowerCase():
           processor.addPage(parameters);
           return;
@@ -1949,6 +2040,9 @@ var JsPdfDynamo = class {
         case "CopyVar".toLowerCase():
           processor.copyVar(parameters);
           return;
+        case "DivVar".toLowerCase():
+          processor.divVar(parameters);
+          return;
         case "Do".toLowerCase():
           yield this.processGroups(processor, parameters);
           return;
@@ -2009,6 +2103,12 @@ var JsPdfDynamo = class {
         case "IncVar".toLowerCase():
           processor.incVar(parameters);
           return;
+        case "LoadImageFromFile".toLowerCase():
+          processor.LoadImageFromFile(parameters);
+          return;
+        case "LoadImageFromUrl".toLowerCase():
+          yield processor.LoadImageFromUrl(parameters);
+          return;
         case "MultVar".toLowerCase():
           processor.multVar(parameters);
           return;
@@ -2085,9 +2185,11 @@ var JsPdfDynamo = class {
         let { first: group, rest } = getNextString(subs);
         subs = rest;
         __privateGet(this, _appLogger).debug(`
-[${group}]`);
+[${group} - Enter]`);
         if (__privateGet(this, _groups)[group]) {
           yield this.processTemplate(processor, __privateGet(this, _groups)[group]);
+          __privateGet(this, _appLogger).debug(`[${group} - Exit]
+`);
         } else {
           __privateGet(this, _appLogger).warn(`Group ${group} was not found.`);
           processor.lastResult = "0";

package/dist/index.d.cts

@@ -1,21 +1,21 @@
 import jsPDF from 'jspdf';
 
 interface ILogger {
-    debug: (message: string, ...args: any | null) => void;
-    error: (message: string, ...args: any | null) => void;
-    info: (message: string, ...args: any | null) => void;
-    trace: (message: string, ...args: any | null) => void;
-    warn: (message: string, ...args: any | null) => void;
+    debug: (message: string, args?: any) => void;
+    error: (message: string, args?: any) => void;
+    info: (message: string, args?: any) => void;
+    trace: (message: string, args?: any) => void;
+    warn: (message: string, args?: any) => void;
 }
 declare class AppLogger implements ILogger {
     private _logLevel;
     private _logger;
     constructor(logger?: ILogger | null);
-    trace(message: string, ...args: any | null): void;
-    debug(message: string, ...args: any | null): void;
-    info(message: string, ...args: any | null): void;
-    warn(message: string, ...args: any | null): void;
-    error(message: string, ...args: any | null): void;
+    trace(message: string, args?: any): void;
+    debug(message: string, args?: any): void;
+    info(message: string, args?: any): void;
+    warn(message: string, args?: any): void;
+    error(message: string, args?: any): void;
     logLevel(newLevel: string | number): void;
     private canLog;
 }
@@ -193,6 +193,7 @@ declare const pageSizes: {
 type pageSizeType = keyof typeof pageSizes;
 
 interface IJsPdfOptions {
+    compress: boolean;
     margins: {
         top: number;
         bottom: number;
@@ -200,6 +201,7 @@ interface IJsPdfOptions {
         right: number;
     };
     pageSize: pageSizeType;
+    putOnlyUsedFonts: boolean;
     orientation: "portrait" | "landscape" | "p" | "l";
     unit: "mm" | "in" | "pt";
 }
@@ -307,8 +309,8 @@ declare class JsPdfProcessor {
     addBookmark(input: string): void;
     addPage(input?: string): void;
     private calcPageDimensions;
-    addImageFromFile(input: string): void;
-    addImageFromUrl(input: string): Promise<void>;
+    LoadImageFromFile(input: string): void;
+    LoadImageFromUrl(input: string): Promise<void>;
     private saveImage;
     private getContentType;
     checkPage(jsPdfDynamo: JsPdfDynamo, input: string): Promise<void>;
@@ -329,6 +331,7 @@ declare class JsPdfProcessor {
     incCurrentX(input: string): void;
     incCurrentY(input: string): void;
     incVar(input: string): void;
+    divVar(input: string): void;
     multVar(input: string): void;
     savePdf(input: string): void;
     selectPage(input: string): void;
@@ -365,7 +368,7 @@ declare class JsPdfDynamo {
     _processor: JsPdfProcessor;
     constructor(options?: Partial<IJsPdfOptions>, logger?: ILogger | null);
     toBlob(): Blob | null;
-    toBlobUrl(fileName?: string): string | null;
+    toBlobUrl(): string | null;
     getVariable(variableName: string): string | null;
     private prepareNewPdf;
     prepareWrappedString(input: string): string;

package/dist/index.d.ts

@@ -1,21 +1,21 @@
 import jsPDF from 'jspdf';
 
 interface ILogger {
-    debug: (message: string, ...args: any | null) => void;
-    error: (message: string, ...args: any | null) => void;
-    info: (message: string, ...args: any | null) => void;
-    trace: (message: string, ...args: any | null) => void;
-    warn: (message: string, ...args: any | null) => void;
+    debug: (message: string, args?: any) => void;
+    error: (message: string, args?: any) => void;
+    info: (message: string, args?: any) => void;
+    trace: (message: string, args?: any) => void;
+    warn: (message: string, args?: any) => void;
 }
 declare class AppLogger implements ILogger {
     private _logLevel;
     private _logger;
     constructor(logger?: ILogger | null);
-    trace(message: string, ...args: any | null): void;
-    debug(message: string, ...args: any | null): void;
-    info(message: string, ...args: any | null): void;
-    warn(message: string, ...args: any | null): void;
-    error(message: string, ...args: any | null): void;
+    trace(message: string, args?: any): void;
+    debug(message: string, args?: any): void;
+    info(message: string, args?: any): void;
+    warn(message: string, args?: any): void;
+    error(message: string, args?: any): void;
     logLevel(newLevel: string | number): void;
     private canLog;
 }
@@ -193,6 +193,7 @@ declare const pageSizes: {
 type pageSizeType = keyof typeof pageSizes;
 
 interface IJsPdfOptions {
+    compress: boolean;
     margins: {
         top: number;
         bottom: number;
@@ -200,6 +201,7 @@ interface IJsPdfOptions {
         right: number;
     };
     pageSize: pageSizeType;
+    putOnlyUsedFonts: boolean;
     orientation: "portrait" | "landscape" | "p" | "l";
     unit: "mm" | "in" | "pt";
 }
@@ -307,8 +309,8 @@ declare class JsPdfProcessor {
     addBookmark(input: string): void;
     addPage(input?: string): void;
     private calcPageDimensions;
-    addImageFromFile(input: string): void;
-    addImageFromUrl(input: string): Promise<void>;
+    LoadImageFromFile(input: string): void;
+    LoadImageFromUrl(input: string): Promise<void>;
     private saveImage;
     private getContentType;
     checkPage(jsPdfDynamo: JsPdfDynamo, input: string): Promise<void>;
@@ -329,6 +331,7 @@ declare class JsPdfProcessor {
     incCurrentX(input: string): void;
     incCurrentY(input: string): void;
     incVar(input: string): void;
+    divVar(input: string): void;
     multVar(input: string): void;
     savePdf(input: string): void;
     selectPage(input: string): void;
@@ -365,7 +368,7 @@ declare class JsPdfDynamo {
     _processor: JsPdfProcessor;
     constructor(options?: Partial<IJsPdfOptions>, logger?: ILogger | null);
     toBlob(): Blob | null;
-    toBlobUrl(fileName?: string): string | null;
+    toBlobUrl(): string | null;
     getVariable(variableName: string): string | null;
     private prepareNewPdf;
     prepareWrappedString(input: string): string;