@embedpdf/engines 1.0.17 → 1.0.19

package/dist/lib/pdfium/engine.d.ts

@@ -1,4 +1,4 @@
-import { PdfAnnotationObject, PdfTextRectObject, PdfWidgetAnnoObject, Logger, SearchTarget, MatchFlag, PdfBookmarkObject, PdfDocumentObject, PdfEngine, PdfPageObject, Rotation, Rect, PdfAttachmentObject, PdfSignatureObject, PdfRenderOptions, Position, PdfStampAnnoObject, PdfCircleAnnoObject, PdfSquareAnnoObject, PdfSquigglyAnnoObject, PdfStrikeOutAnnoObject, PdfUnderlineAnnoObject, PdfFile, AppearanceMode, PdfHighlightAnnoObject, FormFieldValue, PdfPageFlattenFlag, PdfPageFlattenResult, PdfTask, PdfFileLoader, SearchAllPagesResult, PdfUrlOptions, PdfFileUrl, Task, PdfErrorReason, PdfGlyphObject, PdfPageGeometry, PdfImage, ImageConversionTypes, PageTextSlice, AnnotationCreateContext, PdfPageSearchProgress } from '@embedpdf/models';
+import { PdfAnnotationObject, PdfTextRectObject, PdfWidgetAnnoObject, Logger, SearchTarget, PdfBookmarkObject, PdfDocumentObject, PdfEngine, PdfPageObject, Rect, PdfAttachmentObject, PdfSignatureObject, Position, PdfStampAnnoObject, PdfCircleAnnoObject, PdfSquareAnnoObject, PdfSquigglyAnnoObject, PdfStrikeOutAnnoObject, PdfUnderlineAnnoObject, PdfFile, PdfHighlightAnnoObject, FormFieldValue, PdfPageFlattenResult, PdfTask, PdfFileLoader, SearchAllPagesResult, PdfOpenDocumentUrlOptions, PdfOpenDocumentBufferOptions, PdfFileUrl, Task, PdfErrorReason, PdfGlyphObject, PdfPageGeometry, PdfImage, ImageConversionTypes, PageTextSlice, AnnotationCreateContext, PdfPageSearchProgress, PdfSearchAllPagesOptions, PdfRenderPageAnnotationOptions, PdfRedactTextOptions, PdfFlattenPageOptions, PdfRenderThumbnailOptions, PdfRenderPageOptions, PdfAnnotationsProgress } from '@embedpdf/models';
 import { WrappedPdfiumModule } from '@embedpdf/pdfium';
 /**
  * Format of bitmap
@@ -62,24 +62,34 @@ export declare enum PdfiumErrorCode {
  */
 export type ImageDataConverter<T = Blob> = (imageData: PdfImage, imageType?: ImageConversionTypes) => Promise<T>;
 export declare const browserImageDataToBlobConverter: ImageDataConverter<Blob>;
+interface PdfiumEngineOptions<T> {
+    logger?: Logger;
+    imageDataConverter?: ImageDataConverter<T>;
+}
 /**
  * Pdf engine that based on pdfium wasm
  */
 export declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
     private pdfiumModule;
-    private logger;
-    private imageDataConverter;
     /**
      * pdf documents that opened
      */
     private readonly cache;
+    /**
+     * logger instance
+     */
+    private readonly logger;
+    /**
+     * function to convert ImageData to Blob
+     */
+    private readonly imageDataConverter;
     /**
      * Create an instance of PdfiumEngine
      * @param wasmModule - pdfium wasm module
      * @param logger - logger instance
      * @param imageDataToBlobConverter - function to convert ImageData to Blob
      */
-    constructor(pdfiumModule: WrappedPdfiumModule, logger?: Logger, imageDataConverter?: ImageDataConverter<T>);
+    constructor(pdfiumModule: WrappedPdfiumModule, options?: PdfiumEngineOptions<T>);
     /**
      * {@inheritDoc @embedpdf/models!PdfEngine.initialize}
      *
@@ -97,7 +107,7 @@ export declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      *
      * @public
      */
