jspdf-dynamo 1.0.7 → 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);
@@ -1630,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;
     }
@@ -1665,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);

package/dist/index.js

@@ -1601,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;
     }
@@ -1636,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);

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/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%

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.7",
+  "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"
     }
   }
 }