Merge pull request #27 from dichovsky/version3

Version3
dichovsky · Apr 9, 2023 · 0751379 · 0751379
2 parents 056f0b6 + 56c97cd
commit 0751379
Show file tree

Hide file tree

Showing 33 changed files with 1,057 additions and 979 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -8,7 +8,7 @@ jobs:
     runs-on: macos-11
     strategy:
       matrix:
-        node: [ 16, 18 ]
+        node: [ 18, 19 ]
     steps:
       - uses: actions/checkout@v2
       - name: Test on macos-11 Use Node.js ${{ matrix.node }}
@@ -23,7 +23,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ 16, 18 ]
+        node: [ 18, 19 ]
     steps:
       - uses: actions/checkout@v2
       - name: Test on Ubuntu Use Node.js ${{ matrix.node }}
@@ -38,7 +38,7 @@ jobs:
     runs-on: windows-latest
     strategy:
       matrix:
-        node: [ 16, 18 ]
+        node: [ 18, 19 ]
     steps:
       - uses: actions/checkout@v2
       - name: Test on Windows Use Node.js ${{ matrix.node }}

diff --git a/.prettierrc b/.prettierrc
@@ -7,11 +7,11 @@
     "useTabs": false,
     "arrowParens": "always",
     "overrides": [
-      {
-        "files": ["*.json", ".*.json"],
-        "options": {
-          "tabWidth": 4
+        {
+            "files": ["*.json", ".*.json"],
+            "options": {
+                "tabWidth": 4
+            }
         }
-      }
     ]
-  }
+}
diff --git a/README.md b/README.md
@@ -30,12 +30,13 @@ test(`Convert PDF To PNG`, async () => {
     {
         disableFontFace: false, // When `false`, fonts will be rendered using a built-in font renderer that constructs the glyphs with primitive path commands. Default value is true.
         useSystemFonts: false, // When `true`, fonts that aren't embedded in the PDF document will fallback to a system font. Default value is false.
+        enableXfa: false, // Render Xfa forms if any. Default value is false.
         viewportScale: 2.0, // The desired scale of PNG viewport. Default value is 1.0.
         outputFolder: 'output/folder', // Folder to write output PNG files. If not specified, PNG output will be available only as a Buffer content, without saving to a file.
         outputFileMask: 'buffer', // Output filename mask. Default value is 'buffer'.
         pdfFilePassword: 'pa$$word', // Password for encrypted PDF.
         pagesToProcess: [1, 3, 11],   // Subset of pages to convert (first page = 1), other pages will be skipped if specified.
-        strictPagesToProcess: false // When `true`, will throw an error if specified page number in pagesToProcess is invalid, otherwise will skip invalid page. Default value is false.
+        strictPagesToProcess: false, // When `true`, will throw an error if specified page number in pagesToProcess is invalid, otherwise will skip invalid page. Default value is false.
         verbosityLevel: 0 // Verbosity level. ERRORS: 0, WARNINGS: 1, INFOS: 5. Default value is 0.
     });
    ...
@@ -46,9 +47,12 @@ test(`Convert PDF To PNG`, async () => {
 
 ```javascript
 {
-    name: string; // PNG page name in a format `{pdfFileName}_page_{pdfPageNumber}.png`,
+    pageNumber: number; // Page number in PDF file
+    name: string; // PNG page name in a format `{pdfFileName}_page_{pdfPageNumber}.png`
     content: Buffer; // PNG page Buffer content
     path: string; // Path to the rendered PNG page file (empty string and if outputFilesFolder is not provided)
+    width: number; // PNG page width
+    height: number; // PNG page height
 }
 ```
 

diff --git a/__tests__/buffer.pdf.to.buffer.ts b/__tests__/buffer.pdf.to.buffer.ts
@@ -1,7 +1,7 @@
-import { existsSync, readFileSync } from 'fs';
-import { parse, resolve } from 'path';
-import comparePng from 'png-visual-compare';
-import { pdfToPng, PngPageOutput } from '../src';
+import { existsSync, readFileSync } from 'node:fs';
+import { parse, resolve } from 'node:path';
+import { PngPageOutput, pdfToPng } from '../src';
+import { comparePNG } from '../src/compare.png';
 import { PDF_TO_PNG_OPTIONS_DEFAULTS } from '../src/const';
 
 const pdfFilePath: string = resolve('test-data/large_pdf.pdf');
@@ -15,8 +15,7 @@ test(`should convert PDF To PNG without saving to file, output file mask is defi
 
     pngPages.forEach((pngPage: PngPageOutput) => {
         const expectedFilePath: string = resolve('test-data/pdf.to.buffer/expected', pngPage.name);
-        const expectedFileContent: Buffer = readFileSync(expectedFilePath);
-        const compareResult: number = comparePng(pngPage.content, expectedFileContent);
+        const compareResult: number = comparePNG(pngPage.content, expectedFilePath);
 
         expect(existsSync(pngPage.path)).toBe(false);
         expect(compareResult).toBe(0);
@@ -33,8 +32,7 @@ test(`should convert PDF To PNG without saving to file, output file mask is not
             'test-data/pdf.to.buffer/expected',
             pngPage.name.replace(PDF_TO_PNG_OPTIONS_DEFAULTS.outputFileMask as string, parse(pdfFilePath).name),
         );
-        const expectedFileContent: Buffer = readFileSync(expectedFilePath);
-        const compareResult: number = comparePng(pngPage.content, expectedFileContent);
+        const compareResult: number = comparePNG(pngPage.content, expectedFilePath);
 
         expect(pngPage.name).toBe(`${PDF_TO_PNG_OPTIONS_DEFAULTS.outputFileMask as string}_page_${index + 1}.png`);
         expect(existsSync(pngPage.path)).toBe(false);

diff --git a/__tests__/pdf.pages.to.file.ts b/__tests__/pdf.pages.to.file.ts
@@ -1,7 +1,7 @@
-import { readFileSync } from 'fs';
-import { resolve } from 'path';
-import comparePng from 'png-visual-compare';
+import { readFileSync } from 'node:fs';
+import { resolve } from 'node:path';
 import { pdfToPng, PngPageOutput } from '../src';
+import { comparePNG } from '../src/compare.png';
 
 test(`should convert specific PDF pages To PNG files`, async () => {
     const pdfFilePath: string = resolve('test-data/large_pdf.pdf');
@@ -15,9 +15,8 @@ test(`should convert specific PDF pages To PNG files`, async () => {
 
     pngPages.forEach((pngPage: PngPageOutput) => {
         const expectedFilePath: string = resolve('test-data/pdf.to.file/expected', pngPage.name);
-        const expectedFileContent: Buffer = readFileSync(expectedFilePath);
         const actualFileContent: Buffer = readFileSync(pngPage.path);
-        const compareResult: number = comparePng(actualFileContent, expectedFileContent);
+        const compareResult: number = comparePNG(actualFileContent, expectedFilePath);
 
         expect(compareResult).toBe(0);
     });

diff --git a/__tests__/pdf.to.buffer.ts b/__tests__/pdf.to.buffer.ts
@@ -1,7 +1,7 @@
-import { existsSync, readFileSync } from 'fs';
-import { resolve } from 'path';
-import comparePng from 'png-visual-compare';
-import { pdfToPng, PngPageOutput } from '../src';
+import { existsSync } from 'node:fs';
+import { resolve } from 'node:path';
+import { PngPageOutput, pdfToPng } from '../src';
+import { comparePNG } from '../src/compare.png';
 
 test(`should convert PDF To PNG buffer (without saving to file)`, async () => {
     const pdfFilePath: string = resolve('test-data/large_pdf.pdf');
@@ -11,8 +11,7 @@ test(`should convert PDF To PNG buffer (without saving to file)`, async () => {
 
     pngPages.forEach((pngPage: PngPageOutput) => {
         const expectedFilePath: string = resolve('test-data/pdf.to.buffer/expected', pngPage.name);
-        const expectedFileContent: Buffer = readFileSync(expectedFilePath);
-        const compareResult: number = comparePng(pngPage.content, expectedFileContent);
+        const compareResult: number = comparePNG(pngPage.content, expectedFilePath);
 
         expect(existsSync(pngPage.path)).toBe(false);
         expect(compareResult).toBe(0);

diff --git a/__tests__/pdf.to.file.ts b/__tests__/pdf.to.file.ts
@@ -1,7 +1,7 @@
-import { readFileSync } from 'fs';
-import { resolve } from 'path';
-import comparePng from 'png-visual-compare';
+import { readFileSync } from 'node:fs';
+import { resolve } from 'node:path';
 import { pdfToPng, PngPageOutput } from '../src';
+import { comparePNG } from '../src/compare.png';
 
 test(`should convert PDF To PNG files`, async () => {
     const pdfFilePath: string = resolve('test-data/large_pdf.pdf');
@@ -11,9 +11,8 @@ test(`should convert PDF To PNG files`, async () => {
 
     pngPages.forEach((pngPage: PngPageOutput) => {
         const expectedFilePath: string = resolve('test-data/pdf.to.file/expected', pngPage.name);
-        const expectedFileContent: Buffer = readFileSync(expectedFilePath);
         const actualFileContent: Buffer = readFileSync(pngPage.path);
-        const compareResult: number = comparePng(actualFileContent, expectedFileContent);
+        const compareResult: number = comparePNG(actualFileContent, expectedFilePath);
 
         expect(compareResult).toBe(0);
     });

diff --git a/__tests__/pdf.to.png.exceptions.ts b/__tests__/pdf.to.png.exceptions.ts
@@ -1,4 +1,4 @@
-import { resolve } from 'path';
+import { resolve } from 'node:path';
 import { pdfToPng } from '../src';
 
 test(`should throw "PDF file not found" exception`, async () => {

diff --git a/__tests__/props.to.pdf.doc.init.params.ts b/__tests__/props.to.pdf.doc.init.params.ts
@@ -8,9 +8,11 @@ const testDataArray: { id: string; props?: PdfToPngOptions; expectedPdfDocInitPa
         expectedPdfDocInitParams: {
             cMapUrl: '../node_modules/pdfjs-dist/cmaps/',
             cMapPacked: true,
+            standardFontDataUrl: '../node_modules/pdfjs-dist/standard_fonts/',
             verbosity: 0,
             disableFontFace: true,
             useSystemFonts: false,
+            enableXfa: false,
             password: undefined,
         },
     },
@@ -20,9 +22,11 @@ const testDataArray: { id: string; props?: PdfToPngOptions; expectedPdfDocInitPa
         expectedPdfDocInitParams: {
             cMapUrl: '../node_modules/pdfjs-dist/cmaps/',
             cMapPacked: true,
+            standardFontDataUrl: '../node_modules/pdfjs-dist/standard_fonts/',
             verbosity: 0,
             disableFontFace: true,
             useSystemFonts: false,
+            enableXfa: false,
             password: undefined,
         },
     },
@@ -34,9 +38,11 @@ const testDataArray: { id: string; props?: PdfToPngOptions; expectedPdfDocInitPa
         expectedPdfDocInitParams: {
             cMapUrl: '../node_modules/pdfjs-dist/cmaps/',
             cMapPacked: true,
+            standardFontDataUrl: '../node_modules/pdfjs-dist/standard_fonts/',
             verbosity: 0,
             disableFontFace: true,
             useSystemFonts: false,
+            enableXfa: false,
             password: undefined,
         },
     },
@@ -48,9 +54,11 @@ const testDataArray: { id: string; props?: PdfToPngOptions; expectedPdfDocInitPa
         expectedPdfDocInitParams: {
             cMapUrl: '../node_modules/pdfjs-dist/cmaps/',
             cMapPacked: true,
+            standardFontDataUrl: '../node_modules/pdfjs-dist/standard_fonts/',
             verbosity: 0,
             disableFontFace: false,
             useSystemFonts: false,
+            enableXfa: false,
             password: undefined,
         },
     },
@@ -62,9 +70,11 @@ const testDataArray: { id: string; props?: PdfToPngOptions; expectedPdfDocInitPa
         expectedPdfDocInitParams: {
             cMapUrl: '../node_modules/pdfjs-dist/cmaps/',
             cMapPacked: true,
+            standardFontDataUrl: '../node_modules/pdfjs-dist/standard_fonts/',
             verbosity: 0,
             disableFontFace: true,
             useSystemFonts: true,
+            enableXfa: false,
             password: undefined,
         },
     },
@@ -76,9 +86,11 @@ const testDataArray: { id: string; props?: PdfToPngOptions; expectedPdfDocInitPa
         expectedPdfDocInitParams: {
             cMapUrl: '../node_modules/pdfjs-dist/cmaps/',
             cMapPacked: true,
+            standardFontDataUrl: '../node_modules/pdfjs-dist/standard_fonts/',
             verbosity: 0,
             disableFontFace: true,
             useSystemFonts: false,
+            enableXfa: false,
             password: '12345',
         },
     },
@@ -90,9 +102,27 @@ const testDataArray: { id: string; props?: PdfToPngOptions; expectedPdfDocInitPa
         expectedPdfDocInitParams: {
             cMapUrl: '../node_modules/pdfjs-dist/cmaps/',
             cMapPacked: true,
+            standardFontDataUrl: '../node_modules/pdfjs-dist/standard_fonts/',
             verbosity: 1,
             disableFontFace: true,
             useSystemFonts: false,
+            enableXfa: false,
+            password: undefined,
+        },
+    },
+    {
+        id: 'only enableXfa is specified',
+        props: {
+            enableXfa: true,
+        },
+        expectedPdfDocInitParams: {
+            cMapUrl: '../node_modules/pdfjs-dist/cmaps/',
+            cMapPacked: true,
+            standardFontDataUrl: '../node_modules/pdfjs-dist/standard_fonts/',
+            verbosity: 0,
+            disableFontFace: true,
+            useSystemFonts: false,
+            enableXfa: true,
             password: undefined,
         },
     },
@@ -102,6 +132,7 @@ const testDataArray: { id: string; props?: PdfToPngOptions; expectedPdfDocInitPa
             viewportScale: 3.0,
             disableFontFace: false,
             useSystemFonts: true,
+            enableXfa: true,
             pdfFilePassword: 'pdfFilePassword',
             outputFolder: 'outputFolder',
             outputFileMask: 'outputFileMask',
@@ -112,17 +143,19 @@ const testDataArray: { id: string; props?: PdfToPngOptions; expectedPdfDocInitPa
         expectedPdfDocInitParams: {
             cMapUrl: '../node_modules/pdfjs-dist/cmaps/',
             cMapPacked: true,
+            standardFontDataUrl: '../node_modules/pdfjs-dist/standard_fonts/',
             verbosity: 2,
             disableFontFace: false,
             useSystemFonts: true,
+            enableXfa: true,
             password: 'pdfFilePassword',
         },
     },
 ];
 
 for (const testData of testDataArray) {
     test(`should convert props to PdfDocInitParams when ${testData.id}`, async () => {
-        const actualPdfDocInitParams = propsToPdfDocInitParams(testData.props);
+        const actualPdfDocInitParams: DocumentInitParameters = propsToPdfDocInitParams(testData.props);
 
         expect(actualPdfDocInitParams).toStrictEqual(testData.expectedPdfDocInitParams);
     });

diff --git a/__tests__/protected.pdf.ts b/__tests__/protected.pdf.ts
@@ -1,7 +1,6 @@
-import { readFileSync } from 'fs';
-import { resolve } from 'path';
-import comparePng from 'png-visual-compare';
+import { resolve } from 'node:path';
 import { pdfToPng, PngPageOutput } from '../src';
+import { comparePNG } from '../src/compare.png';
 
 test(`should convert protected PDF To PNG`, async () => {
     const pdfFilePath: string = resolve('test-data/large_pdf-protected.pdf');
@@ -12,8 +11,7 @@ test(`should convert protected PDF To PNG`, async () => {
 
     pngPages.forEach((pngPage: PngPageOutput) => {
         const expectedFilePath: string = resolve('test-data/protected.pdf/expected', pngPage.name);
-        const expectedFileContent: Buffer = readFileSync(expectedFilePath);
-        const compareResult: number = comparePng(pngPage.content, expectedFileContent);
+        const compareResult: number = comparePNG(pngPage.content, expectedFilePath);
 
         expect(compareResult).toBe(0);
     });