@embedpdf/models 2.2.0 → 2.3.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
      */
@@ -1208,9 +1253,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 +1413,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 +1661,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 +1690,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 +1723,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 +1785,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;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embedpdf/models",
-  "version": "2.2.0",
+  "version": "2.3.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",