From 49b8e64a8f57b8520961d936ef759668e138c1d9 Mon Sep 17 00:00:00 2001 From: Nick the Sick Date: Mon, 16 Nov 2026 14:01:01 +0100 Subject: [PATCH] fix: render file links in full HTML exports --- .../helpers/render/createFileBlockWrapper.ts | 16 +- .../core/src/editor/fileHTML.browser.test.ts | 168 ++++++++++++++++++ .../src/blocks/File/fileHTML.browser.test.tsx | 69 +++++++ .../File/helpers/render/FileBlockWrapper.tsx | 20 ++- .../src/context/ServerBlockNoteEditor.test.ts | 19 ++ .../ServerBlockNoteEditor.test.ts.snap | 2 +- .../blocknoteHTML/file/basic.html | 20 ++- .../blocknoteHTML/file/nested.html | 40 +++-- .../blocknoteHTML/file/noCaption.html | 20 ++- .../blocknoteHTML/file/noName.html | 20 ++- .../blocknoteHTML/image/noPreview.html | 20 ++- .../blocknoteHTML/reactFile/basic.html | 20 ++- .../blocknoteHTML/reactFile/nested.html | 40 +++-- .../blocknoteHTML/reactFile/noCaption.html | 20 ++- .../blocknoteHTML/reactFile/noName.html | 20 ++- .../blocknoteHTML/reactImage/noPreview.html | 20 ++- 16 files changed, 422 insertions(+), 112 deletions(-) create mode 100644 packages/core/src/editor/fileHTML.browser.test.ts create mode 100644 packages/react/src/blocks/File/fileHTML.browser.test.tsx diff --git a/packages/core/src/blocks/File/helpers/render/createFileBlockWrapper.ts b/packages/core/src/blocks/File/helpers/render/createFileBlockWrapper.ts index 0dd52a4cd9..32104fab36 100644 --- a/packages/core/src/blocks/File/helpers/render/createFileBlockWrapper.ts +++ b/packages/core/src/blocks/File/helpers/render/createFileBlockWrapper.ts @@ -70,8 +70,20 @@ export const createFileBlockWrapper = ( // Show the file preview, or the file name and icon. if (block.props.showPreview === false || !element) { // Show file name and icon. - const fileNameWithIcon = createFileNameWithIcon(block); - wrapper.appendChild(fileNameWithIcon.dom); + const fileNameWithIcon = createFileNameWithIcon({ + ...block, + props: { ...block.props, name: block.props.name || block.props.url }, + }); + const link = document.createElement("a"); + link.className = "bn-file-link"; + link.setAttribute("href", block.props.url); + link.addEventListener("click", (event) => { + if (editor.isEditable) { + event.preventDefault(); + } + }); + link.appendChild(fileNameWithIcon.dom); + wrapper.appendChild(link); ret.destroy = () => { fileNameWithIcon.destroy?.(); diff --git a/packages/core/src/editor/fileHTML.browser.test.ts b/packages/core/src/editor/fileHTML.browser.test.ts new file mode 100644 index 0000000000..c34fd16416 --- /dev/null +++ b/packages/core/src/editor/fileHTML.browser.test.ts @@ -0,0 +1,168 @@ +import { afterEach, expect, it, vi } from "vite-plus/test"; +import { userEvent } from "vite-plus/test/browser"; + +import { BlockNoteEditor } from "./BlockNoteEditor.js"; +import { BlockNoteSchema } from "../blocks/BlockNoteSchema.js"; +import { defaultBlockSpecs } from "../blocks/defaultBlocks.js"; +import { createFileBlockConfig } from "../blocks/File/block.js"; +import { createBlockSpec } from "../schema/index.js"; + +const editors: BlockNoteEditor[] = []; + +afterEach(() => { + for (const editor of editors.splice(0)) { + editor._tiptapEditor.destroy(); + } +}); + +function parse(html: string) { + const root = document.createElement("div"); + root.innerHTML = html; + return root; +} + +it.each([ + ["https://example.com/report.pdf?x=1&y=2", "report.pdf", "Attachment"], + ["../files/report.pdf", "", ""], +])( + "exports a navigable file without losing its source: %s", + async (url, name, caption) => { + const editor = BlockNoteEditor.create(); + editors.push(editor); + editor.replaceBlocks(editor.document, [ + { + id: "parent", + type: "paragraph", + children: [ + { + id: "attachment", + type: "file", + props: { url, name, caption }, + }, + ], + }, + ]); + const blocks = editor.document; + const html = editor.blocksToFullHTML(); + const root = parse(html); + const link = root.querySelector("a.bn-file-link"); + expect(link?.getAttribute("href")).toBe(url); + expect( + link?.closest('[data-content-type="file"]')?.getAttribute("data-url"), + ).toBe(url); + expect(root.querySelector(".bn-file-name")?.textContent).toBe(name || url); + expect(editor.tryParseHTMLToBlocks(html)).toEqual(blocks); + // Applications can replace navigation URLs without changing stored sources. + link!.setAttribute("href", "https://cdn.example.com/resolved.pdf"); + expect(editor.tryParseHTMLToBlocks(root.innerHTML)).toEqual(blocks); + + const host = document.createElement("div"); + document.body.appendChild(host); + try { + editor.mount(host); + expect(host.querySelector('[data-content-type="file"]')).not.toBeNull(); + expect( + host + .querySelector('[data-content-type="file"] a') + ?.getAttribute("href"), + ).toBe(url); + const navigation = vi.fn((event: MouseEvent) => { + const prevented = event.defaultPrevented; + // Observe the renderer's policy without actually leaving the test page. + event.preventDefault(); + return prevented; + }); + host.addEventListener("click", navigation); + const liveLink = host.querySelector("a.bn-file-link")!; + await userEvent.click(liveLink); + expect(navigation).toHaveLastReturnedWith(true); + expect(editor.getTextCursorPosition().block.id).toBe("attachment"); + + editor.isEditable = false; + await userEvent.click(liveLink); + expect(navigation).toHaveLastReturnedWith(false); + navigation.mockClear(); + liveLink.focus(); + await userEvent.keyboard("{Enter}"); + expect(navigation).toHaveReturnedWith(false); + } finally { + editor.unmount(); + host.remove(); + } + }, +); + +it.each([ + "", + "javascript:alert(1)", + "java\nscript:alert(1)", + "data:text/html,test", + "storage://original", +])("preserves the stored source without filtering schemes: %s", (url) => { + const editor = BlockNoteEditor.create(); + editors.push(editor); + editor.replaceBlocks(editor.document, [ + { id: "file", type: "file", props: { url } }, + { id: "safe", type: "file", props: { url: "https://example.com/safe" } }, + ]); + const blocks = editor.document; + const html = editor.blocksToFullHTML(); + const root = parse(html); + expect(root.querySelector('[data-id="file"] a')?.getAttribute("href")).toBe( + url || undefined, + ); + expect(root.querySelector('[data-id="safe"] a')?.getAttribute("href")).toBe( + "https://example.com/safe", + ); + expect(editor.tryParseHTMLToBlocks(html)).toEqual(blocks); +}); + +it("does not invoke the resolver during synchronous export", () => { + const resolveFileUrl = vi.fn(async () => "https://cdn.example.com/private"); + const editor = BlockNoteEditor.create({ resolveFileUrl }); + editors.push(editor); + const html = editor.blocksToFullHTML([ + { type: "file", props: { url: "https://example.com/original" } }, + ]); + expect(parse(html).querySelector("a")?.getAttribute("href")).toBe( + "https://example.com/original", + ); + expect(resolveFileUrl).not.toHaveBeenCalled(); +}); + +it("leaves replacement renderers alone and links media filename fallbacks", () => { + const resolveFileUrl = vi.fn(async () => "https://cdn.example.com/resolved"); + const customFile = createBlockSpec(createFileBlockConfig, { + render() { + const dom = document.createElement("div"); + dom.className = "bn-file-name-with-icon"; + dom.textContent = "Custom file UI"; + return { dom }; + }, + }); + const editor = BlockNoteEditor.create({ + schema: BlockNoteSchema.create({ + blockSpecs: { ...defaultBlockSpecs, file: customFile() }, + }), + resolveFileUrl, + }); + editors.push(editor); + const html = editor.blocksToFullHTML([ + { type: "file", props: { url: "https://example.com/custom.pdf" } }, + { + type: "image", + props: { url: "https://example.com/image.png", showPreview: false }, + }, + ]); + const root = parse(html); + expect(root.querySelector('[data-content-type="file"] a')).toBeNull(); + expect(root.querySelector("a.bn-file-link")?.getAttribute("href")).toBe( + "https://example.com/image.png", + ); + expect(html).toContain("Custom file UI"); + // The image renderer still performs its existing asynchronous preview work; + // the attachment exporter must not resolve the custom file or re-resolve media. + expect(resolveFileUrl).toHaveBeenCalledExactlyOnceWith( + "https://example.com/image.png", + ); +}); diff --git a/packages/react/src/blocks/File/fileHTML.browser.test.tsx b/packages/react/src/blocks/File/fileHTML.browser.test.tsx new file mode 100644 index 0000000000..901a8ecab6 --- /dev/null +++ b/packages/react/src/blocks/File/fileHTML.browser.test.tsx @@ -0,0 +1,69 @@ +import { + BlockNoteEditor, + BlockNoteSchema, + defaultBlockSpecs, +} from "@blocknote/core"; +import { createRoot } from "react-dom/client"; +import { flushSync } from "react-dom"; +import { expect, it, vi } from "vite-plus/test"; +import { userEvent } from "vite-plus/test/browser"; + +import { BlockNoteViewRaw } from "../../editor/BlockNoteView.js"; +import { ReactFileBlock } from "./block.js"; + +it("renders React file links in the editor and exported HTML", async () => { + const editor = BlockNoteEditor.create({ + schema: BlockNoteSchema.create({ + blockSpecs: { ...defaultBlockSpecs, file: ReactFileBlock() }, + }), + initialContent: [ + { + id: "file", + type: "file", + props: { url: "https://example.com/report.pdf", caption: "Caption" }, + }, + ], + }); + const host = document.createElement("div"); + document.body.append(host); + const root = createRoot(host); + try { + flushSync(() => root.render()); + const blocks = editor.document; + const html = editor.blocksToFullHTML(); + const exported = document.createElement("div"); + exported.innerHTML = html; + expect(exported.querySelector("a.bn-file-link")?.getAttribute("href")).toBe( + "https://example.com/report.pdf", + ); + expect(exported.querySelector("figcaption")?.textContent).toBe("Caption"); + expect(editor.tryParseHTMLToBlocks(html)).toEqual(blocks); + expect( + host.querySelector('[data-content-type="file"] a')?.getAttribute("href"), + ).toBe("https://example.com/report.pdf"); + const navigation = vi.fn((event: MouseEvent) => { + const prevented = event.defaultPrevented; + event.preventDefault(); + return prevented; + }); + host.addEventListener("click", navigation); + const liveLink = host.querySelector("a.bn-file-link")!; + await userEvent.click(liveLink); + expect(navigation).toHaveLastReturnedWith(true); + expect(editor.getTextCursorPosition().block.id).toBe("file"); + + flushSync(() => { + editor.isEditable = false; + }); + await userEvent.click(liveLink); + expect(navigation).toHaveLastReturnedWith(false); + navigation.mockClear(); + liveLink.focus(); + await userEvent.keyboard("{Enter}"); + expect(navigation).toHaveReturnedWith(false); + } finally { + root.unmount(); + editor._tiptapEditor.destroy(); + host.remove(); + } +}); diff --git a/packages/react/src/blocks/File/helpers/render/FileBlockWrapper.tsx b/packages/react/src/blocks/File/helpers/render/FileBlockWrapper.tsx index f277db693f..3bf99be9f1 100644 --- a/packages/react/src/blocks/File/helpers/render/FileBlockWrapper.tsx +++ b/packages/react/src/blocks/File/helpers/render/FileBlockWrapper.tsx @@ -53,7 +53,25 @@ export const FileBlockWrapper = ( <> {props.block.props.showPreview === false || !props.children ? ( // Show file name and icon. - + { + if (props.editor.isEditable) { + event.preventDefault(); + } + }} + > + + ) : ( // Show preview. props.children diff --git a/packages/server-util/src/context/ServerBlockNoteEditor.test.ts b/packages/server-util/src/context/ServerBlockNoteEditor.test.ts index fd45b2fadd..83619b88da 100644 --- a/packages/server-util/src/context/ServerBlockNoteEditor.test.ts +++ b/packages/server-util/src/context/ServerBlockNoteEditor.test.ts @@ -116,6 +116,25 @@ describe("Test ServerBlockNoteEditor", () => { expect(html).toMatchSnapshot(); }); + it("exports file links while preserving stored URLs", async () => { + const fileEditor = ServerBlockNoteEditor.create(); + try { + const input = [ + { + id: "file", + type: "file" as const, + props: { url: "https://example.com/report.pdf" }, + }, + ]; + const html = await fileEditor.blocksToFullHTML(input); + expect(html).toContain('href="https://example.com/report.pdf"'); + const parsed = await fileEditor.tryParseHTMLToBlocks(html); + expect(parsed[0]).toMatchObject(input[0]); + } finally { + fileEditor.editor._tiptapEditor.destroy(); + } + }); + it("converts to and from markdown (blocksToMarkdownLossy)", async () => { const md = await editor.blocksToMarkdownLossy(blocks); expect(md).toMatchSnapshot(); diff --git a/packages/server-util/src/context/__snapshots__/ServerBlockNoteEditor.test.ts.snap b/packages/server-util/src/context/__snapshots__/ServerBlockNoteEditor.test.ts.snap index db9aa56560..4e49936f3a 100644 --- a/packages/server-util/src/context/__snapshots__/ServerBlockNoteEditor.test.ts.snap +++ b/packages/server-util/src/context/__snapshots__/ServerBlockNoteEditor.test.ts.snap @@ -1,6 +1,6 @@ // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html -exports[`Test ServerBlockNoteEditor > converts to HTML (blocksToFullHTML) 1`] = `"

Heading 2

Paragraph

list item

Example
Caption

Example

Caption
"`; +exports[`Test ServerBlockNoteEditor > converts to HTML (blocksToFullHTML) 1`] = `"

Heading 2

Paragraph

list item

Example
Caption

Example

Caption
"`; exports[`Test ServerBlockNoteEditor > converts to and from HTML (blocksToHTMLLossy) 1`] = `"

Heading 2

Paragraph

  • list item

Example
Caption
Example

Caption

"`; diff --git a/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/file/basic.html b/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/file/basic.html index d7802da3e3..9c0362955d 100644 --- a/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/file/basic.html +++ b/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/file/basic.html @@ -10,16 +10,18 @@ data-file-block="" >
-
diff --git a/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/file/nested.html b/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/file/nested.html index c62486d27d..c78629be57 100644 --- a/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/file/nested.html +++ b/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/file/nested.html @@ -10,16 +10,18 @@ data-file-block="" >
-
@@ -35,16 +37,18 @@ data-file-block="" >
-
diff --git a/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/file/noCaption.html b/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/file/noCaption.html index 48340682e8..0324c05498 100644 --- a/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/file/noCaption.html +++ b/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/file/noCaption.html @@ -9,16 +9,18 @@ data-file-block="" > diff --git a/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/file/noName.html b/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/file/noName.html index 1ec20af747..ef1c22dbbe 100644 --- a/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/file/noName.html +++ b/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/file/noName.html @@ -9,16 +9,18 @@ data-file-block="" >
-
diff --git a/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/image/noPreview.html b/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/image/noPreview.html index 59d65f82ae..d88b8e4aff 100644 --- a/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/image/noPreview.html +++ b/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/image/noPreview.html @@ -12,16 +12,18 @@ data-file-block="" >
-
diff --git a/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactFile/basic.html b/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactFile/basic.html index d7802da3e3..9c0362955d 100644 --- a/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactFile/basic.html +++ b/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactFile/basic.html @@ -10,16 +10,18 @@ data-file-block="" >
-
diff --git a/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactFile/nested.html b/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactFile/nested.html index c62486d27d..c78629be57 100644 --- a/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactFile/nested.html +++ b/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactFile/nested.html @@ -10,16 +10,18 @@ data-file-block="" >
-
@@ -35,16 +37,18 @@ data-file-block="" >
-
diff --git a/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactFile/noCaption.html b/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactFile/noCaption.html index 48340682e8..0324c05498 100644 --- a/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactFile/noCaption.html +++ b/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactFile/noCaption.html @@ -9,16 +9,18 @@ data-file-block="" > diff --git a/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactFile/noName.html b/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactFile/noName.html index 1ec20af747..ef1c22dbbe 100644 --- a/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactFile/noName.html +++ b/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactFile/noName.html @@ -9,16 +9,18 @@ data-file-block="" >
-
diff --git a/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactImage/noPreview.html b/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactImage/noPreview.html index 59d65f82ae..d88b8e4aff 100644 --- a/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactImage/noPreview.html +++ b/tests/src/unit/react/formatConversion/export/__snapshots__/blocknoteHTML/reactImage/noPreview.html @@ -12,16 +12,18 @@ data-file-block="" >
-