@file-viewer/renderer-pdf 2.1.29 → 2.2.0

package/README.en.md

@@ -42,7 +42,7 @@ const options = {
 }
 ```
 
-When no explicit PDF asset URL is configured, the renderer first uses the public base exposed by build tools such as Vite and can fall back to the page entry script. An app deployed under `/workspace/` therefore still requests `/workspace/vendor/pdf/pdf.worker.mjs` while its current SPA route is `/workspace/c/`. UMI, custom proxies, and builds whose public path cannot be detected can set `pdf.assetBaseUrl: '/workspace/'` to pin the base for every PDF offline asset. If the host app did not run `file-viewer-copy-assets`, does not use `@file-viewer/vite-plugin`, or a local dev server falls back to HTML for that path, the renderer lazy-loads the packaged PDF.js worker handler as a compatibility fallback so preview does not fail with `Setting up fake worker failed`. For best performance, complete cMap/standard-font/WASM decoding, or strict offline deployments, still copy viewer assets and point these URLs at real static files. The pinned PDF.js 5.4 stable line loads local JBIG2, JPEG 2000, color-management, and related helpers through `wasmUrl`; viewer assets and the Vite plugin copy them without relying on the public internet.
+When no explicit PDF asset URL is configured, the renderer first uses the public base exposed by build tools such as Vite and can fall back to the page entry script. An app deployed under `/workspace/` therefore still requests `/workspace/vendor/pdf/pdf.worker.mjs` while its current SPA route is `/workspace/c/`. UMI, custom proxies, and builds whose public path cannot be detected can set `pdf.assetBaseUrl: '/workspace/'` to pin the base for every PDF offline asset. Before creating a static Worker, the renderer reads the official PDF.js version marker; a stale Worker from an older deployment is rejected and the packaged same-version handler is used instead. If the host app did not run `file-viewer-copy-assets`, does not use `@file-viewer/vite-plugin`, or a local dev server falls back to HTML for that path, the same fallback prevents `Setting up fake worker failed`. For best performance, complete cMap/standard-font/WASM decoding, or strict offline deployments, still copy viewer assets and point these URLs at real static files. The pinned PDF.js 5.4 stable line loads local JBIG2, JPEG 2000, color-management, and related helpers through `wasmUrl`; viewer assets and the Vite plugin copy them without relying on the public internet.
 
 `cjkFontFallback` is enabled by default. When a PDF references `MicrosoftYaHei-Bold`, SimSun, SimHei, or another CJK font without embedding the font program, the renderer prefers an installed system font and otherwise aliases the original PDF font name to the bundled Noto Sans SC variable font. Only WOFF2 shards needed by the current page text are loaded. The first page waits for the font before rendering, and later pages are redrawn when they introduce new glyphs. Set the option to `false` to disable this behavior, or point `cjkFontFallbackPath` at a self-hosted directory with the same structure.
 

package/README.md

@@ -42,7 +42,7 @@ const options = {
 }
 ```
 
