pdfjs-serverless 0.1.0 → 0.2.1

package/dist/types/web/pdf_link_service.d.ts

@@ -0,0 +1,243 @@
+export type ExternalLinkParameters = {
+    /**
+     * - An absolute URL.
+     */
+    url: string;
+    /**
+     * - The link target. The default value is
+     * `LinkTarget.NONE`.
+     */
+    target?: {
+        NONE: number;
+        SELF: number;
+        BLANK: number;
+        PARENT: number;
+        TOP: number;
+    } | undefined;
+    /**
+     * - The link relationship. The default value is
+     * `DEFAULT_LINK_REL`.
+     */
+    rel?: string | undefined;
+    /**
+     * - Whether the link should be enabled. The
+     * default value is true.
+     */
+    enabled?: boolean | undefined;
+};
+export type EventBus = import("./event_utils").EventBus;
+export type IPDFLinkService = import("./interfaces").IPDFLinkService;
+export type PDFLinkServiceOptions = {
+    /**
+     * - The application event bus.
+     */
+    eventBus: EventBus;
+    /**
+     * - Specifies the `target` attribute
+     * for external links. Must use one of the values from {LinkTarget}.
+     * Defaults to using no target.
+     */
+    externalLinkTarget?: number | undefined;
+    /**
+     * - Specifies the `rel` attribute for
+     * external links. Defaults to stripping the referrer.
+     */
+    externalLinkRel?: string | undefined;
+    /**
+     * - Ignores the zoom argument,
+     * thus preserving the current zoom level in the viewer, when navigating
+     * to internal destinations. The default value is `false`.
+     */
+    ignoreDestinationZoom?: boolean | undefined;
+};
+export namespace LinkTarget {
+    let NONE: number;
+    let SELF: number;
+    let BLANK: number;
+    let PARENT: number;
+    let TOP: number;
+}
+/**
+ * @typedef {Object} PDFLinkServiceOptions
+ * @property {EventBus} eventBus - The application event bus.
+ * @property {number} [externalLinkTarget] - Specifies the `target` attribute
+ *   for external links. Must use one of the values from {LinkTarget}.
+ *   Defaults to using no target.
+ * @property {string} [externalLinkRel] - Specifies the `rel` attribute for
+ *   external links. Defaults to stripping the referrer.
+ * @property {boolean} [ignoreDestinationZoom] - Ignores the zoom argument,
+ *   thus preserving the current zoom level in the viewer, when navigating
+ *   to internal destinations. The default value is `false`.
+ */
+/**
+ * Performs navigation functions inside PDF, such as opening specified page,
+ * or destination.
+ * @implements {IPDFLinkService}
+ */
+export class PDFLinkService implements IPDFLinkService {
+    static "__#42@#isValidExplicitDestination"(dest: any): boolean;
+    /**
+     * @param {PDFLinkServiceOptions} options
+     */
+    constructor({ eventBus, externalLinkTarget, externalLinkRel, ignoreDestinationZoom, }?: PDFLinkServiceOptions);
+    eventBus: import("./event_utils").EventBus;
+    externalLinkTarget: number;
+    externalLinkRel: string;
+    externalLinkEnabled: boolean;
+    _ignoreDestinationZoom: boolean;
+    baseUrl: any;
+    pdfDocument: any;
+    pdfViewer: any;
+    pdfHistory: any;
+    setDocument(pdfDocument: any, baseUrl?: null): void;
+    setViewer(pdfViewer: any): void;
+    setHistory(pdfHistory: any): void;
+    /**
+     * @type {number}
+     */
+    get pagesCount(): number;
+    /**
+     * @param {number} value
+     */
+    set page(arg: number);
+    /**
+     * @type {number}
+     */
+    get page(): number;
+    /**
+     * @param {number} value
+     */
+    set rotation(arg: number);
+    /**
+     * @type {number}
+     */
+    get rotation(): number;
+    /**
+     * @type {boolean}
+     */
+    get isInPresentationMode(): boolean;
+    /**
+     * This method will, when available, also update the browser history.
+     *
+     * @param {string|Array} dest - The named, or explicit, PDF destination.
+     */
+    goToDestination(dest: string | any[]): Promise<void>;
+    /**
+     * This method will, when available, also update the browser history.
+     *
+     * @param {number|string} val - The page number, or page label.
+     */
+    goToPage(val: number | string): void;
+    /**
+     * Wrapper around the `addLinkAttributes` helper function.
+     * @param {HTMLAnchorElement} link
+     * @param {string} url
+     * @param {boolean} [newWindow]
+     */
+    addLinkAttributes(link: HTMLAnchorElement, url: string, newWindow?: boolean | undefined): void;
+    /**
+     * @param {string|Array} dest - The PDF destination object.
+     * @returns {string} The hyperlink to the PDF object.
+     */
+    getDestinationHash(dest: string | any[]): string;
+    /**
+     * Prefix the full url on anchor links to make sure that links are resolved
+     * relative to the current URL instead of the one defined in <base href>.
+     * @param {string} anchor - The anchor hash, including the #.
+     * @returns {string} The hyperlink to the PDF object.
+     */
+    getAnchorUrl(anchor: string): string;
+    /**
+     * @param {string} hash
+     */
+    setHash(hash: string): void;
+    /**
+     * @param {string} action
+     */
+    executeNamedAction(action: string): void;
+    /**
+     * @param {Object} action
+     */
+    executeSetOCGState(action: Object): Promise<void>;
+    /**
+     * @param {number} pageNum - page number.
+     * @param {Object} pageRef - reference to the page.
+     */
+    cachePageRef(pageNum: number, pageRef: Object): void;
+    /**
+     * @ignore
+     */
+    _cachedPageNumber(pageRef: any): any;
+    #private;
+}
+/**
+ * @implements {IPDFLinkService}
+ */
+export class SimpleLinkService implements IPDFLinkService {
+    externalLinkEnabled: boolean;
+    /**
+     * @type {number}
+     */
+    get pagesCount(): number;
+    /**
+     * @param {number} value
+     */
+    set page(arg: number);
+    /**
+     * @type {number}
+     */
+    get page(): number;
+    /**
+     * @param {number} value
+     */
+    set rotation(arg: number);
+    /**
+     * @type {number}
+     */
+    get rotation(): number;
+    /**
+     * @type {boolean}
+     */
+    get isInPresentationMode(): boolean;
+    /**
+     * @param {string|Array} dest - The named, or explicit, PDF destination.
+     */
+    goToDestination(dest: string | any[]): Promise<void>;
+    /**
+     * @param {number|string} val - The page number, or page label.
+     */
+    goToPage(val: number | string): void;
+    /**
+     * @param {HTMLAnchorElement} link
+     * @param {string} url
+     * @param {boolean} [newWindow]
+     */
+    addLinkAttributes(link: HTMLAnchorElement, url: string, newWindow?: boolean | undefined): void;
+    /**
+     * @param dest - The PDF destination object.
+     * @returns {string} The hyperlink to the PDF object.
+     */
+    getDestinationHash(dest: any): string;
+    /**
+     * @param hash - The PDF parameters/hash.
+     * @returns {string} The hyperlink to the PDF object.
+     */
+    getAnchorUrl(hash: any): string;
+    /**
+     * @param {string} hash
+     */
+    setHash(hash: string): void;
+    /**
+     * @param {string} action
+     */
+    executeNamedAction(action: string): void;
+    /**
+     * @param {Object} action
+     */
+    executeSetOCGState(action: Object): void;
+    /**
+     * @param {number} pageNum - page number.
+     * @param {Object} pageRef - reference to the page.
+     */
+    cachePageRef(pageNum: number, pageRef: Object): void;
+}

