@uniweb/content-writer 0.1.1

package/tests/plain-text.test.js

@@ -0,0 +1,218 @@
+import { docToPlainText } from '../src/plain-text.js'
+
+describe('docToPlainText', () => {
+  test('returns empty string for null/undefined/empty', () => {
+    expect(docToPlainText(null)).toBe('')
+    expect(docToPlainText(undefined)).toBe('')
+    expect(docToPlainText({})).toBe('')
+    expect(docToPlainText({ type: 'doc' })).toBe('')
+    expect(docToPlainText({ type: 'doc', content: [] })).toBe('')
+  })
+
+  test('extracts heading text without # prefix', () => {
+    const doc = {
+      type: 'doc',
+      content: [
+        { type: 'heading', attrs: { level: 1 }, content: [{ type: 'text', text: 'Hello World' }] },
+        { type: 'heading', attrs: { level: 2 }, content: [{ type: 'text', text: 'Subtitle' }] }
+      ]
+    }
+    expect(docToPlainText(doc)).toBe('Hello World\n\nSubtitle')
+  })
+
+  test('extracts paragraph text', () => {
+    const doc = {
+      type: 'doc',
+      content: [
+        { type: 'paragraph', content: [{ type: 'text', text: 'First paragraph.' }] },
+        { type: 'paragraph', content: [{ type: 'text', text: 'Second paragraph.' }] }
+      ]
+    }
+    expect(docToPlainText(doc)).toBe('First paragraph.\n\nSecond paragraph.')
+  })
+
+  test('strips bold/italic/code marks', () => {
+    const doc = {
+      type: 'doc',
+      content: [{
+        type: 'paragraph',
+        content: [
+          { type: 'text', text: 'Some ' },
+          { type: 'text', text: 'bold', marks: [{ type: 'bold' }] },
+          { type: 'text', text: ' and ' },
+          { type: 'text', text: 'italic', marks: [{ type: 'italic' }] },
+          { type: 'text', text: ' and ' },
+          { type: 'text', text: 'code', marks: [{ type: 'code' }] },
+          { type: 'text', text: ' text' }
+        ]
+      }]
+    }
+    expect(docToPlainText(doc)).toBe('Some bold and italic and code text')
+  })
+
+  test('strips link marks, keeping link text', () => {
+    const doc = {
+      type: 'doc',
+      content: [{
+        type: 'paragraph',
+        content: [
+          { type: 'text', text: 'Click ' },
+          { type: 'text', text: 'here', marks: [{ type: 'link', attrs: { href: 'https://example.com' } }] },
+          { type: 'text', text: ' for more.' }
+        ]
+      }]
+    }
+    expect(docToPlainText(doc)).toBe('Click here for more.')
+  })
+
+  test('extracts list item text without bullet/number prefixes', () => {
+    const doc = {
+      type: 'doc',
+      content: [{
+        type: 'bulletList',
+        content: [
+          { type: 'listItem', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'First item' }] }] },
+          { type: 'listItem', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'Second item' }] }] }
+        ]
+      }]
+    }
+    expect(docToPlainText(doc)).toBe('First item\nSecond item')
+  })
+
+  test('extracts ordered list text without number prefixes', () => {
+    const doc = {
+      type: 'doc',
+      content: [{
+        type: 'orderedList',
+        attrs: { start: 1 },
+        content: [
+          { type: 'listItem', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'Step one' }] }] },
+          { type: 'listItem', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'Step two' }] }] }
+        ]
+      }]
+    }
+    expect(docToPlainText(doc)).toBe('Step one\nStep two')
+  })
+
+  test('extracts nested list text', () => {
+    const doc = {
+      type: 'doc',
+      content: [{
+        type: 'bulletList',
+        content: [{
+          type: 'listItem',
+          content: [
+            { type: 'paragraph', content: [{ type: 'text', text: 'Parent' }] },
+            {
+              type: 'bulletList',
+              content: [
+                { type: 'listItem', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'Child' }] }] }
+              ]
+            }
+          ]
+        }]
+      }]
+    }
+    expect(docToPlainText(doc)).toBe('Parent\nChild')
+  })
+
+  test('extracts code block content', () => {
+    const doc = {
+      type: 'doc',
+      content: [{
+        type: 'codeBlock',
+        attrs: { language: 'js' },
+        content: [{ type: 'text', text: 'const x = 1' }]
+      }]
+    }
+    expect(docToPlainText(doc)).toBe('const x = 1')
+  })
+
+  test('extracts blockquote text', () => {
+    const doc = {
+      type: 'doc',
+      content: [{
+        type: 'blockquote',
+        content: [
+          { type: 'paragraph', content: [{ type: 'text', text: 'Quoted text' }] }
+        ]
+      }]
+    }
+    expect(docToPlainText(doc)).toBe('Quoted text')
+  })
+
+  test('extracts table cell text', () => {
+    const doc = {
+      type: 'doc',
+      content: [{
+        type: 'table',
+        content: [
+          {
+            type: 'tableRow',
+            content: [
+              { type: 'tableCell', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'Name' }] }] },
+              { type: 'tableCell', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'Age' }] }] }
+            ]
+          },
+          {
+            type: 'tableRow',
+            content: [
+              { type: 'tableCell', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'Alice' }] }] },
+              { type: 'tableCell', content: [{ type: 'paragraph', content: [{ type: 'text', text: '30' }] }] }
+            ]
+          }
+        ]
+      }]
+    }
+    expect(docToPlainText(doc)).toBe('Name Age\nAlice 30')
+  })
+
+  test('skips images, dividers, inset refs, and data blocks', () => {
+    const doc = {
+      type: 'doc',
+      content: [
+        { type: 'paragraph', content: [{ type: 'text', text: 'Before' }] },
+        { type: 'image', attrs: { src: 'photo.jpg' } },
+        { type: 'divider' },
+        { type: 'inset_ref', attrs: { component: 'Chart' } },
+        { type: 'dataBlock', attrs: { tag: 'items', data: [] } },
+        { type: 'paragraph', content: [{ type: 'text', text: 'After' }] }
+      ]
+    }
+    expect(docToPlainText(doc)).toBe('Before\n\nAfter')
+  })
+
+  test('skips inline images within paragraphs', () => {
+    const doc = {
+      type: 'doc',
+      content: [{
+        type: 'paragraph',
+        content: [
+          { type: 'text', text: 'Text with ' },
+          { type: 'image', attrs: { src: 'icon.svg', library: 'lu', name: 'star' } },
+          { type: 'text', text: ' icon' }
+        ]
+      }]
+    }
+    expect(docToPlainText(doc)).toBe('Text with  icon')
+  })
+
+  test('handles mixed content document', () => {
+    const doc = {
+      type: 'doc',
+      content: [
+        { type: 'heading', attrs: { level: 1 }, content: [{ type: 'text', text: 'Title' }] },
+        { type: 'paragraph', content: [{ type: 'text', text: 'Introduction.' }] },
+        {
+          type: 'bulletList',
+          content: [
+            { type: 'listItem', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'Point A' }] }] },
+            { type: 'listItem', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'Point B' }] }] }
+          ]
+        },
+        { type: 'paragraph', content: [{ type: 'text', text: 'Conclusion.' }] }
+      ]
+    }
+    expect(docToPlainText(doc)).toBe('Title\n\nIntroduction.\n\nPoint A\nPoint B\n\nConclusion.')
+  })
+})

