@sutrata/editor 0.1.1 → 0.1.2

package/tests/docx-importer.test.ts

@@ -1,160 +0,0 @@
-import { describe, it, expect } from 'vitest'
-import { parse } from '@sutrata/parser'
-import { exportToDocx } from '../src/file/docx-exporter'
-import { importDocx } from '../src/file/docx-importer'
-import JSZip from 'jszip'
-
-const testSutra = `---
-title: Test Movie
-author: Writer Name
----
-
-## Scene 1 {#1A}
-
-Action with **bold**, *italic*, and _underline_ text.
-
-@JOHN (V.O.)
-Hello Mary.
-
-@MARY
-(smiling)
-Hi John.
-
-@JOHN
-Dual dialogue left.
-
-@MARY ^
-Dual dialogue right.
-
->> CUT TO:
-
->> THE END <<
-
-~ La la la
-
-[[ Note text ]]
-
-<!-- Comment text -->
-
-===
-
-# A Section
-
-Final action line.
-`
-
-async function roundTrip(source: string) {
-  const ast = parse(source)
-  const blob = await exportToDocx(ast)
-  const buffer = await blob.arrayBuffer()
-  return importDocx(buffer)
-}
-
-describe('docx-importer', () => {
-  it('reconstructs the screenplay body from an exported docx', async () => {
-    const { bodyText, warnings } = await roundTrip(testSutra)
-    expect(bodyText).not.toBeNull()
-
-    // Reparse the reconstructed body (no frontmatter) and check it matches structurally.
-    const reparsed = parse(bodyText!)
-    const original = parse(testSutra)
-
-    expect(reparsed.children).toHaveLength(original.children.length)
-
-    const scene = reparsed.children[0]
-    expect(scene?.type).toBe('scene-heading')
-    if (scene?.type === 'scene-heading') {
-      expect(scene.text).toBe('SCENE 1')
-      expect(scene.id).toBe('1A')
-
-      const action = scene.children[0]
-      expect(action?.type).toBe('action')
-      if (action?.type === 'action') {
-        expect(action.spans).toEqual([
-          { type: 'text', text: 'Action with ' },
-          { type: 'bold', spans: [{ type: 'text', text: 'bold' }] },
-          { type: 'text', text: ', ' },
-          { type: 'italic', spans: [{ type: 'text', text: 'italic' }] },
-          { type: 'text', text: ', and ' },
-          { type: 'underline', spans: [{ type: 'text', text: 'underline' }] },
-          { type: 'text', text: ' text.' },
-        ])
-      }
-
-      const john = scene.children[1]
-      expect(john?.type).toBe('character')
-      if (john?.type === 'character') {
-        expect(john.name).toBe('JOHN')
-        expect(john.extension).toBe('(V.O.)')
-      }
-
-      const mary = scene.children[2]
-      expect(mary?.type).toBe('character')
-      if (mary?.type === 'character') {
-        expect(mary.children[0]).toMatchObject({ type: 'parenthetical', text: 'smiling' })
-      }
-
-      const dual = scene.children[3]
-      expect(dual?.type).toBe('dual-dialogue')
-      if (dual?.type === 'dual-dialogue') {
-        expect(dual.left.name).toBe('JOHN')
-        expect(dual.right.name).toBe('MARY')
-        expect(dual.right.isDual).toBe(true)
-      }
-
-      expect(scene.children[4]).toMatchObject({ type: 'transition', text: 'CUT TO:' })
-      expect(scene.children[5]).toMatchObject({ type: 'centered', text: 'THE END' })
-      expect(scene.children[6]).toMatchObject({ type: 'lyrics' })
-      expect(scene.children[7]).toMatchObject({ type: 'note', text: 'Note text' })
-      expect(scene.children[8]).toMatchObject({ type: 'comment', text: 'Comment text' })
-      expect(scene.children[9]).toMatchObject({ type: 'page-break' })
-    }
-
-    const section = reparsed.children[1]
-    expect(section?.type).toBe('section')
-    if (section?.type === 'section') {
-      expect(section.text).toBe('A Section')
-    }
-    expect(reparsed.children[2]).toMatchObject({ type: 'action' })
-
-    // Title page is intentionally not reimported.
-    expect(warnings.some(w => w.toLowerCase().includes('title page'))).toBe(true)
-  })
-
-  it('returns null bodyText and a warning for a non-Sutrata docx', async () => {
-    const ast = parse('---\ntitle: Empty\n---\n')
-    const blob = await exportToDocx(ast)
-    const buffer = await blob.arrayBuffer()
-    const { bodyText, warnings } = await importDocx(buffer)
-    expect(bodyText).toBeNull()
-    expect(warnings.length).toBeGreaterThan(0)
-  })
-
-  it('throws for a file that is not a docx', async () => {
-    const buffer = new TextEncoder().encode('not a docx').buffer
-    await expect(importDocx(buffer)).rejects.toThrow()
-  })
-
-  it('splits the scene id from the heading when Word normalizes the tab to <w:tab/>', async () => {
-    // docx.js (the exporter) writes a literal tab character inside <w:t>. Word, when it
-    // resaves the file, normalizes that into a <w:tab/> element instead — reproduce that
-    // shape directly rather than going through exportToDocx.
-    const documentXml = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
-<w:body>
-<w:p>
-<w:pPr><w:pStyle w:val="CineSceneHeading"/></w:pPr>
-<w:r><w:rPr><w:b/></w:rPr><w:t xml:space="preserve">EXT. ROAD-RAIN EFFECT - MORNING</w:t></w:r>
-<w:r><w:tab/></w:r>
-<w:r><w:rPr><w:b/></w:rPr><w:t xml:space="preserve">1A</w:t></w:r>
-</w:p>
-</w:body>
-</w:document>`
-    const zip = new JSZip()
-    zip.file('word/document.xml', documentXml)
-    const buffer = await zip.generateAsync({ type: 'arraybuffer' })
-
-    const { bodyText } = await importDocx(buffer)
-    expect(bodyText).toBe('## EXT. ROAD-RAIN EFFECT - MORNING {#1A}')
-  })
-})

package/tests/editor/character-decoration-plugin.test.ts

@@ -1,101 +0,0 @@
-import { describe, it, expect } from 'vitest'
-import { EditorState } from 'prosemirror-state'
-import { schema } from '../../src/editor/schema'
-import { createCharacterDecorationPlugin, findCharacterDecorationRanges } from '../../src/editor/character-decoration-plugin'
-
-describe('findCharacterDecorationRanges', () => {
-  it('finds a single trailing extension', () => {
-    const r = findCharacterDecorationRanges('ARAVIND (V.O.)')
-    expect(r).toEqual({ parenStart: 8, parenEnd: 14 })
-  })
-
-  it('finds multiple trailing paren groups as one range', () => {
-    const r = findCharacterDecorationRanges("ARAVIND (V.O.) (CONT'D)")
-    expect(r).toEqual({ parenStart: 8, parenEnd: 23 })
-  })
-
-  it('finds a trailing dual-dialogue marker alone', () => {
-    const r = findCharacterDecorationRanges('ARAVIND ^')
-    expect(r).toEqual({ dualStart: 8, dualEnd: 9 })
-  })
-
-  it('finds both an extension and a dual marker together', () => {
-    const r = findCharacterDecorationRanges('ARAVIND (V.O.) ^')
-    expect(r).toEqual({ parenStart: 8, parenEnd: 14, dualStart: 15, dualEnd: 16 })
-  })
-
-  it('finds nothing for a plain name', () => {
-    expect(findCharacterDecorationRanges('ARAVIND')).toEqual({})
-  })
-
-  it('finds nothing for an unclosed paren (still typing)', () => {
-    expect(findCharacterDecorationRanges('ARAVIND (')).toEqual({})
-  })
-})
-
-describe('character-decoration-plugin', () => {
-  function createStateWithPlugin(text: string) {
-    const plugin = createCharacterDecorationPlugin()
-    const state = EditorState.create({
-      doc: schema.node('doc', null, [schema.node('character', null, [schema.text(text)])]),
-      plugins: [plugin],
-    })
-    return { state, plugin }
-  }
-
-  it('decorates the trailing extension with cs-character-extension', () => {
-    const { state, plugin } = createStateWithPlugin('ARAVIND (V.O.)')
-    const decorations = plugin.getState(state)!.find()
-    const deco = decorations.find((d: any) => d.spec?.class === 'cs-character-extension')
-    expect(deco).toBeDefined()
-    // +1 for the block node's own opening position
-    expect(deco.from).toBe(1 + 8)
-    expect(deco.to).toBe(1 + 14)
-  })
-
-  it('decorates multiple trailing paren groups as one extension span', () => {
-    const { state, plugin } = createStateWithPlugin("ARAVIND (V.O.) (CONT'D)")
-    const decorations = plugin.getState(state)!.find()
-    const deco = decorations.find((d: any) => d.spec?.class === 'cs-character-extension')
-    expect(deco.from).toBe(1 + 8)
-    expect(deco.to).toBe(1 + 23)
-  })
-
-  it('decorates a trailing dual-dialogue marker with cs-character-dual-marker', () => {
-    const { state, plugin } = createStateWithPlugin('ARAVIND ^')
-    const decorations = plugin.getState(state)!.find()
-    const deco = decorations.find((d: any) => d.spec?.class === 'cs-character-dual-marker')
-    expect(deco).toBeDefined()
-  })
-
-  it('decorates both an extension and a dual marker on the same cue', () => {
-    const { state, plugin } = createStateWithPlugin('ARAVIND (V.O.) ^')
-    const decorations = plugin.getState(state)!.find()
-    expect(decorations.some((d: any) => d.spec?.class === 'cs-character-extension')).toBe(true)
-    expect(decorations.some((d: any) => d.spec?.class === 'cs-character-dual-marker')).toBe(true)
-  })
-
-  it('produces no decorations for a plain character name', () => {
-    const { state, plugin } = createStateWithPlugin('ARAVIND')
-    expect(plugin.getState(state)!.find()).toHaveLength(0)
-  })
-
-  it('does not decorate non-character blocks', () => {
-    const plugin = createCharacterDecorationPlugin()
-    const state = EditorState.create({
-      doc: schema.node('doc', null, [schema.node('action', null, [schema.text('Just an (aside) in action.')])]),
-      plugins: [plugin],
-    })
-    expect(plugin.getState(state)!.find()).toHaveLength(0)
-  })
-
-  it('recomputes decorations after a doc-changing transaction', () => {
-    const { state: initialState, plugin } = createStateWithPlugin('ARAVIND')
-    expect(plugin.getState(initialState)!.find()).toHaveLength(0)
-
-    const tr = initialState.tr.insertText(' (V.O.)', 8)
-    const newState = initialState.apply(tr)
-    const decorations = plugin.getState(newState)!.find()
-    expect(decorations.some((d: any) => d.spec?.class === 'cs-character-extension')).toBe(true)
-  })
-})

package/tests/editor/character-extension.test.ts

@@ -1,44 +0,0 @@
-import { describe, it, expect } from 'vitest'
-import { parse } from '@sutrata/parser'
-import { sutraToProsemirror } from '../../src/editor/sutra-to-prosemirror'
-import { prosemirrorToSutra } from '../../src/editor/prosemirror-to-sutra'
-
-function characterText(src: string): string {
-  const pmDoc = sutraToProsemirror(parse(src))
-  let text = ''
-  pmDoc.descendants(node => {
-    if (node.type.name === 'character') text = node.textContent
-  })
-  return text
-}
-
-describe('character extension/dual-marker — Sutra <-> ProseMirror bridge (text-based, no attrs)', () => {
-  it('puts the extension directly in the character node text, no separate attr', () => {
-    expect(characterText('## SC1\n\n@ARAVIND (V.O.)\nHello.\n')).toBe('ARAVIND (V.O.)')
-  })
-
-  it('handles multiple trailing paren groups', () => {
-    expect(characterText("## SC1\n\n@ARAVIND (V.O.) (CONT'D)\nHello.\n")).toBe("ARAVIND (V.O.) (CONT'D)")
-  })
-
-  it('handles a plain name with no extension', () => {
-    expect(characterText('## SC1\n\n@ARAVIND\nHello.\n')).toBe('ARAVIND')
-  })
-
-  it.each([
-    '@ARAVIND (V.O.)',
-    "@ARAVIND (V.O.) (CONT'D)",
-    '@ARAVIND',
-  ])('round-trips %s back to the exact source line', (cue) => {
-    const src = `## SC1\n\n${cue}\nHello.\n`
-    const out = prosemirrorToSutra(sutraToProsemirror(parse(src)))
-    expect(out).toContain(cue)
-  })
-
-  it('round-trips a dual-dialogue pair including the ^ marker and an extension', () => {
-    const src = "## SC1\n\n@ARAVIND (V.O.)\nHello.\n\n@MEERA ^\nHi.\n"
-    const out = prosemirrorToSutra(sutraToProsemirror(parse(src)))
-    expect(out).toContain('@ARAVIND (V.O.)')
-    expect(out).toContain('@MEERA ^')
-  })
-})

