unpdf 0.7.1 → 0.8.0

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

@@ -18,12 +18,12 @@ export class IDownloadManager {
      */
     downloadData(data: Uint8Array, filename: string, contentType?: string | undefined): void;
     /**
-     * @param {HTMLElement} element
      * @param {Uint8Array} data
      * @param {string} filename
+     * @param {string | null} [dest]
      * @returns {boolean} Indicating if the data was opened.
      */
-    openOrDownloadData(element: HTMLElement, data: Uint8Array, filename: string): boolean;
+    openOrDownloadData(data: Uint8Array, filename: string, dest?: string | null | undefined): boolean;
     /**
      * @param {Blob} blob
      * @param {string} url
@@ -37,29 +37,37 @@ export class IDownloadManager {
  */
 export class IL10n {
     /**
-     * @returns {Promise<string>} - Resolves to the current locale.
+     * @returns {string} - The current locale.
      */
-    getLanguage(): Promise<string>;
+    getLanguage(): string;
     /**
-     * @returns {Promise<string>} - Resolves to 'rtl' or 'ltr'.
+     * @returns {string} - 'rtl' or 'ltr'.
      */
-    getDirection(): Promise<string>;
+    getDirection(): string;
     /**
      * Translates text identified by the key and adds/formats data using the args
      * property bag. If the key was not found, translation falls back to the
      * fallback text.
-     * @param {string} key
+     * @param {Array | string} ids
      * @param {Object | null} [args]
      * @param {string} [fallback]
      * @returns {Promise<string>}
      */
-    get(key: string, args?: Object | null | undefined, fallback?: string | undefined): Promise<string>;
+    get(ids: any[] | string, args?: Object | null | undefined, fallback?: string | undefined): Promise<string>;
     /**
      * Translates HTML element.
      * @param {HTMLElement} element
      * @returns {Promise<void>}
      */
     translate(element: HTMLElement): Promise<void>;
+    /**
+     * Pause the localization.
+     */
+    pause(): void;
+    /**
+     * Resume the localization.
+     */
+    resume(): void;
 }
 /** @typedef {import("../src/display/api").PDFPageProxy} PDFPageProxy */
 /** @typedef {import("../src/display/display_utils").PageViewport} PageViewport */

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

@@ -0,0 +1,27 @@
+export type IL10n = import("./interfaces").IL10n;
+/** @typedef {import("./interfaces").IL10n} IL10n */
+/**
+ * @implements {IL10n}
+ */
+export class L10n implements IL10n {
+    static "__#46@#fixupLangCode"(langCode: any): any;
+    static "__#46@#isRTL"(lang: any): boolean;
+    constructor({ lang, isRTL }: {
+        lang: any;
+        isRTL: any;
+    }, l10n?: null);
+    _setL10n(l10n: any): void;
+    /** @inheritdoc */
+    getLanguage(): any;
+    /** @inheritdoc */
+    getDirection(): string;
+    /** @inheritdoc */
+    get(ids: any, args: null | undefined, fallback: any): Promise<any>;
+    /** @inheritdoc */
+    translate(element: any): Promise<void>;
+    /** @inheritdoc */
+    pause(): void;
+    /** @inheritdoc */
+    resume(): void;
+    #private;
+}

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

@@ -1,7 +1,9 @@
-export function getL10nFallback(key: any, args: any): any;
+export type IL10n = import("./interfaces").IL10n;
 export namespace NullL10n {
-    function getLanguage(): Promise<string>;
-    function getDirection(): Promise<string>;
-    function get(key: any, args?: null, fallback?: any): Promise<any>;
-    function translate(element: any): Promise<void>;
+    function getLanguage(): any;
+    function getDirection(): any;
+    function get(ids: any, args: null | undefined, fallback: any): Promise<any>;
+    function translate(element: any): Promise<any>;
+    function pause(): any;
+    function resume(): any;
 }

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

@@ -102,7 +102,8 @@ export class PDFFindController {
     _pagesToSearch: number | null | undefined;
     _pendingFindMatches: Set<any> | undefined;
     _resumePageIdx: any;
-    _firstPageCapability: any;
+    _firstPageCapability: PromiseCapability | undefined;
     _rawQuery: any;
     #private;
 }
+import { PromiseCapability } from "../src/pdf";

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

@@ -75,7 +75,7 @@ export namespace LinkTarget {
  * @implements {IPDFLinkService}
  */
 export class PDFLinkService implements IPDFLinkService {
-    static "__#42@#isValidExplicitDestination"(dest: any): boolean;
+    static "__#43@#isValidExplicitDestination"(dest: any): boolean;
     /**
      * @param {PDFLinkServiceOptions} options
      */

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

@@ -76,10 +76,10 @@ export type PDFPageViewOptions = {
      */
     l10n?: import("./interfaces").IL10n | undefined;
     /**
-     * - The function that is used to lookup
+     * - The object that is used to lookup
      * the necessary layer-properties.
      */
-    layerProperties?: Function | undefined;
+    layerProperties?: Object | undefined;
 };
 /**
  * @implements {IRenderableView}
@@ -105,10 +105,12 @@ export class PDFPageView implements IRenderableView {
     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>;
+        getLanguage(): any;
+        getDirection(): any;
+        get(ids: any, args: null | undefined, fallback: any): Promise<any>;
+        translate(element: any): Promise<any>;
+        pause(): any;
+        resume(): any;
     };
     renderTask: any;
     resume: (() => void) | null;
@@ -149,7 +151,7 @@ export class PDFPageView implements IRenderableView {
      */
     /**
      * Update e.g. the scale and/or rotation of the page.
-     * @param {PDFPageViewUpdateParameters}
+     * @param {PDFPageViewUpdateParameters} params
      */
     update({ scale, rotation, optionalContentConfigPromise, drawingDelay, }: {
         /**

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

@@ -1,5 +1,6 @@
+export type OptionalContentConfig = import("../src/display/optional_content_config").OptionalContentConfig;
+export type PageViewport = import("../src/display/display_utils").PageViewport;
 export type EventBus = import("./event_utils").EventBus;
-export type IL10n = import("./interfaces").IL10n;
 export type IPDFLinkService = import("./interfaces").IPDFLinkService;
 export type IRenderableView = import("./interfaces").IRenderableView;
 export type PDFRenderingQueue = import("./pdf_rendering_queue").PDFRenderingQueue;
@@ -25,7 +26,7 @@ export type PDFThumbnailViewOptions = {
      * A promise that is resolved with an {@link OptionalContentConfig } instance.
      * The default value is `null`.
      */
-    optionalContentConfigPromise?: Promise<OptionalContentConfig> | undefined;
+    optionalContentConfigPromise?: Promise<import("../src/display/optional_content_config").OptionalContentConfig> | undefined;
     /**
      * - The navigation/linking service.
      */
@@ -34,10 +35,6 @@ export type PDFThumbnailViewOptions = {
      * - The rendering queue object.
      */
     renderingQueue: PDFRenderingQueue;
-    /**
-     * - Localization service.
-     */
-    l10n: IL10n;
     /**
      * - Overwrites background and foreground colors
      * with user defined ones in order to improve readability in high contrast
@@ -52,15 +49,15 @@ export class PDFThumbnailView implements IRenderableView {
     /**
      * @param {PDFThumbnailViewOptions} options
      */
-    constructor({ container, eventBus, id, defaultViewport, optionalContentConfigPromise, linkService, renderingQueue, l10n, pageColors, }: PDFThumbnailViewOptions);
+    constructor({ container, eventBus, id, defaultViewport, optionalContentConfigPromise, linkService, renderingQueue, pageColors, }: PDFThumbnailViewOptions);
     id: number;
     renderingId: string;
     pageLabel: string | null;
     pdfPage: any;
     rotation: number;
-    viewport: PageViewport;
-    pdfPageRotate: any;
-    _optionalContentConfigPromise: Promise<OptionalContentConfig> | null;
+    viewport: import("../src/display/display_utils").PageViewport;
+    pdfPageRotate: number;
+    _optionalContentConfigPromise: Promise<import("../src/display/optional_content_config").OptionalContentConfig> | null;
     pageColors: Object | null;
     eventBus: import("./event_utils").EventBus;
     linkService: import("./interfaces").IPDFLinkService;
@@ -68,7 +65,6 @@ export class PDFThumbnailView implements IRenderableView {
     renderTask: any;
     renderingState: number;
     resume: (() => void) | null;
-    l10n: import("./interfaces").IL10n;
     anchor: HTMLAnchorElement;
     div: HTMLDivElement;
     _placeholderImg: HTMLDivElement;
@@ -100,8 +96,6 @@ export class PDFThumbnailView implements IRenderableView {
      * @private
      */
     private _reduceImage;
-    get _thumbPageTitle(): Promise<string>;
-    get _thumbPageCanvas(): Promise<string>;
     /**
      * @param {string|null} label
      */
@@ -119,13 +113,12 @@ export class PDFThumbnailView implements IRenderableView {
  *   The default value is `null`.
  * @property {IPDFLinkService} linkService - The navigation/linking service.
  * @property {PDFRenderingQueue} renderingQueue - The rendering queue object.
- * @property {IL10n} l10n - Localization service.
  * @property {Object} [pageColors] - Overwrites background and foreground colors
  *   with user defined ones in order to improve readability in high contrast
  *   mode.
  */
 export class TempImageFactory {
-    static "__#51@#tempCanvas": null;
+    static "__#55@#tempCanvas": null;
     static getCanvas(width: any, height: any): (HTMLCanvasElement | CanvasRenderingContext2D | null)[];
     static destroyCanvas(): void;
 }

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

@@ -1,6 +1,6 @@
 export type PDFDocumentProxy = import("../src/display/api").PDFDocumentProxy;
+export type PDFPageProxy = import("../src/display/api").PDFPageProxy;
 export type EventBus = import("./event_utils").EventBus;
-export type IL10n = import("./interfaces").IL10n;
 export type IPDFLinkService = import("./interfaces").IPDFLinkService;
 export type PDFRenderingQueue = import("./pdf_rendering_queue").PDFRenderingQueue;
 export type PDFThumbnailViewerOptions = {
@@ -21,10 +21,6 @@ export type PDFThumbnailViewerOptions = {
      * - The rendering queue object.
      */
     renderingQueue: PDFRenderingQueue;
-    /**
-     * - Localization service.
-     */
-    l10n: IL10n;
     /**
      * - Overwrites background and foreground colors
      * with user defined ones in order to improve readability in high contrast
@@ -39,7 +35,6 @@ export type PDFThumbnailViewerOptions = {
  * @property {EventBus} eventBus - The application event bus.
  * @property {IPDFLinkService} linkService - The navigation/linking service.
  * @property {PDFRenderingQueue} renderingQueue - The rendering queue object.
- * @property {IL10n} l10n - Localization service.
  * @property {Object} [pageColors] - Overwrites background and foreground colors
  *   with user defined ones in order to improve readability in high contrast
  *   mode.
@@ -51,12 +46,11 @@ export class PDFThumbnailViewer {
     /**
      * @param {PDFThumbnailViewerOptions} options
      */
-    constructor({ container, eventBus, linkService, renderingQueue, l10n, pageColors, }: PDFThumbnailViewerOptions);
+    constructor({ container, eventBus, linkService, renderingQueue, pageColors, }: PDFThumbnailViewerOptions);
     container: HTMLDivElement;
     eventBus: import("./event_utils").EventBus;
     linkService: import("./interfaces").IPDFLinkService;
     renderingQueue: import("./pdf_rendering_queue").PDFRenderingQueue;
-    l10n: import("./interfaces").IL10n;
     pageColors: Object | null;
     scroll: {
         right: boolean;

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

@@ -6,6 +6,8 @@ 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 PDFFindController = import("./pdf_find_controller").PDFFindController;
+export type PDFScriptingManager = import("./pdf_scripting_manager").PDFScriptingManager;
 export type PDFViewerOptions = {
     /**
      * - The container for the viewer element.
@@ -32,12 +34,12 @@ export type PDFViewerOptions = {
      * - The find controller
      * component.
      */
-    findController?: any;
+    findController?: import("./pdf_find_controller").PDFFindController | undefined;
     /**
      * - The scripting manager
      * component.
      */
-    scriptingManager?: any;
+    scriptingManager?: import("./pdf_scripting_manager").PDFScriptingManager | undefined;
     /**
      * - The rendering queue object.
      */
@@ -179,18 +181,20 @@ export class PDFViewer {
     eventBus: import("./event_utils").EventBus;
     linkService: import("./interfaces").IPDFLinkService | SimpleLinkService;
     downloadManager: import("./interfaces").IDownloadManager | null;
-    findController: any;
-    _scriptingManager: any;
+    findController: import("./pdf_find_controller").PDFFindController | null;
+    _scriptingManager: import("./pdf_scripting_manager").PDFScriptingManager | null;
     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>;
+        getLanguage(): any;
+        getDirection(): any;
+        get(ids: any, args: null | undefined, fallback: any): Promise<any>;
+        translate(element: any): Promise<any>;
+        pause(): any;
+        resume(): any;
     };
     pageColors: Object | null;
     defaultRenderingQueue: boolean;
@@ -268,9 +272,10 @@ export class PDFViewer {
      */
     get pagesRotation(): number;
     _pagesRotation: any;
-    get firstPagePromise(): any;
-    get onePageRendered(): any;
-    get pagesPromise(): any;
+    get firstPagePromise(): Promise<any> | null;
+    get onePageRendered(): Promise<any> | null;
+    get pagesPromise(): Promise<any> | null;
+    get _layerProperties(): any;
     getAllText(): Promise<string | null>;
     /**
      * @param {PDFDocumentProxy} pdfDocument
@@ -296,9 +301,9 @@ export class PDFViewer {
         rotation: any;
         pdfOpenParams: string;
     } | null | undefined;
-    _firstPageCapability: any;
-    _onePageRenderedCapability: any;
-    _pagesCapability: any;
+    _firstPageCapability: PromiseCapability | undefined;
+    _onePageRenderedCapability: PromiseCapability | undefined;
+    _pagesCapability: PromiseCapability | undefined;
     _previousScrollMode: any;
     _spreadMode: any;
     _scrollUpdate(): void;
@@ -453,3 +458,4 @@ export class PDFViewer {
 }
 import { PDFRenderingQueue } from "./pdf_rendering_queue.js";
 import { SimpleLinkService } from "./pdf_link_service.js";
+import { PromiseCapability } from "../src/pdf";

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

@@ -14,7 +14,7 @@ export class TextAccessibilityManager {
      * @param {HTMLElement} e2
      * @returns {number}
      */
-    static "__#45@#compareElementPositions"(e1: HTMLElement, e2: HTMLElement): number;
+    static "__#4@#compareElementPositions"(e1: HTMLElement, e2: HTMLElement): number;
     setTextMapping(textDivs: any): void;
     /**
      * Function called when the text layer has finished rendering.
@@ -31,12 +31,14 @@ export class TextAccessibilityManager {
      * in order to correctly position this editor in the text flow.
      * @param {HTMLElement} element
      * @param {boolean} isRemovable
+     * @returns {string|null} The id in the struct tree if any.
      */
-    addPointerInTextLayer(element: HTMLElement, isRemovable: boolean): void;
+    addPointerInTextLayer(element: HTMLElement, isRemovable: boolean): string | null;
     /**
      * Move a div in the DOM in order to respect the visual order.
      * @param {HTMLDivElement} element
+     * @returns {string|null} The id in the struct tree if any.
      */
-    moveElementInDOM(container: any, element: HTMLDivElement, contentElement: any, isRemovable: any): void;
+    moveElementInDOM(container: any, element: HTMLDivElement, contentElement: any, isRemovable: any): string | null;
     #private;
 }

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

@@ -38,11 +38,16 @@ export class TextLayerBuilder {
     textContentItemsStr: any[];
     renderingDone: boolean;
     textDivs: any[];
-    textDivProperties: WeakMap<object, any>;
-    textLayerRenderTask: any;
+    textDivProperties: WeakMap<WeakKey, any>;
+    textLayerRenderTask: import("../src/display/text_layer.js").TextLayerRenderTask | null;
     highlighter: any;
     accessibilityManager: any;
     isOffscreenCanvasSupported: boolean;
+    /**
+     * Callback used to attach the textLayer to the DOM.
+     * @type {function}
+     */
+    onAppend: Function;
     div: HTMLDivElement;
     get numTextDivs(): number;
     /**

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

@@ -47,10 +47,10 @@ export type GetVisibleElementsParameters = {
 export const animationStarted: Promise<any>;
 /**
  * Converts API PageLayout values to the format used by `BaseViewer`.
- * @param {string} mode - The API PageLayout value.
+ * @param {string} layout - The API PageLayout value.
  * @returns {Object}
  */
-export function apiPageLayoutToViewerModes(layout: any): Object;
+export function apiPageLayoutToViewerModes(layout: string): Object;
 /**
  * Converts API PageMode values to the format used by `PDFSidebar`.
  * NOTE: There's also a "FullScreen" parameter which is not possible to support,
@@ -157,7 +157,7 @@ export function getPageSizeInches({ view, userUnit, rotate }: GetPageSizeInchesP
  * rendering canvas. Earlier and later refer to index in `views`, not page
  * layout.)
  *
- * @param {GetVisibleElementsParameters}
+ * @param {GetVisibleElementsParameters} params
  * @returns {Object} `{ first, last, views: [{ id, x, y, view, percent }] }`
  */
 export function getVisibleElements({ scrollEl, views, sortByVisibility, horizontal, rtl, }: GetVisibleElementsParameters): Object;
@@ -168,10 +168,6 @@ export function isValidSpreadMode(mode: any): boolean;
 export const MAX_AUTO_SCALE: 1.25;
 export const MAX_SCALE: 10;
 export const MIN_SCALE: 0.1;
-/**
- * Event handler to suppress context menu.
- */
-export function noContextMenuHandler(evt: any): void;
 export function normalizeWheelEventDelta(evt: any): number;
 export function normalizeWheelEventDirection(evt: any): number;
 /**
@@ -193,10 +189,10 @@ export class OutputScale {
 }
 /**
  * Helper function to parse query string (e.g. ?param1=value&param2=...).
- * @param {string}
+ * @param {string} query
  * @returns {Map}
  */
-export function parseQueryString(query: any): Map<any, any>;
+export function parseQueryString(query: string): Map<any, any>;
 export namespace PresentationModeState {
     let UNKNOWN: number;
     let NORMAL: number;

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

@@ -1,16 +1,15 @@
 export type PDFPageProxy = import("../src/display/api").PDFPageProxy;
+export type AnnotationStorage = import("../src/display/annotation_storage").AnnotationStorage;
 export type PageViewport = import("../src/display/display_utils").PageViewport;
 export type IPDFLinkService = import("./interfaces").IPDFLinkService;
 export type XfaLayerBuilderOptions = {
-    pageDiv: HTMLDivElement;
     pdfPage: PDFPageProxy;
-    annotationStorage?: any;
+    annotationStorage?: import("../src/display/annotation_storage").AnnotationStorage | undefined;
     linkService: IPDFLinkService;
     xfaHtml?: Object | undefined;
 };
 /**
  * @typedef {Object} XfaLayerBuilderOptions
- * @property {HTMLDivElement} pageDiv
  * @property {PDFPageProxy} pdfPage
  * @property {AnnotationStorage} [annotationStorage]
  * @property {IPDFLinkService} linkService
@@ -20,10 +19,9 @@ export class XfaLayerBuilder {
     /**
      * @param {XfaLayerBuilderOptions} options
      */
-    constructor({ pageDiv, pdfPage, annotationStorage, linkService, xfaHtml, }: XfaLayerBuilderOptions);
-    pageDiv: HTMLDivElement;
+    constructor({ pdfPage, annotationStorage, linkService, xfaHtml, }: XfaLayerBuilderOptions);
     pdfPage: import("../src/display/api").PDFPageProxy;
-    annotationStorage: any;
+    annotationStorage: import("../src/display/annotation_storage").AnnotationStorage;
     linkService: import("./interfaces").IPDFLinkService;
     xfaHtml: Object;
     div: HTMLDivElement | null;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "unpdf",
   "type": "module",
-  "version": "0.7.1",
-  "packageManager": "pnpm@8.7.0",
+  "version": "0.8.0",
+  "packageManager": "pnpm@8.10.2",
   "description": "Utilities to work with PDFs in Node.js, browser and workers",
   "author": "Johann Schopplich <pkg@johannschopplich.com>",
   "license": "MIT",
@@ -55,10 +55,10 @@
     "build": "unbuild && node scripts/post-build.mjs",
     "build:pdfjs": "rollup --config pdfjs.rollup.config.ts --configPlugin typescript && cp -R node_modules/pdfjs-dist/types dist",
     "dev": "unbuild --stub",
-    "lint": "eslint \"**/*.ts\" --ignore-path .gitignore",
+    "lint": "eslint \"**/*.{cjs,mjs,ts}\" --ignore-path .gitignore",
     "lint:fix": "npm run lint -- --fix",
-    "format": "prettier \"**/*.{css,html,json,md,mjs,ts,vue,yml}\" --write",
-    "format:check": "prettier \"**/*.{css,html,json,md,mjs,ts,vue,yml}\" --check",
+    "format": "prettier \"**/*.{json,md,cjs,mjs,ts,yml}\" --write",
+    "format:check": "prettier \"**/*.{json,md,cjs,mjs,ts,yml}\" --check",
     "release": "bumpp --commit --push --tag",
     "test": "vitest",
     "test:types": "tsc --noEmit"
@@ -67,22 +67,22 @@
     "canvas": "^2.11.2"
   },
   "devDependencies": {
-    "@rollup/plugin-alias": "^5.0.0",
-    "@rollup/plugin-commonjs": "^25.0.4",
-    "@rollup/plugin-inject": "^5.0.3",
-    "@rollup/plugin-node-resolve": "^15.2.1",
-    "@rollup/plugin-replace": "^5.0.2",
-    "@rollup/plugin-terser": "^0.4.3",
-    "@rollup/plugin-typescript": "^11.1.3",
-    "@types/node": "^20.5.7",
+    "@rollup/plugin-alias": "^5.0.1",
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-inject": "^5.0.5",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-replace": "^5.0.5",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^11.1.5",
+    "@types/node": "^20.9.0",
     "bumpp": "^9.2.0",
-    "eslint": "^8.48.0",
+    "eslint": "^8.53.0",
     "eslint-config-unjs": "^0.2.1",
-    "fast-glob": "^3.3.1",
-    "pdfjs-dist": "^3.10.111",
-    "prettier": "^3.0.2",
+    "fast-glob": "^3.3.2",
+    "pdfjs-dist": "^4.0.189",
+    "prettier": "^3.0.3",
     "rollup": "^3.28.1",
-    "typescript": "^5.1.6",
+    "typescript": "^5.2.2",
     "unbuild": "^2.0.0",
     "unenv": "^1.7.4",
     "vitest": "^0.34.3"