jspdf-dynamo 1.0.0 → 1.0.1

package/dist/index.cjs

@@ -61,9 +61,6 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
-// src/jsPdfDynamo.ts
-var import_node_fetch = __toESM(require("node-fetch"), 1);
-
 // src/models/jsPdfProcessor.ts
 var import_jspdf = __toESM(require("jspdf"), 1);
 var fs = __toESM(require("fs"), 1);
@@ -995,6 +992,7 @@ 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);
@@ -1006,7 +1004,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";
+      this.lastError = `Text was truncated to fit within the available width (${(_a = lines[0]) == null ? void 0 : _a.substring(0, 20)}...)`;
       this.lastResult = "0";
       if (lines[0]) {
         if (this._pdfDocument.getTextWidth(lines[0]) < maxWidth) {
@@ -1038,7 +1036,7 @@ var JsPdfProcessor = class {
       return false;
     }
     if (isNaN(top)) {
-      this.lastError = `Vertical position '${top}' is not a number`;
+      this.lastError = `Vertical position '${top}' is not a number on page ${this._currentPageNumber}.`;
       this.lastResult = "0";
       return false;
     }
@@ -1350,8 +1348,8 @@ var JsPdfProcessor = class {
       this.lastError = "Y Position resulted in negative value, adjusted to 0";
     }
     if (this.posnY > this._pageHeight) {
+      this.lastError = `Y Position ${this.posnY} exceeded page ${this._currentPageNumber} height, adjusted to page height (${this._pageHeight})`;
       this.posnY = this._pageHeight;
-      this.lastError = "Y Position exceeded page height, adjusted to page height";
     }
   }
   incVar(input) {
@@ -2144,7 +2142,7 @@ var JsPdfDynamo = class {
       const subs = processor.substitute(input);
       __privateGet(this, _appLogger).debug(`.includeUri ${subs}`);
       try {
-        const response = yield (0, import_node_fetch.default)(subs, {
+        const response = yield fetch(subs, {
           headers: { Accept: "text/plain;q=0.9, text/*;q=0.8, */*;q=0.7" }
         });
         if (!response.ok) {

package/dist/index.js

@@ -32,9 +32,6 @@ var __async = (__this, __arguments, generator) => {
   });
 };
 
-// src/jsPdfDynamo.ts
-import fetch2 from "node-fetch";
-
 // src/models/jsPdfProcessor.ts
 import jsPDF from "jspdf";
 import * as fs from "fs";
@@ -966,6 +963,7 @@ 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);
@@ -977,7 +975,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";
+      this.lastError = `Text was truncated to fit within the available width (${(_a = lines[0]) == null ? void 0 : _a.substring(0, 20)}...)`;
       this.lastResult = "0";
       if (lines[0]) {
         if (this._pdfDocument.getTextWidth(lines[0]) < maxWidth) {
@@ -1009,7 +1007,7 @@ var JsPdfProcessor = class {
       return false;
     }
     if (isNaN(top)) {
-      this.lastError = `Vertical position '${top}' is not a number`;
+      this.lastError = `Vertical position '${top}' is not a number on page ${this._currentPageNumber}.`;
       this.lastResult = "0";
       return false;
     }
@@ -1321,8 +1319,8 @@ var JsPdfProcessor = class {
       this.lastError = "Y Position resulted in negative value, adjusted to 0";
     }
     if (this.posnY > this._pageHeight) {
+      this.lastError = `Y Position ${this.posnY} exceeded page ${this._currentPageNumber} height, adjusted to page height (${this._pageHeight})`;
       this.posnY = this._pageHeight;
-      this.lastError = "Y Position exceeded page height, adjusted to page height";
     }
   }
   incVar(input) {
@@ -2115,7 +2113,7 @@ var JsPdfDynamo = class {
       const subs = processor.substitute(input);
       __privateGet(this, _appLogger).debug(`.includeUri ${subs}`);
       try {
-        const response = yield fetch2(subs, {
+        const response = yield fetch(subs, {
           headers: { Accept: "text/plain;q=0.9, text/*;q=0.8, */*;q=0.7" }
         });
         if (!response.ok) {

package/documentation/1. Introduction/Introduction.txt

@@ -6,7 +6,7 @@
 .DrawTextWrapped 0 %_CurrentY% %_PageWidth% *None %text%
 .incCurrentY  %_FONTHEIGHT%
 
-.SetVar text jsPdf-Dynamo can be used with browser or NodeJs JavaScript or TypeScript applications.
+.SetVar text jsPdf-Dynamo can be used with browser or NodeJs applications written in JavaScript or TypeScript.
 .DrawTextWrapped 0 %_CurrentY% %_PageWidth% *None %text%
 .incCurrentY  %_FONTHEIGHT%
 
@@ -51,7 +51,7 @@
 .SetVar text Output is driven by a series of plain text 'commands'. These
 .SetVar text %text% commands can be provided as a list of strings from multiple sources, 
 .SetVar text %text% including the JavaScript or TypeScript application, or loaded from
-.SetVar text %text% 'templates' retrieved from a URL (browser or NodeJs) or from local text 
+.SetVar text %text% 'templates' retrieved from a URL (browser only) or from local text 
 .SetVar text %text% files (NodeJs only).
 .DrawTextWrapped 10 %top% %width% *None %text%
 

package/documentation/4. Commands/AddImageFromUrl.txt

@@ -1,12 +1,9 @@
-.SetVar CommandName AddImageFromUrl
+.SetVar CommandName AddImageFromUrl (Browser Only)
 .Do CommandHeading
 .SetVar text Reads an image from the given URL and stores it for later output. JsPdfDynamo can use all image types
 .SetVar text %text% that jsPDF supports, including: BMP, GIF, JPEG, PNG, TIFF and WEBP
 .DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
 .incCurrentY %halfLineGap%
-.SetVar text This command is available for both browser and NodeJs applications.
-.DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
-.incCurrentY %halfLineGap%
 
 .SetVar CommandSubHeading Syntax
 .Do CommandSubHeading

package/documentation/4. Commands/Include.txt

@@ -1,11 +1,8 @@
-.SetVar CommandName Include
+.SetVar CommandName Include (NodeJs Only)
 .Do CommandHeading
-.DrawText 0 %_CurrentY% Include a template into the current document. The template itself may include other templates.
-.SetVar CommandLine1 The template must be a text file and located relative to the current directory. The template
-.Do CommandLine
-.SetVar CommandLine1 may contain individual commands or groups of commands. Any individual commands in the
-.Do CommandLine
-.SetVar CommandLine1 template are run.
+.SetVar CommandLine1 Load commands from a text file in the file system. The loaded commands may also load other commands.
+.SetVar CommandLine1 %CommandLine1% The text file  may contain individual commands or groups of commands.
+.SetVar CommandLine1 %CommandLine1% Commands not within a group will be executed.
 .Do CommandLine
 
 .SetVar CommandSubHeading Syntax
@@ -21,11 +18,9 @@
 
 .SetVar CommandSubHeading Other
 .Do CommandSubHeading
-.SetVar CommandLine1 The variable _LastResult is set to '1' if the file is found or '0' if the file could not be found or
-.Do CommandLine
-.SetVar CommandLine1 opened. Note that the _LastResult of any commands run are not available unless they are
-.Do CommandLine
-.SetVar CommandLine1 saved within the template file to variables.
+.SetVar CommandLine1 The variable _LastResult is set to '1' if the file is found or '0' if the file could not be found or opened. 
+.SetVar CommandLine1 %CommandLine1% opened. Note that the _LastResult of any commands run by the include are not available and
+.SetVar CommandLine1 %CommandLine1% should be saved to variables within the included file if required. 
 .Do CommandLine
 
 .SetVar CommandSubHeading Examples
@@ -33,12 +28,18 @@
 .SetVar CommandLine1 Include the template file StdReportLayout.txt:
 .Do CommandLine
 .incCurrentY %halfLineGap%
-.SetVar CommandLine1 .Include .\StdReportLayout.txt
+.SetVar CommandLine1 .Include ./StdReportLayout.txt
 .Do CommandLine2
 .incCurrentY %_FontHeight%
 .SetVar CommandLine1 Include the template file specified in the 'ReportType' variable:
 .Do CommandLine
 .incCurrentY %halfLineGap%
-.SetVar CommandLine1 .Include \tmplates\%%%%ReportType%%%%
+.SetVar CommandLine1 .Include /tmplates/%%%%ReportType%%%%
 .Do CommandLine2
+
+.SetVar CommandSubHeading See Also
+.Do CommandSubHeading
+.SetVar CommandLine1 IncludeUrl
+.Do CommandLine
+
 .incCurrentY %_FontHeight%

package/documentation/4. Commands/IncludeUrl.txt

@@ -0,0 +1,11 @@
+.SetVar CommandName IncludeUrl (Browser Only)
+.Do CommandHeading
+.SetVar CommandLine1 To be documented.
+.Do CommandLine
+
+.SetVar CommandSubHeading See Also
+.Do CommandSubHeading
+.SetVar CommandLine1 Include
+.Do CommandLine
+
+.incCurrentY %_FontHeight%

package/documentation/4. Commands/SetFontSize.txt

@@ -2,21 +2,3 @@
 .Do CommandHeading
 .SetVar CommandLine1 To be documented.
 .Do CommandLine
-
-.incCurrentY %_FontHeight%
-.SetVar CommandLine1 Set a variable named 'BoldText' and then use this variable to set the emphasis of subsequent
-.Do CommandLine
-.SetVar CommandLine1 text to be bold:
-.Do CommandLine
-.incCurrentY %halfLineGap%
-.SetVar CommandLine1 .SetVar BoldText 1
-.Do CommandLine2
-.SetVar CommandLine1 .SetFontStyle %%%%BoldText%%%%
-.Do CommandLine2
-
-.SetVar CommandSubHeading See Also
-.Do CommandSubHeading
-.SetVar CommandLine1 DrawTextBox, DrawText, SetFontType, SetFontSize, SetTextColour
-.Do CommandLine
-
-.incCurrentY %_FontHeight%

package/documentation/4. Commands/SetFontStyle.txt

@@ -17,18 +17,22 @@
 .SetVar CommandLine2 The typographical emphasis to apply:
 .Do CommandLine2
 .incCurrentY %halfLineGap%
-.SetVar CommandLine2 Normal - Normal text (no typographical emphasis)
+.SetVar CommandLine2 -
+.SetVar CommandLine3 Normal - Normal text (no typographical emphasis)
 .Do CommandLine2
 
-.SetVar CommandLine2 Bold - Bold text
+.SetVar CommandLine2 -
+.SetVar CommandLine3 Bold - Bold text
 .SetFontStyle Bold
 .Do CommandLine2
 
-.SetVar CommandLine2 Italic - Italic text
+.SetVar CommandLine2 -
+.SetVar CommandLine3 Italic - Italic text
 .SetFontStyle Italic
 .Do CommandLine2
 
-.SetVar CommandLine2 BoldItalic - Bold and italic text
+.SetVar CommandLine2 -
+.SetVar CommandLine3 BoldItalic - Bold and italic text
 .SetFontStyle BoldItalic
 .Do CommandLine2
 
@@ -36,14 +40,11 @@
 
 .SetVar CommandSubHeading Other
 .Do CommandSubHeading
-.SetVar CommandLine1 The font style name is not case sensitive so can be either upper, lower
-.Do CommandLine
-.SetVar CommandLine1 or mixed case.
+.SetVar CommandLine1 The font style name is not case sensitive so can be either upper, lower or mixed case.
 .Do CommandLine
 .incCurrentY %halfLineGap%
 .SetVar CommandLine1 If a valid font style is provided the variable _LastResult is set to '1' otherwise the current
-.Do CommandLine
-.SetVar CommandLine1 typographical emphasis is unchanged and _LastResult is set to '0'. 
+.SetVar CommandLine1 %CommandLine1% typographical emphasis is unchanged and _LastResult is set to '0'. 
 .Do CommandLine
 
 .SetVar CommandSubHeading Examples
@@ -51,5 +52,22 @@
 .SetVar CommandLine1 Set the emphasis of subsequent text to be italic:
 .Do CommandLine
 .incCurrentY %halfLineGap%
-.SetVar CommandLine1 .SetFontStyle 2
+.SetVar CommandLine1 .SetFontStyle  italic
+.Do CommandLine2
+
+.incCurrentY %_FontHeight%
+.SetVar CommandLine1 Set a variable named 'BoldText' and then use this variable to set the emphasis of subsequent
+.SetVar CommandLine1 %CommandLine1% text to be bold:
+.Do CommandLine
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 .SetVar  BoldText bold
 .Do CommandLine2
+.SetVar CommandLine1 .SetFontStyle  %%%%BoldText%%%%
+.Do CommandLine2
+
+.SetVar CommandSubHeading See Also
+.Do CommandSubHeading
+.SetVar CommandLine1 DrawTextBox, DrawText, SetFontType, SetFontSize, SetTextColour
+.Do CommandLine
+
+.incCurrentY %_FontHeight%

package/documentation/4. Commands/SetLineColour.txt

@@ -1,6 +1,6 @@
 .SetVar CommandName SetLineColour
 .Do CommandHeading
-.DrawText 0 %_CurrentY Set the colour of subsequent lines drawn with the DrawBox and DrawLine commands.
+.DrawText 0 %_CurrentY% Set the colour of subsequent lines drawn with the DrawBox and DrawLine commands.
 
 .SetVar CommandSubHeading Syntax
 .Do CommandSubHeading