unpdf 0.5.4 → 0.6.1

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

@@ -0,0 +1,203 @@
+export type PDFPageProxy = import("./api").PDFPageProxy;
+export type PageViewport = import("./display_utils").PageViewport;
+export type IDownloadManager = any;
+export type IPDFLinkService = import("../../web/interfaces").IPDFLinkService;
+export type AnnotationElementParameters = {
+    data: Object;
+    layer: HTMLDivElement;
+    linkService: IPDFLinkService;
+    downloadManager: any;
+    annotationStorage?: AnnotationStorage | undefined;
+    /**
+     * - Path for image resources, mainly
+     * for annotation icons. Include trailing slash.
+     */
+    imageResourcesPath?: string | undefined;
+    renderForms: boolean;
+    svgFactory: Object;
+    enableScripting?: boolean | undefined;
+    hasJSActions?: boolean | undefined;
+    fieldObjects?: Object | undefined;
+};
+export type AnnotationLayerParameters = {
+    viewport: PageViewport;
+    div: HTMLDivElement;
+    annotations: any[];
+    page: PDFPageProxy;
+    linkService: IPDFLinkService;
+    downloadManager: any;
+    annotationStorage?: AnnotationStorage | undefined;
+    /**
+     * - Path for image resources, mainly
+     * for annotation icons. Include trailing slash.
+     */
+    imageResourcesPath?: string | undefined;
+    renderForms: boolean;
+    /**
+     * - Enable embedded script execution.
+     */
+    enableScripting?: boolean | undefined;
+    /**
+     * - Some fields have JS actions.
+     * The default value is `false`.
+     */
+    hasJSActions?: boolean | undefined;
+    fieldObjects?: {
+        [x: string]: Object[];
+    } | null | undefined;
+    annotationCanvasMap?: Map<string, HTMLCanvasElement> | undefined;
+    accessibilityManager?: any;
+};
+/**
+ * @typedef {Object} AnnotationLayerParameters
+ * @property {PageViewport} viewport
+ * @property {HTMLDivElement} div
+ * @property {Array} annotations
+ * @property {PDFPageProxy} page
+ * @property {IPDFLinkService} linkService
+ * @property {IDownloadManager} downloadManager
+ * @property {AnnotationStorage} [annotationStorage]
+ * @property {string} [imageResourcesPath] - Path for image resources, mainly
+ *   for annotation icons. Include trailing slash.
+ * @property {boolean} renderForms
+ * @property {boolean} [enableScripting] - Enable embedded script execution.
+ * @property {boolean} [hasJSActions] - Some fields have JS actions.
+ *   The default value is `false`.
+ * @property {Object<string, Array<Object>> | null} [fieldObjects]
+ * @property {Map<string, HTMLCanvasElement>} [annotationCanvasMap]
+ * @property {TextAccessibilityManager} [accessibilityManager]
+ */
+/**
+ * Manage the layer containing all the annotations.
+ */
+export class AnnotationLayer {
+    constructor({ div, accessibilityManager, annotationCanvasMap, l10n, page, viewport, }: {
+        div: any;
+        accessibilityManager: any;
+        annotationCanvasMap: any;
+        l10n: any;
+        page: any;
+        viewport: any;
+    });
+    div: any;
+    l10n: any;
+    page: any;
+    viewport: any;
+    zIndex: number;
+    popupShow: any[] | undefined;
+    /**
+     * Render a new annotation layer with all annotation elements.
+     *
+     * @param {AnnotationLayerParameters} params
+     * @memberof AnnotationLayer
+     */
+    render(params: AnnotationLayerParameters): Promise<void>;
+    /**
+     * Update the annotation elements on existing annotation layer.
+     *
+     * @param {AnnotationLayerParameters} viewport
+     * @memberof AnnotationLayer
+     */
+    update({ viewport }: AnnotationLayerParameters): void;
+    getEditableAnnotations(): any[];
+    getEditableAnnotation(id: any): any;
+    #private;
+}
+export class FreeTextAnnotationElement extends AnnotationElement {
+    constructor(parameters: any);
+    textContent: any;
+    textPosition: any;
+    annotationEditorType: number;
+    render(): HTMLElement | undefined;
+}
+export class InkAnnotationElement extends AnnotationElement {
+    constructor(parameters: any);
+    containerClassName: string;
+    svgElementName: string;
+    annotationEditorType: number;
+    render(): HTMLElement | undefined;
+    getElementsToTriggerPopup(): any[];
+    #private;
+}
+export class StampAnnotationElement extends AnnotationElement {
+    constructor(parameters: any);
+    render(): HTMLElement | undefined;
+}
+import { AnnotationStorage } from "./annotation_storage.js";
+declare class AnnotationElement {
+    constructor(parameters: any, { isRenderable, ignoreBorder, createQuadrilaterals, }?: {
+        isRenderable?: boolean | undefined;
+        ignoreBorder?: boolean | undefined;
+        createQuadrilaterals?: boolean | undefined;
+    });
+    isRenderable: boolean;
+    data: any;
+    layer: any;
+    linkService: any;
+    downloadManager: any;
+    imageResourcesPath: any;
+    renderForms: any;
+    svgFactory: any;
+    annotationStorage: any;
+    enableScripting: any;
+    hasJSActions: any;
+    _fieldObjects: any;
+    parent: any;
+    container: HTMLElement | undefined;
+    /**
+     * Create an empty container for the annotation's HTML element.
+     *
+     * @private
+     * @param {boolean} ignoreBorder
+     * @memberof AnnotationElement
+     * @returns {HTMLElement} A section element.
+     */
+    private _createContainer;
+    setRotation(angle: any, container?: HTMLElement | undefined): void;
+    get _commonActions(): any;
+    _dispatchEventFromSandbox(actions: any, jsEvent: any): void;
+    _setDefaultPropertiesFromJS(element: any): void;
+    /**
+     * Create quadrilaterals from the annotation's quadpoints.
+     *
+     * @private
+     * @memberof AnnotationElement
+     */
+    private _createQuadrilaterals;
+    /**
+     * Create a popup for the annotation's HTML element. This is used for
+     * annotations that do not have a Popup entry in the dictionary, but
+     * are of a type that works with popups (such as Highlight annotations).
+     *
+     * @private
+     * @memberof AnnotationElement
+     */
+    private _createPopup;
+    /**
+     * Render the annotation's HTML element(s).
+     *
+     * @public
+     * @memberof AnnotationElement
+     */
+    public render(): void;
+    /**
+     * @private
+     * @returns {Array}
+     */
+    private _getElementsByName;
+    show(): void;
+    hide(): void;
+    /**
+     * Get the HTML element(s) which can trigger a popup when clicked or hovered.
+     *
+     * @public
+     * @memberof AnnotationElement
+     * @returns {Array<HTMLElement>|HTMLElement} An array of elements or an
+     *          element.
+     */
+    public getElementsToTriggerPopup(): Array<HTMLElement> | HTMLElement;
+    addHighlightArea(): void;
+    _editOnDoubleClick(): void;
+    #private;
+}
+export {};

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