package/tests/editor/grapheme-cursor.test.ts

@@ -1,118 +0,0 @@
-import { describe, it, expect } from 'vitest'
-import { EditorState, TextSelection } from 'prosemirror-state'
-import { schema } from '../../src/editor/schema'
-import { moveByGrapheme, extendByGrapheme } from '../../src/editor/grapheme-cursor'
-
-/**
- * ProseMirror position layout for an action node containing text T (length n):
- *   pos 1  = action open  (= $cursor.start())
- *   pos 2  = first UTF-16 code unit of T
- *   ...
- *   pos 1+n = action close  (= $cursor.end())
- *
- * Each JS string character (UTF-16 code unit) takes exactly 1 PM position.
- * Surrogate pairs (emoji, etc.) each take 2 positions in PM.
- *
- * Cursor at pos 1 is before the very first character (the true block-start).
- * Cursor at pos 1+n is after the last character (the true block-end).
- */
-function makeState(text: string, cursorPos: number) {
-  const doc = schema.node('doc', null, [
-    schema.node('action', null, text ? [schema.text(text)] : []),
-  ])
-  const state = EditorState.create({ doc, schema })
-  return state.apply(
-    state.tr.setSelection(TextSelection.create(doc, cursorPos))
-  )
-}
-
-describe('grapheme-cursor', () => {
-  it('moveByGrapheme right advances over a single ASCII char', () => {
-    // 'ABC': pos 1=start, pos 2='A', pos 3='B', pos 4='C', pos 5=end
-    const state = makeState('ABC', 2) // cursor after 'A'... wait: pos 2 = after action_open = before 'A'?
-    // No: pos 1 = action_open = start(). pos 2 = position after first char 'A'.
-    // Actually: textBetween(1, 4) = 'ABC' → positions 1..4 map to chars A,B,C.
-    // So pos 1 is before 'A', pos 2 is between 'A' and 'B', pos 3 is between 'B' and 'C', pos 4 is after 'C'.
-    // Cursor at pos 1: textBetween(1, 4) = 'ABC', first grapheme 'A' (len 1) → advance to pos 2.
-    // Cursor at pos 2: textBetween(2, 4) = 'BC', first grapheme 'B' → advance to pos 3. ✓
-    let dispatched: any = null
-    moveByGrapheme('right')(state, (tr) => { dispatched = tr })
-    expect(dispatched).not.toBeNull()
-    const sel = dispatched.selection as TextSelection
-    expect(sel.$cursor?.pos).toBe(3) // 'B' is next, advance by 1
-  })
-
-  it('moveByGrapheme right advances over the first grapheme in a Tamil sequence', () => {
-    // 'க்ஷ' = U+0B95 U+0BCD U+0BB7 (3 BMP chars, 3 PM positions)
-    // Node.js ICU segments 'க்ஷA' as ['க்'(len 2), 'ஷ'(len 1), 'A'(len 1)]
-    // Cursor at pos 1 (block start, before 'க'): textBetween(1, 5) = 'க்ஷA'
-    // First grapheme 'க்' has length 2 → cursor advances to pos 3.
-    const cluster = 'க்ஷ'
-    expect(cluster.length).toBe(3) // 3 UTF-16 code units
-    const state = makeState(cluster + 'A', 1) // cursor at block start, before 'க'
-    let dispatched: any = null
-    moveByGrapheme('right')(state, (tr) => { dispatched = tr })
-    expect(dispatched).not.toBeNull()
-    const sel = dispatched.selection as TextSelection
-    // Advances by 2 (length of first grapheme 'க்'), not by 1 (single codepoint)
-    expect(sel.$cursor?.pos).toBe(3)
-  })
-
-  it('moveByGrapheme left retreats over a Tamil grapheme cluster', () => {
-    // 'Aக்ஷ': pos 1=start, pos 2='A', pos 3='க', pos 4='்', pos 5='ஷ', end()=5
-    // Cursor at pos 4 (after 'A','க','்'): textBetween(1, 4) = 'Aக்'
-    // graphemes of 'Aக்' = ['A', 'க்'] → last grapheme 'க்' (len 2) → retreat by 2 → pos 2
-    const cluster = 'க்ஷ'
-    const state = makeState('A' + cluster, 4) // cursor after 'க்'
-    let dispatched: any = null
-    moveByGrapheme('left')(state, (tr) => { dispatched = tr })
-    expect(dispatched).not.toBeNull()
-    const sel = dispatched.selection as TextSelection
-    // Retreats by 2 (length of 'க்'), landing before 'க'
-    expect(sel.$cursor?.pos).toBe(2)
-  })
-
-  it('moveByGrapheme right advances over emoji ZWJ sequence as one grapheme', () => {
-    // '👨‍👩‍👧' is a family ZWJ emoji — 1 grapheme cluster, 8 UTF-16 code units = 8 PM positions
-    // Cursor at pos 1 (block start): textBetween(1, 9) = emoji string (length 8)
-    // Intl.Segmenter gives 1 grapheme of length 8 → advance by 8 → pos 9
-    const emoji = '👨‍👩‍👧'
-    expect(emoji.length).toBe(8) // 8 UTF-16 code units
-    const state = makeState(emoji, 1) // cursor at block start, before emoji
-    let dispatched: any = null
-    moveByGrapheme('right')(state, (tr) => { dispatched = tr })
-    expect(dispatched).not.toBeNull()
-    const sel = dispatched.selection as TextSelection
-    // Should advance by 8 (full emoji = single grapheme)
-    expect(sel.$cursor?.pos).toBe(1 + emoji.length) // 9
-  })
-
-  it('moveByGrapheme right returns false at end of block', () => {
-    // 'A': start()=1, end()=2. Cursor at pos 2 (after 'A') → pos(2) >= end(2) → false
-    const state = makeState('A', 2) // cursor after 'A', at block end
-    const result = moveByGrapheme('right')(state, () => {})
-    expect(result).toBe(false)
-  })
-
-  it('moveByGrapheme left returns false at start of block', () => {
-    // start() = 1 for any inline content. Cursor at pos 1 → pos(1) <= start(1) → false
-    const state = makeState('A', 1) // cursor at block start
-    const result = moveByGrapheme('left')(state, () => {})
-    expect(result).toBe(false)
-  })
-
-  it('extendByGrapheme right extends selection over first Tamil grapheme', () => {
-    // 'க்ஷ': cursor at pos 1 (before 'க')
-    // textBetween(head=1, end=4) = 'க்ஷ'
-    // graphemes ['க்','ஷ'] → first='க்' (len 2) → head goes to 1+2=3
-    // anchor stays at 1
-    const cluster = 'க்ஷ'
-    const state = makeState(cluster, 1) // cursor at block start
-    let dispatched: any = null
-    extendByGrapheme('right')(state, (tr) => { dispatched = tr })
-    expect(dispatched).not.toBeNull()
-    const sel = dispatched.selection as TextSelection
-    expect(sel.head).toBe(3)   // extended by 2 (first grapheme 'க்')
-    expect(sel.anchor).toBe(1) // anchor unchanged
-  })
-})

