@file-viewer/vite-plugin 2.0.11

package/LICENSE

@@ -0,0 +1,6 @@
+Apache-2.0
+
+Copyright 2026 Flyfish Viewer
+
+Licensed under the Apache License, Version 2.0. See the root repository LICENSE
+file or https://www.apache.org/licenses/LICENSE-2.0 for the full license text.

package/README.en.md

@@ -0,0 +1,84 @@
+# @file-viewer/vite-plugin
+
+Vite plugin for Flyfish File Viewer on-demand renderer assembly. It generates `virtual:file-viewer-renderers` from the formats your application declares, imports only the matching renderer packages, and provides renderer-oriented chunk planning plus offline worker/WASM asset copying. The extension mapping is verified against the full `@file-viewer/core` format matrix in repository gates, so new formats cannot silently drift away from automatic assembly.
+
+## Install
+
+```bash
+pnpm add @file-viewer/vue3 @file-viewer/vite-plugin @file-viewer/renderer-pdf
+```
+
+Install additional renderer packages when you need more formats, such as `@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`.
+
+When you want one package for a common product shape, install a preset:
+
+```bash
+pnpm add @file-viewer/vue3 @file-viewer/vite-plugin @file-viewer/preset-office
+```
+
+Available presets:
+
+- `@file-viewer/preset-lite`: text, Markdown, code, image, audio, and video.
+- `@file-viewer/preset-office`: PDF, Word, Excel, PowerPoint, OFD, RTF, and OpenDocument.
+- `@file-viewer/preset-engineering`: CAD, 3D, drawing, XMind, Geo, Typst, Archive, Data, and EDA.
+- `@file-viewer/preset-all`: the complete official demo format matrix.
+
+## vite.config.ts
+
+```ts
+import { defineConfig } from 'vite'
+import { fileViewerRenderers } from '@file-viewer/vite-plugin'
+
+export default defineConfig({
+  plugins: [
+    fileViewerRenderers({
+      formats: ['pdf', 'dwg', 'typst', 'zip', 'xmind'],
+      scan: true,
+      copyAssets: true,
+      chunkStrategy: 'renderer'
+    })
+  ]
+})
+```
+
+Or use one preset package:
+
+```ts
+fileViewerRenderers({
+  preset: 'office',
+  copyAssets: true
+})
+```
+
+`scan: true` inspects common source folders for lightweight hints and merges them with `formats`:
+
+```ts
+export const fileViewerFormats = ['pdf', 'docx', 'xlsx']
+```
+
+```html
+<input accept=".pdf,.docx" data-file-viewer-formats="dwg,xmind" />
+```
+
+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.
+
+## Application Code
+
+```ts
+import FileViewer from '@file-viewer/vue3'
+import { configuredFileViewerRenderers } from 'virtual:file-viewer-renderers'
+
+const options = {
+  rendererMode: 'replace',
+  renderers: configuredFileViewerRenderers
+}
+```
+
+## Current Boundary
+
+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. `preset: 'lite' | 'office' | 'engineering' | 'all'` imports the matching `@file-viewer/preset-*` package; when `formats` are also present, the plugin adds extra renderers outside the preset.
+
+## Documentation
+
+- On-demand renderer architecture: <https://doc.file-viewer.app/guide/on-demand-renderers>
+- Supported formats: <https://doc.file-viewer.app/guide/formats>

package/README.md

@@ -0,0 +1,84 @@
+# @file-viewer/vite-plugin
+
+Flyfish File Viewer 的 Vite 按需 renderer 自动装配插件。它根据业务声明的文件格式生成 `virtual:file-viewer-renderers`，只 import 命中的 renderer 包，并提供 chunk 分组和离线 worker/WASM 资源复制能力。插件的扩展名映射会在仓库门禁中对照 `@file-viewer/core` 的完整格式矩阵验证，避免新增格式后自动装配能力漂移。
+
+## 安装
+
+```bash
+pnpm add @file-viewer/vue3 @file-viewer/vite-plugin @file-viewer/renderer-pdf
+```
+
+需要更多格式时安装对应 renderer 包，例如 `@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`。
+
+如果你希望用一个包完成常见场景装配，可以安装 preset：
+
+```bash
+pnpm add @file-viewer/vue3 @file-viewer/vite-plugin @file-viewer/preset-office
+```
+
+可选 preset：
+
+- `@file-viewer/preset-lite`: 文本、Markdown、代码、图片、音频、视频。
+- `@file-viewer/preset-office`: PDF、Word、Excel、PowerPoint、OFD、RTF、OpenDocument。
+- `@file-viewer/preset-engineering`: CAD、3D、绘图、XMind、Geo、Typst、Archive、Data、EDA。
+- `@file-viewer/preset-all`: 官方 demo 完整格式矩阵。
+
+## vite.config.ts
+
+```ts
+import { defineConfig } from 'vite'
+import { fileViewerRenderers } from '@file-viewer/vite-plugin'
+
+export default defineConfig({
+  plugins: [
+    fileViewerRenderers({
+      formats: ['pdf', 'dwg', 'typst', 'zip', 'xmind'],
+      scan: true,
+      copyAssets: true,
+      chunkStrategy: 'renderer'
+    })
+  ]
+})
+```
+
+或者使用 preset 一包装配：
+
+```ts
+fileViewerRenderers({
+  preset: 'office',
+  copyAssets: true
+})
+```
+
+`scan: true` 会扫描常见源码目录里的轻量 hint，并把它们合并到 `formats`：
+
+```ts
+export const fileViewerFormats = ['pdf', 'docx', 'xlsx']
+```
+
+```html
+<input accept=".pdf,.docx" data-file-viewer-formats="dwg,xmind" />
+```
+
+这适合业务把上传入口、示例矩阵或附件白名单维护在源码中时使用：开发和构建阶段插件会自动生成 renderer 装配模块，少写一份手工 import 清单。
+
+## 业务代码
+
+```ts
+import FileViewer from '@file-viewer/vue3'
+import { configuredFileViewerRenderers } from 'virtual:file-viewer-renderers'
+
+const options = {
+  rendererMode: 'replace',
+  renderers: configuredFileViewerRenderers
+}
+```
+
+## 当前边界
+
+当前插件会为已经拆出的 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。`preset: 'lite' | 'office' | 'engineering' | 'all'` 会导入对应 `@file-viewer/preset-*` 包；如果同时声明 `formats`，插件会在 preset 之外补充额外 renderer。
+
+## 文档
+
+- 按需渲染架构: <https://doc.file-viewer.app/guide/on-demand-renderers>
+- 支持格式: <https://doc.file-viewer.app/guide/formats>

