unpdf 1.3.2 → 1.5.0

package/dist/types/src/display/annotation_layer.d.ts

@@ -1,15 +1,16 @@
 export type PDFPageProxy = import("./api").PDFPageProxy;
 export type PageViewport = import("./display_utils").PageViewport;
 export type TextAccessibilityManager = import("../../web/text_accessibility.js").TextAccessibilityManager;
-export type IDownloadManager = import("../../web/interfaces").IDownloadManager;
-export type IPDFLinkService = import("../../web/interfaces").IPDFLinkService;
 export type AnnotationEditorUIManager = any;
 export type StructTreeLayerBuilder = import("../../web/struct_tree_layer_builder.js").StructTreeLayerBuilder;
+export type CommentManager = import("../../web/comment_manager.js").CommentManager;
+export type PDFLinkService = import("../../web/pdf_link_service.js").PDFLinkService;
+export type BaseDownloadManager = import("../../web/base_download_manager.js").BaseDownloadManager;
 export type AnnotationElementParameters = {
     data: Object;
     layer: HTMLDivElement;
-    linkService: IPDFLinkService;
-    downloadManager?: import("../../web/interfaces").IDownloadManager | undefined;
+    linkService: PDFLinkService;
+    downloadManager?: import("../../web/base_download_manager.js").BaseDownloadManager | undefined;
     annotationStorage?: AnnotationStorage | undefined;
     /**
      * - Path for image resources, mainly
@@ -27,8 +28,8 @@ export type AnnotationLayerParameters = {
     div: HTMLDivElement;
     annotations: any[];
     page: PDFPageProxy;
-    linkService: IPDFLinkService;
-    downloadManager?: import("../../web/interfaces").IDownloadManager | undefined;
+    linkService: PDFLinkService;
+    downloadManager?: import("../../web/base_download_manager.js").BaseDownloadManager | undefined;
     annotationStorage?: AnnotationStorage | undefined;
     /**
      * - Path for image resources, mainly
@@ -52,6 +53,10 @@ export type AnnotationLayerParameters = {
     accessibilityManager?: import("../../web/text_accessibility.js").TextAccessibilityManager | undefined;
     annotationEditorUIManager?: AnnotationEditorUIManager;
     structTreeLayer?: import("../../web/struct_tree_layer_builder.js").StructTreeLayerBuilder | undefined;
+    /**
+     * - The comment manager instance.
+     */
+    commentManager?: import("../../web/comment_manager.js").CommentManager | undefined;
 };
 /**
  * @typedef {Object} AnnotationLayerParameters
@@ -59,8 +64,8 @@ export type AnnotationLayerParameters = {
  * @property {HTMLDivElement} div
  * @property {Array} annotations
  * @property {PDFPageProxy} page
- * @property {IPDFLinkService} linkService
- * @property {IDownloadManager} [downloadManager]
+ * @property {PDFLinkService} linkService
+ * @property {BaseDownloadManager} [downloadManager]
  * @property {AnnotationStorage} [annotationStorage]
  * @property {string} [imageResourcesPath] - Path for image resources, mainly
  *   for annotation icons. Include trailing slash.
@@ -73,6 +78,7 @@ export type AnnotationLayerParameters = {
  * @property {TextAccessibilityManager} [accessibilityManager]
  * @property {AnnotationEditorUIManager} [annotationEditorUIManager]
  * @property {StructTreeLayerBuilder} [structTreeLayer]
+ * @property {CommentManager} [commentManager] - The comment manager instance.
  */
 /**
  * Manage the layer containing all the annotations.
@@ -82,7 +88,7 @@ export class AnnotationLayer {
      * @private
      */
     private static get _defaultBorderStyle();
