@embedpdf/models 2.10.0 → 2.11.0

package/dist/pdf.d.ts

@@ -613,6 +613,10 @@ export declare const PdfAnnotationSubtypeName: Record<PdfAnnotationSubtype, stri
 export interface AnnotationContextMap {
     [PdfAnnotationSubtype.STAMP]: {
         imageData: ImageData;
+        appearance?: never;
+    } | {
+        imageData?: never;
+        appearance: ArrayBuffer;
     };
 }
 /**
@@ -697,124 +701,56 @@ export declare enum PdfAnnotationStateModel {
     Review = "Review"
 }
 /**
- * Icon of pdf annotation
+ * Name (/Name entry) of a pdf annotation — identifies the icon for text/sound/file
+ * annotations and the stamp type for stamp annotations.
  *
  * @public
  */
-export declare enum PdfAnnotationIcon {
-    /**
-     * Unknown icon
-     */
+export declare enum PdfAnnotationName {
     Unknown = -1,
-    /**
-     * Comment icon
-     */
     Comment = 0,
-    /**
-     * Key icon
-     */
     Key = 1,
-    /**
-     * Note icon
-     */
     Note = 2,
-    /**
-     * Help icon
-     */
     Help = 3,
-    /**
-     * New paragraph icon
-     */
     NewParagraph = 4,
-    /**
-     * Paragraph icon
-     */
     Paragraph = 5,
-    /**
-     * Insert icon
-     */
     Insert = 6,
-    /**
-     * Graph icon
-     */
     Graph = 7,
-    /**
-     * Push pin icon
-     */
     PushPin = 8,
-    /**
-     * Paperclip icon
-     */
     Paperclip = 9,
-    /**
-     * Tag icon
-     */
     Tag = 10,
-    /**
-     * Speaker icon
-     */
     Speaker = 11,
-    /**
-     * Mic icon
-     */
     Mic = 12,
-    /**
-     * Approved icon
-     */
     Approved = 13,
-    /**
-     * Experimental icon
-     */
     Experimental = 14,
-    /**
-     * Not approved icon
-     */
     NotApproved = 15,
-    /**
-     * As is icon
-     */
     AsIs = 16,
-    /**
-     * Expired icon
-     */
     Expired = 17,
-    /**
-     * Not for public release icon
-     */
     NotForPublicRelease = 18,
-    /**
-     * Confidential icon
-     */
     Confidential = 19,
-    /**
-     * Final icon
-     */
     Final = 20,
-    /**
-     * Sold icon
-     */
     Sold = 21,
-    /**
-     * Departmental icon
-     */
     Departmental = 22,
-    /**
-     * For comment icon
-     */
     ForComment = 23,
-    /**
-     * Top secret icon
-     */
     TopSecret = 24,
-    /**
-     * Draft icon
-     */
     Draft = 25,
-    /**
-     * For public release icon
-     */
-    ForPublicRelease = 26
-}
+    ForPublicRelease = 26,
+    Completed = 27,
+    Void = 28,
+    PreliminaryResults = 29,
+    InformationOnly = 30,
+    Rejected = 31,
+    Witness = 32,
+    InitialHere = 33,
+    SignHere = 34,
+    Accepted = 35,
+    Custom = 36,
+    Image = 37
+}
+/** @deprecated Use PdfAnnotationName instead */
+export type PdfAnnotationIcon = PdfAnnotationName;
+/** @deprecated Use PdfAnnotationName instead */
+export declare const PdfAnnotationIcon: typeof PdfAnnotationName;
 /**
  * Line ending of annotation
  */
@@ -984,6 +920,10 @@ export interface PdfAnnotationObjectBase {
      * Reply type (how this annotation relates to the parent via IRT)
      */
     replyType?: PdfAnnotationReplyType;
+    /**
+     * Subject of the annotation
+     */
+    subject?: string;
 }
 /**
  * Popup annotation
@@ -1064,8 +1004,10 @@ export interface PdfTextAnnoObject extends PdfAnnotationObjectBase {
      */
     stateModel?: PdfAnnotationStateModel;
     /**
-     * Icon of the text annotation
+     * Name (/Name entry) of the text annotation
      */
+    name?: PdfAnnotationName;
+    /** @deprecated Use name instead */
     icon?: PdfAnnotationIcon;
 }
 /**
@@ -1789,13 +1731,11 @@ export interface PdfStampAnnoObject extends PdfAnnotationObjectBase {
     /** {@inheritDoc PdfAnnotationObjectBase.type} */
     type: PdfAnnotationSubtype.STAMP;
     /**
-     * Icon of the stamp annotation
+     * Name (/Name entry) of the stamp annotation
      */
+    name?: PdfAnnotationName;
+    /** @deprecated Use name instead */
     icon?: PdfAnnotationIcon;
-    /**
-     * Subject of the stamp annotation
-     */
-    subject?: string;
 }
 /**
  * Pdf circle annotation
@@ -2680,7 +2620,8 @@ export declare enum PdfErrorCode {
     CantSelectText = 26,
     CantSelectOption = 27,
     CantCheckField = 28,
-    CantSetAnnotString = 29
+    CantSetAnnotString = 29,
+    CantDeletePage = 30
 }
 export interface PdfErrorReason {
     code: PdfErrorCode;
@@ -2800,6 +2741,11 @@ export interface PdfRenderPageOptions extends PdfRenderOptions {
      * Whether to render interactive form widgets
      */
     withForms?: boolean;