package/client.d.ts

@@ -0,0 +1,21 @@
+declare module 'virtual:file-viewer-renderers' {
+  import type {
+    FileRenderHandler,
+    FileViewerRenderedInstance,
+    FileViewerRendererPluginInput,
+  } from '@file-viewer/core';
+
+  type BrowserRendererHandler = FileRenderHandler<FileViewerRenderedInstance, HTMLDivElement>;
+
+  export interface ConfiguredFileViewerRendererPlan {
+    preset: string | null;
+    formats: string[];
+    rendererIds: string[];
+    packages: string[];
+    generatedBy: '@file-viewer/vite-plugin';
+  }
+
+  export const configuredFileViewerRenderers: FileViewerRendererPluginInput<BrowserRendererHandler>;
+  export const fileViewerRendererPlan: ConfiguredFileViewerRendererPlan;
+  export default configuredFileViewerRenderers;
+}

package/dist/index.d.ts

@@ -0,0 +1,100 @@
+import type { Plugin } from 'vite';
+export type FileViewerVitePreset = 'all' | 'lite' | 'office' | 'engineering';
+export type FileViewerMissingRendererMode = 'error' | 'warn' | 'ignore';
+export type FileViewerChunkStrategy = 'renderer' | 'none';
+export interface FileViewerRendererScanOptions {
+    /**
+     * Disable a shared scan object without branching user config.
+     */
+    enabled?: boolean;
+    /**
+     * Source roots, relative to Vite root, that should be inspected for format hints.
+     * Defaults to common application source folders.
+     */
+    roots?: readonly string[];
+    /**
+     * Text-like source extensions to inspect. Values may include or omit the dot.
+     */
+    extensions?: readonly string[];
+    /**
+     * Large generated files are ignored by default to keep config/startup fast.
+     */
+    maxFileSize?: number;
+}
+export interface FileViewerCopyAssetsOptions {
+    /**
+     * Directory used by Vite dev. Defaults to config.publicDir.
+     */
+    publicDir?: string;
+    /**
+     * Directory used after production build. Defaults to build.outDir.
+     */
+    outDir?: string;
+    /**
+     * Copy during dev server startup, build closeBundle, or both.
+     */
+    mode?: 'dev' | 'build' | 'both';
+}
+export interface FileViewerRenderersPluginOptions {
+    /**
+     * File extensions or renderer ids. Examples: pdf, .dwg, typst, zip, xmind.
+     */
+    formats?: readonly string[];
+    /**
+     * Explicit renderer ids. Useful when several extensions share one renderer.
+     */
+    renderers?: readonly string[];
+    /**
+     * Presets import their dedicated @file-viewer/preset-* package. Add
+     * `formats` / `renderers` when you need to extend a preset with extra lines.
+     */
+    preset?: FileViewerVitePreset;
+    /**
+     * Virtual module id consumed by application code.
+     */
+    moduleId?: string;
+    /**
+     * Controls how planned-but-not-yet-extracted renderer lines are reported.
+     */
+    missingRenderer?: FileViewerMissingRendererMode;
+    /**
+     * Adds renderer-oriented manualChunks when the user did not define one.
+     */
+    chunkStrategy?: FileViewerChunkStrategy;
+    /**
+     * Copies known worker/WASM/vendor assets for selected renderer lines.
+     */
+    copyAssets?: boolean | FileViewerCopyAssetsOptions;
+    /**
+     * Opt-in source scan. The plugin reads lightweight hints such as
+     * `fileViewerFormats = ['pdf', 'docx']`, `data-file-viewer-formats="pdf,docx"`,
+     * and upload `accept=".pdf,.docx"` declarations, then merges them with
+     * `formats` / `renderers` before generating the virtual module.
+     */
+    scan?: boolean | FileViewerRendererScanOptions;
+}
+interface MissingRendererNotice {
+    format: string;
+    targetPackage?: string;
+    note: string;
+}
+export declare function extractFileViewerRendererHintTokens(source: string): string[];
+export declare function collectFileViewerRendererScanTokens(projectRoot: string, scan: FileViewerRenderersPluginOptions['scan']): string[];
+export declare function fileViewerRenderers(options?: FileViewerRenderersPluginOptions): Plugin;
+export declare function createFileViewerManualChunks(options?: FileViewerRenderersPluginOptions): (id: string) => string | undefined;
+export declare function resolveFileViewerRendererSelection(options?: FileViewerRenderersPluginOptions, projectRoot?: string): {
+    preset: FileViewerVitePreset | null;
+    presetPackage: string | null;
+    formats: string[];
+    packages: string[];
+    rendererIds: string[];
+    renderers: {
+        id: string;
+        packageName: string;
+        formats: string[];
+        rendererIds: string[];
+        chunkName: string;
+    }[];
+    missing: MissingRendererNotice[];
+};
+export default fileViewerRenderers;