package/tests/editor/ime-plugin.test.ts

@@ -1,72 +0,0 @@
-import { describe, it, expect, beforeEach, vi } from 'vitest'
-import { EditorState } from 'prosemirror-state'
-import { schema } from '../../src/editor/schema'
-import { createImePlugin, isComposing } from '../../src/editor/ime-plugin'
-
-// Minimal EditorView mock — only needs dom + dispatch + state
-function makeMockView(dom?: HTMLElement) {
-  const el = dom ?? document.createElement('div')
-  document.body.appendChild(el)
-  return {
-    dom: el,
-    dispatch: vi.fn(),
-    state: EditorState.create({ schema, plugins: [] }),
-  }
-}
-
-describe('ime-plugin', () => {
-  it('exports createImePlugin and isComposing', () => {
-    expect(typeof createImePlugin).toBe('function')
-    expect(typeof isComposing).toBe('function')
-  })
-
-  it('isComposing returns false when no composition active', () => {
-    expect(isComposing()).toBe(false)
-  })
-
-  it('plugin view attaches compositionstart/end listeners to dom', () => {
-    const dom = document.createElement('div')
-    const addSpy = vi.spyOn(dom, 'addEventListener')
-    const mockView = { ...makeMockView(dom), dom } as any
-    const plugin = createImePlugin()
-    plugin.spec.view!(mockView)
-
-    expect(addSpy).toHaveBeenCalledWith('compositionstart', expect.any(Function))
-    expect(addSpy).toHaveBeenCalledWith('compositionend', expect.any(Function))
-  })
-
-  it('plugin view removes listeners on destroy', () => {
-    const dom = document.createElement('div')
-    const removeSpy = vi.spyOn(dom, 'removeEventListener')
-    const mockView = { ...makeMockView(dom), dom } as any
-    const plugin = createImePlugin()
-    const view = plugin.spec.view!(mockView)
-
-    view!.destroy!()
-
-    expect(removeSpy).toHaveBeenCalledWith('compositionstart', expect.any(Function))
-    expect(removeSpy).toHaveBeenCalledWith('compositionend', expect.any(Function))
-  })
-
-  it('compositionstart sets composing = true', () => {
-    const dom = document.createElement('div')
-    const mockView = { ...makeMockView(dom), dom } as any
-    const plugin = createImePlugin()
-    const pluginView = plugin.spec.view!(mockView) as any
-
-    dom.dispatchEvent(new Event('compositionstart'))
-    expect(pluginView.isComposing()).toBe(true)
-  })
-
-  it('compositionend sets composing = false', () => {
-    const dom = document.createElement('div')
-    const mockView = { ...makeMockView(dom), dom } as any
-    const plugin = createImePlugin()
-    const pluginView = plugin.spec.view!(mockView) as any
-
-    dom.dispatchEvent(new Event('compositionstart'))
-    expect(pluginView.isComposing()).toBe(true)
-    dom.dispatchEvent(new Event('compositionend'))
-    expect(pluginView.isComposing()).toBe(false)
-  })
-})