-    openDocumentUrl(file: PdfFileUrl, options?: PdfUrlOptions): Task<PdfDocumentObject, PdfErrorReason, unknown>;
+    openDocumentUrl(file: PdfFileUrl, options?: PdfOpenDocumentUrlOptions): Task<PdfDocumentObject, PdfErrorReason, unknown>;
     /**
      * Check if the server supports range requests:
      * Sends a HEAD request and sees if 'Accept-Ranges: bytes'.
@@ -129,12 +139,7 @@ export declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      *
      * @public
      */
-    openDocumentFromBuffer(file: PdfFile, password?: string): Task<PdfDocumentObject, PdfErrorReason, unknown>;
-    /**
-     * {@inheritDoc @embedpdf/models!PdfEngine.openDocumentFromLoader}
-     *
-     * @public
-     */
+    openDocumentBuffer(file: PdfFile, options?: PdfOpenDocumentBufferOptions): Task<PdfDocumentObject, PdfErrorReason, unknown>;
     openDocumentFromLoader(fileLoader: PdfFileLoader, password?: string): Task<PdfDocumentObject, PdfErrorReason, unknown>;
     /**
      * {@inheritDoc @embedpdf/models!PdfEngine.getMetadata}
@@ -182,23 +187,19 @@ export declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      *
      * @public
      */
-    renderPage(doc: PdfDocumentObject, page: PdfPageObject, scaleFactor?: number, rotation?: Rotation, dpr?: number, options?: PdfRenderOptions, imageType?: ImageConversionTypes): PdfTask<T>;
+    renderPage(doc: PdfDocumentObject, page: PdfPageObject, options?: PdfRenderPageOptions): PdfTask<T>;
     /**
      * {@inheritDoc @embedpdf/models!PdfEngine.renderPageRect}
      *
      * @public
      */
-    renderPageRect(doc: PdfDocumentObject, page: PdfPageObject, scaleFactor: number, rotation: Rotation, dpr: number, rect: Rect, options: PdfRenderOptions, imageType?: ImageConversionTypes): PdfTask<T>;
+    renderPageRect(doc: PdfDocumentObject, page: PdfPageObject, rect: Rect, options?: PdfRenderPageOptions): PdfTask<T>;
     /**
      * {@inheritDoc @embedpdf/models!PdfEngine.getAllAnnotations}
      *
      * @public
      */
-    getAllAnnotations(doc: PdfDocumentObject): PdfTask<Record<number, PdfAnnotationObject[]>, // final result
-    {
-        page: number;
-        annotations: PdfAnnotationObject[];
-    }>;
+    getAllAnnotations(doc: PdfDocumentObject): PdfTask<Record<number, PdfAnnotationObject[]>, PdfAnnotationsProgress>;
     private readAllAnnotations;
     /**
      * {@inheritDoc @embedpdf/models!PdfEngine.getPageAnnotations}
@@ -211,7 +212,7 @@ export declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      *
      * @public
      */
-    createPageAnnotation<A extends PdfAnnotationObject>(doc: PdfDocumentObject, page: PdfPageObject, annotation: A, context?: AnnotationCreateContext<A>): PdfTask<number>;
+    createPageAnnotation<A extends PdfAnnotationObject>(doc: PdfDocumentObject, page: PdfPageObject, annotation: A, context?: AnnotationCreateContext<A>): PdfTask<string>;
     /**
      * Update an existing page annotation in-place
      *
@@ -233,13 +234,13 @@ export declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      *
      * @public
      */
-    getPageTextRects(doc: PdfDocumentObject, page: PdfPageObject, scaleFactor: number, rotation: Rotation): Task<any, PdfErrorReason, unknown> | Task<PdfTextRectObject[], PdfErrorReason, unknown>;
+    getPageTextRects(doc: PdfDocumentObject, page: PdfPageObject): Task<any, PdfErrorReason, unknown> | Task<PdfTextRectObject[], PdfErrorReason, unknown>;
     /**
      * {@inheritDoc @embedpdf/models!PdfEngine.renderThumbnail}
      *
      * @public
      */
