@file-viewer/renderer-pdf 2.1.13 → 2.1.14

package/dist/pdf.js

@@ -1,6 +1,6 @@
 import { getDocument, GlobalWorkerOptions, PDFWorker as PdfJsWorker, PixelsPerInch, } from 'pdfjs-dist/legacy/build/pdf.mjs';
 import { EventBus, GenericL10n, PDFFindController, PDFLinkService, PDFViewer, } from 'pdfjs-dist/legacy/web/pdf_viewer.mjs';
-import { registerFileViewerSearchProvider, registerFileViewerZoomProvider, unregisterFileViewerSearchProvider, unregisterFileViewerZoomProvider, createFileViewerZoomChangeEmitter, createFileViewerTranslator, buildPrintPageStyle, formatCssPixels, DEFAULT_PDF_RANGE_CHUNK_SIZE, resolveFileViewerLocale, } from '@file-viewer/core';
+import { registerFileViewerSearchProvider, registerFileViewerZoomProvider, unregisterFileViewerSearchProvider, unregisterFileViewerZoomProvider, registerFileViewerViewStateProvider, unregisterFileViewerViewStateProvider, createFileViewerZoomChangeEmitter, createFileViewerViewStateChange, createFileViewerViewStateChangeEmitter, createFileViewerTranslator, buildPrintPageStyle, formatCssPixels, DEFAULT_PDF_RANGE_CHUNK_SIZE, resolveFileViewerLocale, } from '@file-viewer/core';
 import { DEFAULT_FILE_VIEWER_PDF_WORKER_PATH, resolveFileViewerPdfAssetUrls, } from '@file-viewer/core/assets';
 import { pdfViewerStyle } from './pdfStyles.js';
 export const DEFAULT_FILE_VIEWER_PDF_WORKER_URL = DEFAULT_FILE_VIEWER_PDF_WORKER_PATH;
