[minor] support passing arbitrary pdfjs-dist options

related to #12

Author: electrovir

src/read-pdf.test.ts

@@ -1,9 +1,11 @@
+import {assertTypeOf} from 'run-time-assertions';
 import {assert} from 'chai';
 import {existsSync} from 'fs';
 import {join} from 'path';
-import {ReadonlyDeep} from 'type-fest';
-import {PdfProgressData, readPdfPages, readPdfText} from './read-pdf';
+import type {ReadonlyDeep} from 'type-fest';
+import {PdfProgressData, ReadPdfTextParams, readPdfPages, readPdfText} from './read-pdf';
 import {nodeModulesDir, sampleFilesDir} from './repo-paths.test-helper';
+import type {TypedArray} from 'pdfjs-dist/types/src/display/api';
 
 type PdfTestFile = {
     filePath: string;
@@ -112,6 +114,9 @@ describe(readPdfPages.name, () => {
             progressCallback(progressData) {
                 allProgressData.push(progressData);
             },
+            options: {
+                isEvalSupported: false,
+            },
         });
 
         assert.isAbove(allProgressData.length, 0, 'got no progress data');
@@ -142,3 +147,13 @@ describe(readPdfText.name, () => {
         });
     });
 });
+
+describe('ReadPdfTextParams', () => {
+    it('matches expected types', () => {
+        assertTypeOf<Required<ReadPdfTextParams>['data']>().toEqualTypeOf<
+            string | number[] | ArrayBuffer | TypedArray
+        >();
+        assertTypeOf<Required<ReadPdfTextParams>['url']>().toEqualTypeOf<string | URL>();
+        assertTypeOf<Required<ReadPdfTextParams>['filePath']>().toEqualTypeOf<string | URL>();
+    });
+});

src/read-pdf.ts

@@ -48,16 +48,19 @@ export type ReadPdfTextParams = PartialWithUndefined<{
      * Example: /home/ubuntu/this-repo/node_modules/pdfjs-dist
      */
     pathToPdfJsDistNodeModule: string;
+    /**
+     * All options that the Mozilla's `pdfjs-dist` package supports. This will override any options
+     * that this package passes to `pdfjs-dist`.
+     */
+    options: Partial<Omit<DocumentInitParameters, 'data' | 'url'>>;
 }> &
     RequireExactlyOne<{
         /** File path to the PDF file to read. */
-        filePath: string;
+        filePath: NonNullable<DocumentInitParameters['url']>;
         /** URL to the PDF. */
-        url: string;
+        url: NonNullable<DocumentInitParameters['url']>;
         /** PDF file data that has already been read from a PDF file. */
-        data: BinaryData;
-        /** All other options that the Mozilla `pdfjs-dist` package supports. */
-        allOptions: DocumentInitParameters;
+        data: NonNullable<DocumentInitParameters['data']>;
     }>;
 
 /**
@@ -73,6 +76,7 @@ export async function readPdfPages({
     pathToPdfJsDistNodeModule,
     progressCallback,
     url,
+    options,
 }: ReadPdfTextParams): Promise<PdfPage[]> {
     const documentLoadingTask = getDocument({
         data,
@@ -82,6 +86,7 @@ export async function readPdfPages({
         standardFontDataUrl: pathToPdfJsDistNodeModule
             ? join(pathToPdfJsDistNodeModule, 'standard_fonts')
             : undefined,
+        ...options,
     });
     if (progressCallback) {
         documentLoadingTask.onProgress = progressCallback;