pdfjs-dist 2.5.207 → 2.6.347

package/types/display/api_compatibility.d.ts

@@ -0,0 +1 @@
+export const apiCompatibilityParams: any;

package/types/display/canvas.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @type {any}
+ */
+export var CanvasGraphics: any;

package/types/display/content_disposition.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Extract file name from the Content-Disposition HTTP response header.
+ *
+ * @param {string} contentDisposition
+ * @returns {string} Filename, if found in the Content-Disposition header.
+ */
+export function getFilenameFromContentDispositionHeader(contentDisposition: string): string;

package/types/display/display_utils.d.ts

@@ -0,0 +1,243 @@
+export type ExternalLinkParameters = any;
+export type PageViewportParameters = {
+    /**
+     * - The xMin, yMin, xMax and
+     * yMax coordinates.
+     */
+    viewBox: Array<number>;
+    /**
+     * - The scale of the viewport.
+     */
+    scale: number;
+    /**
+     * - The rotation, in degrees, of the viewport.
+     */
+    rotation: number;
+    /**
+     * - The horizontal, i.e. x-axis, offset. The
+     * default value is `0`.
+     */
+    offsetX?: number;
+    /**
+     * - The vertical, i.e. y-axis, offset. The
+     * default value is `0`.
+     */
+    offsetY?: number;
+    /**
+     * - If true, the y-axis will not be flipped.
+     * The default value is `false`.
+     */
+    dontFlip?: boolean;
+};
+export type PageViewportCloneParameters = {
+    /**
+     * - The scale, overriding the one in the cloned
+     * viewport. The default value is `this.scale`.
+     */
+    scale?: number;
+    /**
+     * - The rotation, in degrees, overriding the one
+     * in the cloned viewport. The default value is `this.rotation`.
+     */
+    rotation?: number;
+    /**
+     * - The horizontal, i.e. x-axis, offset.
+     * The default value is `this.offsetX`.
+     */
+    offsetX?: number;
+    /**
+     * - The vertical, i.e. y-axis, offset.
+     * The default value is `this.offsetY`.
+     */
+    offsetY?: number;
+    /**
+     * - If true, the x-axis will not be flipped.
+     * The default value is `false`.
+     */
+    dontFlip?: boolean;
+};
+/**
+ * @typedef {Object} PageViewportParameters
+ * @property {Array<number>} viewBox - The xMin, yMin, xMax and
+ *   yMax coordinates.
+ * @property {number} scale - The scale of the viewport.
+ * @property {number} rotation - The rotation, in degrees, of the viewport.
+ * @property {number} [offsetX] - The horizontal, i.e. x-axis, offset. The
+ *   default value is `0`.
+ * @property {number} [offsetY] - The vertical, i.e. y-axis, offset. The
+ *   default value is `0`.
+ * @property {boolean} [dontFlip] - If true, the y-axis will not be flipped.
+ *   The default value is `false`.
+ */
+/**
+ * @typedef {Object} PageViewportCloneParameters
+ * @property {number} [scale] - The scale, overriding the one in the cloned
+ *   viewport. The default value is `this.scale`.
+ * @property {number} [rotation] - The rotation, in degrees, overriding the one
+ *   in the cloned viewport. The default value is `this.rotation`.
+ * @property {number} [offsetX] - The horizontal, i.e. x-axis, offset.
+ *   The default value is `this.offsetX`.
+ * @property {number} [offsetY] - The vertical, i.e. y-axis, offset.
+ *   The default value is `this.offsetY`.
+ * @property {boolean} [dontFlip] - If true, the x-axis will not be flipped.
+ *   The default value is `false`.
+ */
+/**
+ * PDF page viewport created based on scale, rotation and offset.
+ */
+export class PageViewport {
+    /**
+     * @param {PageViewportParameters}
+     */
+    constructor({ viewBox, scale, rotation, offsetX, offsetY, dontFlip, }: PageViewportParameters);
+    viewBox: number[];
+    scale: number;
+    rotation: number;
+    offsetX: number;
+    offsetY: number;
+    transform: number[];
+    width: number;
+    height: number;
+    /**
+     * Clones viewport, with optional additional properties.
+     * @param {PageViewportCloneParameters} [params]
+     * @returns {PageViewport} Cloned viewport.
+     */
+    clone({ scale, rotation, offsetX, offsetY, dontFlip, }?: PageViewportCloneParameters | undefined): PageViewport;
+    /**
+     * Converts PDF point to the viewport coordinates. For examples, useful for
+     * converting PDF location into canvas pixel coordinates.
+     * @param {number} x - The x-coordinate.
+     * @param {number} y - The y-coordinate.
+     * @returns {Object} Object containing `x` and `y` properties of the
+     *   point in the viewport coordinate space.
+     * @see {@link convertToPdfPoint}
+     * @see {@link convertToViewportRectangle}
+     */
+    convertToViewportPoint(x: number, y: number): Object;
+    /**
+     * Converts PDF rectangle to the viewport coordinates.
+     * @param {Array} rect - The xMin, yMin, xMax and yMax coordinates.
+     * @returns {Array} Array containing corresponding coordinates of the
+     *   rectangle in the viewport coordinate space.
+     * @see {@link convertToViewportPoint}
+     */
+    convertToViewportRectangle(rect: any[]): any[];
+    /**
+     * Converts viewport coordinates to the PDF location. For examples, useful
+     * for converting canvas pixel location into PDF one.
+     * @param {number} x - The x-coordinate.
+     * @param {number} y - The y-coordinate.
+     * @returns {Object} Object containing `x` and `y` properties of the
+     *   point in the PDF coordinate space.
+     * @see {@link convertToViewportPoint}
+     */
+    convertToPdfPoint(x: number, y: number): Object;
+}
+declare const RenderingCancelledException_base: any;
+export class RenderingCancelledException extends RenderingCancelledException_base {
+    [x: string]: any;
+    constructor(msg: any, type: any);
+    type: any;
+}
+/**
+ * @typedef ExternalLinkParameters
+ * @typedef {Object} ExternalLinkParameters
+ * @property {string} url - An absolute URL.
+ * @property {LinkTarget} [target] - The link target. The default value is
+ *   `LinkTarget.NONE`.
+ * @property {string} [rel] - The link relationship. The default value is
+ *   `DEFAULT_LINK_REL`.
+ * @property {boolean} [enabled] - Whether the link should be enabled. The
+ *   default value is true.
+ */
+/**
+ * Adds various attributes (href, title, target, rel) to hyperlinks.
+ * @param {HTMLLinkElement} link - The link element.
+ * @param {ExternalLinkParameters} params
+ */
+export function addLinkAttributes(link: HTMLLinkElement, { url, target, rel, enabled }?: any): void;
+/**
+ * Gets the file name from a given URL.
+ * @param {string} url
+ */
+export function getFilenameFromUrl(url: string): string;
+export namespace LinkTarget {
+    export const NONE: number;
+    export const SELF: number;
+    export const BLANK: number;
+    export const PARENT: number;
+    export const TOP: number;
+}
+export const DEFAULT_LINK_REL: "noopener noreferrer nofollow";
+export class BaseCanvasFactory {
+    create(width: any, height: any): void;
+    reset(canvasAndContext: any, width: any, height: any): void;
+    destroy(canvasAndContext: any): void;
+}
+export class DOMCanvasFactory extends BaseCanvasFactory {
+    constructor({ ownerDocument }?: {
+        ownerDocument?: Document | undefined;
+    });
+    _document: Document;
+}
+export class BaseCMapReaderFactory {
+    constructor({ baseUrl, isCompressed }: {
+        baseUrl?: any;
+        isCompressed?: boolean | undefined;
+    });
+    baseUrl: any;
+    isCompressed: boolean;
+    fetch({ name }: {
+        name: any;
+    }): Promise<any>;
+    /**
+     * @private
+     */
+    private _fetchData;
+}
+export class DOMCMapReaderFactory extends BaseCMapReaderFactory {
+    constructor({ baseUrl, isCompressed }: {
+        baseUrl?: any;
+        isCompressed?: boolean | undefined;
+    });
+}
+export class DOMSVGFactory {
+    create(width: any, height: any): SVGElement;
+    createElement(type: any): any;
+}
+export class StatTimer {
+    started: any;
+    times: any[];
+    time(name: any): void;
+    timeEnd(name: any): void;
+    toString(): string;
+}
+export function isFetchSupported(): boolean;
+export function isValidFetchUrl(url: any, baseUrl: any): boolean;
+/**
+ * @param {string} src
+ * @returns {Promise<void>}
+ */
+export function loadScript(src: string): Promise<void>;
+export function deprecated(details: any): void;
+export class PDFDateString {
+    /**
+     * Convert a PDF date string to a JavaScript `Date` object.
+     *
+     * The PDF date string format is described in section 7.9.4 of the official
+     * PDF 32000-1:2008 specification. However, in the PDF 1.7 reference (sixth
+     * edition) Adobe describes the same format including a trailing apostrophe.
+     * This syntax in incorrect, but Adobe Acrobat creates PDF files that contain
+     * them. We ignore all apostrophes as they are not necessary for date parsing.
+     *
+     * Moreover, Adobe Acrobat doesn't handle changing the date to universal time
+     * and doesn't use the user's time zone (effectively ignoring the HH' and mm'
+     * parts of the date string).
+     *
+     * @param {string} input
+     * @returns {Date|null}
+     */
+    static toDateObject(input: string): Date | null;
+}
+export {};