-    renderThumbnail(doc: PdfDocumentObject, page: PdfPageObject, scaleFactor: number, rotation: Rotation, dpr: number): PdfTask<T>;
+    renderThumbnail(doc: PdfDocumentObject, page: PdfPageObject, options?: PdfRenderThumbnailOptions): PdfTask<T>;
     /**
      * {@inheritDoc @embedpdf/models!PdfEngine.getAttachments}
      *
@@ -263,7 +264,7 @@ export declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      *
      * @public
      */
-    flattenPage(doc: PdfDocumentObject, page: PdfPageObject, flag: PdfPageFlattenFlag): PdfTask<PdfPageFlattenResult>;
+    flattenPage(doc: PdfDocumentObject, page: PdfPageObject, options?: PdfFlattenPageOptions): PdfTask<PdfPageFlattenResult>;
     /**
      * {@inheritDoc @embedpdf/models!PdfEngine.extractPages}
      *
@@ -518,28 +519,31 @@ export declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
     private readCharBox;
     /**
      * Read page annotations
+     *
+     * @param ctx - document context
      * @param page - page info
-     * @param docPtr - pointer to pdf document
-     * @param pagePtr - pointer to pdf page
-     * @param textPagePtr - pointe to pdf text page
-     * @param scaleFactor - scale factor
-     * @param rotation - rotation angle
      * @returns annotations on the pdf page
      *
      * @private
      */
     private readPageAnnotations;
+    /**
+     * Read page annotations
+     *
+     * @param ctx - document context
+     * @param page - page info
+     * @returns annotations on the pdf page
+     *
+     * @private
+     */
     private readPageAnnotationsRaw;
     /**
      * Read pdf annotation from pdf document
-     * @param page  - pdf page infor
-     * @param docPtr - pointer to pdf document object
-     * @param pagePtr - pointer to pdf page object
-     * @param  textPagePtr - pointer to pdf text page object
-     * @param formHandle - form handle
-     * @param index - index of annotation in the pdf page
-     * @param scaleFactor  - factor of scalling
-     * @param rotation  - rotation angle
+     *
+     * @param docPtr - pointer to pdf document
+     * @param page - page info
+     * @param annotationPtr - pointer to pdf annotation
+     * @param pageCtx - page context
      * @returns pdf annotation
      *
      * @private
@@ -807,6 +811,13 @@ export declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      * @private
      */
     private syncQuadPointsAnno;
+    /**
+     * Redact text that intersects ANY of the provided **quads** (device-space).
+     * Returns `true` if the page changed. Always regenerates the page stream.
+     */
+    redactTextInRects(doc: PdfDocumentObject, page: PdfPageObject, rects: Rect[], options?: PdfRedactTextOptions): Task<boolean, PdfErrorReason>;
+    /** Pack device-space Rects into an FS_QUADPOINTSF[] buffer (page space). */
+    private allocFSQuadsBufferFromRects;
     /**
      * Read ink list from annotation
      * @param page  - logical page info object (`PdfPageObject`)
@@ -1216,8 +1227,7 @@ export declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      *
      * @public
      */
-    renderAnnotation(doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject, scaleFactor: number, rotation: Rotation, dpr?: number, // device-pixel-ratio (canvas)
-    mode?: AppearanceMode, imageType?: ImageConversionTypes): PdfTask<T>;
+    renderPageAnnotation(doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject, options?: PdfRenderPageAnnotationOptions): PdfTask<T>;
     /**
      * render rectangle of pdf page to image
      * @param docPtr - pointer to pdf document object
@@ -1353,7 +1363,7 @@ export declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      *
      * @public
      */
-    searchAllPages(doc: PdfDocumentObject, keyword: string, flags?: MatchFlag[]): PdfTask<SearchAllPagesResult, PdfPageSearchProgress>;
+    searchAllPages(doc: PdfDocumentObject, keyword: string, options?: PdfSearchAllPagesOptions): PdfTask<SearchAllPagesResult, PdfPageSearchProgress>;
     /**
      * Extract word-aligned context for a search hit.
      *
@@ -1386,3 +1396,4 @@ export declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      */
     private searchAllInPage;
 }
+export {};