package/tests/editor/inline-note-bridge.test.ts

@@ -1,32 +0,0 @@
-import { describe, it, expect } from 'vitest'
-import { parse } from '@sutrata/parser'
-import { sutraToProsemirror } from '../../src/editor/sutra-to-prosemirror'
-import { prosemirrorToSutra } from '../../src/editor/prosemirror-to-sutra'
-import { schema } from '../../src/editor/schema'
-
-describe('inline [[ ]] note — Sutra <-> ProseMirror bridge', () => {
-  it('carries the note_mark on the bracketed text when converting Sutra to ProseMirror', () => {
-    const src = "## SC1\n\nThere's no next train. [[दर्शक को यहीं पता चलना चाहिए]]\n"
-    const ast = parse(src)
-    const pmDoc = sutraToProsemirror(ast)
-
-    let found: { text: string | null; hasMark: boolean } | null = null
-    pmDoc.descendants(node => {
-      if (node.isText && node.text?.includes('दर्शक')) {
-        found = { text: node.text, hasMark: !!node.marks.find(m => m.type === schema.marks['note_mark']) }
-      }
-    })
-
-    expect(found).not.toBeNull()
-    expect(found!.hasMark).toBe(true)
-  })
-
-  it('round-trips the note back into [[ ]] brackets when converting ProseMirror to Sutra', () => {
-    const src = "## SC1\n\nThere's no next train. [[दर्शक को यहीं पता चलना चाहिए]]\n"
-    const ast = parse(src)
-    const pmDoc = sutraToProsemirror(ast)
-    const out = prosemirrorToSutra(pmDoc)
-
-    expect(out).toContain('[[दर्शक को यहीं पता चलना चाहिए]]')
-  })
-})