@@ -200,7 +200,7 @@ const buildOutlineItems = (items, prefix = 'outline', getFallbackTitle = index =
     };
 });
 export default async function renderPdf(buffer, target, context) {
-    var _a, _b;
+    var _a, _b, _c;
     const documentRef = target.ownerDocument || document;
     const targetWindow = documentRef.defaultView || (typeof window !== 'undefined' ? window : null);
     const t = createFileViewerTranslator(context === null || context === void 0 ? void 0 : context.options);
@@ -209,10 +209,12 @@ export default async function renderPdf(buffer, target, context) {
         throw new Error(t('pdf.error.browserWindow'));
     }
     const options = (_a = context === null || context === void 0 ? void 0 : context.options) === null || _a === void 0 ? void 0 : _a.pdf;
+    const initialViewState = (options === null || options === void 0 ? void 0 : options.initialViewState) || ((_b = context === null || context === void 0 ? void 0 : context.options) === null || _b === void 0 ? void 0 : _b.initialViewState) || null;
     const navigationEnabled = (options === null || options === void 0 ? void 0 : options.navigation) !== false;
     const toolbarVisible = (options === null || options === void 0 ? void 0 : options.toolbar) !== false;
     const thumbnailsEnabled = (options === null || options === void 0 ? void 0 : options.thumbnails) === true;
     const zoomEmitter = createFileViewerZoomChangeEmitter();
+    const viewStateEmitter = createFileViewerViewStateChangeEmitter();
     const isCompactViewport = () => {
         const width = target.clientWidth || targetWindow.innerWidth || 0;
         return width > 0 && width <= 720;
@@ -229,7 +231,7 @@ export default async function renderPdf(buffer, target, context) {
     let pageCount = 0;
     let currentScale = 1;
     let autoFitWidth = true;
-    let currentRotation = normalizeRotation((_b = options === null || options === void 0 ? void 0 : options.rotation) !== null && _b !== void 0 ? _b : 0);
+    let currentRotation = normalizeRotation((_c = options === null || options === void 0 ? void 0 : options.rotation) !== null && _c !== void 0 ? _c : 0);
     let outlineItems = [];
     let resizeObserver = null;
     let thumbnailObserver = null;
@@ -237,6 +239,11 @@ export default async function renderPdf(buffer, target, context) {
     let pageDimensionFrame = 0;
     let destroyed = false;
     let loadVersion = 0;
+    let viewStateApplyVersion = 0;
+    let activeViewStateApplyVersion = 0;
+    let pendingInitialViewState = initialViewState;
+    let suppressScrollEventUntil = 0;
+    let scrollStateFrame = 0;
     let pdfSearchState = createPdfSearchState();
     let pdfMatchesCount = { current: 0, total: 0 };
     let pdfSearchOptions;
@@ -357,7 +364,7 @@ export default async function renderPdf(buffer, target, context) {
                     thumb.textContent = String(page);
                 }
                 button.append(thumb, createElement(documentRef, 'span', 'pdf-page-label', t('pdf.nav.pageLabel', { page })));
-                button.addEventListener('click', () => goToPage(page));
+                button.addEventListener('click', () => goToPage(page, 'page-click', 'user'));
                 navList.append(button);
             }
             return;
@@ -735,13 +742,153 @@ export default async function renderPdf(buffer, target, context) {
     const getPdfZoomState = () => ({
         scale: currentScale,
         label: scaleText(),
-        canZoomIn: !!pdfContext.viewer && canZoomIn(),
-        canZoomOut: !!pdfContext.viewer && canZoomOut(),
-        canReset: !!pdfContext.viewer,
+        canZoomIn: loadStatus === 'ready' && !!pdfContext.viewer && canZoomIn(),
+        canZoomOut: loadStatus === 'ready' && !!pdfContext.viewer && canZoomOut(),
+        canReset: loadStatus === 'ready' && !!pdfContext.viewer && !autoFitWidth,
         minScale: MIN_SCALE,
         maxScale: MAX_SCALE,
     });
-    const setScale = (scale) => {
+    const readScrollState = () => {
+        const maxTop = Math.max(0, container.scrollHeight - container.clientHeight);
+        const maxLeft = Math.max(0, container.scrollWidth - container.clientWidth);
+        return {
+            top: container.scrollTop || 0,
+            left: container.scrollLeft || 0,
+            width: container.scrollWidth || 0,
+            height: container.scrollHeight || 0,
+            clientWidth: container.clientWidth || 0,
+            clientHeight: container.clientHeight || 0,
+            topRatio: maxTop > 0 ? (container.scrollTop || 0) / maxTop : 0,
+            leftRatio: maxLeft > 0 ? (container.scrollLeft || 0) / maxLeft : 0,
+        };
+    };
+    const getPdfViewState = () => {
+        const zoom = getPdfZoomState();
+        return {
+            renderer: 'pdf',
+            page: currentPage,
+            pageCount,
+            scale: zoom.scale,
+            zoom,
+            rotation: currentRotation,
+            scroll: readScrollState(),
+            navigation: {
+                visible: navigationEnabled ? navVisible : false,
+                mode: navMode,
+            },
+        };
+    };
+    const emitViewStateChange = (action, source = 'viewer') => {
+        const state = getPdfViewState();
+        if (!destroyed) {
+            viewStateEmitter.emit(createFileViewerViewStateChange(state, {
+                action,
+                source,
+            }));
+        }
+        return state;
+    };
+    const resolveScrollValue = (value, ratio, maxValue) => {
+        if (Number.isFinite(value)) {
+            return Number(value);
+        }
+        if (Number.isFinite(ratio)) {
+            return Number(ratio) * maxValue;
+        }
+        return undefined;
+    };
+    const suppressProgrammaticScrollEvents = () => {
+        suppressScrollEventUntil = Math.max(suppressScrollEventUntil, Date.now() + 180);
+    };
+    const restoreScrollState = (scroll, notify = true) => {
+        if (!scroll) {
+            return;
+        }
+        const maxTop = Math.max(0, container.scrollHeight - container.clientHeight);
+        const maxLeft = Math.max(0, container.scrollWidth - container.clientWidth);
+        const top = resolveScrollValue(scroll.top, scroll.topRatio, maxTop);
+        const left = resolveScrollValue(scroll.left, scroll.leftRatio, maxLeft);
+        if (!notify) {
+            suppressProgrammaticScrollEvents();
+        }
+        if (top !== undefined) {
+            container.scrollTop = Math.min(Math.max(0, top), maxTop);
+        }
+        if (left !== undefined) {
+            container.scrollLeft = Math.min(Math.max(0, left), maxLeft);
+        }
+    };
+    const applyPdfViewState = async (state, applyOptions = {}) => {
+        var _a, _b;
+        if (!pdfContext.viewer || loadStatus !== 'ready') {
+            pendingInitialViewState = state;
+            return getPdfViewState();
+        }
+        const source = applyOptions.source || 'api';
+        const action = applyOptions.action || 'restore';
+        const notify = applyOptions.notify !== false;
+        const applyVersion = ++viewStateApplyVersion;
+        activeViewStateApplyVersion = applyVersion;
+        suppressProgrammaticScrollEvents();
+        const nextRotation = Number(state.rotation);
+        const nextScale = Number((_a = state.scale) !== null && _a !== void 0 ? _a : (_b = state.zoom) === null || _b === void 0 ? void 0 : _b.scale);
+        const nextPage = Number(state.page);
+        try {
+            if (state.navigation) {
+                if (navigationEnabled && typeof state.navigation.visible === 'boolean') {
+                    navVisible = state.navigation.visible;
+                }
+                if (state.navigation.mode === 'pages' || state.navigation.mode === 'outline') {
+                    navMode = state.navigation.mode;
+                }
+                syncUi();
+            }
+            if (Number.isFinite(nextRotation)) {
+                applyRotation(nextRotation, 'rotation-change', source, false);
+            }
+            if (Number.isFinite(nextScale)) {
+                autoFitWidth = false;
+                setScale(nextScale, 'zoom-change', source, false);
+            }
+            if (Number.isFinite(nextPage)) {
+                goToPage(nextPage, 'page-change', source, false);
+            }
+            await waitForPaint(targetWindow);
+            if (applyVersion !== viewStateApplyVersion) {
+                return getPdfViewState();
+            }
+            restoreScrollState(state.scroll, false);
+            await waitForPaint(targetWindow);
+            if (applyVersion !== viewStateApplyVersion) {
+                return getPdfViewState();
+            }
+            restoreScrollState(state.scroll, false);
+            syncUi();
+            if (notify && applyVersion === viewStateApplyVersion) {
+                emitViewStateChange(action, source);
+            }
+            return getPdfViewState();
+        }
+        finally {
+            suppressProgrammaticScrollEvents();
+            if (activeViewStateApplyVersion === applyVersion) {
+                activeViewStateApplyVersion = 0;
+            }
+        }
+    };
+    const scheduleScrollViewStateChange = () => {
+        if (activeViewStateApplyVersion || Date.now() < suppressScrollEventUntil || destroyed) {
+            return;
+        }
+        if (scrollStateFrame) {
+            return;
+        }
+        scrollStateFrame = targetWindow.requestAnimationFrame(() => {
+            scrollStateFrame = 0;
+            emitViewStateChange('scroll', 'user');
+        });
+    };
+    const setScale = (scale, action = 'zoom-change', source = 'viewer', notifyViewState = true) => {
         if (!pdfContext.viewer) {
             return;
         }
@@ -751,6 +898,9 @@ export default async function renderPdf(buffer, target, context) {
         scheduleLegacyPageDimensionPatch();
         zoomEmitter.emit();
         syncUi();
+        if (notifyViewState) {
+            emitViewStateChange(action, source);
+        }
     };
     const getPageWidthAtScaleOne = (pdfViewer) => {
         var _a;
@@ -774,12 +924,12 @@ export default async function renderPdf(buffer, target, context) {
         const availableWidth = Math.max(containerWidth - FIT_HORIZONTAL_PADDING - PAGE_BORDER_WIDTH, 96);
         return pageWidth ? clampScale(availableWidth / pageWidth) : 1;
     };
-    const fitToWidth = () => {
+    const fitToWidth = (source = 'user', notifyViewState = true) => {
         if (!pdfContext.viewer) {
             return;
         }
         autoFitWidth = true;
-        setScale(getFitWidthScale(pdfContext.viewer));
+        setScale(getFitWidthScale(pdfContext.viewer), 'zoom-reset', source, notifyViewState);
         void waitForPaint(targetWindow).then(() => {
             var _a;
             (_a = pdfContext.viewer) === null || _a === void 0 ? void 0 : _a.update();
@@ -790,17 +940,17 @@ export default async function renderPdf(buffer, target, context) {
             return;
         }
         targetWindow.cancelAnimationFrame(fitFrame);
-        fitFrame = targetWindow.requestAnimationFrame(() => fitToWidth());
+        fitFrame = targetWindow.requestAnimationFrame(() => fitToWidth('viewer'));
     };
-    const zoomIn = () => {
+    const zoomIn = (source = 'user') => {
         autoFitWidth = false;
-        setScale(currentScale + SCALE_STEP);
+        setScale(currentScale + SCALE_STEP, 'zoom-in', source);
     };
-    const zoomOut = () => {
+    const zoomOut = (source = 'user') => {
         autoFitWidth = false;
-        setScale(currentScale - SCALE_STEP);
+        setScale(currentScale - SCALE_STEP, 'zoom-out', source);
     };
-    const applyRotation = (rotation) => {
+    const applyRotation = (rotation, action = 'rotation-change', source = 'viewer', notifyViewState = true) => {
         const normalized = normalizeRotation(rotation);
         currentRotation = normalized;
         pdfThumbnails.clear();
@@ -813,12 +963,18 @@ export default async function renderPdf(buffer, target, context) {
         void waitForPaint(targetWindow).then(() => {
             var _a;
             if (autoFitWidth) {
-                fitToWidth();
+                fitToWidth(source, notifyViewState);
+                if (notifyViewState) {
+                    emitViewStateChange(action, source);
+                }
                 return;
             }
             (_a = pdfContext.viewer) === null || _a === void 0 ? void 0 : _a.update();
             scheduleLegacyPageDimensionPatch();
             syncUi();
+            if (notifyViewState) {
+                emitViewStateChange(action, source);
+            }
         });
     };
     const runWithStableHorizontalScroll = (action) => {
@@ -829,7 +985,7 @@ export default async function renderPdf(buffer, target, context) {
             void Promise.resolve(result).finally(() => stabilizeHorizontalScroll(previousScrollLeft));
         }
     };
-    function goToPage(pageNumber) {
+    function goToPage(pageNumber, action = 'page-change', source = 'viewer', notifyViewState = true) {
         if (!pdfContext.viewer || !pageCount) {
             return;
         }
@@ -838,9 +994,12 @@ export default async function renderPdf(buffer, target, context) {
             pdfContext.viewer.currentPageNumber = nextPage;
             currentPage = nextPage;
             syncUi();
+            if (notifyViewState) {
+                emitViewStateChange(action, source);
+            }
         });
     }
-    const toggleNav = () => {
+    const toggleNav = (source = 'user', notifyViewState = true) => {
         if (!navigationEnabled) {
             return;
         }
@@ -849,15 +1008,21 @@ export default async function renderPdf(buffer, target, context) {
         void waitForPaint(targetWindow).then(() => {
             var _a;
             if (autoFitWidth) {
-                fitToWidth();
+                fitToWidth(source, notifyViewState);
                 return;
             }
             (_a = pdfContext.viewer) === null || _a === void 0 ? void 0 : _a.update();
         });
+        if (notifyViewState) {
+            emitViewStateChange('navigation-toggle', source);
+        }
     };
-    const setNavMode = (mode) => {
+    const setNavMode = (mode, source = 'user', notifyViewState = true) => {
         navMode = mode;
         syncUi();
+        if (notifyViewState) {
+            emitViewStateChange('navigation-mode-change', source);
+        }
     };
     const toggleOutlineItem = (item) => {
         if (!item.items.length) {
@@ -871,6 +1036,7 @@ export default async function renderPdf(buffer, target, context) {
             return;
         }
         runWithStableHorizontalScroll(() => pdfContext.linkService.goToDestination(item.dest));
+        void waitForPaint(targetWindow).then(() => emitViewStateChange('outline-click', 'user'));
     };
     const destroyPdfResource = async (resource) => {
         var _a;
@@ -1026,25 +1192,44 @@ export default async function renderPdf(buffer, target, context) {
             eventBus.on('updatefindcontrolstate', handlePdfFindControlState);
             eventBus.on('pagesinit', () => {
                 var _a;
-                applyRotation(currentRotation);
-                fitToWidth();
-                scheduleLegacyPageDimensionPatch();
+                applyRotation(currentRotation, 'rotation-change', 'viewer', false);
                 loadStatus = 'ready';
+                fitToWidth('viewer', false);
+                scheduleLegacyPageDimensionPatch();
                 syncUi();
                 (_a = context === null || context === void 0 ? void 0 : context.onProgressiveRender) === null || _a === void 0 ? void 0 : _a.call(context);
+                const viewStateToRestore = pendingInitialViewState;
+                pendingInitialViewState = null;
+                if (viewStateToRestore) {
+                    void applyPdfViewState(viewStateToRestore, {
+                        action: 'restore',
+                        source: 'initial',
+                    });
+                }
+                else {
+                    emitViewStateChange('init', 'viewer');
+                }
                 if (pdfContext.search) {
                     eventBus.dispatch('find', { type: '', query: pdfContext.search });
                 }
             });
             eventBus.on('pagechanging', ({ pageNumber }) => {
+                const previousPage = currentPage;
                 currentPage = pageNumber;
                 syncUi();
+                if (previousPage !== currentPage && !activeViewStateApplyVersion) {
+                    emitViewStateChange('page-change', 'viewer');
+                }
             });
             eventBus.on('scalechanging', ({ scale }) => {
+                const previousScale = currentScale;
                 currentScale = clampScale(scale);
                 scheduleLegacyPageDimensionPatch();
                 zoomEmitter.emit();
                 syncUi();
+                if (previousScale !== currentScale && !activeViewStateApplyVersion) {
+                    emitViewStateChange('zoom-change', 'viewer');
+                }
             });
             eventBus.on('pagerendered', scheduleLegacyPageDimensionPatch);
             if (!(context === null || context === void 0 ? void 0 : context.streamUrl) && !buffer.byteLength) {
@@ -1120,35 +1305,41 @@ export default async function renderPdf(buffer, target, context) {
     });
     registerFileViewerZoomProvider(root, {
         zoomIn: () => {
-            zoomIn();
+            zoomIn('api');
             return getPdfZoomState();
         },
         zoomOut: () => {
-            zoomOut();
+            zoomOut('api');
             return getPdfZoomState();
         },
         resetZoom: () => {
-            fitToWidth();
+            fitToWidth('api');
             return getPdfZoomState();
         },
         setZoom: scale => {
             autoFitWidth = false;
-            setScale(scale);
+            setScale(scale, 'zoom-change', 'api');
             return getPdfZoomState();
         },
         getState: getPdfZoomState,
         subscribe: zoomEmitter.subscribe,
     });
-    navToggleButton.addEventListener('click', toggleNav);
-    previousPageButton.addEventListener('click', () => goToPage(currentPage - 1));
-    nextPageButton.addEventListener('click', () => goToPage(currentPage + 1));
-    zoomOutButton.addEventListener('click', zoomOut);
-    zoomInButton.addEventListener('click', zoomIn);
-    scaleButton.addEventListener('click', fitToWidth);
-    rotateLeftButton.addEventListener('click', () => applyRotation(currentRotation - 90));
-    rotateRightButton.addEventListener('click', () => applyRotation(currentRotation + 90));
-    pagesTab.addEventListener('click', () => setNavMode('pages'));
-    outlineTab.addEventListener('click', () => setNavMode('outline'));
+    registerFileViewerViewStateProvider(root, {
+        getState: getPdfViewState,
+        applyState: applyPdfViewState,
+        subscribe: viewStateEmitter.subscribe,
+    });
+    navToggleButton.addEventListener('click', () => toggleNav('user'));
+    previousPageButton.addEventListener('click', () => goToPage(currentPage - 1, 'page-step', 'user'));
+    nextPageButton.addEventListener('click', () => goToPage(currentPage + 1, 'page-step', 'user'));
+    zoomOutButton.addEventListener('click', () => zoomOut('user'));
+    zoomInButton.addEventListener('click', () => zoomIn('user'));
+    scaleButton.addEventListener('click', () => fitToWidth('user'));
+    rotateLeftButton.addEventListener('click', () => applyRotation(currentRotation - 90, 'rotate-left', 'user'));
+    rotateRightButton.addEventListener('click', () => applyRotation(currentRotation + 90, 'rotate-right', 'user'));
+    pagesTab.addEventListener('click', () => setNavMode('pages', 'user'));
+    outlineTab.addEventListener('click', () => setNavMode('outline', 'user'));
+    container.addEventListener('scroll', scheduleScrollViewStateChange, { passive: true });
     if (targetWindow.ResizeObserver) {
         resizeObserver = new targetWindow.ResizeObserver(() => scheduleFitToWidth());
         resizeObserver.observe(container);
@@ -1163,12 +1354,15 @@ export default async function renderPdf(buffer, target, context) {
             loadVersion += 1;
             targetWindow.cancelAnimationFrame(fitFrame);
             targetWindow.cancelAnimationFrame(pageDimensionFrame);
+            targetWindow.cancelAnimationFrame(scrollStateFrame);
             thumbnailObserver === null || thumbnailObserver === void 0 ? void 0 : thumbnailObserver.disconnect();
             thumbnailObserver = null;
             resizeObserver === null || resizeObserver === void 0 ? void 0 : resizeObserver.disconnect();
             resizeObserver = null;
+            container.removeEventListener('scroll', scheduleScrollViewStateChange);
             unregisterFileViewerSearchProvider(root);
             unregisterFileViewerZoomProvider(root);
+            unregisterFileViewerViewStateProvider(root);
             outlineItems = [];
             (_a = context === null || context === void 0 ? void 0 : context.registerExportAdapter) === null || _a === void 0 ? void 0 : _a.call(context, null);
             const resource = pdfContext.resource;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@file-viewer/renderer-pdf",
-  "version": "2.1.13",
+  "version": "2.1.14",
   "private": false,
   "type": "module",
   "description": "Standalone PDF renderer plugin for Flyfish File Viewer powered by PDF.js.",
@@ -54,7 +54,7 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@file-viewer/core": "^2.1.13",
+    "@file-viewer/core": "^2.1.14",
     "pdfjs-dist": "^6.0.227"
   },
   "devDependencies": {