package/dist/types/web/pdf_page_view.d.ts

@@ -0,0 +1,209 @@
+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 IL10n = import("./interfaces").IL10n;
+export type IRenderableView = import("./interfaces").IRenderableView;
+export type PDFRenderingQueue = import("./pdf_rendering_queue").PDFRenderingQueue;
+export type PDFPageViewOptions = {
+    /**
+     * - The viewer element.
+     */
+    container?: HTMLDivElement | undefined;
+    /**
+     * - The application event bus.
+     */
+    eventBus: EventBus;
+    /**
+     * - The page unique ID (normally its number).
+     */
+    id: number;
+    /**
+     * - The page scale display.
+     */
+    scale?: number | undefined;
+    /**
+     * - The page viewport.
+     */
+    defaultViewport: PageViewport;
+    /**
+     * -
+     * A promise that is resolved with an {@link OptionalContentConfig } instance.
+     * The default value is `null`.
+     */
+    optionalContentConfigPromise?: Promise<import("../src/display/optional_content_config").OptionalContentConfig> | undefined;
+    /**
+     * - The rendering queue object.
+     */
+    renderingQueue?: import("./pdf_rendering_queue").PDFRenderingQueue | 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;
+    /**
+     * - Path for image resources, mainly
+     * for annotation icons. Include trailing slash.
+     */
+    imageResourcesPath?: string | 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;
+    /**
+     * - Overwrites background and foreground colors
+     * with user defined ones in order to improve readability in high contrast
+     * mode.
+     */
+    pageColors?: Object | undefined;
+    /**
+     * - Localization service.
+     */
+    l10n?: import("./interfaces").IL10n | undefined;
+    /**
+     * - The function that is used to lookup
+     * the necessary layer-properties.
+     */
+    layerProperties?: Function | undefined;
+};
+/**
+ * @implements {IRenderableView}
+ */
+export class PDFPageView implements IRenderableView {
+    /**
+     * @param {PDFPageViewOptions} options
+     */
+    constructor(options: PDFPageViewOptions);
+    id: number;
+    renderingId: string;
+    pdfPage: any;
+    pageLabel: string | null;
+    rotation: number;
+    scale: number;
+    viewport: import("../src/display/display_utils").PageViewport;
+    pdfPageRotate: number;
+    _optionalContentConfigPromise: Promise<import("../src/display/optional_content_config").OptionalContentConfig> | null;
+    imageResourcesPath: string;
+    isOffscreenCanvasSupported: boolean;
+    maxCanvasPixels: any;
+    pageColors: Object | null;
+    eventBus: import("./event_utils").EventBus;
+    renderingQueue: import("./pdf_rendering_queue").PDFRenderingQueue | undefined;
+    l10n: {
+        getLanguage(): Promise<string>;
+        getDirection(): Promise<string>;
+        get(key: any, args?: null, fallback?: any): Promise<any>;
+        translate(element: any): Promise<void>;
+    };
+    renderTask: any;
+    resume: (() => void) | null;
+    _isStandalone: boolean | undefined;
+    _container: HTMLDivElement | undefined;
+    _annotationCanvasMap: any;
+    annotationLayer: AnnotationLayerBuilder | null;
+    annotationEditorLayer: AnnotationEditorLayerBuilder | null;
+    textLayer: TextLayerBuilder | null;
+    zoomLayer: ParentNode | null;
+    xfaLayer: XfaLayerBuilder | null;
+    structTreeLayer: any;
+    div: HTMLDivElement;
+    set renderingState(arg: number);
+    get renderingState(): number;
+    setPdfPage(pdfPage: any): void;
+    destroy(): void;
+    get _textHighlighter(): any;
+    /**
+     * @private
+     */
+    private _resetZoomLayer;
+    reset({ keepZoomLayer, keepAnnotationLayer, keepAnnotationEditorLayer, keepXfaLayer, keepTextLayer, }?: {
+        keepZoomLayer?: boolean | undefined;
+        keepAnnotationLayer?: boolean | undefined;
+        keepAnnotationEditorLayer?: boolean | undefined;
+        keepXfaLayer?: boolean | undefined;
+        keepTextLayer?: boolean | undefined;
+    }): void;
+    /**
+     * @typedef {Object} PDFPageViewUpdateParameters
+     * @property {number} [scale] The new scale, if specified.
+     * @property {number} [rotation] The new rotation, if specified.
+     * @property {Promise<OptionalContentConfig>} [optionalContentConfigPromise]
+     *   A promise that is resolved with an {@link OptionalContentConfig}
+     *   instance. The default value is `null`.
+     * @property {number} [drawingDelay]
+     */
+    /**
+     * Update e.g. the scale and/or rotation of the page.
+     * @param {PDFPageViewUpdateParameters}
+     */
+    update({ scale, rotation, optionalContentConfigPromise, drawingDelay, }: {
+        /**
+         * The new scale, if specified.
+         */
+        scale?: number | undefined;
+        /**
+         * The new rotation, if specified.
+         */
+        rotation?: number | undefined;
+        /**
+         * A promise that is resolved with an {@link OptionalContentConfig }instance. The default value is `null`.
+         */
+        optionalContentConfigPromise?: Promise<import("../src/display/optional_content_config").OptionalContentConfig> | undefined;
+        drawingDelay?: number | undefined;
+    }): void;
+    /**
+     * PLEASE NOTE: Most likely you want to use the `this.reset()` method,
+     *              rather than calling this one directly.
+     */
+    cancelRendering({ keepAnnotationLayer, keepAnnotationEditorLayer, keepXfaLayer, keepTextLayer, cancelExtraDelay, }?: {
+        keepAnnotationLayer?: boolean | undefined;
+        keepAnnotationEditorLayer?: boolean | undefined;
+        keepXfaLayer?: boolean | undefined;
+        keepTextLayer?: boolean | undefined;
+        cancelExtraDelay?: number | undefined;
+    }): void;
+    cssTransform({ target, redrawAnnotationLayer, redrawAnnotationEditorLayer, redrawXfaLayer, redrawTextLayer, hideTextLayer, }: {
+        target: any;
+        redrawAnnotationLayer?: boolean | undefined;
+        redrawAnnotationEditorLayer?: boolean | undefined;
+        redrawXfaLayer?: boolean | undefined;
+        redrawTextLayer?: boolean | undefined;
+        hideTextLayer?: boolean | undefined;
+    }): void;
+    get width(): number;
+    get height(): number;
+    getPagePoint(x: any, y: any): any[];
+    draw(): Promise<any>;
+    canvas: HTMLCanvasElement | undefined;
+    outputScale: OutputScale | undefined;
+    /**
+     * @param {string|null} label
+     */
+    setPageLabel(label: string | null): void;
+    /**
+     * For use by the `PDFThumbnailView.setImage`-method.
+     * @ignore
+     */
+    get thumbnailCanvas(): HTMLCanvasElement | null | undefined;
+    #private;
+}
+import { AnnotationLayerBuilder } from "./annotation_layer_builder.js";
+import { AnnotationEditorLayerBuilder } from "./annotation_editor_layer_builder.js";
+import { TextLayerBuilder } from "./text_layer_builder.js";
+import { XfaLayerBuilder } from "./xfa_layer_builder.js";
+import { OutputScale } from "./ui_utils.js";

