@file-viewer/core 2.0.11 → 2.1.0

package/dist/renderers/index.js

@@ -14,34 +14,6 @@ const createWrapper = (el) => ({
     },
 });
 export const coreBrowserRendererHandlers = [
-    {
-        rendererId: 'code',
-        handler: async (buffer, target, type) => {
-            const { default: renderCode } = await import('./code.js');
-            return renderCode(buffer, target, type);
-        },
-    },
-    {
-        rendererId: 'markdown',
-        handler: async (buffer, target) => {
-            const { default: renderMarkdown } = await import('./markdown.js');
-            return renderMarkdown(buffer, target);
-        },
-    },
-    {
-        rendererId: 'video',
-        handler: async (buffer, target, type, context) => {
-            const { default: renderVideo } = await import('./video.js');
-            return renderVideo(buffer, target, type, context);
-        },
-    },
-    {
-        rendererId: 'audio',
-        handler: async (buffer, target, type) => {
-            const { default: renderAudio } = await import('./audio.js');
-            return renderAudio(buffer, target, type);
-        },
-    },
     {
         rendererId: 'image',
         handler: async (buffer, target, type) => {
@@ -49,133 +21,30 @@ export const coreBrowserRendererHandlers = [
             return renderImage(buffer, target, type);
         },
     },
-    {
-        rendererId: 'umd',
-        handler: async (buffer, target) => {
-            const { default: renderUmd } = await import('./umd.js');
-            return renderUmd(buffer, target);
-        },
-    },
-    {
-        rendererId: 'geo',
-        handler: async (buffer, target, type) => {
-            const { default: renderGeo } = await import('./geo.js');
-            return renderGeo(buffer, target, type);
-        },
-    },
-    {
-        rendererId: 'open-document',
-        handler: async (buffer, target, type) => {
-            const { default: renderOpenDocument } = await import('./openDocument.js');
-            return renderOpenDocument(buffer, target, type);
-        },
-    },
-    {
-        rendererId: 'ofd',
-        handler: async (buffer, target, _type, context) => {
-            const { default: renderOfd } = await import('./ofd.js');
-            return renderOfd(buffer, target, context);
-        },
-    },
-    {
-        rendererId: 'pdf',
-        handler: async (buffer, target, _type, context) => {
-            const { default: renderPdf } = await import('./pdf.js');
-            return renderPdf(buffer, target, context);
-        },
-    },
-    {
-        rendererId: 'office-word-openxml',
-        handler: async (buffer, target, _type, context) => {
-            const { default: renderWordDocx } = await import('./wordDocx.js');
-            return renderWordDocx(buffer, target, context);
-        },
-    },
-    {
-        rendererId: 'office-word-binary',
-        handler: async (buffer, target, _type, context) => {
-            const { default: renderWordDoc } = await import('./wordDoc.js');
-            return renderWordDoc(buffer, target, context);
-        },
-    },
-    {
-        rendererId: 'spreadsheet-openxml',
-        handler: async (buffer, target, type, context) => {
-            const { default: renderSpreadsheet } = await import('./spreadsheet.js');
-            return renderSpreadsheet(buffer, target, type, context);
-        },
-    },
-    {
-        rendererId: 'email',
-        handler: async (buffer, target, type, context) => {
-            const { default: renderEmail } = await import('./email.js');
-            return renderEmail(buffer, target, type, context);
-        },
-    },
-    {
-        rendererId: 'eda',
-        handler: async (buffer, target, type, context) => {
-            const { default: renderEda } = await import('./eda.js');
-            return renderEda(buffer, target, type, context);
-        },
-    },
-    {
-        rendererId: 'cad',
-        handler: async (buffer, target, type, context) => {
-            const { default: renderCad } = await import('./cad.js');
-            return renderCad(buffer, target, type, context);
-        },
-    },
-    {
-        rendererId: 'typst',
-        handler: async (buffer, target, type, context) => {
-            const { default: renderTypst } = await import('./typst.js');
-            return renderTypst(buffer, target, type, context);
-        },
-    },
-    {
-        rendererId: 'office-presentation',
-        handler: async (buffer, target, type, context) => {
-            const { default: renderPptx } = await import('./pptx.js');
-            return renderPptx(buffer, target, type, context);
-        },
-    },
-    {
-        rendererId: 'epub',
-        handler: async (buffer, target) => {
-            const { default: renderEpub } = await import('./epub.js');
-            return renderEpub(buffer, target);
-        },
-    },
-    {
-        rendererId: 'model',
-        handler: async (buffer, target, type, context) => {
-            const { default: renderModel } = await import('./model.js');
-            return renderModel(buffer, target, type, context);
-        },
-    },
-    {
-        rendererId: 'drawing',
-        handler: async (buffer, target, type, context) => {
-            const { default: renderDrawing } = await import('./drawing.js');
-            return renderDrawing(buffer, target, type, context);
-        },
-    },
-    {
-        rendererId: 'data-asset',
-        handler: async (buffer, target, type, context) => {
-            const { default: renderDataAsset } = await import('./data.js');
-            return renderDataAsset(buffer, target, type, context);
-        },
-    },
-    {
-        rendererId: 'archive',
-        handler: async (buffer, target, type, context) => {
-            const { default: renderArchive } = await import('./archive.js');
-            return renderArchive(buffer, target, type, context);
-        },
-    },
 ];
+export const CORE_LITE_RENDERER_IDS = [
+    'image',
+];
+export const coreLiteBrowserRendererHandlers = coreBrowserRendererHandlers.filter(handler => CORE_LITE_RENDERER_IDS.includes(handler.rendererId));
+export const coreLiteRendererDefinitions = DEFAULT_RENDERER_DEFINITIONS.filter(definition => CORE_LITE_RENDERER_IDS.includes(definition.id));
+const resolveCoreRendererDefinitions = (preset) => {
+    if (preset === 'none') {
+        return [];
+    }
+    if (preset === 'lite') {
+        return coreLiteRendererDefinitions;
+    }
+    return DEFAULT_RENDERER_DEFINITIONS;
+};
+const resolveCoreRendererHandlers = (preset) => {
+    if (preset === 'none') {
+        return [];
+    }
+    if (preset === 'lite') {
+        return coreLiteBrowserRendererHandlers;
+    }
+    return coreBrowserRendererHandlers;
+};
 const renderUnsupported = async (_buffer, target, type) => {
     const state = createFileViewerUnsupportedState(type);
     const wrapper = document.createElement('div');
@@ -192,10 +61,11 @@ const renderUnsupported = async (_buffer, target, type) => {
     target.replaceChildren(wrapper);
     return createWrapper(target);
 };
-export const createFileViewerCoreRendererRegistry = () => {
+export const createFileViewerCoreRendererRegistry = (options = {}) => {
+    const preset = options.builtinRenderers || 'all';
     const bridge = createFileRenderHandlerRegistry({
-        definitions: DEFAULT_RENDERER_DEFINITIONS,
-        handlers: coreBrowserRendererHandlers,
+        definitions: resolveCoreRendererDefinitions(preset),
+        handlers: resolveCoreRendererHandlers(preset),
     });
     return {
         ...bridge,

package/dist/viewer/createViewer.js

@@ -10,11 +10,13 @@ import { createFileViewerZoomController } from '../features/document/zoom.js';
 import { DEFAULT_FILE_VIEWER_DOWNLOAD_FILENAME, DEFAULT_FILE_VIEWER_EXPORT_FILENAME, DEFAULT_FILE_VIEWER_PREVIEW_TITLE, createFileViewerOriginalSourceStateFromNormalizedSource, executeFileViewerDownloadOperation, executeFileViewerExportHtmlOperation, executeFileViewerPrintOperation, resolveFileViewerDisplayFilename, resolveFileViewerOperationFilename, } from './operations.js';
 import { getRendererAvailability, createUnsupportedAvailability } from '../registry/capabilities.js';
 import { buildFileViewerLifecycleContextFromNormalizedSource, buildFileViewerOperationContext, runFileViewerBeforeOperation, runFileViewerLifecycleHook, } from '../lifecycle/operations.js';
-import { createRendererRegistry } from '../registry/registry.js';
-import { applyFileViewerRenderSurfaceState, createFileViewerRenderSurfaceState, } from '../rendering/handler.js';
+import { collectFileViewerRendererPlugins, createRendererRegistry, installFileViewerRendererPlugins, } from '../registry/registry.js';
+import { createFileRenderHandlerLoader, applyFileViewerRenderSurfaceState, createFileViewerRenderSurfaceState, } from '../rendering/handler.js';
+import { createFileViewerCoreRendererRegistry } from '../renderers/index.js';
 import { createFileViewerRequestScope } from '../source/loading.js';
 import { normalizeSource } from '../source/index.js';
 import { buildFileViewerWatermarkInlineStyle } from '../features/watermark.js';
+import { createFileViewerUnsupportedState } from './state.js';
 const emitLifecycle = async (options, onEvent, phase, source, version, startedAt, reason) => {
     const now = Date.now();
     const context = buildFileViewerLifecycleContextFromNormalizedSource({
@@ -30,9 +32,52 @@ const emitLifecycle = async (options, onEvent, phase, source, version, startedAt
     });
     onEvent === null || onEvent === void 0 ? void 0 : onEvent({ type: phase, payload: context });
 };
+const createBaseRendererRegistry = (createOptions, options) => {
+    if (options.rendererMode === 'replace') {
+        return createRendererRegistry([]);
+    }
+    if (createOptions.registry) {
+        return createOptions.registry;
+    }
+    return createFileViewerCoreRendererRegistry({
+        builtinRenderers: options.builtinRenderers,
+    }).registry;
+};
+const renderMissingRendererState = (container, type) => {
+    const documentRef = container.ownerDocument;
+    const state = createFileViewerUnsupportedState(type);
+    const wrapper = documentRef.createElement('div');
+    wrapper.className = 'file-viewer-missing-renderer';
+    wrapper.style.cssText = [
+        'display:flex',
+        'min-height:260px',
+        'height:100%',
+        'align-items:center',
+        'justify-content:center',
+        'padding:32px',
+        'box-sizing:border-box',
+        'text-align:center',
+        'color:#64748b',
+        'font:14px/1.6 system-ui,-apple-system,BlinkMacSystemFont,"Segoe UI",sans-serif',
+    ].join(';');
+    const content = documentRef.createElement('div');
+    const title = documentRef.createElement('strong');
+    title.textContent = state.message;
+    title.style.cssText = 'display:block;margin-bottom:8px;color:#172033;font-size:16px;';
+    const description = documentRef.createElement('p');
+    description.textContent = state.description ||
+        '当前内置 renderer 配置没有加载该格式。请安装并传入对应 @file-viewer/renderer-* 包，或使用 @file-viewer/preset-all。';
+    description.style.cssText = 'max-width:520px;margin:0;';
+    content.append(title, description);
+    wrapper.append(content);
+    container.replaceChildren(wrapper);
+};
 export const createViewer = (container, createOptions = {}) => {
-    const registry = createOptions.registry || createRendererRegistry();
     let options = createOptions.options || {};
+    let registry = createBaseRendererRegistry(createOptions, options);
+    let installedRendererInput = undefined;
+    let installedRendererMode = options.rendererMode || 'extend';
+    let installedBuiltinRenderers = options.builtinRenderers || 'all';
     let currentSource = null;
     const renderSurfaceState = createFileViewerRenderSurfaceState();
     const requestScope = createFileViewerRequestScope();
@@ -40,6 +85,42 @@ export const createViewer = (container, createOptions = {}) => {
         anchors: { value: [] },
         state: createEmptyFileViewerSearchState(),
     };
+    const ensureRendererPluginsInstalled = async () => {
+        const nextMode = options.rendererMode || 'extend';
+        const nextRendererInput = options.renderers;
+        const nextBuiltinRenderers = options.builtinRenderers || 'all';
+        if (nextMode === installedRendererMode &&
+            nextRendererInput === installedRendererInput &&
+            nextBuiltinRenderers === installedBuiltinRenderers) {
+            return;
+        }
+        registry = createBaseRendererRegistry(createOptions, options);
+        installedRendererMode = nextMode;
+        installedRendererInput = nextRendererInput;
+        installedBuiltinRenderers = nextBuiltinRenderers;
+        const plugins = collectFileViewerRendererPlugins(nextRendererInput);
+        if (!plugins.length) {
+            return;
+        }
+        const registerHandler = (registration) => {
+            const definition = registry.getById(registration.rendererId);
+            if (!definition) {
+                return;
+            }
+            registry.register({
+                ...definition,
+                load: createFileRenderHandlerLoader({
+                    handler: registration.handler,
+                    getTarget: context => context.surface.container,
+                }),
+            });
+        };
+        await installFileViewerRendererPlugins({
+            registry,
+            plugins,
+            registerHandler,
+        });
+    };
     const buildCurrentLifecycleContext = () => {
         const source = currentSource || normalizeSource({});
         return buildFileViewerLifecycleContextFromNormalizedSource({
@@ -139,6 +220,7 @@ export const createViewer = (container, createOptions = {}) => {
         container,
         async load(source) {
             await destroyCurrent('replace');
+            await ensureRendererPluginsInstalled();
             const normalized = normalizeSource(source);
             currentSource = normalized;
             const version = requestScope.requestController.createVersion();
@@ -146,6 +228,7 @@ export const createViewer = (container, createOptions = {}) => {
             const startedAt = Date.now();
             await emitLifecycle(options, createOptions.onEvent, 'load-start', normalized, version, startedAt);
             if (!(renderer === null || renderer === void 0 ? void 0 : renderer.load)) {
+                renderMissingRendererState(container, normalized.extension);
                 applyFileViewerRenderSurfaceState(renderSurfaceState, { session: null });
                 emitOperationAvailabilityChange();
                 emitZoomChange();

package/package.json

@@ -1,14 +1,21 @@
 {
   "name": "@file-viewer/core",
-  "version": "2.0.11",
+  "version": "2.1.0",
   "private": false,
   "type": "module",
-  "description": "Framework-neutral TypeScript core for Flyfish File Viewer",
+  "description": "Framework-neutral modular TypeScript core for Flyfish File Viewer renderer orchestration, lifecycle APIs, search, zoom, print, and export",
   "keywords": [
     "file-viewer",
     "document-preview",
     "typescript",
-    "core"
+    "core",
+    "document-viewer",
+    "file-preview",
+    "self-hosted",
+    "browser",
+    "wasm",
+    "office-viewer",
+    "pdf-viewer"
   ],
   "publishConfig": {
     "access": "public",
@@ -23,6 +30,13 @@
     "url": "git+https://github.com/flyfish-dev/file-viewer-core.git",
     "directory": "packages/core"
   },
+  "bugs": {
+    "url": "https://github.com/flyfish-dev/file-viewer-core/issues"
+  },
+  "funding": {
+    "type": "individual",
+    "url": "https://dev.flyfish.group/shop"
+  },
   "homepage": "https://doc.file-viewer.app/",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -57,48 +71,7 @@
     "README.en.md",
     "LICENSE"
   ],
-  "dependencies": {
-    "@excalidraw/excalidraw": "^0.18.1",
-    "@file-viewer/docx": "^0.3.12",
-    "@file-viewer/pptx": "^2.0.11",
-    "@flyfish-dev/cad-viewer": "^0.6.4",
-    "@kenjiuno/msgreader": "^1.28.0",
-    "@myriaddreamin/typst-ts-renderer": "0.7.0",
-    "@myriaddreamin/typst-ts-web-compiler": "0.7.0",
-    "@myriaddreamin/typst.ts": "0.7.0",
-    "@tmcw/togeojson": "^7.1.2",
-    "@tonejs/midi": "^2.0.28",
-    "@xmldom/xmldom": "^0.9.10",
-    "ag-psd": "^30.1.1",
-    "avsc": "^5.7.9",
-    "cfb": "^1.2.2",
-    "e-virt-table": "^1.3.26",
-    "epubjs": "^0.3.93",
-    "heic2any": "^0.0.4",
-    "highlight.js": "^11.11.1",
-    "hls.js": "^1.6.16",
-    "hyparquet": "^1.26.0",
-    "jszip": "^3.10.1",
-    "libarchive.js": "^2.0.2",
-    "linkedom": "^0.18.12",
-    "marked": "^18.0.5",
-    "msdoc-viewer": "^0.2.0",
-    "ofd-xml-parser": "^0.0.6",
-    "pako": "^2.1.0",
-    "pdfjs-dist": "^6.0.227",
-    "postal-mime": "^2.7.4",
-    "roughjs": "^4.6.6",
-    "rtf.js": "^3.0.9",
-    "shpjs": "^6.2.0",
-    "sql.js": "^1.14.1",
-    "styled-exceljs": "0.21.1",
-    "three": "^0.184.0",
-    "tinycolor2": "^1.6.0"
-  },
   "devDependencies": {
-    "@types/pako": "^2.0.4",
-    "@types/three": "^0.184.1",
-    "@types/tinycolor2": "^1.4.6",
     "typescript": "^6.0.3"
   },
   "license": "Apache-2.0",

package/dist/renderers/archive.d.ts

@@ -1,2 +0,0 @@
-import type { FileRenderContext, FileViewerRenderedInstance } from '../contracts/types';
-export default function renderArchive(buffer: ArrayBuffer, target: HTMLDivElement, _type?: string, context?: FileRenderContext): Promise<FileViewerRenderedInstance>;