@divriots/pdfjs-dist 3.10.111-divriots2.0

package/types/web/pdf_viewer.d.ts

@@ -0,0 +1,455 @@
+export type PDFDocumentProxy = import("../src/display/api").PDFDocumentProxy;
+export type PDFPageProxy = import("../src/display/api").PDFPageProxy;
+export type PageViewport = import("../src/display/display_utils").PageViewport;
+export type OptionalContentConfig = import("../src/display/optional_content_config").OptionalContentConfig;
+export type EventBus = import("./event_utils").EventBus;
+export type IDownloadManager = import("./interfaces").IDownloadManager;
+export type IL10n = import("./interfaces").IL10n;
+export type IPDFLinkService = import("./interfaces").IPDFLinkService;
+export type PDFViewerOptions = {
+    /**
+     * - The container for the viewer element.
+     */
+    container: HTMLDivElement;
+    /**
+     * - The viewer element.
+     */
+    viewer?: HTMLDivElement | undefined;
+    /**
+     * - The application event bus.
+     */
+    eventBus: EventBus;
+    /**
+     * - The navigation/linking service.
+     */
+    linkService?: import("./interfaces").IPDFLinkService | undefined;
+    /**
+     * - The download manager
+     * component.
+     */
+    downloadManager?: import("./interfaces").IDownloadManager | undefined;
+    /**
+     * - The find controller
+     * component.
+     */
+    findController?: any;
+    /**
+     * - The scripting manager
+     * component.
+     */
+    scriptingManager?: any;
+    /**
+     * - The rendering queue object.
+     */
+    renderingQueue?: PDFRenderingQueue | undefined;
+    /**
+     * - Removes the border shadow around
+     * the pages. The default value is `false`.
+     */
+    removePageBorders?: boolean | undefined;
+    /**
+     * - Controls if the text layer used for
+     * selection and searching is created. The constants from {TextLayerMode}
+     * should be used. The default value is `TextLayerMode.ENABLE`.
+     */
+    textLayerMode?: number | undefined;
+    /**
+     * - Controls if the annotation layer is
+     * created, and if interactive form elements or `AnnotationStorage`-data are
+     * being rendered. The constants from {@link AnnotationMode } should be used;
+     * see also {@link RenderParameters } and {@link GetOperatorListParameters }.
+     * The default value is `AnnotationMode.ENABLE_FORMS`.
+     */
+    annotationMode?: number | undefined;
+    /**
+     * - Enables the creation and editing
+     * of new Annotations. The constants from {@link AnnotationEditorType } should
+     * be used. The default value is `AnnotationEditorType.NONE`.
+     */
+    annotationEditorMode?: number | undefined;
+    /**
+     * - Path for image resources, mainly
+     * mainly for annotation icons. Include trailing slash.
+     */
+    imageResourcesPath?: string | undefined;
+    /**
+     * - Enables automatic rotation of
+     * landscape pages upon printing. The default is `false`.
+     */
+    enablePrintAutoRotate?: boolean | undefined;
+    /**
+     * - Allows to use an
+     * OffscreenCanvas if needed.
+     */
+    isOffscreenCanvasSupported?: boolean | undefined;
+    /**
+     * - The maximum supported canvas size in
+     * total pixels, i.e. width * height. Use `-1` for no limit, or `0` for
+     * CSS-only zooming. The default value is 4096 * 4096 (16 mega-pixels).
+     */
+    maxCanvasPixels?: number | undefined;
+    /**
+     * - Localization service.
+     */
+    l10n?: import("./interfaces").IL10n | undefined;
+    /**
+     * - Enables PDF document permissions,
+     * when they exist. The default value is `false`.
+     */
+    enablePermissions?: boolean | undefined;
+    /**
+     * - Overwrites background and foreground colors
+     * with user defined ones in order to improve readability in high contrast
+     * mode.
+     */
+    pageColors?: Object | undefined;
+};
+export namespace PagesCountLimit {
+    let FORCE_SCROLL_MODE_PAGE: number;
+    let FORCE_LAZY_PAGE_INIT: number;
+    let PAUSE_EAGER_PAGE_INIT: number;
+}
+/**
+ * @typedef {Object} PDFViewerOptions
+ * @property {HTMLDivElement} container - The container for the viewer element.
+ * @property {HTMLDivElement} [viewer] - The viewer element.
+ * @property {EventBus} eventBus - The application event bus.
+ * @property {IPDFLinkService} [linkService] - The navigation/linking service.
+ * @property {IDownloadManager} [downloadManager] - The download manager
+ *   component.
+ * @property {PDFFindController} [findController] - The find controller
+ *   component.
+ * @property {PDFScriptingManager} [scriptingManager] - The scripting manager
+ *   component.
+ * @property {PDFRenderingQueue} [renderingQueue] - The rendering queue object.
+ * @property {boolean} [removePageBorders] - Removes the border shadow around
+ *   the pages. The default value is `false`.
+ * @property {number} [textLayerMode] - Controls if the text layer used for
+ *   selection and searching is created. The constants from {TextLayerMode}
+ *   should be used. The default value is `TextLayerMode.ENABLE`.
+ * @property {number} [annotationMode] - Controls if the annotation layer is
+ *   created, and if interactive form elements or `AnnotationStorage`-data are
+ *   being rendered. The constants from {@link AnnotationMode} should be used;
+ *   see also {@link RenderParameters} and {@link GetOperatorListParameters}.
+ *   The default value is `AnnotationMode.ENABLE_FORMS`.
+ * @property {number} [annotationEditorMode] - Enables the creation and editing
+ *   of new Annotations. The constants from {@link AnnotationEditorType} should
+ *   be used. The default value is `AnnotationEditorType.NONE`.
+ * @property {string} [imageResourcesPath] - Path for image resources, mainly
+ *   mainly for annotation icons. Include trailing slash.
+ * @property {boolean} [enablePrintAutoRotate] - Enables automatic rotation of
+ *   landscape pages upon printing. The default is `false`.
+ * @property {boolean} [isOffscreenCanvasSupported] - Allows to use an
+ *   OffscreenCanvas if needed.
+ * @property {number} [maxCanvasPixels] - The maximum supported canvas size in
+ *   total pixels, i.e. width * height. Use `-1` for no limit, or `0` for
+ *   CSS-only zooming. The default value is 4096 * 4096 (16 mega-pixels).
+ * @property {IL10n} [l10n] - Localization service.
+ * @property {boolean} [enablePermissions] - Enables PDF document permissions,
+ *   when they exist. The default value is `false`.
+ * @property {Object} [pageColors] - Overwrites background and foreground colors
+ *   with user defined ones in order to improve readability in high contrast
+ *   mode.
+ */
+export class PDFPageViewBuffer {
+    constructor(size: any);
+    push(view: any): void;
+    /**
+     * After calling resize, the size of the buffer will be `newSize`.
+     * The optional parameter `idsToKeep` is, if present, a Set of page-ids to
+     * push to the back of the buffer, delaying their destruction. The size of
+     * `idsToKeep` has no impact on the final size of the buffer; if `idsToKeep`
+     * is larger than `newSize`, some of those pages will be destroyed anyway.
+     */
+    resize(newSize: any, idsToKeep?: null): void;
+    has(view: any): boolean;
+    [Symbol.iterator](): IterableIterator<any>;
+    #private;
+}
+/**
+ * Simple viewer control to display PDF content/pages.
+ */
+export class PDFViewer {
+    /**
+     * @param {PDFViewerOptions} options
+     */
+    constructor(options: PDFViewerOptions);
+    container: HTMLDivElement;
+    viewer: Element | null;
+    eventBus: import("./event_utils").EventBus;
+    linkService: import("./interfaces").IPDFLinkService | SimpleLinkService;
+    downloadManager: import("./interfaces").IDownloadManager | null;
+    findController: any;
+    _scriptingManager: any;
+    imageResourcesPath: string;
+    enablePrintAutoRotate: boolean;
+    removePageBorders: boolean | undefined;
+    isOffscreenCanvasSupported: boolean;
+    maxCanvasPixels: number | undefined;
+    l10n: {
+        getLanguage(): Promise<string>;
+        getDirection(): Promise<string>;
+        get(key: any, args?: null, fallback?: any): Promise<any>;
+        translate(element: any): Promise<void>;
+    };
+    pageColors: Object | null;
+    defaultRenderingQueue: boolean;
+    renderingQueue: PDFRenderingQueue | undefined;
+    scroll: {
+        right: boolean;
+        down: boolean;
+        lastX: any;
+        lastY: any;
+        _eventHandler: (evt: any) => void;
+    };
+    presentationModeState: number;
+    _onBeforeDraw: ((evt: any) => void) | null;
+    _onAfterDraw: any;
+    get pagesCount(): number;
+    getPageView(index: any): any;
+    getCachedPageViews(): Set<any>;
+    /**
+     * @type {boolean} - True if all {PDFPageView} objects are initialized.
+     */
+    get pageViewsReady(): boolean;
+    /**
+     * @type {boolean}
+     */
+    get renderForms(): boolean;
+    /**
+     * @type {boolean}
+     */
+    get enableScripting(): boolean;
+    /**
+     * @param {number} val - The page number.
+     */
+    set currentPageNumber(arg: number);
+    /**
+     * @type {number}
+     */
+    get currentPageNumber(): number;
+    /**
+     * @returns {boolean} Whether the pageNumber is valid (within bounds).
+     * @private
+     */
+    private _setCurrentPageNumber;
+    _currentPageNumber: any;
+    /**
+     * @param {string} val - The page label.
+     */
+    set currentPageLabel(arg: string | null);
+    /**
+     * @type {string|null} Returns the current page label, or `null` if no page
+     *   labels exist.
+     */
+    get currentPageLabel(): string | null;
+    /**
+     * @param {number} val - Scale of the pages in percents.
+     */
+    set currentScale(arg: number);
+    /**
+     * @type {number}
+     */
+    get currentScale(): number;
+    /**
+     * @param val - The scale of the pages (in percent or predefined value).
+     */
+    set currentScaleValue(arg: string);
+    /**
+     * @type {string}
+     */
+    get currentScaleValue(): string;
+    /**
+     * @param {number} rotation - The rotation of the pages (0, 90, 180, 270).
+     */
+    set pagesRotation(arg: number);
+    /**
+     * @type {number}
+     */
+    get pagesRotation(): number;
+    _pagesRotation: any;
+    get firstPagePromise(): any;
+    get onePageRendered(): any;
+    get pagesPromise(): any;
+    getAllText(): Promise<string | null>;
+    /**
+     * @param {PDFDocumentProxy} pdfDocument
+     */
+    setDocument(pdfDocument: PDFDocumentProxy): void;
+    pdfDocument: import("../src/display/api").PDFDocumentProxy | undefined;
+    _scrollMode: any;
+    _optionalContentConfigPromise: Promise<import("../src/display/optional_content_config").OptionalContentConfig> | null | undefined;
+    /**
+     * @param {Array|null} labels
+     */
+    setPageLabels(labels: any[] | null): void;
+    _pageLabels: any[] | null | undefined;
+    _resetView(): void;
+    _pages: any[] | undefined;
+    _currentScale: any;
+    _currentScaleValue: any;
+    _location: {
+        pageNumber: any;
+        scale: any;
+        top: number;
+        left: number;
+        rotation: any;
+        pdfOpenParams: string;
+    } | null | undefined;
+    _firstPageCapability: any;
+    _onePageRenderedCapability: any;
+    _pagesCapability: any;
+    _previousScrollMode: any;
+    _spreadMode: any;
+    _scrollUpdate(): void;
+    /**
+     * @param {string} label - The page label.
+     * @returns {number|null} The page number corresponding to the page label,
+     *   or `null` when no page labels exist and/or the input is invalid.
+     */
+    pageLabelToPageNumber(label: string): number | null;
+    /**
+     * @typedef {Object} ScrollPageIntoViewParameters
+     * @property {number} pageNumber - The page number.
+     * @property {Array} [destArray] - The original PDF destination array, in the
+     *   format: <page-ref> </XYZ|/FitXXX> <args..>
+     * @property {boolean} [allowNegativeOffset] - Allow negative page offsets.
+     *   The default value is `false`.
+     * @property {boolean} [ignoreDestinationZoom] - Ignore the zoom argument in
+     *   the destination array. The default value is `false`.
+     */
+    /**
+     * Scrolls page into view.
+     * @param {ScrollPageIntoViewParameters} params
+     */
+    scrollPageIntoView({ pageNumber, destArray, allowNegativeOffset, ignoreDestinationZoom, }: {
+        /**
+         * - The page number.
+         */
+        pageNumber: number;
+        /**
+         * - The original PDF destination array, in the
+         * format: <page-ref> </XYZ|/FitXXX> <args..>
+         */
+        destArray?: any[] | undefined;
+        /**
+         * - Allow negative page offsets.
+         * The default value is `false`.
+         */
+        allowNegativeOffset?: boolean | undefined;
+        /**
+         * - Ignore the zoom argument in
+         * the destination array. The default value is `false`.
+         */
+        ignoreDestinationZoom?: boolean | undefined;
+    }): void;
+    _updateLocation(firstPage: any): void;
+    update(): void;
+    containsElement(element: any): boolean;
+    focus(): void;
+    get _isContainerRtl(): boolean;
+    get isInPresentationMode(): boolean;
+    get isChangingPresentationMode(): boolean;
+    get isHorizontalScrollbarEnabled(): boolean;
+    get isVerticalScrollbarEnabled(): boolean;
+    _getVisiblePages(): Object;
+    cleanup(): void;
+    /**
+     * @private
+     */
+    private _cancelRendering;
+    forceRendering(currentlyVisiblePages: any): boolean;
+    /**
+     * @type {boolean} Whether all pages of the PDF document have identical
+     *   widths and heights.
+     */
+    get hasEqualPageSizes(): boolean;
+    /**
+     * Returns sizes of the pages.
+     * @returns {Array} Array of objects with width/height/rotation fields.
+     */
+    getPagesOverview(): any[];
+    /**
+     * @param {Promise<OptionalContentConfig>} promise - A promise that is
+     *   resolved with an {@link OptionalContentConfig} instance.
+     */
+    set optionalContentConfigPromise(arg: Promise<import("../src/display/optional_content_config").OptionalContentConfig | null>);
+    /**
+     * @type {Promise<OptionalContentConfig | null>}
+     */
+    get optionalContentConfigPromise(): Promise<import("../src/display/optional_content_config").OptionalContentConfig | null>;
+    /**
+     * @param {number} mode - The direction in which the document pages should be
+     *   laid out within the scrolling container.
+     *   The constants from {ScrollMode} should be used.
+     */
+    set scrollMode(arg: number);
+    /**
+     * @type {number} One of the values in {ScrollMode}.
+     */
+    get scrollMode(): number;
+    _updateScrollMode(pageNumber?: null): void;
+    /**
+     * @param {number} mode - Group the pages in spreads, starting with odd- or
+     *   even-number pages (unless `SpreadMode.NONE` is used).
+     *   The constants from {SpreadMode} should be used.
+     */
+    set spreadMode(arg: number);
+    /**
+     * @type {number} One of the values in {SpreadMode}.
+     */
+    get spreadMode(): number;
+    _updateSpreadMode(pageNumber?: null): void;
+    /**
+     * @private
+     */
+    private _getPageAdvance;
+    /**
+     * Go to the next page, taking scroll/spread-modes into account.
+     * @returns {boolean} Whether navigation occurred.
+     */
+    nextPage(): boolean;
+    /**
+     * Go to the previous page, taking scroll/spread-modes into account.
+     * @returns {boolean} Whether navigation occurred.
+     */
+    previousPage(): boolean;
+    /**
+     * @typedef {Object} ChangeScaleOptions
+     * @property {number} [drawingDelay]
+     * @property {number} [scaleFactor]
+     * @property {number} [steps]
+     */
+    /**
+     * Increase the current zoom level one, or more, times.
+     * @param {ChangeScaleOptions} [options]
+     */
+    increaseScale({ drawingDelay, scaleFactor, steps }?: {
+        drawingDelay?: number | undefined;
+        scaleFactor?: number | undefined;
+        steps?: number | undefined;
+    } | undefined): void;
+    /**
+     * Decrease the current zoom level one, or more, times.
+     * @param {ChangeScaleOptions} [options]
+     */
+    decreaseScale({ drawingDelay, scaleFactor, steps }?: {
+        drawingDelay?: number | undefined;
+        scaleFactor?: number | undefined;
+        steps?: number | undefined;
+    } | undefined): void;
+    get containerTopLeft(): number[];
+    /**
+     * @param {number} mode - AnnotationEditor mode (None, FreeText, Ink, ...)
+     */
+    set annotationEditorMode(arg: number);
+    /**
+     * @type {number}
+     */
+    get annotationEditorMode(): number;
+    set annotationEditorParams(arg: any);
+    refresh(noUpdate?: boolean, updateArgs?: any): void;
+    #private;
+}
+import { PDFRenderingQueue } from "./pdf_rendering_queue.js";
+import { SimpleLinkService } from "./pdf_link_service.js";

