@file-viewer/vite-plugin 3.2.0 → 3.2.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.
Files changed (4) hide show
  1. package/README.en.md +190 -3
  2. package/README.md +190 -3
  3. package/dist/index.js +6 -1
  4. package/package.json +1 -1
package/README.en.md CHANGED
@@ -1,7 +1,194 @@
1
1
  # @file-viewer/vite-plugin
2
2
 
3
- Runtime package version 3.2.0.
3
+ <!-- FILE_VIEWER_PACKAGE_HEADER -->
4
+ <p>
5
+ <a href="https://www.npmjs.com/package/@file-viewer/vite-plugin"><img src="https://img.shields.io/npm/v/@file-viewer%2Fvite-plugin?logo=npm" alt="npm version"></a>
6
+ <a href="https://www.npmjs.com/package/@file-viewer/vite-plugin"><img src="https://img.shields.io/npm/dm/@file-viewer%2Fvite-plugin?logo=npm" alt="npm downloads"></a>
7
+ <a href="https://github.com/flyfish-dev/file-viewer/stargazers"><img src="https://img.shields.io/github/stars/flyfish-dev/file-viewer?style=flat&logo=github" alt="GitHub stars"></a>
8
+ <a href="https://github.com/flyfish-dev/file-viewer/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-blue" alt="License: Apache-2.0"></a>
9
+ </p>
4
10
 
5
- Usage and API documentation: https://doc.file-viewer.app/guide/on-demand-renderers
11
+ <p>
12
+ <a href="https://github.com/flyfish-dev/file-viewer">GitHub</a> · <a href="https://doc.file-viewer.app/">Docs</a> · <a href="https://demo.file-viewer.app/">Live demo</a> · <a href="https://doc.file-viewer.app/guide/formats">Format matrix</a> · <a href="https://github.com/flyfish-dev/file-viewer/issues">Issues</a> · <a href="https://github.com/flyfish-dev/file-viewer/blob/main/packages/presets/vite-plugin/README.md">简体中文</a>
13
+ </p>
6
14
 
