@file-viewer/vite-plugin 3.2.3 → 3.3.0

package/dist/index.d.ts

@@ -4,103 +4,28 @@ export type FileViewerVitePresetMode = FileViewerVitePreset | 'auto';
 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;
-    /**
-     * Directory below publicDir/outDir where assets are published. When omitted,
-     * projects with an installed @file-viewer/*-full package use `file-viewer`;
-     * other projects keep the existing output-root layout. Use an empty string
-     * to explicitly publish at the output root. The injected runtime module
-     * keeps every renderer's default asset base aligned with this directory.
-     */
     baseDir?: 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. Use `auto`
-     * to discover installed preset packages, and add `formats` / `renderers`
-     * when you need to extend a preset with extra lines.
-     */
     preset?: FileViewerVitePresetMode;
-    /**
-     * Auto-discovers installed `@file-viewer/preset-*` packages and registers
-     * them globally for framework components. Defaults to true only when no
-     * explicit preset/formats/renderers are configured, or when `preset: 'auto'`.
-     */
     autoPresets?: boolean | readonly FileViewerVitePreset[];
-    /**
-     * Injects the virtual renderer module into Vite HTML entrypoints so
-     * framework components can consume auto-registered renderers without
-     * application code importing `virtual:file-viewer-renderers`.
-     */
     inject?: boolean;
-    /**
-     * 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;
-    /**
-     * Stabilizes default chunk groups and wraps existing manualChunks functions.
-     * This keeps CodeMirror/Lezer/Sandpack in one chunk when host
-     * apps split node_modules by package name, avoiding production TDZ errors.
-     * Pako and the shared CommonJS helpers also stay outside renderer/app chunks
-     * so compressed-format imports cannot form an initialization cycle.
-     */
     stabilizeInteropChunks?: boolean;
-    /**
-     * 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 {
@@ -111,11 +36,8 @@ interface MissingRendererNotice {
 export declare function extractFileViewerRendererHintTokens(source: string): string[];
 export declare function collectFileViewerRendererScanTokens(projectRoot: string, scan: FileViewerRenderersPluginOptions['scan']): string[];
 export interface FileViewerCopyAssetsTargetConfig {
-    /** Vite project root. Defaults to process.cwd(). */
     projectRoot?: string;
-    /** Resolved Vite publicDir. Defaults to `public`. */
     publicDir?: string;
-    /** Resolved Vite build.outDir. Defaults to `dist`. */
     outDir?: string;
 }
 export interface FileViewerCopyAssetsTarget {
@@ -126,10 +48,6 @@ export interface FileViewerCopyAssetsTarget {
     installedFullPackages: string[];
     installedAssetPackages: string[];
 }
-/**
- * Resolves the exact directory used by copyAssets without running a Vite build.
- * This is exported so integrations can validate their deployment contract.
- */
 export declare function resolveFileViewerCopyAssetsTarget(mode: 'dev' | 'build', value?: true | FileViewerCopyAssetsOptions, config?: FileViewerCopyAssetsTargetConfig): FileViewerCopyAssetsTarget;
 export declare function fileViewerRenderers(options?: FileViewerRenderersPluginOptions): Plugin;
 export declare function createFileViewerManualChunks(options?: FileViewerRenderersPluginOptions): (id: string) => string | undefined;

package/dist/index.js

@@ -578,10 +578,6 @@ const fileViewerFullPackages = [
     '@file-viewer/jquery-full',
     '@file-viewer/svelte-full'
 ];
-// Vite dep optimization rewrites import.meta.url into node_modules/.vite/deps
-// and can trigger full-preset dev-server re-optimization reloads. Keep File
-// Viewer packages out of dep optimization while still optimizing their
-// CommonJS/UMD helper dependencies below.
 const fileViewerOptimizationExcludedPackages = [
     '@file-viewer/core',
     '@file-viewer/ppt',
@@ -690,24 +686,15 @@ export function extractFileViewerRendererHintTokens(source) {
             }
         });
     };
-    // Explicit JavaScript/TypeScript hints:
-    //   const fileViewerFormats = ['pdf', 'docx']
-    //   fileViewerRenderers: ['pdf', 'cad']
     for (const match of source.matchAll(/\bfileViewer(?:Formats?|Renderers?)\b\s*[:=]\s*\[([\s\S]*?)\]/g)) {
         push(collectQuotedTokens(match[1]));
     }
