pdf-oxide 0.3.42 → 0.3.43

package/lib/index.d.ts

@@ -79,8 +79,28 @@ declare class PdfDocumentImpl {
      * export — exposed in TS for the first time as part of gap L.
      */
     estimateRenderTime(pageIndex: number, dpi?: number): number;
+    /**
+     * Render a page to fit inside a `width × height` pixel box, preserving
+     * aspect ratio. Picks the largest DPI such that both rendered
+     * dimensions are ≤ the target box, so the output may be smaller than
+     * `width × height` on one axis. Issue #448.
+     *
+     * @param pageIndex   zero-based page index
+     * @param width       target box width (pixels, must be > 0)
+     * @param height      target box height (pixels, must be > 0)
+     * @param format      `'png'` (default) or `'jpeg'`
+     */
+    renderPageFit(pageIndex: number, width: number, height: number, format?: 'png' | 'jpeg'): Uint8Array;
     page(index: number): Page;
     [Symbol.iterator](): Iterator<Page>;
+    /**
+     * Async iteration over the document's pages — issue #447. The body
+     * is identical to the sync iterator (page handles are constructed
+     * synchronously) but exposing this surface lets consumers `for await`
+     * uniformly with other async resources without an explicit
+     * `Promise.resolve(...)`.
+     */
+    [Symbol.asyncIterator](): AsyncIterator<Page>;
     /**
      * Validate PDF/A conformance at a given level.
      * @param level - "1a"|"1b"|"2a"|"2b"|"2u"|"3a"|"3b"|"3u" (default "2b")

package/lib/index.js

@@ -313,6 +313,34 @@ class PdfDocumentImpl {
         this.ensureOpen();
         return native.estimateRenderTime(this._handle, pageIndex, dpi);
     }
+    /**
+     * Render a page to fit inside a `width × height` pixel box, preserving
+     * aspect ratio. Picks the largest DPI such that both rendered
+     * dimensions are ≤ the target box, so the output may be smaller than
+     * `width × height` on one axis. Issue #448.
+     *
+     * @param pageIndex   zero-based page index
+     * @param width       target box width (pixels, must be > 0)
+     * @param height      target box height (pixels, must be > 0)
+     * @param format      `'png'` (default) or `'jpeg'`
+     */
+    renderPageFit(pageIndex, width, height, format = 'png') {
+        this.ensureOpen();
+        if (width <= 0 || height <= 0) {
+            throw new RangeError(`width and height must be > 0, got ${width}×${height}`);
+        }
+        const fmt = format === 'jpeg' ? 1 : 0;
+        const imgHandle = native.renderPageFit(this._handle, pageIndex, width, height, fmt);
+        try {
+            const buf = native.pdfGetRenderedImageData(imgHandle);
+            return new Uint8Array(buf);
+        }
+        finally {
+            if (native.freeRenderedImage) {
+                native.freeRenderedImage(imgHandle);
+            }
+        }
+    }
     page(index) {
         this.ensureOpen();
         const count = this.pageCount();
@@ -334,6 +362,26 @@ class PdfDocumentImpl {
             },
         };
     }
+    /**
+     * Async iteration over the document's pages — issue #447. The body
+     * is identical to the sync iterator (page handles are constructed
+     * synchronously) but exposing this surface lets consumers `for await`
+     * uniformly with other async resources without an explicit
+     * `Promise.resolve(...)`.
+     */
+    [Symbol.asyncIterator]() {
+        this.ensureOpen();
+        const count = this.pageCount();
+        let i = 0;
+        const doc = this;
+        return {
+            async next() {
+                if (i >= count)
+                    return { value: undefined, done: true };
+                return { value: new Page(doc, i++), done: false };
+            },
+        };
+    }
     /**
      * Validate PDF/A conformance at a given level.
      * @param level - "1a"|"1b"|"2a"|"2b"|"2u"|"3a"|"3b"|"3u" (default "2b")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pdf-oxide",
-  "version": "0.3.42",
+  "version": "0.3.43",
   "type": "module",
   "description": "High-performance PDF parsing and text extraction library — prebuilt native bindings, no build toolchain required",
   "main": "lib/index.js",
@@ -69,7 +69,7 @@
   "devDependencies": {
     "@types/node": "^18.0.0",
     "node-addon-api": "^8.7.0",
-    "rimraf": "^5.0.0",
+    "rimraf": "^6.1.3",
     "typescript": "^5.3.0"
   },
   "gypfile": false