@embedpdf/models 1.0.18 → 1.0.20

package/dist/pdf.d.ts

@@ -1928,17 +1928,6 @@ export interface PdfAnnotationTransformation {
      */
     scale: Size;
 }
-/**
- * Render options
- *
- * @public
- */
-export interface PdfRenderOptions {
-    /**
-     * Whether needs to render the page with annotations
-     */
-    withAnnotations: boolean;
-}
 /**
  * source can be byte array contains pdf content
  *
@@ -1988,7 +1977,7 @@ export interface PdfFileLoader extends PdfFileWithoutContent {
      */
     callback: (offset: number, length: number) => Uint8Array;
 }
-export interface PdfPageWithAnnotations {
+export interface PdfAnnotationsProgress {
     page: number;
     annotations: PdfAnnotationObject[];
 }
@@ -2015,10 +2004,6 @@ export interface PdfFile extends PdfFileWithoutContent {
 export interface PdfFileUrl extends PdfFileWithoutContent {
     url: string;
 }
-export interface PdfUrlOptions {
-    mode?: 'auto' | 'range-request' | 'full-fetch';
-    password?: string;
-}
 export declare enum PdfErrorCode {
     Ok = 0,//  #define FPDF_ERR_SUCCESS 0    // No error.
     Unknown = 1,// #define FPDF_ERR_UNKNOWN 1    // Unknown error.
@@ -2082,6 +2067,80 @@ export declare class PdfTaskHelper {
      */
     static abort<T = any, P = unknown>(reason: PdfErrorReason): Task<T, PdfErrorReason, P>;
 }
+export interface PdfOpenDocumentBufferOptions {
+    /**
+     * Password for the document
+     */
+    password?: string;
+}
+export interface PdfOpenDocumentUrlOptions {
+    /**
+     * Password for the document
+     */
+    password?: string;
+    /**
+     * Loading mode
+     */
+    mode?: 'auto' | 'range-request' | 'full-fetch';
+}
+export interface PdfRenderOptions {
+    /**
+     * Scale factor
+     */
+    scaleFactor?: number;
+    /**
+     * Rotation
+     */
+    rotation?: Rotation;
+    /**
+     * Device pixel ratio
+     */
+    dpr?: number;
+    /**
+     * Image type
+     */
+    imageType?: ImageConversionTypes;
+}
+export interface PdfRenderPageOptions extends PdfRenderOptions {
+    /**
+     * Whether to render annotations
+     */
+    withAnnotations?: boolean;
+}
+export interface PdfRenderPageAnnotationOptions extends PdfRenderOptions {
+    /**
+     * Appearance mode normal down or rollover
+     */
+    mode?: AppearanceMode;
+}
+export interface PdfRenderThumbnailOptions extends PdfRenderOptions {
+    /**
+     * Whether to render annotations
+     */
+    withAnnotations?: boolean;
+}
+export interface PdfSearchAllPagesOptions {
+    /**
+     * Search flags
+     */
+    flags?: MatchFlag[];
+}
+export interface PdfRedactTextOptions {
+    /**
+     * Whether to recurse forms
+     */
+    recurseForms?: boolean;
+    /**
+     * Whether to draw black boxes
+     */
+    drawBlackBoxes?: boolean;
+}
+export interface PdfFlattenPageOptions {
+    /**
+     * Flatten flag
+     */
+    flag?: PdfPageFlattenFlag;
+}
 /**
  * Pdf engine
  *
@@ -2110,21 +2169,14 @@ export interface PdfEngine<T = Blob> {
      * @param options - Additional options including mode (auto, range-request, full-fetch) and password
      * @returns Task that resolves with the PdfDocumentObject or an error
      */
-    openDocumentUrl: (file: PdfFileUrl, options?: PdfUrlOptions) => PdfTask<PdfDocumentObject>;
+    openDocumentUrl: (file: PdfFileUrl, options?: PdfOpenDocumentUrlOptions) => PdfTask<PdfDocumentObject>;
     /**
      * Open pdf document from buffer
      * @param file - pdf file
-     * @param password - protected password for this file
-     * @returns task that contains the file or error
-     */
-    openDocumentFromBuffer: (file: PdfFile, password: string) => PdfTask<PdfDocumentObject>;
-    /**
-     * Open pdf document from loader
-     * @param file - pdf file
-     * @param password - protected password for this file
+     * @param options - Additional options including password
      * @returns task that contains the file or error
      */
-    openDocumentFromLoader: (file: PdfFileLoader, password: string) => PdfTask<PdfDocumentObject>;
+    openDocumentBuffer: (file: PdfFile, options?: PdfOpenDocumentBufferOptions) => PdfTask<PdfDocumentObject>;
     /**
      * Get the metadata of the file
      * @param doc - pdf document
@@ -2159,25 +2211,27 @@ export interface PdfEngine<T = Blob> {
      * Render the specified pdf page
      * @param doc - pdf document
      * @param page - pdf page
-     * @param scaleFactor - factor of scaling
-     * @param rotation - rotated angle
-     * @param dpr - devicePixelRatio
      * @param options - render options
      * @returns task contains the rendered image or error
      */
-    renderPage: (doc: PdfDocumentObject, page: PdfPageObject, scaleFactor: number, rotation: Rotation, dpr: number, options: PdfRenderOptions, imageType?: ImageConversionTypes) => PdfTask<T>;
+    renderPage: (doc: PdfDocumentObject, page: PdfPageObject, options?: PdfRenderPageOptions) => PdfTask<T>;
     /**
      * Render the specified rect of pdf page
      * @param doc - pdf document
      * @param page - pdf page
-     * @param scaleFactor - factor of scaling
-     * @param rotation - rotated angle
-     * @param dpr - devicePixelRatio
      * @param rect - target rect
      * @param options - render options
      * @returns task contains the rendered image or error
      */
-    renderPageRect: (doc: PdfDocumentObject, page: PdfPageObject, scaleFactor: number, rotation: Rotation, dpr: number, rect: Rect, options: PdfRenderOptions, imageType?: ImageConversionTypes) => PdfTask<T>;
+    renderPageRect: (doc: PdfDocumentObject, page: PdfPageObject, rect: Rect, options?: PdfRenderPageOptions) => PdfTask<T>;
+    /**
+     * Render the thumbnail of specified pdf page
+     * @param doc - pdf document
+     * @param page - pdf page
+     * @param options - render options
+     * @returns task contains the rendered image or error
+     */
+    renderThumbnail: (doc: PdfDocumentObject, page: PdfPageObject, options?: PdfRenderThumbnailOptions) => PdfTask<T>;
     /**
      * Render a single annotation into an ImageData blob.
      *
@@ -2186,18 +2240,13 @@ export interface PdfEngine<T = Blob> {
      * @param doc - pdf document
      * @param page - pdf page
      * @param annotation - the annotation to render
-     * @param scaleFactor - factor of scaling
-     * @param rotation - rotated angle
-     * @param dpr - devicePixelRatio
-     * @param mode - appearance mode
+     * @param options - render options
      */
-    renderAnnotation(doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject, scaleFactor: number, rotation: Rotation, dpr: number, mode: AppearanceMode, imageType: ImageConversionTypes): PdfTask<T>;
+    renderPageAnnotation(doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject, options?: PdfRenderPageAnnotationOptions): PdfTask<T>;
     /**
      * Get annotations of pdf page
      * @param doc - pdf document
      * @param page - pdf page
-     * @param scaleFactor - factor of scaling
-     * @param rotation - rotated angle
      * @returns task contains the annotations or error
      */
     getPageAnnotations: (doc: PdfDocumentObject, page: PdfPageObject) => PdfTask<PdfAnnotationObject[]>;
@@ -2206,9 +2255,10 @@ export interface PdfEngine<T = Blob> {
      * @param doc - pdf document
      * @param page - pdf page
      * @param annotation - new annotations
+     * @param context - context of the annotation
      * @returns task whether the annotations is created successfully
      */
-    createPageAnnotation: <A extends PdfAnnotationObject>(doc: PdfDocumentObject, page: PdfPageObject, annotation: A, context?: AnnotationCreateContext<A>) => PdfTask<number>;
+    createPageAnnotation: <A extends PdfAnnotationObject>(doc: PdfDocumentObject, page: PdfPageObject, annotation: A, context?: AnnotationCreateContext<A>) => PdfTask<string>;
     /**
      * Update a annotation on specified page
      * @param doc - pdf document
@@ -2229,36 +2279,24 @@ export interface PdfEngine<T = Blob> {
      * get all text rects in pdf page
      * @param doc - pdf document
      * @param page - pdf page
-     * @param scaleFactor - factor of scaling
-     * @param rotation - rotated angle
+     * @param options - get page text rects options
      * @returns task contains the text rects or error
      */
-    getPageTextRects: (doc: PdfDocumentObject, page: PdfPageObject, scaleFactor: number, rotation: Rotation) => PdfTask<PdfTextRectObject[]>;
-    /**
-     * Render the thumbnail of specified pdf page
-     * @param doc - pdf document
-     * @param page - pdf page
-     * @param scaleFactor - factor of scaling
-     * @param rotation - rotated angle
-     * @param dpr - devicePixelRatio
-     * @param options - render options
-     * @returns task contains the rendered image or error
-     */
-    renderThumbnail: (doc: PdfDocumentObject, page: PdfPageObject, scaleFactor: number, rotation: Rotation, dpr: number) => PdfTask<T>;
+    getPageTextRects: (doc: PdfDocumentObject, page: PdfPageObject) => PdfTask<PdfTextRectObject[]>;
     /**
      * Search across all pages in the document
      * @param doc - pdf document
      * @param keyword - search keyword
-     * @param flags - match flags for search
+     * @param options - search all pages options
      * @returns Task contains all search results throughout the document
      */
-    searchAllPages: (doc: PdfDocumentObject, keyword: string, flags?: MatchFlag[]) => PdfTask<SearchAllPagesResult, PdfPageSearchProgress>;
+    searchAllPages: (doc: PdfDocumentObject, keyword: string, options?: PdfSearchAllPagesOptions) => PdfTask<SearchAllPagesResult, PdfPageSearchProgress>;
     /**
      * Get all annotations in this file
      * @param doc - pdf document
      * @returns task that contains the annotations or error
      */
-    getAllAnnotations: (doc: PdfDocumentObject) => PdfTask<Record<number, PdfAnnotationObject[]>, PdfPageWithAnnotations>;
+    getAllAnnotations: (doc: PdfDocumentObject) => PdfTask<Record<number, PdfAnnotationObject[]>, PdfAnnotationsProgress>;
     /**
      * Get all attachments in this file
      * @param doc - pdf document
@@ -2284,9 +2322,9 @@ export interface PdfEngine<T = Blob> {
      * Flatten annotations and form fields into the page contents.
      * @param doc - pdf document
      * @param page - pdf page
-     * @param flag - flatten flag
+     * @param options - flatten page options
      */
-    flattenPage: (doc: PdfDocumentObject, page: PdfPageObject, flag: PdfPageFlattenFlag) => PdfTask<PdfPageFlattenResult>;
+    flattenPage: (doc: PdfDocumentObject, page: PdfPageObject, options?: PdfFlattenPageOptions) => PdfTask<PdfPageFlattenResult>;
     /**
      * Extract pdf pages to a new file
      * @param doc - pdf document
@@ -2304,10 +2342,12 @@ export interface PdfEngine<T = Blob> {
     /**
      * Redact text by run slices
      * @param doc - pdf document
-     * @param perPage - per page run slices
+     * @param page - pdf page
+     * @param rects - rects to redact
+     * @param options - redact text options
      * @returns task contains the result
      */
-    redactTextInRects: (doc: PdfDocumentObject, page: PdfPageObject, rects: Rect[], recurseForms: boolean, drawBlackBoxes: boolean) => PdfTask<boolean>;
+    redactTextInRects: (doc: PdfDocumentObject, page: PdfPageObject, rects: Rect[], options?: PdfRedactTextOptions) => PdfTask<boolean>;
     /**
      * Extract text on specified pdf pages
      * @param doc - pdf document

package/package.json

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