package/tests/roundtrip.test.js

@@ -0,0 +1,307 @@
+/**
+ * Round-trip tests: markdown → content-reader → content-writer → content-reader
+ *
+ * Verifies that ProseMirror documents survive the round trip without
+ * information loss. Output markdown may differ in formatting (whitespace,
+ * attribute order) but must parse to the same ProseMirror structure.
+ */
+
+import { markdownToProseMirror } from '@uniweb/content-reader'
+import { proseMirrorToMarkdown } from '../src/index.js'
+
+/**
+ * Test that markdown survives a round trip through reader → writer → reader.
+ * Compares ProseMirror documents, not markdown strings.
+ */
+function testRoundTrip(markdown, description) {
+  test(description || markdown.trim().slice(0, 60), () => {
+    const parsed = markdownToProseMirror(markdown)
+    const serialized = proseMirrorToMarkdown(parsed)
+    const reparsed = markdownToProseMirror(serialized)
+    expect(reparsed).toEqual(parsed)
+  })
+}
+
+describe('Round-trip: Basic Formatting', () => {
+  testRoundTrip('Hello world', 'plain text')
+
+  testRoundTrip(
+    `text with 'single', "double", & specials`,
+    'special characters'
+  )
+
+  testRoundTrip(
+    'Some **bold** and *italic* text',
+    'bold and italic'
+  )
+
+  testRoundTrip(
+    '***bold italic both***',
+    'triple bold italic'
+  )
+
+  testRoundTrip(
+    '# Main Title\n\n## Subtitle',
+    'headings'
+  )
+
+  testRoundTrip(
+    'Text\n\n---\n\nMore text',
+    'dividers'
+  )
+})
+
+describe('Round-trip: Links', () => {
+  testRoundTrip(
+    '[Link text](https://example.com "Title")',
+    'link with title'
+  )
+
+  testRoundTrip(
+    '[Link](https://example.com)',
+    'link without title'
+  )
+
+  testRoundTrip(
+    '[External Link](https://example.com){target=_blank rel="noopener noreferrer"}',
+    'link with attributes'
+  )
+
+  testRoundTrip(
+    '[Download PDF](./document.pdf){download}',
+    'download link (boolean)'
+  )
+
+  testRoundTrip(
+    '[Get Report](./data.pdf){download="annual-report.pdf"}',
+    'download link with filename'
+  )
+})
+
+describe('Round-trip: Buttons', () => {
+  testRoundTrip(
+    '[Button Text](button:https://example.com)',
+    'basic button'
+  )
+
+  // Note: .button class syntax round-trips to button: prefix (both are equivalent)
+  test('button with variant and size', () => {
+    // .button class → button: prefix is expected normalization
+    const markdown = '[Get Started](https://example.com){.button variant=secondary size=lg}'
+    const parsed = markdownToProseMirror(markdown)
+    const serialized = proseMirrorToMarkdown(parsed)
+    const reparsed = markdownToProseMirror(serialized)
+    expect(reparsed).toEqual(parsed)
+  })
+
+  test('button with icon', () => {
+    const markdown = '[Learn More](https://example.com){.button icon=arrow-right}'
+    const parsed = markdownToProseMirror(markdown)
+    const serialized = proseMirrorToMarkdown(parsed)
+    const reparsed = markdownToProseMirror(serialized)
+    expect(reparsed).toEqual(parsed)
+  })
+})
+
+describe('Round-trip: Images', () => {
+  testRoundTrip(
+    '![Alt Text](path/to/image.svg)',
+    'basic image'
+  )
+
+  testRoundTrip(
+    '![Alt Text](https://test.com)',
+    'image with URL'
+  )
+
+  testRoundTrip(
+    '![Hero Image](./hero.jpg){role=hero}',
+    'image with role'
+  )
+
+  testRoundTrip(
+    '![Photo](./photo.jpg "A beautiful photo"){width=800 height=600 loading=lazy}',
+    'image with caption and attributes'
+  )
+
+  testRoundTrip(
+    '![Logo](./logo.svg){.featured #main-logo}',
+    'image with class and id'
+  )
+
+  testRoundTrip(
+    '![Gallery](./photo.jpg){.featured .rounded .shadow}',
+    'image with multiple classes'
+  )
+
+  testRoundTrip(
+    '![Background](./bg.jpg){fit=cover position=center}',
+    'image with fit and position'
+  )
+})
+
+describe('Round-trip: Video and PDF', () => {
+  testRoundTrip(
+    '![Intro Video](./intro.mp4){role=video poster=./poster.jpg autoplay muted loop}',
+    'video with attributes'
+  )
+
+  testRoundTrip(
+    '![Demo Video](./demo.mp4){role=video controls muted}',
+    'video with controls'
+  )
+
+  testRoundTrip(
+    '![User Guide](./guide.pdf){role=pdf preview=./guide-preview.jpg}',
+    'PDF with preview'
+  )
+})
+
+describe('Round-trip: Icons', () => {
+  testRoundTrip(
+    '![](lu-home)',
+    'icon dash format'
+  )
+
+  testRoundTrip(
+    '![](lu-home) [Sports](/sports)',
+    'icon with adjacent link'
+  )
+
+  test('icon colon format normalizes to dash format', () => {
+    // lu:home → lu-home is expected normalization
+    const markdown = '![](lu:home)'
+    const parsed = markdownToProseMirror(markdown)
+    const serialized = proseMirrorToMarkdown(parsed)
+    expect(serialized).toBe('![](lu-home)')
+    const reparsed = markdownToProseMirror(serialized)
+    expect(reparsed).toEqual(parsed)
+  })
+})
+
+describe('Round-trip: Spans', () => {
+  testRoundTrip(
+    'This is [highlighted text]{.highlight} in a sentence.',
+    'span with class'
+  )
+
+  testRoundTrip(
+    '[important note]{.callout .bold}',
+    'span with multiple classes'
+  )
+
+  testRoundTrip(
+    '[key term]{.highlight #glossary-term}',
+    'span with id and class'
+  )
+
+  testRoundTrip(
+    '[tooltip text]{.info data-tooltip="More info"}',
+    'span with custom attributes'
+  )
+
+  testRoundTrip(
+    '[first]{.highlight} normal [second]{.muted}',
+    'multiple spans'
+  )
+
+  testRoundTrip(
+    '[Link](https://example.com) and [span]{.highlight}',
+    'link and span in same paragraph'
+  )
+})
+
+describe('Round-trip: Component References', () => {
+  testRoundTrip(
+    '![](@Hero)',
+    'bare component ref'
+  )
+
+  testRoundTrip(
+    '![Architecture diagram](@NetworkDiagram){variant=compact size=lg}',
+    'component ref with alt and params'
+  )
+
+  testRoundTrip(
+    '![](@Widget)\n\n![](@Chart)',
+    'multiple component refs'
+  )
+})
+
+describe('Round-trip: Code', () => {
+  testRoundTrip(
+    '```javascript\nconst x = 1;\nconsole.log(\'x:\', x);\n```',
+    'fenced code block'
+  )
+
+  testRoundTrip(
+    '```\nline 1\n\nline 2\n```',
+    'code block without language'
+  )
+
+  testRoundTrip(
+    'Use the `console.log(\'test\')` function.',
+    'inline code'
+  )
+
+  testRoundTrip(
+    '```json:nav-links\n[{"label": "Home"}]\n```',
+    'tagged data block'
+  )
+})
+
+describe('Round-trip: Lists', () => {
+  testRoundTrip(
+    '- First item\n- Second item\n- Third item',
+    'bullet list'
+  )
+
+  testRoundTrip(
+    '1. First item\n2. Second item\n3. Third item',
+    'ordered list'
+  )
+
+  testRoundTrip(
+    '- First item\n  - Nested item 1\n  - Nested item 2\n- Second item\n  1. Nested ordered 1\n  2. Nested ordered 2',
+    'nested lists'
+  )
+
+  testRoundTrip(
+    '- Item with **bold** text\n- Item with *italic* text\n- Item with [link](https://example.com)',
+    'list items with formatted text'
+  )
+})
+
+describe('Round-trip: Tables', () => {
+  testRoundTrip(
+    '| Column 1 | Column 2 |\n|----------|----------|\n| Cell 1   | Cell 2   |\n| Cell 3   | Cell 4   |',
+    'basic table'
+  )
+
+  testRoundTrip(
+    '| Left | Center | Right |\n|:-----|:------:|------:|\n| 1    |   2    |     3 |',
+    'table with alignments'
+  )
+
+  testRoundTrip(
+    '| Style | Example |\n|-------|--------|\n| Bold | **text** |\n| Link | [link](https://example.com) |',
+    'table with formatted content'
+  )
+})
+
+describe('Round-trip: Mixed Content', () => {
+  testRoundTrip(
+    '# Title\n\nSome text with **bold** and *italic*.\n\n---\n\n![Image](./photo.jpg)\n\nMore text.',
+    'mixed content document'
+  )
+
+  test('paragraph with extracted image', () => {
+    // "Text ![img](src) more" → reader extracts image to block level
+    // Writer must handle the extracted structure correctly
+    const markdown = 'Some text before\n\n![Widget](./widget.png)\n\nand after'
+    const parsed = markdownToProseMirror(markdown)
+    const serialized = proseMirrorToMarkdown(parsed)
+    const reparsed = markdownToProseMirror(serialized)
+    expect(reparsed).toEqual(parsed)
+  })
+})