@portabletext/editor 1.52.8 → 1.53.1

package/src/behaviors/behavior.abstract.split.ts

@@ -1,111 +1,132 @@
 import {isTextBlock, parseBlock} from '../internal-utils/parse-blocks'
 import * as selectors from '../selectors'
-import {getSelectionStartPoint, isSelectionCollapsed} from '../utils'
-import {getBlockEndPoint} from '../utils/util.get-block-end-point'
-import {getSelectionEndPoint} from '../utils/util.get-selection-end-point'
-import {sliceBlocks} from '../utils/util.slice-blocks'
+import * as utils from '../utils'
 import {raise} from './behavior.types.action'
 import {defineBehavior} from './behavior.types.behavior'
 
 export const abstractSplitBehaviors = [
+  /**
+   * You can't split an inline object.
+   */
+  defineBehavior({
+    on: 'split',
+    guard: ({snapshot}) =>
+      selectors.isSelectionCollapsed(snapshot) &&
+      selectors.getFocusInlineObject(snapshot),
+    actions: [],
+  }),
+
+  /**
+   * You can't split a block object.
+   */
+  defineBehavior({
+    on: 'split',
+    guard: ({snapshot}) =>
+      selectors.isSelectionCollapsed(snapshot) &&
+      selectors.getFocusBlockObject(snapshot),
+    actions: [],
+  }),
+
+  defineBehavior({
+    on: 'split',
+    guard: ({snapshot}) => {
+      const selection = snapshot.context.selection
+
+      if (!selection || utils.isSelectionCollapsed(selection)) {
+        return false
+      }
+
+      const selectionStartBlock = selectors.getSelectionStartBlock(snapshot)
+      const selectionEndBlock = selectors.getSelectionEndBlock(snapshot)
+
+      if (!selectionStartBlock || !selectionEndBlock) {
+        return false
+      }
+
+      if (
+        !isTextBlock(snapshot.context, selectionStartBlock.node) &&
+        isTextBlock(snapshot.context, selectionEndBlock.node)
+      ) {
+        return {selection}
+      }
+
+      return false
+    },
+    actions: [(_, {selection}) => [raise({type: 'delete', at: selection})]],
+  }),
+
+  defineBehavior({
+    on: 'split',
+    guard: ({snapshot}) => {
+      const selection = snapshot.context.selection
+
+      if (!selection || utils.isSelectionCollapsed(selection)) {
+        return false
+      }
+
+      return {selection}
+    },
+    actions: [
+      (_, {selection}) => [
+        raise({type: 'delete', at: selection}),
+        raise({type: 'split'}),
+      ],
+    ],
+  }),
+
   defineBehavior({
     on: 'split',
     guard: ({snapshot}) => {
-      if (!snapshot.context.selection) {
+      const selection = snapshot.context.selection
+
+      if (!selection || !utils.isSelectionCollapsed(selection)) {
+        return false
+      }
+
+      const selectionStartPoint = utils.getSelectionStartPoint(selection)
+
+      const focusTextBlock = selectors.getFocusTextBlock(snapshot)
+
+      if (!focusTextBlock) {
         return false
       }
 
-      const selectionStartPoint = getSelectionStartPoint(
-        snapshot.context.selection,
-      )
-      const selectionEndPoint = getSelectionEndPoint(snapshot.context.selection)
-
-      const focusTextBlock = selectors.getFocusTextBlock({
-        ...snapshot,
-        context: {
-          ...snapshot.context,
-          selection: {
-            anchor: selectionStartPoint,
-            focus: selectionEndPoint,
-          },
-        },
+      const blockEndPoint = utils.getBlockEndPoint({
+        context: snapshot.context,
+        block: focusTextBlock,
       })
 
-      if (focusTextBlock) {
-        const blockEndPoint = getBlockEndPoint({
-          context: snapshot.context,
-          block: focusTextBlock,
-        })
-        const newTextBlockSelection = {
-          anchor: selectionEndPoint,
-          focus: blockEndPoint,
-        }
-        const newTextBlock = parseBlock({
-          block: sliceBlocks({
+      const newTextBlockSelection = {
+        anchor: selectionStartPoint,
+        focus: blockEndPoint,
+      }
+
+      const newTextBlock = parseBlock({
+        block: utils
+          .sliceBlocks({
             context: {
               ...snapshot.context,
               selection: newTextBlockSelection,
             },
             blocks: [focusTextBlock.node],
-          }).at(0),
-          context: snapshot.context,
-          options: {refreshKeys: true, validateFields: true},
-        })
-
-        if (!newTextBlock || !isTextBlock(snapshot.context, newTextBlock)) {
-          return false
-        }
-
-        return {
-          newTextBlock,
-          newTextBlockSelection,
-          selection: {
-            anchor: selectionStartPoint,
-            focus: blockEndPoint,
-          },
-        }
-      }
-
-      const focusBlockObject = selectors.getFocusBlockObject({
-        ...snapshot,
-        context: {
-          ...snapshot.context,
-          selection: {
-            anchor: selectionStartPoint,
-            focus: selectionEndPoint,
-          },
-        },
+          })
+          .at(0),
+        context: snapshot.context,
+        options: {refreshKeys: true, validateFields: true},
       })
 
-      if (focusBlockObject) {
-        const newTextBlock = parseBlock({
-          block: {
-            _type: snapshot.context.schema.block.name,
-            children: [],
-          },
-          context: snapshot.context,
-          options: {refreshKeys: true, validateFields: true},
-        })
-
-        if (!newTextBlock) {
-          return false
-        }
-
-        return {
-          newTextBlock,
-          newTextBlockSelection: {
-            anchor: selectionEndPoint,
-            focus: selectionEndPoint,
-          },
-          selection: snapshot.context.selection,
-        }
+      if (!newTextBlock) {
+        return false
       }
 
-      return false
+      return {
+        newTextBlock,
+        newTextBlockSelection,
+      }
     },
     actions: [
-      (_, {newTextBlock, selection}) =>
-        isSelectionCollapsed(selection)
+      (_, {newTextBlock, newTextBlockSelection}) =>
+        utils.isSelectionCollapsed(newTextBlockSelection)
           ? [
               raise({
                 type: 'insert.block',
@@ -115,10 +136,7 @@ export const abstractSplitBehaviors = [
               }),
             ]
           : [
-              raise({
-                type: 'delete',
-                at: selection,
-              }),
+              raise({type: 'delete', at: newTextBlockSelection}),
               raise({
                 type: 'insert.block',
                 block: newTextBlock,

package/src/behaviors/behavior.core.insert-break.ts

@@ -235,9 +235,23 @@ const breakingEntireBlocks = defineBehavior({
   ],
 })
 
+const breakingInlineObject = defineBehavior({
+  on: 'insert.break',
+  guard: ({snapshot}) => {
+    const selectionCollapsed = selectors.isSelectionCollapsed(snapshot)
+    const focusInlineObject = selectors.getFocusInlineObject(snapshot)
+
+    return selectionCollapsed && focusInlineObject
+  },
+  actions: [
+    () => [raise({type: 'move.forward', distance: 1}), raise({type: 'split'})],
+  ],
+})
+
 export const coreInsertBreakBehaviors = {
   breakingAtTheEndOfTextBlock,
   breakingAtTheStartOfTextBlock,
   breakingEntireDocument,
   breakingEntireBlocks,
+  breakingInlineObject,
 }

package/src/behaviors/behavior.core.ts

@@ -29,6 +29,7 @@ export const coreBehaviorsConfig = [
   coreInsertBreakBehaviors.breakingAtTheStartOfTextBlock,
   coreInsertBreakBehaviors.breakingEntireDocument,
   coreInsertBreakBehaviors.breakingEntireBlocks,
+  coreInsertBreakBehaviors.breakingInlineObject,
 ].map((behavior) => ({
   behavior,
   priority: corePriority,

package/src/internal-utils/key-is.ts

@@ -1,4 +1,5 @@
 export const keyIs = {
+  break: (event) => event.key === 'Enter' && !event.shiftKey,
   lineBreak: (event) => event.key === 'Enter' && event.shiftKey,
 } satisfies Record<string, KeyboardEventPredicate>
 

package/src/selectors/index.ts

@@ -7,15 +7,28 @@ export {getAnchorSpan} from './selector.get-anchor-span'
 export {getAnchorTextBlock} from './selector.get-anchor-text-block'
 export {getBlockOffsets} from './selector.get-block-offsets'
 export {getCaretWordSelection} from './selector.get-caret-word-selection'
+export {getFirstBlock} from './selector.get-first-block'
+export {getFocusBlock} from './selector.get-focus-block'
+export {getFocusBlockObject} from './selector.get-focus-block-object'
+export {getFocusChild} from './selector.get-focus-child'
 export {getFocusInlineObject} from './selector.get-focus-inline-object'
+export {getFocusListBlock} from './selector.get-focus-list-block'
+export {getFocusSpan} from './selector.get-focus-span'
+export {getFocusTextBlock} from './selector.get-focus-text-block'
+export {getLastBlock} from './selector.get-last-block'
 export {getListIndex} from './selector.get-list-state'
+export {getNextBlock} from './selector.get-next-block'
 export {getNextInlineObject} from './selector.get-next-inline-object'
+export {getPreviousBlock} from './selector.get-previous-block'
 export {getPreviousInlineObject} from './selector.get-previous-inline-object'
+export {getSelectedBlocks} from './selector.get-selected-blocks'
 export {getSelectedSlice} from './selector.get-selected-slice'
 export {getSelectedSpans} from './selector.get-selected-spans'
 export {getSelectedTextBlocks} from './selector.get-selected-text-blocks'
 export {getSelection} from './selector.get-selection'
+export {getSelectionEndBlock} from './selector.get-selection-end-block'
 export {getSelectionEndPoint} from './selector.get-selection-end-point'
+export {getSelectionStartBlock} from './selector.get-selection-start-block'
 export {getSelectionStartPoint} from './selector.get-selection-start-point'
 export {getSelectionText} from './selector.get-selection-text'
 export {getBlockTextBefore} from './selector.get-text-before'
@@ -33,4 +46,3 @@ export {isPointBeforeSelection} from './selector.is-point-before-selection'
 export {isSelectingEntireBlocks} from './selector.is-selecting-entire-blocks'
 export {isSelectionCollapsed} from './selector.is-selection-collapsed'
 export {isSelectionExpanded} from './selector.is-selection-expanded'
-export * from './selectors'

package/src/selectors/selector.get-active-annotations.ts

@@ -1,9 +1,10 @@
 import type {PortableTextObject} from '@sanity/types'
 import type {EditorSelector} from '../editor/editor-selector'
 import {isTextBlock} from '../internal-utils/parse-blocks'
+import {getFocusSpan} from './selector.get-focus-span'
+import {getSelectedBlocks} from './selector.get-selected-blocks'
 import {getSelectedSpans} from './selector.get-selected-spans'
 import {isSelectionCollapsed} from './selector.is-selection-collapsed'
-import {getFocusSpan, getSelectedBlocks} from './selectors'
 
 /**
  * @public

package/src/selectors/selector.get-active-list-item.ts

@@ -1,7 +1,7 @@
 import type {PortableTextListBlock} from '@sanity/types'
 import type {EditorSelector} from '../editor/editor-selector'
 import {isTextBlock} from '../internal-utils/parse-blocks'
-import {getSelectedBlocks} from './selectors'
+import {getSelectedBlocks} from './selector.get-selected-blocks'
 
 /**
  * @public

package/src/selectors/selector.get-active-style.ts

@@ -1,7 +1,7 @@
 import type {PortableTextTextBlock} from '@sanity/types'
 import type {EditorSelector} from '../editor/editor-selector'
 import {isTextBlock} from '../internal-utils/parse-blocks'
-import {getSelectedBlocks} from './selectors'
+import {getSelectedBlocks} from './selector.get-selected-blocks'
 
 /**
  * @public

package/src/selectors/selector.get-caret-word-selection.ts

@@ -7,13 +7,13 @@ import {
   getBlockStartPoint,
   spanSelectionPointToBlockOffset,
 } from '../utils'
+import {getFocusTextBlock} from './selector.get-focus-text-block'
 import {getNextInlineObject} from './selector.get-next-inline-object'
 import {getPreviousInlineObject} from './selector.get-previous-inline-object'
 import {getSelectionStartPoint} from './selector.get-selection-start-point'
 import {getSelectionText} from './selector.get-selection-text'
 import {isSelectionCollapsed} from './selector.is-selection-collapsed'
 import {isSelectionExpanded} from './selector.is-selection-expanded'
-import {getFocusTextBlock} from './selectors'
 
 /**
  * @public

package/src/selectors/selector.get-first-block.ts

@@ -0,0 +1,14 @@
+import type {PortableTextBlock} from '@sanity/types'
+import type {EditorSelector} from '../editor/editor-selector'
+import type {BlockPath} from '../types/paths'
+
+/**
+ * @public
+ */
+export const getFirstBlock: EditorSelector<
+  {node: PortableTextBlock; path: BlockPath} | undefined
+> = (snapshot) => {
+  const node = snapshot.context.value[0]
+
+  return node ? {node, path: [{_key: node._key}]} : undefined
+}

package/src/selectors/selector.get-focus-block-object.ts

@@ -0,0 +1,18 @@
+import type {PortableTextObject} from '@sanity/types'
+import type {EditorSelector} from '../editor/editor-selector'
+import {isTextBlock} from '../internal-utils/parse-blocks'
+import type {BlockPath} from '../types/paths'
+import {getFocusBlock} from './selector.get-focus-block'
+
+/**
+ * @public
+ */
+export const getFocusBlockObject: EditorSelector<
+  {node: PortableTextObject; path: BlockPath} | undefined
+> = (snapshot) => {
+  const focusBlock = getFocusBlock(snapshot)
+
+  return focusBlock && !isTextBlock(snapshot.context, focusBlock.node)
+    ? {node: focusBlock.node, path: focusBlock.path}
+    : undefined
+}

package/src/selectors/selector.get-focus-block.ts

@@ -0,0 +1,23 @@
+import type {PortableTextBlock} from '@sanity/types'
+import type {EditorSelector} from '../editor/editor-selector'
+import {getBlockKeyFromSelectionPoint} from '../selection/selection-point'
+import type {BlockPath} from '../types/paths'
+
+/**
+ * @public
+ */
+export const getFocusBlock: EditorSelector<
+  {node: PortableTextBlock; path: BlockPath} | undefined
+> = (snapshot) => {
+  if (!snapshot.context.selection) {
+    return undefined
+  }
+
+  const key = getBlockKeyFromSelectionPoint(snapshot.context.selection.focus)
+
+  const node = key
+    ? snapshot.context.value.find((block) => block._key === key)
+    : undefined
+
+  return node && key ? {node, path: [{_key: key}]} : undefined
+}

package/src/selectors/selector.get-focus-child.ts

@@ -0,0 +1,39 @@
+import type {
+  KeyedSegment,
+  PortableTextObject,
+  PortableTextSpan,
+} from '@sanity/types'
+import type {EditorSelector} from '../editor/editor-selector'
+import {getChildKeyFromSelectionPoint} from '../selection/selection-point'
+import {getFocusTextBlock} from './selector.get-focus-text-block'
+
+/**
+ * @public
+ */
+export const getFocusChild: EditorSelector<
+  | {
+      node: PortableTextObject | PortableTextSpan
+      path: [KeyedSegment, 'children', KeyedSegment]
+    }
+  | undefined
+> = (snapshot) => {
+  if (!snapshot.context.selection) {
+    return undefined
+  }
+
+  const focusBlock = getFocusTextBlock(snapshot)
+
+  if (!focusBlock) {
+    return undefined
+  }
+
+  const key = getChildKeyFromSelectionPoint(snapshot.context.selection.focus)
+
+  const node = key
+    ? focusBlock.node.children.find((span) => span._key === key)
+    : undefined
+
+  return node && key
+    ? {node, path: [...focusBlock.path, 'children', {_key: key}]}
+    : undefined
+}

package/src/selectors/selector.get-focus-inline-object.ts

@@ -4,7 +4,7 @@ import {
   type PortableTextObject,
 } from '@sanity/types'
 import type {EditorSelector} from '../editor/editor-selector'
-import {getFocusChild} from './selectors'
+import {getFocusChild} from './selector.get-focus-child'
 
 /**
  * @public

package/src/selectors/selector.get-focus-list-block.ts

@@ -0,0 +1,18 @@
+import type {PortableTextListBlock} from '@sanity/types'
+import type {EditorSelector} from '../editor/editor-selector'
+import {isListBlock} from '../internal-utils/parse-blocks'
+import type {BlockPath} from '../types/paths'
+import {getFocusTextBlock} from './selector.get-focus-text-block'
+
+/**
+ * @public
+ */
+export const getFocusListBlock: EditorSelector<
+  {node: PortableTextListBlock; path: BlockPath} | undefined
+> = (snapshot) => {
+  const focusTextBlock = getFocusTextBlock(snapshot)
+
+  return focusTextBlock && isListBlock(snapshot.context, focusTextBlock.node)
+    ? {node: focusTextBlock.node, path: focusTextBlock.path}
+    : undefined
+}

package/src/selectors/selector.get-focus-span.ts

@@ -0,0 +1,18 @@
+import type {KeyedSegment, PortableTextSpan} from '@sanity/types'
+import type {EditorSelector} from '../editor/editor-selector'
+import {isSpan} from '../internal-utils/parse-blocks'
+import {getFocusChild} from './selector.get-focus-child'
+
+/**
+ * @public
+ */
+export const getFocusSpan: EditorSelector<
+  | {node: PortableTextSpan; path: [KeyedSegment, 'children', KeyedSegment]}
+  | undefined
+> = (snapshot) => {
+  const focusChild = getFocusChild(snapshot)
+
+  return focusChild && isSpan(snapshot.context, focusChild.node)
+    ? {node: focusChild.node, path: focusChild.path}
+    : undefined
+}

package/src/selectors/selector.get-focus-text-block.ts

@@ -0,0 +1,18 @@
+import type {PortableTextTextBlock} from '@sanity/types'
+import type {EditorSelector} from '../editor/editor-selector'
+import {isTextBlock} from '../internal-utils/parse-blocks'
+import type {BlockPath} from '../types/paths'
+import {getFocusBlock} from './selector.get-focus-block'
+
+/**
+ * @public
+ */
+export const getFocusTextBlock: EditorSelector<
+  {node: PortableTextTextBlock; path: BlockPath} | undefined
+> = (snapshot) => {
+  const focusBlock = getFocusBlock(snapshot)
+
+  return focusBlock && isTextBlock(snapshot.context, focusBlock.node)
+    ? {node: focusBlock.node, path: focusBlock.path}
+    : undefined
+}

package/src/selectors/selector.get-last-block.ts

@@ -0,0 +1,16 @@
+import type {PortableTextBlock} from '@sanity/types'
+import type {EditorSelector} from '../editor/editor-selector'
+import type {BlockPath} from '../types/paths'
+
+/**
+ * @public
+ */
+export const getLastBlock: EditorSelector<
+  {node: PortableTextBlock; path: BlockPath} | undefined
+> = (snapshot) => {
+  const node = snapshot.context.value[snapshot.context.value.length - 1]
+    ? snapshot.context.value[snapshot.context.value.length - 1]
+    : undefined
+
+  return node ? {node, path: [{_key: node._key}]} : undefined
+}

package/src/selectors/selector.get-list-state.ts

@@ -2,7 +2,8 @@ import type {PortableTextTextBlock} from '@sanity/types'
 import type {EditorSelector} from '../editor/editor-selector'
 import {isTextBlock} from '../internal-utils/parse-blocks'
 import type {BlockPath} from '../types/paths'
-import {getFocusTextBlock, getPreviousBlock} from './selectors'
+import {getFocusTextBlock} from './selector.get-focus-text-block'
+import {getPreviousBlock} from './selector.get-previous-block'
 
 /**
  * @beta

package/src/selectors/selector.get-next-block.ts

@@ -0,0 +1,38 @@
+import type {PortableTextBlock} from '@sanity/types'
+import type {EditorSelector} from '../editor/editor-selector'
+import type {BlockPath} from '../types/paths'
+import {getSelectionEndBlock} from './selector.get-selection-end-block'
+
+/**
+ * @public
+ */
+export const getNextBlock: EditorSelector<
+  {node: PortableTextBlock; path: BlockPath} | undefined
+> = (snapshot) => {
+  let nextBlock: {node: PortableTextBlock; path: BlockPath} | undefined
+  const selectionEndBlock = getSelectionEndBlock(snapshot)
+
+  if (!selectionEndBlock) {
+    return undefined
+  }
+
+  let foundSelectionEndBlock = false
+
+  for (const block of snapshot.context.value) {
+    if (block._key === selectionEndBlock.node._key) {
+      foundSelectionEndBlock = true
+      continue
+    }
+
+    if (foundSelectionEndBlock) {
+      nextBlock = {node: block, path: [{_key: block._key}]}
+      break
+    }
+  }
+
+  if (foundSelectionEndBlock && nextBlock) {
+    return nextBlock
+  }
+
+  return undefined
+}

package/src/selectors/selector.get-next-inline-object.ts

@@ -5,8 +5,8 @@ import {
 } from '@sanity/types'
 import type {EditorSelector} from '../editor/editor-selector'
 import {isSpan} from '../utils'
+import {getFocusTextBlock} from './selector.get-focus-text-block'
 import {getSelectionEndPoint} from './selector.get-selection-end-point'
-import {getFocusTextBlock} from './selectors'
 
 /**
  * @public

package/src/selectors/selector.get-previous-block.ts

@@ -0,0 +1,35 @@
+import type {KeyedSegment, PortableTextBlock} from '@sanity/types'
+import type {EditorSelector} from '../editor/editor-selector'
+import type {BlockPath} from '../types/paths'
+import {getSelectionStartBlock} from './selector.get-selection-start-block'
+
+/**
+ * @public
+ */
+export const getPreviousBlock: EditorSelector<
+  {node: PortableTextBlock; path: BlockPath} | undefined
+> = (snapshot) => {
+  let previousBlock: {node: PortableTextBlock; path: [KeyedSegment]} | undefined
+  const selectionStartBlock = getSelectionStartBlock(snapshot)
+
+  if (!selectionStartBlock) {
+    return undefined
+  }
+
+  let foundSelectionStartBlock = false
+
+  for (const block of snapshot.context.value) {
+    if (block._key === selectionStartBlock.node._key) {
+      foundSelectionStartBlock = true
+      break
+    }
+
+    previousBlock = {node: block, path: [{_key: block._key}]}
+  }
+
+  if (foundSelectionStartBlock && previousBlock) {
+    return previousBlock
+  }
+
+  return undefined
+}

package/src/selectors/selector.get-previous-inline-object.ts

@@ -5,8 +5,8 @@ import {
 } from '@sanity/types'
 import type {EditorSelector} from '../editor/editor-selector'
 import {isSpan} from '../utils'
+import {getFocusTextBlock} from './selector.get-focus-text-block'
 import {getSelectionStartPoint} from './selector.get-selection-start-point'
-import {getFocusTextBlock} from './selectors'
 
 /**
  * @public