+    /**
+     * When true, the background is transparent instead of white.
+     * Useful for rendering stamp thumbnails or overlay content.
+     */
+    transparentBackground?: boolean;
 }
 export interface PdfRenderPageAnnotationOptions extends PdfRenderOptions {
     /**
@@ -3198,6 +3144,28 @@ export interface PdfEngine<T = Blob> {
      * @returns task contains the new pdf file content
      */
     extractPages: (doc: PdfDocumentObject, pageIndexes: number[]) => PdfTask<ArrayBuffer>;
+    /**
+     * Create a new empty PDF document
+     * @param id - unique document identifier
+     * @returns task contains the empty document object
+     */
+    createDocument: (id: string) => PdfTask<PdfDocumentObject>;
+    /**
+     * Import pages from a source document into a destination document
+     * @param destDoc - destination document
+     * @param srcDoc - source document
+     * @param srcPageIndices - zero-based page indices in the source document
+     * @param insertIndex - position to insert at (defaults to end)
+     * @returns task contains the newly added page objects
+     */
+    importPages: (destDoc: PdfDocumentObject, srcDoc: PdfDocumentObject, srcPageIndices: number[], insertIndex?: number) => PdfTask<PdfPageObject[]>;
+    /**
+     * Delete a page from a document
+     * @param doc - pdf document
+     * @param pageIndex - zero-based index of the page to delete
+     * @returns task contains the result
+     */
+    deletePage: (doc: PdfDocumentObject, pageIndex: number) => PdfTask<boolean>;
     /**
      * Extract text on specified pdf pages
      * @param doc - pdf document
@@ -3237,6 +3205,22 @@ export interface PdfEngine<T = Blob> {
      * @returns task contains the result
      */
     flattenAnnotation: (doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject) => PdfTask<boolean>;
+    /**
+     * Export an annotation's appearance as a standalone PDF document
+     * @param doc - pdf document
+     * @param page - pdf page
+     * @param annotation - the annotation to export
+     * @returns task contains the exported PDF as ArrayBuffer
+     */
+    exportAnnotationAppearanceAsPdf: (doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject) => PdfTask<ArrayBuffer>;
+    /**
+     * Export multiple annotations' appearances as a standalone single-page PDF
+     * @param doc - pdf document
+     * @param page - pdf page
+     * @param annotations - the annotations to export
+     * @returns task contains the exported PDF as ArrayBuffer
+     */
+    exportAnnotationsAppearanceAsPdf: (doc: PdfDocumentObject, page: PdfPageObject, annotations: PdfAnnotationObject[]) => PdfTask<ArrayBuffer>;
     /**
      * Extract text on specified pdf pages
      * @param doc - pdf document
@@ -3412,11 +3396,15 @@ export interface IPdfiumExecutor {
     shareWidgetField(doc: PdfDocumentObject, sourcePage: PdfPageObject, sourceAnnotation: PdfWidgetAnnoObject, targetPage: PdfPageObject, targetAnnotation: PdfWidgetAnnoObject): PdfTask<boolean>;
     flattenPage(doc: PdfDocumentObject, page: PdfPageObject, options?: PdfFlattenPageOptions): PdfTask<PdfPageFlattenResult>;
     extractPages(doc: PdfDocumentObject, pageIndexes: number[]): PdfTask<ArrayBuffer>;
+    createDocument(id: string): PdfTask<PdfDocumentObject>;
+    importPages(destDoc: PdfDocumentObject, srcDoc: PdfDocumentObject, srcPageIndices: number[], insertIndex?: number): PdfTask<PdfPageObject[]>;
     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>;
+    exportAnnotationAppearanceAsPdf(doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject): PdfTask<ArrayBuffer>;
+    exportAnnotationsAppearanceAsPdf(doc: PdfDocumentObject, page: PdfPageObject, annotations: PdfAnnotationObject[]): PdfTask<ArrayBuffer>;
     getTextSlices(doc: PdfDocumentObject, slices: PageTextSlice[]): PdfTask<string[]>;
     getPageGlyphs(doc: PdfDocumentObject, page: PdfPageObject): PdfTask<PdfGlyphObject[]>;
     getPageGeometry(doc: PdfDocumentObject, page: PdfPageObject): PdfTask<PdfPageGeometry>;
@@ -3427,6 +3415,7 @@ export interface IPdfiumExecutor {
         pageIndices: number[];
     }>): PdfTask<PdfFile>;
     preparePrintDocument(doc: PdfDocumentObject, options?: PdfPrintOptions): PdfTask<ArrayBuffer>;
+    deletePage(doc: PdfDocumentObject, pageIndex: number): PdfTask<boolean>;
     saveAsCopy(doc: PdfDocumentObject): PdfTask<ArrayBuffer>;
     closeDocument(doc: PdfDocumentObject): PdfTask<boolean>;
     closeAllDocuments(): PdfTask<boolean>;

package/package.json

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