@embedpdf/models 1.0.12 → 1.0.14

package/dist/pdf.d.ts

@@ -1,4 +1,3 @@
-import { WebAlphaColor } from './color';
 import { Size, Rect, Position, Rotation } from './geometry';
 import { Task, TaskError } from './task';
 /**
@@ -171,6 +170,42 @@ export declare enum PdfZoomMode {
      */
     FitRectangle = 5
 }
+/**
+ *  12 default fonts for PDF
+ */
+export declare enum PdfStandardFont {
+    Unknown = -1,
+    Courier = 0,
+    Courier_Bold = 1,
+    Courier_BoldOblique = 2,
+    Courier_Oblique = 3,
+    Helvetica = 4,
+    Helvetica_Bold = 5,
+    Helvetica_BoldOblique = 6,
+    Helvetica_Oblique = 7,
+    Times_Roman = 8,
+    Times_Bold = 9,
+    Times_BoldItalic = 10,
+    Times_Italic = 11,
+    Symbol = 12,
+    ZapfDingbats = 13
+}
+/**
+ * Text alignment
+ */
+export declare enum PdfTextAlignment {
+    Left = 0,
+    Center = 1,
+    Right = 2
+}
+/**
+ * Vertical alignment
+ */
+export declare enum PdfVerticalAlignment {
+    Top = 0,
+    Middle = 1,
+    Bottom = 2
+}
 /**
  * Blend mode
  *
@@ -194,57 +229,6 @@ export declare enum PdfBlendMode {
     Color = 14,
     Luminosity = 15
 }
-/** Extra UI sentinel for “multiple different values selected”. */
-export declare const MixedBlendMode: unique symbol;
-export type UiBlendModeValue = PdfBlendMode | typeof MixedBlendMode;
-export type CssBlendMode = 'normal' | 'multiply' | 'screen' | 'overlay' | 'darken' | 'lighten' | 'color-dodge' | 'color-burn' | 'hard-light' | 'soft-light' | 'difference' | 'exclusion' | 'hue' | 'saturation' | 'color' | 'luminosity';
-interface BlendModeInfo {
-    /** Pdf enum value */
-    id: PdfBlendMode;
-    /** Human label for UI */
-    label: string;
-    /** CSS mix-blend-mode token */
-    css: CssBlendMode;
-}
-/** Get descriptor (falls back to Normal if unknown number sneaks in).
- *
- * @public
- */
-export declare function getBlendModeInfo(mode: PdfBlendMode): BlendModeInfo;
-/** Convert enum → CSS value for `mix-blend-mode`.
- *
- * @public
- */
-export declare function blendModeToCss(mode: PdfBlendMode): CssBlendMode;
-/** Convert CSS token → enum (returns undefined if not recognized).
- *
- * @public
- */
-export declare function cssToBlendMode(value: CssBlendMode): PdfBlendMode | undefined;
-/** Enum → UI label.
- *
- * @public
- */
-export declare function blendModeLabel(mode: PdfBlendMode): string;
-/**
- * For a selection of annotations: returns the common enum value, or Mixed sentinel.
- *
- * @public
- */
-export declare function reduceBlendModes(modes: readonly PdfBlendMode[]): UiBlendModeValue;
-/** Options for a <select>.
- *
- * @public
- */
-export declare const blendModeSelectOptions: {
-    value: PdfBlendMode;
-    label: string;
-}[];
-/** Provide a label when Mixed sentinel used (UI convenience).
- *
- * @public
- */
-export declare function uiBlendModeDisplay(value: UiBlendModeValue): string;
 /**
  * Representation of the linked destination
  *
@@ -448,6 +432,16 @@ export interface PdfAlphaColor {
      */
     alpha: number;
 }
+/**
+ * Color
+ *
+ * @public
+ */
+export interface PdfColor {
+    red: number;
+    green: number;
+    blue: number;
+}
 /**
  * Annotation type
  *
@@ -565,6 +559,57 @@ export declare enum PdfAnnotationStateModel {
      */
     Reviewed = "Reviewed"
 }
