@portabletext/editor 1.0.18 → 1.1.0

package/src/utils/operationToPatches.ts

@@ -1,15 +1,20 @@
 import {
   diffMatchPatch,
   insert,
-  type InsertPosition,
-  type Patch,
   set,
   setIfMissing,
   unset,
+  type InsertPosition,
+  type Patch,
 } from '@portabletext/patches'
-import {type Path, type PortableTextSpan, type PortableTextTextBlock} from '@sanity/types'
+import {
+  type Path,
+  type PortableTextSpan,
+  type PortableTextTextBlock,
+} from '@sanity/types'
 import {get, isUndefined, omitBy} from 'lodash'
 import {
+  Text,
   type Descendant,
   type InsertNodeOperation,
   type InsertTextOperation,
@@ -19,17 +24,20 @@ import {
   type RemoveTextOperation,
   type SetNodeOperation,
   type SplitNodeOperation,
-  Text,
 } from 'slate'
-
 import {type PatchFunctions} from '../editor/plugins/createWithPatches'
-import {type PortableTextMemberSchemaTypes, type PortableTextSlateEditor} from '../types/editor'
+import {
+  type PortableTextMemberSchemaTypes,
+  type PortableTextSlateEditor,
+} from '../types/editor'
 import {debugWithName} from './debug'
 import {fromSlateValue} from './values'
 
 const debug = debugWithName('operationToPatches')
 
-export function createOperationToPatches(types: PortableTextMemberSchemaTypes): PatchFunctions {
+export function createOperationToPatches(
+  types: PortableTextMemberSchemaTypes,
+): PatchFunctions {
   const textBlockName = types.block.name
   function insertTextPatch(
     editor: PortableTextSlateEditor,
@@ -40,7 +48,8 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
       debug('Operation', JSON.stringify(operation, null, 2))
     }
     const block =
-      editor.isTextBlock(editor.children[operation.path[0]]) && editor.children[operation.path[0]]
+      editor.isTextBlock(editor.children[operation.path[0]]) &&
+      editor.children[operation.path[0]]
     if (!block) {
       throw new Error('Could not find block')
     }
@@ -51,9 +60,15 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
     if (!textChild) {
       throw new Error('Could not find child')
     }
-    const path: Path = [{_key: block._key}, 'children', {_key: textChild._key}, 'text']
+    const path: Path = [
+      {_key: block._key},
+      'children',
+      {_key: textChild._key},
+      'text',
+    ]
     const prevBlock = beforeValue[operation.path[0]]
-    const prevChild = editor.isTextBlock(prevBlock) && prevBlock.children[operation.path[1]]
+    const prevChild =
+      editor.isTextBlock(prevBlock) && prevBlock.children[operation.path[1]]
     const prevText = editor.isTextSpan(prevChild) ? prevChild.text : ''
     const patch = diffMatchPatch(prevText, textChild.text, path)
     return patch.value.length ? [patch] : []
@@ -68,23 +83,36 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
     if (!block) {
       throw new Error('Could not find block')
     }
-    const child = (editor.isTextBlock(block) && block.children[operation.path[1]]) || undefined
-    const textChild: PortableTextSpan | undefined = editor.isTextSpan(child) ? child : undefined
+    const child =
+      (editor.isTextBlock(block) && block.children[operation.path[1]]) ||
+      undefined
+    const textChild: PortableTextSpan | undefined = editor.isTextSpan(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 path: Path = [
+      {_key: block._key},
+      'children',
+      {_key: textChild._key},
+      'text',
+    ]
     const beforeBlock = beforeValue[operation.path[0]]
-    const prevTextChild = editor.isTextBlock(beforeBlock) && beforeBlock.children[operation.path[1]]
+    const prevTextChild =
+      editor.isTextBlock(beforeBlock) && beforeBlock.children[operation.path[1]]
     const prevText = editor.isTextSpan(prevTextChild) && prevTextChild.text
     const patch = diffMatchPatch(prevText || '', textChild.text, path)
     return patch.value ? [patch] : []
   }
 
-  function setNodePatch(editor: PortableTextSlateEditor, operation: SetNodeOperation) {
+  function setNodePatch(
+    editor: PortableTextSlateEditor,
+    operation: SetNodeOperation,
+  ) {
     if (operation.path.length === 1) {
       const block = editor.children[operation.path[0]]
       if (typeof block._key !== 'string') {
@@ -94,7 +122,9 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
         {...editor.children[operation.path[0]], ...operation.newProperties},
         isUndefined,
       ) as unknown as Descendant
-      return [set(fromSlateValue([setNode], textBlockName)[0], [{_key: block._key}])]
+      return [
+        set(fromSlateValue([setNode], textBlockName)[0], [{_key: block._key}]),
+      ]
     } else if (operation.path.length === 2) {
       const block = editor.children[operation.path[0]]
       if (editor.isTextBlock(block)) {
@@ -109,11 +139,23 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
             if (keys.length === 1 && keyName === '_key') {
               const val = get(operation.newProperties, keyName)
               patches.push(
-                set(val, [{_key: blockKey}, 'children', block.children.indexOf(child), keyName]),
+                set(val, [
+                  {_key: blockKey},
+                  'children',
+                  block.children.indexOf(child),
+                  keyName,
+                ]),
               )
             } else {
               const val = get(operation.newProperties, keyName)
-              patches.push(set(val, [{_key: blockKey}, 'children', {_key: childKey}, keyName]))
+              patches.push(
+                set(val, [
+                  {_key: blockKey},
+                  'children',
+                  {_key: childKey},
+                  keyName,
+                ]),
+              )
             }
           })
           return patches
@@ -122,7 +164,9 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
       }
       throw new Error('Could not find a valid block')
     } else {
-      throw new Error(`Unexpected path encountered: ${JSON.stringify(operation.path)}`)
+      throw new Error(
+        `Unexpected path encountered: ${JSON.stringify(operation.path)}`,
+      )
     }
   }
 
@@ -136,23 +180,34 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
     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
+      const targetKey =
+        operation.path[0] === 0 ? block?._key : beforeBlock?._key
       if (targetKey) {
         return [
-          insert([fromSlateValue([operation.node as Descendant], textBlockName)[0]], position, [
-            {_key: targetKey},
-          ]),
+          insert(
+            [fromSlateValue([operation.node as Descendant], textBlockName)[0]],
+            position,
+            [{_key: targetKey}],
+          ),
         ]
       }
       return [
         setIfMissing(beforeValue, []),
-        insert([fromSlateValue([operation.node as Descendant], textBlockName)[0]], 'before', [
-          operation.path[0],
-        ]),
+        insert(
+          [fromSlateValue([operation.node as Descendant], textBlockName)[0]],
+          'before',
+          [operation.path[0]],
+        ),
       ]
-    } else if (isTextBlock && operation.path.length === 2 && editor.children[operation.path[0]]) {
+    } else if (
+      isTextBlock &&
+      operation.path.length === 2 &&
+      editor.children[operation.path[0]]
+    ) {
       const position =
-        block.children.length === 0 || !block.children[operation.path[1] - 1] ? 'before' : 'after'
+        block.children.length === 0 || !block.children[operation.path[1] - 1]
+          ? 'before'
+          : 'after'
       const node = {...operation.node} as Descendant
       if (!node._type && Text.isText(node)) {
         node._type = 'span'
@@ -179,7 +234,9 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
         ]),
       ]
     }
