Merge pull request #22 from mehmet-kozan/reports-site

Reports site, readme and CI updated

Author: mehmet-kozan

.github/workflows/deploy_github_page.yml

@@ -54,6 +54,16 @@ jobs:
           directory: ./reports_site/coverage
           fail_ci_if_error: false
 
+      - name: Copy test pdf files into site
+        run: |
+          if [ -d test/pdf_file ]; then
+            mkdir -p reports_site/pdf
+            cp -r test/pdf_file/* reports_site/pdf/ || true
+            echo "Copied test/pdf_file -> reports_site/pdf/"
+          else
+            echo "No test/pdf_file directory found; skipping copy"
+          fi
+
       - name: Setup Pages
         uses: actions/configure-pages@v5
 

.github/workflows/test_integration.yml

@@ -35,5 +35,8 @@ jobs:
       - name: Unit tests
         run: npm test
 
+      - name: Unsupported tests
+        run: npm run test:u
+
       - name: Integration tests
         run: npm run test:i

.github/workflows/test_unsupported.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [18, 21]
+        node-version: [18, 19, 21]
 
     steps:
       - name: Checkout

.gitignore

@@ -156,4 +156,5 @@ test/**/imgs/
 test/**/*_images/
 dist/
 temp/
+reports_site/pdf/
 

reports_site/api-report/pdf-parse.api.md README.api.mdreports_site/api-report/pdf-parse.api.md renamed to README.api.md