package/dist/lib/pdfium/index.cjs

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=require("../../engine-Bcr-xNy6.cjs"),e=require("../../runner-C64KrEhP.cjs");exports.BitmapFormat=r.BitmapFormat,exports.PdfiumEngine=r.PdfiumEngine,exports.PdfiumErrorCode=r.PdfiumErrorCode,exports.RenderFlag=r.RenderFlag,exports.browserImageDataToBlobConverter=r.browserImageDataToBlobConverter,exports.readArrayBuffer=r.readArrayBuffer,exports.readString=r.readString,exports.PdfiumEngineRunner=e.PdfiumEngineRunner;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=require("../../engine-CkrTs7st.cjs"),e=require("../../runner-BPhmukiN.cjs");exports.BitmapFormat=r.BitmapFormat,exports.PdfiumEngine=r.PdfiumEngine,exports.PdfiumErrorCode=r.PdfiumErrorCode,exports.RenderFlag=r.RenderFlag,exports.browserImageDataToBlobConverter=r.browserImageDataToBlobConverter,exports.readArrayBuffer=r.readArrayBuffer,exports.readString=r.readString,exports.PdfiumEngineRunner=e.PdfiumEngineRunner;
 //# sourceMappingURL=index.cjs.map

package/dist/lib/pdfium/index.js