package/types/web/struct_tree_layer_builder.d.ts

@@ -0,0 +1,7 @@
+export class StructTreeLayerBuilder {
+    get renderingDone(): boolean;
+    render(structTree: any): HTMLSpanElement | null;
+    hide(): void;
+    show(): void;
+    #private;
+}

package/types/web/text_accessibility.d.ts

@@ -0,0 +1,42 @@
+/**
+ * This class aims to provide some methods:
+ *  - to reorder elements in the DOM with respect to the visual order;
+ *  - to create a link, using aria-owns, between spans in the textLayer and
+ *    annotations in the annotationLayer. The goal is to help to know
+ *    where the annotations are in the text flow.
+ */
+export class TextAccessibilityManager {
+    /**
+     * Compare the positions of two elements, it must correspond to
+     * the visual ordering.
+     *
+     * @param {HTMLElement} e1
+     * @param {HTMLElement} e2
+     * @returns {number}
+     */
+    static "__#45@#compareElementPositions"(e1: HTMLElement, e2: HTMLElement): number;
+    setTextMapping(textDivs: any): void;
+    /**
+     * Function called when the text layer has finished rendering.
+     */
+    enable(): void;
+    disable(): void;
+    /**
+     * Remove an aria-owns id from a node in the text layer.
+     * @param {HTMLElement} element
+     */
+    removePointerInTextLayer(element: HTMLElement): void;
+    /**
+     * Find the text node which is the nearest and add an aria-owns attribute
+     * in order to correctly position this editor in the text flow.
+     * @param {HTMLElement} element
+     * @param {boolean} isRemovable
+     */
+    addPointerInTextLayer(element: HTMLElement, isRemovable: boolean): void;
+    /**
+     * Move a div in the DOM in order to respect the visual order.
+     * @param {HTMLDivElement} element
+     */
+    moveElementInDOM(container: any, element: HTMLDivElement, contentElement: any, isRemovable: any): void;
+    #private;
+}