package/types/display/fetch_stream.d.ts

@@ -0,0 +1,67 @@
+/** @implements {IPDFStream} */
+export class PDFFetchStream {
+    constructor(source: any);
+    source: any;
+    isHttp: boolean;
+    httpHeaders: any;
+    _fullRequestReader: PDFFetchStreamReader | null;
+    _rangeRequestReaders: any[];
+    get _progressiveDataLength(): number;
+    getFullReader(): PDFFetchStreamReader;
+    getRangeReader(begin: any, end: any): PDFFetchStreamRangeReader | null;
+    cancelAllRequests(reason: any): void;
+}
+/** @implements {IPDFStreamReader} */
+declare class PDFFetchStreamReader {
+    constructor(stream: any);
+    _stream: any;
+    _reader: ReadableStreamDefaultReader<Uint8Array> | null;
+    _loaded: number;
+    _filename: string | null;
+    _withCredentials: any;
+    _contentLength: any;
+    _headersCapability: import("../shared/util.js").PromiseCapability;
+    _disableRange: any;
+    _rangeChunkSize: any;
+    _abortController: AbortController;
+    _isStreamingSupported: boolean;
+    _isRangeSupported: boolean;
+    _headers: Headers;
+    onProgress: any;
+    get headersReady(): Promise<any>;
+    get filename(): string | null;
+    get contentLength(): any;
+    get isRangeSupported(): boolean;
+    get isStreamingSupported(): boolean;
+    read(): Promise<{
+        value: Uint8Array | undefined;
+        done: true;
+    } | {
+        value: ArrayBufferLike;
+        done: boolean;
+    }>;
+    cancel(reason: any): void;
+}
+/** @implements {IPDFStreamRangeReader} */
+declare class PDFFetchStreamRangeReader {
+    constructor(stream: any, begin: any, end: any);
+    _stream: any;
+    _reader: ReadableStreamDefaultReader<Uint8Array> | null;
+    _loaded: number;
+    _withCredentials: any;
+    _readCapability: import("../shared/util.js").PromiseCapability;
+    _isStreamingSupported: boolean;
+    _abortController: AbortController;
+    _headers: Headers;
+    onProgress: any;
+    get isStreamingSupported(): boolean;
+    read(): Promise<{
+        value: Uint8Array | undefined;
+        done: true;
+    } | {
+        value: ArrayBufferLike;
+        done: boolean;
+    }>;
+    cancel(reason: any): void;
+}
+export {};