-    // HTML / template hints:
-    //   <div data-file-viewer-formats="pdf,docx"></div>
-    //   <input accept=".pdf,.docx,application/vnd.ms-excel">
     for (const match of source.matchAll(/\bdata-file-viewer-(?:formats?|renderers?)\s*=\s*["']([^"']+)["']/g)) {
         push(collectDelimitedTokens(match[1]));
     }
     for (const match of source.matchAll(/\baccept\s*=\s*["']([^"']+)["']/g)) {
         push(collectDelimitedTokens(match[1]));
     }
-    // Comment hints are useful in non-framework projects where the upload UI is
-    // assembled dynamically:
-    //   // file-viewer-formats: pdf,docx,dwg
     for (const match of source.matchAll(/file-viewer-(?:formats?|renderers?)\s*:\s*([^\n\r<]+)/g)) {
         push(collectDelimitedTokens(match[1]));
     }
@@ -936,7 +923,6 @@ function resolveProjectViteMajor(projectRoot) {
                 return major;
         }
         catch {
-            // Try the plugin's own Vite installation when the project does not expose one.
         }
     }
     return 7;
@@ -966,9 +952,6 @@ function getNodeModulePackageName(id) {
         : parts[0];
 }
 function getStableInteropChunkName(id) {
-    // Rollup's virtual helper is shared by every converted CommonJS package.
-    // Leaving it in an app/renderer chunk makes Pako depend back on that chunk
-    // before its exported utility object has been initialized (issue #311).
     if (id.startsWith('\0') && /(?:^|\/)commonjsHelpers\.js$/.test(id.slice(1))) {
         return 'vendor-commonjs';
     }
@@ -1154,7 +1137,6 @@ function collectWorkspacePackageJsons(root) {
                 }
             }
             catch {
-                // Ignore malformed package.json files in unrelated workspace folders.
             }
         }
         for (const entry of readdirSync(directory)) {
@@ -1352,7 +1334,6 @@ function resolvePackageEntry(packageName, anchorPackages = []) {
                     return requireFn.resolve(packageName);
                 }
                 catch {
-                    // Continue probing alternate anchors.
                 }
             }
             return null;
@@ -1370,14 +1351,12 @@ function resolvePackageEntry(packageName, anchorPackages = []) {
         }
     }
     catch {
-        // Fall back to Node resolution below.
     }
     for (const requireFn of requireFns) {
         try {
             return requireFn.resolve(packageName);
         }
         catch {
-            // Continue probing alternate anchors.
         }
     }
     return null;
@@ -1579,7 +1558,6 @@ async function copyVersionedCadRuntimeDirectoryIfPresent(from, to, runtimeVersio
         return false;
     }
     const versionedTarget = join(to, runtimeVersion);
-    // These files are copied from the package root after its runtime directory.
     return copyDirectoryIfPresent(from, versionedTarget, { exclude: ['LICENSE', 'NOTICE'] });
 }
 async function copyPdfCjkFontAssets(from, to) {
@@ -1686,9 +1664,6 @@ async function copyKnownRendererAssets(targetRoot, rendererIds) {
         '@file-viewer/renderer-pdf'
     ]);
     const pdfCjkFontTarget = join(targetRoot, 'vendor/pdf/fonts');
-    // The PDF renderer owns the runtime font dependency so direct renderer installs retain
-    // CJK fallback support. The standard profile pack is only a pre-staged copy source.
-    // A missing source means an incomplete install and must not silently drop the fallback.
     const hasStandardPdfCjkFont = hasPdfCjkFontAssets(standardPdfCjkFontRoot, 'noto-sans-sc.css', 'OFL-1.1.txt');
     const hasStagedPdfCjkFont = hasPdfCjkFontAssets(stagedPdfCjkFontRoot, 'wght.css', 'LICENSE');
     const hasDependencyPdfCjkFont = hasPdfCjkFontAssets(dependencyPdfCjkFontRoot, 'wght.css', 'LICENSE');
@@ -2064,8 +2039,6 @@ function resolveBundledFullAssetSource(installedFullPackages) {
             };
         }
     }
-    // Source workspaces may not have staged file-viewer-copy-assets/viewer yet.
-    // @file-viewer/web keeps the same tracked payload for local development.
     const webPackageRoot = resolvePackageRoot('@file-viewer/web', installedFullPackages);
     const webPayloadRoot = webPackageRoot ? join(webPackageRoot, 'viewer') : null;
     const sourceVersion = readPackageVersion(webPackageRoot);
