unpdf 0.10.1 → 0.12.0

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

@@ -0,0 +1,33 @@
+export class AltText {
+    static _l10nPromise: null;
+    static initialize(l10nPromise: any): void;
+    constructor(editor: any);
+    render(): Promise<HTMLButtonElement>;
+    finish(): void;
+    isEmpty(): boolean;
+    hasData(): boolean;
+    get guessedText(): null;
+    setGuessedText(guessedText: any): Promise<void>;
+    toggleAltTextBadge(visibility?: boolean): void;
+    serialize(isForCopying: any): {
+        altText: null;
+        decorative: boolean;
+        guessedText: null;
+        textWithDisclaimer: null;
+    };
+    /**
+     * Set the alt text data.
+     */
+    set data({ altText, decorative, guessedText, textWithDisclaimer, cancel, }: {
+        altText: null;
+        decorative: boolean;
+    });
+    get data(): {
+        altText: null;
+        decorative: boolean;
+    };
+    toggle(enabled?: boolean): void;
+    shown(): 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 "__#28@#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.
@@ -68,7 +76,9 @@ export class AnnotationEditorLayer {
      * @param {Object} params
      */
     addCommands(params: Object): void;
+    toggleDrawing(enabled?: boolean): void;
     togglePointerEvents(enabled?: boolean): void;
+    toggleAnnotationLayerPointerEvents(enabled?: boolean): void;
     /**
      * Enable pointer events on the main div in order to enable
      * editor creation.
@@ -84,6 +94,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 +132,8 @@ export class AnnotationEditorLayer {
      * @returns {string}
      */
     getNextId(): string;
+    combinedSignal(ac: any): AbortSignal;
+    canCreateNewEmptyEditor(): boolean | undefined;
     /**
      * Paste some content into a new editor.
      * @param {number} mode
@@ -132,6 +146,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 +215,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;
+}

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

@@ -33,10 +33,12 @@ export type AnnotationEditorParameters = {
  * Base class for editors.
  */
 export class AnnotationEditor {
+    static _l10nPromise: null;
+    static _l10nResizer: null;
     static _borderLineWidth: number;
     static _colorManager: ColorManager;
     static _zIndex: number;
-    static SMALL_EDITOR_SIZE: number;
+    static _telemetryTimeout: number;
     static get _resizerKeyboardManager(): any;
     static get _defaultLineColor(): any;
     static deleteAnnotationElement(editor: any): void;
@@ -44,7 +46,7 @@ export class AnnotationEditor {
      * Initialize the l10n stuff for this type of editor.
      * @param {Object} l10n
      */
-    static initialize(l10n: Object, options?: null): void;
+    static initialize(l10n: Object, _uiManager: any, options: any): void;
     /**
      * Update the default parameters for this type of editor.
      * @param {number} _type
@@ -70,7 +72,7 @@ export class AnnotationEditor {
      * @param {AnnotationEditorLayer} parent
      */
     static paste(item: DataTransferItem, parent: AnnotationEditorLayer): void;
-    static "__#25@#rotatePoint"(x: any, y: any, angle: any): any[];
+    static "__#35@#rotatePoint"(x: any, y: any, angle: any): any[];
     /**
      * Deserialize the editor.
      * The result of the deserialization is a new editor.
@@ -82,14 +84,16 @@ export class AnnotationEditor {
      */
     static deserialize(data: Object, parent: AnnotationEditorLayer, uiManager: AnnotationEditorUIManager): AnnotationEditor | null;
     static get MIN_SIZE(): number;
+    static canCreateNewEmptyEditor(): boolean;
     /**
      * @param {AnnotationEditorParameters} parameters
      */
     constructor(parameters: AnnotationEditorParameters);
+    _editToolbar: null;
     _initialOptions: any;
+    _isVisible: boolean;
     _uiManager: null;
     _focusEventsAllowed: boolean;
-    _l10nPromise: null;
     parent: import("./annotation_editor_layer.js").AnnotationEditorLayer;
     id: string;
     width: any;
@@ -173,7 +177,25 @@ export class AnnotationEditor {
      */
     translateInPage(x: number, y: number): void;
     drag(tx: any, ty: any): void;
-    fixAndSetPosition(): void;
+    get _hasBeenMoved(): boolean;
+    /**
+     * Get the translation to take into account the editor border.
+     * The CSS engine positions the element by taking the border into account so
+     * we must apply the opposite translation to have the editor in the right
+     * position.
+     * @returns {Array<number>}
+     */
+    getBaseTranslation(): Array<number>;
+    /**
+     * @returns {boolean} true if position must be fixed (i.e. make the x and y
+     * living in the page).
+     */
+    get _mustFixPosition(): boolean;
+    /**
+     * Fix the position of the editor in order to keep it inside its parent page.
+     * @param {number} [rotation] - the rotation of the page.
+     */
+    fixAndSetPosition(rotation?: number | undefined): void;
     /**
      * Convert a screen translation into a page one.
      * @param {number} x
@@ -201,22 +223,28 @@ export class AnnotationEditor {
      * @returns {Array<number>}
      */
     getInitialTranslation(): Array<number>;
-    addAltTextButton(): Promise<void>;
+    /**
+     * Called when the alt text dialog is closed.
+     */
     altTextFinish(): void;
-    addEditToolbar(): void;
+    /**
+     * Add a toolbar for this editor.
+     * @returns {Promise<EditorToolbar|null>}
+     */
+    addEditToolbar(): Promise<EditorToolbar | null>;
     removeEditToolbar(): void;
     getClientDimensions(): DOMRect;
+    addAltTextButton(): Promise<void>;
     /**
      * Set the alt text data.
      */
-    set altTextData({ altText, decorative }: {
-        altText: string;
-        decorative: boolean;
-    });
-    get altTextData(): {
-        altText: string;
-        decorative: boolean;
-    };
+    set altTextData(data: any);
+    get altTextData(): any;
+    get guessedAltText(): any;
+    setGuessedAltText(text: any): Promise<void>;
+    serializeAltText(isForCopying: any): any;
+    hasAltText(): boolean;
+    hasAltTextData(): any;
     /**
      * Render this editor in a div.
      * @returns {HTMLDivElement | null}
@@ -231,8 +259,11 @@ export class AnnotationEditor {
     _setParentAndPosition(parent: any, x: any, y: any): void;
     /**
      * Convert the current rect into a page one.
+     * @param {number} tx - x-translation in screen coordinates.
+     * @param {number} ty - y-translation in screen coordinates.
+     * @param {number} [rotation] - the rotation of the page.
      */
-    getRect(tx: any, ty: any): any[];
+    getRect(tx: number, ty: number, rotation?: number | undefined): any[];
     getRectInCurrentCoords(rect: any, pageHeight: any): any[];
     /**
      * Executed once this editor has been rendered.
@@ -273,6 +304,11 @@ export class AnnotationEditor {
      * To implement in subclasses.
      */
     rebuild(): void;
+    /**
+     * Rotate the editor.
+     * @param {number} angle
+     */
+    rotate(_angle: any): void;
     /**
      * Serialize the editor.
      * The result of the serialization will be used to construct a
@@ -284,6 +320,12 @@ export class AnnotationEditor {
      * @returns {Object | null}
      */
     serialize(isForCopying?: boolean | undefined, context?: Object | null | undefined): Object | null;
+    /**
+     * Check if an existing annotation associated with this editor has been
+     * modified.
+     * @returns {boolean}
+     */
+    get hasBeenModified(): boolean;
     /**
      * Remove this editor.
      * It's used on ctrl+backspace action.
@@ -297,6 +339,7 @@ export class AnnotationEditor {
      * Add the resizers to this editor.
      */
     makeResizable(): void;
+    get toolbarPosition(): null;
     /**
      * onkeydown callback.
      * @param {KeyboardEvent} event
@@ -357,7 +400,33 @@ export class AnnotationEditor {
      * @param {number} height
      */
     setAspectRatio(width: number, height: number): void;
+    /**
+     * Get the data to report to the telemetry when the editor is added.
+     * @returns {Object}
+     */
+    get telemetryInitialData(): Object;
+    /**
+     * The telemetry data to use when saving/printing.
+     * @returns {Object|null}
+     */
+    get telemetryFinalData(): Object | null;
+    _reportTelemetry(data: any, mustWait?: boolean): void;
+    /**
+     * Show or hide this editor.
+     * @param {boolean|undefined} visible
+     */
+    show(visible?: boolean | undefined): void;
+    enable(): void;
+    disable(): void;
+    /**
+     * Render an annotation in the annotation layer.
+     * @param {Object} annotation
+     * @returns {HTMLElement}
+     */
+    renderAnnotationElement(annotation: Object): HTMLElement;
+    resetAnnotationElement(annotation: any): void;
     #private;
 }
 import { AnnotationEditorUIManager } from "./tools.js";
+import { EditorToolbar } from "./toolbar.js";
 import { ColorManager } from "./tools.js";

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

@@ -11,11 +11,13 @@ export class FreeTextEditor extends AnnotationEditor {
     static _type: string;
     static _editorType: number;
     /** @inheritdoc */
-    static initialize(l10n: any): void;
+    static initialize(l10n: any, uiManager: any): void;
     /** @inheritdoc */
     static updateDefaultParams(type: any, value: any): void;
     /** @inheritdoc */
     static get defaultPropertiesToUpdate(): any[][];
+    static "__#18@#getNodeContent"(node: any): any;
+    static "__#18@#deserializeContent"(content: any): any;
     /** @inheritdoc */
     static deserialize(data: any, parent: any, uiManager: any): AnnotationEditor | null;
     constructor(params: any);
@@ -45,6 +47,7 @@ export class FreeTextEditor extends AnnotationEditor {
     editorDivInput(event: any): void;
     editorDiv: HTMLDivElement | undefined;
     overlayDiv: HTMLDivElement | undefined;
+    editorDivPaste(event: any): void;
     /** @inheritdoc */
     serialize(isForCopying?: boolean): {
         annotationType: number;
@@ -60,6 +63,8 @@ export class FreeTextEditor extends AnnotationEditor {
         id: any;
         deleted: boolean;
     } | null;
+    /** @inheritdoc */
+    renderAnnotationElement(annotation: any): HTMLElement;
     #private;
 }
 import { AnnotationEditor } from "./editor.js";

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

@@ -0,0 +1,88 @@
+/**
+ * Basic draw editor in order to generate an Highlight annotation.
+ */
+export class HighlightEditor extends AnnotationEditor {
+    static _defaultColor: null;
+    static _defaultOpacity: number;
+    static _defaultThickness: number;
+    static _l10nPromise: any;
+    static _type: string;
+    static _editorType: number;
+    static _freeHighlightId: number;
+    static _freeHighlight: null;
+    static _freeHighlightClipId: string;
+    static get _keyboardManager(): any;
+    static computeTelemetryFinalData(data: any): {
+        numberOfColors: any;
+    };
+    /** @inheritdoc */
+    static initialize(l10n: any, uiManager: any): void;
+    /** @inheritdoc */
+    static updateDefaultParams(type: any, value: any): void;
+    static get defaultPropertiesToUpdate(): (number | null)[][];
+    static "__#24@#rotateBbox"({ x, y, width, height }: {
+        x: any;
+        y: any;
+        width: any;
+        height: any;
+    }, angle: any): {
+        x: any;
+        y: any;
+        width: any;
+        height: any;
+    };
+    static startHighlighting(parent: any, isLTR: any, { target: textLayer, x, y }: {
+        target: any;
+        x: any;
+        y: any;
+    }): void;
+    static "__#24@#highlightMove"(parent: any, event: any): void;
+    static "__#24@#endHighlight"(parent: any, event: any): void;
+    /** @inheritdoc */
+    static deserialize(data: any, parent: any, uiManager: any): AnnotationEditor | null;
+    constructor(params: any);
+    color: any;
+    /** @inheritdoc */
+    get telemetryInitialData(): {
+        action: string;
+        type: string;
+        color: any;
+        thickness: any;
+        methodOfCreation: string;
+    };
+    /** @inheritdoc */
+    get telemetryFinalData(): {
+        type: string;
+        color: any;
+    };
+    /** @inheritdoc */
+    translateInPage(x: any, y: any): void;
+    /** @inheritdoc */
+    updateParams(type: any, value: any): void;
+    /** @inheritdoc */
+    get propertiesToUpdate(): any[][];
+    /** @inheritdoc */
+    fixAndSetPosition(): void;
+    /** @inheritdoc */
+    getRect(tx: any, ty: any): any[];
+    /** @inheritdoc */
+    rotate(angle: any): void;
+    pointerover(): void;
+    pointerleave(): void;
+    _moveCaret(direction: any): void;
+    /** @inheritdoc */
+    serialize(isForCopying?: boolean): {
+        annotationType: number;
+        color: number[];
+        opacity: any;
+        thickness: any;
+        quadPoints: Float32Array | null;
+        outlines: any;
+        pageIndex: number;
+        rect: any[];
+        rotation: number;
+        structTreeParentId: any;
+    } | null;
+    #private;
+}
+import { AnnotationEditor } from "./editor.js";

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

@@ -8,7 +8,7 @@ export class InkEditor extends AnnotationEditor {
     static _type: string;
     static _editorType: number;
     /** @inheritdoc */
-    static initialize(l10n: any): void;
+    static initialize(l10n: any, uiManager: any): void;
     /** @inheritdoc */
     static updateDefaultParams(type: any, value: any): void;
     /** @inheritdoc */
@@ -18,9 +18,9 @@ export class InkEditor extends AnnotationEditor {
      * @param {Array<Array<number>>} bezier
      * @returns {Path2D}
      */
-    static "__#16@#buildPath2D"(bezier: Array<Array<number>>): Path2D;
-    static "__#16@#toPDFCoordinates"(points: any, rect: any, rotation: any): any;
-    static "__#16@#fromPDFCoordinates"(points: any, rect: any, rotation: any): any;
+    static "__#25@#buildPath2D"(bezier: Array<Array<number>>): Path2D;
+    static "__#25@#toPDFCoordinates"(points: any, rect: any, rotation: any): any;
+    static "__#25@#fromPDFCoordinates"(points: any, rect: any, rotation: any): any;
     /** @inheritdoc */
     static deserialize(data: any, parent: any, uiManager: any): AnnotationEditor | null;
     constructor(params: any);
@@ -40,6 +40,7 @@ export class InkEditor extends AnnotationEditor {
     get propertiesToUpdate(): any[][];
     canvas: HTMLCanvasElement | null | undefined;
     onScaleChanging(): void;
+    pointerdownAC: any;
     /**
      * onpointerdown callback for the canvas we're drawing on.
      * @param {PointerEvent} event

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

@@ -1,3 +1,21 @@
+export class FreeOutliner {
+    static "__#21@#MIN_DIST": number;
+    static "__#21@#MIN_DIFF": number;
+    static "__#21@#MIN": number;
+    constructor({ x, y }: {
+        x: any;
+        y: any;
+    }, box: any, scaleFactor: any, thickness: any, isLTR: any, innerMargin?: number);
+    get free(): boolean;
+    isEmpty(): boolean;
+    add({ x, y }: {
+        x: any;
+        y: any;
+    }): boolean;
+    toSVGPath(): string;
+    getOutlines(): FreeHighlightOutline;
+    #private;
+}
 export class Outliner {
     /**
      * Construct an outliner.
@@ -12,15 +30,41 @@ export class Outliner {
      *   the last point of the boxes.
      */
     constructor(boxes: Array<Object>, borderWidth?: number, innerMargin?: number, isLTR?: boolean);
-    getOutlines(): {
-        outlines: any[][];
-        box: {
-            x: number;
-            y: number;
-            width: number;
-            height: number;
-            lastPoint: any[];
-        };
+    getOutlines(): HighlightOutline;
+    #private;
+}
+declare class FreeHighlightOutline extends Outline {
+    constructor(outline: any, points: any, box: any, scaleFactor: any, innerMargin: any, isLTR: any);
+    serialize([blX, blY, trX, trY]: [any, any, any, any], rotation: any): {
+        outline: number[];
+        points: number[][];
     };
+    get box(): null;
+    getNewOutline(thickness: any, innerMargin: any): FreeHighlightOutline;
     #private;
 }
+declare class HighlightOutline extends Outline {
+    constructor(outlines: any, box: any);
+    /**
+     * Serialize the outlines into the PDF page coordinate system.
+     * @param {Array<number>} _bbox - the bounding box of the annotation.
+     * @param {number} _rotation - the rotation of the annotation.
+     * @returns {Array<Array<number>>}
+     */
+    serialize([blX, blY, trX, trY]: Array<number>, _rotation: number): Array<Array<number>>;
+    get box(): any;
+    #private;
+}
+declare class Outline {
+    /**
+     * @returns {string} The SVG path of the outline.
+     */
+    toSVGPath(): string;
+    /**
+     * @type {Object|null} The bounding box of the outline.
+     */
+    get box(): Object | null;
+    serialize(_bbox: any, _rotation: any): void;
+    get free(): any;
+}
+export {};

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

@@ -5,17 +5,38 @@ export class StampEditor extends AnnotationEditor {
     static _type: string;
     static _editorType: number;
     /** @inheritdoc */
-    static initialize(l10n: any): void;
+    static initialize(l10n: any, uiManager: any): void;
     static get supportedTypes(): any;
     static get supportedTypesStr(): any;
     /** @inheritdoc */
     static isHandlingMimeForPasting(mime: any): any;
     /** @inheritdoc */
     static paste(item: any, parent: any): void;
+    static computeTelemetryFinalData(data: any): {
+        hasAltText: any;
+        hasNoAltText: any;
+    };
     /** @inheritdoc */
     static deserialize(data: any, parent: any, uiManager: any): AnnotationEditor | null;
     constructor(params: any);
     /** @inheritdoc */
+    get telemetryFinalData(): {
+        type: string;
+        hasAltText: boolean;
+    };
+    mlGuessAltText(imageData?: null, updateAltTextData?: boolean): Promise<any>;
+    copyCanvas(maxDimension: any, createImageData?: boolean): {
+        canvas: HTMLCanvasElement;
+        imageData: {
+            width: any;
+            height: any;
+            data: Uint8ClampedArray;
+        };
+    } | {
+        canvas: HTMLCanvasElement;
+        imageData: null;
+    };
+    /** @inheritdoc */
     getImageForAltText(): null;
     /** @inheritdoc */
     serialize(isForCopying?: boolean, context?: null): {

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

@@ -1,9 +1,18 @@
 export class EditorToolbar {
-    static "__#24@#pointerDown"(e: any): void;
+    static "__#4@#l10nRemove": null;
+    static "__#4@#pointerDown"(e: any): void;
     constructor(editor: any);
     render(): HTMLDivElement;
     hide(): void;
     show(): void;
+    addAltText(altText: any): Promise<void>;
+    addColorPicker(colorPicker: any): void;
     remove(): void;
     #private;
 }
+export class HighlightToolbar {
+    constructor(uiManager: any);
+    show(parent: any, boxes: any, isLTR: any): void;
+    hide(): void;
+    #private;
+}