@file-viewer/renderer-text 2.4.0 → 3.0.1

package/dist/prettyPrint.js

@@ -0,0 +1,232 @@
+export const DEFAULT_PRETTY_PRINT_MAX_BYTES = 512 * 1024;
+const htmlEmbeddedLanguagePattern = /<(?:script|style)(?:\s|>)/i;
+const htmlScriptPattern = /<script(?:\s|>)/i;
+const htmlStylePattern = /<style(?:\s|>)/i;
+const withHtmlEmbeddedPlugins = (source) => {
+    if (!htmlEmbeddedLanguagePattern.test(source)) {
+        return ['html'];
+    }
+    const plugins = ['html'];
+    if (htmlScriptPattern.test(source)) {
+        plugins.push('babel', 'estree', 'typescript');
+    }
+    if (htmlStylePattern.test(source)) {
+        plugins.push('postcss');
+    }
+    return plugins;
+};
+const prettierLanguages = {
+    cjs: { parser: 'babel', plugins: ['babel', 'estree'] },
+    css: { parser: 'css', plugins: ['postcss'] },
+    graphql: { parser: 'graphql', plugins: ['graphql'] },
+    gql: { parser: 'graphql', plugins: ['graphql'] },
+    html: { parser: 'html', plugins: ['html'], resolvePlugins: withHtmlEmbeddedPlugins },
+    htm: { parser: 'html', plugins: ['html'], resolvePlugins: withHtmlEmbeddedPlugins },
+    ipynb: { parser: 'json', plugins: ['babel', 'estree'] },
+    js: { parser: 'babel', plugins: ['babel', 'estree'] },
+    json: { parser: 'json', plugins: ['babel', 'estree'] },
+    json5: { parser: 'json5', plugins: ['babel', 'estree'] },
+    jsonc: { parser: 'jsonc', plugins: ['babel', 'estree'] },
+    jsx: { parser: 'babel', plugins: ['babel', 'estree'] },
+    markdown: { parser: 'markdown', plugins: ['markdown'] },
+    md: { parser: 'markdown', plugins: ['markdown'] },
+    mjs: { parser: 'babel', plugins: ['babel', 'estree'] },
+    react: { parser: 'babel', plugins: ['babel', 'estree'] },
+    ts: { parser: 'typescript', plugins: ['typescript', 'estree'] },
+    tsx: { parser: 'typescript', plugins: ['typescript', 'estree'] },
+    vue: {
+        parser: 'vue',
+        plugins: ['html', 'babel', 'estree', 'typescript', 'postcss']
+    },
+    xml: {
+        parser: 'xml',
+        plugins: ['xml'],
+        options: {
+            xmlWhitespaceSensitivity: 'preserve',
+            xmlQuoteAttributes: 'preserve',
+            xmlSortAttributesByKey: false
+        }
+    },
+    yaml: { parser: 'yaml', plugins: ['yaml'] },
+    yml: { parser: 'yaml', plugins: ['yaml'] }
+};
+const XML_NAMESPACE = 'http://www.w3.org/XML/1998/namespace';
+const hasWhitespaceSensitiveXml = (source) => {
+    if (/\bxml:space\s*=\s*(["'])preserve\1/i.test(source)) {
+        return true;
+    }
+    const Parser = globalThis.DOMParser;
+    if (typeof Parser !== 'function') {
+        // The text renderer itself is browser-facing, but fail closed when this
+        // helper is evaluated in a non-DOM runtime.
+        return true;
+    }
+    try {
+        const documentRef = new Parser().parseFromString(source, 'application/xml');
+        if (documentRef.querySelector('parsererror')) {
+            return false;
+        }
+        const containsMixedContent = (element) => {
+            var _a, _b, _c;
+            const preservesWhitespace = ((_a = element.getAttributeNS(XML_NAMESPACE, 'space')) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === 'preserve' ||
+                ((_b = element.getAttribute('xml:space')) === null || _b === void 0 ? void 0 : _b.toLowerCase()) === 'preserve';
+            if (preservesWhitespace) {
+                return true;
+            }
+            let hasElementChild = false;
+            let hasDirectText = false;
+            for (const child of Array.from(element.childNodes)) {
+                if (child.nodeType === 1) {
+                    hasElementChild = true;
+                    if (containsMixedContent(child)) {
+                        return true;
+                    }
+                }
+                else if ((child.nodeType === 3 || child.nodeType === 4) && ((_c = child.textContent) === null || _c === void 0 ? void 0 : _c.trim())) {
+                    hasDirectText = true;
+                }
+            }
+            return hasElementChild && hasDirectText;
+        };
+        return documentRef.documentElement
+            ? containsMixedContent(documentRef.documentElement)
+            : false;
+    }
+    catch {
+        return false;
+    }
+};
+const pluginLoaders = {
+    babel: () => import('prettier/plugins/babel').then(module => module.default),
+    estree: () => import('prettier/plugins/estree').then(module => module.default),
+    typescript: () => import('prettier/plugins/typescript').then(module => module.default),
+    postcss: () => import('prettier/plugins/postcss').then(module => module.default),
+    html: () => import('prettier/plugins/html').then(module => module.default),
+    markdown: () => import('prettier/plugins/markdown').then(module => module.default),
+    yaml: () => import('prettier/plugins/yaml').then(module => module.default),
+    graphql: () => import('prettier/plugins/graphql').then(module => module.default),
+    xml: () => import('@prettier/plugin-xml').then(module => module.default)
+};
+const loadPrettierRuntime = async (definition, source) => {
+    var _a, _b;
+    const prettierPromise = import('prettier/standalone');
+    const pluginNames = (_b = (_a = definition.resolvePlugins) === null || _a === void 0 ? void 0 : _a.call(definition, source)) !== null && _b !== void 0 ? _b : definition.plugins;
+    const [prettier, ...plugins] = await Promise.all([
+        prettierPromise,
+        ...pluginNames.map(pluginName => pluginLoaders[pluginName]())
+    ]);
+    return {
+        format: prettier.format,
+        plugins
+    };
+};
+const utf8ByteLength = (source) => new TextEncoder().encode(source).byteLength;
+export const resolveFileViewerPrettyPrintMaxBytes = (options) => {
+    var _a;
+    const configured = (_a = options === null || options === void 0 ? void 0 : options.prettyPrintMaxBytes) !== null && _a !== void 0 ? _a : options === null || options === void 0 ? void 0 : options.virtualizeAboveBytes;
+    if (!Number.isFinite(configured)) {
+        return DEFAULT_PRETTY_PRINT_MAX_BYTES;
+    }
+    return Math.max(0, Math.trunc(Number(configured)));
+};
+export const supportsFileViewerPrettyPrint = (extension) => {
+    return Boolean(prettierLanguages[extension.trim().toLowerCase()]);
+};
+/**
+ * Formats a decoded display representation without mutating the source buffer.
+ *
+ * Parser support and byte limits are resolved before the Prettier runtime or
+ * any parser plugin is imported. Failures intentionally return the original
+ * source so malformed or unsupported uploads remain previewable.
+ */
+export const formatFileViewerTextForDisplay = async (source, extension, options, signal, runtimeLoader = loadPrettierRuntime) => {
+    const maxBytes = resolveFileViewerPrettyPrintMaxBytes(options);
+    const sourceByteLength = utf8ByteLength(source);
+    if ((options === null || options === void 0 ? void 0 : options.prettyPrint) !== true) {
+        return { text: source, formatted: false, reason: 'disabled', sourceByteLength, maxBytes };
+    }
+    const definition = prettierLanguages[extension.trim().toLowerCase()];
+    if (!definition) {
+        return { text: source, formatted: false, reason: 'unsupported', sourceByteLength, maxBytes };
+    }
+    if (sourceByteLength > maxBytes) {
+        return {
+            text: source,
+            formatted: false,
+            reason: 'too-large',
+            parser: definition.parser,
+            sourceByteLength,
+            maxBytes
+        };
+    }
+    if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+        return {
+            text: source,
+            formatted: false,
+            reason: 'aborted',
+            parser: definition.parser,
+            sourceByteLength,
+            maxBytes
+        };
+    }
+    if (definition.parser === 'xml' && hasWhitespaceSensitiveXml(source)) {
+        return {
+            text: source,
+            formatted: false,
+            reason: 'whitespace-sensitive',
+            parser: definition.parser,
+            sourceByteLength,
+            maxBytes
+        };
+    }
+    try {
+        const runtime = await runtimeLoader(definition, source);
+        if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+            return {
+                text: source,
+                formatted: false,
+                reason: 'aborted',
+                parser: definition.parser,
+                sourceByteLength,
+                maxBytes
+            };
+        }
+        const formatted = await runtime.format(source, {
+            parser: definition.parser,
+            plugins: runtime.plugins,
+            tabWidth: 2,
+            useTabs: false,
+            printWidth: 80,
+            endOfLine: 'lf',
+            ...definition.options
+        });
+        if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+            return {
+                text: source,
+                formatted: false,
+                reason: 'aborted',
+                parser: definition.parser,
+                sourceByteLength,
+                maxBytes
+            };
+        }
+        return {
+            text: formatted.replace(/\n$/, ''),
+            formatted: true,
+            reason: 'formatted',
+            parser: definition.parser,
+            sourceByteLength,
+            maxBytes
+        };
+    }
+    catch {
+        return {
+            text: source,
+            formatted: false,
+            reason: 'failed',
+            parser: definition.parser,
+            sourceByteLength,
+            maxBytes
+        };
+    }
+};

