@file-viewer/vite-plugin 2.3.3 → 3.0.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import type { Plugin } from 'vite';
-export type FileViewerVitePreset = 'all' | 'lite' | 'office' | 'engineering';
+export type FileViewerVitePreset = 'all' | 'lite' | 'standard' | 'office' | 'engineering';
 export type FileViewerVitePresetMode = FileViewerVitePreset | 'auto';
 export type FileViewerMissingRendererMode = 'error' | 'warn' | 'ignore';
 export type FileViewerChunkStrategy = 'renderer' | 'none';
@@ -122,6 +122,7 @@ export interface FileViewerCopyAssetsTarget {
     targetRoot: string;
     baseDir: string;
     installedFullPackages: string[];
+    installedAssetPackages: string[];
 }
 /**
  * Resolves the exact directory used by copyAssets without running a Vite build.

package/dist/index.js

@@ -1,5 +1,5 @@
 import { existsSync, readdirSync, readFileSync, statSync } from 'node:fs';
-import { copyFile, cp, mkdir, readFile, realpath, rm, stat, writeFile } from 'node:fs/promises';
+import { copyFile, cp, lstat, mkdir, readFile, readdir, realpath, rm, stat, writeFile } from 'node:fs/promises';
 import { createRequire } from 'node:module';
 import { dirname, extname, isAbsolute, join, relative, resolve, sep } from 'node:path';
 const virtualModuleId = 'virtual:file-viewer-renderers';
@@ -12,7 +12,10 @@ const isPresentationRendererImporter = (importer) => {
     const normalized = importer.replace(/\\/g, '/');
     return (normalized.includes('/@file-viewer/renderer-presentation/') ||
         normalized.includes('/@file-viewer+renderer-presentation@') ||
-        normalized.includes('/packages/renderers/presentation/'));
+        normalized.includes('/packages/renderers/presentation/') ||
+        normalized.includes('/@file-viewer/renderer-ppt/') ||
+        normalized.includes('/@file-viewer+renderer-ppt@') ||
+        normalized.includes('/packages/renderers/presentation-ppt/'));
 };
 const pluginRequire = createRequire(import.meta.url);
 let workspacePackageJsonCache = null;
@@ -59,7 +62,7 @@ const rendererModules = [
     },
     {
         id: 'presentation-binary',
-        packageName: '@file-viewer/renderer-presentation/ppt',
+        packageName: '@file-viewer/renderer-ppt',
         exportName: 'pptRenderer',
         formats: ['ppt', 'pot'],
         rendererIds: ['office-presentation-binary'],
@@ -67,7 +70,7 @@ const rendererModules = [
     },
     {
         id: 'presentation-openxml',
-        packageName: '@file-viewer/renderer-presentation/pptx',
+        packageName: '@file-viewer/renderer-pptx',
         exportName: 'pptxRenderer',
         formats: ['pptx', 'pptm', 'potx', 'potm', 'ppsx', 'ppsm'],
         rendererIds: ['office-presentation'],
@@ -303,6 +306,46 @@ const rendererModules = [
         rendererIds: ['image'],
         chunkName: 'file-viewer-image'
     },
+    {
+        id: 'dicom',
+        packageName: '@file-viewer/renderer-dicom',
+        exportName: 'dicomRenderer',
+        formats: ['dicom', 'dcm'],
+        rendererIds: ['dicom'],
+        chunkName: 'file-viewer-dicom',
+        includeInPresetAll: false
+    },
+    {
+        id: 'signature',
+        packageName: '@file-viewer/renderer-signature',
+        exportName: 'signatureRenderer',
+        formats: [
+            'p7m',
+            'p7s',
+            'p7c',
+            'p7b',
+            'pkcs7',
+            'cms',
+            'cmsc',
+            'tsd',
+            'tst',
+            'tsq',
+            'tsr',
+            'asics',
+            'scs',
+            'asice',
+            'sce',
+            'ers',
+            'asc',
+            'sig',
+            'pgp',
+            'gpg',
+            'jws'
+        ],
+        rendererIds: ['signature'],
+        chunkName: 'file-viewer-signature',
+        includeInPresetAll: false
+    },
     {
         id: 'media',
         packageName: '@file-viewer/renderer-media',
@@ -389,8 +432,22 @@ rendererModules.forEach((descriptor) => {
     descriptor.rendererIds.forEach((rendererId) => descriptorsByRendererId.set(rendererId, descriptor));
 });
 const presetRendererIds = {
-    all: rendererModules.map((descriptor) => descriptor.id),
+    all: rendererModules
+        .filter((descriptor) => descriptor.includeInPresetAll !== false)
+        .map((descriptor) => descriptor.id),
     lite: ['text', 'image', 'media'],
+    standard: [
+        'word',
+        'pdf',
+        'ofd',
+        'presentation-openxml',
+        'spreadsheet',
+        'archive',
+        'email',
+        'text',
+        'image',
+        'media'
+    ],
     office: ['pdf', 'word', 'spreadsheet', 'presentation', 'ofd', 'iwork', 'wordperfect', 'hangul'],
     engineering: [
         'cad',
@@ -419,6 +476,13 @@ const presetModules = {
         rendererIds: presetRendererIds.lite,
         chunkName: 'file-viewer-preset-lite'
     },
+    standard: {
+        id: 'standard',
+        packageName: '@file-viewer/preset-standard',
+        exportName: 'standardRenderers',
+        rendererIds: presetRendererIds.standard,
+        chunkName: 'file-viewer-preset-standard'
+    },
     office: {
         id: 'office',
         packageName: '@file-viewer/preset-office',
@@ -461,7 +525,8 @@ const cjsInteropPackages = [
     '@xmldom/xmldom',
     'keynote-archives',
     'occt-import-js',
-    'jszip'
+    'jszip',
+    'pdf-lib'
 ];
 const defaultScanRoots = ['src', 'app', 'pages', 'components'];
 const defaultScanExtensions = [
@@ -1107,6 +1172,22 @@ function collectDependencyAnchorPackages(selection, autoPresetIds = []) {
     ]);
     return unique([
         ...collectSelectedPackages(selection, autoPresetIds),
+        ...presetIds.flatMap((presetId) => {
+            const packageJsonPath = resolvePackageJson(presetModules[presetId].packageName);
+            if (!packageJsonPath) {
+                return [];
+            }
+            try {
+                const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8'));
+                return Object.keys({
+                    ...(packageJson.dependencies || {}),
+                    ...(packageJson.optionalDependencies || {})
+                }).filter(packageName => packageName.startsWith('@file-viewer/capability-'));
+            }
+            catch {
+                return [];
+            }
+        }),
         ...presetIds.flatMap((presetId) => presetModules[presetId].rendererIds
             .map((rendererId) => descriptorsById.get(rendererId)?.packageName)
             .filter((packageName) => Boolean(packageName))),
@@ -1378,9 +1459,15 @@ async function copyKnownRendererAssets(targetRoot, rendererIds) {
         '@file-viewer/renderer-pdf'
     ]);
     await push('pdf', 'pdf-cjk-font-fallback', join(targetRoot, 'vendor/pdf/fonts'), () => copyPdfCjkFontAssets(pdfCjkFontRoot, join(targetRoot, 'vendor/pdf/fonts')));
-    const pptxRoot = resolvePackageRoot('@file-viewer/pptx', ['@file-viewer/renderer-presentation']);
+    const pptxRoot = resolvePackageRoot('@file-viewer/pptx', [
+        '@file-viewer/renderer-pptx',
+        '@file-viewer/renderer-presentation'
+    ]);
     await push('office-presentation', 'pptx-worker', join(targetRoot, 'vendor/pptx/pptx.worker.js'), () => copyFileIfPresent(pptxRoot ? join(pptxRoot, 'dist/worker/pptx.worker.js') : null, join(targetRoot, 'vendor/pptx/pptx.worker.js')));
-    const pptRoot = resolvePackageRoot('@file-viewer/ppt', ['@file-viewer/renderer-presentation']);
+    const pptRoot = resolvePackageRoot('@file-viewer/ppt', [
+        '@file-viewer/renderer-ppt',
+        '@file-viewer/renderer-presentation'
+    ]);
     const pptVersion = readPackageVersion(pptRoot);
     const pptSource = pptRoot
         ? { sourcePackage: '@file-viewer/ppt', sourceVersion: pptVersion || undefined }
@@ -1473,6 +1560,150 @@ async function copyKnownRendererAssets(targetRoot, rendererIds) {
     }, null, 2)}\n`);
     return results;
 }
+const independentlyOwnedAssetRendererIds = new Map([
+    ['archive', '@file-viewer/assets-standard'],
+    ['pdf', '@file-viewer/assets-standard'],
+    ['office-word-openxml', '@file-viewer/assets-standard'],
+    ['office-presentation', '@file-viewer/assets-standard'],
+    ['spreadsheet-openxml', '@file-viewer/assets-standard'],
+    ['cad', '@file-viewer/assets-cad'],
+    ['typst', '@file-viewer/assets-typst'],
+    ['model', '@file-viewer/assets-model'],
+    ['apple-pages', '@file-viewer/assets-iwork'],
+    ['apple-numbers', '@file-viewer/assets-iwork'],
+    ['apple-keynote', '@file-viewer/assets-iwork'],
+    ['office-presentation-binary', '@file-viewer/assets-ppt'],
+    ['office-hangul', '@file-viewer/assets-hangul'],
+    ['office-wordperfect', '@file-viewer/assets-wordperfect'],
+    ['data-asset', '@file-viewer/assets-data']
+]);
+function resolveInstalledCapabilityAssetSources(installedAssetPackages, anchorPackages) {
+    return installedAssetPackages.map((packageName) => {
+        if (packageName === 'file-viewer-copy-assets') {
+            throw new Error('[file-viewer:vite-plugin] The v2 aggregate asset carrier is forbidden in a v3 capability plan.');
+        }
+        const packageRoot = resolvePackageRoot(packageName, anchorPackages);
+        if (!packageRoot)
+            throw new Error(`[file-viewer:vite-plugin] Could not resolve installed asset owner ${packageName}.`);
+        const packageVersion = readPackageVersion(packageRoot);
+        if (!packageVersion)
+            throw new Error(`[file-viewer:vite-plugin] Could not read ${packageName} version.`);
+        const payloadRoot = join(packageRoot, 'viewer');
+        const manifestPath = [
+            join(payloadRoot, 'file-viewer-asset-pack.json'),
+            join(payloadRoot, 'flyfish-viewer-assets.json')
+        ].find(candidate => existsSync(candidate) && statSync(candidate).isFile());
+        if (!manifestPath)
+            throw new Error(`[file-viewer:vite-plugin] ${packageName} has no staged capability asset manifest.`);
+        const manifest = JSON.parse(readFileSync(manifestPath, 'utf8'));
+        if (manifest.schemaVersion !== 1 || !Array.isArray(manifest.rendererAssetManifests) ||
+            manifest.packageName !== packageName || manifest.packageVersion !== packageVersion) {
+            throw new Error(`[file-viewer:vite-plugin] ${packageName}@${packageVersion} has an invalid or stale asset manifest.`);
+        }
+        return { packageName, packageRoot, packageVersion, payloadRoot, manifest };
+    });
+}
+async function copyAssetPathWithoutConflicts(sourceRoot, targetRoot, relativePath) {
+    const normalized = relativePath.replace(/\\/g, '/').replace(/^\/+/, '');
+    const source = resolve(sourceRoot, ...normalized.split('/'));
+    const destination = resolve(targetRoot, ...normalized.split('/'));
+    if (!isPathWithin(sourceRoot, source) || !isPathWithin(targetRoot, destination)) {
+        throw new Error(`[file-viewer:vite-plugin] Asset path escapes its package or output root: ${relativePath}.`);
+    }
+    const sourceInfo = await lstat(source);
+    if (sourceInfo.isSymbolicLink())
+        throw new Error(`[file-viewer:vite-plugin] Asset source is a symbolic link: ${source}.`);
+    if (sourceInfo.isDirectory()) {
+        await mkdir(destination, { recursive: true });
+        for (const entry of await readdir(source, { withFileTypes: true })) {
+            if (entry.isSymbolicLink())
+                throw new Error(`[file-viewer:vite-plugin] Asset source is a symbolic link: ${join(source, entry.name)}.`);
+            await copyAssetPathWithoutConflicts(sourceRoot, targetRoot, `${normalized}/${entry.name}`);
+        }
+        return;
+    }
+    if (!sourceInfo.isFile())
+        throw new Error(`[file-viewer:vite-plugin] Asset source is not a regular file: ${source}.`);
+    await mkdir(dirname(destination), { recursive: true });
+    if (existsSync(destination)) {
+        const destinationInfo = await lstat(destination);
+        if (destinationInfo.isSymbolicLink() || !destinationInfo.isFile()) {
+            throw new Error(`[file-viewer:vite-plugin] Refusing unsafe asset destination ${destination}.`);
+        }
+        const [sourceContent, destinationContent] = await Promise.all([readFile(source), readFile(destination)]);
+        if (!sourceContent.equals(destinationContent)) {
+            throw new Error(`[file-viewer:vite-plugin] Asset owners conflict at ${normalized}.`);
+        }
+        return;
+    }
+    await copyFile(source, destination);
+}
+async function copyInstalledCapabilityAssetPacks(targetRoot, rendererIds, installedAssetPackages, anchorPackages) {
+    const selected = new Set(rendererIds);
+    const sources = resolveInstalledCapabilityAssetSources(installedAssetPackages, anchorPackages);
+    const rendererOwners = new Map();
+    const results = [];
+    await mkdir(targetRoot, { recursive: true });
+    for (const source of sources) {
+        for (const rendererManifest of source.manifest.rendererAssetManifests || []) {
+            if (!selected.has(rendererManifest.rendererId))
+                continue;
+            const existing = rendererOwners.get(rendererManifest.rendererId);
+            if (existing) {
+                throw new Error(`[file-viewer:vite-plugin] Renderer asset group ${rendererManifest.rendererId} is owned by both ` +
+                    `${existing.packageName} and ${source.packageName}.`);
+            }
+            rendererOwners.set(rendererManifest.rendererId, {
+                packageName: source.packageName,
+                manifest: rendererManifest
+            });
+            for (const asset of rendererManifest.assets || []) {
+                if (asset.target !== 'public' || !asset.defaultPath)
+                    continue;
+                const destination = resolve(targetRoot, ...asset.defaultPath.replace(/\\/g, '/').replace(/^\/+/, '').split('/'));
+                try {
+                    await copyAssetPathWithoutConflicts(source.payloadRoot, targetRoot, asset.defaultPath);
+                    results.push({
+                        rendererId: asset.rendererId,
+                        id: asset.id,
+                        to: destination,
+                        copied: true,
+                        required: asset.required,
+                        sourcePackage: source.packageName,
+                        sourceVersion: source.packageVersion
+                    });
+                }
+                catch (error) {
+                    results.push({
+                        rendererId: asset.rendererId,
+                        id: asset.id,
+                        to: destination,
+                        copied: false,
+                        required: asset.required,
+                        reason: error.message,
+                        sourcePackage: source.packageName,
+                        sourceVersion: source.packageVersion
+                    });
+                }
+            }
+        }
+    }
+    const manifests = [...rendererOwners]
+        .sort(([left], [right]) => left.localeCompare(right))
+        .map(([, value]) => value.manifest);
+    await writeFile(join(targetRoot, 'flyfish-viewer-assets.json'), `${JSON.stringify({
+        schemaVersion: 1,
+        generatedBy: '@file-viewer/vite-plugin',
+        rendererAssetManifests: manifests
+    }, null, 2)}\n`);
+    await writeFile(join(targetRoot, 'flyfish-viewer-manifest.json'), `${JSON.stringify({
+        schemaVersion: 1,
+        kind: 'file-viewer-capability-assets',
+        owners: sources.map(source => ({ packageName: source.packageName, packageVersion: source.packageVersion }))
+            .sort((left, right) => left.packageName.localeCompare(right.packageName))
+    }, null, 2)}\n`);
+    return { results, rendererIds: [...rendererOwners.keys()].sort() };
+}
 function matchesBundledAssetKind(kind, info) {
     return kind === 'directory' || kind === 'wasm-directory'
         ? info.isDirectory()
@@ -1621,6 +1852,24 @@ async function copyRendererAssets(target, rendererIds) {
             return bundledResults;
         }
     }
+    if (target.installedAssetPackages.length) {
+        const bundled = await copyInstalledCapabilityAssetPacks(target.targetRoot, rendererIds, target.installedAssetPackages, target.installedFullPackages);
+        const covered = new Set(bundled.rendererIds);
+        for (const rendererId of rendererIds) {
+            const requiredOwner = independentlyOwnedAssetRendererIds.get(rendererId);
+            if (requiredOwner && !covered.has(rendererId)) {
+                bundled.results.push({
+                    rendererId,
+                    id: 'missing-independent-asset-owner',
+                    to: target.targetRoot,
+                    copied: false,
+                    required: true,
+                    reason: `install ${requiredOwner} for this capability`
+                });
+            }
+        }
+        return bundled.results;
+    }
     const results = await copyKnownRendererAssets(target.targetRoot, rendererIds);
     if (target.installedFullPackages.length) {
         results.push({
@@ -1672,6 +1921,25 @@ function resolveInstalledFullPackages(projectRoot) {
         return [];
     }
 }
+function resolveInstalledAssetPackages(projectRoot) {
+    const packageJsonPath = findNearestProjectPackageJson(projectRoot);
+    if (!packageJsonPath)
+        return [];
+    try {
+        const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8'));
+        const declared = unique([
+            ...Object.keys(packageJson.dependencies || {}),
+            ...Object.keys(packageJson.devDependencies || {}),
+            ...Object.keys(packageJson.optionalDependencies || {})
+        ]).filter(packageName => packageName.startsWith('@file-viewer/assets-'));
+        const require = createRequire(packageJsonPath);
+        const resolved = declared.filter(packageName => Boolean(tryResolvePackageJson(packageName, require)));
+        return unique(resolved).sort();
+    }
+    catch {
+        return [];
+    }
+}
 function normalizeCopyAssetsBaseDir(value) {
     const normalized = value.trim().replace(/\\/g, '/');
     if (!normalized) {
@@ -1722,6 +1990,7 @@ export function resolveFileViewerCopyAssetsTarget(mode, value = true, config = {
     const projectRoot = resolve(config.projectRoot || process.cwd());
     const options = copyOptions(value);
     const installedFullPackages = resolveInstalledFullPackages(projectRoot);
+    const installedAssetPackages = resolveInstalledAssetPackages(projectRoot);
     const baseDir = normalizeCopyAssetsBaseDir(typeof options.baseDir === 'string'
         ? options.baseDir
         : installedFullPackages.length
@@ -1739,7 +2008,8 @@ export function resolveFileViewerCopyAssetsTarget(mode, value = true, config = {
         outputRoot,
         targetRoot,
         baseDir,
-        installedFullPackages: [...installedFullPackages]
+        installedFullPackages: [...installedFullPackages],
+        installedAssetPackages
     };
 }
 function normalizeViteDevBasePath(base) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@file-viewer/vite-plugin",
-  "version": "2.3.3",
+  "version": "3.0.0",
   "private": false,
   "type": "module",
   "description": "Vite plugin for File Viewer on-demand renderer assembly, chunk planning, and offline asset deployment.",