jspdf-dynamo 1.0.6 → 1.0.8

package/dist/index.cjs

@@ -55,11 +55,11 @@ var __async = (__this, __arguments, generator) => {
 };
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   JsPdfDynamo: () => JsPdfDynamo
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/models/jsPdfProcessor.ts
 var import_jspdf = __toESM(require("jspdf"), 1);
@@ -842,6 +842,16 @@ var JsPdfProcessor = class {
     if (!this.checkPosition(left, top)) {
       return;
     }
+    if (isNaN(width)) {
+      this.lastError = `The width of the box is not a number`;
+      this.lastResult = "0";
+      return;
+    }
+    if (isNaN(height)) {
+      this.lastError = `The height of the box is not a number`;
+      this.lastResult = "0";
+      return;
+    }
     this.posnX = left;
     this.posnY = top;
     let lineWidthAdjustment = this._lineWidth;
@@ -862,6 +872,10 @@ var JsPdfProcessor = class {
         style = "FD";
         this._pdfDocument.setFillColor(this.fillColour);
         break;
+      default:
+        this.lastError = `The box style option '${boxType}' is not valid. It must be '0', '1' or '2'`;
+        this.lastResult = "0";
+        return;
     }
     this._pdfDocument.rect(x, y, w, h, style);
     this.posnX = this.posnX + width + this.spaceHoz;
@@ -870,6 +884,51 @@ var JsPdfProcessor = class {
     this.lastObjectWidth = width;
     this.lastResult = "1";
   }
+  drawCircle(input) {
+    const subs = this.logAndParseCommand(".drawCircle", input);
+    const { first: left, rest: rest1 } = getNextNumber(subs);
+    const { first: top, rest: rest2 } = getNextNumber(rest1);
+    const { first: radius, rest: rest3 } = getNextNumber(rest2);
+    const { first: option } = getNextNumber(rest3);
+    if (!this.checkPosition(left, top)) {
+      return;
+    }
+    if (isNaN(radius)) {
+      this.lastError = `The radius of the circle is not a number`;
+      this.lastResult = "0";
+      return;
+    }
+    this.posnX = left;
+    this.posnY = top;
+    const x = this.posnX + this._marginLeft;
+    const y = this.posnY + this._marginTop;
+    let r = radius;
+    let style = "S";
+    switch (option) {
+      case 0:
+        r -= this._lineWidth * 0.5;
+        break;
+      case 1:
+        style = "F";
+        this._pdfDocument.setFillColor(this.fillColour);
+        break;
+      case 2:
+        style = "FD";
+        this._pdfDocument.setFillColor(this.fillColour);
+        r -= this._lineWidth * 0.5;
+        break;
+      default:
+        this.lastError = `The circle style option '${option}' is not valid. It must be '0', '1' or '2'`;
+        this.lastResult = "0";
+        return;
+    }
+    this._pdfDocument.circle(x, y, r, style);
+    this.lastObjectHeight = radius * 2;
+    this.lastObjectWidth = this.lastObjectHeight;
+    this.posnX = this.posnX + radius + this.spaceHoz;
+    this.posnY = this.posnY + radius + this.spaceVert;
+    this.lastResult = "1";
+  }
   drawDebugGrid(input) {
     const subs = this.logAndParseCommand(".drawDebugGrid", input);
     const savedLineColour = this.lineColour;
@@ -935,6 +994,60 @@ var JsPdfProcessor = class {
     this.posnX = savedX;
     this.posnY = savedY;
   }
+  drawEllipse(input) {
+    const subs = this.logAndParseCommand(".drawEllipse", input);
+    const { first: left, rest: rest1 } = getNextNumber(subs);
+    const { first: top, rest: rest2 } = getNextNumber(rest1);
+    const { first: radiusX, rest: rest3 } = getNextNumber(rest2);
+    const { first: radiusY, rest: rest4 } = getNextNumber(rest3);
+    const { first: option } = getNextNumber(rest4);
+    if (!this.checkPosition(left, top)) {
+      return;
+    }
+    if (isNaN(radiusX)) {
+      this.lastError = `The horizontal radius of the ellipse is not a number`;
+      this.lastResult = "0";
+      return;
+    }
+    if (isNaN(radiusY)) {
+      this.lastError = `The vertical radius of the ellipse is not a number`;
+      this.lastResult = "0";
+      return;
+    }
+    this.posnX = left;
+    this.posnY = top;
+    const x = this.posnX + this._marginLeft;
+    const y = this.posnY + this._marginTop;
+    let rx = radiusX;
+    let ry = radiusY;
+    let style = "S";
+    switch (option) {
+      case 0:
+        rx -= this._lineWidth * 0.5;
+        ry -= this._lineWidth * 0.5;
+        break;
+      case 1:
+        style = "F";
+        this._pdfDocument.setFillColor(this.fillColour);
+        break;
+      case 2:
+        style = "FD";
+        this._pdfDocument.setFillColor(this.fillColour);
+        rx -= this._lineWidth * 0.5;
+        ry -= this._lineWidth * 0.5;
+        break;
+      default:
+        this.lastError = `The circle style option '${option}' is not valid. It must be '0', '1' or '2'`;
+        this.lastResult = "0";
+        return;
+    }
+    this._pdfDocument.ellipse(x, y, rx, ry, style);
+    this.lastObjectHeight = radiusY * 2;
+    this.lastObjectWidth = radiusX * 2;
+    this.posnX = this.posnX + radiusX + this.spaceHoz;
+    this.posnY = this.posnY + radiusY + this.spaceVert;
+    this.lastResult = "1";
+  }
   drawLine(input) {
     const subs = this.logAndParseCommand(".drawLine", input);
     const { first: left, rest: rest1 } = getNextNumber(subs);
@@ -1517,6 +1630,7 @@ var JsPdfProcessor = class {
     let subs = this.logAndParseCommand(".savePdf", input.trim());
     if (isBrowser()) {
       this.lastError = "SavePdf is not supported in the browser";
+      this._logger.warn(this.lastError);
       this.lastResult = "0";
       return;
     }
@@ -1552,6 +1666,7 @@ var JsPdfProcessor = class {
     this.lastResult = pageNo.toString();
     this.posnX = 0;
     this.posnY = 0;
+    this.lastResult = "1";
   }
   setCurrentFont(fontName, fontStyle) {
     this._pdfDocument.setFont(fontName, fontStyle);
@@ -2052,9 +2167,15 @@ var JsPdfDynamo = class {
         case "DrawBox".toLowerCase():
           processor.drawBox(parameters);
           return;
+        case "DrawCircle".toLowerCase():
+          processor.drawCircle(parameters);
+          return;
         case "DrawDebugGrid".toLowerCase():
           processor.drawDebugGrid(parameters);
           return;
+        case "DrawEllipse".toLowerCase():
+          processor.drawEllipse(parameters);
+          return;
         case "DrawImage".toLowerCase():
           processor.drawImage(parameters);
           return;

package/dist/index.d.cts

@@ -315,7 +315,9 @@ declare class JsPdfProcessor {
     private getContentType;
     checkPage(jsPdfDynamo: JsPdfDynamo, input: string): Promise<void>;
     drawBox(input: string): void;
+    drawCircle(input: string): void;
     drawDebugGrid(input: string): void;
+    drawEllipse(input: string): void;
     drawLine(input: string): void;
     drawImage(input: string): void;
     drawText(input: string): void;

package/dist/index.d.ts

@@ -315,7 +315,9 @@ declare class JsPdfProcessor {
     private getContentType;
     checkPage(jsPdfDynamo: JsPdfDynamo, input: string): Promise<void>;
     drawBox(input: string): void;
+    drawCircle(input: string): void;
     drawDebugGrid(input: string): void;
+    drawEllipse(input: string): void;
     drawLine(input: string): void;
     drawImage(input: string): void;
     drawText(input: string): void;

package/dist/index.js

@@ -813,6 +813,16 @@ var JsPdfProcessor = class {
     if (!this.checkPosition(left, top)) {
       return;
     }
+    if (isNaN(width)) {
+      this.lastError = `The width of the box is not a number`;
+      this.lastResult = "0";
+      return;
+    }
+    if (isNaN(height)) {
+      this.lastError = `The height of the box is not a number`;
+      this.lastResult = "0";
+      return;
+    }
     this.posnX = left;
     this.posnY = top;
     let lineWidthAdjustment = this._lineWidth;
@@ -833,6 +843,10 @@ var JsPdfProcessor = class {
         style = "FD";
         this._pdfDocument.setFillColor(this.fillColour);
         break;
+      default:
+        this.lastError = `The box style option '${boxType}' is not valid. It must be '0', '1' or '2'`;
+        this.lastResult = "0";
+        return;
     }
     this._pdfDocument.rect(x, y, w, h, style);
     this.posnX = this.posnX + width + this.spaceHoz;
@@ -841,6 +855,51 @@ var JsPdfProcessor = class {
     this.lastObjectWidth = width;
     this.lastResult = "1";
   }
+  drawCircle(input) {
+    const subs = this.logAndParseCommand(".drawCircle", input);
+    const { first: left, rest: rest1 } = getNextNumber(subs);
+    const { first: top, rest: rest2 } = getNextNumber(rest1);
+    const { first: radius, rest: rest3 } = getNextNumber(rest2);
+    const { first: option } = getNextNumber(rest3);
+    if (!this.checkPosition(left, top)) {
+      return;
+    }
+    if (isNaN(radius)) {
+      this.lastError = `The radius of the circle is not a number`;
+      this.lastResult = "0";
+      return;
+    }
+    this.posnX = left;
+    this.posnY = top;
+    const x = this.posnX + this._marginLeft;
+    const y = this.posnY + this._marginTop;
+    let r = radius;
+    let style = "S";
+    switch (option) {
+      case 0:
+        r -= this._lineWidth * 0.5;
+        break;
+      case 1:
+        style = "F";
+        this._pdfDocument.setFillColor(this.fillColour);
+        break;
+      case 2:
+        style = "FD";
+        this._pdfDocument.setFillColor(this.fillColour);
+        r -= this._lineWidth * 0.5;
+        break;
+      default:
+        this.lastError = `The circle style option '${option}' is not valid. It must be '0', '1' or '2'`;
+        this.lastResult = "0";
+        return;
+    }
+    this._pdfDocument.circle(x, y, r, style);
+    this.lastObjectHeight = radius * 2;
+    this.lastObjectWidth = this.lastObjectHeight;
+    this.posnX = this.posnX + radius + this.spaceHoz;
+    this.posnY = this.posnY + radius + this.spaceVert;
+    this.lastResult = "1";
+  }
   drawDebugGrid(input) {
     const subs = this.logAndParseCommand(".drawDebugGrid", input);
     const savedLineColour = this.lineColour;
@@ -906,6 +965,60 @@ var JsPdfProcessor = class {
     this.posnX = savedX;
     this.posnY = savedY;
   }
+  drawEllipse(input) {
+    const subs = this.logAndParseCommand(".drawEllipse", input);
+    const { first: left, rest: rest1 } = getNextNumber(subs);
+    const { first: top, rest: rest2 } = getNextNumber(rest1);
+    const { first: radiusX, rest: rest3 } = getNextNumber(rest2);
+    const { first: radiusY, rest: rest4 } = getNextNumber(rest3);
+    const { first: option } = getNextNumber(rest4);
+    if (!this.checkPosition(left, top)) {
+      return;
+    }
+    if (isNaN(radiusX)) {
+      this.lastError = `The horizontal radius of the ellipse is not a number`;
+      this.lastResult = "0";
+      return;
+    }
+    if (isNaN(radiusY)) {
+      this.lastError = `The vertical radius of the ellipse is not a number`;
+      this.lastResult = "0";
+      return;
+    }
+    this.posnX = left;
+    this.posnY = top;
+    const x = this.posnX + this._marginLeft;
+    const y = this.posnY + this._marginTop;
+    let rx = radiusX;
+    let ry = radiusY;
+    let style = "S";
+    switch (option) {
+      case 0:
+        rx -= this._lineWidth * 0.5;
+        ry -= this._lineWidth * 0.5;
+        break;
+      case 1:
+        style = "F";
+        this._pdfDocument.setFillColor(this.fillColour);
+        break;
+      case 2:
+        style = "FD";
+        this._pdfDocument.setFillColor(this.fillColour);
+        rx -= this._lineWidth * 0.5;
+        ry -= this._lineWidth * 0.5;
+        break;
+      default:
+        this.lastError = `The circle style option '${option}' is not valid. It must be '0', '1' or '2'`;
+        this.lastResult = "0";
+        return;
+    }
+    this._pdfDocument.ellipse(x, y, rx, ry, style);
+    this.lastObjectHeight = radiusY * 2;
+    this.lastObjectWidth = radiusX * 2;
+    this.posnX = this.posnX + radiusX + this.spaceHoz;
+    this.posnY = this.posnY + radiusY + this.spaceVert;
+    this.lastResult = "1";
+  }
   drawLine(input) {
     const subs = this.logAndParseCommand(".drawLine", input);
     const { first: left, rest: rest1 } = getNextNumber(subs);
@@ -1488,6 +1601,7 @@ var JsPdfProcessor = class {
     let subs = this.logAndParseCommand(".savePdf", input.trim());
     if (isBrowser()) {
       this.lastError = "SavePdf is not supported in the browser";
+      this._logger.warn(this.lastError);
       this.lastResult = "0";
       return;
     }
@@ -1523,6 +1637,7 @@ var JsPdfProcessor = class {
     this.lastResult = pageNo.toString();
     this.posnX = 0;
     this.posnY = 0;
+    this.lastResult = "1";
   }
   setCurrentFont(fontName, fontStyle) {
     this._pdfDocument.setFont(fontName, fontStyle);
@@ -2023,9 +2138,15 @@ var JsPdfDynamo = class {
         case "DrawBox".toLowerCase():
           processor.drawBox(parameters);
           return;
+        case "DrawCircle".toLowerCase():
+          processor.drawCircle(parameters);
+          return;
         case "DrawDebugGrid".toLowerCase():
           processor.drawDebugGrid(parameters);
           return;
+        case "DrawEllipse".toLowerCase():
+          processor.drawEllipse(parameters);
+          return;
         case "DrawImage".toLowerCase():
           processor.drawImage(parameters);
           return;

package/documentation/3. Variables/SystemMaintained.txt

@@ -9,6 +9,12 @@
 .SetVar text Note that unless otherwise stated, all distances and positions are in the unit of measure specified
 .SetVar text %text% when creating the JsPdfDynamo object.
 .DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
+.SetVar text %text% variables can not be changed directly by using the SetVar command. 
+.DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
+.incCurrentY %halfLineGap%
+.SetVar text Note that unless otherwise stated, all distances and positions are in the unit of measure specified
+.SetVar text %text% when creating the JsPdfDynamo object.
+.DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
 .incCurrentY %halfLineGap%
 .SetMargin L 20
 

package/documentation/4. Commands/DrawBox.txt

@@ -10,10 +10,10 @@
 .SetVar CommandSubHeading Parameters
 .Do CommandSubHeading
 .SetVar CommandLine1 Left
-.SetVar CommandLine2 The horizontal starting position of the box, measured from the left margin.
+.SetVar CommandLine2 The horizontal top left corner of the box, measured from the left margin.
 .Do CommandLine2
 .SetVar CommandLine1 Top
-.SetVar CommandLine2 The vertical starting position of the box, measured from the top margin.
+.SetVar CommandLine2 The vertical top left corner of the box, measured from the top margin.
 .Do CommandLine2
 .SetVar CommandLine1 Width
 .SetVar CommandLine2 The width of the box.
@@ -25,15 +25,12 @@
 .SetVar CommandLine2 Specifies how the box is drawn:
 .Do CommandLine2
 .incCurrentY %halfLineGap%
-.SetVar CommandLine3 0 - An outline of the box is drawn
+.SetVar CommandLine3 0 - An outline of the box is drawn using the current line width
 .Do CommandLine2
-.SetVar CommandLine3 1 - A filled box, without an outline is drawn
+.SetVar CommandLine3 1 - A box filled with the current fill colour, without an outline is drawn
 .Do CommandLine2
-.SetVar CommandLine3 2 - A filled box, with an outline is drawn
+.SetVar CommandLine3 2 - A box filled with the current fill colour, with an outline is drawn using the current line width
 .Do CommandLine2
-.incCurrentY %halfLineGap%
-.SetVar CommandLine1 All measurements are in the unit of measure specified when the JsPdfDynamo object was created.
-.Do CommandLine
 
 .SetVar CommandSubHeading Other
 .Do CommandSubHeading
@@ -62,6 +59,6 @@
 
 .SetVar CommandSubHeading See Also
 .Do CommandSubHeading
-.SetVar CommandLine1 SetFillColour, SetLineColour, SetLineWidth
+.SetVar CommandLine1 DrawCircle, DrawEllipse, DrawLine, SetFillColour, SetLineColour, SetLineWidth
 .Do CommandLine2
 .incCurrentY %_FontHeight%

package/documentation/4. Commands/DrawCircle.txt

@@ -0,0 +1,71 @@
+.SetVar CommandName DrawCircle
+.Do CommandHeading
+.SetVar CommandLine1 Draw a circle, centered at the given point using the current fill colour, 
+.SetVar CommandLine1 %CommandLine1% line colour and line width.
+.Do CommandLine
+
+.SetVar CommandSubHeading Syntax
+.Do CommandSubHeading
+.SetVar CommandLine1 .DrawCircle  Left  Top  Radius  Option
+.Do CommandLine2
+
+.SetVar CommandSubHeading Parameters
+.Do CommandSubHeading
+.SetVar CommandLine1 Left
+.SetVar CommandLine2 The horizontal center of the circle, measured from the left margin.
+.Do CommandLine2
+.SetVar CommandLine1 Top
+.SetVar CommandLine2 The vertical center of the circle, measured from the top margin.
+.Do CommandLine2
+.SetVar CommandLine1 Radius
+.SetVar CommandLine2 The radius of the circle, including the width of any outline.
+.Do CommandLine2
+.SetVar CommandLine1 Option
+.SetVar CommandLine2 Specifies how the circle is drawn:
+.Do CommandLine2
+.incCurrentY %halfLineGap%
+.SetVar CommandLine3 0 - An outline of the circle is drawn using the current line width
+.Do CommandLine2
+.SetVar CommandLine3 1 - A circle filled with the current fill colour, without an outline is drawn
+.Do CommandLine2
+.SetVar CommandLine3 2 - A circle filled with the current fill colour, with an outline is drawn using the current line width
+.Do CommandLine2
+
+.SetVar CommandSubHeading Other
+.Do CommandSubHeading
+.SetVar CommandLine1 The variable _LastResult is set to '0' if there were any issues with the parameters
+.SetVar CommandLine1 %CommandLine1% provided, otherwise it is set to '1'.
+.Do CommandLine
+.incCurrentY %_FontHeight%
+.SetVar CommandLine1 Unlike most other commands, the top and left positions specify the
+.SetVar CommandLine1 %CommandLine1% center point of the circle, not the left-most and top-most points.
+.Do CommandLine
+
+.SetVar CommandSubHeading Examples
+.Do CommandSubHeading
+.SetVar CommandLine1 Assuming that the unit of measure is millimeters, 
+.SetVar CommandLine1 %CommandLine1% a circle outline is drawn that is 5 millimeters high
+.SetVar CommandLine1 %CommandLine1% and is centered at the current position on the page.
+.Do CommandLine
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 .DrawCircle  %%%%_CurrentX%%%%  %%%%_CurrentY%%%%  5  0
+.Do CommandLine2
+
+.incCurrentY %_FontHeight%
+.SetVar CommandLine1 Assuming that the unit of measure is inches, 
+.SetVar CommandLine1 %CommandLine1% an outlined and filled circle is drawn at the center 
+.SetVar CommandLine1 %CommandLine1% of the page, touching the top margin and is ½ inch high.
+.Do CommandLine
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 .SetVar  center  %%%%_PageWidth%%%%
+.Do CommandLine2
+.SetVar CommandLine1 .MultVar  center  0.5
+.Do CommandLine2
+.SetVar CommandLine1 .DrawCircle  0.5  %%%%center%%%%  0.5  2
+.Do CommandLine2
+
+.SetVar CommandSubHeading See Also
+.Do CommandSubHeading
+.SetVar CommandLine1 DrawBox, DrawEllipse, DrawLine, SetFillColour, SetLineColour, SetLineWidth
+.Do CommandLine2
+.incCurrentY %_FontHeight%

package/documentation/4. Commands/DrawEllipse.txt

@@ -0,0 +1,75 @@
+.SetVar CommandName DrawEllipse
+.Do CommandHeading
+.SetVar CommandLine1 Draw an ellipse, centered at the given point using the current fill colour, 
+.SetVar CommandLine1 %CommandLine1% line colour and line width.
+.Do CommandLine
+
+.SetVar CommandSubHeading Syntax
+.Do CommandSubHeading
+.SetVar CommandLine1 .DrawEllipse  Left  Top  RadiusX  RadiusY  Option
+.Do CommandLine2
+
+.SetVar CommandSubHeading Parameters
+.Do CommandSubHeading
+.SetVar CommandLine1 Left
+.SetVar CommandLine2 The horizontal center of the ellipse, measured from the left margin.
+.Do CommandLine2
+.SetVar CommandLine1 Top
+.SetVar CommandLine2 The vertical center of the ellipse, measured from the top margin.
+.Do CommandLine2
+.SetVar CommandLine1 RadiusX
+.SetVar CommandLine2 The horizontal radius of the ellipse, including the width of any outline.
+.Do CommandLine2
+.Do CommandLine2
+.SetVar CommandLine1 RadiusY
+.SetVar CommandLine2 The vertical radius of the ellipse, including the width of any outline.
+.Do CommandLine2
+.SetVar CommandLine1 Option
+.SetVar CommandLine2 Specifies how the ellipse is drawn:
+.Do CommandLine2
+.incCurrentY %halfLineGap%
+.SetVar CommandLine3 0 - An outline of the ellipse is drawn using the current line width
+.Do CommandLine2
+.SetVar CommandLine3 1 - An ellipse filled with the current fill colour, without an outline is drawn
+.Do CommandLine2
+.SetVar CommandLine3 2 - An ellipse filled with the current fill colour, with an outline is drawn using the current line width
+.Do CommandLine2
+
+.SetVar CommandSubHeading Other
+.Do CommandSubHeading
+.SetVar CommandLine1 The variable _LastResult is set to '0' if there were any issues with the parameters
+.SetVar CommandLine1 %CommandLine1% provided, otherwise it is set to '1'.
+.Do CommandLine
+.incCurrentY %_FontHeight%
+.SetVar CommandLine1 Unlike most other commands, the top and left positions specify the
+.SetVar CommandLine1 %CommandLine1% center point of the ellipse, not the left-most and top-most points.
+.Do CommandLine
+
+.SetVar CommandSubHeading Examples
+.Do CommandSubHeading
+.SetVar CommandLine1 Assuming that the unit of measure is millimeters, 
+.SetVar CommandLine1 %CommandLine1% an outline of an ellipse is drawn that is 4.5 millimeters high,
+.SetVar CommandLine1 %CommandLine1% 8.5 millimeters wide, and is centered at the current position on the page.
+.Do CommandLine
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 .DrawEllipse  %%%%_CurrentX%%%%  %%%%_CurrentY%%%%  8.5  4.5  0
+.Do CommandLine2
+
+.incCurrentY %_FontHeight%
+.SetVar CommandLine1 Assuming that the unit of measure is inches, an outlined and filled
+.SetVar CommandLine1 %CommandLine1% ellipse is drawn at the center of the page, touching the
+.SetVar CommandLine1 %CommandLine1% top margin and is ½ inch high and 1 inch wide.
+.Do CommandLine
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 .SetVar  center  %%%%_PageWidth%%%%
+.Do CommandLine2
+.SetVar CommandLine1 .MultVar  center  0.5
+.Do CommandLine2
+.SetVar CommandLine1 .DrawEllipse  0.5  %%%%center%%%%  1  0.5  2
+.Do CommandLine2
+
+.SetVar CommandSubHeading See Also
+.Do CommandSubHeading
+.SetVar CommandLine1 DrawBox, DrawCircle, DrawLine, SetFillColour, SetLineColour, SetLineWidth
+.Do CommandLine2
+.incCurrentY %_FontHeight%

package/documentation/4. Commands/IfBlank.txt

@@ -14,10 +14,8 @@
 .Do CommandSubHeading
 .SetVar CommandLine1 VariableName
 .SetVar CommandLine2 The name of the variable to check. This does not need to be surrounded
-.Do CommandLine2
-.SetVar CommandLine2 by percentage signs unless the name of the actual variable to check is
-.Do CommandLine2
-.SetVar CommandLine2 given in the variable name parameter.
+.SetVar CommandLine2 %CommandLine2% by percentage signs unless the name of the actual variable to
+.SetVar CommandLine2 %CommandLine2% check is given in the variable name parameter.
 .Do CommandLine2
 .SetVar CommandLine1 Command
 .SetVar CommandLine2 The command to execute if the given variable is blank.
@@ -26,8 +24,7 @@
 .SetVar CommandSubHeading Other
 .Do CommandSubHeading
 .SetVar CommandLine1 The variable _LastResult is set to '-1' if the variable is not blank, otherwise the result of the
-.Do CommandLine
-.SetVar CommandLine1 last command processed by this command.
+.SetVar CommandLine1 %CommandLine1% last command processed by this command.
 .Do CommandLine
 
 .SetVar CommandSubHeading Examples
@@ -35,22 +32,20 @@
 .SetVar CommandLine1 Print a warning message if a variable called 'MyHeading' is blank (or not defined):
 .Do CommandLine
 .incCurrentY %halfLineGap%
-.SetVar CommandLine1 .IfBlank MyHeading  .DrawText  0  %%%%_CurrentY%%%%  *** No heading provided **
+.SetVar CommandLine1 .IfBlank  MyHeading  .DrawText  0  %%%%_CurrentY%%%%  *** No heading provided **
 .Do CommandLine2
 .incCurrentY %_FontHeight%
 
-.SetVar CommandLine1 Process the groups 'CloseSection' and 'NewSection' if the variable called 'more' is blank
-.Do CommandLine
-.SetVar CommandLine1 (or not defined):
+.SetVar CommandLine1 Process the groups 'CloseSection' and 'NewSection' if the variable called 'more'
+.SetVar CommandLine1 %CommandLine1% is blank (or not defined):
 .Do CommandLine
 .incCurrentY %halfLineGap%
 .SetVar CommandLine1 .IfBlank  MORE  .Do  CloseSection  NewSection
 .Do CommandLine2
 .incCurrentY %_FontHeight%
 
-.SetVar CommandLine1 Process the groups 'CloseSection' and 'NewSection' if the variable whose name is stored
-.Do CommandLine
-.SetVar CommandLine1 in the variable named 'varname' is blank (or not defined):
+.SetVar CommandLine1 Process the groups 'CloseSection' and 'NewSection' if the variable whose name
+.SetVar CommandLine1 %CommandLine1% is stored in the variable named 'varname' is blank (or not defined):
 .Do CommandLine
 .incCurrentY %halfLineGap%
 .SetVar CommandLine1 .IfBlank  %%%%VarName%%%%  .Do  CloseSection NewSection
@@ -58,6 +53,6 @@
 
 .SetVar CommandSubHeading See Also
 .Do CommandSubHeading
-.SetVar CommandLine1 IfEq, IfGt, IfNotBlank
+.SetVar CommandLine1 IfEq, IfGt, IfNe, IfNotBlank
 .Do CommandLine2
 .incCurrentY %_FontHeight%

package/documentation/4. Commands/IfEq.txt

@@ -19,13 +19,14 @@
 .SetVar CommandLine2 variables using substitution.
 .Do CommandLine2
 .SetVar CommandLine1 Command
-.SetVar CommandLine2 The command to execute if the first value is greater than the second.
+.SetVar CommandLine2 The command to execute if the first value is equal to the second.
 .Do CommandLine2
 
 .SetVar CommandSubHeading Other
 .Do CommandSubHeading
 .SetVar text The variable _LastResult is set to '0' if the first variable is not equal to the second, otherwise 
 .SetVar text %text% _LastResult is set to the result of the last command processed by this command.
+.SetVar text %text% (Which could also be zero, depending on the result of the last command processed.)
 .DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
 .incCurrentY %HalfFontHeight%
 .SetVar text Comparison of string values is case sensitive.
@@ -48,6 +49,6 @@
 
 .SetVar CommandSubHeading See Also
 .Do CommandSubHeading
-.SetVar CommandLine1 IfBlank, IfGt, IfNotBlank
+.SetVar CommandLine1 IfBlank, IfGt, IfNe, IfNotBlank
 .Do CommandLine2
 .incCurrentY %_FontHeight%

package/documentation/4. Commands/IfGt.txt

@@ -26,6 +26,7 @@
 .Do CommandSubHeading
 .SetVar text The variable _LastResult is set to '0' if the first variable is less than or equal to the second, otherwise 
 .SetVar text %text% _LastResult is set to the result of the last command processed by this command.
+.SetVar text %text% (Which could also be zero, depending on the result of the last command processed.)
 .DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
 .incCurrentY %halfLineGap%
 .SetVar text No action is taken if the two variables have the same value or if the second value is greater than the first.
@@ -53,6 +54,6 @@
 
 .SetVar CommandSubHeading See Also
 .Do CommandSubHeading
-.SetVar CommandLine1 IfBlank, IfEq, IfNotBlank
+.SetVar CommandLine1 IfBlank, IfEq, IfNe, IfNotBlank
 .Do CommandLine2
 .incCurrentY %_FontHeight%

package/documentation/4. Commands/IfNe.txt

@@ -0,0 +1,54 @@
+.SetVar CommandName IfNe
+.Do CommandHeading
+.SetVar text Compares two variables and if the first one is not equal to the second then process a given command. This can be used
+.SetVar text %text% to process one or more groups of commands using the 'do' command or perform some other action, such
+.SetVar text %text% as setting the value of a variable. If either of the variables are not numbers then a string comparison is made.
+.DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
+
+.SetVar CommandSubHeading Syntax
+.Do CommandSubHeading
+.SetVar CommandLine1 .IfNe  Value1  Value2  Command
+.Do CommandLine2
+
+.SetVar CommandSubHeading Parameters
+.Do CommandSubHeading
+.SetVar CommandLine1 Value1,
+.SetVar CommandLine2 The values to compare. These can either be constants or values of
+.Do CommandLine2
+.SetVar CommandLine1 Value2
+.SetVar CommandLine2 variables using substitution.
+.Do CommandLine2
+.SetVar CommandLine1 Command
+.SetVar CommandLine2 The command to execute if the first value is not equal to the second.
+.Do CommandLine2
+
+.SetVar CommandSubHeading Other
+.Do CommandSubHeading
+.SetVar text The variable _LastResult is set to '0' if the first variable is equal to the second, otherwise 
+.SetVar text %text% _LastResult is set to the result of the last command processed by this command.
+.SetVar text %text% (Which could also be zero, depending on the result of the last command processed.) 
+.DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
+.incCurrentY %HalfFontHeight%
+.SetVar text Comparison of string values is case sensitive.
+.DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
+
+.SetVar CommandSubHeading Examples
+.Do CommandSubHeading
+.SetVar text Set the value of variable 'finished' to 'false' when the values of variables 'counter' and 'maxCounter' are not equal.
+.DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
+.Do CommandLine2
+.SetVar CommandLine1 .IfNE  %%%%counter%%%%  %%%%maxCounter%%%%  .SetVar  finished  false
+.Do CommandLine2
+
+.incCurrentY %_FontHeight%
+.SetVar LongText Process the groups 'OutputLine' and 'AddToTotal' if the value of the variable 'finished' is not 'true'.
+.DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %LongText%
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 .IfNe  %%%%finished%%%%  true  .Do  OutputLine  AddToTotal
+.Do CommandLine2
+
+.SetVar CommandSubHeading See Also
+.Do CommandSubHeading
+.SetVar CommandLine1 IfBlank, IfEq, IfGt, IfNotBlank
+.Do CommandLine2
+.incCurrentY %_FontHeight%

package/documentation/4. Commands/IfNotBlank.txt

@@ -1,7 +1,7 @@
 .SetVar CommandName IfNotBlank
 .Do CommandHeading
-.DrawText 0 %_CurrentY% Tests a given variable and if it is not blank then process a given command. This can be
-.SetVar CommandLine1 used to process one or more groups of commands using the 'do' command.
+.SetVar CommandLine1 Tests a given variable and if it is not blank then process a given command. This can be
+.SetVar CommandLine1 %CommandLine1% used to process one or more groups of commands using the 'do' command.
 .Do CommandLine
 
 .SetVar CommandSubHeading Syntax
@@ -12,11 +12,9 @@
 .SetVar CommandSubHeading Parameters
 .Do CommandSubHeading
 .SetVar CommandLine1 VariableName
-.SetVar CommandLine2 The name of the variable to check. This does not need to be surrounded
-.Do CommandLine2
-.SetVar CommandLine2 by percentage signs unless the name of the actual variable to check is
-.Do CommandLine2
-.SetVar CommandLine2 given in the variable name parameter.
+.SetVar CommandLine2 The name of the variable to check. This does not need to be surrounded by
+.SetVar CommandLine2 %CommandLine2% percentage signs unless the name of the actual variable to
+.SetVar CommandLine2 %CommandLine2% check is given in the variable name parameter.
 .Do CommandLine2
 .SetVar CommandLine1 Command
 .SetVar CommandLine2 The command to execute if the given variable is not blank.
@@ -25,8 +23,7 @@
 .SetVar CommandSubHeading Other
 .Do CommandSubHeading
 .SetVar CommandLine1 The variable _LastResult is set to '-1' if the variable is blank, otherwise the result of the
-.Do CommandLine
-.SetVar CommandLine1 last command processed by this command.
+.SetVar CommandLine1 %CommandLine1% last command processed by this command.
 .Do CommandLine
 
 .SetVar CommandSubHeading Examples
@@ -45,9 +42,8 @@
 .Do CommandLine2
 .incCurrentY %_FontHeight%
 
-.SetVar CommandLine1 Process the groups 'continued' and 'AddPage' if the variable whose name is stored in the
-.Do CommandLine
-.SetVar CommandLine1 variable named 'varname' is not blank:
+.SetVar CommandLine1 Process the groups 'continued' and 'AddPage' if the variable whose name is stored
+.SetVar CommandLine1 %CommandLine1% in the variable named 'varname' is not blank:
 .Do CommandLine
 .incCurrentY %halfLineGap%
 .SetVar CommandLine1 .IfNotBlank  %%%%VarName%%%%  .Do  continued  AddPage
@@ -55,6 +51,6 @@
 
 .SetVar CommandSubHeading See Also
 .Do CommandSubHeading
-.SetVar CommandLine1 IfEq, IfGt, IfBlank
+.SetVar CommandLine1 IfBlank, IfEq, IfGt, IfNe
 .Do CommandLine2
 .incCurrentY %_FontHeight%

package/documentation/4. Commands/SavePdf.txt

@@ -1,6 +1,39 @@
 .SetVar CommandName SavePdf
 .Do CommandHeading
-.SetVar CommandLine1 To be documented.
-.Do CommandLine
+.SetVar text Only available when running within Node.js, this command saves the current PDF to the given location.
+.SetVar text %text% A warning will be logged if used within a browser.
+.DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
+
+.SetVar CommandSubHeading Syntax
+.Do CommandSubHeading
+.SetVar CommandLine1 .SavePdf  File-name
+.Do CommandLine2
+
+.SetVar CommandSubHeading Parameters
+.Do CommandSubHeading
+.SetVar CommandLine1 File-name
+.SetVar CommandLine2 The path and name of the file to save. This can include
+.Do CommandLine2
+.SetVar CommandLine2 variables as well as constant text.
+.Do CommandLine2
+
+.SetVar CommandSubHeading Other
+.Do CommandSubHeading
+.SetVar text The variable _LastResult is set to '1' if the current PDF is saved, otherwise it is set to '0'
+.SetVar text %text% and _LastError is set to a description of the problem.
+.DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
+.incCurrentY %halfLineGap%
+.SetVar text Note that the path must exist or this command will fail.
+.DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
+.incCurrentY %halfLineGap%
+.SetVar text If not given the default name of Document.pdf will be used.
+.DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
+
+.SetVar CommandSubHeading Examples
+.Do CommandSubHeading
+.SetVar CommandLine1  .SavePdf  ../output/invoice.pdf
+.Do CommandLine2
+.SetVar CommandLine1  .SavePdf  %%%%savepath%%%%/%%%%customer%%%%.pdf
+.Do CommandLine2
 
 .incCurrentY %_FontHeight%

package/documentation/4. Commands/SelectPage.txt

@@ -1,6 +1,31 @@
 .SetVar CommandName SelectPage
 .Do CommandHeading
-.SetVar CommandLine1 To be documented.
-.Do CommandLine
+.SetVar text This makes the given page active and sets the current left and top positions to zero. 
+.SetVar text %text% Subsequent commands will be relative to this page.
+.DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
+
+.SetVar CommandSubHeading Syntax
+.Do CommandSubHeading
+.SetVar CommandLine1 .SelectPage  Value
+.Do CommandLine2
+
+.SetVar CommandSubHeading Parameters
+.Do CommandSubHeading
+.SetVar CommandLine1 Value
+.SetVar CommandLine2 The number of the page to make active. This is 1 based.
+.Do CommandLine2
+
+.SetVar CommandSubHeading Other
+.Do CommandSubHeading
+.SetVar text The variable _LastResult is set to '1' if the command is successful, otherwise it is set to '0'
+.SetVar text %text% and _LastError is set to a description of the problem.
+.DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
+
+.SetVar CommandSubHeading Examples
+.Do CommandSubHeading
+.SetVar CommandLine1 .SelectPage  7
+.Do CommandLine2
+.SetVar CommandLine1 .SelectPage  %%%%_Pages%%%%
+.Do CommandLine2
 
 .incCurrentY %_FontHeight%

package/documentation/4. Commands/SetFillColour.txt

@@ -5,6 +5,7 @@
 .SetVar CommandSubHeading Syntax
 .Do CommandSubHeading
 .SetVar CommandLine1 .SetFillColor  Colour
+.SetVar CommandLine1 .SetFillColor  Colour
 .Do CommandLine2
 
 .SetVar CommandSubHeading Parameters

package/documentation/4. Commands/SetFontName.txt

@@ -82,4 +82,6 @@
 .SetVar CommandLine1 DrawTextBox, DrawText, SetFontSize, SetFontStyle, SetTextColour
 .Do CommandLine
 
+.incCurrentY %_FontHeight%
+
 .incCurrentY %_FontHeight%

package/documentation/4. Commands/SetFontSize.txt

@@ -45,4 +45,5 @@
 .SetVar CommandLine1 DrawTextBox, DrawText, SetFontName, SetFontStyle, SetTextColour
 .Do CommandLine
 
+.incCurrentY %_FontHeight%
 .incCurrentY %_FontHeight%

package/documentation/4. Commands/SetLineColour.txt

@@ -5,6 +5,7 @@
 .SetVar CommandSubHeading Syntax
 .Do CommandSubHeading
 .SetVar CommandLine1 .SetLineColor  Colour
+.SetVar CommandLine1 .SetLineColor  Colour
 .Do CommandLine2
 
 .SetVar CommandSubHeading Parameters

package/documentation/documentation.txt

@@ -56,7 +56,6 @@
 .SetVar top %_PageHeight%
 .MultVar top 0.3
 .DrawTextBox 0 %top% %_PageWidth% %_FontHeight% centered top jsPdf-Dynamo
-.DrawTextBox 0 %_CurrentY% %_PageWidth% %_FontHeight% centered top (Draft)
 .incCurrentY 2
 .SetFontSize 24
 .SetTextColour %black%
@@ -81,11 +80,6 @@
 [End]
 
 [Footer]
-.setMargin t 7
-.setFontStyle Bold
-.setFontSize 18
-.SetTextColour red
-.ifGt %_PageNo% 1 .DrawTextBox 0 0 %_PageWidth% 8 centered centered *** Draft ***
 .Do SetDefaultText  
 .SetVar top %_PageHeight%
 .incVar top -%_FontHeight%
@@ -225,7 +219,9 @@
 .Include ./Documentation/4. Commands/Do.txt
 .Include ./Documentation/4. Commands/DoRepeat.txt
 .Include ./Documentation/4. Commands/DrawBox.txt
+.Include ./Documentation/4. Commands/DrawCircle.txt
 .Include ./Documentation/4. Commands/DrawDebugGrid.txt
+.Include ./Documentation/4. Commands/DrawEllipse.txt
 .Include ./Documentation/4. Commands/DrawImage.txt
 .Include ./Documentation/4. Commands/DrawLine.txt
 .Include ./Documentation/4. Commands/DrawText.txt
@@ -235,6 +231,7 @@
 .Include ./Documentation/4. Commands/IfBlank.txt
 .Include ./Documentation/4. Commands/IfEq.txt
 .Include ./Documentation/4. Commands/IfGt.txt
+.Include ./Documentation/4. Commands/IfNe.txt
 .Include ./Documentation/4. Commands/IfNotBlank.txt
 .Include ./Documentation/4. Commands/incCurrentX.txt
 .Include ./Documentation/4. Commands/incCurrentY.txt

package/examples/1.Simple/simple.pdf

@@ -46,7 +46,7 @@ endobj
 6 0 obj
 <<
 /Producer (jsPDF 2.5.2)
-/CreationDate (D:20241002155924+10'00')
+/CreationDate (D:20241006151126+10'00')
 >>
 endobj
 7 0 obj
@@ -72,7 +72,7 @@ trailer
 /Size 8
 /Root 7 0 R
 /Info 6 0 R
-/ID [ <057B68611040878E4A1ECADDBA2E3039> <057B68611040878E4A1ECADDBA2E3039> ]
+/ID [ <A4FE96B1D9C5D34C705DDBFDD4170A74> <A4FE96B1D9C5D34C705DDBFDD4170A74> ]
 >>
 startxref
 892

package/examples/{examples.spec.ts → 1.Simple/simple.spec.ts}

@@ -1,8 +1,8 @@
 import { expect, it, describe } from "vitest";
-import { JsPdfDynamo } from "../src/jsPdfDynamo";
+import { JsPdfDynamo } from "../../src/jsPdfDynamo";
 
-describe("app", () => {
-  it("1. Simple", async () => {
+describe("1. Simple example", () => {
+  it("Create", async () => {
     const pdfDynamo = new JsPdfDynamo({
       pageSize: "a4",
       orientation: "portrait",

package/package.json

@@ -1,8 +1,10 @@
 {
   "name": "jspdf-dynamo",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Generate data driven PDFs from dynamic templates",
-  "main": "dist/index.js",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/SteveCorbett/jsPdf-Dynamo"
@@ -33,7 +35,7 @@
   "author": "Stephen Corbett <corbett@corbtech.com.au> (https://corbtech.com.au)",
   "license": "MIT",
   "dependencies": {
-    "jspdf": "^2.5.2"
+    "jspdf": "^4.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.4",
@@ -44,7 +46,7 @@
     "tslog": "^4.9.3",
     "tsup": "^8.2.4",
     "typescript": "^5.5.4",
-    "vitest": "^2.1.1"
+    "vitest": "^4.0.18"
   },
   "files": [
     "dist",
@@ -58,7 +60,7 @@
     "./package.json": "./package.json",
     ".": {
       "import": "./dist/index.js",
-      "default": "./dist/index.cjs"
+      "require": "./dist/index.cjs"
     }
   }
 }