@portabletext/editor 2.9.1 → 2.10.0

package/src/editor/plugins/create-with-event-listeners.ts

@@ -1,9 +1,8 @@
 import {Editor} from 'slate'
 import {slateRangeToSelection} from '../../internal-utils/slate-utils'
-import {insertTextOperationImplementation} from '../../operations/behavior.operation.insert.text'
 import {performOperation} from '../../operations/behavior.operations'
 import type {EditorActor} from '../editor-machine'
-import {isApplyingBehaviorOperations} from '../with-applying-behavior-operations'
+import {isPerformingBehaviorOperation} from '../with-performing-behavior-operation'
 
 export function createWithEventListeners(editorActor: EditorActor) {
   return function withEventListeners(editor: Editor) {
@@ -14,7 +13,7 @@ export function createWithEventListeners(editorActor: EditorActor) {
     const {delete: editorDelete, select} = editor
 
     editor.delete = (options) => {
-      if (isApplyingBehaviorOperations(editor)) {
+      if (isPerformingBehaviorOperation(editor)) {
         editorDelete(options)
         return
       }
@@ -54,7 +53,7 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.deleteBackward = (unit) => {
-      if (isApplyingBehaviorOperations(editor)) {
+      if (isPerformingBehaviorOperation(editor)) {
         console.error('Unexpected call to .deleteBackward(...)')
         return
       }
@@ -71,7 +70,7 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.deleteForward = (unit) => {
-      if (isApplyingBehaviorOperations(editor)) {
+      if (isPerformingBehaviorOperation(editor)) {
         console.error('Unexpected call to .deleteForward(...)')
         return
       }
@@ -88,7 +87,7 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.insertBreak = () => {
-      if (isApplyingBehaviorOperations(editor)) {
+      if (isPerformingBehaviorOperation(editor)) {
         console.error('Unexpected call to .insertBreak(...)')
         return
       }
@@ -104,7 +103,7 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.insertData = (dataTransfer) => {
-      if (isApplyingBehaviorOperations(editor)) {
+      if (isPerformingBehaviorOperation(editor)) {
         console.error('Unexpected call to .insertData(...)')
         return
       }
@@ -122,8 +121,8 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.insertSoftBreak = () => {
-      if (isApplyingBehaviorOperations(editor)) {
-        insertTextOperationImplementation({
+      if (isPerformingBehaviorOperation(editor)) {
+        performOperation({
           context: {
             keyGenerator: editorActor.getSnapshot().context.keyGenerator,
             schema: editorActor.getSnapshot().context.schema,
@@ -144,8 +143,8 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.insertText = (text) => {
-      if (isApplyingBehaviorOperations(editor)) {
-        insertTextOperationImplementation({
+      if (isPerformingBehaviorOperation(editor)) {
+        performOperation({
           context: {
             keyGenerator: editorActor.getSnapshot().context.keyGenerator,
             schema: editorActor.getSnapshot().context.schema,
@@ -167,7 +166,7 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.redo = () => {
-      if (isApplyingBehaviorOperations(editor)) {
+      if (isPerformingBehaviorOperation(editor)) {
         performOperation({
           context: {
             keyGenerator: editorActor.getSnapshot().context.keyGenerator,
@@ -192,7 +191,7 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.select = (location) => {
-      if (isApplyingBehaviorOperations(editor)) {
+      if (isPerformingBehaviorOperation(editor)) {
         select(location)
         return
       }
@@ -220,7 +219,7 @@ export function createWithEventListeners(editorActor: EditorActor) {
     }
 
     editor.undo = () => {
-      if (isApplyingBehaviorOperations(editor)) {
+      if (isPerformingBehaviorOperation(editor)) {
         performOperation({
           context: {
             keyGenerator: editorActor.getSnapshot().context.keyGenerator,

package/src/editor/sync-machine.ts

@@ -507,6 +507,10 @@ async function updateValue({
 
                   isChanged = blockChanged || isChanged
                   isValid = isValid && blockValid
+
+                  if (!isValid) {
+                    break
+                  }
                 }
 
                 resolve()
@@ -544,6 +548,11 @@ async function updateValue({
 
               isChanged = blockChanged || isChanged
               isValid = isValid && blockValid
+
+              if (!blockValid) {
+                break
+              }
+
               index++
             }
           })

package/src/editor/with-performing-behavior-operation.ts

@@ -0,0 +1,21 @@
+import type {Editor} from 'slate'
+
+const IS_PERFORMING_OPERATION: WeakMap<Editor, boolean | undefined> =
+  new WeakMap()
+
+export function withPerformingBehaviorOperation(
+  editor: Editor,
+  fn: () => void,
+) {
+  const prev = IS_PERFORMING_OPERATION.get(editor)
+
+  IS_PERFORMING_OPERATION.set(editor, true)
+
+  fn()
+
+  IS_PERFORMING_OPERATION.set(editor, prev)
+}
+
+export function isPerformingBehaviorOperation(editor: Editor) {
+  return IS_PERFORMING_OPERATION.get(editor) ?? false
+}

package/src/editor/without-normalizing-conditional.ts

@@ -0,0 +1,13 @@
+import {Editor} from 'slate'
+
+export function withoutNormalizingConditional(
+  editor: Editor,
+  predicate: () => boolean,
+  fn: () => void,
+) {
+  if (predicate()) {
+    Editor.withoutNormalizing(editor, fn)
+  } else {
+    fn()
+  }
+}

package/src/internal-utils/parse-blocks.test.ts

@@ -12,7 +12,7 @@ describe(parseBlock.name, () => {
           keyGenerator: createTestKeyGenerator(),
           schema: compileSchema(defineSchema({})),
         },
-        options: {validateFields: true},
+        options: {removeUnusedMarkDefs: true, validateFields: true},
       }),
     ).toBe(undefined)
   })
@@ -25,7 +25,7 @@ describe(parseBlock.name, () => {
           keyGenerator: createTestKeyGenerator(),
           schema: compileSchema(defineSchema({})),
         },
-        options: {validateFields: true},
+        options: {removeUnusedMarkDefs: true, validateFields: true},
       }),
     ).toBe(undefined)
   })
@@ -39,7 +39,7 @@ describe(parseBlock.name, () => {
             keyGenerator: createTestKeyGenerator(),
             schema: compileSchema(defineSchema({})),
           },
-          options: {validateFields: true},
+          options: {removeUnusedMarkDefs: true, validateFields: true},
         }),
       ).toBe(undefined)
     })
@@ -54,7 +54,7 @@ describe(parseBlock.name, () => {
               defineSchema({blockObjects: [{name: 'image'}]}),
             ),
           },
-          options: {validateFields: true},
+          options: {removeUnusedMarkDefs: true, validateFields: true},
         }),
       ).toBe(undefined)
     })
@@ -69,7 +69,7 @@ describe(parseBlock.name, () => {
               defineSchema({blockObjects: [{name: 'image'}]}),
             ),
           },
-          options: {validateFields: true},
+          options: {removeUnusedMarkDefs: true, validateFields: true},
         }),
       ).toEqual({
         _key: 'k0',
@@ -87,7 +87,7 @@ describe(parseBlock.name, () => {
             keyGenerator: createTestKeyGenerator(),
             schema: compileSchema(defineSchema({})),
           },
-          options: {validateFields: true},
+          options: {removeUnusedMarkDefs: true, validateFields: true},
         }),
       ).toEqual({
         _key: 'k0',
@@ -114,7 +114,7 @@ describe(parseBlock.name, () => {
             keyGenerator: createTestKeyGenerator(),
             schema: {...schema, block: {...schema.block, name: 'text'}},
           },
-          options: {validateFields: true},
+          options: {removeUnusedMarkDefs: true, validateFields: true},
         }),
       ).toEqual({
         _key: 'k0',
@@ -149,7 +149,7 @@ describe(parseBlock.name, () => {
             keyGenerator: createTestKeyGenerator(),
             schema: compileSchema(defineSchema({})),
           },
-          options: {validateFields: true},
+          options: {removeUnusedMarkDefs: true, validateFields: true},
         }),
       ).toBe(undefined)
     })
@@ -188,7 +188,7 @@ describe(parseBlock.name, () => {
               }),
             ),
           },
-          options: {validateFields: true},
+          options: {removeUnusedMarkDefs: true, validateFields: true},
         }),
       ).toEqual({
         _key: 'k0',
@@ -236,7 +236,7 @@ describe(parseBlock.name, () => {
             keyGenerator: createTestKeyGenerator(),
             schema: compileSchema(defineSchema({lists: [{name: 'bullet'}]})),
           },
-          options: {validateFields: true},
+          options: {removeUnusedMarkDefs: true, validateFields: true},
         }),
       ).toEqual({
         _key: 'k0',
@@ -263,7 +263,7 @@ describe(parseBlock.name, () => {
             keyGenerator: createTestKeyGenerator(),
             schema: compileSchema(defineSchema({lists: [{name: 'bullet'}]})),
           },
-          options: {validateFields: true},
+          options: {removeUnusedMarkDefs: true, validateFields: true},
         }),
       ).toEqual({
         _key: 'k0',
@@ -290,7 +290,7 @@ describe(parseBlock.name, () => {
               keyGenerator: createTestKeyGenerator(),
               schema: compileSchema(defineSchema({})),
             },
-            options: {validateFields: true},
+            options: {removeUnusedMarkDefs: true, validateFields: true},
           }),
         ).toEqual({
           _type: 'block',
@@ -320,7 +320,7 @@ describe(parseBlock.name, () => {
                 }),
               ),
             },
-            options: {validateFields: true},
+            options: {removeUnusedMarkDefs: true, validateFields: true},
           }),
         ).toEqual({
           _type: 'block',
@@ -351,7 +351,7 @@ describe(parseBlock.name, () => {
                 }),
               ),
             },
-            options: {validateFields: true},
+            options: {removeUnusedMarkDefs: true, validateFields: true},
           }),
         ).toEqual({
           _type: 'block',

package/src/internal-utils/parse-blocks.ts

@@ -19,6 +19,7 @@ export function parseBlocks({
   context: Pick<EditorContext, 'keyGenerator' | 'schema'>
   blocks: unknown
   options: {
+    removeUnusedMarkDefs: boolean
     validateFields: boolean
   }
 }): Array<PortableTextBlock> {
@@ -41,6 +42,7 @@ export function parseBlock({
   context: Pick<EditorContext, 'keyGenerator' | 'schema'>
   block: unknown
   options: {
+    removeUnusedMarkDefs: boolean
     validateFields: boolean
   }
 }): PortableTextBlock | undefined {
@@ -99,7 +101,10 @@ export function parseTextBlock({
 }: {
   block: unknown
   context: Pick<EditorContext, 'keyGenerator' | 'schema'>
-  options: {validateFields: boolean}
+  options: {
+    removeUnusedMarkDefs: boolean
+    validateFields: boolean
+  }
 }): PortableTextTextBlock | undefined {
   if (!isTypedObject(block)) {
     return undefined
@@ -204,7 +209,9 @@ export function parseTextBlock({
               marks: [],
             },
           ],
-    markDefs: markDefs.filter((markDef) => marks.includes(markDef._key)),
+    markDefs: options.removeUnusedMarkDefs
+      ? markDefs.filter((markDef) => marks.includes(markDef._key))
+      : markDefs,
     ...customFields,
   }
 

package/src/internal-utils/slate-utils.test.tsx

@@ -0,0 +1,119 @@
+import {defineSchema} from '@portabletext/schema'
+import {createTestKeyGenerator} from '@portabletext/test'
+import React from 'react'
+import {describe, expect, test} from 'vitest'
+import {InternalSlateEditorRefPlugin} from '../plugins/plugin.internal.slate-editor-ref'
+import type {PortableTextSlateEditor} from '../types/editor'
+import {getFocusSpan} from './slate-utils'
+import {createTestEditor} from './test-editor'
+
+describe(getFocusSpan.name, () => {
+  const keyGenerator = createTestKeyGenerator()
+  const blockKey = keyGenerator()
+  const fooSpanKey = keyGenerator()
+  const stockTickerKey = keyGenerator()
+  const barSpanKey = keyGenerator()
+  const imageKey = keyGenerator()
+  const initialValue = [
+    {
+      _key: blockKey,
+      _type: 'block',
+      children: [
+        {
+          _type: 'span',
+          _key: fooSpanKey,
+          text: 'foo',
+        },
+        {
+          _type: 'stock-ticker',
+          _key: stockTickerKey,
+        },
+        {
+          _type: 'span',
+          _key: barSpanKey,
+          text: 'bar',
+        },
+      ],
+    },
+    {
+      _key: imageKey,
+      _type: 'image',
+    },
+  ]
+  const schemaDefinition = defineSchema({
+    blockObjects: [{name: 'image'}],
+    inlineObjects: [{name: 'stock-ticker'}],
+  })
+
+  test('Scenario: Text block span is selected', async () => {
+    const slateEditorRef = React.createRef<PortableTextSlateEditor>()
+    await createTestEditor({
+      children: <InternalSlateEditorRefPlugin ref={slateEditorRef} />,
+      schemaDefinition,
+      initialValue,
+      editableProps: {
+        selection: {
+          anchor: {
+            path: [{_key: blockKey}, 'children', {_key: fooSpanKey}],
+            offset: 0,
+          },
+          focus: {
+            path: [{_key: blockKey}, 'children', {_key: fooSpanKey}],
+            offset: 0,
+          },
+        },
+      },
+    })
+
+    expect(getFocusSpan({editor: slateEditorRef.current!})).toEqual([
+      {_type: 'span', _key: fooSpanKey, text: 'foo', marks: []},
+      [0, 0],
+    ])
+  })
+
+  test('Scenario: Inline object is selected', async () => {
+    const slateEditorRef = React.createRef<PortableTextSlateEditor>()
+    await createTestEditor({
+      children: <InternalSlateEditorRefPlugin ref={slateEditorRef} />,
+      schemaDefinition,
+      initialValue,
+      editableProps: {
+        selection: {
+          anchor: {
+            path: [{_key: blockKey}, 'children', {_key: stockTickerKey}],
+            offset: 0,
+          },
+          focus: {
+            path: [{_key: blockKey}, 'children', {_key: stockTickerKey}],
+            offset: 0,
+          },
+        },
+      },
+    })
+
+    expect(getFocusSpan({editor: slateEditorRef.current!})).toEqual([
+      undefined,
+      undefined,
+    ])
+  })
+
+  test('Scenario: Block object is selected', async () => {
+    const slateEditorRef = React.createRef<PortableTextSlateEditor>()
+    await createTestEditor({
+      children: <InternalSlateEditorRefPlugin ref={slateEditorRef} />,
+      schemaDefinition,
+      initialValue,
+      editableProps: {
+        selection: {
+          anchor: {path: [{_key: imageKey}], offset: 0},
+          focus: {path: [{_key: imageKey}], offset: 0},
+        },
+      },
+    })
+
+    expect(getFocusSpan({editor: slateEditorRef.current!})).toEqual([
+      undefined,
+      undefined,
+    ])
+  })
+})

package/src/internal-utils/slate-utils.ts

@@ -79,7 +79,20 @@ export function getFocusSpan({
   }
 
   try {
-    const [node, path] = Editor.node(editor, editor.selection.focus.path)
+    const [focusBlock] = getFocusBlock({editor})
+
+    if (!focusBlock) {
+      return [undefined, undefined]
+    }
+
+    if (!editor.isTextBlock(focusBlock)) {
+      return [undefined, undefined]
+    }
+
+    const [node, path] = Editor.node(
+      editor,
+      editor.selection.focus.path.slice(0, 2),
+    )
 
     if (editor.isTextSpan(node)) {
       return [node, path]

package/src/internal-utils/text-marks.ts

@@ -5,7 +5,7 @@ export function getTextMarks(
   context: Pick<EditorContext, 'schema' | 'value'>,
   text: string,
 ) {
-  let marks: Array<string> | undefined
+  let marks: Array<string> = []
 
   for (const block of context.value) {
     if (isTextBlock(context, block)) {

package/src/internal-utils/values.ts

@@ -1,22 +1,17 @@
 import type {
-  PathSegment,
   PortableTextBlock,
   PortableTextChild,
   PortableTextObject,
   PortableTextTextBlock,
 } from '@sanity/types'
 import {isEqual} from 'lodash'
-import {Element, Text, type Descendant, type Node} from 'slate'
+import {Element, Text, type Descendant} from 'slate'
 import type {EditorSchema} from '../editor/editor-schema'
 
 export const EMPTY_MARKDEFS: PortableTextObject[] = []
 
 export const VOID_CHILD_KEY = 'void-child'
 
-type Partial<T> = {
-  [P in keyof T]?: T[P]
-}
-
 function keepObjectEquality(
   object: PortableTextBlock | PortableTextChild,
   keyMap: Record<string, PortableTextBlock | PortableTextChild>,
@@ -188,52 +183,3 @@ export function isEqualToEmptyEditor(
       children[0].children[0].text === '')
   )
 }
-
-export function findBlockAndIndexFromPath(
-  firstPathSegment: PathSegment,
-  children: (Node | Partial<Node>)[],
-): [Element | undefined, number | undefined] {
-  let blockIndex = -1
-  const isNumber = Number.isInteger(Number(firstPathSegment))
-  if (isNumber) {
-    blockIndex = Number(firstPathSegment)
-  } else if (children) {
-    blockIndex = children.findIndex(
-      (blk) =>
-        Element.isElement(blk) && isEqual({_key: blk._key}, firstPathSegment),
-    )
-  }
-  if (blockIndex > -1) {
-    return [children[blockIndex] as Element, blockIndex]
-  }
-  return [undefined, -1]
-}
-
-export function findChildAndIndexFromPath(
-  secondPathSegment: PathSegment,
-  block: Element,
-): [Element | Text | undefined, number] {
-  let childIndex = -1
-  const isNumber = Number.isInteger(Number(secondPathSegment))
-  if (isNumber) {
-    childIndex = Number(secondPathSegment)
-  } else {
-    childIndex = block.children.findIndex((child) =>
-      isEqual({_key: child._key}, secondPathSegment),
-    )
-  }
-  if (childIndex > -1) {
-    return [block.children[childIndex] as Element | Text, childIndex]
-  }
-  return [undefined, -1]
-}
-
-export function getValueOrInitialValue(
-  value: unknown,
-  initialValue: PortableTextBlock[],
-): PortableTextBlock[] | undefined {
-  if (value && Array.isArray(value) && value.length > 0) {
-    return value
-  }
-  return initialValue
-}

package/src/operations/behavior.operation.block.set.ts

@@ -1,64 +1,46 @@
-import {Editor, Transforms, type Element as SlateElement} from 'slate'
+import {Transforms, type Element as SlateElement} from 'slate'
 import {parseBlock} from '../internal-utils/parse-blocks'
-import {toSlateRange} from '../internal-utils/to-slate-range'
-import {fromSlateValue, toSlateValue} from '../internal-utils/values'
-import {KEY_TO_VALUE_ELEMENT} from '../internal-utils/weakMaps'
+import {toSlateValue} from '../internal-utils/values'
 import type {BehaviorOperationImplementation} from './behavior.operations'
 
 export const blockSetOperationImplementation: BehaviorOperationImplementation<
   'block.set'
 > = ({context, operation}) => {
-  const location = toSlateRange({
-    context: {
-      schema: context.schema,
-      value: operation.editor.value,
-      selection: {
-        anchor: {path: operation.at, offset: 0},
-        focus: {path: operation.at, offset: 0},
-      },
-    },
-    blockIndexMap: operation.editor.blockIndexMap,
-  })
+  const blockIndex = operation.editor.blockIndexMap.get(operation.at[0]._key)
 
-  if (!location) {
+  if (blockIndex === undefined) {
     throw new Error(
-      `Unable to convert ${JSON.stringify(operation.at)} into a Slate Range`,
+      `Unable to find block index for block at ${JSON.stringify(operation.at)}`,
     )
   }
 
-  const blockEntry = Editor.node(operation.editor, location, {depth: 1})
-  const block = blockEntry?.[0]
+  const block = operation.editor.value.at(blockIndex)
 
   if (!block) {
     throw new Error(`Unable to find block at ${JSON.stringify(operation.at)}`)
   }
 
-  const parsedBlock = fromSlateValue(
-    [block],
-    context.schema.block.name,
-    KEY_TO_VALUE_ELEMENT.get(operation.editor),
-  ).at(0)
+  const {_type, ...filteredProps} = operation.props
 
-  if (!parsedBlock) {
-    throw new Error(`Unable to parse block at ${JSON.stringify(operation.at)}`)
+  const updatedBlock = {
+    ...block,
+    ...filteredProps,
   }
 
-  const {_type, ...filteredProps} = operation.props
-
-  const updatedBlock = parseBlock({
+  const parsedBlock = parseBlock({
     context,
-    block: {
-      ...parsedBlock,
-      ...filteredProps,
+    block: updatedBlock,
+    options: {
+      removeUnusedMarkDefs: false,
+      validateFields: true,
     },
-    options: {validateFields: true},
   })
 
-  if (!updatedBlock) {
+  if (!parsedBlock) {
     throw new Error(`Unable to update block at ${JSON.stringify(operation.at)}`)
   }
 
-  const slateBlock = toSlateValue([updatedBlock], {
+  const slateBlock = toSlateValue([parsedBlock], {
     schemaTypes: context.schema,
   })?.at(0) as SlateElement | undefined
 
@@ -66,5 +48,5 @@ export const blockSetOperationImplementation: BehaviorOperationImplementation<
     throw new Error(`Unable to convert block to Slate value`)
   }
 
-  Transforms.setNodes(operation.editor, slateBlock, {at: location})
+  Transforms.setNodes(operation.editor, slateBlock, {at: [blockIndex]})
 }

package/src/operations/behavior.operation.block.unset.ts

@@ -51,7 +51,10 @@ export const blockUnsetOperationImplementation: BehaviorOperationImplementation<
     const updatedTextBlock = parseBlock({
       context,
       block: omit(parsedBlock, propsToRemove),
-      options: {validateFields: true},
+      options: {
+        removeUnusedMarkDefs: true,
+        validateFields: true,
+      },
     })
 
     if (!updatedTextBlock) {
@@ -81,7 +84,10 @@ export const blockUnsetOperationImplementation: BehaviorOperationImplementation<
       parsedBlock,
       operation.props.filter((prop) => prop !== '_type'),
     ),
-    options: {validateFields: true},
+    options: {
+      removeUnusedMarkDefs: true,
+      validateFields: true,
+    },
   })
 
   if (!updatedBlockObject) {

package/src/operations/behavior.operation.insert.block.ts

@@ -24,7 +24,10 @@ export const insertBlockOperationImplementation: BehaviorOperationImplementation
   const parsedBlock = parseBlock({
     block: operation.block,
     context,
-    options: {validateFields: true},
+    options: {
+      removeUnusedMarkDefs: true,
+      validateFields: true,
+    },
   })
 
   if (!parsedBlock) {