package/types/web/text_highlighter.d.ts

@@ -0,0 +1,63 @@
+export type EventBus = import("./event_utils").EventBus;
+export type PDFFindController = import("./pdf_find_controller").PDFFindController;
+export type TextHighlighterOptions = {
+    findController: PDFFindController;
+    /**
+     * - The application event bus.
+     */
+    eventBus: EventBus;
+    /**
+     * - The page index.
+     */
+    pageIndex: number;
+};
+/** @typedef {import("./event_utils").EventBus} EventBus */
+/** @typedef {import("./pdf_find_controller").PDFFindController} PDFFindController */
+/**
+ * @typedef {Object} TextHighlighterOptions
+ * @property {PDFFindController} findController
+ * @property {EventBus} eventBus - The application event bus.
+ * @property {number} pageIndex - The page index.
+ */
+/**
+ * TextHighlighter handles highlighting matches from the FindController in
+ * either the text layer or XFA layer depending on the type of document.
+ */
+export class TextHighlighter {
+    /**
+     * @param {TextHighlighterOptions} options
+     */
+    constructor({ findController, eventBus, pageIndex }: TextHighlighterOptions);
+    findController: import("./pdf_find_controller").PDFFindController;
+    matches: any[];
+    eventBus: import("./event_utils").EventBus;
+    pageIdx: number;
+    _onUpdateTextLayerMatches: ((evt: any) => void) | null;
+    textDivs: Node[] | null;
+    textContentItemsStr: string[] | null;
+    enabled: boolean;
+    /**
+     * Store two arrays that will map DOM nodes to text they should contain.
+     * The arrays should be of equal length and the array element at each index
+     * should correspond to the other. e.g.
+     * `items[0] = "<span>Item 0</span>" and texts[0] = "Item 0";
+     *
+     * @param {Array<Node>} divs
+     * @param {Array<string>} texts
+     */
+    setTextMapping(divs: Array<Node>, texts: Array<string>): void;
+    /**
+     * Start listening for events to update the highlighter and check if there are
+     * any current matches that need be highlighted.
+     */
+    enable(): void;
+    disable(): void;
+    _convertMatches(matches: any, matchesLength: any): {
+        begin: {
+            divIdx: number;
+            offset: number;
+        };
+    }[];
+    _renderMatches(matches: any): void;
+    _updateMatches(reset?: boolean): void;
+}