-默认未显式配置时，渲染器优先使用 Vite 等构建器提供的公开基址，并可从页面入口脚本回退识别部署子路径。因此应用部署在 `/workspace/`、当前 SPA 路由为 `/workspace/c/` 时，仍会请求 `/workspace/vendor/pdf/pdf.worker.mjs`。UMI、自定义代理或无法自动识别的构建环境可以设置 `pdf.assetBaseUrl: '/workspace/'` 固定全部 PDF 离线资源的基址。如果项目没有执行 `file-viewer-copy-assets`、没有使用 `@file-viewer/vite-plugin`，或者本地临时服务器把该路径回退成 HTML，PDF renderer 会自动懒加载包内 PDF.js worker handler 作为兼容兜底，避免 `Setting up fake worker failed` 直接中断预览。需要最佳性能、完整 cMap/standard fonts/WASM 解码或严格离线部署时，仍建议复制 viewer assets 并配置真实静态地址。当前锁定的 PDF.js 5.4 稳定线会通过 `wasmUrl` 本地加载 JBIG2、JPEG 2000、颜色管理等辅助资源；这些资源由 viewer assets 和 Vite 插件统一复制，不依赖公网。
+默认未显式配置时，渲染器优先使用 Vite 等构建器提供的公开基址，并可从页面入口脚本回退识别部署子路径。因此应用部署在 `/workspace/`、当前 SPA 路由为 `/workspace/c/` 时，仍会请求 `/workspace/vendor/pdf/pdf.worker.mjs`。UMI、自定义代理或无法自动识别的构建环境可以设置 `pdf.assetBaseUrl: '/workspace/'` 固定全部 PDF 离线资源的基址。创建静态 Worker 前会先读取 PDF.js 官方版本标记；若部署目录残留的旧 Worker 与当前 API 不一致，会拒绝旧文件并自动使用包内同版本 handler。项目未执行 `file-viewer-copy-assets`、未使用 `@file-viewer/vite-plugin`，或本地临时服务器把该路径回退成 HTML 时，也会使用同一兜底，避免 `Setting up fake worker failed` 直接中断预览。需要最佳性能、完整 cMap/standard fonts/WASM 解码或严格离线部署时，仍建议复制 viewer assets 并配置真实静态地址。当前锁定的 PDF.js 5.4 稳定线会通过 `wasmUrl` 本地加载 JBIG2、JPEG 2000、颜色管理等辅助资源；这些资源由 viewer assets 和 Vite 插件统一复制，不依赖公网。
 
 `cjkFontFallback` 默认开启。PDF 引用了 `MicrosoftYaHei-Bold`、宋体、黑体或其他中文字体但没有嵌入字体数据时，渲染器优先使用本机字体；本机缺失时，会把原 PDF 字体名映射到本地 Noto Sans SC 可变字体，并根据当前页实际文字只加载需要的 WOFF2 分片。首屏会在字体就绪后再渲染，后续页发现新字形时会自动重绘。可设为 `false` 完全关闭，或用 `cjkFontFallbackPath` 指向同结构的自托管字体目录。
 

package/dist/pdf.js

@@ -1,21 +1,30 @@
-import { getDocument, GlobalWorkerOptions, PDFWorker as PdfJsWorker, PixelsPerInch, } from 'pdfjs-dist/legacy/build/pdf.mjs';
+import { getDocument, GlobalWorkerOptions, PDFWorker as PdfJsWorker, PixelsPerInch, version as pdfJsVersion, } 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, registerFileViewerViewStateProvider, unregisterFileViewerViewStateProvider, createFileViewerZoomChangeEmitter, createFileViewerViewStateChange, createFileViewerViewStateChangeEmitter, createFileViewerTranslator, buildPrintPageStyle, formatCssPixels, DEFAULT_PDF_RANGE_CHUNK_SIZE, resolveFileViewerLocale, resolveFileViewerFitScale, } from '@file-viewer/core';
 import { DEFAULT_FILE_VIEWER_PDF_WORKER_PATH, resolveFileViewerPdfAssetUrls, resolveFileViewerRuntimeAssetBaseUrl, } from '@file-viewer/core/assets';
 import { pdfViewerStyle } from './pdfStyles.js';
 import { collectMalformedIdentityFontNames, createPdfCjkFontFallbackManager, detectMalformedIdentityCjkFontFamilies, } from './pdfFontFallback.js';
 import { PDF_FIT_HORIZONTAL_PADDING, PDF_PAGE_BORDER_WIDTH, resolvePdfFitViewportSize, } from './pdfFit.js';
+import { capturePdfJsWorkerGlobal, scopePdfJsWorkerMessageHandler, } from './pdfWorkerGlobal.js';
+import { readPdfJsWorkerVersion } from './pdfWorkerVersion.js';
 export const DEFAULT_FILE_VIEWER_PDF_WORKER_URL = DEFAULT_FILE_VIEWER_PDF_WORKER_PATH;
 const MIN_SCALE = 0.2;
 const MAX_SCALE = 3;
 const SCALE_STEP = 0.1;
 const PDF_EXPORT_MAX_PAGE_PIXELS = 8000000;
 const PDF_WORKER_PROBE_TIMEOUT_MS = 1200;
