jspdf-dynamo 1.0.7 → 1.0.9

package/dist/index.cjs

@@ -55,14 +55,14 @@ 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);
+var jspdfModule = __toESM(require("jspdf"), 1);
 var fs = __toESM(require("fs"), 1);
 
 // src/models/logger.ts
@@ -340,11 +340,18 @@ var JsPdfProcessor = class {
     };
     this._logger = logger;
     const optn = new JsPdfOptions(options);
-    this._pdfDocument = new import_jspdf.default(optn);
+    const jsPDFCtor = jspdfModule && typeof jspdfModule.default === "function" ? jspdfModule.default : jspdfModule && typeof jspdfModule.jsPDF === "function" ? jspdfModule.jsPDF : typeof jspdfModule === "function" ? jspdfModule : void 0;
+    if (!jsPDFCtor) {
+      throw new Error(
+        'jsPDF constructor not found. Ensure a compatible "jspdf" package is installed.'
+      );
+    }
+    this._pdfDocument = new jsPDFCtor(optn);
+    this._pdfDocument.setLineHeightFactor(1);
+    this._pdfDocument.setProperties({ creator: "jsPdf-Dynamo" });
     this.pageSize = optn.pageSize;
     this.pageOrientation = optn.orientation;
     this.currentUom = optn.unit;
