before
${inner}after
`; +describe("htmlToMarkdown — custom nodes are preserved losslessly (#206 mdrt-2)", () => { + const wrap = (inner: string) => `before
${inner}after
`; - it("CURRENTLY drops a pageBreak entirely (data loss)", () => { + it("preserves a pageBreak block on Markdown export", () => { const md = htmlToMarkdown( wrap(''), ); - // The page break vanishes: only the two paragraphs remain, nothing between. expect(md).toContain("before"); expect(md).toContain("after"); - expect(md).not.toMatch(/page-?break/i); - expect(md).not.toContain("---"); // not even a horizontal-rule fallback + // The break survives as an inert raw-HTML tag, not silently dropped. + expect(md).toMatch(/data-type="pageBreak"/); + expect(md).toMatch(/page-?break/i); }); - it("CURRENTLY drops a transclusionReference entirely (data loss)", () => { + it("preserves a transclusionReference's identity on Markdown export", () => { const md = htmlToMarkdown( wrap(''), ); expect(md).toContain("before"); expect(md).toContain("after"); - // The data-id (the only thing that gives the reference identity) is gone. - expect(md).not.toContain("abc"); + // The data-id (the only thing that gives the reference identity) survives. + expect(md).toContain("abc"); + expect(md).toMatch(/data-type="transclusionReference"/); }); - it.fails( - "should NOT lose a pageBreak block on Markdown export", - () => { + it("preserves a mention's data-id (stable identity) on Markdown export", () => { + const md = htmlToMarkdown( + 'hi @Bob there
', + ); + // The mention keeps its stable identity (data-id), not just the text. + expect(md).toContain("u1"); + expect(md).toContain("Bob"); + expect(md).toMatch(/data-type="mention"/); + }); + + it("preserves a status chip's color on Markdown export", () => { + const md = htmlToMarkdown( + 's Done
', + ); + // The chip's color (its identity) survives, not just the visible text. + expect(md).toContain("green"); + expect(md).toContain("Done"); + expect(md).toMatch(/data-type="status"/); + }); + + // The export form is only lossless if the import path can rebuild it. These + // assert the full MD -> HTML round-trip restores the node + its attributes, + // which is the marker <-> node contract each `parseHTML` relies on. + describe("import round-trip (markdownToHtml restores the node)", () => { + it("round-trips a pageBreak through export + import", async () => { const md = htmlToMarkdown( wrap(''), ); - // Desired: the break survives in some form (e.g. a `---` rule or marker). - expect(md).toMatch(/(-{3,}|page-?break)/i); - }, - ); + const html = await markdownToHtml(md); + expect(html).toMatch(/hi @Bob there
', ); - // Desired: the mention keeps its stable identity (data-id), not just text. - expect(md).toContain("u1"); - }, - ); + const html = await markdownToHtml(md); + expect(html).toMatch(/s Done
', + ); + const html = await markdownToHtml(md); + expect(html).toMatch(/hi @A & <B> "C" there
`, + ); + + // (a) The exported Markdown carries a WELL-FORMED, correctly-escaped tag: + // the attribute escapes `&`, `<`, `>` AND `"`; the text escapes `&`, `<`, + // `>` (a `"` inside text content is legal, so it stays literal). + expect(md).toContain('data-label="A & <B> "C""'); + expect(md).toContain('>@A & <B> "C"'); + // And explicitly NOT the raw, tag-corrupting forms: a literal `` (would + // mean `<`/`>` escaping was dropped in either the attr or the text)... + expect(md).not.toContain(""); + // ...nor the malformed attribute that an unescaped `"` would produce. + expect(md).not.toContain('data-label="A & <B> "C""'); + + // (b) Import restores the ORIGINAL (unescaped) values, attribute and text. + const html = await markdownToHtml(md); + const dom = new DOMParser().parseFromString(html as string, "text/html"); + const span = dom.querySelector('span[data-type="mention"]'); + expect(span).not.toBeNull(); + expect(span!.getAttribute("data-id")).toBe("u1"); + expect(span!.getAttribute("data-label")).toBe('A & "C"'); + expect(span!.textContent).toBe('@A & "C"'); + }); + }); }); diff --git a/packages/editor-ext/src/lib/markdown/utils/turndown.utils.ts b/packages/editor-ext/src/lib/markdown/utils/turndown.utils.ts index 172786a3..6bb8e456 100644 --- a/packages/editor-ext/src/lib/markdown/utils/turndown.utils.ts +++ b/packages/editor-ext/src/lib/markdown/utils/turndown.utils.ts @@ -43,6 +43,54 @@ function fillEmptyFootnoteRefs(html: string): string { ); } +/** + * `pageBreak` and `transclusionReference` are childless atom