package/dist/sanitizeHtml.d.ts

@@ -0,0 +1,5 @@
+export type FileViewerRichHtmlSanitizerOptions = {
+    /** Preserve inert SVG markup such as diff icons. Raw Markdown keeps this disabled. */
+    allowSvg?: boolean;
+};
+export declare const sanitizeFileViewerRichHtml: (documentRef: Document, html: string, options?: FileViewerRichHtmlSanitizerOptions) => DocumentFragment;

package/dist/sanitizeHtml.js

@@ -0,0 +1,47 @@
+import createDOMPurify from 'dompurify';
+import { sanitizeFileViewerSvgResources } from '@file-viewer/core';
+const safeUrl = (value) => {
+    var _a, _b;
+    // eslint-disable-next-line no-control-regex -- remove URL controls before scheme validation
+    const compact = value.trim().replace(/[\u0000-\u0020\u007f-\u009f]/g, '');
+    const scheme = (_b = (_a = compact.match(/^([a-z][a-z0-9+.-]*):/i)) === null || _a === void 0 ? void 0 : _a[1]) === null || _b === void 0 ? void 0 : _b.toLowerCase();
+    return !scheme || ['http', 'https', 'mailto', 'tel'].includes(scheme);
+};
+export const sanitizeFileViewerRichHtml = (documentRef, html, options = {}) => {
+    const fallback = () => {
+        const fragment = documentRef.createDocumentFragment();
+        fragment.append(documentRef.createTextNode(html));
+        return fragment;
+    };
+    const windowRef = documentRef.defaultView;
+    if (!windowRef)
+        return fallback();
+    const purifier = createDOMPurify(windowRef);
+    if (!purifier.isSupported)
+        return fallback();
+    const fragment = purifier.sanitize(html, {
+        RETURN_DOM_FRAGMENT: true,
+        USE_PROFILES: options.allowSvg
+            ? { html: true, svg: true, svgFilters: true }
+            : { html: true },
+        ADD_ATTR: ['target'],
+        FORBID_TAGS: ['base', 'embed', 'form', 'iframe', 'object', 'script', 'style', 'template'],
+        FORBID_ATTR: ['action', 'formaction', 'srcdoc', 'style'],
+    });
+    fragment.querySelectorAll('*').forEach(element => {
+        for (const attribute of Array.from(element.attributes)) {
+            if (/^on/i.test(attribute.name))
+                element.removeAttribute(attribute.name);
+        }
+    });
+    fragment.querySelectorAll('a[href]').forEach(anchor => {
+        const href = anchor.getAttribute('href') || '';
+        if (!safeUrl(href))
+            anchor.removeAttribute('href');
+        if ((anchor.getAttribute('target') || '').toLowerCase() === '_blank')
+            anchor.rel = 'noopener noreferrer';
+    });
+    if (options.allowSvg)
+        sanitizeFileViewerSvgResources(fragment);
+    return fragment;
+};

