Roadmap to v4

[schoero]

This issue is meant to summarize the planned changes for v4 and track its progress.

Goals:

• More flexibility:
  • External class / Next #388
  • Generate QR Code only [as SVG] #391
  • How to directly access pdf stream instead of writing file #397
  • SwissQRBill.PDF options Request #405
  • Pdf size issue #411
  • External class / Next #388 (comment)
  • Feature/custom font #417
  • Add option to exclude scissors in SVG #420
• Automated testing
• Auto generating documentation
• Automatic versioning, changelog generation and releases
• General cleanup

Todo:

• Don't directly extend PDFKit. Instead create a new QRBill class that attaches to an existing PDFKit instance. External QRBill class #386 (comment).
• Create a separate Table class for the addTable() function, that attaches to an existing PDFKit instance.
• Keep an existing SwissQRBill class, that extends both of the other classes, as well as PDFKit for backwards compatibility.
• Autogenerate changelog
• Improve testing
• Autogenerate documentation.
• General cleanup:
  • Improve TypeScript typings.
  • Rename repository to lowercase swissqrbill
  • Rename master branch to main
• Update how to guide
• Create comprehensive migration guide for all users
  • users of prebuilt bundle.
  • users of html script tag.
  • users of PDF events.
  • users with custom bundling.
  • users of common js module.

[skch-17]

@schoero Just wanted to let you know that currently in v4 the addContent (swissCrossBackground and scissors) seams not to work. At least in my version. I changed it back to doc.path and it worked again. Careful the strings are not an svg path they need to be replaced as well. (Master branch has the right thing)

[schoero]

Thanks for pointing that out @skch-17. We switched to addContent for performance reasons #384. But the scissors and swiss cross contained invalid data. I have fixed it now and also improved the testing behavior, so that this kind of problems will be caught in future.

[schoero]

SwissQRBill v4.0.0 is now finally released 🎉