+/**
+ * Line ending of annotation
+ *
+ * @public
+ */
+export declare enum PdfAnnotationLineEnding {
+    /**
+     * No line ending
+     */
+    None = 0,
+    /**
+     * Square line ending
+     */
+    Square = 1,
+    /**
+     * Circle line ending
+     */
+    Circle = 2,
+    /**
+     * Diamond line ending
+     */
+    Diamond = 3,
+    /**
+     * Open arrow line ending
+     */
+    OpenArrow = 4,
+    /**
+     * Closed arrow line ending
+     */
+    ClosedArrow = 5,
+    /**
+     * Butt line ending
+     */
+    Butt = 6,
+    /**
+     * Right open arrow line ending
+     */
+    ROpenArrow = 7,
+    /**
+     * Right closed arrow line ending
+     */
+    RClosedArrow = 8,
+    /**
+     * Slash line ending
+     */
+    Slash = 9,
+    /**
+     * Unknown line ending
+     */
+    Unknown = 10
+}
 /**
  * Basic information of pdf annotation
  *
@@ -810,6 +855,24 @@ export declare enum PdfPageObjectType {
     SHADING = 4,
     FORM = 5
 }
+/**
+ * Line points
+ *
+ * @public
+ */
+export interface LinePoints {
+    start: Position;
+    end: Position;
+}
+/**
+ * Line endings
+ *
+ * @public
+ */
+export interface LineEndings {
+    start: PdfAnnotationLineEnding;
+    end: PdfAnnotationLineEnding;
+}
 /**
  * Options of pdf widget annotation
  *
@@ -930,10 +993,38 @@ export interface PdfInkAnnoObject extends PdfAnnotationObjectBase {
 export interface PdfPolygonAnnoObject extends PdfAnnotationObjectBase {
     /** {@inheritDoc PdfAnnotationObjectBase.type} */
     type: PdfAnnotationSubtype.POLYGON;
+    /**
+     * contents of polygon annotation
+     */
+    contents?: string;
     /**
      * vertices of annotation
      */
     vertices: Position[];
+    /**
+     * color of ink annotation
+     */
+    color: string;
+    /**
+     * opacity of ink annotation
+     */
+    opacity: number;
+    /**
+     * stroke-width of ink annotation
+     */
+    strokeWidth: number;
+    /**
+     * stroke color of polygon annotation
+     */
+    strokeColor: string;
+    /**
+     * stroke style of polygon annotation
+     */
+    strokeStyle: PdfAnnotationBorderStyle;
+    /**
+     * stroke dash array of polygon annotation
+     */
+    strokeDashArray?: number[];
 }
 /**
  * PDF polyline annotation
@@ -943,10 +1034,42 @@ export interface PdfPolygonAnnoObject extends PdfAnnotationObjectBase {
 export interface PdfPolylineAnnoObject extends PdfAnnotationObjectBase {
     /** {@inheritDoc PdfAnnotationObjectBase.type} */
     type: PdfAnnotationSubtype.POLYLINE;
+    /**
+     * contents of polyline annotation
+     */
+    contents?: string;
+    /**
+     * start and end line endings of polyline
+     */
+    lineEndings?: LineEndings;
     /**
      * vertices of annotation
      */
     vertices: Position[];
+    /**
+     * interior color of line annotation
+     */
+    color: string;
+    /**
+     * opacity of ink annotation
+     */
+    opacity: number;
+    /**
+     * stroke-width of ink annotation
+     */
+    strokeWidth: number;
+    /**
+     * stroke color of line annotation
+     */
+    strokeColor: string;
+    /**
+     * stroke style of polyline annotation
+     */
+    strokeStyle: PdfAnnotationBorderStyle;
+    /**
+     * stroke dash array of polyline annotation
+     */
+    strokeDashArray?: number[];
 }
 /**
  * PDF line annotation
@@ -957,13 +1080,41 @@ export interface PdfLineAnnoObject extends PdfAnnotationObjectBase {
     /** {@inheritDoc PdfAnnotationObjectBase.type} */
     type: PdfAnnotationSubtype.LINE;
     /**
-     * start point of line
+     * contents of line annotation
+     */
+    contents?: string;
+    /**
+     * start and end points of line
+     */
+    linePoints: LinePoints;
+    /**
+     * start and end line endings of line
+     */
+    lineEndings?: LineEndings;
+    /**
+     * interior color of line annotation
+     */
+    color: string;
+    /**
+     * opacity of ink annotation
+     */
+    opacity: number;
+    /**
+     * stroke-width of ink annotation
+     */
+    strokeWidth: number;
+    /**
+     * stroke color of line annotation
      */