-    debug('Something was inserted into a void block. Not producing editor patches.')
+    debug(
+      'Something was inserted into a void block. Not producing editor patches.',
+    )
     return []
   }
 
@@ -205,7 +262,9 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
           textBlockName,
         )[0]
         if (targetValue) {
-          patches.push(insert([targetValue], 'after', [{_key: splitBlock._key}]))
+          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}]
@@ -223,7 +282,10 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
             [
               {
                 ...splitBlock,
-                children: splitBlock.children.slice(operation.path[1] + 1, operation.path[1] + 2),
+                children: splitBlock.children.slice(
+                  operation.path[1] + 1,
+                  operation.path[1] + 2,
+                ),
               } as Descendant,
             ],
             textBlockName,
@@ -267,7 +329,9 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
       const spanToRemove = block.children[operation.path[1]]
 
       if (spanToRemove) {
-        const spansMatchingKey = block.children.filter((span) => span._key === operation.node._key)
+        const spansMatchingKey = block.children.filter(
+          (span) => span._key === operation.node._key,
+        )
 
         if (spansMatchingKey.length > 1) {
           console.warn(
@@ -277,7 +341,9 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
           return []
         }
 
-        return [unset([{_key: block._key}, 'children', {_key: spanToRemove._key}])]
+        return [
+          unset([{_key: block._key}, 'children', {_key: spanToRemove._key}]),
+        ]
       }
       debug('Span not found in editor trying to remove node')
       return []
@@ -299,7 +365,10 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
 
     if (operation.path.length === 1) {
       if (block?._key) {
-        const newBlock = fromSlateValue([editor.children[operation.path[0] - 1]], textBlockName)[0]
+        const newBlock = fromSlateValue(
+          [editor.children[operation.path[0] - 1]],
+          textBlockName,
+        )[0]
         patches.push(set(newBlock, [{_key: newBlock._key}]))
         patches.push(unset([{_key: block._key}]))
       } else {
@@ -316,12 +385,15 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
           ? updatedBlock.children[operation.path[1] - 1]
           : undefined
       const removedSpan =
-        block.children[operation.path[1]] && editor.isTextSpan(block.children[operation.path[1]])
+        block.children[operation.path[1]] &&
+        editor.isTextSpan(block.children[operation.path[1]])
           ? block.children[operation.path[1]]
           : undefined
 
       if (updatedSpan) {
-        const spansMatchingKey = block.children.filter((span) => span._key === updatedSpan._key)
+        const spansMatchingKey = block.children.filter(
+          (span) => span._key === updatedSpan._key,
+        )
 
         if (spansMatchingKey.length === 1) {
           patches.push(
@@ -341,10 +413,14 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
       }
 
       if (removedSpan) {
-        const spansMatchingKey = block.children.filter((span) => span._key === removedSpan._key)
+        const spansMatchingKey = block.children.filter(
+          (span) => span._key === removedSpan._key,
+        )
 
         if (spansMatchingKey.length === 1) {
-          patches.push(unset([{_key: block._key}, 'children', {_key: removedSpan._key}]))
+          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.`,
@@ -367,10 +443,13 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
     const block = beforeValue[operation.path[0]]
     const targetBlock = beforeValue[operation.newPath[0]]
     if (operation.path.length === 1) {
-      const position: InsertPosition = operation.path[0] > operation.newPath[0] ? 'before' : 'after'
+      const position: InsertPosition =
+        operation.path[0] > operation.newPath[0] ? 'before' : 'after'
       patches.push(unset([{_key: block._key}]))
       patches.push(
-        insert([fromSlateValue([block], textBlockName)[0]], position, [{_key: targetBlock._key}]),
+        insert([fromSlateValue([block], textBlockName)[0]], position, [
+          {_key: targetBlock._key},
+        ]),
       )
     } else if (
       operation.path.length === 2 &&
@@ -379,9 +458,13 @@ export function createOperationToPatches(types: PortableTextMemberSchemaTypes):
     ) {
       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 = (fromSlateValue([block], textBlockName)[0] as PortableTextTextBlock)
-        .children[operation.path[1]]
+      const position =
+        operation.newPath[1] === targetBlock.children.length
+          ? 'after'
+          : 'before'
+      const childToInsert = (
+        fromSlateValue([block], textBlockName)[0] as PortableTextTextBlock
+      ).children[operation.path[1]]
       patches.push(unset([{_key: block._key}, 'children', {_key: child._key}]))
       patches.push(
         insert([childToInsert], position, [

package/src/utils/paths.ts

@@ -1,8 +1,16 @@
 import {isKeySegment, type Path} from '@sanity/types'
 import {isEqual} from 'lodash'
-import {type Descendant, Editor, Element, type Path as SlatePath, type Point} from 'slate'
-
-import {type EditorSelectionPoint, type PortableTextMemberSchemaTypes} from '../types/editor'
+import {
+  Editor,
+  Element,
+  type Descendant,
+  type Point,
+  type Path as SlatePath,
+} from 'slate'
+import {
+  type EditorSelectionPoint,
+  type PortableTextMemberSchemaTypes,
+} from '../types/editor'
 import {type ObjectWithKeyAndType} from './ranges'
 
 export function createKeyedPath(
@@ -28,17 +36,24 @@ export function createKeyedPath(
   if (child) {
     keyedChildPath = ['children', {_key: child._key}]
   }
-  return (keyedChildPath ? [...keyedBlockPath, ...keyedChildPath] : keyedBlockPath) as Path
+  return (
+    keyedChildPath ? [...keyedBlockPath, ...keyedChildPath] : keyedBlockPath
+  ) as Path
 }
 
-export function createArrayedPath(point: EditorSelectionPoint, editor: Editor): SlatePath {
+export function createArrayedPath(
+  point: EditorSelectionPoint,
+  editor: Editor,
+): SlatePath {
   if (!editor) {
     return []
   }
   const [block, blockPath] = Array.from(
     Editor.nodes(editor, {
       at: [],
-      match: (n) => isKeySegment(point.path[0]) && (n as Descendant)._key === point.path[0]._key,
+      match: (n) =>
+        isKeySegment(point.path[0]) &&
+        (n as Descendant)._key === point.path[0]._key,
     }),
   )[0] || [undefined, undefined]
   if (!block || !Element.isElement(block)) {
@@ -48,7 +63,9 @@ export function createArrayedPath(point: EditorSelectionPoint, editor: Editor):
     return [blockPath[0], 0]
   }
   const childPath = [point.path[2]]
-  const childIndex = block.children.findIndex((child) => isEqual([{_key: child._key}], childPath))
+  const childIndex = block.children.findIndex((child) =>
+    isEqual([{_key: child._key}], childPath),
+  )
   if (childIndex >= 0 && block.children[childIndex]) {
     const child = block.children[childIndex]
     if (Element.isElement(child) && editor.isVoid(child)) {

package/src/utils/ranges.ts

@@ -1,6 +1,5 @@
 /* eslint-disable complexity */
-import {type BaseRange, type Editor, type Operation, Point, Range} from 'slate'
-
+import {Point, Range, type BaseRange, type Editor, type Operation} from 'slate'
 import {
   type EditorSelection,
   type EditorSelectionPoint,
@@ -38,11 +37,16 @@ export function toPortableTextRange(
       offset: range.focus.offset,
     }
   }
-  const backward = Boolean(Range.isRange(range) ? Range.isBackward(range) : undefined)
+  const backward = Boolean(
+    Range.isRange(range) ? Range.isBackward(range) : undefined,
+  )
   return anchor && focus ? {anchor, focus, backward} : null
 }
 
-export function toSlateRange(selection: EditorSelection, editor: Editor): Range | null {
+export function toSlateRange(
+  selection: EditorSelection,
+  editor: Editor,
+): Range | null {
   if (!selection || !editor) {
     return null
   }
@@ -61,7 +65,10 @@ export function toSlateRange(selection: EditorSelection, editor: Editor): Range
   return range
 }
 
-export function moveRangeByOperation(range: Range, operation: Operation): Range | null {
+export function moveRangeByOperation(
+  range: Range,
+  operation: Operation,
+): Range | null {
   const anchor = Point.transform(range.anchor, operation)
   const focus = Point.transform(range.focus, operation)
 

package/src/utils/selection.ts

@@ -1,6 +1,5 @@
 import {type Path, type PortableTextBlock} from '@sanity/types'
 import {isEqual} from 'lodash'
-
 import {type EditorSelection, type EditorSelectionPoint} from '../types/editor'
 
 export function normalizePoint(
@@ -13,21 +12,31 @@ export function normalizePoint(
   const newPath: Path = []
   let newOffset: number = point.offset || 0
   const blockKey =
-    typeof point.path[0] === 'object' && '_key' in point.path[0] && point.path[0]._key
+    typeof point.path[0] === 'object' &&
+    '_key' in point.path[0] &&
+    point.path[0]._key
   const childKey =
-    typeof point.path[2] === 'object' && '_key' in point.path[2] && point.path[2]._key
-  const block: PortableTextBlock | undefined = value.find((blk) => blk._key === blockKey)
+    typeof point.path[2] === 'object' &&
+    '_key' in point.path[2] &&
+    point.path[2]._key
+  const block: PortableTextBlock | undefined = value.find(
+    (blk) => blk._key === blockKey,
+  )
   if (block) {
     newPath.push({_key: block._key})
   } else {
     return null
   }
   if (block && point.path[1] === 'children') {
-    if (!block.children || (Array.isArray(block.children) && block.children.length === 0)) {
+    if (
+      !block.children ||
+      (Array.isArray(block.children) && block.children.length === 0)
+    ) {
       return null
     }
     const child =
-      Array.isArray(block.children) && block.children.find((cld) => cld._key === childKey)
+      Array.isArray(block.children) &&
+      block.children.find((cld) => cld._key === childKey)
     if (child) {
       newPath.push('children')
       newPath.push({_key: child._key})
@@ -52,7 +61,10 @@ export function normalizeSelection(
   let newAnchor: EditorSelectionPoint | null = null
   let newFocus: EditorSelectionPoint | null = null
   const {anchor, focus} = selection
-  if (anchor && value.find((blk) => isEqual({_key: blk._key}, anchor.path[0]))) {
+  if (
+    anchor &&
+    value.find((blk) => isEqual({_key: blk._key}, anchor.path[0]))
+  ) {
     newAnchor = normalizePoint(anchor, value)
   }
   if (focus && value.find((blk) => isEqual({_key: blk._key}, focus.path[0]))) {