unpdf 0.10.0 → 0.11.0

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

@@ -3,6 +3,7 @@ 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 AnnotationElementParameters = {
     data: Object;
     layer: HTMLDivElement;
@@ -26,7 +27,7 @@ export type AnnotationLayerParameters = {
     annotations: any[];
     page: PDFPageProxy;
     linkService: IPDFLinkService;
-    downloadManager: IDownloadManager;
+    downloadManager?: import("../../web/interfaces").IDownloadManager | undefined;
     annotationStorage?: AnnotationStorage | undefined;
     /**
      * - Path for image resources, mainly
@@ -48,6 +49,7 @@ export type AnnotationLayerParameters = {
     } | null | undefined;
     annotationCanvasMap?: Map<string, HTMLCanvasElement> | undefined;
     accessibilityManager?: import("../../web/text_accessibility.js").TextAccessibilityManager | undefined;
+    annotationEditorUIManager?: any;
 };
 /**
  * @typedef {Object} AnnotationLayerParameters
@@ -56,7 +58,7 @@ export type AnnotationLayerParameters = {
  * @property {Array} annotations
  * @property {PDFPageProxy} page
  * @property {IPDFLinkService} linkService
- * @property {IDownloadManager} downloadManager
+ * @property {IDownloadManager} [downloadManager]
  * @property {AnnotationStorage} [annotationStorage]
  * @property {string} [imageResourcesPath] - Path for image resources, mainly
  *   for annotation icons. Include trailing slash.
@@ -67,15 +69,17 @@ export type AnnotationLayerParameters = {
  * @property {Object<string, Array<Object>> | null} [fieldObjects]
  * @property {Map<string, HTMLCanvasElement>} [annotationCanvasMap]
  * @property {TextAccessibilityManager} [accessibilityManager]
+ * @property {AnnotationEditorUIManager} [annotationEditorUIManager]
  */
 /**
  * Manage the layer containing all the annotations.
  */
 export class AnnotationLayer {
-    constructor({ div, accessibilityManager, annotationCanvasMap, page, viewport, }: {
+    constructor({ div, accessibilityManager, annotationCanvasMap, annotationEditorUIManager, page, viewport, }: {
         div: any;
         accessibilityManager: any;
         annotationCanvasMap: any;
+        annotationEditorUIManager: any;
         page: any;
         viewport: any;
     });
@@ -83,6 +87,7 @@ export class AnnotationLayer {
     page: any;
     viewport: any;
     zIndex: number;
+    _annotationEditorUIManager: any;
     popupShow: any[] | undefined;
     /**
      * Render a new annotation layer with all annotation elements.
@@ -150,6 +155,8 @@ declare class AnnotationElement {
     parent: any;
     container: HTMLElement | undefined;
     get hasPopupData(): boolean;
+    updateEdited(params: any): void;
+    resetEdited(): void;
     /**
      * Create an empty container for the annotation's HTML element.
      *

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

@@ -62,6 +62,7 @@ export class AnnotationStorage {
         hash: string;
         transfer: any[];
     };
+    get editorStats(): any;
     #private;
 }
 /**

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

@@ -1,5 +1,4 @@
 export type TypedArray = Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array;
-export type BinaryData = TypedArray | ArrayBuffer | Array<number> | string;
 export type RefProxy = {
     num: number;
     gen: number;
@@ -13,7 +12,8 @@ export type DocumentInitParameters = {
      */
     url?: string | URL | undefined;
     /**
-     * - Binary PDF data.
+     * -
+     * Binary PDF data.
      * Use TypedArrays (Uint8Array) to improve the memory usage. If PDF data is
      * BASE64-encoded, use `atob()` to convert it to a binary string first.
      *
@@ -21,7 +21,7 @@ export type DocumentInitParameters = {
      * worker-thread. This will help reduce main-thread memory usage, however
      * it will take ownership of the TypedArrays.
      */
-    data?: BinaryData | undefined;
+    data?: string | number[] | ArrayBuffer | TypedArray | undefined;
     /**
      * - Basic authentication headers.
      */
@@ -126,8 +126,8 @@ export type DocumentInitParameters = {
     maxImageSize?: number | undefined;
     /**
      * - Determines if we can evaluate strings
-     * as JavaScript. Primarily used to improve performance of font rendering, and
-     * when parsing PDF functions. The default value is `true`.
+     * as JavaScript. Primarily used to improve performance of PDF functions.
+     * The default value is `true`.
      */
     isEvalSupported?: boolean | undefined;
     /**
@@ -279,6 +279,10 @@ export type TextContent = {
     styles: {
         [x: string]: TextStyle;
     };
+    /**
+     * - The document /Lang attribute.
+     */
+    lang: string | null;
 };
 /**
  * Page text content part.
@@ -519,9 +523,9 @@ export type PDFWorkerParameters = {
 /** @type {string} */
 export const build: string;
 export const DefaultCanvasFactory: typeof DOMCanvasFactory | typeof NodeCanvasFactory;
-export const DefaultCMapReaderFactory: typeof DOMCMapReaderFactory;
+export const DefaultCMapReaderFactory: typeof NodeCMapReaderFactory;
 export const DefaultFilterFactory: typeof DOMFilterFactory | typeof NodeFilterFactory;
-export const DefaultStandardFontDataFactory: typeof DOMStandardFontDataFactory;
+export const DefaultStandardFontDataFactory: typeof NodeStandardFontDataFactory;
 /**
  * @typedef { Int8Array | Uint8Array | Uint8ClampedArray |
  *            Int16Array | Uint16Array |
@@ -529,9 +533,6 @@ export const DefaultStandardFontDataFactory: typeof DOMStandardFontDataFactory;
  *            Float64Array
  * } TypedArray
  */
-/**
- * @typedef { TypedArray | ArrayBuffer | Array<number> | string } BinaryData
- */
 /**
  * @typedef {Object} RefProxy
  * @property {number} num
@@ -542,7 +543,8 @@ export const DefaultStandardFontDataFactory: typeof DOMStandardFontDataFactory;
  *
  * @typedef {Object} DocumentInitParameters
  * @property {string | URL} [url] - The URL of the PDF.
- * @property {BinaryData} [data] - Binary PDF data.
+ * @property {TypedArray | ArrayBuffer | Array<number> | string} [data] -
+ *   Binary PDF data.
  *   Use TypedArrays (Uint8Array) to improve the memory usage. If PDF data is
  *   BASE64-encoded, use `atob()` to convert it to a binary string first.
  *
@@ -598,8 +600,8 @@ export const DefaultStandardFontDataFactory: typeof DOMStandardFontDataFactory;
  *   pixels, i.e. width * height. Images above this value will not be rendered.
  *   Use -1 for no limit, which is also the default value.
  * @property {boolean} [isEvalSupported] - Determines if we can evaluate strings
- *   as JavaScript. Primarily used to improve performance of font rendering, and
- *   when parsing PDF functions. The default value is `true`.
+ *   as JavaScript. Primarily used to improve performance of PDF functions.
+ *   The default value is `true`.
  * @property {boolean} [isOffscreenCanvasSupported] - Determines if we can use
  *   `OffscreenCanvas` in the worker. Primarily used to improve performance of
  *   image conversion/rendering.
@@ -685,7 +687,7 @@ export class PDFDataRangeTransport {
     _progressListeners: any[];
     _progressiveReadListeners: any[];
     _progressiveDoneListeners: any[];
-    _readyCapability: PromiseCapability;
+    _readyCapability: any;
     /**
      * @param {function} listener
      */
@@ -736,8 +738,8 @@ export class PDFDataRangeTransport {
  * after which individual pages can be rendered.
  */
 export class PDFDocumentLoadingTask {
-    static "__#33@#docId": number;
-    _capability: PromiseCapability;
+    static "__#45@#docId": number;
+    _capability: any;
     _transport: any;
     _worker: any;
     /**
@@ -917,11 +919,32 @@ export class PDFDocumentProxy {
         items: any[];
     }[]>;
     /**
+     * @typedef {Object} GetOptionalContentConfigParameters
+     * @property {string} [intent] - Determines the optional content groups that
+     *   are visible by default; valid values are:
+     *    - 'display' (viewable groups).
+     *    - 'print' (printable groups).
+     *    - 'any' (all groups).
+     *   The default value is 'display'.
+     */
+    /**
+     * @param {GetOptionalContentConfigParameters} [params] - Optional content
+     *   config parameters.
      * @returns {Promise<OptionalContentConfig>} A promise that is resolved with
      *   an {@link OptionalContentConfig} that contains all the optional content
      *   groups (assuming that the document has any).
      */
-    getOptionalContentConfig(): Promise<OptionalContentConfig>;
+    getOptionalContentConfig({ intent }?: {
+        /**
+         * - Determines the optional content groups that
+         * are visible by default; valid values are:
+         * - 'display' (viewable groups).
+         * - 'print' (printable groups).
+         * - 'any' (all groups).
+         * The default value is 'display'.
+         */
+        intent?: string | undefined;
+    } | undefined): Promise<OptionalContentConfig>;
     /**
      * @returns {Promise<Array<number> | null>} A promise that is resolved with
      *   an {Array} that contains the permission flags for the PDF document, or
@@ -991,6 +1014,11 @@ export class PDFDocumentProxy {
      * Destroys the current document instance and terminates the worker.
      */
     destroy(): Promise<void>;
+    /**
+     * @param {RefProxy} ref - The page reference.
+     * @returns {number | null} The page number, if it's cached.
+     */
+    cachedPageNumber(ref: RefProxy): number | null;
     /**
      * @type {DocumentInitParameters} A subset of the current
      *   {DocumentInitParameters}, which are needed in the viewer.
@@ -1052,6 +1080,7 @@ export class PDFDocumentProxy {
  *   items are included when includeMarkedContent is true.
  * @property {Object<string, TextStyle>} styles - {@link TextStyle} objects,
  *   indexed by font name.
+ * @property {string | null} lang - The document /Lang attribute.
  */
 /**
  * Page text content part.
@@ -1226,11 +1255,11 @@ export class PDFPageProxy {
      */
     getViewport({ scale, rotation, offsetX, offsetY, dontFlip, }?: GetViewportParameters): PageViewport;
     /**
-     * @param {GetAnnotationsParameters} params - Annotation parameters.
+     * @param {GetAnnotationsParameters} [params] - Annotation parameters.
      * @returns {Promise<Array<any>>} A promise that is resolved with an
      *   {Array} of the annotation objects.
      */
-    getAnnotations({ intent }?: GetAnnotationsParameters): Promise<Array<any>>;
+    getAnnotations({ intent }?: GetAnnotationsParameters | undefined): Promise<Array<any>>;
     /**
      * @returns {Promise<Object>} A promise that is resolved with an
      *   {Object} with JS actions.
@@ -1334,7 +1363,7 @@ export class PDFPageProxy {
  * @param {PDFWorkerParameters} params - The worker initialization parameters.
  */
 export class PDFWorker {
-    static "__#36@#workerPorts": any;
+    static "__#48@#workerPorts": any;
     /**
      * @param {PDFWorkerParameters} params - The worker initialization parameters.
      */
@@ -1344,7 +1373,7 @@ export class PDFWorker {
      * @type {string}
      */
     static get workerSrc(): string;
-    static get "__#36@#mainThreadWorkerMessageHandler"(): any;
+    static get "__#48@#mainThreadWorkerMessageHandler"(): any;
     static get _setupFakeWorkerGlobal(): any;
     constructor({ name, port, verbosity, }?: {
         name?: null | undefined;
@@ -1354,7 +1383,7 @@ export class PDFWorker {
     name: any;
     destroyed: boolean;
     verbosity: number;
-    _readyCapability: PromiseCapability;
+    _readyCapability: any;
     _port: any;
     _webWorker: Worker | null;
     _messageHandler: MessageHandler | null;
@@ -1424,13 +1453,11 @@ import { OptionalContentConfig } from "./optional_content_config.js";
 import { PrintAnnotationStorage } from "./annotation_storage.js";
 import { DOMCanvasFactory } from "./display_utils.js";
 import { NodeCanvasFactory } from "./node_utils";
-import { DOMCMapReaderFactory } from "./display_utils.js";
+import { NodeCMapReaderFactory } from "./node_utils";
 import { DOMFilterFactory } from "./display_utils.js";
 import { NodeFilterFactory } from "./node_utils";
-import { DOMStandardFontDataFactory } from "./display_utils.js";
-import { PromiseCapability } from "../shared/util.js";
+import { NodeStandardFontDataFactory } from "./node_utils";
 import { AnnotationStorage } from "./annotation_storage.js";
-import { info } from "../shared/util.js";
 import { Metadata } from "./metadata.js";
 import { StatTimer } from "./display_utils.js";
 /**
@@ -1465,6 +1492,7 @@ declare class PDFObjects {
      */
     resolve(objId: string, data?: any): void;
     clear(): void;
+    [Symbol.iterator](): Generator<any[], void, unknown>;
     #private;
 }
 import { MessageHandler } from "../shared/message_handler.js";

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

@@ -28,7 +28,9 @@ export class BaseCMapReaderFactory {
 export class BaseFilterFactory {
     addFilter(maps: any): string;
     addHCMFilter(fgColor: any, bgColor: any): string;
-    addHighlightHCMFilter(fgColor: any, bgColor: any, newFgColor: any, newBgColor: any): string;
+    addAlphaFilter(map: any): string;
+    addLuminosityFilter(map: any): string;
+    addHighlightHCMFilter(filterName: any, fgColor: any, bgColor: any, newFgColor: any, newBgColor: any): string;
     destroy(keepHCM?: boolean): void;
 }
 export class BaseStandardFontDataFactory {

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

@@ -79,6 +79,8 @@ export class CanvasGraphics {
     beginSMaskMode(): void;
     endSMaskMode(): void;
     compose(dirtyBox: any): void;
+    composeSMask(ctx: any, smask: any, layerCtx: any, layerBox: any): void;
+    genericComposeSMask(maskCtx: any, layerCtx: any, width: any, height: any, subtype: any, backdrop: any, transferMap: any, layerOffsetX: any, layerOffsetY: any, maskOffsetX: any, maskOffsetY: any): void;
     save(): void;
     restore(): void;
     transform(a: any, b: any, c: any, d: any, e: any, f: any): void;

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

@@ -71,7 +71,7 @@ export class DOMCMapReaderFactory extends BaseCMapReaderFactory {
      * @ignore
      */
     _fetchData(url: any, compressionType: any): Promise<{
-        cMapData: any;
+        cMapData: Uint8Array;
         compressionType: any;
     }>;
 }
@@ -91,14 +91,16 @@ export class DOMFilterFactory extends BaseFilterFactory {
     });
     addFilter(maps: any): any;
     addHCMFilter(fgColor: any, bgColor: any): any;
-    addHighlightHCMFilter(fgColor: any, bgColor: any, newFgColor: any, newBgColor: any): any;
+    addAlphaFilter(map: any): any;
+    addLuminosityFilter(map: any): any;
+    addHighlightHCMFilter(filterName: any, fgColor: any, bgColor: any, newFgColor: any, newBgColor: any): any;
     #private;
 }
 export class DOMStandardFontDataFactory extends BaseStandardFontDataFactory {
     /**
      * @ignore
      */
-    _fetchData(url: any): Promise<any>;
+    _fetchData(url: any): Promise<Uint8Array>;
 }
 export class DOMSVGFactory extends BaseSVGFactory {
     /**
@@ -106,16 +108,16 @@ export class DOMSVGFactory extends BaseSVGFactory {
      */
     _createSVG(type: any): any;
 }
+export function fetchData(url: any, type?: string): Promise<any>;
 export function getColorValues(colors: any): void;
 export function getCurrentTransform(ctx: any): any[];
 export function getCurrentTransformInverse(ctx: any): any[];
 /**
  * Gets the filename from a given URL.
  * @param {string} url
- * @param {boolean} [onlyStripPath]
  * @returns {string}
  */
-export function getFilenameFromUrl(url: string, onlyStripPath?: boolean | undefined): string;
+export function getFilenameFromUrl(url: string): string;
 /**
  * Returns the filename or guessed filename from the url (see issue 3455).
  * @param {string} url - The original PDF location.

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

@@ -0,0 +1,38 @@
+/**
+ * Manage the SVGs drawn on top of the page canvas.
+ * It's important to have them directly on top of the canvas because we want to
+ * be able to use mix-blend-mode for some of them.
+ */
+export class DrawLayer {
+    static get _svgFactory(): any;
+    static "__#26@#setBox"(element: any, { x, y, width, height }?: {
+        x?: number | undefined;
+        y?: number | undefined;
+        width?: number | undefined;
+        height?: number | undefined;
+    }): void;
+    constructor({ pageIndex }: {
+        pageIndex: any;
+    });
+    pageIndex: any;
+    setParent(parent: any): void;
+    highlight(outlines: any, color: any, opacity: any, isPathUpdatable?: boolean): {
+        id: number;
+        clipPathId: string;
+    };
+    highlightOutline(outlines: any): number;
+    finalizeLine(id: any, line: any): void;
+    updateLine(id: any, line: any): void;
+    removeFreeHighlight(id: any): void;
+    updatePath(id: any, line: any): void;
+    updateBox(id: any, box: any): void;
+    show(id: any, visible: any): void;
+    rotate(id: any, angle: any): void;
+    changeColor(id: any, color: any): void;
+    changeOpacity(id: any, opacity: any): void;
+    addClass(id: any, className: any): void;
+    removeClass(id: any, className: any): void;
+    remove(id: any): void;
+    destroy(): void;
+    #private;
+}

package/dist/types/src/display/editor/alt_text.d.ts

@@ -0,0 +1,22 @@
+export class AltText {
+    static _l10nPromise: null;
+    static initialize(l10nPromise: any): void;
+    constructor(editor: any);
+    render(): Promise<HTMLButtonElement>;
+    finish(): void;
+    isEmpty(): boolean;
+    /**
+     * Set the alt text data.
+     */
+    set data({ altText, decorative }: {
+        altText: string;
+        decorative: boolean;
+    });
+    get data(): {
+        altText: string;
+        decorative: boolean;
+    };
+    toggle(enabled?: boolean): void;
+    destroy(): void;
+    #private;
+}

package/dist/types/src/display/editor/annotation_editor_layer.d.ts

@@ -3,6 +3,7 @@ export type PageViewport = import("../display_utils.js").PageViewport;
 export type TextAccessibilityManager = import("../../../web/text_accessibility.js").TextAccessibilityManager;
 export type IL10n = import("../../../web/interfaces").IL10n;
 export type AnnotationLayer = import("../annotation_layer.js").AnnotationLayer;
+export type DrawLayer = import("../draw_layer.js").DrawLayer;
 export type AnnotationEditorLayerOptions = {
     mode: Object;
     div: HTMLDivElement;
@@ -12,6 +13,8 @@ export type AnnotationEditorLayerOptions = {
     pageIndex: number;
     l10n: IL10n;
     annotationLayer?: import("../annotation_layer.js").AnnotationLayer | undefined;
+    textLayer?: HTMLDivElement | undefined;
+    drawLayer: DrawLayer;
     viewport: PageViewport;
 };
 export type RenderEditorLayerOptions = {
@@ -27,6 +30,8 @@ export type RenderEditorLayerOptions = {
  * @property {number} pageIndex
  * @property {IL10n} l10n
  * @property {AnnotationLayer} [annotationLayer]
+ * @property {HTMLDivElement} [textLayer]
+ * @property {DrawLayer} drawLayer
  * @property {PageViewport} viewport
  */
 /**
@@ -38,15 +43,17 @@ export type RenderEditorLayerOptions = {
  */
 export class AnnotationEditorLayer {
     static _initialized: boolean;
-    static "__#18@#editorTypes": Map<number, typeof FreeTextEditor | typeof InkEditor | typeof StampEditor>;
+    static "__#27@#editorTypes": Map<number, typeof FreeTextEditor | typeof HighlightEditor | typeof InkEditor | typeof StampEditor>;
     /**
      * @param {AnnotationEditorLayerOptions} options
      */
-    constructor({ uiManager, pageIndex, div, accessibilityManager, annotationLayer, viewport, l10n, }: AnnotationEditorLayerOptions);
+    constructor({ uiManager, pageIndex, div, accessibilityManager, annotationLayer, drawLayer, textLayer, viewport, l10n, }: AnnotationEditorLayerOptions);
     pageIndex: number;
     div: HTMLDivElement;
     viewport: import("../display_utils.js").PageViewport;
+    drawLayer: import("../draw_layer.js").DrawLayer;
     get isEmpty(): boolean;
+    get isInvisible(): boolean;
     /**
      * Update the toolbar if it's required to reflect the tool currently used.
      * @param {number} mode
@@ -57,6 +64,7 @@ export class AnnotationEditorLayer {
      * @param {number} mode
      */
     updateMode(mode?: number): void;
+    hasTextLayer(textLayer: any): boolean;
     addInkEditorIfNeeded(isCommitting: any): void;
     /**
      * Set the editing state.
@@ -69,6 +77,7 @@ export class AnnotationEditorLayer {
      */
     addCommands(params: Object): void;
     togglePointerEvents(enabled?: boolean): void;
+    toggleAnnotationLayerPointerEvents(enabled?: boolean): void;
     /**
      * Enable pointer events on the main div in order to enable
      * editor creation.
@@ -84,6 +93,8 @@ export class AnnotationEditorLayer {
      * @param {AnnotationEditor} editor
      */
     setActiveEditor(editor: AnnotationEditor): void;
+    enableTextSelection(): void;
+    disableTextSelection(): void;
     enableClick(): void;
     disableClick(): void;
     attach(editor: any): void;
@@ -120,6 +131,7 @@ export class AnnotationEditorLayer {
      * @returns {string}
      */
     getNextId(): string;
+    canCreateNewEmptyEditor(): boolean | undefined;
     /**
      * Paste some content into a new editor.
      * @param {number} mode
@@ -132,6 +144,14 @@ export class AnnotationEditorLayer {
      * @returns {AnnotationEditor | null}
      */
     deserialize(data: Object): AnnotationEditor | null;
+    /**
+     * Create and add a new editor.
+     * @param {PointerEvent} event
+     * @param {boolean} isCentered
+     * @param [Object] data
+     * @returns {AnnotationEditor}
+     */
+    createAndAddNewEditor(event: PointerEvent, isCentered: boolean, data?: {}): AnnotationEditor;
     /**
      * Create and add a new editor.
      */
@@ -193,9 +213,11 @@ export class AnnotationEditorLayer {
      * @returns {Object} dimensions.
      */
     get pageDimensions(): Object;
+    get scale(): number;
     #private;
 }
 import { AnnotationEditor } from "./editor.js";
 import { FreeTextEditor } from "./freetext.js";
+import { HighlightEditor } from "./highlight.js";
 import { InkEditor } from "./ink.js";
 import { StampEditor } from "./stamp.js";

package/dist/types/src/display/editor/color_picker.d.ts

@@ -0,0 +1,19 @@
+export class ColorPicker {
+    static get _keyboardManager(): any;
+    constructor({ editor, uiManager }: {
+        editor?: null | undefined;
+        uiManager?: null | undefined;
+    });
+    renderButton(): HTMLButtonElement;
+    renderMainDropdown(): HTMLDivElement;
+    _colorSelectFromKeyboard(event: any): void;
+    _moveToNext(event: any): void;
+    _moveToPrevious(event: any): void;
+    _moveToBeginning(event: any): void;
+    _moveToEnd(event: any): void;
+    hideDropdown(): void;
+    _hideDropdownFromKeyboard(): void;
+    updateColor(color: any): void;
+    destroy(): void;
+    #private;
+}