@portabletext/editor 0.0.0

package/src/utils/__tests__/dmpToOperations.test.ts

@@ -0,0 +1,181 @@
+import {describe, expect, test} from '@jest/globals'
+import {makeDiff, makePatches, stringifyPatches} from '@sanity/diff-match-patch'
+import {
+  isPortableTextSpan,
+  isPortableTextTextBlock,
+  type Path,
+  type PortableTextBlock,
+  type PortableTextSpan,
+  type PortableTextTextBlock,
+} from '@sanity/types'
+import {type Descendant, type Operation} from 'slate'
+
+import {type PortableTextSlateEditor} from '../../types/editor'
+import {type DiffMatchPatch} from '../../types/patch'
+import {diffMatchPatch} from '../applyPatch'
+
+describe('operationToPatches: diffMatchPatch', () => {
+  test.todo('skips patches for blocks that cannot be found locally')
+  test.todo('skips patches for non-PT-blocks')
+  test.todo('skips patches for non-spans')
+  test.todo('throws if cannot find span')
+
+  test('should apply the most basic additive operation correctly', () => {
+    const source = 'Hello'
+    const target = 'Hello there'
+    const patch = getPteDmpPatch(stringifyPatches(makePatches(makeDiff(source, target))))
+    const editor = getMockEditor({text: source})
+    expect(diffMatchPatch(editor, patch)).toBe(true)
+    expect(editor.getText()).toBe(target)
+  })
+
+  test('should apply the most basic removal operation correctly', () => {
+    const source = 'Hello there'
+    const target = 'Hello'
+    const patch = getPteDmpPatch(stringifyPatches(makePatches(makeDiff(source, target))))
+    const editor = getMockEditor({text: source})
+    expect(diffMatchPatch(editor, patch)).toBe(true)
+    expect(editor.getText()).toBe(target)
+  })
+
+  test('should treat equality as noops', () => {
+    const source = 'Hello'
+    const target = 'Hello'
+    const patch = getPteDmpPatch(stringifyPatches(makePatches(makeDiff(source, target))))
+    const editor = getMockEditor({text: source})
+    expect(diffMatchPatch(editor, patch)).toBe(true)
+    expect(editor.getText()).toBe(target)
+  })
+
+  test('should apply combined add + remove operations', () => {
+    const source = 'A quick brown fox jumps over the very lazy dog'
+    const target = 'The quick brown fox jumps over the lazy dog'
+    const patch = getPteDmpPatch(stringifyPatches(makePatches(makeDiff(source, target))))
+    const editor = getMockEditor({text: source})
+    expect(diffMatchPatch(editor, patch)).toBe(true)
+    expect(editor.getText()).toBe(target)
+  })
+
+  test('should apply combined add + remove operations', () => {
+    const source = 'Many quick brown fox jumps over the very lazy dog'
+    const target = 'The many, quick, brown, foxes jumps over all of the lazy dogs'
+    const patch = getPteDmpPatch(stringifyPatches(makePatches(makeDiff(source, target))))
+    const editor = getMockEditor({text: source})
+    expect(diffMatchPatch(editor, patch)).toBe(true)
+    expect(editor.getText()).toBe(target)
+  })
+
+  test('should apply reverse line edits correctly', () => {
+    const line1 = 'The quick brown fox jumps over the lazy dog'
+    const line2 = 'But the slow green frog jumps over the wild cat'
+    const source = [line1, line2, line1, line2].join('\n')
+    const target = [line2, line1, line2, line1].join('\n')
+    const patch = getPteDmpPatch(stringifyPatches(makePatches(makeDiff(source, target))))
+    const editor = getMockEditor({text: source})
+    expect(diffMatchPatch(editor, patch)).toBe(true)
+    expect(editor.getText()).toBe(target)
+  })
+
+  test('should apply larger text differences correctly', () => {
+    const source = `Portable Text is a agnostic abstraction of "rich text" that can be stringified into any markup language, for instance HTML, Markdown, SSML, XML, etc. It's designed to be efficient for collaboration, and makes it possible to enrich rich text with data structures in depth.\n\nPortable Text is built on the idea of rich text as an array of blocks, themselves arrays of children spans. Each block can have a style and a set of mark dfinitions, which describe data structures distributed on the children spans. Portable Text also allows for inserting arbitrary data objects in the array, only requiring _type-key. Portable Text also allows for custom objects in the root array, enabling rendering environments to mix rich text with custom content types.\n\nPortable Text is a combination of arrays and objects. In its simplest form it's an array of objects with an array of children. Some definitions: \n- Block: Typically recognized as a section of a text, e.g. a paragraph or a heading.\n- Span: Piece of text with a set of marks, e.g. bold or italic.\n- Mark: A mark is a data structure that can be appliad to a span, e.g. a link or a comment.\n- Mark definition: A mark definition is a structure that describes a mark, a link or a comment.`
+    const target = `Portable Text is an agnostic abstraction of rich text that can be serialized into pretty much any markup language, be it HTML, Markdown, SSML, XML, etc. It is designed to be efficient for real-time collaborative interfaces, and makes it possible to annotate rich text with additional data structures recursively.\n\nPortable Text is built on the idea of rich text as an array of blocks, themselves arrays of child spans. Each block can have a style and a set of mark definitions, which describe data structures that can be applied on the children spans. Portable Text also allows for inserting arbitrary data objects in the array, only requiring _type-key. Portable Text also allows for custom content objects in the root array, enabling editing- and rendering environments to mix rich text with custom content types.\n\nPortable Text is a recursive composition of arrays and objects. In its simplest form it's an array of objects of a type with an array of children. Some definitions: \n- Block: A block is what's typically recognized as a section of a text, e.g. a paragraph or a heading.\n- Span: A span is a piece of text with a set of marks, e.g. bold or italic.\n- Mark: A mark is a data structure that can be applied to a span, e.g. a link or a comment.\n- Mark definition: A mark definition is a data structure that describes a mark, e.g. a link or a comment.`
+    const patch = getPteDmpPatch(stringifyPatches(makePatches(makeDiff(source, target))))
+    const editor = getMockEditor({text: source})
+    expect(diffMatchPatch(editor, patch)).toBe(true)
+    expect(editor.getText()).toBe(target)
+  })
+
+  test('should apply offset text differences correctly', () => {
+    const source = `This string has changes, but they occur somewhere near the end. That means we need to use an offset to get at the change, we cannot just rely on equality segaments in the generated diff.`
+    const target = `This string has changes, but they occur somewhere near the end. That means we need to use an offset to get at the change, we cannot just rely on equality segments in the generated diff.`
+    const patch = getPteDmpPatch(stringifyPatches(makePatches(makeDiff(source, target))))
+    const editor = getMockEditor({text: source})
+    expect(diffMatchPatch(editor, patch)).toBe(true)
+    expect(editor.getText()).toBe(target)
+  })
+})
+
+function getPteDmpPatch(
+  value: string,
+  path: Path = [{_key: 'bA'}, 'children', {_key: 's1'}, 'text'],
+): DiffMatchPatch {
+  return {
+    type: 'diffMatchPatch',
+    path,
+    origin: 'remote',
+    value,
+  }
+}
+
+type MockEditorOptions = {children: PortableTextTextBlock[]} | {text: string}
+
+function getMockEditor(options: MockEditorOptions): Pick<
+  PortableTextSlateEditor,
+  'children' | 'isTextBlock' | 'apply' | 'selection' | 'onChange'
+> & {
+  getText: () => string
+} {
+  let children: PortableTextBlock[] = 'children' in options ? options.children : []
+  if (!('children' in options)) {
+    children = [
+      {
+        _type: 'block',
+        _key: 'bA',
+        children: [{_type: 'span', _key: 's1', text: 'text' in options ? options.text : ''}],
+        markDefs: [],
+      },
+    ]
+  }
+
+  function getText(blockKey?: string) {
+    return children
+      .filter((child): child is PortableTextTextBlock => isPortableTextTextBlock(child))
+      .filter((child) => (blockKey ? child._key === blockKey : true))
+      .flatMap((block) =>
+        block.children
+          .filter((span) => isPortableTextSpan(span))
+          .map((span) => span.text)
+          .join(''),
+      )
+      .join('\n\n')
+  }
+
+  function isTextBlock(value: unknown): value is PortableTextTextBlock {
+    return isPortableTextTextBlock(value)
+  }
+
+  function apply(operation: Operation): void {
+    if (operation.type !== 'insert_text' && operation.type !== 'remove_text') {
+      throw new Error(`Unexpected operation type ${operation.type}`)
+    }
+
+    // Forcing for tests, theoretically can target non-PT blocks
+    const ptBlocks = children as PortableTextTextBlock<PortableTextSpan>[]
+
+    const {type, path, offset, text} = operation
+    const [blockIndex, spanIndex] = path
+    const span = ptBlocks[blockIndex].children[spanIndex]
+    const current = span.text
+
+    if (type === 'insert_text') {
+      const before = current.slice(0, offset)
+      const after = current.slice(offset)
+      span.text = `${before}${text}${after}`
+    } else if (type === 'remove_text') {
+      const before = current.slice(0, offset)
+      const after = current.slice(offset + text.length)
+      span.text = `${before}${after}`
+    }
+  }
+
+  return {
+    selection: null,
+    getText,
+    children: children as Descendant[],
+    apply,
+    onChange: () => {
+      // NOOP
+    },
+    isTextBlock,
+  }
+}