7
- The package's own license is Apache-2.0. Included third-party notices apply to their respective components.
15
+ <p>
16
+ <a href="https://demo.file-viewer.app/"><img src="https://raw.githubusercontent.com/flyfish-dev/file-viewer/main/docs/public/_media/file-viewer-demo-v3-en.webp" width="760" alt="File Viewer live demo: Word, Excel, PowerPoint, 3D model, CAD drawing and binary inspector"></a>
17
+ </p>
18
+
19
+ > ⭐ If File Viewer helps you, please [star the repo on GitHub](https://github.com/flyfish-dev/file-viewer).
20
+
21
+ Vite plugin for Flyfish File Viewer on-demand renderer assembly. It can auto-discover installed `@file-viewer/preset-*` and `@file-viewer/*-full` packages, so Vue, React, Svelte, jQuery, and Vanilla JS components receive matching preview capability without application code passing `renderers` manually. It can also generate `virtual:file-viewer-renderers` from declared formats, import only matching renderer packages, and provide renderer-oriented chunk planning plus offline worker/WASM/font asset copying.
22
+
23
+ ## Fastest Start
24
+
25
+ For complete format support, the fastest path is one full package and one Vite plugin registration. Full packages already include `preset-all`; do not install another preset. `copyAssets:true` matches the installed full package and publishes its Worker, WASM, font, and vendor files under `file-viewer/` at the deployment base (`/file-viewer/` for a root deployment) in both dev and build:
26
+
27
+ ```bash
28
+ pnpm add @file-viewer/vue3-full
29
+ pnpm add -D @file-viewer/vite-plugin
30
+ ```
31
+
32
+ ```ts
33
+ import { defineConfig } from 'vite'
34
+ import { fileViewerRenderers } from '@file-viewer/vite-plugin'
35
+
36
+ export default defineConfig({
37
+ plugins: [
38
+ fileViewerRenderers({
39
+ copyAssets: true
40
+ })
41
+ ]
42
+ })
43
+ ```
44
+
45
+ Installing a full package without publishing these assets leaves PDF Worker, CAD/Typst/Archive WASM, and other formats without runtime files. That is partial support, not a complete setup.
46
+
47
+ For a smaller install, use a standard component with one preset and keep the same Vite config. The plugin auto-discovers installed presets, so application code does not hand-write renderer imports and the plugin does not need `preset:'office'`:
48
+
49
+ ```bash
50
+ pnpm add @file-viewer/vue3 @file-viewer/preset-office
51
+ pnpm add -D @file-viewer/vite-plugin
52
+ ```
53
+
54
+ Components keep `autoRenderers:true` by default, so `@file-viewer/vue3`, `@file-viewer/react`, `@file-viewer/web`, `@file-viewer/svelte`, `@file-viewer/jquery`, `@file-viewer/vue2.7`, and `@file-viewer/vue2.6` automatically consume the injected preset / renderer registry.
55
+
56
+ Available presets:
57
+
58
+ - `@file-viewer/preset-lite`: text, Markdown, code, image, audio, and video.
59
+ - `@file-viewer/preset-office`: PDF, Word, Excel, PowerPoint, OFD, RTF, and OpenDocument.
60
+ - `@file-viewer/preset-engineering`: CAD, 3D, drawing, XMind, Geo, Typst, Archive, Data, and EDA.
61
+ - `@file-viewer/preset-all`: the complete official demo format matrix.
62
+
63
+ Install individual renderer packages only for strict cuts, such as `@file-viewer/renderer-pdf`, `@file-viewer/renderer-word`, `@file-viewer/renderer-ofd`, `@file-viewer/renderer-presentation`, `@file-viewer/renderer-cad`, `@file-viewer/renderer-drawing`, `@file-viewer/renderer-3d`, `@file-viewer/renderer-data`, `@file-viewer/renderer-eda`, `@file-viewer/renderer-typst`, `@file-viewer/renderer-archive`, or `@file-viewer/renderer-text`, then use `formats` to generate exact imports.
64
+
65
+ ## vite.config.ts
66
+
67
+ Prefer full/preset auto assembly for normal products. With only `copyAssets:true`, the plugin auto-discovers installed `@file-viewer/*-full` or `@file-viewer/preset-*` packages:
68
+
69
+ ```ts
70
+ fileViewerRenderers({
71
+ copyAssets: true
72
+ })
73
+ ```
74
+
75
+ Use customization options only when you need source scanning, single-format cuts, or manual registry control:
76
+
77
+ ```ts
78
+ import { defineConfig } from 'vite'
79
+ import { fileViewerRenderers } from '@file-viewer/vite-plugin'
80
+
81
+ export default defineConfig({
82
+ plugins: [
83
+ fileViewerRenderers({
84
+ formats: ['pdf', 'dwg', 'typst', 'zip', 'xmind'],
85
+ scan: true,
86
+ copyAssets: true,
87
+ chunkStrategy: 'renderer'
88
+ })
89
+ ]
90
+ })
91
+ ```
92
+
93
+ `inject` is enabled by default. The plugin injects `virtual:file-viewer-renderers` into Vite HTML entrypoints, preset imports register themselves in core, and framework components consume them through `autoRenderers`.
94
+
95
+ ```ts
96
+ const options = {
97
+ // Defaults to true; set false when a product needs total manual control.
98
+ autoRenderers: true
99
+ }
100
+ ```
101
+
102
+ ### Customization Options
103
+
104
+ | Option | Description |
105
+ | --- | --- |
106
+ | `copyAssets` | `true` or `{ publicDir, outDir, mode, baseDir }`; copies matching Worker, WASM, font, and vendor assets. Installed full packages default to `<deployment-base>/file-viewer/`, which is required for complete full support; standard packages/presets keep the existing root behavior |
107
+ | `preset` | `'auto' | 'lite' | 'office' | 'engineering' | 'all'`; with no explicit formats, installed presets are discovered automatically |
108
+ | `autoPresets` | `true` or a preset list; useful with `scan:true` when installed presets should stay active |
109
+ | `formats` | File extensions or format tokens, for example `['pdf', 'docx', 'dwg']` |
110
+ | `renderers` | Renderer ids, for example `['pdf', 'word', 'cad']` |
111
+ | `scan` | `true` or `{ roots, extensions, maxFileSize }`; scans source hints and merges formats |
112
+ | `inject` | Defaults to `true`; set `false` to import `virtual:file-viewer-renderers` manually |
113
+ | `chunkStrategy` | `'renderer' | 'none'`; controls renderer-level chunk grouping |
114
+ | `stabilizeInteropChunks` | Defaults to `true`; keeps Pako / shared CommonJS helpers and CodeMirror / Lezer / Sandpack in stable groups for default and host-defined chunk splitting |
115
+ | `missingRenderer` | `'error' | 'warn' | 'ignore'`; controls notices for planned renderer mappings |
116
+
117
+ When host apps split `node_modules` by package name, circular dependencies between `@codemirror/*`, `@lezer/*`, and Sandpack can show up in production as `codemirror-view.* Cannot access ... before initialization`. The plugin stabilizes default chunk splitting and wraps existing `manualChunks` functions. Pako and shared CommonJS helpers use `vendor-commonjs` to prevent compressed-format initialization cycles; CodeMirror / Lezer / Sandpack use `vendor-codemirror`. Other custom groups remain intact, and Vite 8 receives equivalent Rolldown groups. Set `stabilizeInteropChunks:false` only when the host build needs total control.
118
+
119
+ `copyAssets.baseDir` overrides automatic placement. It must be relative and cannot contain `..`; an empty string explicitly selects the root. The plugin now aligns the shared runtime asset base for standard packages, presets, and full packages; full packages also keep `setDefaultFullAssetBaseUrl()` synchronized. Only integrations that set `inject:false` and do not import the virtual module must call `setDefaultFileViewerAssetBaseUrl()` themselves (plus `setDefaultFullAssetBaseUrl()` for a full package). With Vite `base:'/app/'`, full-package dev URLs start with `/app/file-viewer/...`, while production files remain under `outDir/file-viewer/`.
120
+
121
+ For strict registry control, disable injection and pass the virtual module explicitly:
122
+
123
+ ```ts
124
+ fileViewerRenderers({
125
+ formats: ['pdf'],
126
+ inject: false,
127
+ copyAssets: true
128
+ })
129
+ ```
130
+
131
+ ```ts
132
+ import { configuredFileViewerRenderers } from 'virtual:file-viewer-renderers'
133
+
134
+ const options = {
135
+ rendererMode: 'replace',
136
+ renderers: configuredFileViewerRenderers
137
+ }
138
+ ```
139
+
140
+ You can also use `preset: 'auto'` to discover installed preset packages. When `preset-all` is installed, it wins to avoid importing narrower presets twice. Note: when `scan:true` is enabled, use `preset:'auto'` or `autoPresets:true` explicitly; otherwise the plugin treats source hints as the explicit renderer selection and skips zero-config preset discovery.
141
+
142
+ ```ts
143
+ fileViewerRenderers({
144
+ preset: 'auto',
145
+ scan: true,
146
+ formats: ['pdf'],
147
+ copyAssets: true,
148
+ chunkStrategy: 'renderer'
149
+ })
150
+ ```
151
+
152
+ `scan: true` inspects common source folders for lightweight hints and merges them with `formats`:
153
+
154
+ ```ts
155
+ export const fileViewerFormats = ['pdf', 'docx', 'xlsx']
156
+ ```
157
+
158
+ ```html
159
+ <input accept=".pdf,.docx" data-file-viewer-formats="dwg,xmind" />
160
+ ```
161
+
162
+ This is useful when upload accept lists, sample matrices, or attachment allow-lists already live in source code: dev and production builds can generate the renderer assembly module without a second hand-written import list.
163
+
164
+ ## Missing Renderer Guidance
165
+
166
+ When a file extension is in the supported matrix but the current project has not assembled its renderer, core now shows an install-oriented “renderer assembly required” state with the recommended preset / renderer package. For example, `.pdf` points to `@file-viewer/preset-office` or `@file-viewer/renderer-pdf`. Only truly unknown extensions show an unsupported-format state.
167
+
168
+ ## Nested Vite Projects
169
+
170
+ From 3.0.3, a nested metadata-only project can use a resolvable Full dependency
171
+ declared in an ancestor `package.json`. A nearer light component or preset keeps
172
+ its own root asset layout. Explicit `copyAssets.baseDir` still takes precedence;
173
+ `publicDir` and `build.outDir` stay relative to the Vite root, not the dependency owner.
174
+
175
+ ## Current Boundary
176
+
177
+ The plugin currently generates imports for extracted renderer packages: Word, Spreadsheet, PDF, OFD, Presentation, CAD, Draw.io/Excalidraw/Mermaid/PlantUML, 3D, Data, EDA, Typst, archives, email, EPUB, code/Markdown/Patch/Git Bundle, image, media, XMind, and Geo. Declare them explicitly with `formats`, or let `scan: true` discover source hints automatically; core-supported extensions such as `.zipx`, `.cbz`, `.tiff`, `.mjs`, `.gv`, `.patch`, `.bundle`, `.mermaid`, `.puml`, and `.mpeg` also resolve to their renderer packages. With `copyAssets:true`, the plugin detects installed capability packages. Full packages copy matching assets into dev `publicDir/file-viewer/` and production `outDir/file-viewer/`; standard packages/presets keep the existing root placement, including the Typst compiler / renderer WASM files and default fonts. `preset: 'auto' | 'lite' | 'office' | 'engineering' | 'all'` imports matching `@file-viewer/preset-*` packages; when `formats` are also present, the plugin adds extra renderers outside the preset.
178
+
179
+ ## Documentation
180
+
181
+ - On-demand renderer architecture: <https://doc.file-viewer.app/guide/on-demand-renderers>
182
+ - Supported formats: <https://doc.file-viewer.app/guide/formats>
183
+
184
+ ## Formats and related packages
185
+
186
+ File Viewer previews 275+ file extensions in the browser, covering Office, PDF/OFD, CAD, 3D, archives, email, images, media and code, without server-side conversion. See the [format matrix](https://doc.file-viewer.app/guide/formats) for the full list.
187
+
188
+ - Components: `@file-viewer/web`, `@file-viewer/vue3`, `@file-viewer/vue2.7`, `@file-viewer/vue2.6`, `@file-viewer/react`, `@file-viewer/react-legacy`, `@file-viewer/svelte`, `@file-viewer/jquery`, plus their `-full` packages
189
+ - Presets: `@file-viewer/preset-lite`, `@file-viewer/preset-office`, `@file-viewer/preset-engineering`, `@file-viewer/preset-all`
190
+ - Build: `@file-viewer/vite-plugin`, `file-viewer-copy-assets`
191
+
192
+ ## License
193
+
194
+ This package is Apache-2.0. See [LICENSE](https://github.com/flyfish-dev/file-viewer/blob/main/LICENSE).
package/README.md CHANGED
@@ -1,7 +1,194 @@
1
1
  # @file-viewer/vite-plugin
2
2
 
3
- Runtime package version 3.2.0.
3
+ <!-- FILE_VIEWER_PACKAGE_HEADER -->
4
+ <p>
5
+ <a href="https://www.npmjs.com/package/@file-viewer/vite-plugin"><img src="https://img.shields.io/npm/v/@file-viewer%2Fvite-plugin?logo=npm" alt="npm version"></a>
6
+ <a href="https://www.npmjs.com/package/@file-viewer/vite-plugin"><img src="https://img.shields.io/npm/dm/@file-viewer%2Fvite-plugin?logo=npm" alt="npm downloads"></a>
7
+ <a href="https://github.com/flyfish-dev/file-viewer/stargazers"><img src="https://img.shields.io/github/stars/flyfish-dev/file-viewer?style=flat&logo=github" alt="GitHub stars"></a>
8
+ <a href="https://github.com/flyfish-dev/file-viewer/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-blue" alt="License: Apache-2.0"></a>
9
+ </p>
4
10
 
5
- Usage and API documentation: https://doc.file-viewer.app/guide/on-demand-renderers
11
+ <p>
12
+ <a href="https://github.com/flyfish-dev/file-viewer">GitHub</a> · <a href="https://doc.file-viewer.app/zh/">文档</a> · <a href="https://demo.file-viewer.app/">在线 Demo</a> · <a href="https://doc.file-viewer.app/guide/formats">格式矩阵</a> · <a href="https://github.com/flyfish-dev/file-viewer/issues">问题反馈</a> · <a href="https://github.com/flyfish-dev/file-viewer/blob/main/packages/presets/vite-plugin/README.en.md">English</a>
13
+ </p>
6
14
 
7
- The package's own license is Apache-2.0. Included third-party notices apply to their respective components.
15
+ <p>
16
+ <a href="https://demo.file-viewer.app/"><img src="https://raw.githubusercontent.com/flyfish-dev/file-viewer/main/docs/public/_media/file-viewer-demo-v3-zh.webp" width="760" alt="File Viewer 在线演示：Word、Excel、PPT、3D 模型、CAD 图纸与二进制检查器"></a>
17
+ </p>
18
+
19
+ > ⭐ 如果 File Viewer 对你有帮助，欢迎到 [GitHub](https://github.com/flyfish-dev/file-viewer) 点个 Star。
20
+
21
+ Flyfish File Viewer 的 Vite 按需 renderer 自动装配插件。它可以自动发现已安装的 `@file-viewer/preset-*` 和 `@file-viewer/*-full` 包，让 Vue、React、Svelte、jQuery 和 Vanilla JS 组件无需手动传 `renderers` 就获得对应预览能力；也可以根据业务声明的文件格式生成 `virtual:file-viewer-renderers`，只 import 命中的 renderer 包，并提供 chunk 分组和离线 worker/WASM/字体资源复制能力。
22
+
23
+ ## 最快开始
24
+
25
+ 需要完整格式支持时，最快路径是“full 包 + 注册一次 Vite 插件”。full 已内置 `preset-all`，不要再安装 preset；`copyAssets:true` 会在开发和构建时自动匹配 full 包，并把 Worker、WASM、字体和 vendor 文件发布到部署基址下的 `file-viewer/`（根部署即 `/file-viewer/`）：
26
+
27
+ ```bash
28
+ pnpm add @file-viewer/vue3-full
29
+ pnpm add -D @file-viewer/vite-plugin
30
+ ```
31
+
32
+ ```ts
33
+ import { defineConfig } from 'vite'
34
+ import { fileViewerRenderers } from '@file-viewer/vite-plugin'
35
+
36
+ export default defineConfig({
37
+ plugins: [
38
+ fileViewerRenderers({
39
+ copyAssets: true
40
+ })
41
+ ]
42
+ })
43
+ ```
44
+
45
+ 只安装 full 包而不启用资源复制，PDF Worker、CAD/Typst/Archive WASM 等格式会缺少运行文件，只能获得部分格式支持。
46
+
47
+ 需要更小体积时，改用“标准组件包 + 一个 preset”，Vite 配置保持不变。插件会自动发现已安装的 preset，无需手写 renderer import，也无需显式写 `preset:'office'`：
48
+
49
+ ```bash
50
+ pnpm add @file-viewer/vue3 @file-viewer/preset-office
51
+ pnpm add -D @file-viewer/vite-plugin
52
+ ```
53
+
54
+ 组件默认 `autoRenderers:true`，会读取 Vite 插件注入的 preset / renderer registry。常规业务代码只要使用 `@file-viewer/vue3`、`@file-viewer/react`、`@file-viewer/web`、`@file-viewer/svelte`、`@file-viewer/jquery`、`@file-viewer/vue2.7` 或 `@file-viewer/vue2.6` 即可获得对应能力。
55
+
56
+ 可选 preset：
57
+
58
+ - `@file-viewer/preset-lite`: 文本、Markdown、代码、图片、音频、视频。
59
+ - `@file-viewer/preset-office`: PDF、Word、Excel、PowerPoint、OFD、RTF、OpenDocument。
60
+ - `@file-viewer/preset-engineering`: CAD、3D、绘图、XMind、Geo、Typst、Archive、Data、EDA。
61
+ - `@file-viewer/preset-all`: 官方 demo 完整格式矩阵。
62
+
63
+ 如果只需要极少数格式，也可以安装对应 renderer 包，例如 `@file-viewer/renderer-pdf`、`@file-viewer/renderer-word`、`@file-viewer/renderer-ofd`、`@file-viewer/renderer-presentation`、`@file-viewer/renderer-cad`、`@file-viewer/renderer-drawing`、`@file-viewer/renderer-3d`、`@file-viewer/renderer-data`、`@file-viewer/renderer-eda`、`@file-viewer/renderer-typst`、`@file-viewer/renderer-archive`、`@file-viewer/renderer-text`，再通过 `formats` 做精确裁剪。
64
+
65
+ ## vite.config.ts
66
+
67
+ 推荐默认使用 full/preset 自动装配。只传 `copyAssets:true` 时，插件会自动发现已安装的 `@file-viewer/*-full` 或 `@file-viewer/preset-*`，无需写 `preset:'all'`：
68
+
69
+ ```ts
70
+ fileViewerRenderers({
71
+ copyAssets: true
72
+ })
73
+ ```
74
+
75
+ 只有在需要源码扫描、单格式裁剪、或手动 registry 管理时，再使用自定义能力：
76
+
77
+ ```ts
78
+ import { defineConfig } from 'vite'
79
+ import { fileViewerRenderers } from '@file-viewer/vite-plugin'
80
+
81
+ export default defineConfig({
82
+ plugins: [
83
+ fileViewerRenderers({
84
+ formats: ['pdf', 'dwg', 'typst', 'zip', 'xmind'],
85
+ scan: true,
86
+ copyAssets: true,
87
+ chunkStrategy: 'renderer'
88
+ })
89
+ ]
90
+ })
91
+ ```
92
+
93
+ `inject` 默认开启，插件会把 `virtual:file-viewer-renderers` 注入 Vite HTML 入口，preset 导入后会自动注册到 core。常规业务只需要安装组件包和对应 preset，组件会通过 `autoRenderers` 默认读取这些能力。
94
+
95
+ ```ts
96
+ const options = {
97
+ // 默认 true；需要完全手动控制时设为 false。
98
+ autoRenderers: true
99
+ }
100
+ ```
101
+
102
+ ### 可定制能力
103
+
104
+ | 选项 | 说明 |
105
+ | --- | --- |
106
+ | `copyAssets` | `true` 或 `{ publicDir, outDir, mode, baseDir }`；复制匹配的 Worker、WASM、字体和 vendor 资源。检测到 full 时默认发布到 `<部署基址>/file-viewer/`，这是 full 完整格式支持的必需项；标准包/preset 保持原有根目录行为 |
107
+ | `preset` | `'auto' | 'lite' | 'office' | 'engineering' | 'all'`；默认无显式格式时自动发现已安装 preset |
108
+ | `autoPresets` | `true` 或 preset 列表；常用于 `scan:true` 时继续自动激活已安装 preset |
109
+ | `formats` | 文件扩展名或格式 token，例如 `['pdf', 'docx', 'dwg']` |
110
+ | `renderers` | renderer id，例如 `['pdf', 'word', 'cad']` |
111
+ | `scan` | `true` 或 `{ roots, extensions, maxFileSize }`，扫描源码 hint 并合并格式 |
112
+ | `inject` | 默认 `true`；设为 `false` 后手动导入 `virtual:file-viewer-renderers` |
113
+ | `chunkStrategy` | `'renderer' | 'none'`，控制是否注入 renderer 级 chunk 分组 |
114
+ | `stabilizeInteropChunks` | 默认 `true`；为默认分组和宿主 `manualChunks` 稳定 Pako / CommonJS 辅助模块及 CodeMirror / Lezer / Sandpack 的分组 |
115
+ | `missingRenderer` | `'error' | 'warn' | 'ignore'`，控制尚未提取的 renderer 映射提示方式 |
116
+
117
+ 如果宿主项目按包名拆分 `node_modules`，`@codemirror/*`、`@lezer/*` 和 Sandpack 之间的循环依赖可能在生产构建中表现为 `codemirror-view.* Cannot access ... before initialization`。插件同时稳定默认分组和已有的 `manualChunks` 函数：Pako 与共享 CommonJS 辅助模块归入 `vendor-commonjs`，避免压缩格式的初始化循环；CodeMirror / Lezer / Sandpack 归入 `vendor-codemirror`。Vite 8 使用对应的 Rolldown 分组，其它自定义分组保持不变；确实需要完全接管时可设置 `stabilizeInteropChunks:false`。
118
+
119
+ `copyAssets.baseDir` 可以覆盖自动目录：必须是相对路径，不能包含 `..`；传空字符串表示显式复制到根目录。插件会为标准包、preset 和 full 包同步统一运行时资源根；full 包仍同时同步 `setDefaultFullAssetBaseUrl()`。只有设置 `inject:false` 且不手动导入虚拟模块时，业务才需要调用 `setDefaultFileViewerAssetBaseUrl()`（full 包同时调用 `setDefaultFullAssetBaseUrl()`）。Vite 配置了 `base:'/app/'` 时，full 包开发 URL 为 `/app/file-viewer/...`，构建文件仍位于 `outDir/file-viewer/`。
120
+
121
+ 如果你需要严格控制 registry，可以关闭注入并手动传入：
122
+
123
+ ```ts
124
+ fileViewerRenderers({
125
+ formats: ['pdf'],
126
+ inject: false,
127
+ copyAssets: true
128
+ })
129
+ ```
130
+
131
+ ```ts
132
+ import { configuredFileViewerRenderers } from 'virtual:file-viewer-renderers'
133
+
134
+ const options = {
135
+ rendererMode: 'replace',
136
+ renderers: configuredFileViewerRenderers
137
+ }
138
+ ```
139
+
140
+ 也可以使用 `preset: 'auto'` 发现项目中已安装的 preset 包；当 `preset-all` 存在时会优先使用它，避免重复导入其它 preset。注意：如果同时开启 `scan:true`，请显式使用 `preset:'auto'` 或 `autoPresets:true`，否则插件会以源码 hint 为准，不再做“无配置 preset 自动发现”。
141
+
142
+ ```ts
143
+ fileViewerRenderers({
144
+ preset: 'auto',
145
+ scan: true,
146
+ formats: ['pdf'],
147
+ copyAssets: true,
148
+ chunkStrategy: 'renderer'
149
+ })
150
+ ```
151
+
152
+ `scan: true` 会扫描常见源码目录里的轻量 hint，并把它们合并到 `formats`：
153
+
154
+ ```ts
155
+ export const fileViewerFormats = ['pdf', 'docx', 'xlsx']
156
+ ```
157
+
158
+ ```html
159
+ <input accept=".pdf,.docx" data-file-viewer-formats="dwg,xmind" />
160
+ ```
161
+
162
+ 这适合业务把上传入口、示例矩阵或附件白名单维护在源码中时使用：开发和构建阶段插件会自动生成 renderer 装配模块，少写一份手工 import 清单。
163
+
164
+ ## 缺失 renderer 提示
165
+
166
+ 如果用户打开的是支持矩阵内的格式，但项目没有安装或装配对应 renderer，core 会显示“需要装配预览能力”，并提示推荐安装的 preset / renderer 包，例如 `.pdf` 会引导安装 `@file-viewer/preset-office` 或 `@file-viewer/renderer-pdf`。只有真正不在支持矩阵中的扩展名才显示“不支持在线预览”。
167
+
168
+ ## 嵌套 Vite 项目
169
+
170
+ 从 3.0.3 起，子目录只有项目元数据或 Vite 插件声明时，会沿祖先 `package.json`
171
+ 查找实际可解析的 Full 依赖。子项目明确声明轻量组件或 preset 时保留其根目录资产布局，
172
+ 不会继承父项目的 Full 布局。`copyAssets.baseDir` 仍具有最高优先级；`publicDir`
173
+ 和 `build.outDir` 均相对于 Vite root，不相对于依赖所在目录。
174
+
175
+ ## 当前边界
176
+
177
+ 当前插件会为已经拆出的 renderer 包生成导入：Word、Spreadsheet、PDF、OFD、Presentation、CAD、Draw.io/Excalidraw/Mermaid/PlantUML、3D、Data、EDA、Typst、压缩包、邮件、EPUB、代码/Markdown/Patch/Git Bundle、图片、媒体、XMind 和 Geo。可以通过 `formats` 显式声明，也可以通过 `scan: true` 从源码 hint 自动发现；`.zipx`、`.cbz`、`.tiff`、`.mjs`、`.gv`、`.patch`、`.bundle`、`.mermaid`、`.puml`、`.mpeg` 等 core 支持的扩展也会映射到对应 renderer。开启 `copyAssets:true` 时会识别已安装能力；full 包把匹配资源复制到开发 `publicDir/file-viewer/` 与构建 `outDir/file-viewer/`，标准包/preset 维持根目录行为，包括 Typst compiler / renderer WASM 与默认字体目录。`preset: 'auto' | 'lite' | 'office' | 'engineering' | 'all'` 会导入对应 `@file-viewer/preset-*` 包；如果同时声明 `formats`，插件会在 preset 之外补充额外 renderer。
178
+
179
+ ## 文档
180
+
181
+ - 按需渲染架构: <https://doc.file-viewer.app/guide/on-demand-renderers>
182
+ - 支持格式: <https://doc.file-viewer.app/guide/formats>
183
+
184
+ ## 格式与相关包
185
+
186
+ File Viewer 在浏览器内预览 275+ 种扩展名，覆盖 Office、PDF/OFD、CAD、3D、压缩包、邮件、图片、音视频和代码，无需服务端转码；完整清单见 [格式矩阵](https://doc.file-viewer.app/guide/formats)。
187
+
188
+ - 组件：`@file-viewer/web`、`@file-viewer/vue3`、`@file-viewer/vue2.7`、`@file-viewer/vue2.6`、`@file-viewer/react`、`@file-viewer/react-legacy`、`@file-viewer/svelte`、`@file-viewer/jquery`，以及对应的 `-full` 包
189
+ - 能力组合：`@file-viewer/preset-lite`、`@file-viewer/preset-office`、`@file-viewer/preset-engineering`、`@file-viewer/preset-all`
190
+ - 构建：`@file-viewer/vite-plugin`、`file-viewer-copy-assets`
191
+
192
+ ## 许可证
193
+
194
+ 本包采用 Apache-2.0。详见 [LICENSE](https://github.com/flyfish-dev/file-viewer/blob/main/LICENSE)。
package/dist/index.js CHANGED
@@ -1730,6 +1730,10 @@ async function copyKnownRendererAssets(targetRoot, rendererIds) {
1730
1730
  const postscriptLicenses = [
1731
1731
  ['postscript-design-license-stet-apache', 'Stet-Apache-2.0.txt', 'LICENSE.stet-Apache-2.0.txt'],
1732
1732
  ['postscript-design-license-stet-mit', 'Stet-MIT.txt', 'LICENSE.stet-MIT.txt'],
1733
+ ['postscript-design-license-urw-ofl', 'Stet-URW-Fonts-OFL-1.1.txt', 'LICENSE.Stet-URW-Fonts-OFL-1.1.txt'],
1734
+ ['postscript-design-license-cmyk-provenance', 'Stet-CMYK-Profile.txt', 'LICENSE.Stet-CMYK-Profile.txt'],
1735
+ ['postscript-design-license-cc0', 'CC0-1.0.txt', 'LICENSE.CC0-1.0.txt'],
1736
+ ['postscript-design-license-native-dependencies', 'Stet_NATIVE_THIRD_PARTY_LICENSES.json', 'Stet_NATIVE_THIRD_PARTY_LICENSES.json'],
1733
1737
  ['postscript-design-license-carlito-ofl', 'Carlito-OFL-1.1.txt', 'LICENSE.Carlito-OFL-1.1.txt'],
1734
1738
  ['postscript-design-license-tinos-ofl', 'Tinos-OFL-1.1.txt', 'LICENSE.Tinos-OFL-1.1.txt'],
1735
1739
  ['postscript-design-license-cousine-ofl', 'Cousine-OFL-1.1.txt', 'LICENSE.Cousine-OFL-1.1.txt'],
@@ -2337,7 +2341,8 @@ const defaultRequiredAssetRendererIds = [
2337
2341
  'office-presentation',
2338
2342
  'archive',
2339
2343
  'cad',
2340
- 'typst'
2344
+ 'typst',
2345
+ 'postscript-design'
2341
2346
  ];
2342
2347
  function isRequiredAssetResult(result) {
2343
2348
  return result.required ?? defaultRequiredAssetRendererIds.includes(result.rendererId);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@file-viewer/vite-plugin",
3
- "version": "3.2.0",
3
+ "version": "3.2.2",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "description": "Vite plugin for File Viewer on-demand renderer assembly, chunk planning, and offline asset deployment.",