package/file-viewer.capability.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "../../../ecosystem/capability-manifest.schema.json",
+  "schemaVersion": 1,
+  "id": "text",
+  "packageName": "@file-viewer/renderer-text",
+  "rendererIds": ["markdown", "code"],
+  "formats": ["md", "markdown", "txt", "json", "js", "mjs", "cjs", "css", "java", "py", "html", "htm", "jsx", "ts", "tsx", "xml", "log", "vue", "yaml", "yml", "ini", "sh", "bash", "sql", "go", "rs", "php", "c", "cpp", "cc", "h", "hpp", "cs", "jsonc", "json5", "ipynb", "toml", "proto", "hcl", "tex", "gv", "http", "react", "rb", "swift", "kt"],
+  "assets": { "rendererIds": [] },
+  "license": { "spdx": "Apache-2.0", "policy": "permissive" },
+  "weight": "standard",
+  "profiles": ["lite", "standard", "all"]
+}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@file-viewer/renderer-text",
-  "version": "2.4.0",
+  "version": "3.0.1",
   "private": false,
   "type": "module",
-  "description": "Standalone code, text, Markdown, patch diff, and Git bundle renderer plugin for File Viewer.",
+  "description": "Standalone code, text, and Markdown renderer for File Viewer; Mermaid, patch diff, and Git bundle tools are explicit opt-in capabilities.",
   "keywords": [
     "file-viewer",
     "renderer",
@@ -52,25 +52,32 @@
   },
   "files": [
     "dist",
+    "file-viewer.capability.json",
     "README.md",
     "README.en.md",
     "LICENSE"
   ],
   "dependencies": {
-    "@file-viewer/core": "2.4.0",
-    "diff2html": "^3.4.56",
+    "@file-viewer/core": "3.0.1",
+    "@prettier/plugin-xml": "3.4.2",
+    "dompurify": "^3.4.14",
     "highlight.js": "^11.11.1",
     "marked": "^18.0.5",
-    "mermaid": "^11.16.1",
-    "pako": "^2.1.0",
-    "dompurify": "^3.4.13"
+    "prettier": "3.8.3"
   },
   "devDependencies": {
+    "diff2html": "^3.4.56",
+    "mermaid": "^11.17.2",
+    "pako": "^2.1.0",
+    "jsdom": "^27.4.0",
     "typescript": "^6.0.3"
   },
+  "fileViewer": {
+    "capabilityManifest": "./file-viewer.capability.json"
+  },
   "license": "Apache-2.0",
   "scripts": {
-    "build": "tsc -b tsconfig.json",
+    "build": "tsc -b tsconfig.json && node --test test/*.test.mjs",
     "type-check": "tsc -b tsconfig.json"
   }
 }