jspdf-dynamo 1.0.0

package/documentation/README.md

@@ -0,0 +1,7 @@
+## 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/documentation.txt

@@ -0,0 +1,266 @@
+;
+; jsPdf-Dynamo Documentation.
+;
+; Use this template to generate the documentation
+;
+.SetDocumentInfo author Stephen Corbett
+.SetLineWidth 0.1
+.SetFillColour lightgrey
+.SetFontName helvetica
+.SetSpaceVert 0.8
+
+.SetVar themeColour red
+.SetVar black black
+.setVar codeBg 200 200 200
+.SetVar halfLineGap 2.0
+.SetLineColor %black%
+
+.Do SetDefaultText
+.SetVar margins 15
+.SetVar marginB %margins%
+.IncVar marginB %_FONTHEIGHT% 0.1
+
+[SetMargins]
+.SetMargin a %margins%
+.SetMargin b %marginB%
+[End]
+
+[SetDefaultText]
+.SetFontSize 11
+.SetTextColour %black%
+.SetFontStyle Normal
+.Do SetHalfFontHeight
+[End]
+
+[SetHalfFontHeight]
+.SetVar HalfFontHeight %_FontHeight%
+.MultVar HalfFontHeight 0.5
+[End]
+
+[SetSmallFont]
+.SetFontSize 7
+.SetFontStyle Normal
+.Do SetHalfFontHeight
+[End]
+
+[SetSmallFontBold]
+.SetFontSize 7
+.SetFontStyle Bold
+.Do SetHalfFontHeight
+[End]
+
+[TitlePage]
+.SetFontSize 36
+.SetTextColour %themeColour%
+.SetFontStyle Bold
+.DrawBox  0 0 %_PageWidth% %_PageHeight% 0
+.SetVar top %_PageHeight%
+.MultVar top 0.3
+.DrawTextBox 0 %top% %_PageWidth% %_FontHeight% centered top jsPdf-Dynamo
+.SetFontSize 24
+.SetTextColour %black%
+.DrawTextBox 0 %_CurrentY% %_PageWidth% %_FontHeight% centered top User Guide
+[End]
+
+[ChapterHeading]
+.AddPage
+.do SetMargins
+.SetFontSize 16
+.SetTextColour %themeColour%
+.SetFontStyle Bold
+.IncVar ChapterNo 1
+.AddBookmark 0 %_PAGENO% %ChapterNo%. %ChapterName%
+.SetVar ChapterOutLine %_LastResult%
+.DrawText 0 0 %ChapterNo%. %ChapterName%
+.SetLineColor %themeColour%
+.SetLineWidth 0.5
+.DrawLine 0 %_CurrentY% %_PageWidth% %_CurrentY%
+.do SetDefaultText
+.incCurrentY %HalfFontHeight%
+[End]
+
+[Footer]
+.SetVar top %_PageHeight%
+.incVar top -%_FontHeight%
+.ifGt %_PageNo% 1 .DrawTextBox 0 %top% %_PageWidth% %_FontHeight% centered centered Page %_PageNo% of %LastPage%
+[End]
+
+[CommandHeading]
+.do SetMargins
+.CheckPage 40 
+.SetFontSize 13
+.SetTextColour %themeColour%
+.SetFontStyle Bold
+.addBookmark %ChapterOutLine% %_PAGENO% %CommandName%
+.DrawText 0 %_CurrentY% %CommandName%
+.do SetDefaultText
+[End]
+
+[CheckCommandOverflow]
+.CheckPage %pageBottomMargin% CommandOverflow
+[End]
+
+[CommandOverflow]
+.AddPage
+.do SetMargins
+.SetFontSize 14
+.SetTextColour %themeColour%
+.SetFontStyle Bold
+.IfNotBlank CommandName .DrawText 0 %_CurrentY% %CommandName% (Continued)
+.SetMargin L 20
+.do SetDefaultText
+.incCurrentY %halfLineGap%
+[End]
+
+[CommandSubHeading]
+.incCurrentY %HalfFontHeight%
+.CheckPage 10  CommandOverflow
+.SetFontStyle Bold
+.ifNe %_MarginLeft% 20 .SetMargin L 20
+.DrawText 0 %_CurrentY% %CommandSubHeading%
+.do SetDefaultText
+[End]
+
+[CommandCheckPage]
+.CheckPage %_FONTHEIGHT% CommandOverflow
+[End]
+
+[CommandLine]
+.CheckPage %_FONTHEIGHT% CommandOverflow
+.DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %CommandLine1%
+.SetVar CommandLine1
+[End]
+
+[CommandLine2]
+.CheckPage %_FONTHEIGHT% CommandOverflow
+.SetVar top %_CurrentY%
+.SetVar cl1Width %_PageWidth%
+.IncVar cl1Width -5
+.SetVar cl1bWidth %_PageWidth%
+.IncVar cl1bWidth -10
+.SetVar cl2Width %_PageWidth%
+.IncVar cl2Width -33
+.SetVar cl3Width %_PageWidth%
+.IncVar cl3Width -35
+.ifNotBlank CommandLine1 .DrawTextWrapped 5 %top% %cl1Width% CommandCheckPage %CommandLine1%
+.ifNotBlank CommandLine1b .DrawTextWrapped 10 %top% %cl1bWidth% CommandCheckPage %CommandLine1b%
+.ifNotBlank CommandLine1c .DrawText 15 %top% %CommandLine1c%
+.ifNotBlank CommandLine2 .DrawTextWrapped 33 %top% %cl2Width% CommandCheckPage %CommandLine2%
+.ifNotBlank CommandLine3 .DrawTextWrapped 35 %top% %cl3Width% CommandCheckPage %CommandLine3%
+.SetVar CommandLine1
+.SetVar CommandLine1b
+.SetVar CommandLine1c
+.SetVar CommandLine2
+.SetVar CommandLine3
+[End]
+
+[VariableLine]
+.SetVar pageBottomMargin %_FONTHEIGHT%
+.incVar pageBottomMargin %halfLineGap%
+.CheckPage %pageBottomMargin% CommandOverflow
+.SetVar top %_CurrentY%
+.ifNotBlank CommandLine1 .DrawText 0 %top% %CommandLine1%
+.ifNotBlank CommandLine2 .DrawText 38 %top% %CommandLine2%
+.SetVar CommandLine1
+.SetVar CommandLine2
+[End]
+
+[VariableLineWrapped]
+.SetVar pageBottomMargin %_FONTHEIGHT%
+.incVar pageBottomMargin %halfLineGap%
+.SetVar maxWidth %_PageWidth%
+.incVar maxWidth -38
+.CheckPage %pageBottomMargin% CommandOverflow
+.SetVar top %_CurrentY%
+.ifNotBlank CommandLine1 .DrawText 0 %top% %CommandLine1%
+.ifNotBlank CommandLine2 .DrawTextWrapped 38 %top% %maxWidth% CheckCommandOverflow %CommandLine2%
+.SetVar CommandLine1
+.SetVar CommandLine2
+[End]
+
+[VariableLineWide]
+.SetVar pageBottomMargin %_FONTHEIGHT%
+.incVar pageBottomMargin %halfLineGap%
+.CheckPage %pageBottomMargin% CommandOverflow
+.SetVar top %_CurrentY%
+.ifNotBlank CommandLine1 .DrawText 0 %top% %CommandLine1%
+.ifNotBlank CommandLine2 .DrawText 48 %top% %CommandLine2%
+.SetVar CommandLine1
+.SetVar CommandLine2
+[End]
+
+.do SetMargins TitlePage
+.SetDocumentInfo Title jsPdf-Dynamo Developer's Documentation 
+.SetDocumentInfo Author Stephen Corbett
+.SetDocumentInfo Creator jsPdf-Dynamo
+.SetVar ChapterNo 0
+
+.Include ./Documentation/1. Introduction/Introduction.txt
+.Include ./Documentation/2. JsPdfDynamo/JsPdfDynamo.txt
+.Include ./Documentation/2. JsPdfDynamo/constructor.txt
+.Include ./Documentation/2. JsPdfDynamo/getVariable.txt
+.Include ./Documentation/2. JsPdfDynamo/prepareWrappedString.txt
+.Include ./Documentation/2. JsPdfDynamo/processCommands.txt
+.Include ./Documentation/2. JsPdfDynamo/toBlob.txt
+.Include ./Documentation/2. JsPdfDynamo/toBlobUrl.txt
+
+.Include ./Documentation/3. Variables/Introduction.txt
+.Include ./Documentation/3. Variables/SystemMaintained.txt
+
+.SetVar ChapterName Commands
+.do ChapterHeading
+
+.Include ./Documentation/4. Commands/AddBookmark.txt
+.Include ./Documentation/4. Commands/AddImageFromFile.txt
+.Include ./Documentation/4. Commands/AddImageFromUrl.txt
+.Include ./Documentation/4. Commands/AddPage.txt
+.Include ./Documentation/4. Commands/CheckPage.txt
+.Include ./Documentation/4. Commands/CopyVar.txt
+.Include ./Documentation/4. Commands/Do.txt
+.Include ./Documentation/4. Commands/DoRepeat.txt
+.Include ./Documentation/4. Commands/DrawBox.txt
+.Include ./Documentation/4. Commands/DrawDebugGrid.txt
+.Include ./Documentation/4. Commands/DrawImage.txt
+.Include ./Documentation/4. Commands/DrawLine.txt
+.Include ./Documentation/4. Commands/DrawText.txt
+.Include ./Documentation/4. Commands/DrawTextBox.txt
+.Include ./Documentation/4. Commands/DrawTextWrapped.txt
+.Include ./Documentation/4. Commands/ForEachPage.txt
+.Include ./Documentation/4. Commands/IfBlank.txt
+.Include ./Documentation/4. Commands/IfGt.txt
+.Include ./Documentation/4. Commands/IfNotBlank.txt
+.Include ./Documentation/4. Commands/incCurrentX.txt
+.Include ./Documentation/4. Commands/incCurrentY.txt
+.Include ./Documentation/4. Commands/Include.txt
+.Include ./Documentation/4. Commands/IncVar.txt
+.Include ./Documentation/4. Commands/MultVar.txt    
+.Include ./Documentation/4. Commands/setCurrentX.txt
+.Include ./Documentation/4. Commands/setCurrentY.txt
+.Include ./Documentation/4. Commands/SetDocumentInfo.txt
+.Include ./Documentation/4. Commands/SetFillColour.txt
+.Include ./Documentation/4. Commands/SetFontName.txt
+.Include ./Documentation/4. Commands/SetFontSize.txt
+.Include ./Documentation/4. Commands/SetFontStyle.txt
+.Include ./Documentation/4. Commands/SetLineColour.txt
+.Include ./Documentation/4. Commands/SetLineWidth.txt
+.Include ./Documentation/4. Commands/SetMargin.txt
+.Include ./Documentation/4. Commands/SetPageOrientation.txt
+.Include ./Documentation/4. Commands/SetVar.txt
+
+.SetVar ChapterName Other Definitions
+.do ChapterHeading
+.Include ./Documentation/5. Other Definitions/jsPdfOptions.txt
+.Include ./Documentation/5. Other Definitions/logger.txt
+.Include ./Documentation/5. Other Definitions/pageSizes.txt
+
+.Include ./Documentation/6. Other/PossibleEnhancements.txt
+.Include ./Documentation/6. Other/To Be Documented.txt
+
+.SetVar LastPage %_PageNo%
+.Do SetMargins SetDefaultText
+.SetMargin b %margins%
+.ForEachPage Footer
+
+;.DrawDebugGrid
+.SAVEpdF ./documentation/Documentation.pdf
+.WriteLog info Documentation has been generated.