@@ -0,0 +1,89 @@
+/**
+ * Key/value storage for annotation data in forms.
+ */
+export class AnnotationStorage {
+    onSetModified: any;
+    onResetModified: any;
+    onAnnotationEditor: any;
+    /**
+     * Get the value for a given key if it exists, or return the default value.
+     * @param {string} key
+     * @param {Object} defaultValue
+     * @returns {Object}
+     */
+    getValue(key: string, defaultValue: Object): Object;
+    /**
+     * Get the value for a given key.
+     * @param {string} key
+     * @returns {Object}
+     */
+    getRawValue(key: string): Object;
+    /**
+     * Remove a value from the storage.
+     * @param {string} key
+     */
+    remove(key: string): void;
+    /**
+     * Set the value for a given key
+     * @param {string} key
+     * @param {Object} value
+     */
+    setValue(key: string, value: Object): void;
+    /**
+     * Check if the storage contains the given key.
+     * @param {string} key
+     * @returns {boolean}
+     */
+    has(key: string): boolean;
+    /**
+     * @returns {Object | null}
+     */
+    getAll(): Object | null;
+    /**
+     * @param {Object} obj
+     */
+    setAll(obj: Object): void;
+    get size(): number;
+    resetModified(): void;
+    /**
+     * @returns {PrintAnnotationStorage}
+     */
+    get print(): PrintAnnotationStorage;
+    /**
+     * PLEASE NOTE: Only intended for usage within the API itself.
+     * @ignore
+     */
+    get serializable(): Readonly<{
+        map: null;
+        hash: "";
+        transfers: undefined;
+    }> | {
+        map: Map<any, any>;
+        hash: string;
+        transfers: any[];
+    };
+    #private;
+}
+/**
+ * A special `AnnotationStorage` for use during printing, where the serializable
+ * data is *frozen* upon initialization, to prevent scripting from modifying its
+ * contents. (Necessary since printing is triggered synchronously in browsers.)
+ */
+export class PrintAnnotationStorage extends AnnotationStorage {
+    constructor(parent: any);
+    /**
+     * PLEASE NOTE: Only intended for usage within the API itself.
+     * @ignore
+     */
+    get serializable(): {
+        map: any;
+        hash: any;
+        transfers: any;
+    };
+    #private;
+}
+export const SerializableEmpty: Readonly<{
+    map: null;
+    hash: "";
+    transfers: undefined;
+}>;