@embedpdf/models 1.0.13 → 1.0.15

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
  *
@@ -490,6 +484,22 @@ export declare enum PdfAnnotationSubtype {
  * @public
  */
 export declare const PdfAnnotationSubtypeName: Record<PdfAnnotationSubtype, string>;
+/**
+ * Context map for annotation subtypes
+ *
+ * @public
+ */
+export interface AnnotationContextMap {
+    [PdfAnnotationSubtype.STAMP]: {
+        imageData: ImageData;
+    };
+}
+/**
+ * Context type for annotation subtypes
+ *
+ * @public
+ */
+export type AnnotationCreateContext<A extends PdfAnnotationObject> = A['type'] extends keyof AnnotationContextMap ? AnnotationContextMap[A['type']] : undefined;
 /**
  * Status of pdf annotation
  *
@@ -642,6 +652,10 @@ export interface PdfAnnotationObjectBase {
      * Sub type of annotation
      */
     type: PdfAnnotationSubtype;
+    /**
+     * flags of the annotation
+     */
+    flags?: PdfAnnotationFlagName[];
     /**
      * The index of page that this annotation belong to
      */
@@ -1263,10 +1277,6 @@ export type PdfStampAnnoObjectContents = Array<PdfPathObject | PdfImageObject |
 export interface PdfStampAnnoObject extends PdfAnnotationObjectBase {
     /** {@inheritDoc PdfAnnotationObjectBase.type} */
     type: PdfAnnotationSubtype.STAMP;
-    /**
-     * contents in this stamp annotation
-     */
-    contents: PdfStampAnnoObjectContents;
 }
 /**
  * Pdf circle annotation
@@ -1458,7 +1468,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;
 }
 /**
@@ -2010,16 +2058,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
@@ -2027,7 +2065,7 @@ export interface PdfEngine<T = Blob> {
      * @param annotation - new annotations
      * @returns task whether the annotations is created successfully
      */
-    createPageAnnotation: (doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject) => PdfTask<number>;
+    createPageAnnotation: <A extends PdfAnnotationObject>(doc: PdfDocumentObject, page: PdfPageObject, annotation: A, context?: AnnotationCreateContext<A>) => PdfTask<number>;
     /**
      * Update a annotation on specified page
      * @param doc - pdf document

package/package.json

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