package/documentation/gendoc.spec.ts

@@ -0,0 +1,22 @@
+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);
+  });
+});

package/examples/1.Simple/simple.pdf

@@ -0,0 +1,247 @@
+%PDF-1.3
+%�߬�
+3 0 obj
+<</Type /Page
+/Parent 1 0 R
+/Resources 2 0 R
+/MediaBox [0 0 595.2799999999999727 841.8899999999999864]
+/Contents 4 0 R
+>>
+endobj
+4 0 obj
+<<
+/Length 278
+>>
+stream
+0.5670000000000001 w
+0 G
+0.5669291338582678 w
+0. G
+1. g
+2.2677165354330713 w
+0. 0. 1. RG
+27.2125984251968518 814.6774015748030706 543.1181102362205593 -775.5590551181103365 re
+S
+BT
+/F2 36 Tf
+36. TL
+0. 0. 1. rg
+188.9177952755905778 410.0317322834645211 Td
+(This is a title) Tj
+ET
+endstream
+endobj
+1 0 obj
+<</Type /Pages
+/Kids [3 0 R ]
+/Count 1
+>>
+endobj
+5 0 obj
+<<
+/Type /Font
+/BaseFont /Helvetica
+/Subtype /Type1
+/Encoding /WinAnsiEncoding
+/FirstChar 32
+/LastChar 255
+>>
+endobj
+6 0 obj
+<<
+/Type /Font
+/BaseFont /Helvetica-Bold
+/Subtype /Type1
+/Encoding /WinAnsiEncoding
+/FirstChar 32
+/LastChar 255
+>>
+endobj
+7 0 obj
+<<
+/Type /Font
+/BaseFont /Helvetica-Oblique
+/Subtype /Type1
+/Encoding /WinAnsiEncoding
+/FirstChar 32
+/LastChar 255
+>>
+endobj
+8 0 obj
+<<
+/Type /Font
+/BaseFont /Helvetica-BoldOblique
+/Subtype /Type1
+/Encoding /WinAnsiEncoding
+/FirstChar 32
+/LastChar 255
+>>
+endobj
+9 0 obj
+<<
+/Type /Font
+/BaseFont /Courier
+/Subtype /Type1
+/Encoding /WinAnsiEncoding
+/FirstChar 32
+/LastChar 255
+>>
+endobj
+10 0 obj
+<<
+/Type /Font
+/BaseFont /Courier-Bold
+/Subtype /Type1
+/Encoding /WinAnsiEncoding
+/FirstChar 32
+/LastChar 255
+>>
+endobj
+11 0 obj
+<<
+/Type /Font
+/BaseFont /Courier-Oblique
+/Subtype /Type1
+/Encoding /WinAnsiEncoding
+/FirstChar 32
+/LastChar 255
+>>
+endobj
+12 0 obj
+<<
+/Type /Font
+/BaseFont /Courier-BoldOblique
+/Subtype /Type1
+/Encoding /WinAnsiEncoding
+/FirstChar 32
+/LastChar 255
+>>
+endobj
+13 0 obj
+<<
+/Type /Font
+/BaseFont /Times-Roman
+/Subtype /Type1
+/Encoding /WinAnsiEncoding
+/FirstChar 32
+/LastChar 255
+>>
+endobj
+14 0 obj
+<<
+/Type /Font
+/BaseFont /Times-Bold
+/Subtype /Type1
+/Encoding /WinAnsiEncoding
+/FirstChar 32
+/LastChar 255
+>>
+endobj
+15 0 obj
+<<
+/Type /Font
+/BaseFont /Times-Italic
+/Subtype /Type1
+/Encoding /WinAnsiEncoding
+/FirstChar 32
+/LastChar 255
+>>
+endobj
+16 0 obj
+<<
+/Type /Font
+/BaseFont /Times-BoldItalic
+/Subtype /Type1
+/Encoding /WinAnsiEncoding
+/FirstChar 32
+/LastChar 255
+>>
+endobj
+17 0 obj
+<<
+/Type /Font
+/BaseFont /ZapfDingbats
+/Subtype /Type1
+/FirstChar 32
+/LastChar 255
+>>
+endobj
+18 0 obj
+<<
+/Type /Font
+/BaseFont /Symbol
+/Subtype /Type1
+/FirstChar 32
+/LastChar 255
+>>
+endobj
+2 0 obj
+<<
+/ProcSet [/PDF /Text /ImageB /ImageC /ImageI]
+/Font <<
+/F1 5 0 R
+/F2 6 0 R
+/F3 7 0 R
+/F4 8 0 R
+/F5 9 0 R
+/F6 10 0 R
+/F7 11 0 R
+/F8 12 0 R
+/F9 13 0 R
+/F10 14 0 R
+/F11 15 0 R
+/F12 16 0 R
+/F13 17 0 R
+/F14 18 0 R
+>>
+/XObject <<
+>>
+>>
+endobj
+19 0 obj
+<<
+/Producer (jsPDF 2.5.2)
+/CreationDate (D:20240923184311+10'00')
+>>
+endobj
+20 0 obj
+<<
+/Type /Catalog
+/Pages 1 0 R
+/OpenAction [3 0 R /FitH null]
+/PageLayout /OneColumn
+>>
+endobj
+xref
+0 21
+0000000000 65535 f 
+0000000481 00000 n 
+0000002298 00000 n 
+0000000015 00000 n 
+0000000152 00000 n 
+0000000538 00000 n 
+0000000663 00000 n 
+0000000793 00000 n 
+0000000926 00000 n 
+0000001063 00000 n 
+0000001186 00000 n 
+0000001315 00000 n 
+0000001447 00000 n 
+0000001583 00000 n 
+0000001711 00000 n 
+0000001838 00000 n 
+0000001967 00000 n 
+0000002100 00000 n 
+0000002202 00000 n 
+0000002546 00000 n 
+0000002632 00000 n 
+trailer
+<<
+/Size 21
+/Root 20 0 R
+/Info 19 0 R
+/ID [ <2FACE2D36FA3E85F5DEA29CF7C8F21D9> <2FACE2D36FA3E85F5DEA29CF7C8F21D9> ]
+>>
+startxref
+2736
+%%EOF