@@ -1,5 +1,5 @@
-import { B, a, P, R, b, c, r } from "../../engine-uSZXjmb5.js";
-import { P as P2 } from "../../runner-BOJ4naYI.js";
+import { B, a, P, R, b, c, r } from "../../engine-DMU8HkGx.js";
+import { P as P2 } from "../../runner-TzQFlVIQ.js";
 export {
   B as BitmapFormat,
   a as PdfiumEngine,

package/dist/lib/pdfium/runner.d.ts

@@ -1,4 +1,5 @@
 import { EngineRunner } from '../webworker/runner';
+import { Logger } from '@embedpdf/models';
 /**
  * EngineRunner for pdfium-based wasm engine
  */
@@ -8,7 +9,7 @@ export declare class PdfiumEngineRunner extends EngineRunner {
      * Create an instance of PdfiumEngineRunner
      * @param wasmBinary - wasm binary that contains the pdfium wasm file
      */
-    constructor(wasmBinary: ArrayBuffer);
+    constructor(wasmBinary: ArrayBuffer, logger?: Logger);
     /**
      * Initialize runner
      */

package/dist/lib/pdfium/web/direct-engine.cjs

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("@embedpdf/pdfium"),i=require("../../../engine-Bcr-xNy6.cjs");exports.createPdfiumEngine=async function(t,n){const r=await fetch(t),a=await r.arrayBuffer(),u=await e.init({wasmBinary:a});return new i.PdfiumEngine(u,n)};
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("@embedpdf/pdfium"),i=require("../../../engine-CkrTs7st.cjs");exports.createPdfiumEngine=async function(r,t){const n=await fetch(r),a=await n.arrayBuffer(),u=await e.init({wasmBinary:a});return new i.PdfiumEngine(u,{logger:t})};
 //# sourceMappingURL=direct-engine.cjs.map

package/dist/lib/pdfium/web/direct-engine.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"direct-engine.cjs","sources":["../../../../src/lib/pdfium/web/direct-engine.ts"],"sourcesContent":["import { Logger } from '@embedpdf/models';\nimport { init } from '@embedpdf/pdfium';\n\nimport { PdfiumEngine } from '../engine';\n\nexport async function createPdfiumEngine(wasmUrl: string, logger?: Logger): Promise<PdfiumEngine> {\n  const response = await fetch(wasmUrl);\n  const wasmBinary = await response.arrayBuffer();\n  const wasmModule = await init({ wasmBinary });\n  return new PdfiumEngine(wasmModule, logger);\n}\n"],"names":["async","wasmUrl","logger","response","fetch","wasmBinary","arrayBuffer","wasmModule","init","PdfiumEngine"],"mappings":"yLAKsBA,eAAmBC,EAAiBC,GAClD,MAAAC,QAAiBC,MAAMH,GACvBI,QAAmBF,EAASG,cAC5BC,QAAmBC,OAAK,CAAEH,eACzB,OAAA,IAAII,EAAAA,aAAaF,EAAYL,EACtC"}
+{"version":3,"file":"direct-engine.cjs","sources":["../../../../src/lib/pdfium/web/direct-engine.ts"],"sourcesContent":["import { Logger } from '@embedpdf/models';\nimport { init } from '@embedpdf/pdfium';\n\nimport { PdfiumEngine } from '../engine';\n\nexport async function createPdfiumEngine(wasmUrl: string, logger?: Logger): Promise<PdfiumEngine> {\n  const response = await fetch(wasmUrl);\n  const wasmBinary = await response.arrayBuffer();\n  const wasmModule = await init({ wasmBinary });\n  return new PdfiumEngine(wasmModule, { logger });\n}\n"],"names":["async","wasmUrl","logger","response","fetch","wasmBinary","arrayBuffer","wasmModule","init","PdfiumEngine"],"mappings":"yLAKsBA,eAAmBC,EAAiBC,GAClD,MAAAC,QAAiBC,MAAMH,GACvBI,QAAmBF,EAASG,cAC5BC,QAAmBC,OAAK,CAAEH,eAChC,OAAO,IAAII,EAAAA,aAAaF,EAAY,CAAEL,UACxC"}

package/dist/lib/pdfium/web/direct-engine.js

@@ -1,10 +1,10 @@
 import { init } from "@embedpdf/pdfium";
-import { a as PdfiumEngine } from "../../../engine-uSZXjmb5.js";
+import { a as PdfiumEngine } from "../../../engine-DMU8HkGx.js";
 async function createPdfiumEngine(wasmUrl, logger) {
   const response = await fetch(wasmUrl);
   const wasmBinary = await response.arrayBuffer();
   const wasmModule = await init({ wasmBinary });
-  return new PdfiumEngine(wasmModule, logger);
+  return new PdfiumEngine(wasmModule, { logger });
 }
 export {
   createPdfiumEngine

package/dist/lib/pdfium/web/direct-engine.js.map

@@ -1 +1 @@
-{"version":3,"file":"direct-engine.js","sources":["../../../../src/lib/pdfium/web/direct-engine.ts"],"sourcesContent":["import { Logger } from '@embedpdf/models';\nimport { init } from '@embedpdf/pdfium';\n\nimport { PdfiumEngine } from '../engine';\n\nexport async function createPdfiumEngine(wasmUrl: string, logger?: Logger): Promise<PdfiumEngine> {\n  const response = await fetch(wasmUrl);\n  const wasmBinary = await response.arrayBuffer();\n  const wasmModule = await init({ wasmBinary });\n  return new PdfiumEngine(wasmModule, logger);\n}\n"],"names":[],"mappings":";;AAKsB,eAAA,mBAAmB,SAAiB,QAAwC;AAC1F,QAAA,WAAW,MAAM,MAAM,OAAO;AAC9B,QAAA,aAAa,MAAM,SAAS,YAAY;AAC9C,QAAM,aAAa,MAAM,KAAK,EAAE,YAAY;AACrC,SAAA,IAAI,aAAa,YAAY,MAAM;AAC5C;"}
+{"version":3,"file":"direct-engine.js","sources":["../../../../src/lib/pdfium/web/direct-engine.ts"],"sourcesContent":["import { Logger } from '@embedpdf/models';\nimport { init } from '@embedpdf/pdfium';\n\nimport { PdfiumEngine } from '../engine';\n\nexport async function createPdfiumEngine(wasmUrl: string, logger?: Logger): Promise<PdfiumEngine> {\n  const response = await fetch(wasmUrl);\n  const wasmBinary = await response.arrayBuffer();\n  const wasmModule = await init({ wasmBinary });\n  return new PdfiumEngine(wasmModule, { logger });\n}\n"],"names":[],"mappings":";;AAKsB,eAAA,mBAAmB,SAAiB,QAAwC;AAC1F,QAAA,WAAW,MAAM,MAAM,OAAO;AAC9B,QAAA,aAAa,MAAM,SAAS,YAAY;AAC9C,QAAM,aAAa,MAAM,KAAK,EAAE,YAAY;AAC5C,SAAO,IAAI,aAAa,YAAY,EAAE,QAAQ;AAChD;"}