@embedpdf/models 2.0.0-next.2 → 2.0.0

package/dist/logger.d.ts

@@ -147,6 +147,7 @@ export declare class LevelLogger implements Logger {
  * @public
  */
 export declare class PerfLogger implements Logger {
+    private marks;
     /**
      * create new PerfLogger
      */

package/dist/pdf.d.ts

@@ -352,6 +352,18 @@ export type PdfImage = {
     width: number;
     height: number;
 };
+/**
+ * Image data type that matches both browser's ImageData and plain objects.
+ * Used for raw rendering output that may include colorSpace from browser APIs.
+ *
+ * @public
+ */
+export type ImageDataLike = {
+    data: Uint8ClampedArray<ArrayBuffer>;
+    width: number;
+    height: number;
+    colorSpace?: PredefinedColorSpace;
+};
 /**
  * Representation of pdf action
  *
@@ -1429,9 +1441,9 @@ export interface PdfPathObject {
 export interface PdfImageObject {
     type: PdfPageObjectType.IMAGE;
     /**
-     * data of the image
+     * data of the image (cross-platform compatible, works in Node.js and browsers)
      */
-    imageData: ImageData;
+    imageData: ImageDataLike;
     /**
      * transform matrix
      */
@@ -2051,7 +2063,7 @@ export interface PdfFileLoader extends PdfFileWithoutContent {
 }
 export interface PdfAnnotationsProgress {
     page: number;
-    annotations: PdfAnnotationObject[];
+    result: PdfAnnotationObject[];
 }
 /**
  * Progress of search all pages
@@ -2299,11 +2311,6 @@ export interface PdfEngine<T = Blob> {
      * @returns support or not
      */
     isSupport?: (feature: PdfEngineFeature) => PdfTask<PdfEngineOperation[]>;
-    /**
-     * Initialize the engine
-     * @returns task that indicate whether initialization is successful
-     */
-    initialize?: () => PdfTask<boolean>;
     /**
      * Destroy the engine
      * @returns task that indicate whether destroy is successful
@@ -2598,6 +2605,74 @@ export interface PdfEngine<T = Blob> {
  * @public
  */
 export type PdfEngineMethodName = keyof Required<PdfEngine>;
+/**
+ * Progress info for batch operations
+ * Emitted per-page as the batch is processed
+ *
+ * @public
+ */
+export interface BatchProgress<T> {
+    /** Index of the page that was just processed */
+    pageIndex: number;
+    /** Result for this page */
+    result: T;
+    /** Number of pages completed so far */
+    completed: number;
+    /** Total number of pages in this batch */
+    total: number;
+}
+/**
+ * Executor interface for PDFium implementations.
+ * Can be either PdfiumNative (direct) or RemoteExecutor (worker proxy).
+ *
+ * @public
+ */
+export interface IPdfiumExecutor {
+    destroy(): void;
+    openDocumentBuffer(file: PdfFile, options?: PdfOpenDocumentBufferOptions): PdfTask<PdfDocumentObject>;
+    getMetadata(doc: PdfDocumentObject): PdfTask<PdfMetadataObject>;
+    setMetadata(doc: PdfDocumentObject, metadata: Partial<PdfMetadataObject>): PdfTask<boolean>;
+    getDocPermissions(doc: PdfDocumentObject): PdfTask<number>;
+    getDocUserPermissions(doc: PdfDocumentObject): PdfTask<number>;
+    getSignatures(doc: PdfDocumentObject): PdfTask<PdfSignatureObject[]>;
+    getBookmarks(doc: PdfDocumentObject): PdfTask<PdfBookmarksObject>;
+    setBookmarks(doc: PdfDocumentObject, bookmarks: PdfBookmarkObject[]): PdfTask<boolean>;
+    deleteBookmarks(doc: PdfDocumentObject): PdfTask<boolean>;
+    renderPageRaw(doc: PdfDocumentObject, page: PdfPageObject, options?: PdfRenderPageOptions): PdfTask<ImageDataLike>;
+    renderPageRect(doc: PdfDocumentObject, page: PdfPageObject, rect: Rect, options?: PdfRenderPageOptions): PdfTask<ImageDataLike>;
+    renderThumbnailRaw(doc: PdfDocumentObject, page: PdfPageObject, options?: PdfRenderThumbnailOptions): PdfTask<ImageDataLike>;
+    renderPageAnnotationRaw(doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject, options?: PdfRenderPageAnnotationOptions): PdfTask<ImageDataLike>;
+    getPageAnnotationsRaw(doc: PdfDocumentObject, page: PdfPageObject): PdfTask<PdfAnnotationObject[]>;
+    getPageAnnotations(doc: PdfDocumentObject, page: PdfPageObject): PdfTask<PdfAnnotationObject[]>;
+    createPageAnnotation<A extends PdfAnnotationObject>(doc: PdfDocumentObject, page: PdfPageObject, annotation: A, context?: AnnotationCreateContext<A>): PdfTask<string>;
+    updatePageAnnotation(doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject): PdfTask<boolean>;
+    removePageAnnotation(doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfAnnotationObject): PdfTask<boolean>;
+    getPageTextRects(doc: PdfDocumentObject, page: PdfPageObject): PdfTask<PdfTextRectObject[]>;
+    searchInPage(doc: PdfDocumentObject, page: PdfPageObject, keyword: string, flags: number): PdfTask<SearchResult[]>;
+    getAnnotationsBatch(doc: PdfDocumentObject, pages: PdfPageObject[]): PdfTask<Record<number, PdfAnnotationObject[]>, BatchProgress<PdfAnnotationObject[]>>;
+    searchBatch(doc: PdfDocumentObject, pages: PdfPageObject[], keyword: string, flags: number): PdfTask<Record<number, SearchResult[]>, BatchProgress<SearchResult[]>>;
+    getAttachments(doc: PdfDocumentObject): PdfTask<PdfAttachmentObject[]>;
+    addAttachment(doc: PdfDocumentObject, params: PdfAddAttachmentParams): PdfTask<boolean>;
+    removeAttachment(doc: PdfDocumentObject, attachment: PdfAttachmentObject): PdfTask<boolean>;
+    readAttachmentContent(doc: PdfDocumentObject, attachment: PdfAttachmentObject): PdfTask<ArrayBuffer>;
+    setFormFieldValue(doc: PdfDocumentObject, page: PdfPageObject, annotation: PdfWidgetAnnoObject, value: FormFieldValue): PdfTask<boolean>;
+    flattenPage(doc: PdfDocumentObject, page: PdfPageObject, options?: PdfFlattenPageOptions): PdfTask<PdfPageFlattenResult>;
+    extractPages(doc: PdfDocumentObject, pageIndexes: number[]): PdfTask<ArrayBuffer>;
+    extractText(doc: PdfDocumentObject, pageIndexes: number[]): PdfTask<string>;
+    redactTextInRects(doc: PdfDocumentObject, page: PdfPageObject, rects: Rect[], options?: PdfRedactTextOptions): PdfTask<boolean>;
+    getTextSlices(doc: PdfDocumentObject, slices: PageTextSlice[]): PdfTask<string[]>;
+    getPageGlyphs(doc: PdfDocumentObject, page: PdfPageObject): PdfTask<PdfGlyphObject[]>;
+    getPageGeometry(doc: PdfDocumentObject, page: PdfPageObject): PdfTask<PdfPageGeometry>;
+    merge(files: PdfFile[]): PdfTask<PdfFile>;
+    mergePages(mergeConfigs: Array<{
+        docId: string;
+        pageIndices: number[];
+    }>): PdfTask<PdfFile>;
+    preparePrintDocument(doc: PdfDocumentObject, options?: PdfPrintOptions): PdfTask<ArrayBuffer>;
+    saveAsCopy(doc: PdfDocumentObject): PdfTask<ArrayBuffer>;
+    closeDocument(doc: PdfDocumentObject): PdfTask<boolean>;
+    closeAllDocuments(): PdfTask<boolean>;
+}
 /**
  * Arguments of PdfEngine method
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embedpdf/models",
-  "version": "2.0.0-next.2",
+  "version": "2.0.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",