-    startPoint: Position;
+    strokeColor: string;
     /**
-     * end point of line
+     * stroke style of line annotation
      */
-    endPoint: Position;
+    strokeStyle: PdfAnnotationBorderStyle;
+    /**
+     * stroke dash array of line annotation
+     */
+    strokeDashArray?: number[];
 }
 /**
  * PDF highlight annotation
@@ -1123,6 +1274,10 @@ export interface PdfCircleAnnoObject extends PdfAnnotationObjectBase {
      * flags of circle annotation
      */
     flags: PdfAnnotationFlagName[];
+    /**
+     * Text contents of the circle annotation
+     */
+    contents?: string;
     /**
      * color of circle annotation
      */
@@ -1164,6 +1319,10 @@ export interface PdfCircleAnnoObject extends PdfAnnotationObjectBase {
 export interface PdfSquareAnnoObject extends PdfAnnotationObjectBase {
     /** {@inheritDoc PdfAnnotationObjectBase.type} */
     type: PdfAnnotationSubtype.SQUARE;
+    /**
+     * Text contents of the square annotation
+     */
+    contents?: string;
     /**
      * flags of square annotation
      */
@@ -1293,7 +1452,45 @@ export interface PdfCaretAnnoObject extends PdfAnnotationObjectBase {
 export interface PdfFreeTextAnnoObject extends PdfAnnotationObjectBase {
     /** {@inheritDoc PdfAnnotationObjectBase.type} */
     type: PdfAnnotationSubtype.FREETEXT;
+    /**
+     * Text contents of the free text annotation
+     */
     contents: string;
+    /**
+     * Font family of the free text annotation
+     */
+    fontFamily: PdfStandardFont;
+    /**
+     * Font size of the free text annotation
+     */
+    fontSize: number;
+    /**
+     * Font color of the free text annotation
+     */
+    fontColor: string;
+    /**
+     * Text alignment of the free text annotation
+     */
+    textAlign: PdfTextAlignment;
+    /**
+     * Vertical alignment of the free text annotation
+     */
+    verticalAlign: PdfVerticalAlignment;
+    /**
+     * Opacity of the free text annotation
+     */
+    opacity: number;
+    /**
+     * Background color of the free text annotation
+     */
+    backgroundColor?: string;
+    /**
+     * Default style of the free text annotation
+     */
+    defaultStyle?: string;
+    /**
+     * Rich content of the free text annotation
+     */
     richContent?: string;
 }
 /**
@@ -1845,16 +2042,6 @@ export interface PdfEngine<T = Blob> {
      * @returns task contains the annotations or error
      */
     getPageAnnotations: (doc: PdfDocumentObject, page: PdfPageObject) => PdfTask<PdfAnnotationObject[]>;
-    /**
-     * Change the visible colour (and opacity) of an existing annotation.
-     * @param doc - pdf document
-     * @param page - pdf page
-     * @param annotation - the annotation to recolour
-     * @param colour - RGBA color values (0-255 per channel)
-     * @param which - 0 = stroke/fill colour (PDFium's "colourType" param)
-     * @returns task that indicates whether the operation succeeded
-     */
-    updateAnnotationColor: (doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObjectBase, color: WebAlphaColor, which?: number) => PdfTask<boolean>;
     /**
      * Create a annotation on specified page
      * @param doc - pdf document

package/package.json

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