@embedpdf/engines 1.0.6 → 1.0.7

package/dist/pdfium.d.ts

@@ -1,4 +1,4 @@
-import { SearchTarget, PdfImage, ImageConversionTypes, PdfEngine, Logger, Task, PdfErrorReason, PdfFileUrl, PdfUrlOptions, PdfDocumentObject, PdfFile, PdfFileLoader, PdfSignatureObject, PdfBookmarkObject, PdfPageObject, Rotation, PdfRenderOptions, PdfTask, Rect, PdfAnnotationObject, PdfAnnotationTransformation, PdfTextRectObject, PdfAttachmentObject, PdfWidgetAnnoObject, FormFieldValue, PdfPageFlattenFlag, PdfPageFlattenResult, PageTextSlice, PdfInkListObject, PdfStampAnnoObjectContents, Position, PdfPageGeometry, PdfGlyphObject, MatchFlag, SearchAllPagesResult, PdfEngineMethodName, PdfEngineMethodArgs, TaskReturn, PdfEngineMethodReturnType } from '@embedpdf/models';
+import { SearchTarget, PdfImage, ImageConversionTypes, PdfEngine, Logger, Task, PdfErrorReason, PdfFileUrl, PdfUrlOptions, PdfDocumentObject, PdfFile, PdfFileLoader, PdfSignatureObject, PdfBookmarkObject, PdfPageObject, Rotation, PdfRenderOptions, PdfTask, Rect, PdfAnnotationObject, PdfAnnotationTransformation, PdfTextRectObject, PdfAttachmentObject, PdfWidgetAnnoObject, FormFieldValue, PdfPageFlattenFlag, PdfPageFlattenResult, PageTextSlice, PdfInkListObject, PdfHighlightAnnoObject, PdfUnderlineAnnoObject, PdfStrikeOutAnnoObject, PdfSquigglyAnnoObject, PdfStampAnnoObjectContents, Position, PdfPageGeometry, PdfGlyphObject, PdfAnnotationObjectBase, WebAlphaColor, MatchFlag, SearchAllPagesResult, PdfEngineMethodName, PdfEngineMethodArgs, TaskReturn, PdfEngineMethodReturnType } from '@embedpdf/models';
 import { WrappedPdfiumModule, PdfiumRuntimeMethods, PdfiumModule } from '@embedpdf/pdfium';
 
 /**
@@ -208,7 +208,17 @@ declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      *
      * @public
      */
-    createPageAnnotation(doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject): Task<boolean, PdfErrorReason> | Task<any, PdfErrorReason>;
+    createPageAnnotation(doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject): PdfTask<number>;
+    /**
+     * Update an existing page annotation in-place
+     *
+     *  • Locates the annot by page-local index (`annotation.id`)
+     *  • Re-writes its /Rect and type-specific payload
+     *  • Calls FPDFPage_GenerateContent so the new appearance is rendered
+     *
+     * @returns PdfTask<boolean>  –  true on success
+     */
+    updatePageAnnotation(doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject): PdfTask<boolean>;
     /**
      * {@inheritDoc @embedpdf/models!PdfEngine.transformPageAnnotation}
      *
@@ -330,6 +340,16 @@ declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      * @private
      */
     addInkStroke(page: PdfPageObject, pagePtr: number, annotationPtr: number, inkList: PdfInkListObject[]): boolean;
+    /**
+     * Add highlight content to annotation
+     * @param page - page info
+     * @param annotationPtr - pointer to highlight annotation
+     * @param annotation - highlight annotation
+     * @returns whether highlight content is added to annotation
+     *
+     * @private
+     */
+    addTextMarkupContent(page: PdfPageObject, annotationPtr: number, annotation: PdfHighlightAnnoObject | PdfUnderlineAnnoObject | PdfStrikeOutAnnoObject | PdfSquigglyAnnoObject, shouldClearAP?: boolean): boolean;
     /**
      * Add contents to stamp annotation
      * @param docPtr - pointer to pdf document object
@@ -537,11 +557,23 @@ declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      *
      * @param annotationPtr - pointer to an `FPDF_ANNOTATION`
      * @param fallback      - colour to use when the PDF stores no tint at all
-     * @returns Guaranteed RGBA tuple (never `undefined`)
+     * @returns WebAlphaColor with hex color and opacity (0-1)
      *
      * @private
      */
     private resolveAnnotationColor;