+const PDF_WORKER_VERSION_PROBE_BYTES = 4096;
 const PDF_JS_DESTROY_CONSOLE_SUPPRESSION_MS = 1500;
 let bundledPdfWorkerModulePromise = null;
+const scopePdfJsRootVariables = (style) => style.replace(/:root(\s*\{)/g, ':root,\n.pdf-shell$1');
 // PDF.js viewer CSS references image assets that are not shipped with the
 // on-demand renderer chunk, so keep the preview self-contained and 404-free.
-const normalizedPdfViewerStyle = pdfViewerStyle
+// Its root custom properties also need a local scope: a :root selector inside
+// Shadow DOM does not match the document root or the custom-element host.
+const normalizedPdfViewerStyle = `${scopePdfJsRootVariables(pdfViewerStyle)}
+.pdf-shell{background:var(--file-viewer-render-surface-background,#edf2f7)}
+.pdf-wrapper{background:var(--file-viewer-render-surface-background,#e8edf4)}
+`
     .replace(/--page-border-image:\s*url\(images\/shadow\.png\)\s*9 9 repeat;/g, '--page-border-image:none;')
     .replace(/background:\s*url\("\.\/images\/loading-icon\.gif"\)\s*center no-repeat;/g, 'background:none;');
 const pdfJsConsoleErrorSuppressions = new WeakMap();
@@ -234,21 +243,33 @@ const isJavaScriptLikeResponse = (response) => {
         contentType.includes('application/octet-stream') ||
         contentType.includes('text/plain');
 };
+const readResponsePrefix = async (response, maximumBytes = PDF_WORKER_VERSION_PROBE_BYTES) => {
+    // Consume the response even when a server ignores Range. Cancelling after the
+    // prefix creates a browser-level ERR_ABORTED event that strict hosts treat as
+    // a failed asset request, despite the compatibility probe succeeding.
+    return (await response.text()).slice(0, maximumBytes);
+};
 const loadBundledPdfWorkerModule = async () => {
     bundledPdfWorkerModulePromise !== null && bundledPdfWorkerModulePromise !== void 0 ? bundledPdfWorkerModulePromise : (bundledPdfWorkerModulePromise = import('pdfjs-dist/legacy/build/pdf.worker.mjs'));
     return bundledPdfWorkerModulePromise;
 };
-const installBundledPdfFakeWorker = async () => {
-    var _a;
+const createBundledPdfFakeWorker = async () => {
     const workerGlobal = globalThis;
-    if ((_a = workerGlobal.pdfjsWorker) === null || _a === void 0 ? void 0 : _a.WorkerMessageHandler) {
-        return;
-    }
+    // pdf.worker.mjs assigns globalThis.pdfjsWorker as a module side effect, so
+    // capture the host namespace before importing it and restore that snapshot.
+    const hostWorkerGlobal = capturePdfJsWorkerGlobal(workerGlobal);
     const workerModule = await loadBundledPdfWorkerModule();
-    workerGlobal.pdfjsWorker = {
-        ...workerGlobal.pdfjsWorker,
-        WorkerMessageHandler: workerModule.WorkerMessageHandler,
-    };
+    const workerHandlerScope = scopePdfJsWorkerMessageHandler(workerGlobal, workerModule.WorkerMessageHandler, hostWorkerGlobal);
+    try {
+        const worker = new PdfJsWorker({
+            name: 'file-viewer-pdf-worker',
+        });
+        await worker.promise;
+        return worker;
+    }
+    finally {
+        workerHandlerScope.restore();
+    }
 };
 const resolvePdfWorkerUrl = (options, documentBaseUrl) => {
     return resolveFileViewerPdfAssetUrls(options, documentBaseUrl).workerUrl;
@@ -688,57 +709,78 @@ export default async function renderPdf(buffer, target, context) {
             targetWindow.requestAnimationFrame(writeLegacyCompatiblePageDimensions);
         });
     };
-    const canUseResolvedPdfWorkerUrl = async (workerUrl) => {
+    const probeResolvedPdfWorkerUrl = async (workerUrl) => {
         var _a, _b;
         const fetcher = ((_a = targetWindow.fetch) === null || _a === void 0 ? void 0 : _a.bind(targetWindow)) || ((_b = globalThis.fetch) === null || _b === void 0 ? void 0 : _b.bind(globalThis));
         const AbortControllerCtor = targetWindow.AbortController || globalThis.AbortController;
         if (!fetcher || !AbortControllerCtor) {
-            return false;
+            return { status: 'unavailable', workerVersion: null };
         }
         try {
             const parsed = new URL(workerUrl, documentRef.baseURI || targetWindow.location.href);
             if (parsed.protocol !== 'http:' && parsed.protocol !== 'https:') {
-                return false;
+                return { status: 'unavailable', workerVersion: null };
             }
         }
         catch {
-            return false;
+            return { status: 'unavailable', workerVersion: null };
         }
         const controller = new AbortControllerCtor();
         const timer = targetWindow.setTimeout(() => controller.abort(), PDF_WORKER_PROBE_TIMEOUT_MS);
         try {
             const response = await fetcher(workerUrl, {
-                method: 'HEAD',
+                method: 'GET',
                 cache: 'no-cache',
+                headers: {
+                    Range: `bytes=0-${PDF_WORKER_VERSION_PROBE_BYTES - 1}`,
+                },
                 signal: controller.signal,
             });
-            if (response.ok) {
-                return isJavaScriptLikeResponse(response);
+            if ((!response.ok && response.status !== 206) || !isJavaScriptLikeResponse(response)) {
+                return { status: 'unavailable', workerVersion: null };
             }
-            if (response.status !== 405 && response.status !== 501) {
-                return false;
+            const workerVersion = readPdfJsWorkerVersion(await readResponsePrefix(response));
+            if (!workerVersion) {
+                return { status: 'unknown', workerVersion: null };
             }
-            const fallbackResponse = await fetcher(workerUrl, {
-                method: 'GET',
-                cache: 'no-cache',
-                headers: { Range: 'bytes=0-0' },
-                signal: controller.signal,
-            });
-            return (fallbackResponse.ok || fallbackResponse.status === 206) &&
-                isJavaScriptLikeResponse(fallbackResponse);
+            return {
+                status: workerVersion === pdfJsVersion ? 'compatible' : 'incompatible',
+                workerVersion,
+            };
         }
         catch {
-            return false;
+            return { status: 'unavailable', workerVersion: null };
         }
         finally {
             targetWindow.clearTimeout(timer);
         }
     };
     const createPdfWorker = async () => {
+        var _a;
         const workerUrl = resolvePdfWorkerUrl(options, pdfRuntimeAssetBaseUrl);
+        const workerGlobal = globalThis;
+        if ((_a = workerGlobal.pdfjsWorker) === null || _a === void 0 ? void 0 : _a.WorkerMessageHandler) {
+            try {
+                // PDF.js prefers a preinstalled main-thread handler over workerSrc.
+                // Scope our bundled handler only until this PDFWorker captures it, so
+                // a vue-office/PDF.js 3.x global cannot hijack this renderer and the
+                // host can still use its original handler afterwards.
+                return await createBundledPdfFakeWorker();
+            }
+            catch (error) {
+                console.warn('[file-viewer] PDF.js 全局 Worker handler 隔离失败，继续探测静态 Worker。', error);
+            }
+        }
         const hasExplicitWorkerUrl = isConfiguredUrl(options === null || options === void 0 ? void 0 : options.workerUrl);
-        const shouldUseRealWorker = !!(targetWindow === null || targetWindow === void 0 ? void 0 : targetWindow.Worker) &&
-            (hasExplicitWorkerUrl || await canUseResolvedPdfWorkerUrl(workerUrl));
+        const workerProbe = (targetWindow === null || targetWindow === void 0 ? void 0 : targetWindow.Worker)
+            ? await probeResolvedPdfWorkerUrl(workerUrl)
+            : { status: 'unavailable', workerVersion: null };
+        if (workerProbe.status === 'incompatible') {
+            console.warn(`[file-viewer] PDF Worker ${workerProbe.workerVersion} 与 PDF.js API ${pdfJsVersion} 不匹配，` +
+                '改用包内同版本 PDF.js handler。');
+        }
+        const shouldUseRealWorker = !!(targetWindow === null || targetWindow === void 0 ? void 0 : targetWindow.Worker) && (workerProbe.status === 'compatible' ||
+            (hasExplicitWorkerUrl && workerProbe.status !== 'incompatible'));
         if (shouldUseRealWorker) {
             GlobalWorkerOptions.workerSrc = workerUrl;
             try {
@@ -753,7 +795,7 @@ export default async function renderPdf(buffer, target, context) {
             }
         }
         try {
-            await installBundledPdfFakeWorker();
+            return await createBundledPdfFakeWorker();
         }
         catch (error) {
             console.warn('[file-viewer] PDF.js 包内 worker 兜底加载失败，继续使用 PDF.js 默认策略。', error);
@@ -1762,9 +1804,16 @@ export default async function renderPdf(buffer, target, context) {
     container.addEventListener('keydown', recordUserScrollIntent);
     container.addEventListener('scroll', scheduleScrollViewStateChange, { passive: true });
     if (targetWindow.ResizeObserver) {
-        resizeObserver = new targetWindow.ResizeObserver(() => scheduleFitAfterResize());
+        resizeObserver = new targetWindow.ResizeObserver(() => {
+            root.style.setProperty('--viewer-container-height', `${container.clientHeight}px`);
+            scheduleFitAfterResize();
+        });
         resizeObserver.observe(container);
     }
+    // PDFViewer writes this value to documentElement, which cannot safely model
+    // multiple differently-sized viewers. Keep a live shell-local value as well
+    // so Shadow DOM and multi-instance layouts both resolve the dummy-page height.
+    root.style.setProperty('--viewer-container-height', `${container.clientHeight}px`);
     syncUi();
     void loadFile();
     return {

package/dist/pdfWorkerGlobal.d.ts

@@ -0,0 +1,27 @@
+export type PdfJsWorkerNamespace = {
+    WorkerMessageHandler?: unknown;
+    [key: string]: unknown;
+};
+export type PdfJsWorkerGlobal = {
+    pdfjsWorker?: PdfJsWorkerNamespace;
+};
+export type PdfJsWorkerHandlerInstallResult = 'installed' | 'replaced' | 'unchanged';
+export type PdfJsWorkerHandlerScope = {
+    installResult: PdfJsWorkerHandlerInstallResult;
+    restore: () => boolean;
+};
+export type PdfJsWorkerGlobalSnapshot = {
+    hadOwnNamespace: boolean;
+    namespace: PdfJsWorkerNamespace | undefined;
+};
+export declare const capturePdfJsWorkerGlobal: (workerGlobal: PdfJsWorkerGlobal) => PdfJsWorkerGlobalSnapshot;
+/**
+ * Temporarily own the fake-worker handler used by this renderer.
+ *
+ * Host applications can load another PDF.js build before File Viewer. Reusing
+ * that global handler is unsafe because PDF.js requires its API and worker
+ * versions to match exactly. The original namespace is restored after our
+ * PDFWorker has captured and initialized the bundled handler, so a host PDF.js
+ * build can continue using its own global afterwards.
+ */
+export declare const scopePdfJsWorkerMessageHandler: (workerGlobal: PdfJsWorkerGlobal, WorkerMessageHandler: unknown, restoreSnapshot?: PdfJsWorkerGlobalSnapshot) => PdfJsWorkerHandlerScope;

package/dist/pdfWorkerGlobal.js

@@ -0,0 +1,58 @@
+export const capturePdfJsWorkerGlobal = (workerGlobal) => ({
+    hadOwnNamespace: Object.prototype.hasOwnProperty.call(workerGlobal, 'pdfjsWorker'),
+    namespace: workerGlobal.pdfjsWorker,
+});
+/**
+ * Temporarily own the fake-worker handler used by this renderer.
+ *
+ * Host applications can load another PDF.js build before File Viewer. Reusing
+ * that global handler is unsafe because PDF.js requires its API and worker
+ * versions to match exactly. The original namespace is restored after our
+ * PDFWorker has captured and initialized the bundled handler, so a host PDF.js
+ * build can continue using its own global afterwards.
+ */
+export const scopePdfJsWorkerMessageHandler = (workerGlobal, WorkerMessageHandler, restoreSnapshot = capturePdfJsWorkerGlobal(workerGlobal)) => {
+    const currentNamespace = workerGlobal.pdfjsWorker;
+    const installResult = (currentNamespace === null || currentNamespace === void 0 ? void 0 : currentNamespace.WorkerMessageHandler) === WorkerMessageHandler
+        ? 'unchanged'
+        : (currentNamespace === null || currentNamespace === void 0 ? void 0 : currentNamespace.WorkerMessageHandler)
+            ? 'replaced'
+            : 'installed';
+    const installedNamespace = installResult === 'unchanged'
+        ? currentNamespace
+        : {
+            ...currentNamespace,
+            WorkerMessageHandler,
+        };
+    if (!installedNamespace) {
+        return {
+            installResult: 'unchanged',
+            restore: () => false,
+        };
+    }
+    if (installResult !== 'unchanged') {
+        workerGlobal.pdfjsWorker = installedNamespace;
+    }
+    const restorationIsNoop = restoreSnapshot.hadOwnNamespace &&
+        restoreSnapshot.namespace === installedNamespace;
+    let restoreAttempted = false;
+    return {
+        installResult,
+        restore: () => {
+            if (restorationIsNoop || restoreAttempted) {
+                return false;
+            }
+            restoreAttempted = true;
+            if (workerGlobal.pdfjsWorker !== installedNamespace) {
+                return false;
+            }
+            if (restoreSnapshot.hadOwnNamespace) {
+                workerGlobal.pdfjsWorker = restoreSnapshot.namespace;
+            }
+            else {
+                delete workerGlobal.pdfjsWorker;
+            }
+            return true;
+        },
+    };
+};

package/dist/pdfWorkerVersion.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Read the version marker emitted by official PDF.js worker bundles.
+ *
+ * The marker is intentionally read from a small source prefix before a Worker
+ * is constructed. PDF.js does not reject an API/worker mismatch until the
+ * first document request, which is too late for `PDFWorker.promise` to be a
+ * useful compatibility probe.
+ */
+export declare const readPdfJsWorkerVersion: (sourcePrefix: string) => string | null;

package/dist/pdfWorkerVersion.js

@@ -0,0 +1,23 @@
+const PDF_JS_SEMVER_PATTERN = '(\\d+\\.\\d+\\.\\d+(?:-[0-9A-Za-z.-]+)?)';
+const PDF_JS_WORKER_VERSION_PATTERNS = [
+    new RegExp(`\\bpdfjsVersion\\s*=\\s*["']?${PDF_JS_SEMVER_PATTERN}`, 'i'),
+    new RegExp(`\\bworkerVersion\\s*=\\s*["']${PDF_JS_SEMVER_PATTERN}["']`, 'i'),
+    new RegExp(`\\bPDF\\.js\\s+v${PDF_JS_SEMVER_PATTERN}`, 'i'),
+];
+/**
+ * Read the version marker emitted by official PDF.js worker bundles.
+ *
+ * The marker is intentionally read from a small source prefix before a Worker
+ * is constructed. PDF.js does not reject an API/worker mismatch until the
+ * first document request, which is too late for `PDFWorker.promise` to be a
+ * useful compatibility probe.
+ */
+export const readPdfJsWorkerVersion = (sourcePrefix) => {
+    for (const pattern of PDF_JS_WORKER_VERSION_PATTERNS) {
+        const match = pattern.exec(sourcePrefix);
+        if (match === null || match === void 0 ? void 0 : match[1]) {
+            return match[1];
+        }
+    }
+    return null;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@file-viewer/renderer-pdf",
-  "version": "2.1.29",
+  "version": "2.2.0",
   "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.29",
+    "@file-viewer/core": "2.2.0",
     "@fontsource-variable/noto-sans-sc": "5.2.10",
     "pdf-lib": "1.17.1",
     "pdfjs-dist": "5.4.624"