@embedpdf/models 2.3.0 → 2.4.0

package/dist/pdf.d.ts

@@ -1073,7 +1073,8 @@ export declare enum PDF_FORM_FIELD_TYPE {
 }
 export declare enum PdfAnnotationColorType {
     Color = 0,
-    InteriorColor = 1
+    InteriorColor = 1,
+    OverlayColor = 2
 }
 /**
  * Border style of pdf annotation
@@ -1801,12 +1802,69 @@ export interface PdfFreeTextAnnoObject extends PdfAnnotationObjectBase {
      */
     richContent?: string;
 }
+/**
+ * Pdf redact annotation
+ *
+ * @public
+ */
+export interface PdfRedactAnnoObject extends PdfAnnotationObjectBase {
+    /** {@inheritDoc PdfAnnotationObjectBase.type} */
+    type: PdfAnnotationSubtype.REDACT;
+    /**
+     * Text contents of the redact annotation
+     */
+    contents?: string;
+    /**
+     * Quads defining the redaction areas (like markup annotations)
+     */
+    segmentRects: Rect[];
+    /**
+     * Interior color - the preview color shown BEFORE redaction is applied
+     */
+    color?: string;
+    /**
+     * Overlay color - the fill color shown AFTER redaction is applied
+     */
+    overlayColor?: string;
+    /**
+     * Stroke/border color of the redaction box
+     */
+    strokeColor?: string;
+    /**
+     * Opacity of the redact annotation
+     */
+    opacity?: number;
+    /**
+     * Text displayed on the redacted area after applying the redaction
+     */
+    overlayText?: string;
+    /**
+     * Whether the overlay text repeats to fill the redaction area
+     */
+    overlayTextRepeat?: boolean;
+    /**
+     * Font family for the overlay text
+     */
+    fontFamily?: PdfStandardFont;
+    /**
+     * Font size for the overlay text
+     */
+    fontSize?: number;
+    /**
+     * Font color for the overlay text
+     */
+    fontColor?: string;
+    /**
+     * Text alignment for the overlay text
+     */
+    textAlign?: PdfTextAlignment;
+}
 /**
  * All annotation that support
  *
  * @public
  */
-export type PdfSupportedAnnoObject = PdfInkAnnoObject | PdfTextAnnoObject | PdfLinkAnnoObject | PdfPolygonAnnoObject | PdfPolylineAnnoObject | PdfHighlightAnnoObject | PdfLineAnnoObject | PdfWidgetAnnoObject | PdfFileAttachmentAnnoObject | PdfStampAnnoObject | PdfSquareAnnoObject | PdfCircleAnnoObject | PdfSquigglyAnnoObject | PdfUnderlineAnnoObject | PdfStrikeOutAnnoObject | PdfCaretAnnoObject | PdfFreeTextAnnoObject;
+export type PdfSupportedAnnoObject = PdfInkAnnoObject | PdfTextAnnoObject | PdfLinkAnnoObject | PdfPolygonAnnoObject | PdfPolylineAnnoObject | PdfHighlightAnnoObject | PdfLineAnnoObject | PdfWidgetAnnoObject | PdfFileAttachmentAnnoObject | PdfStampAnnoObject | PdfSquareAnnoObject | PdfCircleAnnoObject | PdfSquigglyAnnoObject | PdfUnderlineAnnoObject | PdfStrikeOutAnnoObject | PdfCaretAnnoObject | PdfFreeTextAnnoObject | PdfRedactAnnoObject;
 /**
  * Pdf annotation that does not support
  *
@@ -2693,6 +2751,29 @@ export interface PdfEngine<T = Blob> {
      * @returns task contains the result
      */
     redactTextInRects: (doc: PdfDocumentObject, page: PdfPageObject, rects: Rect[], options?: PdfRedactTextOptions) => PdfTask<boolean>;
+    /**
+     * Apply a single REDACT annotation - removes content, flattens RO overlay, deletes annotation.
+     * @param doc - pdf document
+     * @param page - pdf page
+     * @param annotation - the REDACT annotation to apply
+     * @returns task contains the result
+     */
+    applyRedaction: (doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject) => PdfTask<boolean>;
+    /**
+     * Apply all REDACT annotations on a page - removes content, flattens overlays, deletes annotations.
+     * @param doc - pdf document
+     * @param page - pdf page
+     * @returns task contains the result
+     */
+    applyAllRedactions: (doc: PdfDocumentObject, page: PdfPageObject) => PdfTask<boolean>;
+    /**
+     * Flatten an annotation's appearance (AP/N) to page content and remove the annotation.
+     * @param doc - pdf document
+     * @param page - pdf page
+     * @param annotation - the annotation to flatten
+     * @returns task contains the result
+     */
+    flattenAnnotation: (doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject) => PdfTask<boolean>;
     /**
      * Extract text on specified pdf pages
      * @param doc - pdf document
@@ -2853,6 +2934,9 @@ export interface IPdfiumExecutor {
     extractPages(doc: PdfDocumentObject, pageIndexes: number[]): PdfTask<ArrayBuffer>;
     extractText(doc: PdfDocumentObject, pageIndexes: number[]): PdfTask<string>;
     redactTextInRects(doc: PdfDocumentObject, page: PdfPageObject, rects: Rect[], options?: PdfRedactTextOptions): PdfTask<boolean>;
+    applyRedaction(doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject): PdfTask<boolean>;
+    applyAllRedactions(doc: PdfDocumentObject, page: PdfPageObject): PdfTask<boolean>;
+    flattenAnnotation(doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject): PdfTask<boolean>;
     getTextSlices(doc: PdfDocumentObject, slices: PageTextSlice[]): PdfTask<string[]>;
     getPageGlyphs(doc: PdfDocumentObject, page: PdfPageObject): PdfTask<PdfGlyphObject[]>;
     getPageGeometry(doc: PdfDocumentObject, page: PdfPageObject): PdfTask<PdfPageGeometry>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embedpdf/models",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "private": false,
   "description": "Shared type definitions, data models, and utility helpers (geometry, tasks, logging, PDF primitives) that underpin every package in the EmbedPDF ecosystem.",
   "type": "module",