@embedpdf/models 1.2.1 → 1.3.1

package/dist/pdf.d.ts

@@ -155,7 +155,7 @@ export declare const PdfUnwantedTextRegex: RegExp;
  */
 export declare function stripPdfUnwantedMarkers(text: string): string;
 /**
- * zoom mode
+ * Zoom mode
  *
  * @public
  */
@@ -170,17 +170,29 @@ export declare enum PdfZoomMode {
      */
     FitPage = 2,
     /**
-     * Fit the page width.
+     * Fit the entire page width to the window.
      */
     FitHorizontal = 3,
     /**
-     * Fit the page height.
+     * Fit the entire page height to the window.
      */
     FitVertical = 4,
     /**
      * Fit a specific rectangle area within the window.
      */
-    FitRectangle = 5
+    FitRectangle = 5,
+    /**
+     * Fit bounding box of the entire page (including annotations).
+     */
+    FitBoundingBox = 6,
+    /**
+     * Fit the bounding box width of the page.
+     */
+    FitBoundingBoxHorizontal = 7,
+    /**
+     * Fit the bounding box height of the page.
+     */
+    FitBoundingBoxVertical = 8
 }
 /**
  * Trapped status of the document.
@@ -302,6 +314,12 @@ export interface PdfDestinationObject {
         mode: PdfZoomMode.FitVertical;
     } | {
         mode: PdfZoomMode.FitRectangle;
+    } | {
+        mode: PdfZoomMode.FitBoundingBox;
+    } | {
+        mode: PdfZoomMode.FitBoundingBoxHorizontal;
+    } | {
+        mode: PdfZoomMode.FitBoundingBoxVertical;
     };
     view: number[];
 }
@@ -1717,7 +1735,10 @@ export type PdfAnnotationObject = PdfSupportedAnnoObject | PdfUnsupportedAnnoObj
 export interface PdfAttachmentObject {
     index: number;
     name: string;
-    creationDate: string;
+    description: string;
+    mimeType: string;
+    size?: number;
+    creationDate?: Date;
     checksum: string;
 }
 /**
@@ -2227,6 +2248,27 @@ export interface PdfPrintOptions {
      */
     pageRange?: string;
 }
+/**
+ * Parameters for adding an attachment to a PDF document
+ */
+export interface PdfAddAttachmentParams {
+    /**
+     * Name of the attachment
+     */
+    name: string;
+    /**
+     * Description of the attachment
+     */
+    description: string;
+    /**
+     * MIME type of the attachment
+     */
+    mimeType: string;
+    /**
+     * Data of the attachment
+     */
+    data: ArrayBuffer | Uint8Array;
+}
 /**
  * Pdf engine
  *
@@ -2300,6 +2342,19 @@ export interface PdfEngine<T = Blob> {
      * @returns task that contains the bookmarks or error
      */
     getBookmarks: (doc: PdfDocumentObject) => PdfTask<PdfBookmarksObject>;
+    /**
+     * Set the bookmarks of the file
+     * @param doc - pdf document
+     * @param payload - bookmarks to set
+     * @returns task that contains whether the bookmarks are set successfully or not
+     */
+    setBookmarks: (doc: PdfDocumentObject, payload: PdfBookmarkObject[]) => PdfTask<boolean>;
+    /**
+     * Remove all bookmarks from the document.
+     * @param doc - pdf document
+     * @returns task that contains whether the bookmarks are removed successfully or not
+     */
+    deleteBookmarks: (doc: PdfDocumentObject) => PdfTask<boolean>;
     /**
      * Render the specified pdf page
      * @param doc - pdf document
@@ -2396,6 +2451,22 @@ export interface PdfEngine<T = Blob> {
      * @returns task that contains the attachments or error
      */
     getAttachments: (doc: PdfDocumentObject) => PdfTask<PdfAttachmentObject[]>;
+    /**
+     * Add a attachment to the file
+    /**
+     * @param doc - pdf document
+     * @param attachment - pdf attachment
+     * @returns task that contains the attachment or error
+     */
+    addAttachment: (doc: PdfDocumentObject, params: PdfAddAttachmentParams) => PdfTask<boolean>;
+    /**
+     * Remove a attachment from the file
+    /**
+     * @param doc - pdf document
+     * @param attachment - pdf attachment
+     * @returns task that contains the attachment or error
+     */
+    removeAttachment: (doc: PdfDocumentObject, attachment: PdfAttachmentObject) => PdfTask<boolean>;
     /**
      * Read content of pdf attachment
      * @param doc - pdf document

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embedpdf/models",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "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",
@@ -33,7 +33,7 @@
     "typescript": "^5.0.0",
     "@types/jest": "^29.5.14",
     "jest": "^29.7.0",
-    "@embedpdf/build": "1.0.0"
+    "@embedpdf/build": "1.0.1"
   },
   "publishConfig": {
     "access": "public"