package/dist/types/web/pdf_rendering_queue.d.ts

@@ -0,0 +1,53 @@
+export type IRenderableView = import("./interfaces").IRenderableView;
+export type PDFViewer = import("./pdf_viewer").PDFViewer;
+export type PDFThumbnailViewer = import("./pdf_thumbnail_viewer").PDFThumbnailViewer;
+/**
+ * Controls rendering of the views for pages and thumbnails.
+ */
+export class PDFRenderingQueue {
+    pdfViewer: import("./pdf_viewer").PDFViewer | null;
+    pdfThumbnailViewer: import("./pdf_thumbnail_viewer").PDFThumbnailViewer | null;
+    onIdle: any;
+    highestPriorityPage: string | null;
+    /** @type {number} */
+    idleTimeout: number;
+    printing: boolean;
+    isThumbnailViewEnabled: boolean;
+    /**
+     * @param {PDFViewer} pdfViewer
+     */
+    setViewer(pdfViewer: PDFViewer): void;
+    /**
+     * @param {PDFThumbnailViewer} pdfThumbnailViewer
+     */
+    setThumbnailViewer(pdfThumbnailViewer: PDFThumbnailViewer): void;
+    /**
+     * @param {IRenderableView} view
+     * @returns {boolean}
+     */
+    isHighestPriority(view: IRenderableView): boolean;
+    /**
+     * @param {Object} currentlyVisiblePages
+     */
+    renderHighestPriority(currentlyVisiblePages: Object): void;
+    /**
+     * @param {Object} visible
+     * @param {Array} views
+     * @param {boolean} scrolledDown
+     * @param {boolean} [preRenderExtra]
+     */
+    getHighestPriority(visible: Object, views: any[], scrolledDown: boolean, preRenderExtra?: boolean | undefined): any;
+    /**
+     * @param {IRenderableView} view
+     * @returns {boolean}
+     */
+    isViewFinished(view: IRenderableView): boolean;
+    /**
+     * Render a page or thumbnail view. This calls the appropriate function
+     * based on the views state. If the view is already rendered it will return
+     * `false`.
+     *
+     * @param {IRenderableView} view
+     */
+    renderView(view: IRenderableView): boolean;
+}

