fix: package json exports (#448)

* fix: conditional exports * chore: update dependencies * style: eslint fixes * fix: add `node10` require fallbacks https://github.com/andrewbranch/example-subpath-exports-ts-compat * chore: update version * chore: change gitignore to root paths * chore: regenerate documentation
schoero · Jan 1, 2025 · 01d51fe · 01d51fe
1 parent 5572c2e
commit 01d51fe
Show file tree

Hide file tree

Showing 39 changed files with 4,790 additions and 3,750 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,14 @@
-node_modules
-tests/output
-examples/output
-lib
-local
 .DS_Store
 .env
+
+node_modules
+
+/tests/output
+/examples/output
+
+/lib
+/pdf
+/svg
+/errors
+/types
+/utils
diff --git a/README.md b/README.md
@@ -95,7 +95,6 @@ Once you have imported SwissQRBill and PDFKit, it is quite easy to create a simp
 
 ```js
 import { createWriteStream } from "node:fs";
-
 import PDFDocument from "pdfkit";
 import { SwissQRBill } from "swissqrbill/pdf";
 

diff --git a/docs/bundle/index.md b/docs/bundle/index.md
@@ -570,7 +570,7 @@ Defined in: [src/bundle/index.ts](../../src/bundle/index.ts#L3C7)
 
 #### Class: svg.SwissQRBill
 
-Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L45C0)  
+Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L44C0)  
 
 ##### Description
 
@@ -610,7 +610,7 @@ writeFileSync("qr-bill.svg", svg.toString());
 
 ##### Constructor: new svg.SwissQRBill(data\[, options\])
 
-Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L56C2)  
+Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L55C2)  
 
 ###### Parameters
 
@@ -627,7 +627,7 @@ Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L56C2)
 
 `public`  
 
-Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L47C2)  
+Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L46C2)  
 
 ###### Type
 
@@ -639,7 +639,7 @@ Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L47C2)
 
 `public`  
 
-Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L87C2)  
+Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L86C2)  
 
 ###### Return Type
 
@@ -655,7 +655,7 @@ Outputs the SVG as a string.
 
 `public`  
 
-Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L97C2)  
+Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L96C2)  
 
 ###### Return Type
 
@@ -669,13 +669,13 @@ Returns the SVG element.
 
 #### Class: svg.SwissQRCode
 
-Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L10C0)  
+Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L9C0)  
 
 <br/>
 
 ##### Constructor: new svg.SwissQRCode(data\[, size\])
 
-Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L21C2)  
+Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L20C2)  
 
 ###### Parameters
 
@@ -700,7 +700,7 @@ Creates a Swiss QR Code.
 
 `public`  
 
-Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L12C2)  
+Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L11C2)  
 
 ###### Type
 
@@ -712,7 +712,7 @@ Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L12C2)
 
 `public`  
 
-Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L58C2)  
+Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L57C2)  
 
 ###### Return Type
 
@@ -728,7 +728,7 @@ Outputs the SVG as a string.
 
 `public`  
 
-Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L68C2)  
+Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L67C2)  
 
 ###### Return Type
 

diff --git a/docs/how-to-create-a-complete-qr-bill.md b/docs/how-to-create-a-complete-qr-bill.md
@@ -2,8 +2,7 @@
 
 ## Introduction
 
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)
-][stackblitz]
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)][stackblitz]
 
 In this guide you will learn how you can use SwissQRBill to create a complete PDF file and then attach the QR slip to the bottom of the page.  
 We will use [PDFKit][npm-pdfkit] to create a PDF document with a Logo, title and the address of the biller, as well as the recipient.  

diff --git a/docs/importing.md b/docs/importing.md
@@ -21,8 +21,7 @@ Each example below is available as a StackBlitz project.
 
 #### Node.js: ES Module import
 
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)
-][node-esm-javascript]
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)][node-esm-javascript]
 
 Importing the library in Node.js using ES modules is straight forward. You can use the following import statement:
 
@@ -37,8 +36,7 @@ import { SwissQRBill } from "swissqrbill/svg";
 
 #### Node.js: CommonJS import
 
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)
-][node-cjs-javascript]
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)][node-cjs-javascript]
 
 SwissQRBill provides a CommonJS module for legacy Node.js applications. You can require the library as follows:
 
@@ -55,8 +53,7 @@ const { SwissQRBill } = require("swissqrbill/svg");
 
 ### Browser: Bundling with webpack
 
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)
-][browser-bundling-with-webpack]
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)][browser-bundling-with-webpack]
 
 > **Warning**
 >
@@ -66,8 +63,7 @@ As PDFKit internally relies on several different built in modules of Node.js, it
 
 ### Browser: Pre-built bundle
 
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)
-][browser-pre-built-bundle]
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)][browser-pre-built-bundle]
 
 > **Warning**
 >

diff --git a/docs/svg/index.md b/docs/svg/index.md
@@ -31,7 +31,7 @@
 
 ### Class: SwissQRBill
 
-Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L45C0)  
+Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L44C0)  
 
 #### Description
 
@@ -71,7 +71,7 @@ writeFileSync("qr-bill.svg", svg.toString());
 
 #### Constructor: new SwissQRBill(data\[, options\])
 
-Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L56C2)  
+Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L55C2)  
 
 ##### Parameters
 
@@ -88,7 +88,7 @@ Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L56C2)
 
 `public`  
 
-Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L47C2)  
+Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L46C2)  
 
 ##### Type
 
@@ -100,7 +100,7 @@ Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L47C2)
 
 `public`  
 
-Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L87C2)  
+Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L86C2)  
 
 ##### Return Type
 
@@ -116,7 +116,7 @@ Outputs the SVG as a string.
 
 `public`  
 
-Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L97C2)  
+Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L96C2)  
 
 ##### Return Type
 
@@ -130,13 +130,13 @@ Returns the SVG element.
 
 ### Class: SwissQRCode
 
-Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L10C0)  
+Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L9C0)  
 
 <br/>
 
 #### Constructor: new SwissQRCode(data\[, size\])
 
-Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L21C2)  
+Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L20C2)  
 
 ##### Parameters
 
@@ -161,7 +161,7 @@ Creates a Swiss QR Code.
 
 `public`  
 
-Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L12C2)  
+Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L11C2)  
 
 ##### Type
 
@@ -173,7 +173,7 @@ Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L12C2)
 
 `public`  
 
-Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L58C2)  
+Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L57C2)  
 
 ##### Return Type
 
@@ -189,7 +189,7 @@ Outputs the SVG as a string.
 
 `public`  
 
-Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L68C2)  
+Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L67C2)  
 
 ##### Return Type
 

diff --git a/eslint.config.js b/eslint.config.js
@@ -7,7 +7,14 @@ export default [
   ...sharedRules,
 
   {
-    ignores: ["src/shared/qr-code-generator.ts"]
+    ignores: [
+      "src/shared/qr-code-generator.ts",
+      "pdf",
+      "svg",
+      "utils",
+      "types",
+      "errors"
+    ]
   },
   {
     files: ["**/*.ts"],

diff --git a/examples/browser-bundling-with-webpack/src/pdf.js b/examples/browser-bundling-with-webpack/src/pdf.js
@@ -1,6 +1,5 @@
-import fs from "fs";
-
 import BlobStream from "blob-stream";
+import fs from "fs";
 import PDFDocument from "pdfkit";
 import HelveticaBold from "pdfkit/js/data/Helvetica-Bold.afm";
 import Helvetica from "pdfkit/js/data/Helvetica.afm";

diff --git a/examples/how-to-create-a-complete-qr-bill/src/index.js b/examples/how-to-create-a-complete-qr-bill/src/index.js
@@ -1,5 +1,4 @@
 import { createWriteStream } from "fs";
-
 import PDFDocument from "pdfkit";
 import { SwissQRBill, Table } from "swissqrbill/pdf";
 import { mm2pt } from "swissqrbill/utils";

diff --git a/examples/node-cjs-javascript/src/pdf.js b/examples/node-cjs-javascript/src/pdf.js
@@ -1,5 +1,4 @@
 const { createWriteStream } = require("fs");
-
 const PDFDocument = require("pdfkit");
 const { SwissQRBill } = require("swissqrbill/pdf");
 

diff --git a/examples/node-cjs-javascript/src/svg.js b/examples/node-cjs-javascript/src/svg.js
@@ -1,5 +1,4 @@
 const { writeFileSync } = require("fs");
-
 const { SwissQRBill } = require("swissqrbill/svg");
 
 const data = require("./data.js");

diff --git a/examples/node-esm-javascript/src/pdf.js b/examples/node-esm-javascript/src/pdf.js
@@ -1,5 +1,4 @@
 import { createWriteStream } from "fs";
-
 import PDFDocument from "pdfkit";
 import { SwissQRBill } from "swissqrbill/pdf";
 

diff --git a/examples/node-esm-javascript/src/svg.js b/examples/node-esm-javascript/src/svg.js
@@ -1,5 +1,4 @@
 import { writeFileSync } from "fs";
-
 import { SwissQRBill } from "swissqrbill/svg";
 
 import { data } from "./data.js";
-Original file line number
+Diff line change
@@ Expand Up @@
     ```js
     import { createWriteStream } from "node:fs";
     import PDFDocument from "pdfkit";
     import { SwissQRBill } from "swissqrbill/pdf";
@@ Expand Down @@