package/types/display/font_loader.d.ts

@@ -0,0 +1,19 @@
+export class FontFaceObject {
+    constructor(translatedData: any, { isEvalSupported, disableFontFace, ignoreErrors, onUnsupportedFeature, fontRegistry, }: {
+        isEvalSupported?: boolean | undefined;
+        disableFontFace?: boolean | undefined;
+        ignoreErrors?: boolean | undefined;
+        onUnsupportedFeature?: any;
+        fontRegistry?: any;
+    });
+    compiledGlyphs: any;
+    isEvalSupported: boolean;
+    disableFontFace: boolean;
+    ignoreErrors: boolean;
+    _onUnsupportedFeature: any;
+    fontRegistry: any;
+    createNativeFontFace(): any;
+    createFontFaceRule(): string | null;
+    getPathGenerator(objs: any, character: any): any;
+}
+export let FontLoader: any;

package/types/display/metadata.d.ts

@@ -0,0 +1,9 @@
+export class Metadata {
+    constructor(data: any);
+    _metadataMap: Map<any, any>;
+    _repair(data: any): any;
+    _parse(xmlDocument: any): void;
+    get(name: any): any;
+    getAll(): any;
+    has(name: any): boolean;
+}

package/types/display/network.d.ts

@@ -0,0 +1,80 @@
+/** @implements {IPDFStream} */
+export class PDFNetworkStream {
+    constructor(source: any);
+    _source: any;
+    _manager: NetworkManager;
+    _rangeChunkSize: any;
+    _fullRequestReader: PDFNetworkStreamFullRequestReader | null;
+    _rangeRequestReaders: any[];
+    _onRangeRequestReaderClosed(reader: any): void;
+    getFullReader(): PDFNetworkStreamFullRequestReader;
+    getRangeReader(begin: any, end: any): PDFNetworkStreamRangeRequestReader;
+    cancelAllRequests(reason: any): void;
+}
+declare class NetworkManager {
+    constructor(url: any, args: any);
+    url: any;
+    isHttp: boolean;
+    httpHeaders: any;
+    withCredentials: any;
+    getXhr: any;
+    currXhrId: number;
+    pendingRequests: any;
+    requestRange(begin: any, end: any, listeners: any): number;
+    requestFull(listeners: any): number;
+    request(args: any): number;
+    onProgress(xhrId: any, evt: any): void;
+    onStateChange(xhrId: any, evt: any): void;
+    getRequestXhr(xhrId: any): any;
+    isPendingRequest(xhrId: any): boolean;
+    abortRequest(xhrId: any): void;
+}
+/** @implements {IPDFStreamReader} */
+declare class PDFNetworkStreamFullRequestReader {
+    constructor(manager: any, source: any);
+    _manager: any;
+    _url: any;
+    _fullRequestId: any;
+    _headersReceivedCapability: import("../shared/util.js").PromiseCapability;
+    _disableRange: any;
+    _contentLength: any;
+    _rangeChunkSize: any;
+    _isStreamingSupported: boolean;
+    _isRangeSupported: boolean;
+    _cachedChunks: any[];
+    _requests: any[];
+    _done: boolean;
+    _storedError: import("../shared/util.js").MissingPDFException | import("../shared/util.js").UnexpectedResponseException | undefined;
+    _filename: string | null;
+    onProgress: any;
+    _onHeadersReceived(): void;
+    _onDone(args: any): void;
+    _onError(status: any): void;
+    _onProgress(data: any): void;
+    get filename(): string | null;
+    get isRangeSupported(): boolean;
+    get isStreamingSupported(): boolean;
+    get contentLength(): any;
+    get headersReady(): Promise<any>;
+    read(): Promise<any>;
+    cancel(reason: any): void;
+    _fullRequestReader: any;
+}
+/** @implements {IPDFStreamRangeReader} */
+declare class PDFNetworkStreamRangeRequestReader {
+    constructor(manager: any, begin: any, end: any);
+    _manager: any;
+    _requestId: any;
+    _requests: any[];
+    _queuedChunk: any;
+    _done: boolean;
+    onProgress: any;
+    onClosed: any;
+    _close(): void;
+    _onDone(data: any): void;
+    _onProgress(evt: any): void;
+    get isStreamingSupported(): boolean;
+    read(): Promise<any>;
+    cancel(reason: any): void;
+}
+export {};