package/examples/1.Simple/template.txt

@@ -0,0 +1,21 @@
+[Initialise]
+.SetVar themeColour blue
+.SetFontName helvetica
+.SetSpaceVert = 0.3
+.SetMargin a 10
+.SetMargin b 15
+[End]
+
+[TitlePage]
+.SetLineWidth 0.8
+.SetLineColor %themeColour%
+.DrawBox  0 0 %_PageWidth% %_PageHeight% 0
+.SetFontSize 36
+.SetTextColour %themeColour%
+.SetFontStyle Bold
+.DrawTextBox 0 0 %_PageWidth% %_PageHeight% center center %title%
+[End]
+
+[DrawPage]
+.Do Initialise TitlePage
+[End]

package/examples/examples.spec.ts

@@ -0,0 +1,26 @@
+import { expect, it, describe } from "vitest";
+import { JsPdfDynamo } from "../src/jsPdfDynamo";
+
+describe("app", () => {
+  it("1. Simple", async () => {
+    const pdfDynamo = new JsPdfDynamo({
+      pageSize: "a4",
+      orientation: "portrait",
+      unit: "mm",
+    });
+
+    const commands = [
+      // Load the template
+      ".include ./examples/1.Simple/template.txt",
+      // Set the title
+      ".SetVar title This is a title",
+      // Process the template
+      ".Do DrawPage",
+      // Save the pdf
+      ".SavePdf ./examples/1.Simple/simple.pdf",
+    ];
+
+    await pdfDynamo.processCommands(commands);
+    expect(true).toBe(true);
+  });
+});

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "jspdf-dynamo",
+  "version": "1.0.0",
+  "description": "Generate data driven PDFs from dynamic templates",
+  "main": "dist/index.js",
+  "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 ",
+    "examples": "vitest --dir ./examples run",
+    "format": "prettier --write .",
+    "lint": "tsc",
+    "local-release": "changeset version && changeset publish",
+    "prepublishOnly": "npm run ci",
+    "check-format": "prettier --check .",
+    "test": "vitest --dir ./src run"
+  },
+  "keywords": [
+    "dynamo",
+    "jsPdf",
+    "PDF",
+    "template",
+    "typescript"
+  ],
+  "author": "Stephen Corbett",
+  "license": "MIT",
+  "dependencies": {
+    "jspdf": "^2.5.1",
+    "node-fetch": "^3.3.2"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.15.4",
+    "@changesets/cli": "^2.27.8",
+    "@types/blob-stream": "^0.1.33",
+    "@types/jspdf": "^1.3.3",
+    "prettier": "^3.3.3",
+    "tslog": "^4.9.3",
+    "tsup": "^8.2.4",
+    "typescript": "^5.5.4",
+    "vitest": "^2.1.1"
+  },
+  "files": [
+    "dist",
+    "documentation",
+    "examples",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": "./dist/index.js",
+      "default": "./dist/index.cjs"
+    }
+  }
+}