-    constructor({ div, accessibilityManager, annotationCanvasMap, annotationEditorUIManager, page, viewport, structTreeLayer, }: {
+    constructor({ div, accessibilityManager, annotationCanvasMap, annotationEditorUIManager, page, viewport, structTreeLayer, commentManager, linkService, annotationStorage, }: {
         div: any;
         accessibilityManager: any;
         annotationCanvasMap: any;
@@ -90,12 +96,16 @@ export class AnnotationLayer {
         page: any;
         viewport: any;
         structTreeLayer: any;
+        commentManager: any;
+        linkService: any;
+        annotationStorage: any;
     });
     div: any;
     page: any;
     viewport: any;
     zIndex: number;
     _annotationEditorUIManager: any;
+    _commentManager: any;
     popupShow: any[] | undefined;
     hasEditableAnnotations(): boolean;
     /**
@@ -109,10 +119,8 @@ export class AnnotationLayer {
      * Add link annotations to the annotation layer.
      *
      * @param {Array<Object>} annotations
-     * @param {IPDFLinkService} linkService
-     * @memberof AnnotationLayer
      */
-    addLinkAnnotations(annotations: Array<Object>, linkService: IPDFLinkService): Promise<void>;
+    addLinkAnnotations(annotations: Array<Object>): Promise<void>;
     /**
      * Update the annotation elements on existing annotation layer.
      *
@@ -120,8 +128,12 @@ export class AnnotationLayer {
      * @memberof AnnotationLayer
      */
     update({ viewport }: AnnotationLayerParameters): void;
-    getEditableAnnotations(): any[];
+    getEditableAnnotations(): MapIterator<any>;
     getEditableAnnotation(id: any): any;
+    addFakeAnnotation(editor: any): EditorAnnotationElement;
+    removeAnnotation(id: any): void;
+    updateFakeAnnotations(editors: any): void;
+    togglePointerEvents(enabled?: boolean): void;
     #private;
 }
 export class FreeTextAnnotationElement extends AnnotationElement {
@@ -151,6 +163,13 @@ export class StampAnnotationElement extends AnnotationElement {
     render(): HTMLElement | undefined;
 }
 import { AnnotationStorage } from "./annotation_storage.js";
+declare class EditorAnnotationElement extends AnnotationElement {
+    constructor(parameters: any);
+    editor: any;
+    render(): HTMLElement | undefined;
+    createOrUpdatePopup(): void;
+    remove(): void;
+}
 declare class AnnotationElement {
     static _hasPopupData({ contentsObj, richText }: {
         contentsObj: any;
@@ -175,15 +194,20 @@ declare class AnnotationElement {
     hasJSActions: any;
     _fieldObjects: any;
     parent: any;
+    hasOwnCommentButton: boolean;
+    contentElement: HTMLElement | undefined;
     container: HTMLElement | undefined;
     get _isEditable(): any;
-    get hasPopupData(): boolean;
+    get hasPopupData(): any;
+    get commentData(): any;
     get hasCommentButton(): any;
-    get commentButtonPosition(): any[] | null;
-    get commentButtonColor(): string | null;
+    get commentButtonPosition(): any;
     _normalizePoint(point: any): any;
-    updateEdited(params: any): void;
+    set commentText(text: any);
+    get commentText(): any;
+    removePopup(): void;
     popup: any;
+    updateEdited(params: any): void;
     resetEdited(): void;
     /**
      * Create an empty container for the annotation's HTML element.
@@ -217,6 +241,7 @@ declare class AnnotationElement {
      */
     private _createPopup;
     get hasPopupElement(): boolean;
+    get extraPopupElement(): null;
     /**
      * Render the annotation's HTML element(s).
      *

package/dist/types/src/display/annotation_storage.d.ts

@@ -2,9 +2,9 @@
  * Key/value storage for annotation data in forms.
  */
 export class AnnotationStorage {
-    onSetModified: any;
-    onResetModified: any;
-    onAnnotationEditor: any;
+    onSetModified: null;
+    onResetModified: null;
+    onAnnotationEditor: null;
     /**
      * Get the value for a given key if it exists, or return the default value.
      * @param {string} key
@@ -56,6 +56,8 @@ export class AnnotationStorage {
     };
     get editorStats(): any;
     resetModifiedIds(): void;
+    updateEditor(annotationId: any, data: any): boolean;
+    getEditor(annotationId: any): any;
     /**
      * @returns {{ids: Set<string>, hash: string}}
      */
@@ -77,11 +79,11 @@ export class PrintAnnotationStorage extends AnnotationStorage {
      * PLEASE NOTE: Only intended for usage within the API itself.
      * @ignore
      */
-    get serializable(): {
-        map: any;
-        hash: any;
-        transfer: any;
-    };
+    get serializable(): Readonly<{
+        map: null;
+        hash: "";
+        transfer: undefined;
+    }>;
     get modifiedIds(): any;
     #private;
 }

package/dist/types/src/display/api.d.ts

@@ -36,11 +36,6 @@ export type DocumentInitParameters = {
      * - For decrypting password-protected PDFs.
      */
     password?: string | undefined;
-    /**
-     * - The PDF file length. It's used for progress
-     * reports and range requests operations.
-     */
-    length?: number | undefined;
     /**
      * - Allows for using a custom range
      * transport implementation.
@@ -77,12 +72,6 @@ export type DocumentInitParameters = {
      * packed or not. The default value is `true`.
      */
     cMapPacked?: boolean | undefined;
-    /**
-     * - The factory that will be used when
-     * reading built-in CMap files.
-     * The default value is {DOMCMapReaderFactory}.
-     */
-    CMapReaderFactory?: Object | undefined;
     /**
      * - The URL where the predefined ICC profiles are
      * located. Include the trailing slash.
@@ -101,28 +90,15 @@ export type DocumentInitParameters = {
      * files are located. Include the trailing slash.
      */
     standardFontDataUrl?: string | undefined;
-    /**
-     * - The factory that will be used
-     * when reading the standard font files.
-     * The default value is {DOMStandardFontDataFactory}.
-     */
-    StandardFontDataFactory?: Object | undefined;
     /**
      * - The URL where the wasm files are located.
      * Include the trailing slash.
      */
     wasmUrl?: string | undefined;
-    /**
-     * - The factory that will be used
-     * when reading the wasm files.
-     * The default value is {DOMWasmFactory}.
-     */
-    WasmFactory?: Object | undefined;
     /**
      * - Enable using the Fetch API in the
-     * worker-thread when reading CMap and standard font files. When `true`,
-     * the `CMapReaderFactory`, `StandardFontDataFactory`, and `WasmFactory`
-     * options are ignored.
+     * worker-thread when reading built-in CMap files, standard font files,
+     * and wasm files. If `true`, the `BinaryDataFactory` option is ignored.
      * The default value is `true` in web environments and `false` in Node.js.
      */
     useWorkerFetch?: boolean | undefined;
@@ -246,11 +222,24 @@ export type DocumentInitParameters = {
      * The default value is {DOMFilterFactory}.
      */
     FilterFactory?: Object | undefined;
+    /**
+     * - The factory that will be used when
+     * falling back to reading built-in CMap files, standard font files,
+     * and wasm files in the main-thread.
+     * The default value is {DOMBinaryDataFactory}.
+     */
+    BinaryDataFactory?: Object | undefined;
     /**
      * - Enables hardware acceleration for
      * rendering. The default value is `false`.
      */
     enableHWA?: boolean | undefined;
+    /**
+     * - The pages mapper that will be used to map
+     * page ids and page numbers. It's used when the page order is changed or some
+     * pages are removed, cloned, etc.
+     */
+    pagesMapper?: Object | undefined;
 };
 export type OnProgressParameters = {
     /**
@@ -261,6 +250,11 @@ export type OnProgressParameters = {
      * - Total number of bytes in the PDF file.
      */
     total: number;
+    /**
+     * - Currently loaded percentage, as an integer value
+     * in the [0, 100] range. If `total` is undefined, the percentage is `NaN`.
+     */
+    percent: number;
 };
 /**
  * Page getViewport parameters.
@@ -492,17 +486,22 @@ export type RenderParameters = {
      * - Render the page in editing mode.
      */
     isEditing?: boolean | undefined;
+    /**
+     * - Record the location of images in the PDF
+     */
+    recordImages?: boolean | undefined;
     /**
      * - Record the dependencies and bounding
      * boxes of all PDF operations that render onto the canvas.
      */
     recordOperations?: boolean | undefined;
     /**
-     * - If provided, only run
-     * the PDF operations that are included in this set.
+     * - If provided, only
+     * run for which this function returns `true`.
      */
-    filteredOperationIndexes?: Set<number> | undefined;
+    operationsFilter?: OperationsFilter | undefined;
 };
+export type OperationsFilter = (index: number) => boolean;
 /**
  * Page getOperatorList parameters.
  */
@@ -623,8 +622,6 @@ export const build: string;
  *   cross-site Access-Control requests should be made using credentials such
  *   as cookies or authorization headers. The default is `false`.
  * @property {string} [password] - For decrypting password-protected PDFs.
- * @property {number} [length] - The PDF file length. It's used for progress
- *   reports and range requests operations.
  * @property {PDFDataRangeTransport} [range] - Allows for using a custom range
  *   transport implementation.
  * @property {number} [rangeChunkSize] - Specify maximum number of bytes fetched
@@ -640,9 +637,6 @@ export const build: string;
  *   located. Include the trailing slash.
  * @property {boolean} [cMapPacked] - Specifies if the Adobe CMaps are binary
  *   packed or not. The default value is `true`.
- * @property {Object} [CMapReaderFactory] - The factory that will be used when
- *   reading built-in CMap files.
- *   The default value is {DOMCMapReaderFactory}.
  * @property {string} [iccUrl] - The URL where the predefined ICC profiles are
  *   located. Include the trailing slash.
  * @property {boolean} [useSystemFonts] - When `true`, fonts that aren't
@@ -652,18 +646,11 @@ export const build: string;
  *   regardless of the environment (to prevent completely broken fonts).
  * @property {string} [standardFontDataUrl] - The URL where the standard font
  *   files are located. Include the trailing slash.
- * @property {Object} [StandardFontDataFactory] - The factory that will be used
- *   when reading the standard font files.
- *   The default value is {DOMStandardFontDataFactory}.
  * @property {string} [wasmUrl] - The URL where the wasm files are located.
  *   Include the trailing slash.
- * @property {Object} [WasmFactory] - The factory that will be used
- *   when reading the wasm files.
- *   The default value is {DOMWasmFactory}.
  * @property {boolean} [useWorkerFetch] - Enable using the Fetch API in the
- *   worker-thread when reading CMap and standard font files. When `true`,
- *   the `CMapReaderFactory`, `StandardFontDataFactory`, and `WasmFactory`
- *   options are ignored.
+ *   worker-thread when reading built-in CMap files, standard font files,
+ *   and wasm files. If `true`, the `BinaryDataFactory` option is ignored.
  *   The default value is `true` in web environments and `false` in Node.js.
  * @property {boolean} [useWasm] - Attempt to use WebAssembly in order to
  *    improve e.g. image decoding performance.
@@ -735,8 +722,15 @@ export const build: string;
  * @property {Object} [FilterFactory] - The factory that will be used to
  *    create SVG filters when rendering some images on the main canvas.
  *    The default value is {DOMFilterFactory}.
+ * @property {Object} [BinaryDataFactory] - The factory that will be used when
+ *   falling back to reading built-in CMap files, standard font files,
+ *   and wasm files in the main-thread.
+ *   The default value is {DOMBinaryDataFactory}.
  * @property {boolean} [enableHWA] - Enables hardware acceleration for
  *   rendering. The default value is `false`.
+ * @property {Object} [pagesMapper] - The pages mapper that will be used to map
+ *   page ids and page numbers. It's used when the page order is changed or some
+ *   pages are removed, cloned, etc.
  */
 /**
  * This is the main entry point for loading a PDF and interacting with it.
@@ -774,10 +768,6 @@ export class PDFDataRangeTransport {
      * @param {function} listener
      */
     addRangeListener(listener: Function): void;
-    /**
-     * @param {function} listener
-     */
-    addProgressListener(listener: Function): void;
     /**
      * @param {function} listener
      */
@@ -791,11 +781,6 @@ export class PDFDataRangeTransport {
      * @param {Uint8Array|null} chunk
      */
     onDataRange(begin: number, chunk: Uint8Array | null): void;
-    /**
-     * @param {number} loaded
-     * @param {number|undefined} total
-     */
-    onDataProgress(loaded: number, total: number | undefined): void;
     /**
      * @param {Uint8Array|null} chunk
      */
@@ -814,6 +799,8 @@ export class PDFDataRangeTransport {
  * @typedef {Object} OnProgressParameters
  * @property {number} loaded - Currently loaded number of bytes.
  * @property {number} total - Total number of bytes in the PDF file.
+ * @property {number} percent - Currently loaded percentage, as an integer value
+ *   in the [0, 100] range. If `total` is undefined, the percentage is `NaN`.
  */
 /**
  * The loading task controls the operations required to load a PDF document
@@ -821,7 +808,7 @@ export class PDFDataRangeTransport {
  * after which individual pages can be rendered.
  */
 export class PDFDocumentLoadingTask {
-    static #docId: number;
+    static "__#private@#docId": number;
     /**
      * @private
      */
@@ -884,6 +871,10 @@ export class PDFDocumentProxy {
     constructor(pdfInfo: any, transport: any);
     _pdfInfo: any;
     _transport: any;
+    /**
+     * @type {PagesMapper} The pages mapper instance.
+     */
+    get pagesMapper(): PagesMapper;
     /**
      * @type {AnnotationStorage} Storage for annotation data in forms.
      */
@@ -1099,6 +1090,30 @@ export class PDFDocumentProxy {
      *   {Uint8Array} containing the full data of the saved document.
      */
     saveDocument(): Promise<Uint8Array>;
+    /**
+     * @typedef {Object} PageInfo
+     * @property {null|Uint8Array} document
+     * @property {Array<Array<number>|number>} [includePages]
+     *  included ranges or indices.
+     * @property {Array<Array<number>|number>} [excludePages]
+     *  excluded ranges or indices.
+     */
+    /**
+     * @param {Array<PageInfo>} pageInfos - The pages to extract.
+     * @returns {Promise<Uint8Array>} A promise that is resolved with a
+     *   {Uint8Array} containing the full data of the saved document.
+     */
+    extractPages(pageInfos: Array<{
+        document: null | Uint8Array;
+        /**
+         * included ranges or indices.
+         */
+        includePages?: (number | number[])[] | undefined;
+        /**
+         * excluded ranges or indices.
+         */
+        excludePages?: (number | number[])[] | undefined;
+    }>): Promise<Uint8Array>;
     /**
      * @returns {Promise<{ length: number }>} A promise that is resolved when the
      *   document's data is loaded. It is resolved with an {Object} that contains
@@ -1107,6 +1122,7 @@ export class PDFDocumentProxy {
     getDownloadInfo(): Promise<{
         length: number;
     }>;
+    getRawData(data: any): any;
     /**
      * Cleans up resources allocated by the document on both the main and worker
      * threads.
@@ -1282,10 +1298,16 @@ export class PDFDocumentProxy {
  *   annotation ids with canvases used to render them.
  * @property {PrintAnnotationStorage} [printAnnotationStorage]
  * @property {boolean} [isEditing] - Render the page in editing mode.
+ * @property {boolean} [recordImages] - Record the location of images in the PDF
  * @property {boolean} [recordOperations] - Record the dependencies and bounding
  *   boxes of all PDF operations that render onto the canvas.
- * @property {Set<number>} [filteredOperationIndexes] - If provided, only run
- *   the PDF operations that are included in this set.
+ * @property {OperationsFilter} [operationsFilter] - If provided, only
+ *   run for which this function returns `true`.
+ */
+/**
+ * @callback OperationsFilter
+ * @param {number} index - The index of the operation.
+ * @returns {boolean} If false, the operation is ignored.
  */
 /**
  * Page getOperatorList parameters.
@@ -1337,7 +1359,7 @@ export class PDFDocumentProxy {
  * Proxy to a `PDFPage` in the worker thread.
  */
 export class PDFPageProxy {
-    constructor(pageIndex: any, pageInfo: any, transport: any, pdfBug?: boolean);
+    constructor(pageIndex: any, pageInfo: any, transport: any, pagesMapper: any, pdfBug?: boolean);
     _pageIndex: any;
     _pageInfo: any;
     _transport: any;
@@ -1348,7 +1370,13 @@ export class PDFPageProxy {
     objs: PDFObjects;
     _intentStates: Map<any, any>;
     destroyed: boolean;
-    recordedGroups: any;
+    recordedBBoxes: any;
+    imageCoordinates: any;
+    clone(id: any): PDFPageProxy;
+    /**
+     * @param {number} value - The page number to set. First page is 1.
+     */
+    set pageNumber(value: number);
     /**
      * @type {number} Page number of the page. First page is 1.
      */
@@ -1409,7 +1437,7 @@ export class PDFPageProxy {
      * @returns {RenderTask} An object that contains a promise that is
      *   resolved when the page finishes rendering.
      */
-    render({ canvasContext, canvas, viewport, intent, annotationMode, transform, background, optionalContentConfigPromise, annotationCanvasMap, pageColors, printAnnotationStorage, isEditing, recordOperations, filteredOperationIndexes, }: RenderParameters): RenderTask;
+    render({ canvasContext, canvas, viewport, intent, annotationMode, transform, background, optionalContentConfigPromise, annotationCanvasMap, pageColors, printAnnotationStorage, isEditing, recordImages, recordOperations, operationsFilter, }: RenderParameters): RenderTask;
     /**
      * @param {GetOperatorListParameters} params - Page getOperatorList
      *   parameters.
@@ -1492,9 +1520,9 @@ export class PDFPageProxy {
  * @param {PDFWorkerParameters} params - The worker initialization parameters.
  */
 export class PDFWorker {
-    static #fakeWorkerId: number;
-    static #isWorkerDisabled: boolean;
-    static #workerPorts: WeakMap<object, any>;
+    static "__#private@#fakeWorkerId": number;
+    static "__#private@#isWorkerDisabled": boolean;
+    static "__#private@#workerPorts": WeakMap<object, any>;
     /**
      * @param {PDFWorkerParameters} params - The worker initialization parameters.
      * @returns {PDFWorker}
@@ -1505,7 +1533,7 @@ export class PDFWorker {
      * @type {string}
      */
     static get workerSrc(): string;
-    static get #mainThreadWorkerMessageHandler(): any;
+    static get "__#private@#mainThreadWorkerMessageHandler"(): any;
     static get _setupFakeWorkerGlobal(): any;
     constructor({ name, port, verbosity, }?: {
         name?: null | undefined;
@@ -1541,6 +1569,7 @@ export class PDFWorker {
  */
 export class RenderTask {
     constructor(internalRenderTask: any);
+    _internalRenderTask: null;
     /**
      * Callback for incremental rendering -- a function that will be called
      * each time the rendering is paused.  To continue rendering call the
@@ -1575,13 +1604,14 @@ export class RenderTask {
      * @type {boolean}
      */
     get separateAnnots(): boolean;
-    #private;
+    get imageCoordinates(): any;
 }
 /** @type {string} */
 export const version: string;
 import { PageViewport } from "./display_utils.js";
 import { OptionalContentConfig } from "./optional_content_config.js";
 import { PrintAnnotationStorage } from "./annotation_storage.js";
+import { PagesMapper } from "./pages_mapper.js";
 import { AnnotationStorage } from "./annotation_storage.js";
 import { Metadata } from "./metadata.js";
 import { StatTimer } from "./display_utils.js";

package/dist/types/src/display/api_utils.d.ts

@@ -1,6 +1,6 @@
 export function getDataProp(val: any): Uint8Array<any>;
 export function getFactoryUrlProp(val: any): string | null;
-export function getUrlProp(val: any): string | null;
+export function getUrlProp(val: any): URL | null;
 export function isNameProxy(v: any): boolean;
 export function isRefProxy(v: any): boolean;
 export const isValidExplicitDest: (dest?: any) => boolean;

package/dist/types/src/display/binary_data_factory.d.ts

@@ -0,0 +1,26 @@
+export class BaseBinaryDataFactory {
+    constructor({ cMapUrl, standardFontDataUrl, wasmUrl }: {
+        cMapUrl?: null | undefined;
+        standardFontDataUrl?: null | undefined;
+        wasmUrl?: null | undefined;
+    });
+    cMapUrl: any;
+    standardFontDataUrl: any;
+    wasmUrl: any;
+    fetch({ kind, filename }: {
+        kind: any;
+        filename: any;
+    }): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @ignore
+     * @returns {Promise<Uint8Array>}
+     */
+    _fetch(url: any, kind: any): Promise<Uint8Array>;
+    #private;
+}
+export class DOMBinaryDataFactory extends BaseBinaryDataFactory {
+    /**
+     * @ignore
+     */
+    _fetch(url: any, kind: any): Promise<Uint8Array<any>>;
+}