@portabletext/editor 3.3.2 → 3.3.4

package/src/internal-utils/operation-to-patches.ts

@@ -1,571 +0,0 @@
-import {
-  diffMatchPatch,
-  insert,
-  set,
-  setIfMissing,
-  unset,
-  type InsertPosition,
-  type Patch,
-} from '@portabletext/patches'
-import {isSpan, isTextBlock, type PortableTextBlock} from '@portabletext/schema'
-import type {Path, PortableTextSpan, PortableTextTextBlock} from '@sanity/types'
-import {
-  Element,
-  Text,
-  type Descendant,
-  type InsertNodeOperation,
-  type InsertTextOperation,
-  type MergeNodeOperation,
-  type MoveNodeOperation,
-  type RemoveNodeOperation,
-  type RemoveTextOperation,
-  type SetNodeOperation,
-  type SplitNodeOperation,
-} from 'slate'
-import type {EditorSchema} from '../editor/editor-schema'
-import {fromSlateBlock} from './values'
-
-export function insertTextPatch(
-  schema: EditorSchema,
-  children: Descendant[],
-  operation: InsertTextOperation,
-  beforeValue: Array<PortableTextBlock>,
-): Array<Patch> {
-  const block =
-    isTextBlock({schema}, children[operation.path[0]]) &&
-    children[operation.path[0]]
-  if (!block) {
-    throw new Error('Could not find block')
-  }
-  const textChild =
-    isTextBlock({schema}, block) &&
-    isSpan({schema}, block.children[operation.path[1]]) &&
-    (block.children[operation.path[1]] as PortableTextSpan)
-  if (!textChild) {
-    throw new Error('Could not find child')
-  }
-  const path: Path = [
-    {_key: block._key},
-    'children',
-    {_key: textChild._key},
-    'text',
-  ]
-  const prevBlock = beforeValue[operation.path[0]]
-  const prevChild =
-    isTextBlock({schema}, prevBlock) && prevBlock.children[operation.path[1]]
-  const prevText = isSpan({schema}, prevChild) ? prevChild.text : ''
-  const patch = diffMatchPatch(prevText, textChild.text, path)
-  return patch.value.length ? [patch] : []
-}
-
-export function removeTextPatch(
-  schema: EditorSchema,
-  children: Descendant[],
-  operation: RemoveTextOperation,
-  beforeValue: Array<PortableTextBlock>,
-): Array<Patch> {
-  const block = children[operation.path[0]]
-  if (!block) {
-    throw new Error('Could not find block')
-  }
-  const child =
-    (isTextBlock({schema}, block) && block.children[operation.path[1]]) ||
-    undefined
-  const textChild: PortableTextSpan | undefined = isSpan({schema}, child)
-    ? child
-    : undefined
-  if (child && !textChild) {
-    throw new Error('Expected span')
-  }
-  if (!textChild) {
-    throw new Error('Could not find child')
-  }
-  const path: Path = [
-    {_key: block._key},
-    'children',
-    {_key: textChild._key},
-    'text',
-  ]
-  const beforeBlock = beforeValue[operation.path[0]]
-  const prevTextChild =
-    isTextBlock({schema}, beforeBlock) &&
-    beforeBlock.children[operation.path[1]]
-  const prevText = isSpan({schema}, prevTextChild) && prevTextChild.text
-  const patch = diffMatchPatch(prevText || '', textChild.text, path)
-  return patch.value ? [patch] : []
-}
-
-export function setNodePatch(
-  schema: EditorSchema,
-  children: Descendant[],
-  operation: SetNodeOperation,
-): Array<Patch> {
-  const blockIndex = operation.path.at(0)
-
-  if (blockIndex !== undefined && operation.path.length === 1) {
-    const block = children.at(blockIndex)
-
-    if (!block) {
-      console.error('Could not find block at index', blockIndex)
-      return []
-    }
-
-    if (isTextBlock({schema}, block)) {
-      const patches: Patch[] = []
-
-      for (const key of Object.keys(operation.newProperties)) {
-        const value = (operation.newProperties as Record<string, unknown>)[key]
-
-        if (key === '_key') {
-          patches.push(set(value, [blockIndex, '_key']))
-        } else {
-          patches.push(set(value, [{_key: block._key}, key]))
-        }
-      }
-
-      for (const key of Object.keys(operation.properties)) {
-        if (!(key in operation.newProperties)) {
-          patches.push(unset([{_key: block._key}, key]))
-        }
-      }
-
-      return patches
-    } else {
-      const patches: Patch[] = []
-
-      const _key = operation.newProperties._key
-
-      if (_key !== undefined) {
-        patches.push(set(_key, [blockIndex, '_key']))
-      }
-
-      const newValue =
-        'value' in operation.newProperties &&
-        typeof operation.newProperties.value === 'object'
-          ? (operation.newProperties.value as Record<string, unknown>)
-          : ({} satisfies Record<string, unknown>)
-
-      const keys = Object.keys(newValue)
-
-      for (const key of keys) {
-        const value = newValue[key]
-
-        patches.push(set(value, [{_key: block._key}, key]))
-      }
-
-      const value =
-        'value' in operation.properties &&
-        typeof operation.properties.value === 'object'
-          ? (operation.properties.value as Record<string, unknown>)
-          : ({} satisfies Record<string, unknown>)
-
-      for (const key of Object.keys(value)) {
-        if (!(key in newValue)) {
-          patches.push(unset([{_key: block._key}, key]))
-        }
-      }
-
-      return patches
-    }
-  } else if (operation.path.length === 2) {
-    const block = children[operation.path[0]]
-    if (isTextBlock({schema}, block)) {
-      const child = block.children[operation.path[1]]
-      if (child) {
-        const blockKey = block._key
-        const childKey = child._key
-        const patches: Patch[] = []
-
-        if (Element.isElement(child)) {
-          // The child is an inline object. This needs to be treated
-          // differently since all custom properties are stored on a `value`
-          // object.
-
-          const _key = operation.newProperties._key
-
-          if (_key !== undefined) {
-            patches.push(
-              set(_key, [
-                {_key: blockKey},
-                'children',
-                block.children.indexOf(child),
-                '_key',
-              ]),
-            )
-          }
-
-          const properties =
-            'value' in operation.newProperties &&
-            typeof operation.newProperties.value === 'object'
-              ? (operation.newProperties.value as Record<string, unknown>)
-              : ({} satisfies Record<string, unknown>)
-
-          const keys = Object.keys(properties)
-
-          for (const key of keys) {
-            const value = properties[key]
-
-            patches.push(
-              set(value, [{_key: blockKey}, 'children', {_key: childKey}, key]),
-            )
-          }
-
-          return patches
-        }
-
-        const newPropNames = Object.keys(operation.newProperties)
-
-        for (const keyName of newPropNames) {
-          const value = (operation.newProperties as Record<string, unknown>)[
-            keyName
-          ]
-
-          if (keyName === '_key') {
-            patches.push(
-              set(value, [
-                {_key: blockKey},
-                'children',
-                block.children.indexOf(child),
-                keyName,
-              ]),
-            )
-
-            continue
-          }
-
-          patches.push(
-            set(value, [
-              {_key: blockKey},
-              'children',
-              {_key: childKey},
-              keyName,
-            ]),
-          )
-        }
-
-        const propNames = Object.keys(operation.properties)
-
-        for (const keyName of propNames) {
-          if (keyName in operation.newProperties) {
-            continue
-          }
-
-          patches.push(
-            unset([{_key: blockKey}, 'children', {_key: childKey}, keyName]),
-          )
-        }
-
-        return patches
-      }
-      throw new Error('Could not find a valid child')
-    }
-    throw new Error('Could not find a valid block')
-  } else {
-    throw new Error(
-      `Unexpected path encountered: ${JSON.stringify(operation.path)}`,
-    )
-  }
-}
-
-export function insertNodePatch(
-  schema: EditorSchema,
-  children: Descendant[],
-  operation: InsertNodeOperation,
-  beforeValue: Array<PortableTextBlock>,
-): Array<Patch> {
-  const block = beforeValue[operation.path[0]]
-  if (operation.path.length === 1) {
-    const position = operation.path[0] === 0 ? 'before' : 'after'
-    const beforeBlock = beforeValue[operation.path[0] - 1]
-    const targetKey = operation.path[0] === 0 ? block?._key : beforeBlock?._key
-    if (targetKey) {
-      return [
-        insert(
-          [fromSlateBlock(operation.node as Descendant, schema.block.name)],
-          position,
-          [{_key: targetKey}],
-        ),
-      ]
-    }
-    return [
-      setIfMissing(beforeValue, []),
-      insert(
-        [fromSlateBlock(operation.node as Descendant, schema.block.name)],
-        'before',
-        [operation.path[0]],
-      ),
-    ]
-  } else if (
-    isTextBlock({schema}, block) &&
-    operation.path.length === 2 &&
-    children[operation.path[0]]
-  ) {
-    const position =
-      block.children.length === 0 || !block.children[operation.path[1] - 1]
-        ? 'before'
-        : 'after'
-    const path =
-      block.children.length <= 1 || !block.children[operation.path[1] - 1]
-        ? [{_key: block._key}, 'children', 0]
-        : [
-            {_key: block._key},
-            'children',
-            {_key: block.children[operation.path[1] - 1]._key},
-          ]
-
-    if (Text.isText(operation.node)) {
-      return [insert([operation.node], position, path)]
-    }
-
-    const _type = operation.node._type
-    const _key = operation.node._key
-    const value =
-      'value' in operation.node && typeof operation.node.value === 'object'
-        ? operation.node.value
-        : ({} satisfies Record<string, unknown>)
-
-    return [
-      insert(
-        [
-          {
-            _type,
-            _key,
-            ...value,
-          },
-        ],
-        position,
-        path,
-      ),
-    ]
-  }
-
-  return []
-}
-
-export function splitNodePatch(
-  schema: EditorSchema,
-  children: Descendant[],
-  operation: SplitNodeOperation,
-  beforeValue: Array<PortableTextBlock>,
-): Array<Patch> {
-  const patches: Patch[] = []
-  const splitBlock = children[operation.path[0]]
-  if (!isTextBlock({schema}, splitBlock)) {
-    throw new Error(
-      `Block with path ${JSON.stringify(
-        operation.path[0],
-      )} is not a text block and can't be split`,
-    )
-  }
-  if (operation.path.length === 1) {
-    const oldBlock = beforeValue[operation.path[0]]
-    if (isTextBlock({schema}, oldBlock)) {
-      const targetValue = fromSlateBlock(
-        children[operation.path[0] + 1],
-        schema.block.name,
-      )
-      if (targetValue) {
-        patches.push(insert([targetValue], 'after', [{_key: splitBlock._key}]))
-        const spansToUnset = oldBlock.children.slice(operation.position)
-        spansToUnset.forEach((span) => {
-          const path = [{_key: oldBlock._key}, 'children', {_key: span._key}]
-          patches.push(unset(path))
-        })
-      }
-    }
-    return patches
-  }
-  if (operation.path.length === 2) {
-    const splitSpan = splitBlock.children[operation.path[1]]
-    if (isSpan({schema}, splitSpan)) {
-      const targetSpans = (
-        fromSlateBlock(
-          {
-            ...splitBlock,
-            children: splitBlock.children.slice(
-              operation.path[1] + 1,
-              operation.path[1] + 2,
-            ),
-          } as Descendant,
-          schema.block.name,
-        ) as PortableTextTextBlock
-      ).children
-
-      patches.push(
-        insert(targetSpans, 'after', [
-          {_key: splitBlock._key},
-          'children',
-          {_key: splitSpan._key},
-        ]),
-      )
-      patches.push(
-        set(splitSpan.text, [
-          {_key: splitBlock._key},
-          'children',
-          {_key: splitSpan._key},
-          'text',
-        ]),
-      )
-    }
-    return patches
-  }
-  return patches
-}
-
-export function removeNodePatch(
-  schema: EditorSchema,
-  beforeValue: Array<PortableTextBlock>,
-  operation: RemoveNodeOperation,
-): Array<Patch> {
-  const block = beforeValue[operation.path[0]]
-  if (operation.path.length === 1) {
-    // Remove a single block
-    if (block && block._key) {
-      return [unset([{_key: block._key}])]
-    }
-    throw new Error('Block not found')
-  } else if (isTextBlock({schema}, block) && operation.path.length === 2) {
-    const spanToRemove = block.children[operation.path[1]]
-
-    if (spanToRemove) {
-      const spansMatchingKey = block.children.filter(
-        (span) => span._key === operation.node._key,
-      )
-
-      if (spansMatchingKey.length > 1) {
-        console.warn(
-          `Multiple spans have \`_key\` ${operation.node._key}. It's ambiguous which one to remove.`,
-          JSON.stringify(block, null, 2),
-        )
-        return []
-      }
-
-      return [
-        unset([{_key: block._key}, 'children', {_key: spanToRemove._key}]),
-      ]
-    }
-    return []
-  } else {
-    return []
-  }
-}
-
-export function mergeNodePatch(
-  schema: EditorSchema,
-  children: Descendant[],
-  operation: MergeNodeOperation,
-  beforeValue: Array<PortableTextBlock>,
-): Array<Patch> {
-  const patches: Patch[] = []
-
-  const block = beforeValue[operation.path[0]]
-  const updatedBlock = children[operation.path[0]]
-
-  if (operation.path.length === 1) {
-    if (block?._key) {
-      const newBlock = fromSlateBlock(
-        children[operation.path[0] - 1],
-        schema.block.name,
-      )
-      patches.push(set(newBlock, [{_key: newBlock._key}]))
-      patches.push(unset([{_key: block._key}]))
-    } else {
-      throw new Error('Target key not found!')
-    }
-  } else if (
-    isTextBlock({schema}, block) &&
-    isTextBlock({schema}, updatedBlock) &&
-    operation.path.length === 2
-  ) {
-    const updatedSpan =
-      updatedBlock.children[operation.path[1] - 1] &&
-      isSpan({schema}, updatedBlock.children[operation.path[1] - 1])
-        ? updatedBlock.children[operation.path[1] - 1]
-        : undefined
-    const removedSpan =
-      block.children[operation.path[1]] &&
-      isSpan({schema}, block.children[operation.path[1]])
-        ? block.children[operation.path[1]]
-        : undefined
-
-    if (updatedSpan) {
-      const spansMatchingKey = block.children.filter(
-        (span) => span._key === updatedSpan._key,
-      )
-
-      if (spansMatchingKey.length === 1) {
-        patches.push(
-          set(updatedSpan.text, [
-            {_key: block._key},
-            'children',
-            {_key: updatedSpan._key},
-            'text',
-          ]),
-        )
-      } else {
-        console.warn(
-          `Multiple spans have \`_key\` ${updatedSpan._key}. It's ambiguous which one to update.`,
-          JSON.stringify(block, null, 2),
-        )
-      }
-    }
-
-    if (removedSpan) {
-      const spansMatchingKey = block.children.filter(
-        (span) => span._key === removedSpan._key,
-      )
-
-      if (spansMatchingKey.length === 1) {
-        patches.push(
-          unset([{_key: block._key}, 'children', {_key: removedSpan._key}]),
-        )
-      } else {
-        console.warn(
-          `Multiple spans have \`_key\` ${removedSpan._key}. It's ambiguous which one to remove.`,
-          JSON.stringify(block, null, 2),
-        )
-      }
-    }
-  }
-  return patches
-}
-
-export function moveNodePatch(
-  schema: EditorSchema,
-  beforeValue: Array<PortableTextBlock>,
-  operation: MoveNodeOperation,
-): Array<Patch> {
-  const patches: Patch[] = []
-  const block = beforeValue[operation.path[0]]
-  const targetBlock = beforeValue[operation.newPath[0]]
-
-  if (!targetBlock) {
-    return patches
-  }
-
-  if (operation.path.length === 1) {
-    const position: InsertPosition =
-      operation.path[0] > operation.newPath[0] ? 'before' : 'after'
-    patches.push(unset([{_key: block._key}]))
-    patches.push(insert([block], position, [{_key: targetBlock._key}]))
-  } else if (
-    operation.path.length === 2 &&
-    isTextBlock({schema}, block) &&
-    isTextBlock({schema}, targetBlock)
-  ) {
-    const child = block.children[operation.path[1]]
-    const targetChild = targetBlock.children[operation.newPath[1]]
-    const position =
-      operation.newPath[1] === targetBlock.children.length ? 'after' : 'before'
-    const childToInsert = block.children[operation.path[1]]
-    patches.push(unset([{_key: block._key}, 'children', {_key: child._key}]))
-    patches.push(
-      insert([childToInsert], position, [
-        {_key: targetBlock._key},
-        'children',
-        {_key: targetChild._key},
-      ]),
-    )
-  }
-  return patches
-}