@@ -2113,8 +2086,6 @@ async function copyBundledFullRendererAssets(targetRoot, rendererIds, installedF
         throw new Error(`[file-viewer:vite-plugin] Unsupported full asset manifest in ${sourceManifestPath}.`);
     }
     const packageJson = JSON.parse(readFileSync(join(source.packageRoot, 'package.json'), 'utf8'));
-    // Full may split large asset families into version-paired dependencies.
-    // Resolve only its declared owners, never an unrelated project-level pack.
     const dependencies = packageJson.dependencies || {};
     const splitPackageNames = Object.keys(dependencies)
         .filter(name => name.startsWith('@file-viewer/assets-'));
@@ -2148,8 +2119,6 @@ async function copyBundledFullRendererAssets(targetRoot, rendererIds, installedF
         }
     }
     await mkdir(targetRoot, { recursive: true });
-    // The runtime manifest is generated below; never overwrite it with the bundled
-    // source first, otherwise an unchanged copy still writes it twice.
     await copyDirectoryIfPresent(source.payloadRoot, targetRoot, {
         merge: true,
         exclude: ['flyfish-viewer-assets.json']
@@ -2213,7 +2182,6 @@ async function copyRendererAssets(target, rendererIds) {
                     id: 'missing-independent-asset-owner',
                     to: target.targetRoot,
                     copied: false,
-                    // Specialist offline payloads stay opt-in; warn instead of failing the build.
                     required: false,
                     reason: `install ${requiredOwner} for this capability`
                 });
@@ -2272,8 +2240,6 @@ function resolveInstalledFullPackages(projectRoot) {
                 return fileViewerFullPackages.filter(packageName => declaredPackages.has(packageName) &&
                     Boolean(tryResolvePackageJson(packageName, projectPackageRequire)));
             }
-            // Vite roots can contain a metadata-only package.json while runtime
-            // dependencies live in an ancestor. A nearer light runtime is a boundary.
             const directory = dirname(packageJsonPath);
             const parent = dirname(directory);
             packageJsonPath = parent === directory ? null : findNearestProjectPackageJson(parent);
@@ -2345,10 +2311,6 @@ function resolveOutputRoot(value, fallback, projectRoot) {
     const output = value || fallback;
     return isAbsolute(output) ? resolve(output) : resolve(projectRoot, output);
 }
-/**
- * Resolves the exact directory used by copyAssets without running a Vite build.
- * This is exported so integrations can validate their deployment contract.
- */
 export function resolveFileViewerCopyAssetsTarget(mode, value = true, config = {}) {
     const projectRoot = resolve(config.projectRoot || process.cwd());
     const options = copyOptions(value);
@@ -2408,10 +2370,6 @@ function resolveViteFullAssetBase(base, baseDir) {
 function resolveDevAssetRequestPath(targetRoot, baseDir, requestPathname, viteBasePath) {
     let requestRelativePath;
     try {
-        // Depending on the Vite major and middleware ordering, configureServer can
-        // observe either the original base-prefixed URL or the pathname after
-        // Vite's base middleware has stripped it. Accept both shapes, then keep the
-        // strict viewer-asset allowlist and target-root boundary checks below.
         const encodedRelativePath = viteBasePath === '/' || requestPathname.startsWith(viteBasePath)
             ? requestPathname.slice(viteBasePath === '/' ? 1 : viteBasePath.length)
             : requestPathname.replace(/^\/+/, '');
@@ -2680,7 +2638,6 @@ export function fileViewerRenderers(options = {}) {
                             }
                         }
                         catch {
-                            // Let Vite return its normal 404/fallback response.
                         }
                     }
                     next();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@file-viewer/vite-plugin",
-  "version": "3.2.3",
+  "version": "3.3.0",
   "private": false,
   "type": "module",
   "description": "Vite plugin for File Viewer on-demand renderer assembly, chunk planning, and offline asset deployment.",
@@ -47,12 +47,12 @@
     "./package.json": "./package.json"
   },
   "files": [
-    "LICENSE",
     "client.d.ts",
-    "dist/index.js",
     "dist/index.d.ts",
-    "README.md",
+    "dist/index.js",
+    "LICENSE",
     "README.en.md",
+    "README.md",
     "README.zh-CN.md"
   ],
   "peerDependencies": {