package/types/display/network_utils.d.ts

@@ -0,0 +1,14 @@
+export function createResponseStatusError(status: any, url: any): MissingPDFException | UnexpectedResponseException;
+export function extractFilenameFromHeader(getResponseHeader: any): string | null;
+export function validateRangeRequestCapabilities({ getResponseHeader, isHttp, rangeChunkSize, disableRange, }: {
+    getResponseHeader: any;
+    isHttp: any;
+    rangeChunkSize: any;
+    disableRange: any;
+}): {
+    allowRangeRequests: boolean;
+    suggestedLength: undefined;
+};
+export function validateResponseStatus(status: any): boolean;
+import { MissingPDFException } from "../shared/util.js";
+import { UnexpectedResponseException } from "../shared/util.js";

package/types/display/node_stream.d.ts

@@ -0,0 +1,72 @@
+export class PDFNodeStream {
+    constructor(source: any);
+    source: any;
+    url: any;
+    isHttp: boolean;
+    isFsUrl: boolean;
+    httpHeaders: any;
+    _fullRequestReader: PDFNodeStreamFsFullReader | PDFNodeStreamFullReader | null;
+    _rangeRequestReaders: any[];
+    get _progressiveDataLength(): number;
+    getFullReader(): PDFNodeStreamFsFullReader | PDFNodeStreamFullReader;
+    getRangeReader(start: any, end: any): PDFNodeStreamFsRangeReader | PDFNodeStreamRangeReader | null;
+    cancelAllRequests(reason: any): void;
+}
+declare class PDFNodeStreamFsFullReader extends BaseFullReader {
+    constructor(stream: any);
+}
+declare class PDFNodeStreamFullReader extends BaseFullReader {
+    constructor(stream: any);
+    _request: any;
+}
+declare class PDFNodeStreamFsRangeReader extends BaseRangeReader {
+    constructor(stream: any, start: any, end: any);
+}
+declare class PDFNodeStreamRangeReader extends BaseRangeReader {
+    constructor(stream: any, start: any, end: any);
+    _httpHeaders: {};
+    _request: any;
+}
+declare class BaseFullReader {
+    constructor(stream: any);
+    _url: any;
+    _done: boolean;
+    _storedError: any;
+    onProgress: any;
+    _contentLength: any;
+    _loaded: number;
+    _filename: any;
+    _disableRange: any;
+    _rangeChunkSize: any;
+    _isStreamingSupported: boolean;
+    _isRangeSupported: boolean;
+    _readableStream: any;
+    _readCapability: import("../shared/util.js").PromiseCapability;
+    _headersCapability: import("../shared/util.js").PromiseCapability;
+    get headersReady(): Promise<any>;
+    get filename(): any;
+    get contentLength(): any;
+    get isRangeSupported(): boolean;
+    get isStreamingSupported(): boolean;
+    read(): any;
+    cancel(reason: any): void;
+    _error(reason: any): void;
+    _setReadableStream(readableStream: any): void;
+}
+declare class BaseRangeReader {
+    constructor(stream: any);
+    _url: any;
+    _done: boolean;
+    _storedError: any;
+    onProgress: any;
+    _loaded: number;
+    _readableStream: any;
+    _readCapability: import("../shared/util.js").PromiseCapability;
+    _isStreamingSupported: boolean;
+    get isStreamingSupported(): boolean;
+    read(): any;
+    cancel(reason: any): void;
+    _error(reason: any): void;
+    _setReadableStream(readableStream: any): void;
+}
+export {};