package/dist/types/web/pdf_scripting_manager.component.d.ts

@@ -0,0 +1,5 @@
+export { PDFScriptingManagerComponents as PDFScriptingManager };
+declare class PDFScriptingManagerComponents extends PDFScriptingManager {
+    constructor(options: any);
+}
+import { PDFScriptingManager } from "./pdf_scripting_manager.js";

package/dist/types/web/pdf_scripting_manager.d.ts

@@ -0,0 +1,61 @@
+export type EventBus = import("./event_utils").EventBus;
+export type PDFScriptingManagerOptions = {
+    /**
+     * - The application event bus.
+     */
+    eventBus: EventBus;
+    /**
+     * - The path and filename of the scripting
+     * bundle.
+     */
+    sandboxBundleSrc: string;
+    /**
+     * - The factory that is used when
+     * initializing scripting; must contain a `createScripting` method.
+     * PLEASE NOTE: Primarily intended for the default viewer use-case.
+     */
+    externalServices?: Object | undefined;
+    /**
+     * - The function that is used to lookup
+     * the necessary document properties.
+     */
+    docProperties?: Function | undefined;
+};
+/**
+ * @typedef {Object} PDFScriptingManagerOptions
+ * @property {EventBus} eventBus - The application event bus.
+ * @property {string} sandboxBundleSrc - The path and filename of the scripting
+ *   bundle.
+ * @property {Object} [externalServices] - The factory that is used when
+ *   initializing scripting; must contain a `createScripting` method.
+ *   PLEASE NOTE: Primarily intended for the default viewer use-case.
+ * @property {function} [docProperties] - The function that is used to lookup
+ *   the necessary document properties.
+ */
+export class PDFScriptingManager {
+    /**
+     * @param {PDFScriptingManagerOptions} options
+     */
+    constructor({ eventBus, sandboxBundleSrc, externalServices, docProperties, }: PDFScriptingManagerOptions);
+    setViewer(pdfViewer: any): void;
+    setDocument(pdfDocument: any): Promise<void>;
+    dispatchWillSave(): Promise<any>;
+    dispatchDidSave(): Promise<any>;
+    dispatchWillPrint(): Promise<any>;
+    dispatchDidPrint(): Promise<any>;
+    get destroyPromise(): any;
+    get ready(): boolean;
+    /**
+     * @private
+     */
+    private get _internalEvents();
+    /**
+     * @private
+     */
+    private get _pageOpenPending();
+    /**
+     * @private
+     */
+    private get _visitedPages();
+    #private;
+}

package/dist/types/web/pdf_single_page_viewer.d.ts

@@ -0,0 +1,7 @@
+export class PDFSinglePageViewer extends PDFViewer {
+    set scrollMode(arg: any);
+    _updateScrollMode(): void;
+    set spreadMode(arg: any);
+    _updateSpreadMode(): void;
+}
+import { PDFViewer } from "./pdf_viewer.js";