@@ -268,8 +268,9 @@ export default nextConfig;
 Custom builds, Electron/NW.js, or specific deployment environments—you may need to manually configure the worker source.
 
 ```js
+import {getWorkerPath, getWorkerSource} from "pdf-parse/worker"; // Import this before importing "pdf-parse"
 import {PDFParse} from "pdf-parse";
-import {getWorkerPath, getWorkerSource} from "pdf-parse/worker";
+
 // CommonJS
 // const {getWorkerSource, getWorkerPath} = require('pdf-parse/worker');
 
@@ -351,13 +352,40 @@ See [`example/basic.esm.worker.html`](example/basic.esm.worker.html) for a worki
 
 > **Benchmark Note:** The benchmark currently runs only against `pdf2json`. I don't know the current state of `pdf2json` — the original reason for creating `pdf-parse` was to work around stability issues with `pdf2json`. I deliberately did not include `pdf-parse` or other `pdf.js`-based packages in the benchmark because dependencies conflict. If you have recommendations for additional packages to include, please open an issue, see [`benchmark results`](https://mehmet-kozan.github.io/pdf-parse/bench.html).
 
-## Supported Node.js Versions
+## Supported Node.js Versions(20.x, 22.x, 23.x, 24.x)
 
 - Supported: Node.js 20 (>= 20.16.0), Node.js 22 (>= 22.3.0), Node.js 23 (>= 23.0.0), and Node.js 24 (>= 24.0.0).
 - Not supported: Node.js 21.x, and Node.js 19.x and earlier.
 
 Integration tests run on Node.js 20–24, see [`test_integration.yml`](./.github/workflows/test_integration.yml).
 
+### Unsupported Node.js Versions (18.x, 19.x, 21.x)
+
+Requires additional setup — import and configure a compatible CanvasFactory or worker implementation before initializing pdf-parse; see the examples below.
+
+ESM 
+```js
+import { CustomCanvasFactory } from 'pdf-parse/canvas'; // Import this before importing "pdf-parse"
+import { PDFParse } from 'pdf-parse';
+
+const parser = new PDFParse({ data: buffer, CanvasFactory: CustomCanvasFactory });
+// then use parser
+```
+
+CommonJS
+```js
+const { CustomCanvasFactory } = require('pdf-parse/canvas'); // Import this before importing "pdf-parse"
+const { PDFParse } = require('pdf-parse');
+
+const parser = new PDFParse({ data: buffer, CanvasFactory: CustomCanvasFactory });
+// then use parser
+```
+
+Unsupported tests run on Node.js 18, 19, 21, see [`test_unsupported.yml`](./.github/workflows/test_unsupported.yml).  
+Check: [`test_unsupported`](./test_unsupported)
+
+
+
 ## Contributing
 
  When opening an issue, please attach the relevant PDF file if possible. Providing the file will help us reproduce and resolve your issue more efficiently. For detailed guidelines on how to contribute, report bugs, or submit pull requests, see: [`contributing to pdf-parse`](https://github.com/mehmet-kozan/pdf-parse?tab=contributing-ov-file#contributing-to-pdf-parse)

README.md

@@ -158,7 +158,7 @@
 		 * SUPPORTED TOKENS: <packageName>, <unscopedPackageName>
 		 * DEFAULT VALUE: "<unscopedPackageName>"
 		 */
-		// "reportFileName": "<unscopedPackageName>",
+		"reportFileName": "README.api.md",
 
 		/**
 		 * To support different approval requirements for different API levels, multiple "variants" of the API report can
@@ -184,7 +184,7 @@
 		 * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
 		 * DEFAULT VALUE: "<projectFolder>/etc/"
 		 */
-		"reportFolder": "reports_site/api-report/"
+		"reportFolder": "./"
 
 		/**
 		 * Specifies the folder where the temporary report file is written.  The file name portion is determined by
@@ -218,7 +218,7 @@
 		/**
 		 * (REQUIRED) Whether to generate a doc model file.
 		 */
-		"enabled": true
+		"enabled": true,
 
 		/**
 		 * The output path for the doc model file.  The file extension should be ".api.json".
@@ -229,7 +229,7 @@
 		 * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
 		 * DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json"
 		 */
-		// "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json",
+		"apiJsonFilePath": "reports_site/api-report/pdf-parse.api.json",
 
 		/**
 		 * Whether "forgotten exports" should be included in the doc model file. Forgotten exports are declarations
@@ -254,7 +254,7 @@
 		 * SUPPORTED TOKENS: none
 		 * DEFAULT VALUE: ""
 		 */
-		// "projectFolderUrl": "http://github.com/path/to/your/projectFolder"
+		"projectFolderUrl": "https://github.com/mehmet-kozan/pdf-parse/tree/main"
 	},
 
 	/**
@@ -341,7 +341,7 @@
 		 *
 		 * DEFAULT VALUE: true
 		 */
-		// "enabled": true,
+		"enabled": true,
 		/**
 		 * Specifies where the TSDoc metadata file should be written.
 		 *
@@ -355,7 +355,7 @@
 		 * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
 		 * DEFAULT VALUE: "<lookup>"
 		 */
-		// "tsdocMetadataFilePath": "<projectFolder>/dist/tsdoc-metadata.json"
+		"tsdocMetadataFilePath": "reports_site/api-report/tsdoc-metadata.json"
 	},
 
 	/**
@@ -389,7 +389,7 @@
 				 *
 				 * DEFAULT VALUE: "warning"
 				 */
-				"logLevel": "warning"
+				"logLevel": "error"
 
 				/**
 				 * When addToApiReportFile is true:  If API Extractor is configured to write an API report file (.api.md),

api-extractor.json

@@ -107,7 +107,7 @@
 		"build:node": "vite build --config vite.config.node.ts && npm run bundle:dts",
 		"build:browser": "vite build --config vite.config.browser.ts && vite build --config vite.config.browser.min.ts",
 		"build:worker": "vite build --config vite.config.worker.ts",
-		"bundle:dts": "api-extractor run --local --verbose",
+		"bundle:dts": "api-extractor run --local",
 		"clean": "npm run clean:build && npm run clean:site && npm run clean:test && npm run clean:test:i",
 		"clean:build": "rimraf dist bin/worker/worker_source.js bin/worker/worker_source.cjs",
 		"clean:site": "rimraf reports_site/test-report reports_site/coverage reports_site/live_demo/dist-browser",