package/types/display/node_utils.d.ts

@@ -0,0 +1,6 @@
+export let NodeCanvasFactory: {
+    new (): {};
+};
+export let NodeCMapReaderFactory: {
+    new (): {};
+};

package/types/display/optional_content_config.d.ts

@@ -0,0 +1,12 @@
+export class OptionalContentConfig {
+    constructor(data: any);
+    name: any;
+    creator: any;
+    _order: any;
+    _groups: Map<any, any>;
+    isVisible(group: any): any;
+    setVisibility(id: any, visible?: boolean): void;
+    getOrder(): any;
+    getGroups(): any;
+    getGroup(id: any): any;
+}

package/types/display/pattern_helper.d.ts

@@ -0,0 +1,5 @@
+export function getShadingPatternFromIR(raw: any): any;
+/**
+ * @type {any}
+ */
+export var TilingPattern: any;

package/types/display/svg.d.ts

@@ -0,0 +1,2 @@
+/** @type {any} */
+export let SVGGraphics: any;

package/types/display/text_layer.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Text layer render parameters.
+ */
+export type TextLayerRenderParameters = {
+    /**
+     * - Text content to
+     * render (the object is returned by the page's `getTextContent` method).
+     */
+    textContent?: import("./api").TextContent;
+    /**
+     * - Text content stream to
+     * render (the stream is returned by the page's `streamTextContent` method).
+     */
+    textContentStream?: ReadableStream;
+    /**
+     * - HTML element that will contain text runs.
+     */
+    container: HTMLElement;
+    /**
+     * - The target
+     * viewport to properly layout the text runs.
+     */
+    viewport: import("./display_utils").PageViewport;
+    /**
+     * - HTML elements that are correspond
+     * to the text items of the textContent input. This is output and shall be
+     * initially be set to empty array.
+     */
+    textDivs?: Array<HTMLElement>;
+    /**
+     * - Strings that correspond to
+     * the `str` property of the text items of textContent input. This is output
+     * and shall be initially be set to empty array.
+     */
+    textContentItemsStr?: Array<string>;
+    /**
+     * - Delay in milliseconds before rendering of the
+     * text runs occurs.
+     */
+    timeout?: number;
+    /**
+     * - Whether to turn on the text
+     * selection enhancement.
+     */
+    enhanceTextSelection?: boolean;
+};
+export type TextLayerRenderTask = {
+    promise: Promise<void>;
+    cancel: () => void;
+    expandTextDivs: (expandDivs: boolean) => void;
+};
+/**
+ * Text layer render parameters.
+ *
+ * @typedef {Object} TextLayerRenderParameters
+ * @property {import("./api").TextContent} [textContent] - Text content to
+ *   render (the object is returned by the page's `getTextContent` method).
+ * @property {ReadableStream} [textContentStream] - Text content stream to
+ *   render (the stream is returned by the page's `streamTextContent` method).
+ * @property {HTMLElement} container - HTML element that will contain text runs.
+ * @property {import("./display_utils").PageViewport} viewport - The target
+ *   viewport to properly layout the text runs.
+ * @property {Array<HTMLElement>} [textDivs] - HTML elements that are correspond
+ *   to the text items of the textContent input. This is output and shall be
+ *   initially be set to empty array.
+ * @property {Array<string>} [textContentItemsStr] - Strings that correspond to
+ *    the `str` property of the text items of textContent input. This is output
+ *   and shall be initially be set to empty array.
+ * @property {number} [timeout] - Delay in milliseconds before rendering of the
+ *   text runs occurs.
+ * @property {boolean} [enhanceTextSelection] - Whether to turn on the text
+ *   selection enhancement.
+ */
+/**
+ * @typedef {Object} TextLayerRenderTask
+ * @property {Promise<void>} promise
+ * @property {() => void} cancel
+ * @property {(expandDivs: boolean) => void} expandTextDivs
+ */
+/**
+ * @type {(renderParameters: TextLayerRenderParameters) => TextLayerRenderTask}
+ */
+export var renderTextLayer: (renderParameters: TextLayerRenderParameters) => TextLayerRenderTask;