pdfjs-dist 2.6.347 → 2.7.570

package/types/display/api.d.ts

@@ -6,48 +6,48 @@ export type DocumentInitParameters = {
     /**
      * - The URL of the PDF.
      */
-    url?: string;
+    url?: string | undefined;
     /**
      * - Binary PDF data. Use
      * typed arrays (Uint8Array) to improve the memory usage. If PDF data is
      * BASE64-encoded, use `atob()` to convert it to a binary string first.
      */
-    data?: TypedArray | Array<number> | string;
+    data?: string | number[] | Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | undefined;
     /**
      * - Basic authentication headers.
      */
-    httpHeaders?: Object;
+    httpHeaders?: Object | undefined;
     /**
      * - Indicates whether or not
      * cross-site Access-Control requests should be made using credentials such
      * as cookies or authorization headers. The default is `false`.
      */
-    withCredentials?: boolean;
+    withCredentials?: boolean | undefined;
     /**
      * - For decrypting password-protected PDFs.
      */
-    password?: string;
+    password?: string | undefined;
     /**
      * - A typed array with the first portion
      * or all of the pdf data. Used by the extension since some data is already
      * loaded before the switch to range requests.
      */
-    initialData?: TypedArray;
+    initialData?: Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | undefined;
     /**
      * - The PDF file length. It's used for progress
      * reports and range requests operations.
      */
-    length?: number;
+    length?: number | undefined;
     /**
      * - Allows for using a custom range
      * transport implementation.
      */
-    range?: PDFDataRangeTransport;
+    range?: PDFDataRangeTransport | undefined;
     /**
      * - Specify maximum number of bytes fetched
      * per range request. The default value is {@link DEFAULT_RANGE_CHUNK_SIZE}.
      */
-    rangeChunkSize?: number;
+    rangeChunkSize?: number | undefined;
     /**
      * - The worker that will be used for loading and
      * parsing the PDF data.
@@ -57,56 +57,56 @@ export type DocumentInitParameters = {
      * - Controls the logging level; the constants
      * from {@link VerbosityLevel} should be used.
      */
-    verbosity?: number;
+    verbosity?: number | undefined;
     /**
      * - The base URL of the document, used when
      * attempting to recover valid absolute URLs for annotations, and outline
      * items, that (incorrectly) only specify relative URLs.
      */
-    docBaseUrl?: string;
+    docBaseUrl?: string | undefined;
     /**
      * - The URL where the predefined Adobe CMaps are
      * located. Include the trailing slash.
      */
-    cMapUrl?: string;
+    cMapUrl?: string | undefined;
     /**
      * - Specifies if the Adobe CMaps are binary
      * packed or not.
      */
-    cMapPacked?: boolean;
+    cMapPacked?: boolean | undefined;
     /**
      * - The factory that will be used when
      * reading built-in CMap files. Providing a custom factory is useful for
      * environments without Fetch API or `XMLHttpRequest` support, such as
      * Node.js. The default value is {DOMCMapReaderFactory}.
      */
-    CMapReaderFactory?: Object;
+    CMapReaderFactory?: Object | undefined;
     /**
      * - Reject certain promises, e.g.
      * `getOperatorList`, `getTextContent`, and `RenderTask`, when the associated
      * PDF data cannot be successfully parsed, instead of attempting to recover
      * whatever possible of the data. The default value is `false`.
      */
-    stopAtErrors?: boolean;
+    stopAtErrors?: boolean | undefined;
     /**
      * - The maximum allowed image size in total
      * pixels, i.e. width * height. Images above this value will not be rendered.
      * Use -1 for no limit, which is also the default value.
      */
-    maxImageSize?: number;
+    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`.
      */
-    isEvalSupported?: boolean;
+    isEvalSupported?: boolean | undefined;
     /**
      * - By default fonts are converted to
      * OpenType fonts and loaded via `@font-face` rules. If disabled, fonts will
      * be rendered using a built-in font renderer that constructs the glyphs with
      * primitive path commands. The default value is `false`.
      */
-    disableFontFace?: boolean;
+    disableFontFace?: boolean | undefined;
     /**
      * - Include additional properties,
      * which are unused during rendering of PDF documents, when exporting the
@@ -114,25 +114,25 @@ export type DocumentInitParameters = {
      * purposes (and backwards compatibility), but note that it will lead to
      * increased memory usage. The default value is `false`.
      */
-    fontExtraProperties?: boolean;
+    fontExtraProperties?: boolean | undefined;
     /**
      * - Specify an explicit document
      * context to create elements with and to load resources, such as fonts,
      * into. Defaults to the current document.
      */
-    ownerDocument?: HTMLDocument;
+    ownerDocument?: HTMLDocument | undefined;
     /**
      * - Disable range request loading of PDF
      * files. When enabled, and if the server supports partial content requests,
      * then the PDF will be fetched in chunks. The default value is `false`.
      */
-    disableRange?: boolean;
+    disableRange?: boolean | undefined;
     /**
      * - Disable streaming of PDF file data.
      * By default PDF.js attempts to load PDF files in chunks. The default value
      * is `false`.
      */
-    disableStream?: boolean;
+    disableStream?: boolean | undefined;
     /**
      * - Disable pre-fetching of PDF file
      * data. When range requests are enabled PDF.js will automatically keep
@@ -142,12 +142,12 @@ export type DocumentInitParameters = {
      * NOTE: It is also necessary to disable streaming, see above, in order for
      * disabling of pre-fetching to work correctly.
      */
-    disableAutoFetch?: boolean;
+    disableAutoFetch?: boolean | undefined;
     /**
      * - Enables special hooks for debugging PDF.js
      * (see `web/debugger.js`). The default value is `false`.
      */
-    pdfBug?: boolean;
+    pdfBug?: boolean | undefined;
 };
 export type PDFDocumentStats = {
     /**
@@ -188,20 +188,20 @@ export type PDFDocumentLoadingTask = {
      * function that should be called with the new password, and a reason (see
      * {@link PasswordResponses}).
      */
-    onPassword?: Function;
+    onPassword?: Function | undefined;
     /**
      * - Callback to be able to monitor the
      * loading progress of the PDF file (necessary to implement e.g. a loading
      * bar). The callback receives an {Object} with the properties `loaded`
      * ({number}) and `total` ({number}) that indicate how many bytes are loaded.
      */
-    onProgress?: Function;
+    onProgress?: Function | undefined;
     /**
      * - Callback for when an
      * unsupported feature is used in the PDF document. The callback receives an
      * {@link UNSUPPORTED_FEATURES} argument.
      */
-    onUnsupportedFeature?: Function;
+    onUnsupportedFeature?: Function | undefined;
     /**
      * - Promise for document loading
      * task completion.
@@ -226,22 +226,22 @@ export type GetViewportParameters = {
      * - The desired rotation, in degrees, of
      * the viewport. If omitted it defaults to the page rotation.
      */
-    rotation?: number;
+    rotation?: number | undefined;
     /**
      * - The horizontal, i.e. x-axis, offset.
      * The default value is `0`.
      */
-    offsetX?: number;
+    offsetX?: number | undefined;
     /**
      * - The vertical, i.e. y-axis, offset.
      * The default value is `0`.
      */
-    offsetY?: number;
+    offsetY?: number | undefined;
     /**
      * - If true, the y-axis will not be
      * flipped. The default value is `false`.
      */
-    dontFlip?: boolean;
+    dontFlip?: boolean | undefined;
 };
 /**
  * Page getTextContent parameters.
@@ -352,33 +352,33 @@ export type RenderParameters = {
      * - Rendering intent, can be 'display' or 'print'.
      * The default value is 'display'.
      */
-    intent?: string;
+    intent?: string | undefined;
     /**
      * - Enables WebGL accelerated rendering for
      * some operations. The default value is `false`.
      */
-    enableWebGL?: boolean;
+    enableWebGL?: boolean | undefined;
     /**
      * - Whether or not interactive
      * form elements are rendered in the display layer. If so, we do not render
      * them on the canvas as well.
      */
-    renderInteractiveForms?: boolean;
+    renderInteractiveForms?: boolean | undefined;
     /**
      * - Additional transform, applied just
      * before viewport transform.
      */
-    transform?: Array<any>;
+    transform?: any[] | undefined;
     /**
      * - An object that has `beginLayout`,
      * `endLayout` and `appendImage` functions.
      */
-    imageLayer?: Object;
+    imageLayer?: Object | undefined;
     /**
      * - The factory instance that will be used
      * when creating canvases. The default value is {new DOMCanvasFactory()}.
      */
-    canvasFactory?: Object;
+    canvasFactory?: Object | undefined;
     /**
      * - Background to use for the canvas.
      * Any valid `canvas.fillStyle` can be used: a `DOMString` parsed as CSS
@@ -386,12 +386,12 @@ export type RenderParameters = {
      * a `CanvasPattern` object (a repetitive image). The default value is
      * 'rgb(255,255,255)'.
      */
-    background?: Object | string;
+    background?: string | Object | undefined;
     /**
      * - Storage for annotation
      * data in forms.
      */
-    annotationStorage?: AnnotationStorage;
+    annotationStorage?: AnnotationStorage | undefined;
     /**
      * -
      * A promise that should resolve with an {@link OptionalContentConfig}
@@ -399,7 +399,7 @@ export type RenderParameters = {
      * the configuration will be fetched automatically with the default visibility
      * states set.
      */
-    optionalContentConfigPromise?: Promise<OptionalContentConfig>;
+    optionalContentConfigPromise?: Promise<OptionalContentConfig> | undefined;
 };
 /**
  * PDF page operator list.
@@ -419,16 +419,24 @@ export type PDFWorkerParameters = {
     /**
      * - The name of the worker.
      */
-    name?: string;
+    name?: string | undefined;
     /**
      * - The `workerPort` object.
      */
-    port?: Object;
+    port?: Object | undefined;
     /**
      * - Controls the logging level; the
      * constants from {@link VerbosityLevel} should be used.
      */
-    verbosity?: number;
+    verbosity?: number | undefined;
+};
+/** @type {string} */
+export const build: string;
+export const DefaultCanvasFactory: typeof DOMCanvasFactory | {
+    new (): {};
+};
+export const DefaultCMapReaderFactory: typeof DOMCMapReaderFactory | {
+    new (): {};
 };
 /**
  * @typedef { Int8Array | Uint8Array | Uint8ClampedArray |
@@ -574,15 +582,6 @@ export class PDFDataRangeTransport {
     requestDataRange(begin: any, end: any): void;
     abort(): void;
 }
-/**
- * @typedef {Object} PDFWorkerParameters
- * @property {string} [name] - The name of the worker.
- * @property {Object} [port] - The `workerPort` object.
- * @property {number} [verbosity] - Controls the logging level; the
- *   constants from {@link VerbosityLevel} should be used.
- */
-/** @type {any} */
-export const PDFWorker: any;
 /**
  * Proxy to a `PDFDocument` in the worker thread.
  */
@@ -676,6 +675,14 @@ export class PDFDocumentProxy {
      *   if no JavaScript exists.
      */
     getJavaScript(): Promise<Array<string> | null>;
+    /**
+     * @returns {Promise<Object | null>} A promise that is resolved with
+     *   an {Object} with the JavaScript actions:
+     *     - from the name tree (like getJavaScript);
+     *     - from A or AA entries in the catalog dictionary.
+     *   , or `null` if no JavaScript exists.
+     */
+    getJSActions(): Promise<Object | null>;
     /**
      * @typedef {Object} OutlineNode
      * @property {string} title
@@ -733,6 +740,23 @@ export class PDFDocumentProxy {
         info: Object;
         metadata: Metadata;
     }>;
+    /**
+     * @typedef {Object} MarkInfo
+     * Properties correspond to Table 321 of the PDF 32000-1:2008 spec.
+     * @property {boolean} Marked
+     * @property {boolean} UserProperties
+     * @property {boolean} Suspects
+     */
+    /**
+     * @returns {Promise<MarkInfo | null>} A promise that is resolved with
+     *   a {MarkInfo} object that contains the MarkInfo flags for the PDF
+     *   document, or `null` when no MarkInfo values are present in the PDF file.
+     */
+    getMarkInfo(): Promise<{
+        Marked: boolean;
+        UserProperties: boolean;
+        Suspects: boolean;
+    } | null>;
     /**
      * @returns {Promise<TypedArray>} A promise that is resolved with a
      *   {TypedArray} that has the raw data from the PDF.
@@ -783,6 +807,23 @@ export class PDFDocumentProxy {
      *   {Uint8Array} containing the full data of the saved document.
      */
     saveDocument(annotationStorage: AnnotationStorage): Promise<Uint8Array>;
+    /**
+     * @returns {Promise<Array<Object> | null>} A promise that is resolved with an
+     *   {Array<Object>} containing /AcroForm field data for the JS sandbox,
+     *   or `null` when no field data is present in the PDF file.
+     */
+    getFieldObjects(): Promise<Array<Object> | null>;
+    /**
+     * @returns {Promise<boolean>} A promise that is resolved with `true`
+     *   if some /AcroForm fields have JavaScript actions.
+     */
+    hasJSActions(): Promise<boolean>;
+    /**
+     * @returns {Promise<Array<string> | null>} A promise that is resolved with an
+     *   {Array<string>} containing IDs of annotations that have a calculation
+     *   action, or `null` when no such annotations are present in the PDF file.
+     */
+    getCalculationOrderIds(): Promise<Array<string> | null>;
 }
 /**
  * Page getViewport parameters.
@@ -937,6 +978,11 @@ export class PDFPageProxy {
     getAnnotations({ intent }?: GetAnnotationsParameters): Promise<Array<any>>;
     annotationsPromise: any;
     annotationsIntent: string | undefined;
+    /**
+     * @returns {Promise<Object>} A promise that is resolved with an
+     *   {Object} with JS actions.
+     */
+    getJSActions(): Promise<Object>;
     /**
      * Begins the process of rendering a page to the desired context.
      *
@@ -966,6 +1012,7 @@ export class PDFPageProxy {
      * @private
      */
     private _destroy;
+    _jsActionsPromise: any;
     /**
      * Cleans up resources allocated by the page.
      *
@@ -1000,6 +1047,15 @@ export class PDFPageProxy {
      */
     get stats(): Object;
 }
+/**
+ * @typedef {Object} PDFWorkerParameters
+ * @property {string} [name] - The name of the worker.
+ * @property {Object} [port] - The `workerPort` object.
+ * @property {number} [verbosity] - Controls the logging level; the
+ *   constants from {@link VerbosityLevel} should be used.
+ */
+/** @type {any} */
+export const PDFWorker: any;
 /**
  * Sets the function that instantiates an {IPDFStream} as an alternative PDF
  * data transport.
@@ -1012,11 +1068,11 @@ export class PDFPageProxy {
 export function setPDFNetworkStreamFactory(pdfNetworkStreamFactory: IPDFStreamFactory): void;
 /** @type {string} */
 export const version: string;
-/** @type {string} */
-export const build: string;
 import { PageViewport } from "./display_utils.js";
 import { AnnotationStorage } from "./annotation_storage.js";
 import { OptionalContentConfig } from "./optional_content_config.js";
+import { DOMCanvasFactory } from "./display_utils.js";
+import { DOMCMapReaderFactory } from "./display_utils.js";
 /**
  * The loading task controls the operations required to load a PDF document
  * (such as network requests) and provides a way to listen for completion,

package/types/display/canvas.d.ts

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

package/types/display/display_utils.d.ts

@@ -17,45 +17,120 @@ export type PageViewportParameters = {
      * - The horizontal, i.e. x-axis, offset. The
      * default value is `0`.
      */
-    offsetX?: number;
+    offsetX?: number | undefined;
     /**
      * - The vertical, i.e. y-axis, offset. The
      * default value is `0`.
      */
-    offsetY?: number;
+    offsetY?: number | undefined;
     /**
      * - If true, the y-axis will not be flipped.
      * The default value is `false`.
      */
-    dontFlip?: boolean;
+    dontFlip?: boolean | undefined;
 };
 export type PageViewportCloneParameters = {
     /**
      * - The scale, overriding the one in the cloned
      * viewport. The default value is `this.scale`.
      */
-    scale?: number;
+    scale?: number | undefined;
     /**
      * - The rotation, in degrees, overriding the one
      * in the cloned viewport. The default value is `this.rotation`.
      */
-    rotation?: number;
+    rotation?: number | undefined;
     /**
      * - The horizontal, i.e. x-axis, offset.
      * The default value is `this.offsetX`.
      */
-    offsetX?: number;
+    offsetX?: number | undefined;
     /**
      * - The vertical, i.e. y-axis, offset.
      * The default value is `this.offsetY`.
      */
-    offsetY?: number;
+    offsetY?: number | undefined;
     /**
      * - If true, the x-axis will not be flipped.
      * The default value is `false`.
      */
-    dontFlip?: boolean;
+    dontFlip?: boolean | undefined;
 };
+/**
+ * @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;
+export class BaseCanvasFactory {
+    create(width: any, height: any): void;
+    reset(canvasAndContext: any, width: any, height: any): void;
+    destroy(canvasAndContext: any): void;
+}
+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 const DEFAULT_LINK_REL: "noopener noreferrer nofollow";
+export function deprecated(details: any): void;
+export class DOMCanvasFactory extends BaseCanvasFactory {
+    constructor({ ownerDocument }?: {
+        ownerDocument?: Document | undefined;
+    });
+    _document: Document;
+}
+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;
+}
+/**
+ * Gets the file name from a given URL.
+ * @param {string} url
+ */
+export function getFilenameFromUrl(url: string): string;
+export function isFetchSupported(): boolean;
+export function isValidFetchUrl(url: any, baseUrl: any): boolean;
+export namespace LinkTarget {
+    const NONE: number;
+    const SELF: number;
+    const BLANK: number;
+    const PARENT: number;
+    const TOP: number;
+}
+/**
+ * @param {string} src
+ * @param {boolean} [removeScriptElement]
+ * @returns {Promise<void>}
+ */
+export function loadScript(src: string, removeScriptElement?: boolean | undefined): Promise<void>;
 /**
  * @typedef {Object} PageViewportParameters
  * @property {Array<number>} viewBox - The xMin, yMin, xMax and
@@ -134,93 +209,6 @@ export class PageViewport {
      */
     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.
@@ -240,4 +228,17 @@ export class PDFDateString {
      */
     static toDateObject(input: string): Date | null;
 }
+declare const RenderingCancelledException_base: any;
+export class RenderingCancelledException extends RenderingCancelledException_base {
+    [x: string]: any;
+    constructor(msg: any, type: any);
+    type: any;
+}
+export class StatTimer {
+    started: any;
+    times: any[];
+    time(name: any): void;
+    timeEnd(name: any): void;
+    toString(): string;
+}
 export {};

package/types/display/fetch_stream.d.ts

@@ -23,7 +23,7 @@ declare class PDFFetchStreamReader {
     _headersCapability: import("../shared/util.js").PromiseCapability;
     _disableRange: any;
     _rangeChunkSize: any;
-    _abortController: AbortController;
+    _abortController: AbortController | undefined;
     _isStreamingSupported: boolean;
     _isRangeSupported: boolean;
     _headers: Headers;
@@ -51,7 +51,7 @@ declare class PDFFetchStreamRangeReader {
     _withCredentials: any;
     _readCapability: import("../shared/util.js").PromiseCapability;
     _isStreamingSupported: boolean;
-    _abortController: AbortController;
+    _abortController: AbortController | undefined;
     _headers: Headers;
     onProgress: any;
     get isStreamingSupported(): boolean;