-    this._pdfDocument.setLineHeightFactor(1);
     const now = /* @__PURE__ */ new Date();
     this._variables.set(
       "_TIMEHM",
@@ -660,7 +667,8 @@ var JsPdfProcessor = class {
     this._pdfDocument.setTextColor(this._textColour);
   }
   get pageCount() {
-    return this._pdfDocument ? this._pdfDocument.internal.getNumberOfPages() : -1;
+    const internal = this._pdfDocument && this._pdfDocument.internal ? this._pdfDocument.internal : null;
+    return internal && typeof internal.getNumberOfPages === "function" ? internal.getNumberOfPages() : -1;
   }
   addBookmark(input) {
     const subs = this.logAndParseCommand(".addBookmark", input);
@@ -1630,6 +1638,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 +1674,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);
@@ -1687,9 +1697,6 @@ var JsPdfProcessor = class {
     let { first, rest } = getNextString(subs);
     this.lastResult = "1";
     switch (first.toLocaleLowerCase()) {
-      case "application":
-        this._pdfDocument.setProperties({ application: rest });
-        break;
       case "author":
         this._pdfDocument.setProperties({ author: rest });
         break;

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import jsPDF from 'jspdf';
+import { jsPDF } from 'jspdf';
 
 interface ILogger {
     debug: (message: string, args?: any) => void;
@@ -370,7 +370,7 @@ declare class JsPdfDynamo {
     _processor: JsPdfProcessor;
     constructor(options?: Partial<IJsPdfOptions>, logger?: ILogger | null);
     toBlob(): Blob | null;
-    toBlobUrl(): string | null;
+    toBlobUrl(): URL | null;
     getVariable(variableName: string): string | null;
     private prepareNewPdf;
     prepareWrappedString(input: string): string;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import jsPDF from 'jspdf';
+import { jsPDF } from 'jspdf';
 
 interface ILogger {
     debug: (message: string, args?: any) => void;
@@ -370,7 +370,7 @@ declare class JsPdfDynamo {
     _processor: JsPdfProcessor;
     constructor(options?: Partial<IJsPdfOptions>, logger?: ILogger | null);
     toBlob(): Blob | null;
-    toBlobUrl(): string | null;
+    toBlobUrl(): URL | null;
     getVariable(variableName: string): string | null;
     private prepareNewPdf;
     prepareWrappedString(input: string): string;

package/dist/index.js

@@ -33,7 +33,7 @@ var __async = (__this, __arguments, generator) => {
 };
 
 // src/models/jsPdfProcessor.ts
-import jsPDF from "jspdf";
+import * as jspdfModule from "jspdf";
 import * as fs from "fs";
 
 // src/models/logger.ts
@@ -311,11 +311,18 @@ var JsPdfProcessor = class {
     };
     this._logger = logger;
     const optn = new JsPdfOptions(options);
-    this._pdfDocument = new jsPDF(optn);
+    const jsPDFCtor = jspdfModule && typeof jspdfModule.default === "function" ? jspdfModule.default : jspdfModule && typeof jspdfModule.jsPDF === "function" ? jspdfModule.jsPDF : typeof jspdfModule === "function" ? jspdfModule : void 0;
+    if (!jsPDFCtor) {
+      throw new Error(
+        'jsPDF constructor not found. Ensure a compatible "jspdf" package is installed.'
+      );
+    }
+    this._pdfDocument = new jsPDFCtor(optn);
+    this._pdfDocument.setLineHeightFactor(1);
+    this._pdfDocument.setProperties({ creator: "jsPdf-Dynamo" });
     this.pageSize = optn.pageSize;
     this.pageOrientation = optn.orientation;
     this.currentUom = optn.unit;
-    this._pdfDocument.setLineHeightFactor(1);
     const now = /* @__PURE__ */ new Date();
     this._variables.set(
       "_TIMEHM",
@@ -631,7 +638,8 @@ var JsPdfProcessor = class {
     this._pdfDocument.setTextColor(this._textColour);
   }
   get pageCount() {
-    return this._pdfDocument ? this._pdfDocument.internal.getNumberOfPages() : -1;
+    const internal = this._pdfDocument && this._pdfDocument.internal ? this._pdfDocument.internal : null;
+    return internal && typeof internal.getNumberOfPages === "function" ? internal.getNumberOfPages() : -1;
   }
   addBookmark(input) {
     const subs = this.logAndParseCommand(".addBookmark", input);
@@ -1601,6 +1609,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 +1645,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);
@@ -1658,9 +1668,6 @@ var JsPdfProcessor = class {
     let { first, rest } = getNextString(subs);
     this.lastResult = "1";
     switch (first.toLocaleLowerCase()) {
-      case "application":
-        this._pdfDocument.setProperties({ application: rest });
-        break;
       case "author":
         this._pdfDocument.setProperties({ author: rest });
         break;

package/documentation/2. JsPdfDynamo/toBlobUrl.txt

@@ -1,7 +1,7 @@
 .SetVar CommandName toBlobUrl()
 .Do CommandHeading
 .SetVar text This is a browser only method that generates the current PDF as a Blob
-.SetVar text %text% and returns a string containing a URL to that Blob. This can be
+.SetVar text %text% and returns the URL to that Blob. This can be
 .SetVar text %text% used to display the PDF in the current or another browser window.
 .DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
 
@@ -12,7 +12,7 @@
 
 .SetVar CommandSubHeading Returns
 .Do CommandSubHeading
-.SetVar CommandLine1 A string containing the URL reference to the PDF.
+.SetVar CommandLine1 A URL object that references the PDF.
 .Do CommandLine2
 
 .SetVar CommandSubHeading Example

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/SetDocumentInfo.txt

@@ -10,14 +10,10 @@
 .SetVar CommandSubHeading Parameters
 .Do CommandSubHeading
 .SetVar CommandLine1 Property
-.SetVar CommandLine2 One of the following values: Application, Author, Creator, CreationDate, Keywords, 
-.Do CommandLine2
-.SetVar CommandLine2 ModDate, Producer, Subject or Title.
+.SetVar CommandLine2 One of the following values: Author, Creator, Keywords, Subject or Title.
 .Do CommandLine2
 .SetVar CommandLine1 Value
-.SetVar CommandLine2 The value to set the property to. For CreationDate and ModDate this must
-.Do CommandLine2
-.SetVar CommandLine2 either be in the format of yyyy-mm-dd or blank.
+.SetVar CommandLine2 The value to set the property to.
 .Do CommandLine2
 
 .SetVar CommandSubHeading Other

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%
@@ -276,5 +270,5 @@
 .ForEachPage Footer
 
 ;.DrawDebugGrid
-.SAVEpdF ./documentation/Documentation.pdf
+.SAVEpdF ./Documentation.pdf
 .WriteLog info Documentation has been generated.

package/examples/1.Simple/simple.pdf

@@ -45,8 +45,9 @@ endobj
 endobj
 6 0 obj
 <<
-/Producer (jsPDF 2.5.2)
-/CreationDate (D:20241006151126+10'00')
+/Producer (jsPDF 4.1.0)
+/Creator (jsPdf-Dynamo)
+/CreationDate (D:20260205101406+11'00')
 >>
 endobj
 7 0 obj
@@ -66,14 +67,14 @@ xref
 0000000152 00000 n 
 0000000470 00000 n 
 0000000704 00000 n 
-0000000789 00000 n 
+0000000813 00000 n 
 trailer
 <<
 /Size 8
 /Root 7 0 R
 /Info 6 0 R
-/ID [ <A4FE96B1D9C5D34C705DDBFDD4170A74> <A4FE96B1D9C5D34C705DDBFDD4170A74> ]
+/ID [ <6F3B78A493C9BF1EDA9BB278B0829F9E> <6F3B78A493C9BF1EDA9BB278B0829F9E> ]
 >>
 startxref
-892
+916
 %%EOF

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,11 +1,13 @@
 {
   "name": "jspdf-dynamo",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "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"
+    "url": "git+https://github.com/SteveCorbett/jsPdf-Dynamo.git"
   },
   "bugs": {
     "url": "https://github.com/SteveCorbett/jsPdf-Dynamo/issues"
@@ -13,8 +15,8 @@
   "scripts": {
     "build": "tsup",
     "build-docs": "vitest --dir ./documentation run",
-    "check-exports": "attw --pack . ",
-    "ci": "npm run test && npm run lint && npm run build && npm run check-format && npm run check-exports ",
+    "check-exports": "npm pack && attw \"$(ls *.tgz | head -n 1)\" && rm -f *.tgz",
+    "ci": "npm run test && npm run lint && npm run build && npm run check-format && ( [ \"$npm_config_dry_run\" = \"true\" ] && echo \"Skipping check-exports in dry-run\" || npm run check-exports )",
     "examples": "vitest --dir ./examples run",
     "format": "prettier --write .",
     "lint": "tsc",
@@ -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,11 +46,12 @@
     "tslog": "^4.9.3",
     "tsup": "^8.2.4",
     "typescript": "^5.5.4",
-    "vitest": "^2.1.1"
+    "vitest": "^4.0.18"
   },
   "files": [
     "dist",
     "documentation",
+    "Documentation.pdf",
     "examples",
     "README.md",
     "LICENSE"
@@ -58,7 +61,7 @@
     "./package.json": "./package.json",
     ".": {
       "import": "./dist/index.js",
-      "default": "./dist/index.cjs"
+      "require": "./dist/index.cjs"
     }
   }
 }

package/documentation/README.md

@@ -1,7 +0,0 @@
-## How to build the documentation
-
-The documentation for jsPdfDynamo is built using jsPdfDynamo. Once the project dependencies have been restored, run the following command:
-
-```
-    npm run build-docs
-```

package/documentation/gendoc.spec.ts

@@ -1,22 +0,0 @@
-import { expect, it, describe } from "vitest";
-import { JsPdfDynamo } from "../src/jsPdfDynamo";
-import { Logger } from "tslog";
-import { ILogger } from "../src/models/logger";
-
-describe("Build the documentation", () => {
-  it("should build", async () => {
-    const logger: ILogger = new Logger({
-      name: "jspdf-dynamo",
-      minLevel: 0,
-      type: "pretty",
-    });
-    const pdfDynamo = new JsPdfDynamo(
-      { pageSize: "a4", orientation: "portrait" },
-      logger,
-    );
-    await pdfDynamo.processCommands([
-      ".include ./documentation/documentation.txt",
-    ]);
-    expect(true).toBe(true);
-  });
-});