refactor: wip

.cspell.json

@@ -3,12 +3,14 @@
     "@schoero/cspell-config"
   ],
   "words": [
-    "swissqrbill",
-    "SCOR",
+    "iban",
+    "qriban",
+    "QRIBAN",
     "QRIID",
     "QRR",
-    "QRIBAN",
-    "qriban",
-    "iban"
+    "SCOR",
+    "swiss",
+    "swissqrbill",
+    "undash"
   ]
 }

.eslintignore

@@ -1,4 +1,5 @@
 node_modules
+lib
 src/shared/qr-code-generator.ts
 !/.vscode
 !/.github

package.json

@@ -133,6 +133,8 @@
     "markdownlint:ci": "npm run markdownlint",
     "markdownlint:fix": "node_modules/.bin/markdownlint-cli2-fix '**/*.md' '#node_modules'",
     "postbuild": "sh fix-exports.sh",
+    "spellcheck": "node_modules/.bin/cspell lint",
+    "spellcheck:ci": "npm run spellcheck -- --no-progress",
     "test": "node_modules/.bin/vitest -c ./vite.config.ts",
     "test:legacy": "npm run build && cd tests && sh run.sh",
     "test:update": "npm run test -- --update --run",
@@ -150,9 +152,9 @@
   },
   "devDependencies": {
     "@schoero/cspell-config": "^1.5.0",
-    "@schoero/eslint-config": "^1.28.14",
+    "@schoero/eslint-config": "^1.28.15",
     "@schoero/markdownlint-config": "^1.1.2",
-    "@schoero/ts-config": "^0.3.0",
+    "@schoero/ts-config": "^0.3.1",
     "@types/blob-stream": "^0.1.30",
     "@types/node": "^18.11.15",
     "@types/svg-parser": "^2.0.3",

src/browser/bundle.ts

@@ -2,10 +2,9 @@ import fs from "fs";
 
 import BlobStream_ from "blob-stream";
 
-//-- Register fonts for the bundled version
-// @ts-expect-error
+// @ts-expect-error - Import resolution does not work here
 import Helvetica from "../../node_modules/pdfkit/js/data/Helvetica.afm";
-// @ts-expect-error
+// @ts-expect-error - Import resolution does not work here
 import HelveticaBold from "../../node_modules/pdfkit/js/data/Helvetica-Bold.afm";
 import * as types from "../shared/types.js";
 import * as utils from "../shared/utils.js";

src/browser/pdf.ts

@@ -10,10 +10,9 @@ export import BlobStream = BlobStream_;
 
 export class PDF extends PDF_ {
 
-  constructor(data: Data, writableStream: IBlobStream, options?: PDFOptions);
-  constructor(data: Data, writeableStream: IBlobStream, options?: PDFOptions, callback?: Function);
   constructor(data: Data, writeableStream: IBlobStream, callback?: Function);
-  constructor(data: Data, writeableStream: IBlobStream, optionsOrCallback?: PDFOptions | Function, callbackOrUndefined?: Function | undefined) {
+  constructor(data: Data, writeableStream: IBlobStream, options?: PDFOptions, callback?: Function);
+  constructor(data: Data, writeableStream: IBlobStream, optionsOrCallback?: Function | PDFOptions, callbackOrUndefined?: Function | undefined) {
 
     let callback: Function | undefined = undefined;
     let options: PDFOptions | undefined = undefined;

src/browser/svg.ts

@@ -1,13 +1,8 @@
-import { Data, SVGOptions } from "../shared/types.js";
 import { SVG_ } from "../svg/svg.js";
 
 
 export class SVG extends SVG_ {
 
-  constructor(data: Data, options?: SVGOptions) {
-    super(data, options);
-  }
-
 
   /**
    * Outputs the SVG as a string.
@@ -21,7 +16,8 @@ export class SVG extends SVG_ {
 
   /**
    * Returns the SVG element.
-   * > **Note:** This function is only available in the browser.
+   *
+   * **Note:** This function is only available in the browser.
    *
    * @readonly
    */

src/node/pdf.ts

@@ -7,13 +7,11 @@ import { Data, PDFOptions } from "../shared/types.js";
 
 export class PDF extends PDF_ {
 
-  constructor(data: Data, outputPath: string, options?: PDFOptions);
-  constructor(data: Data, writableStream: Writable, options?: PDFOptions);
-  constructor(data: Data, outputPath: string, options?: PDFOptions, callback?: Function);
-  constructor(data: Data, writableStream: Writable, options?: PDFOptions, callback?: Function);
   constructor(data: Data, outputPath: string, callback?: Function);
   constructor(data: Data, writableStream: Writable, callback?: Function);
-  constructor(data: Data, outputPathOrWritableStream: string | Writable, optionsOrCallback?: PDFOptions | Function, callbackOrUndefined?: Function | undefined) {
+  constructor(data: Data, outputPath: string, options?: PDFOptions, callback?: Function);
+  constructor(data: Data, writableStream: Writable, options?: PDFOptions, callback?: Function);
+  constructor(data: Data, outputPathOrWritableStream: Writable | string, optionsOrCallback?: Function | PDFOptions, callbackOrUndefined?: Function | undefined) {
 
     let callback: Function | undefined = undefined;
     let options: PDFOptions | undefined = undefined;

src/node/svg.ts

@@ -1,14 +1,9 @@
-import { Data, SVGOptions } from "../shared/types.js";
 import { SVG_ } from "../svg/svg.js";
 
 
 export class SVG extends SVG_ {
 
-  constructor(data: Data, options?: SVGOptions) {
-    super(data, options);
-  }
-
-  public toString(): string {
+  public override toString(): string {
     return this.outerHTML;
   }
 

src/pdf/extended-pdf.ts

@@ -113,7 +113,7 @@ export class ExtendedPDF extends PDFDocument {
   }
 
 
-  public switchToPage(n: number): PDFKit.PDFPage {
+  public override switchToPage(n: number): PDFKit.PDFPage {
     const page = super.switchToPage(n);
     this._currentPage = n;
     return page;

src/pdf/pdf.ts

@@ -26,7 +26,7 @@ export class PDF_ extends ExtendedPDF {
     this._data = data;
 
 
-    //-- Clean data (remove line breaks and unnecessary whitespaces)
+    //-- Clean data (remove line breaks and unnecessary white spaces)
 
     this._data = cleanData(this._data);
 
@@ -82,7 +82,7 @@ export class PDF_ extends ExtendedPDF {
    * @param options - An object containing [PDFKit document options.](https://pdfkit.org/docs/getting_started.html#adding_pages)
    * @returns `this`
    */
-  public addPage(options?: PDFKit.PDFDocumentOptions): PDFKit.PDFDocument {
+  public override addPage(options?: PDFKit.PDFDocumentOptions): PDFKit.PDFDocument {
 
     if(options === undefined){
       options = {
@@ -97,7 +97,7 @@ export class PDF_ extends ExtendedPDF {
   }
 
 
-  public end(): void {
+  public override end(): void {
     this.emit("beforeEnd", this);
     return super.end();
   }

src/shared/shared.ts

@@ -9,23 +9,23 @@ export function cleanData(data: Data): Data {
     const keys = Object.keys(object);
 
     for(let k = 0; k < keys.length; k++){
-      if(typeof object[keys[k]] === "string"){
+      if(typeof object[keys[k]!] === "string"){
 
-        object[keys[k]] = removeLinebreaks(object[keys[k]]);
+        object[keys[k]!] = removeLineBreaks(object[keys[k]!]);
 
         if(keys[k] === "account"){
-          object[keys[k]] = object[keys[k]].replace(/ /g, "");
+          object[keys[k]!] = object[keys[k]!].replace(/ /g, "");
         }
         if(keys[k] === "reference"){
-          object[keys[k]] = object[keys[k]].replace(/ /g, "");
+          object[keys[k]!] = object[keys[k]!].replace(/ /g, "");
         }
         if(keys[k] === "country"){
-          object[keys[k]] = object[keys[k]].toUpperCase();
+          object[keys[k]!] = object[keys[k]!].toUpperCase();
         }
 
       } else {
-        if(typeof object[keys[k]] === "object"){
-          _cleanObject(object[keys[k]]);
+        if(typeof object[keys[k]!] === "object"){
+          _cleanObject(object[keys[k]!]);
         }
       }
     }
@@ -38,7 +38,7 @@ export function cleanData(data: Data): Data {
 }
 
 
-export function removeLinebreaks(text: string): string {
+export function removeLineBreaks(text: string): string {
   return text.replace(/\n/g, "").replace(/\r/g, "");
 }
 

src/shared/types.ts

@@ -23,7 +23,8 @@ export interface Data {
 
   /**
    * Additional information. **Max 140 characters.**
-   * > Bill information contain coded information for automated booking of the payment. The data is not forwarded with the payment.
+   *
+   * Bill information contain coded information for automated booking of the payment. The data is not forwarded with the payment.
    */
   additionalInformation?: string;
 
@@ -34,13 +35,15 @@ export interface Data {
 
   /**
    * Alternative scheme. **Max. 100 characters.**
-   * > Parameter character chain of the alternative scheme according to the syntax definition in the [“Alternative scheme” section](https://www.paymentstandards.ch/dam/downloads/ig-qr-bill-en.pdf)
+   *
+   * Parameter character chain of the alternative scheme according to the syntax definition in the [“Alternative scheme” section](https://www.paymentstandards.ch/dam/downloads/ig-qr-bill-en.pdf)
    */
   av1?: string;
 
   /**
    * Alternative scheme. **Max. 100 characters.**
-   * > Parameter character chain of the alternative scheme according to the syntax definition in the [“Alternative scheme” section](https://www.paymentstandards.ch/dam/downloads/ig-qr-bill-en.pdf)
+   *
+   * Parameter character chain of the alternative scheme according to the syntax definition in the [“Alternative scheme” section](https://www.paymentstandards.ch/dam/downloads/ig-qr-bill-en.pdf)
    */
   av2?: string;
 
@@ -51,13 +54,15 @@ export interface Data {
 
   /**
    * A message. **Max. 140 characters.**
-   * > message can be used to indicate the payment purpose or for additional textual information about payments with a structured reference.
+   *
+   * message can be used to indicate the payment purpose or for additional textual information about payments with a structured reference.
    */
   message?: string;
 
   /**
    * A reference number. **Max 27 characters.**
-   * > QR-IBAN: Maximum 27 characters. Must be filled if a QR-IBAN is used.
+   *
+   * QR-IBAN: Maximum 27 characters. Must be filled if a QR-IBAN is used.
    *   Creditor Reference (ISO 11649): Maximum 25 characters.
    */
   reference?: string;
@@ -119,21 +124,23 @@ export interface PDFOptions {
   language?: Languages;
 
   /**
-   *  Whether you want render the outlines. This option may be disabled if you use perforated paper.
+   * Whether you want render the outlines. This option may be disabled if you use perforated paper.
    * @defaultValue `true`
    */
   outlines?: boolean;
 
   /**
-   *  Whether you want to show the scissors icons or the text `Separate before paying in`.
-   *  > **Warning:** Setting **scissors** to false sets **separate** to true. To disable scissors and separate, you have to set both options to false.
+   * Whether you want to show the scissors icons or the text `Separate before paying in`.
+   *
+   * **Warning:** Setting **scissors** to false sets **separate** to true. To disable scissors and separate, you have to set both options to false.
    * @defaultValue `true`
    */
   scissors?: boolean;
 
   /**
-   *  Whether you want to show the text `Separate before paying in` rather than the scissors icons.
-   *  > **Warning:** Setting **separate** to true sets **scissors** to false. To disable scissors and separate, you have to set both options to false.
+   * Whether you want to show the text `Separate before paying in` rather than the scissors icons.
+   *
+   * **Warning:** Setting **separate** to true sets **scissors** to false. To disable scissors and separate, you have to set both options to false.
    * @defaultValue `false`
    */
   separate?: boolean;