package/src/utils/__tests__/operationToPatches.test.ts

@@ -0,0 +1,421 @@
+import {beforeEach, describe, expect, it} from '@jest/globals'
+import {type PortableTextTextBlock} from '@sanity/types'
+import {createEditor, type Descendant} from 'slate'
+
+import {PortableTextEditor, type PortableTextEditorProps} from '../..'
+import {schemaType} from '../../editor/__tests__/PortableTextEditorTester'
+import {defaultKeyGenerator} from '../../editor/hooks/usePortableTextEditorKeyGenerator'
+import {withPlugins} from '../../editor/plugins'
+import {getPortableTextMemberSchemaTypes} from '../getPortableTextMemberSchemaTypes'
+import {createOperationToPatches} from '../operationToPatches'
+
+const portableTextFeatures = getPortableTextMemberSchemaTypes(schemaType)
+
+const operationToPatches = createOperationToPatches(portableTextFeatures)
+
+const {editor} = withPlugins(createEditor(), {
+  portableTextEditor: new PortableTextEditor({schemaType} as PortableTextEditorProps),
+  keyGenerator: defaultKeyGenerator,
+  readOnly: false,
+})
+
+const createDefaultValue = () =>
+  [
+    {
+      _type: 'myTestBlockType',
+      _key: '1f2e64b47787',
+      style: 'normal',
+      markDefs: [],
+      children: [
+        {_type: 'span', _key: 'c130395c640c', text: '', marks: []},
+        {
+          _key: '773866318fa8',
+          _type: 'someObject',
+          value: {title: 'The Object'},
+          __inline: true,
+          children: [{_type: 'span', _key: 'bogus', text: '', marks: []}],
+        },
+        {_type: 'span', _key: 'fd9b4a4e6c0b', text: '', marks: []},
+      ],
+    },
+  ] as Descendant[]
+
+describe('operationToPatches', () => {
+  beforeEach(() => {
+    editor.children = createDefaultValue()
+    editor.onChange()
+  })
+
+  it('translates void items correctly when splitting spans', () => {
+    expect(
+      operationToPatches.splitNodePatch(
+        editor,
+        {
+          type: 'split_node',
+          path: [0, 0],
+          position: 0,
+          properties: {_type: 'span', _key: 'c130395c640c', marks: []},
+        },
+
+        createDefaultValue(),
+      ),
+    ).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "items": Array [
+            Object {
+              "_key": "773866318fa8",
+              "_type": "someObject",
+              "title": "The Object",
+            },
+          ],
+          "path": Array [
+            Object {
+              "_key": "1f2e64b47787",
+            },
+            "children",
+            Object {
+              "_key": "c130395c640c",
+            },
+          ],
+          "position": "after",
+          "type": "insert",
+        },
+        Object {
+          "path": Array [
+            Object {
+              "_key": "1f2e64b47787",
+            },
+            "children",
+            Object {
+              "_key": "c130395c640c",
+            },
+            "text",
+          ],
+          "type": "set",
+          "value": "",
+        },
+      ]
+    `)
+  })
+
+  it('produce correct insert block patch', () => {
+    expect(
+      operationToPatches.insertNodePatch(
+        editor,
+        {
+          type: 'insert_node',
+          path: [0],
+          node: {
+            _type: 'someObject',
+            _key: 'c130395c640c',
+            value: {title: 'The Object'},
+            __inline: false,
+            children: [{_key: '1', _type: 'span', text: '', marks: []}],
+          },
+        },
+        createDefaultValue(),
+      ),
+    ).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "items": Array [
+            Object {
+              "_key": "c130395c640c",
+              "_type": "someObject",
+              "title": "The Object",
+            },
+          ],
+          "path": Array [
+            Object {
+              "_key": "1f2e64b47787",
+            },
+          ],
+          "position": "before",
+          "type": "insert",
+        },
+      ]
+    `)
+  })
+
+  it('produce correct insert block patch with an empty editor', () => {
+    editor.children = []
+    editor.onChange()
+    expect(
+      operationToPatches.insertNodePatch(
+        editor,
+        {
+          type: 'insert_node',
+          path: [0],
+          node: {
+            _type: 'someObject',
+            _key: 'c130395c640c',
+            value: {},
+            __inline: false,
+            children: [{_key: '1', _type: 'span', text: '', marks: []}],
+          },
+        },
+
+        [],
+      ),
+    ).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "path": Array [],
+          "type": "setIfMissing",
+          "value": Array [],
+        },
+        Object {
+          "items": Array [
+            Object {
+              "_key": "c130395c640c",
+              "_type": "someObject",
+            },
+          ],
+          "path": Array [
+            0,
+          ],
+          "position": "before",
+          "type": "insert",
+        },
+      ]
+    `)
+  })
+
+  it('produce correct insert child patch', () => {
+    expect(
+      operationToPatches.insertNodePatch(
+        editor,
+        {
+          type: 'insert_node',
+          path: [0, 3],
+          node: {
+            _type: 'someObject',
+            _key: 'c130395c640c',
+            value: {title: 'The Object'},
+            __inline: true,
+            children: [{_key: '1', _type: 'span', text: '', marks: []}],
+          },
+        },
+
+        createDefaultValue(),
+      ),
+    ).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "items": Array [
+            Object {
+              "_key": "c130395c640c",
+              "_type": "someObject",
+              "title": "The Object",
+            },
+          ],
+          "path": Array [
+            Object {
+              "_key": "1f2e64b47787",
+            },
+            "children",
+            Object {
+              "_key": "fd9b4a4e6c0b",
+            },
+          ],
+          "position": "after",
+          "type": "insert",
+        },
+      ]
+    `)
+  })
+
+  it('produce correct insert text patch', () => {
+    ;(editor.children[0] as PortableTextTextBlock).children[2].text = '1'
+    editor.onChange()
+    expect(
+      operationToPatches.insertTextPatch(
+        editor,
+        {
+          type: 'insert_text',
+          path: [0, 2],
+          text: '1',
+          offset: 0,
+        },
+
+        createDefaultValue(),
+      ),
+    ).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "path": Array [
+            Object {
+              "_key": "1f2e64b47787",
+            },
+            "children",
+            Object {
+              "_key": "fd9b4a4e6c0b",
+            },
+            "text",
+          ],
+          "type": "diffMatchPatch",
+          "value": "@@ -0,0 +1 @@
+      +1
+      ",
+        },
+      ]
+    `)
+  })
+
+  it('produces correct remove text patch', () => {
+    const before = createDefaultValue()
+    ;(before[0] as PortableTextTextBlock).children[2].text = '1'
+    expect(
+      operationToPatches.removeTextPatch(
+        editor,
+        {
+          type: 'remove_text',
+          path: [0, 2],
+          text: '1',
+          offset: 1,
+        },
+
+        before,
+      ),
+    ).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "path": Array [
+            Object {
+              "_key": "1f2e64b47787",
+            },
+            "children",
+            Object {
+              "_key": "fd9b4a4e6c0b",
+            },
+            "text",
+          ],
+          "type": "diffMatchPatch",
+          "value": "@@ -1 +0,0 @@
+      -1
+      ",
+        },
+      ]
+    `)
+  })
+
+  it('produces correct remove child patch', () => {
+    expect(
+      operationToPatches.removeNodePatch(
+        editor,
+        {
+          type: 'remove_node',
+          path: [0, 1],
+          node: {
+            _key: '773866318fa8',
+            _type: 'someObject',
+            value: {title: 'The object'},
+            __inline: true,
+            children: [{_type: 'span', _key: 'bogus', text: '', marks: []}],
+          },
+        },
+
+        createDefaultValue(),
+      ),
+    ).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "path": Array [
+            Object {
+              "_key": "1f2e64b47787",
+            },
+            "children",
+            Object {
+              "_key": "773866318fa8",
+            },
+          ],
+          "type": "unset",
+        },
+      ]
+    `)
+  })
+
+  it('produce correct remove block patch', () => {
+    const val = createDefaultValue()
+    expect(
+      operationToPatches.removeNodePatch(
+        editor,
+        {
+          type: 'remove_node',
+          path: [0],
+          node: val[0],
+        },
+
+        val,
+      ),
+    ).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "path": Array [
+            Object {
+              "_key": "1f2e64b47787",
+            },
+          ],
+          "type": "unset",
+        },
+      ]
+    `)
+  })
+
+  it('produce correct merge node patch', () => {
+    const val = createDefaultValue()
+    ;(val[0] as PortableTextTextBlock).children.push({
+      _type: 'span',
+      _key: 'r4wr323432',
+      text: '1234',
+      marks: [],
+    })
+    const block = editor.children[0] as PortableTextTextBlock
+    block.children = block.children.splice(0, 3)
+    block.children[2].text = '1234'
+    editor.onChange()
+    expect(
+      operationToPatches.mergeNodePatch(
+        editor,
+        {
+          type: 'merge_node',
+          path: [0, 3],
+          position: 2,
+          properties: {text: '1234'},
+        },
+
+        val,
+      ),
+    ).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "path": Array [
+            Object {
+              "_key": "1f2e64b47787",
+            },
+            "children",
+            Object {
+              "_key": "fd9b4a4e6c0b",
+            },
+            "text",
+          ],
+          "type": "set",
+          "value": "1234",
+        },
+        Object {
+          "path": Array [
+            Object {
+              "_key": "1f2e64b47787",
+            },
+            "children",
+            Object {
+              "_key": "r4wr323432",
+            },
+          ],
+          "type": "unset",
+        },
+      ]
+    `)
+  })
+})