+    /**
+     * Set the fill/stroke colour for a **Highlight / Underline / StrikeOut / Squiggly** markup annotation.
+     *
+     * @param annotationPtr - pointer to the annotation whose colour is being set
+     * @param webAlphaColor - WebAlphaColor with hex color and opacity (0-1)
+     * @param shouldClearAP - whether to clear the /AP entry
+     * @param which - which colour to set (0 = fill, 1 = stroke)
+     * @returns `true` if the operation was successful
+     *
+     * @private
+     */
+    private setAnnotationColor;
     /**
      * Read `/QuadPoints` from any annotation and convert each quadrilateral to
      * device-space coordinates.
@@ -553,11 +585,22 @@ declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      *
      * @param page          - logical page info object (`PdfPageObject`)
      * @param annotationPtr - pointer to the annotation whose quads are needed
-     * @returns Array of `Quad` objects (`[]` if the annotation has no quads)
+     * @returns Array of `Rect` objects (`[]` if the annotation has no quads)
+     *
+     * @private
+     */
+    private getQuadPointsAnno;
+    /**
+     * Set the quadrilaterals for a **Highlight / Underline / StrikeOut / Squiggly** markup annotation.
+     *
+     * @param page          - logical page info object (`PdfPageObject`)
+     * @param annotationPtr - pointer to the annotation whose quads are needed
+     * @param rects         - array of `Rect` objects (`[]` if the annotation has no quads)
+     * @returns `true` if the operation was successful
      *
      * @private
      */
-    private readAnnotationQuads;
+    private syncQuadPointsAnno;
     /**
      * Read pdf text annotation
      * @param page  - pdf page infor
@@ -820,14 +863,6 @@ declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      * @private
      */
     private getInReplyToId;
-    /**
-     * Parse a PDF date string **D:YYYYMMDDHHmmSSOHH'mm'** to ISO-8601.
-     *
-     * Returns `undefined` if the input is malformed.
-     *
-     * @private
-     */
-    private toIsoDate;
     /**
      * Fetch a string value (`/T`, `/M`, `/State`, …) from an annotation.
      *
@@ -837,16 +872,13 @@ declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      */
     private getAnnotString;
     /**
-     * Read linked popup of pdf annotation
-     * @param page  - pdf page infor
-     * @param pagePtr - pointer to pdf page object
-     * @param annotationPtr - pointer to pdf annotation
-     * @param index  - index of annotation in the pdf page
-     * @returns pdf popup linked to annotation
+     * Set a string value (`/T`, `/M`, `/State`, …) to an annotation.
+     *
+     * @returns `true` if the operation was successful
      *
      * @private
      */
-    private readPdfAnnoLinkedPopup;
+    private setAnnotString;
     /**
      * Read vertices of pdf annotation
      * @param page  - pdf page infor
@@ -972,6 +1004,23 @@ declare class PdfiumEngine<T = Blob> implements PdfEngine<T> {
      * @private
      */
     private readPageAnnoAppearanceStream;
+    /**
+     * Change the visible colour (and opacity) of an existing annotation.
+     *
+     * For markup annotations (highlight / underline / strikeout / squiggly) we
+     * first clear the AP dictionary entry, otherwise the stored appearance stream
+     * will override the new tint.  For all other sub-types we keep the existing
+     * AP so custom artwork isn't lost.
+     *
+     * @param doc         logical document object
+     * @param page        logical page object
+     * @param annotation  the annotation we want to recolour
+     * @param colour      RGBA tuple (0-255 per channel)
+     * @param which       0 = stroke/fill colour  (PDFium's "colourType" param)
+     *
+     * @returns `true` when the operation succeeded
+     */
+    updateAnnotationColor(doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObjectBase, color: WebAlphaColor, which?: number): PdfTask<boolean>;
     /**
      * Set the rect of specified annotation
      * @param page - page info that the annotation is belonged to