@file-viewer/core 2.1.1 → 2.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -195,6 +195,15 @@ export interface FileViewerCadOptions {
195
195
  }
196
196
  export type FileViewerRendererMode = 'extend' | 'replace';
197
197
  export type FileViewerBuiltinRendererPreset = 'all' | 'lite' | 'none';
198
+ export interface FileViewerAutoRendererOptions {
199
+ /**
200
+ * Uses renderer presets registered by build tooling or preset side-effect imports.
201
+ *
202
+ * Defaults to true in `extend` mode and false in `replace` mode so applications
203
+ * can keep a strict hand-picked renderer registry when needed.
204
+ */
205
+ enabled?: boolean;
206
+ }
198
207
  export interface FileViewerSearchOptions {
199
208
  enabled?: boolean;
200
209
  caseSensitive?: boolean;
@@ -230,6 +239,12 @@ export interface FileViewerOptions {
230
239
  * allowing renderer plugins or presets to be installed through `renderers`.
231
240
  */
232
241
  builtinRenderers?: FileViewerBuiltinRendererPreset;
242
+ /**
243
+ * Enables renderer presets that were auto-registered by `@file-viewer/vite-plugin`
244
+ * or by explicitly importing a preset package. Set to false when a product wants
245
+ * total manual control through `renderers`.
246
+ */
247
+ autoRenderers?: boolean | FileViewerAutoRendererOptions;
233
248
  renderers?: FileViewerRendererPluginInput;
234
249
  watermark?: boolean | FileViewerWatermarkOptions;
235
250
  toolbar?: boolean | FileViewerToolbarOptions;
package/dist/index.d.ts CHANGED
@@ -14,7 +14,8 @@ export { applyPrintPageSize, buildPrintPageStyle, formatCssPixels, getElementPri
14
14
  export type { ApplyPrintPageSizeOptions, BuildPrintPageStyleOptions, PrintPageSize, } from './output/printLayout';
15
15
  export { DEFAULT_FILE_VIEWER_DOWNLOAD_FILENAME, DEFAULT_FILE_VIEWER_EXPORT_FILENAME, DEFAULT_FILE_VIEWER_PREVIEW_TITLE, FILE_VIEWER_OPERATION_ACTION_ERROR_PREFIXES, createFileViewerOperationActionHandlers, createFileViewerOriginalSourceState, createFileViewerOriginalSourceStateFromNormalizedSource, createFileViewerPublicOperationActionHandlers, executeFileViewerDownloadOperation, executeFileViewerExportHtmlOperation, executeFileViewerPrintOperation, hasFileViewerOriginalSource, resolveFileViewerDisplayFilename, resolveFileViewerOperationActionErrorMessage, resolveFileViewerOperationFilename, resolveFileViewerOriginalFilename, } from './viewer/operations';
16
16
  export type { CreateFileViewerOperationActionHandlersInput, FileViewerOperationActionErrorFormatter, FileViewerFileOperationType, FileViewerOperationActionErrorContext, FileViewerOperationActionErrorPrefixes, FileViewerOperationActionHandlers, FileViewerPublicOperationActionHandlers, ResolveFileViewerOperationActionErrorMessageInput, } from './viewer/operations';
17
- export { collectFileViewerRendererPlugins, createRendererRegistry, installFileViewerRendererPlugins, } from './registry/registry';
17
+ export { clearFileViewerAutoRendererPresets, collectFileViewerRendererPlugins, createRendererRegistry, getFileViewerAutoRendererPresetVersion, installFileViewerRendererPlugins, listFileViewerAutoRendererPresets, registerFileViewerAutoRendererPreset, unregisterFileViewerAutoRendererPreset, } from './registry/registry';
18
+ export type { RegisterFileViewerAutoRendererPresetOptions, } from './registry/registry';
18
19
  export { CORE_LITE_RENDERER_IDS, coreBrowserRendererHandlers, coreLiteBrowserRendererHandlers, coreLiteRendererDefinitions, createFileViewerCoreRendererRegistry, fileViewerCoreRendererDispatcher, fileViewerCoreRendererRegistry, fileViewerCoreRendererRegistryBridge, missingFileViewerCoreRendererHandlers, } from './renderers/index';
19
20
  export type { CreateFileViewerCoreRendererRegistryOptions, } from './renderers/index';
20
21
  export declare const renderFileViewerAudio: (buffer: ArrayBuffer, target: HTMLDivElement, type?: string) => Promise<FileViewerRenderedInstance>;
@@ -56,8 +57,8 @@ export { buildFileRenderContextFromLoadContext, applyFileViewerRenderSurfaceStat
56
57
  export type { CreateFileViewerRenderSurfaceActionHandlersInput, CreateFileViewerRenderReadinessTargetInput, CreateFileViewerRenderSurfaceStateTargetInput, FileViewerRenderSurfaceActionHandlers, FileViewerRenderSurfaceClearState, FileViewerRenderSurfaceState, FileViewerRenderSurfaceMountContext, FileViewerRenderSessionDisposeErrorLogger, MutableFileViewerRenderSurfaceState, ReportFileViewerRenderSessionDisposeErrorInput, ResetFileViewerRenderSurfaceInput, ResolveFileViewerRenderSessionDisposeErrorMessageInput, RunFileViewerRenderSurfaceClearInput, RunFileViewerRenderSurfaceMountInput, } from './rendering/handler';
57
58
  export { DEFAULT_FILE_VIEWER_SOURCE_FILENAME, decodeFilename, getExtension, normalizeFileExtension, normalizeFilename, resolveFileViewerSourceFilename, normalizeSource, readFileViewerBuffer, readFileViewerDataUrl, readFileViewerText, wrapFileViewerFileRef, } from './source';
58
59
  export type { FileViewerReadResult } from './source';
59
- export { DEFAULT_FILE_VIEWER_STATE_THEME, DEFAULT_FILE_VIEWER_UNSUPPORTED_DESCRIPTION, FILE_VIEWER_PREVIEW_MESSAGES, createFileViewerEmptyState, createFileViewerErrorState, createFileViewerPreviewLoadingState, createFileViewerReadyState, createFileViewerUnsupportedState, formatFileViewerErrorMessage, normalizeFileViewerErrorMessage, } from './viewer/state';
60
- export type { FileViewerErrorMessageFormatter, } from './viewer/state';
60
+ export { DEFAULT_FILE_VIEWER_STATE_THEME, DEFAULT_FILE_VIEWER_UNSUPPORTED_DESCRIPTION, FILE_VIEWER_PREVIEW_MESSAGES, createFileViewerEmptyState, createFileViewerErrorState, createFileViewerPreviewLoadingState, createFileViewerReadyState, createFileViewerUnsupportedState, formatFileViewerErrorMessage, normalizeFileViewerErrorMessage, resolveFileViewerRendererInstallHint, } from './viewer/state';
61
+ export type { FileViewerErrorMessageFormatter, FileViewerRendererInstallHint, } from './viewer/state';
61
62
  export { buildFileViewerWatermarkBackgroundImage, buildFileViewerWatermarkInlineStyle, buildFileViewerWatermarkStyle, buildFileViewerWatermarkSvg, normalizeFileViewerWatermark, resolveFileViewerWatermarkPresentationState, } from './features/watermark';
62
63
  export type { FileViewerWatermarkPresentationState, FileViewerWatermarkStyle, } from './features/watermark';
63
64
  export { cancelFileViewerPreviewRequest, DEFAULT_FILE_VIEWER_STREAMING_PDF_FILENAME, DEFAULT_FILE_VIEWER_PREVIEW_LOAD_ERROR_LOGGER, DEFAULT_PDF_RANGE_CHUNK_SIZE, FILE_VIEWER_PREVIEW_LOAD_ERROR_PREFIXES, FILE_VIEWER_REMOTE_MISSING_DATA_ERROR_MESSAGE, applyFileViewerEmptyPreviewState, applyFileViewerPreviewFilenameState, applyFileViewerPreviewSourceUrlState, applyFileViewerReadPreviewState, applyFileViewerRenderReadinessState, applyFileViewerPreviewRequestResetState, commitFileViewerEmptyPreviewResetState, commitFileViewerLoadStartState, commitFileViewerPreviewRequestStartState, commitFileViewerRenderCompleteState, commitFileViewerRemoteDownloadState, createFileViewerEmptyPreviewState, createFileViewerLoadStartState, createFileViewerPreviewStateTarget, createFileViewerSourceLoadingActionHandlers, createFileViewerReadPreviewState, createFileViewerPreviewRequestResetState, createFileViewerRenderCompleteState, createFileViewerRequestController, createFileViewerRequestScope, createFileViewerStreamingPdfPlaceholderFile, finalizeFileViewerPreviewLoadState, hasFileViewerPreviewSource, isFileViewerAbortError, isSameOriginUrl, normalizeFileViewerSourceUrl, normalizePdfStreamingMode, resolveFileViewerFileRefSourcePlan, resolveFileViewerLoadStartMessage, resolveFileViewerMissingRemoteDataErrorMessage, resolveFileViewerPreviewLoadErrorMessage, resolveFileViewerPreviewRequestReason, resolveFileViewerRemoteSourcePlan, resolveFileViewerPageHref, reportFileViewerMissingRemoteData, reportFileViewerPreviewLoadError, runFileViewerLocalFilePreview, runFileViewerPreviewComponentUnmount, runFileViewerPreviewRequest, runFileViewerPreviewSourceChange, runFileViewerRemoteFilePreview, runFileViewerReadAndRenderFile, runFileViewerStreamingPdfPreview, shouldStreamPdfUrl, } from './source/loading';
package/dist/index.js CHANGED
@@ -8,7 +8,7 @@ export { DEFAULT_FILE_VIEWER_ANCHOR_EXCLUDE_SELECTOR, DEFAULT_FILE_VIEWER_ANCHOR
8
8
  export { buildFileViewerRenderedHtmlDocument, buildExportHtmlDocument, collectDocumentStyles, prepareFileViewerRenderedContentForSnapshot, replaceFileViewerCanvasWithImages, resolveFileViewerPrintStyle, triggerFileViewerBlobDownload, triggerFileViewerUrlDownload, waitForFileViewerImages, waitForFileViewerNextPaint, waitForFileViewerPrintWindowReady, } from './output/export.js';
9
9
  export { applyPrintPageSize, buildPrintPageStyle, formatCssPixels, getElementPrintPageSize, } from './output/printLayout.js';
10
10
  export { DEFAULT_FILE_VIEWER_DOWNLOAD_FILENAME, DEFAULT_FILE_VIEWER_EXPORT_FILENAME, DEFAULT_FILE_VIEWER_PREVIEW_TITLE, FILE_VIEWER_OPERATION_ACTION_ERROR_PREFIXES, createFileViewerOperationActionHandlers, createFileViewerOriginalSourceState, createFileViewerOriginalSourceStateFromNormalizedSource, createFileViewerPublicOperationActionHandlers, executeFileViewerDownloadOperation, executeFileViewerExportHtmlOperation, executeFileViewerPrintOperation, hasFileViewerOriginalSource, resolveFileViewerDisplayFilename, resolveFileViewerOperationActionErrorMessage, resolveFileViewerOperationFilename, resolveFileViewerOriginalFilename, } from './viewer/operations.js';
11
- export { collectFileViewerRendererPlugins, createRendererRegistry, installFileViewerRendererPlugins, } from './registry/registry.js';
11
+ export { clearFileViewerAutoRendererPresets, collectFileViewerRendererPlugins, createRendererRegistry, getFileViewerAutoRendererPresetVersion, installFileViewerRendererPlugins, listFileViewerAutoRendererPresets, registerFileViewerAutoRendererPreset, unregisterFileViewerAutoRendererPreset, } from './registry/registry.js';
12
12
  export { CORE_LITE_RENDERER_IDS, coreBrowserRendererHandlers, coreLiteBrowserRendererHandlers, coreLiteRendererDefinitions, createFileViewerCoreRendererRegistry, fileViewerCoreRendererDispatcher, fileViewerCoreRendererRegistry, fileViewerCoreRendererRegistryBridge, missingFileViewerCoreRendererHandlers, } from './renderers/index.js';
13
13
  export const renderFileViewerAudio = async (buffer, target, type) => {
14
14
  void buffer;
@@ -168,7 +168,7 @@ export { resolveFileViewerPresentationState, } from './presentation/state.js';
168
168
  export { createFileViewerRendererDispatcher, } from './rendering/dispatcher.js';
169
169
  export { buildFileRenderContextFromLoadContext, applyFileViewerRenderSurfaceState, clearFileViewerRenderSurface, createFileRenderHandlerRendererSession, createFileRenderHandlerRegistry, createFileRenderHandlerLoader, createFileViewerRenderSurfaceActionHandlers, createFileViewerRenderReadinessTarget, createFileViewerRenderSurfaceState, createFileViewerRenderSurfaceStateTarget, createFileViewerRenderTarget, DEFAULT_FILE_VIEWER_RENDER_TARGET_CLASS, DEFAULT_FILE_VIEWER_RENDER_SESSION_DISPOSE_ERROR_LOGGER, FILE_VIEWER_RENDER_SESSION_DISPOSE_ERROR_MESSAGE, disposeActiveFileViewerRendererSession, disposeFileViewerRendered, disposeFileViewerRendererSession, removeFileViewerRenderTarget, reportFileViewerRenderSessionDisposeError, resetFileViewerRenderSurface, resolveFileViewerRenderSessionDisposeErrorMessage, runFileViewerRenderSurfaceClear, runFileViewerRenderSurfaceMount, renderFileViewerHandler, } from './rendering/handler.js';
170
170
  export { DEFAULT_FILE_VIEWER_SOURCE_FILENAME, decodeFilename, getExtension, normalizeFileExtension, normalizeFilename, resolveFileViewerSourceFilename, normalizeSource, readFileViewerBuffer, readFileViewerDataUrl, readFileViewerText, wrapFileViewerFileRef, } from './source/index.js';
171
- export { DEFAULT_FILE_VIEWER_STATE_THEME, DEFAULT_FILE_VIEWER_UNSUPPORTED_DESCRIPTION, FILE_VIEWER_PREVIEW_MESSAGES, createFileViewerEmptyState, createFileViewerErrorState, createFileViewerPreviewLoadingState, createFileViewerReadyState, createFileViewerUnsupportedState, formatFileViewerErrorMessage, normalizeFileViewerErrorMessage, } from './viewer/state.js';
171
+ export { DEFAULT_FILE_VIEWER_STATE_THEME, DEFAULT_FILE_VIEWER_UNSUPPORTED_DESCRIPTION, FILE_VIEWER_PREVIEW_MESSAGES, createFileViewerEmptyState, createFileViewerErrorState, createFileViewerPreviewLoadingState, createFileViewerReadyState, createFileViewerUnsupportedState, formatFileViewerErrorMessage, normalizeFileViewerErrorMessage, resolveFileViewerRendererInstallHint, } from './viewer/state.js';
172
172
  export { buildFileViewerWatermarkBackgroundImage, buildFileViewerWatermarkInlineStyle, buildFileViewerWatermarkStyle, buildFileViewerWatermarkSvg, normalizeFileViewerWatermark, resolveFileViewerWatermarkPresentationState, } from './features/watermark.js';
173
173
  export { cancelFileViewerPreviewRequest, DEFAULT_FILE_VIEWER_STREAMING_PDF_FILENAME, DEFAULT_FILE_VIEWER_PREVIEW_LOAD_ERROR_LOGGER, DEFAULT_PDF_RANGE_CHUNK_SIZE, FILE_VIEWER_PREVIEW_LOAD_ERROR_PREFIXES, FILE_VIEWER_REMOTE_MISSING_DATA_ERROR_MESSAGE, applyFileViewerEmptyPreviewState, applyFileViewerPreviewFilenameState, applyFileViewerPreviewSourceUrlState, applyFileViewerReadPreviewState, applyFileViewerRenderReadinessState, applyFileViewerPreviewRequestResetState, commitFileViewerEmptyPreviewResetState, commitFileViewerLoadStartState, commitFileViewerPreviewRequestStartState, commitFileViewerRenderCompleteState, commitFileViewerRemoteDownloadState, createFileViewerEmptyPreviewState, createFileViewerLoadStartState, createFileViewerPreviewStateTarget, createFileViewerSourceLoadingActionHandlers, createFileViewerReadPreviewState, createFileViewerPreviewRequestResetState, createFileViewerRenderCompleteState, createFileViewerRequestController, createFileViewerRequestScope, createFileViewerStreamingPdfPlaceholderFile, finalizeFileViewerPreviewLoadState, hasFileViewerPreviewSource, isFileViewerAbortError, isSameOriginUrl, normalizeFileViewerSourceUrl, normalizePdfStreamingMode, resolveFileViewerFileRefSourcePlan, resolveFileViewerLoadStartMessage, resolveFileViewerMissingRemoteDataErrorMessage, resolveFileViewerPreviewLoadErrorMessage, resolveFileViewerPreviewRequestReason, resolveFileViewerRemoteSourcePlan, resolveFileViewerPageHref, reportFileViewerMissingRemoteData, reportFileViewerPreviewLoadError, runFileViewerLocalFilePreview, runFileViewerPreviewComponentUnmount, runFileViewerPreviewRequest, runFileViewerPreviewSourceChange, runFileViewerRemoteFilePreview, runFileViewerReadAndRenderFile, runFileViewerStreamingPdfPreview, shouldStreamPdfUrl, } from './source/loading.js';
174
174
  export { createViewer } from './viewer/createViewer.js';
@@ -1,4 +1,15 @@
1
1
  import type { FileViewerRendererHandlerRegistration, FileViewerRendererPluginInput, FileViewerRendererPlugin, RendererDefinition, RendererRegistry } from '../contracts/types';
2
+ export interface RegisterFileViewerAutoRendererPresetOptions {
3
+ /**
4
+ * Stable key used to replace an existing auto preset registration.
5
+ */
6
+ id?: string;
7
+ /**
8
+ * Package name is useful for diagnostics and gives generated integrations a
9
+ * deterministic id even when the preset input is an array.
10
+ */
11
+ packageName?: string;
12
+ }
2
13
  export declare const createRendererRegistry: (initialDefinitions?: readonly RendererDefinition[]) => RendererRegistry;
3
14
  export interface InstallFileViewerRendererPluginsOptions<Handler = unknown> {
4
15
  registry: RendererRegistry;
@@ -6,4 +17,9 @@ export interface InstallFileViewerRendererPluginsOptions<Handler = unknown> {
6
17
  registerHandler?: (registration: FileViewerRendererHandlerRegistration<Handler>) => void;
7
18
  }
8
19
  export declare const collectFileViewerRendererPlugins: <Handler = unknown>(input?: FileViewerRendererPluginInput<Handler> | null) => FileViewerRendererPlugin<Handler>[];
20
+ export declare const registerFileViewerAutoRendererPreset: <Handler = unknown>(input: FileViewerRendererPluginInput<Handler>, options?: RegisterFileViewerAutoRendererPresetOptions) => () => void;
21
+ export declare const unregisterFileViewerAutoRendererPreset: (id: string) => boolean;
22
+ export declare const clearFileViewerAutoRendererPresets: () => void;
23
+ export declare const listFileViewerAutoRendererPresets: <Handler = unknown>() => FileViewerRendererPluginInput<Handler>[];
24
+ export declare const getFileViewerAutoRendererPresetVersion: () => number;
9
25
  export declare const installFileViewerRendererPlugins: <Handler = unknown>({ registry, plugins, registerHandler, }: InstallFileViewerRendererPluginsOptions<Handler>) => Promise<RendererRegistry>;
@@ -1,5 +1,16 @@
1
1
  import { DEFAULT_RENDERER_DEFINITIONS } from './formats.js';
2
2
  import { normalizeFileExtension } from '../source/index.js';
3
+ const autoRendererBucketKey = '__flyfish_file_viewer_auto_renderer_presets__';
4
+ const getAutoRendererBucket = () => {
5
+ const host = globalThis;
6
+ if (!host[autoRendererBucketKey]) {
7
+ host[autoRendererBucketKey] = {
8
+ version: 0,
9
+ presets: new Map(),
10
+ };
11
+ }
12
+ return host[autoRendererBucketKey];
13
+ };
3
14
  const normalizeDefinition = (definition) => ({
4
15
  ...definition,
5
16
  extensions: definition.extensions.map(normalizeFileExtension),
@@ -77,6 +88,55 @@ export const collectFileViewerRendererPlugins = (input) => {
77
88
  }
78
89
  return [input];
79
90
  };
91
+ const resolveAutoRendererPresetId = (input, options = {}) => {
92
+ if (options.id) {
93
+ return options.id;
94
+ }
95
+ if (options.packageName) {
96
+ return options.packageName;
97
+ }
98
+ if (isRendererPreset(input)) {
99
+ return input.id;
100
+ }
101
+ if (!Array.isArray(input) && input && typeof input === 'object' && 'id' in input) {
102
+ return String(input.id);
103
+ }
104
+ return 'file-viewer-auto-renderers';
105
+ };
106
+ export const registerFileViewerAutoRendererPreset = (input, options = {}) => {
107
+ const bucket = getAutoRendererBucket();
108
+ const id = resolveAutoRendererPresetId(input, options);
109
+ const existing = bucket.presets.get(id);
110
+ if ((existing === null || existing === void 0 ? void 0 : existing.input) !== input || existing.packageName !== options.packageName) {
111
+ bucket.presets.set(id, {
112
+ id,
113
+ packageName: options.packageName,
114
+ input: input,
115
+ });
116
+ bucket.version += 1;
117
+ }
118
+ return () => {
119
+ unregisterFileViewerAutoRendererPreset(id);
120
+ };
121
+ };
122
+ export const unregisterFileViewerAutoRendererPreset = (id) => {
123
+ const bucket = getAutoRendererBucket();
124
+ const removed = bucket.presets.delete(id);
125
+ if (removed) {
126
+ bucket.version += 1;
127
+ }
128
+ return removed;
129
+ };
130
+ export const clearFileViewerAutoRendererPresets = () => {
131
+ const bucket = getAutoRendererBucket();
132
+ if (!bucket.presets.size) {
133
+ return;
134
+ }
135
+ bucket.presets.clear();
136
+ bucket.version += 1;
137
+ };
138
+ export const listFileViewerAutoRendererPresets = () => Array.from(getAutoRendererBucket().presets.values()).map(entry => entry.input);
139
+ export const getFileViewerAutoRendererPresetVersion = () => getAutoRendererBucket().version;
80
140
  export const installFileViewerRendererPlugins = async ({ registry, plugins, registerHandler, }) => {
81
141
  var _a, _b, _c;
82
142
  for (const plugin of plugins) {
@@ -10,7 +10,7 @@ import { createFileViewerZoomController } from '../features/document/zoom.js';
10
10
  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';
11
11
  import { getRendererAvailability, createUnsupportedAvailability } from '../registry/capabilities.js';
12
12
  import { buildFileViewerLifecycleContextFromNormalizedSource, buildFileViewerOperationContext, runFileViewerBeforeOperation, runFileViewerLifecycleHook, } from '../lifecycle/operations.js';
13
- import { collectFileViewerRendererPlugins, createRendererRegistry, installFileViewerRendererPlugins, } from '../registry/registry.js';
13
+ import { collectFileViewerRendererPlugins, createRendererRegistry, getFileViewerAutoRendererPresetVersion, installFileViewerRendererPlugins, listFileViewerAutoRendererPresets, } from '../registry/registry.js';
14
14
  import { createFileRenderHandlerLoader, applyFileViewerRenderSurfaceState, createFileViewerRenderSurfaceState, } from '../rendering/handler.js';
15
15
  import { createFileViewerCoreRendererRegistry } from '../renderers/index.js';
16
16
  import { createFileViewerRequestScope } from '../source/loading.js';
@@ -43,6 +43,16 @@ const createBaseRendererRegistry = (createOptions, options) => {
43
43
  builtinRenderers: options.builtinRenderers,
44
44
  }).registry;
45
45
  };
46
+ const resolveAutoRenderersEnabled = (options) => {
47
+ const setting = options.autoRenderers;
48
+ if (typeof setting === 'boolean') {
49
+ return setting;
50
+ }
51
+ if ((setting === null || setting === void 0 ? void 0 : setting.enabled) !== undefined) {
52
+ return setting.enabled;
53
+ }
54
+ return (options.rendererMode || 'extend') !== 'replace';
55
+ };
46
56
  const renderMissingRendererState = (container, type) => {
47
57
  const documentRef = container.ownerDocument;
48
58
  const state = createFileViewerUnsupportedState(type);
@@ -78,6 +88,8 @@ export const createViewer = (container, createOptions = {}) => {
78
88
  let installedRendererInput = undefined;
79
89
  let installedRendererMode = options.rendererMode || 'extend';
80
90
  let installedBuiltinRenderers = options.builtinRenderers || 'all';
91
+ let installedAutoRenderersEnabled = resolveAutoRenderersEnabled(options);
92
+ let installedAutoRendererVersion = -1;
81
93
  let currentSource = null;
82
94
  const renderSurfaceState = createFileViewerRenderSurfaceState();
83
95
  const requestScope = createFileViewerRequestScope();
@@ -89,16 +101,31 @@ export const createViewer = (container, createOptions = {}) => {
89
101
  const nextMode = options.rendererMode || 'extend';
90
102
  const nextRendererInput = options.renderers;
91
103
  const nextBuiltinRenderers = options.builtinRenderers || 'all';
104
+ const nextAutoRenderersEnabled = resolveAutoRenderersEnabled(options);
105
+ const nextAutoRendererVersion = nextAutoRenderersEnabled
106
+ ? getFileViewerAutoRendererPresetVersion()
107
+ : 0;
92
108
  if (nextMode === installedRendererMode &&
93
109
  nextRendererInput === installedRendererInput &&
94
- nextBuiltinRenderers === installedBuiltinRenderers) {
110
+ nextBuiltinRenderers === installedBuiltinRenderers &&
111
+ nextAutoRenderersEnabled === installedAutoRenderersEnabled &&
112
+ nextAutoRendererVersion === installedAutoRendererVersion) {
95
113
  return;
96
114
  }
97
115
  registry = createBaseRendererRegistry(createOptions, options);
98
116
  installedRendererMode = nextMode;
99
117
  installedRendererInput = nextRendererInput;
100
118
  installedBuiltinRenderers = nextBuiltinRenderers;
101
- const plugins = collectFileViewerRendererPlugins(nextRendererInput);
119
+ installedAutoRenderersEnabled = nextAutoRenderersEnabled;
120
+ installedAutoRendererVersion = nextAutoRendererVersion;
121
+ const rendererInputs = [];
122
+ if (nextAutoRenderersEnabled) {
123
+ rendererInputs.push(...listFileViewerAutoRendererPresets());
124
+ }
125
+ if (nextRendererInput) {
126
+ rendererInputs.push(nextRendererInput);
127
+ }
128
+ const plugins = collectFileViewerRendererPlugins(rendererInputs);
102
129
  if (!plugins.length) {
103
130
  return;
104
131
  }
@@ -1,4 +1,4 @@
1
- import type { FileViewerStateDescriptor, FileViewerStateTheme } from '../contracts/types';
1
+ import type { FileViewerRendererCategory, FileViewerStateDescriptor, FileViewerStateTheme } from '../contracts/types';
2
2
  export type FileViewerErrorMessageFormatter = (prefix: string, error: unknown) => string;
3
3
  export declare const FILE_VIEWER_PREVIEW_MESSAGES: Readonly<{
4
4
  downloading: "正在下载文件资源...";
@@ -7,6 +7,17 @@ export declare const FILE_VIEWER_PREVIEW_MESSAGES: Readonly<{
7
7
  }>;
8
8
  export declare const DEFAULT_FILE_VIEWER_STATE_THEME: FileViewerStateTheme;
9
9
  export declare const DEFAULT_FILE_VIEWER_UNSUPPORTED_DESCRIPTION = "\u652F\u6301 Office\u3001PDF\u3001OFD\u3001Typst\u3001\u538B\u7F29\u5305\u3001\u90AE\u4EF6\u3001OLB/DRA\u3001CAD\u3001\u5730\u7406\u6570\u636E\u30013D \u6A21\u578B\u3001Excalidraw\u3001draw.io\u3001EPUB\u3001UMD\u3001Markdown\u3001\u4EE3\u7801/\u6587\u672C\u3001\u56FE\u7247\u3001\u97F3\u89C6\u9891\u3001\u5B57\u4F53\u548C\u6570\u636E\u8D44\u4EA7\u7684\u5728\u7EBF\u9884\u89C8";
10
+ export interface FileViewerRendererInstallHint {
11
+ extension: string;
12
+ rendererId: string;
13
+ rendererLabel: string;
14
+ rendererCategory: FileViewerRendererCategory;
15
+ rendererPackage?: string;
16
+ presetPackage: string;
17
+ vitePreset: string;
18
+ presetLabel: string;
19
+ }
20
+ export declare const resolveFileViewerRendererInstallHint: (extension?: string) => FileViewerRendererInstallHint | null;
10
21
  export declare const createFileViewerPreviewLoadingState: (extension?: string, message?: "正在解析文件内容...", theme?: FileViewerStateTheme) => FileViewerStateDescriptor;
11
22
  export declare const createFileViewerReadyState: (extension?: string, theme?: FileViewerStateTheme) => FileViewerStateDescriptor;
12
23
  export declare const createFileViewerEmptyState: (extension?: string, theme?: FileViewerStateTheme) => FileViewerStateDescriptor;
@@ -1,4 +1,5 @@
1
1
  import { normalizeFileExtension } from '../source/index.js';
2
+ import { DEFAULT_RENDERER_DEFINITIONS } from '../registry/formats.js';
2
3
  export const FILE_VIEWER_PREVIEW_MESSAGES = Object.freeze({
3
4
  downloading: '正在下载文件资源...',
4
5
  streamingPdf: '正在建立 PDF 流式预览...',
@@ -16,6 +17,105 @@ const extensionLabel = (extension) => {
16
17
  const normalized = normalizeFileExtension(extension);
17
18
  return normalized ? `.${normalized}` : '当前';
18
19
  };
20
+ const rendererPackageById = {
21
+ 'office-word-openxml': '@file-viewer/renderer-word',
22
+ 'office-word-binary': '@file-viewer/renderer-word',
23
+ 'office-presentation': '@file-viewer/renderer-presentation',
24
+ 'open-document': '@file-viewer/renderer-word',
25
+ 'spreadsheet-openxml': '@file-viewer/renderer-spreadsheet',
26
+ pdf: '@file-viewer/renderer-pdf',
27
+ ofd: '@file-viewer/renderer-ofd',
28
+ typst: '@file-viewer/renderer-typst',
29
+ archive: '@file-viewer/renderer-archive',
30
+ email: '@file-viewer/renderer-email',
31
+ eda: '@file-viewer/renderer-eda',
32
+ cad: '@file-viewer/renderer-cad',
33
+ model: '@file-viewer/renderer-3d',
34
+ geo: '@file-viewer/renderer-geo',
35
+ drawing: '@file-viewer/renderer-drawing',
36
+ mindmap: '@file-viewer/renderer-mindmap',
37
+ epub: '@file-viewer/renderer-epub',
38
+ umd: '@file-viewer/renderer-epub',
39
+ image: '@file-viewer/renderer-image',
40
+ markdown: '@file-viewer/renderer-text',
41
+ code: '@file-viewer/renderer-text',
42
+ video: '@file-viewer/renderer-media',
43
+ audio: '@file-viewer/renderer-media',
44
+ 'data-asset': '@file-viewer/renderer-data',
45
+ };
46
+ const officeRendererIds = new Set([
47
+ 'office-word-openxml',
48
+ 'office-word-binary',
49
+ 'office-presentation',
50
+ 'open-document',
51
+ 'spreadsheet-openxml',
52
+ 'pdf',
53
+ 'ofd',
54
+ ]);
55
+ const liteRendererIds = new Set([
56
+ 'image',
57
+ 'markdown',
58
+ 'code',
59
+ 'video',
60
+ 'audio',
61
+ ]);
62
+ const engineeringRendererIds = new Set([
63
+ 'typst',
64
+ 'archive',
65
+ 'eda',
66
+ 'cad',
67
+ 'model',
68
+ 'geo',
69
+ 'drawing',
70
+ 'mindmap',
71
+ 'data-asset',
72
+ ]);
73
+ const resolvePresetHint = (definition) => {
74
+ if (officeRendererIds.has(definition.id)) {
75
+ return {
76
+ packageName: '@file-viewer/preset-office',
77
+ vitePreset: 'office',
78
+ label: 'Office preset',
79
+ };
80
+ }
81
+ if (engineeringRendererIds.has(definition.id)) {
82
+ return {
83
+ packageName: '@file-viewer/preset-engineering',
84
+ vitePreset: 'engineering',
85
+ label: 'Engineering preset',
86
+ };
87
+ }
88
+ if (liteRendererIds.has(definition.id)) {
89
+ return {
90
+ packageName: '@file-viewer/preset-lite',
91
+ vitePreset: 'lite',
92
+ label: 'Lite preset',
93
+ };
94
+ }
95
+ return {
96
+ packageName: '@file-viewer/preset-all',
97
+ vitePreset: 'all',
98
+ label: 'Full preset',
99
+ };
100
+ };
101
+ export const resolveFileViewerRendererInstallHint = (extension = '') => {
102
+ const normalized = normalizeFileExtension(extension);
103
+ const definition = DEFAULT_RENDERER_DEFINITIONS.find(item => item.extensions.map(normalizeFileExtension).includes(normalized));
104
+ if (!definition) {
105
+ return null;
106
+ }
107
+ const preset = resolvePresetHint(definition);
108
+ return {
109
+ extension: normalized,
110
+ rendererId: definition.id,
111
+ rendererLabel: definition.label,
112
+ rendererCategory: definition.category,
113
+ rendererPackage: rendererPackageById[definition.id],
114
+ presetPackage: preset.packageName,
115
+ vitePreset: preset.vitePreset,
116
+ presetLabel: preset.label,
117
+ };
118
+ };
19
119
  const createFileViewerStateDescriptor = ({ state, extension = '', title, message, description, theme = DEFAULT_FILE_VIEWER_STATE_THEME, recoverable, }) => ({
20
120
  state,
21
121
  extension: normalizeFileExtension(extension),
@@ -52,6 +152,21 @@ export const createFileViewerEmptyState = (extension = '', theme = DEFAULT_FILE_
52
152
  });
53
153
  export const createFileViewerUnsupportedState = (extension = '', theme = DEFAULT_FILE_VIEWER_STATE_THEME) => {
54
154
  const label = extensionLabel(extension);
155
+ const installHint = resolveFileViewerRendererInstallHint(extension);
156
+ if (installHint) {
157
+ const rendererTip = installHint.rendererPackage
158
+ ? `;如果需要极致裁剪,也可以只安装 ${installHint.rendererPackage}`
159
+ : '';
160
+ return createFileViewerStateDescriptor({
161
+ state: 'unsupported',
162
+ extension,
163
+ title: '需要装配预览能力',
164
+ message: `${label} 格式已在支持矩阵中,但当前项目尚未装配 ${installHint.rendererLabel} renderer。`,
165
+ description: `推荐安装 ${installHint.presetPackage} 并启用 @file-viewer/vite-plugin(preset: '${installHint.vitePreset}' 或 preset: 'auto')${rendererTip},也可以通过 options.renderers 手动传入对应 renderer。`,
166
+ theme,
167
+ recoverable: true,
168
+ });
169
+ }
55
170
  return createFileViewerStateDescriptor({
56
171
  state: 'unsupported',
57
172
  extension,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@file-viewer/core",
3
- "version": "2.1.1",
3
+ "version": "2.1.2",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "description": "Framework-neutral modular TypeScript core for Flyfish File Viewer renderer orchestration, lifecycle APIs, search, zoom, print, and export",