@embedpdf/models 2.2.0 → 2.4.0

package/dist/pdf.d.ts

@@ -829,6 +829,35 @@ export declare enum PdfAnnotationLineEnding {
      */
     Unknown = 10
 }
+/**
+ * Reply type of annotation (RT property per ISO 32000-2)
+ *
+ * Specifies how an annotation relates to another annotation when it is
+ * a reply (via IRT - In Reply To). Valid values are:
+ * - Reply (/R): Normal comment reply (default if RT is missing)
+ * - Group (/Group): Logical grouping of annotations
+ *
+ * @public
+ */
+export declare enum PdfAnnotationReplyType {
+    /**
+     * Unknown or invalid reply type
+     */
+    Unknown = 0,
+    /**
+     * /R - Comment reply (default if RT is missing)
+     * The annotation is a child comment of the annotation referenced by IRT.
+     * Used for comment threads, reviewer discussions, sticky-note replies.
+     */
+    Reply = 1,
+    /**
+     * /Group - Logical grouping
+     * The annotation is grouped with the annotation referenced by IRT.
+     * They represent the same logical object. Used when multiple annotations
+     * act as one unit (e.g., visual shape + metadata/label).
+     */
+    Group = 2
+}
 /**
  * Basic information of pdf annotation
  *
@@ -883,6 +912,14 @@ export interface PdfAnnotationObjectBase {
      * Custom data of the annotation
      */
     custom?: any;
+    /**
+     * In reply to annotation id (IRT - for grouping or reply threads)
+     */
+    inReplyToId?: string;
+    /**
+     * Reply type (how this annotation relates to the parent via IRT)
+     */
+    replyType?: PdfAnnotationReplyType;
 }
 /**
  * Popup annotation
@@ -900,10 +937,6 @@ export interface PdfPopupAnnoObject extends PdfAnnotationObjectBase {
      * Whether the popup is opened or not
      */
     open: boolean;
-    /**
-     * In reply to id
-     */
-    inReplyToId?: string;
 }
 /**
  * Pdf Link annotation
@@ -917,6 +950,22 @@ export interface PdfLinkAnnoObject extends PdfAnnotationObjectBase {
      * target of the link
      */
     target: PdfLinkTarget | undefined;
+    /**
+     * Stroke color of the link border (e.g., "#00A5E4")
+     */
+    strokeColor?: string;
+    /**
+     * Width of the link border (default: 2)
+     */
+    strokeWidth?: number;
+    /**
+     * Style of the link border (default: UNDERLINE)
+     */
+    strokeStyle?: PdfAnnotationBorderStyle;
+    /**
+     * Dash pattern for dashed border style
+     */
+    strokeDashArray?: number[];
 }
 /**
  * Pdf Text annotation
@@ -938,10 +987,6 @@ export interface PdfTextAnnoObject extends PdfAnnotationObjectBase {
      * opacity of text annotation
      */
     opacity?: number;
-    /**
-     * In reply to id
-     */
-    inReplyToId?: string;
     /**
      * State of the text annotation
      */
@@ -1028,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
@@ -1208,9 +1254,13 @@ export interface PdfInkAnnoObject extends PdfAnnotationObjectBase {
      */
     inkList: PdfInkListObject[];
     /**
-     * color of ink annotation
+     * Color of the ink stroke (preferred over deprecated `color`)
      */
-    color: string;
+    strokeColor?: string;
+    /**
+     * @deprecated Use strokeColor instead. Will be removed in next major version.
+     */
+    color?: string;
     /**
      * opacity of ink annotation
      */
@@ -1364,9 +1414,13 @@ export interface PdfHighlightAnnoObject extends PdfAnnotationObjectBase {
      */
     contents?: string;
     /**
-     * color of highlight annotation
+     * Color of the highlight markup (preferred over deprecated `color`)
      */
-    color: string;
+    strokeColor?: string;
+    /**
+     * @deprecated Use strokeColor instead. Will be removed in next major version.
+     */
+    color?: string;
     /**
      * opacity of highlight annotation
      */
@@ -1608,19 +1662,23 @@ export interface PdfSquigglyAnnoObject extends PdfAnnotationObjectBase {
     /** {@inheritDoc PdfAnnotationObjectBase.type} */
     type: PdfAnnotationSubtype.SQUIGGLY;
     /**
-     * Text contents of the highlight annotation
+     * Text contents of the squiggly annotation
      */
     contents?: string;
     /**
-     * color of strike out annotation
+     * Color of the squiggly markup (preferred over deprecated `color`)
      */
-    color: string;
+    strokeColor?: string;
     /**
-     * opacity of strike out annotation
+     * @deprecated Use strokeColor instead. Will be removed in next major version.
+     */
+    color?: string;
+    /**
+     * opacity of squiggly annotation
      */
     opacity: number;
     /**
-     * quads of highlight area
+     * quads of squiggly area
      */
     segmentRects: Rect[];
 }
@@ -1633,19 +1691,23 @@ export interface PdfUnderlineAnnoObject extends PdfAnnotationObjectBase {
     /** {@inheritDoc PdfAnnotationObjectBase.type} */
     type: PdfAnnotationSubtype.UNDERLINE;
     /**
-     * Text contents of the highlight annotation
+     * Text contents of the underline annotation
      */
     contents?: string;
     /**
-     * color of strike out annotation
+     * Color of the underline markup (preferred over deprecated `color`)
      */
-    color: string;
+    strokeColor?: string;
     /**
-     * opacity of strike out annotation
+     * @deprecated Use strokeColor instead. Will be removed in next major version.
+     */
+    color?: string;
+    /**
+     * opacity of underline annotation
      */
     opacity: number;
     /**
-     * quads of highlight area
+     * quads of underline area
      */
     segmentRects: Rect[];
 }
@@ -1662,15 +1724,19 @@ export interface PdfStrikeOutAnnoObject extends PdfAnnotationObjectBase {
      */
     contents?: string;
     /**
-     * color of strike out annotation
+     * Color of the strikeout markup (preferred over deprecated `color`)
      */
-    color: string;
+    strokeColor?: string;
+    /**
+     * @deprecated Use strokeColor instead. Will be removed in next major version.
+     */
+    color?: string;
     /**
      * opacity of strike out annotation
      */
     opacity: number;
     /**
-     * quads of highlight area
+     * quads of strikeout area
      */
     segmentRects: Rect[];
 }
@@ -1720,7 +1786,11 @@ export interface PdfFreeTextAnnoObject extends PdfAnnotationObjectBase {
      */
     opacity: number;
     /**
-     * Background color of the free text annotation
+     * Background/fill color of the free text annotation (matches shape convention)
+     */
+    color?: string;
+    /**
+     * @deprecated Use color instead. Will be removed in next major version.
      */
     backgroundColor?: string;
     /**
@@ -1732,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
  *
@@ -2624,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
@@ -2784,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.2.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",