package/types/web/text_layer_builder.d.ts

@@ -0,0 +1,64 @@
+export type PageViewport = import("../src/display/display_utils").PageViewport;
+export type TextContent = import("../src/display/api").TextContent;
+export type TextHighlighter = import("./text_highlighter").TextHighlighter;
+export type TextAccessibilityManager = import("./text_accessibility.js").TextAccessibilityManager;
+export type TextLayerBuilderOptions = {
+    /**
+     * - Optional object that will handle
+     * highlighting text from the find controller.
+     */
+    highlighter: TextHighlighter;
+    accessibilityManager?: import("./text_accessibility.js").TextAccessibilityManager | undefined;
+    /**
+     * - Allows to use an
+     * OffscreenCanvas if needed.
+     */
+    isOffscreenCanvasSupported?: boolean | undefined;
+};
+/**
+ * @typedef {Object} TextLayerBuilderOptions
+ * @property {TextHighlighter} highlighter - Optional object that will handle
+ *   highlighting text from the find controller.
+ * @property {TextAccessibilityManager} [accessibilityManager]
+ * @property {boolean} [isOffscreenCanvasSupported] - Allows to use an
+ *   OffscreenCanvas if needed.
+ */
+/**
+ * The text layer builder provides text selection functionality for the PDF.
+ * It does this by creating overlay divs over the PDF's text. These divs
+ * contain text that matches the PDF text they are overlaying.
+ */
+export class TextLayerBuilder {
+    constructor({ highlighter, accessibilityManager, isOffscreenCanvasSupported, enablePermissions, }: {
+        highlighter?: null | undefined;
+        accessibilityManager?: null | undefined;
+        isOffscreenCanvasSupported?: boolean | undefined;
+        enablePermissions?: boolean | undefined;
+    });
+    textContentItemsStr: any[];
+    renderingDone: boolean;
+    textDivs: any[];
+    textDivProperties: WeakMap<object, any>;
+    textLayerRenderTask: any;
+    highlighter: any;
+    accessibilityManager: any;
+    isOffscreenCanvasSupported: boolean;
+    div: HTMLDivElement;
+    get numTextDivs(): number;
+    /**
+     * Renders the text layer.
+     * @param {PageViewport} viewport
+     */
+    render(viewport: PageViewport): Promise<void>;
+    hide(): void;
+    show(): void;
+    /**
+     * Cancel rendering of the text layer.
+     */
+    cancel(): void;
+    /**
+     * @param {ReadableStream | TextContent} source
+     */
+    setTextContentSource(source: ReadableStream | TextContent): void;
+    #private;
+}