@portabletext/editor 1.34.0 → 1.35.0

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

@@ -17,9 +17,9 @@ export const getPreviousInlineObject: EditorSelector<
       path: [KeyedSegment, 'children', KeyedSegment]
     }
   | undefined
-> = ({context}) => {
-  const focusTextBlock = getFocusTextBlock({context})
-  const selectionStartPoint = getSelectionStartPoint({context})
+> = (snapshot) => {
+  const focusTextBlock = getFocusTextBlock(snapshot)
+  const selectionStartPoint = getSelectionStartPoint(snapshot)
   const selectionStartPointChildKey =
     selectionStartPoint && isKeySegment(selectionStartPoint.path[2])
       ? selectionStartPoint.path[2]._key
@@ -41,7 +41,7 @@ export const getPreviousInlineObject: EditorSelector<
       break
     }
 
-    if (!isSpan(context, child)) {
+    if (!isSpan(snapshot.context, child)) {
       inlineObject = {
         node: child,
         path: [...focusTextBlock.path, 'children', {_key: child._key}],

package/src/selectors/selector.get-selected-slice.ts

@@ -5,8 +5,11 @@ import {sliceBlocks} from '../utils'
 /**
  * @public
  */
-export const getSelectedSlice: EditorSelector<Array<PortableTextBlock>> = ({
-  context,
-}) => {
-  return sliceBlocks({blocks: context.value, selection: context.selection})
+export const getSelectedSlice: EditorSelector<Array<PortableTextBlock>> = (
+  snapshot,
+) => {
+  return sliceBlocks({
+    blocks: snapshot.context.value,
+    selection: snapshot.context.selection,
+  })
 }

package/src/selectors/selector.get-selected-spans.ts

@@ -15,8 +15,8 @@ export const getSelectedSpans: EditorSelector<
     node: PortableTextSpan
     path: [KeyedSegment, 'children', KeyedSegment]
   }>
-> = ({context}) => {
-  if (!context.selection) {
+> = (snapshot) => {
+  if (!snapshot.context.selection) {
     return []
   }
 
@@ -25,12 +25,12 @@ export const getSelectedSpans: EditorSelector<
     path: [KeyedSegment, 'children', KeyedSegment]
   }> = []
 
-  const startPoint = context.selection.backward
-    ? context.selection.focus
-    : context.selection.anchor
-  const endPoint = context.selection.backward
-    ? context.selection.anchor
-    : context.selection.focus
+  const startPoint = snapshot.context.selection.backward
+    ? snapshot.context.selection.focus
+    : snapshot.context.selection.anchor
+  const endPoint = snapshot.context.selection.backward
+    ? snapshot.context.selection.anchor
+    : snapshot.context.selection.focus
 
   const startBlockKey = isKeySegment(startPoint.path[0])
     ? startPoint.path[0]._key
@@ -50,7 +50,7 @@ export const getSelectedSpans: EditorSelector<
     ? endPoint.path[2]._key
     : undefined
 
-  for (const block of context.value) {
+  for (const block of snapshot.context.value) {
     if (!isPortableTextTextBlock(block)) {
       continue
     }

package/src/selectors/selector.get-selection-end-point.ts

@@ -6,12 +6,12 @@ import type {EditorSelectionPoint} from '../utils'
  */
 export const getSelectionEndPoint: EditorSelector<
   EditorSelectionPoint | undefined
-> = ({context}) => {
-  if (!context.selection) {
+> = (snapshot) => {
+  if (!snapshot.context.selection) {
     return undefined
   }
 
-  return context.selection.backward
-    ? context.selection.anchor
-    : context.selection.focus
+  return snapshot.context.selection.backward
+    ? snapshot.context.selection.anchor
+    : snapshot.context.selection.focus
 }

package/src/selectors/selector.get-selection-start-point.ts

@@ -6,12 +6,12 @@ import type {EditorSelectionPoint} from '../utils'
  */
 export const getSelectionStartPoint: EditorSelector<
   EditorSelectionPoint | undefined
-> = ({context}) => {
-  if (!context.selection) {
+> = (snapshot) => {
+  if (!snapshot.context.selection) {
     return undefined
   }
 
-  return context.selection.backward
-    ? context.selection.focus
-    : context.selection.anchor
+  return snapshot.context.selection.backward
+    ? snapshot.context.selection.focus
+    : snapshot.context.selection.anchor
 }

package/src/selectors/selector.get-selection-text.ts

@@ -5,8 +5,8 @@ import {getSelectedSlice} from './selector.get-selected-slice'
 /**
  * @public
  */
-export const getSelectionText: EditorSelector<string> = ({context}) => {
-  const selectedSlice = getSelectedSlice({context})
+export const getSelectionText: EditorSelector<string> = (snapshot) => {
+  const selectedSlice = getSelectedSlice(snapshot)
 
   return selectedSlice.reduce((text, block) => {
     if (!isPortableTextTextBlock(block)) {

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

@@ -3,6 +3,6 @@ import type {EditorSelection, EditorSelector} from './_exports'
 /**
  * @public
  */
-export const getSelection: EditorSelector<EditorSelection> = ({context}) => {
-  return context.selection
+export const getSelection: EditorSelector<EditorSelection> = (snapshot) => {
+  return snapshot.context.selection
 }

package/src/selectors/selector.get-text-before.ts

@@ -7,19 +7,19 @@ import {getSelectionText} from './selector.get-selection-text'
 /**
  * @public
  */
-export const getBlockTextBefore: EditorSelector<string> = ({context}) => {
-  if (!context.selection) {
+export const getBlockTextBefore: EditorSelector<string> = (snapshot) => {
+  if (!snapshot.context.selection) {
     return ''
   }
 
-  const selection = context.selection.backward
-    ? reverseSelection(context.selection)
-    : context.selection
+  const selection = snapshot.context.selection.backward
+    ? reverseSelection(snapshot.context.selection)
+    : snapshot.context.selection
   const point = selection.anchor
   const key = isKeyedSegment(point.path[0]) ? point.path[0]._key : undefined
 
   const block = key
-    ? context.value.find((block) => block._key === key)
+    ? snapshot.context.value.find((block) => block._key === key)
     : undefined
 
   if (!block) {
@@ -32,9 +32,9 @@ export const getBlockTextBefore: EditorSelector<string> = ({context}) => {
   })
 
   return getSelectionText({
+    ...snapshot,
     context: {
-      ...context,
-      value: context.value,
+      ...snapshot.context,
       selection: {
         anchor: startOfBlock,
         focus: point,

package/src/selectors/selector.get-trimmed-selection.ts

@@ -14,18 +14,18 @@ import {getFocusTextBlock} from './selectors'
 /**
  * @public
  */
-export const getTrimmedSelection: EditorSelector<EditorSelection> = ({
-  context,
-}) => {
-  if (!context.selection) {
-    return context.selection
+export const getTrimmedSelection: EditorSelector<EditorSelection> = (
+  snapshot,
+) => {
+  if (!snapshot.context.selection) {
+    return snapshot.context.selection
   }
 
-  const startPoint = getSelectionStartPoint({context})
-  const endPoint = getSelectionEndPoint({context})
+  const startPoint = getSelectionStartPoint(snapshot)
+  const endPoint = getSelectionEndPoint(snapshot)
 
   if (!startPoint || !endPoint) {
-    return context.selection
+    return snapshot.context.selection
   }
 
   const startBlockKey = isKeyedSegment(startPoint.path[0])
@@ -42,7 +42,7 @@ export const getTrimmedSelection: EditorSelector<EditorSelection> = ({
     : null
 
   if (!startBlockKey || !endBlockKey) {
-    return context.selection
+    return snapshot.context.selection
   }
 
   let startBlockFound = false
@@ -54,7 +54,7 @@ export const getTrimmedSelection: EditorSelector<EditorSelection> = ({
     | {blockKey: string; span: PortableTextSpan}
     | undefined
 
-  for (const block of context.value) {
+  for (const block of snapshot.context.value) {
     if (block._key === startBlockKey) {
       startBlockFound = true
 
@@ -140,7 +140,7 @@ export const getTrimmedSelection: EditorSelector<EditorSelection> = ({
     }
   }
 
-  const trimmedSelection = context.selection.backward
+  const trimmedSelection = snapshot.context.selection.backward
     ? {
         anchor: trimEndPoint && adjustedEndPoint ? adjustedEndPoint : endPoint,
         focus: adjustedStartPoint ?? startPoint,
@@ -153,15 +153,17 @@ export const getTrimmedSelection: EditorSelector<EditorSelection> = ({
 
   if (
     isSelectionCollapsed({
+      ...snapshot,
       context: {
-        ...context,
+        ...snapshot.context,
         selection: trimmedSelection,
       },
     })
   ) {
     const focusTextBlock = getFocusTextBlock({
+      ...snapshot,
       context: {
-        ...context,
+        ...snapshot.context,
         selection: trimmedSelection,
       },
     })

package/src/selectors/selector.get-value.ts

@@ -4,8 +4,8 @@ import type {EditorSelector} from './_exports'
 /**
  * @public
  */
-export const getValue: EditorSelector<Array<PortableTextBlock>> = ({
-  context,
-}) => {
-  return context.value
+export const getValue: EditorSelector<Array<PortableTextBlock>> = (
+  snapshot,
+) => {
+  return snapshot.context.value
 }

package/src/selectors/selector.is-at-the-end-of-block.ts

@@ -10,13 +10,16 @@ export function isAtTheEndOfBlock(block: {
   node: PortableTextBlock
   path: [KeyedSegment]
 }): EditorSelector<boolean> {
-  return ({context}) => {
-    if (!context.selection || !isSelectionCollapsed({context})) {
+  return (snapshot) => {
+    if (!snapshot.context.selection || !isSelectionCollapsed(snapshot)) {
       return false
     }
 
     const blockEndPoint = utils.getBlockEndPoint(block)
 
-    return utils.isEqualSelectionPoints(context.selection.focus, blockEndPoint)
+    return utils.isEqualSelectionPoints(
+      snapshot.context.selection.focus,
+      blockEndPoint,
+    )
   }
 }

package/src/selectors/selector.is-at-the-start-of-block.ts

@@ -10,15 +10,15 @@ export function isAtTheStartOfBlock(block: {
   node: PortableTextBlock
   path: [KeyedSegment]
 }): EditorSelector<boolean> {
-  return ({context}) => {
-    if (!context.selection || !isSelectionCollapsed({context})) {
+  return (snapshot) => {
+    if (!snapshot.context.selection || !isSelectionCollapsed(snapshot)) {
       return false
     }
 
     const blockStartPoint = utils.getBlockStartPoint(block)
 
     return utils.isEqualSelectionPoints(
-      context.selection.focus,
+      snapshot.context.selection.focus,
       blockStartPoint,
     )
   }

package/src/selectors/selector.is-overlapping-selection.ts

@@ -11,20 +11,22 @@ import {isPointBeforeSelection} from './selector.is-point-before-selection'
 export function isOverlappingSelection(
   selection: EditorSelection,
 ): EditorSelector<boolean> {
-  return ({context}) => {
-    if (!selection || !context.selection) {
+  return (snapshot) => {
+    if (!selection || !snapshot.context.selection) {
       return false
     }
 
     const selectionStartPoint = getSelectionStartPoint({
+      ...snapshot,
       context: {
-        ...context,
+        ...snapshot.context,
         selection,
       },
     })
     const selectionEndPoint = getSelectionEndPoint({
+      ...snapshot,
       context: {
-        ...context,
+        ...snapshot.context,
         selection,
       },
     })
@@ -33,11 +35,11 @@ export function isOverlappingSelection(
       return false
     }
 
-    if (!isPointAfterSelection(selectionStartPoint)({context})) {
+    if (!isPointAfterSelection(selectionStartPoint)(snapshot)) {
       return false
     }
 
-    if (!isPointBeforeSelection(selectionEndPoint)({context})) {
+    if (!isPointBeforeSelection(selectionEndPoint)(snapshot)) {
       return false
     }
 

package/src/selectors/selector.is-selection-collapsed.ts

@@ -3,14 +3,15 @@ import type {EditorSelector} from '../editor/editor-selector'
 /**
  * @public
  */
-export const isSelectionCollapsed: EditorSelector<boolean> = ({context}) => {
-  if (!context.selection) {
+export const isSelectionCollapsed: EditorSelector<boolean> = (snapshot) => {
+  if (!snapshot.context.selection) {
     return false
   }
 
   return (
-    JSON.stringify(context.selection.anchor.path) ===
-      JSON.stringify(context.selection.focus.path) &&
-    context.selection?.anchor.offset === context.selection?.focus.offset
+    JSON.stringify(snapshot.context.selection.anchor.path) ===
+      JSON.stringify(snapshot.context.selection.focus.path) &&
+    snapshot.context.selection?.anchor.offset ===
+      snapshot.context.selection?.focus.offset
   )
 }

package/src/selectors/selector.is-selection-expanded.ts

@@ -4,6 +4,6 @@ import {isSelectionCollapsed} from './selector.is-selection-collapsed'
 /**
  * @public
  */
-export const isSelectionExpanded: EditorSelector<boolean> = ({context}) => {
-  return !isSelectionCollapsed({context})
+export const isSelectionExpanded: EditorSelector<boolean> = (snapshot) => {
+  return !isSelectionCollapsed(snapshot)
 }

package/src/selectors/selectors.ts

@@ -17,15 +17,15 @@ import type {EditorSelector} from '../editor/editor-selector'
  */
 export const getFocusBlock: EditorSelector<
   {node: PortableTextBlock; path: [KeyedSegment]} | undefined
-> = ({context}) => {
-  const key = context.selection
-    ? isKeySegment(context.selection.focus.path[0])
-      ? context.selection.focus.path[0]._key
+> = (snapshot) => {
+  const key = snapshot.context.selection
+    ? isKeySegment(snapshot.context.selection.focus.path[0])
+      ? snapshot.context.selection.focus.path[0]._key
       : undefined
     : undefined
 
   const node = key
-    ? context.value.find((block) => block._key === key)
+    ? snapshot.context.value.find((block) => block._key === key)
     : undefined
 
   return node && key ? {node, path: [{_key: key}]} : undefined
@@ -36,9 +36,9 @@ export const getFocusBlock: EditorSelector<
  */
 export const getFocusListBlock: EditorSelector<
   {node: PortableTextListBlock; path: [KeyedSegment]} | undefined
-> = ({context}) => {
-  const guards = createGuards(context)
-  const focusBlock = getFocusBlock({context})
+> = (snapshot) => {
+  const guards = createGuards(snapshot.context)
+  const focusBlock = getFocusBlock(snapshot)
 
   return focusBlock && guards.isListBlock(focusBlock.node)
     ? {node: focusBlock.node, path: focusBlock.path}
@@ -50,8 +50,8 @@ export const getFocusListBlock: EditorSelector<
  */
 export const getFocusTextBlock: EditorSelector<
   {node: PortableTextTextBlock; path: [KeyedSegment]} | undefined
-> = ({context}) => {
-  const focusBlock = getFocusBlock({context})
+> = (snapshot) => {
+  const focusBlock = getFocusBlock(snapshot)
 
   return focusBlock && isPortableTextTextBlock(focusBlock.node)
     ? {node: focusBlock.node, path: focusBlock.path}
@@ -63,8 +63,8 @@ export const getFocusTextBlock: EditorSelector<
  */
 export const getFocusBlockObject: EditorSelector<
   {node: PortableTextObject; path: [KeyedSegment]} | undefined
-> = ({context}) => {
-  const focusBlock = getFocusBlock({context})
+> = (snapshot) => {
+  const focusBlock = getFocusBlock(snapshot)
 
   return focusBlock && !isPortableTextTextBlock(focusBlock.node)
     ? {node: focusBlock.node, path: focusBlock.path}
@@ -80,16 +80,16 @@ export const getFocusChild: EditorSelector<
       path: [KeyedSegment, 'children', KeyedSegment]
     }
   | undefined
-> = ({context}) => {
-  const focusBlock = getFocusTextBlock({context})
+> = (snapshot) => {
+  const focusBlock = getFocusTextBlock(snapshot)
 
   if (!focusBlock) {
     return undefined
   }
 
-  const key = context.selection
-    ? isKeySegment(context.selection.focus.path[2])
-      ? context.selection.focus.path[2]._key
+  const key = snapshot.context.selection
+    ? isKeySegment(snapshot.context.selection.focus.path[2])
+      ? snapshot.context.selection.focus.path[2]._key
       : undefined
     : undefined
 
@@ -108,8 +108,8 @@ export const getFocusChild: EditorSelector<
 export const getFocusSpan: EditorSelector<
   | {node: PortableTextSpan; path: [KeyedSegment, 'children', KeyedSegment]}
   | undefined
-> = ({context}) => {
-  const focusChild = getFocusChild({context})
+> = (snapshot) => {
+  const focusChild = getFocusChild(snapshot)
 
   return focusChild && isPortableTextSpan(focusChild.node)
     ? {node: focusChild.node, path: focusChild.path}
@@ -121,8 +121,8 @@ export const getFocusSpan: EditorSelector<
  */
 export const getFirstBlock: EditorSelector<
   {node: PortableTextBlock; path: [KeyedSegment]} | undefined
-> = ({context}) => {
-  const node = context.value[0]
+> = (snapshot) => {
+  const node = snapshot.context.value[0]
 
   return node ? {node, path: [{_key: node._key}]} : undefined
 }
@@ -132,9 +132,9 @@ export const getFirstBlock: EditorSelector<
  */
 export const getLastBlock: EditorSelector<
   {node: PortableTextBlock; path: [KeyedSegment]} | undefined
-> = ({context}) => {
-  const node = context.value[context.value.length - 1]
-    ? context.value[context.value.length - 1]
+> = (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
@@ -145,33 +145,33 @@ export const getLastBlock: EditorSelector<
  */
 export const getSelectedBlocks: EditorSelector<
   Array<{node: PortableTextBlock; path: [KeyedSegment]}>
-> = ({context}) => {
-  if (!context.selection) {
+> = (snapshot) => {
+  if (!snapshot.context.selection) {
     return []
   }
 
   const selectedBlocks: Array<{node: PortableTextBlock; path: [KeyedSegment]}> =
     []
-  const startKey = context.selection.backward
-    ? isKeySegment(context.selection.focus.path[0])
-      ? context.selection.focus.path[0]._key
+  const startKey = snapshot.context.selection.backward
+    ? isKeySegment(snapshot.context.selection.focus.path[0])
+      ? snapshot.context.selection.focus.path[0]._key
       : undefined
-    : isKeySegment(context.selection.anchor.path[0])
-      ? context.selection.anchor.path[0]._key
+    : isKeySegment(snapshot.context.selection.anchor.path[0])
+      ? snapshot.context.selection.anchor.path[0]._key
       : undefined
-  const endKey = context.selection.backward
-    ? isKeySegment(context.selection.anchor.path[0])
-      ? context.selection.anchor.path[0]._key
+  const endKey = snapshot.context.selection.backward
+    ? isKeySegment(snapshot.context.selection.anchor.path[0])
+      ? snapshot.context.selection.anchor.path[0]._key
       : undefined
-    : isKeySegment(context.selection.focus.path[0])
-      ? context.selection.focus.path[0]._key
+    : isKeySegment(snapshot.context.selection.focus.path[0])
+      ? snapshot.context.selection.focus.path[0]._key
       : undefined
 
   if (!startKey || !endKey) {
     return selectedBlocks
   }
 
-  for (const block of context.value) {
+  for (const block of snapshot.context.value) {
     if (block._key === startKey) {
       selectedBlocks.push({node: block, path: [{_key: block._key}]})
 
@@ -203,21 +203,21 @@ export const getSelectionStartBlock: EditorSelector<
       path: [KeyedSegment]
     }
   | undefined
-> = ({context}) => {
-  if (!context.selection) {
+> = (snapshot) => {
+  if (!snapshot.context.selection) {
     return undefined
   }
 
-  const key = context.selection.backward
-    ? isKeySegment(context.selection.focus.path[0])
-      ? context.selection.focus.path[0]._key
+  const key = snapshot.context.selection.backward
+    ? isKeySegment(snapshot.context.selection.focus.path[0])
+      ? snapshot.context.selection.focus.path[0]._key
       : undefined
-    : isKeySegment(context.selection.anchor.path[0])
-      ? context.selection.anchor.path[0]._key
+    : isKeySegment(snapshot.context.selection.anchor.path[0])
+      ? snapshot.context.selection.anchor.path[0]._key
       : undefined
 
   const node = key
-    ? context.value.find((block) => block._key === key)
+    ? snapshot.context.value.find((block) => block._key === key)
     : undefined
 
   return node && key ? {node, path: [{_key: key}]} : undefined
@@ -232,21 +232,21 @@ export const getSelectionEndBlock: EditorSelector<
       path: [KeyedSegment]
     }
   | undefined
-> = ({context}) => {
-  if (!context.selection) {
+> = (snapshot) => {
+  if (!snapshot.context.selection) {
     return undefined
   }
 
-  const key = context.selection.backward
-    ? isKeySegment(context.selection.anchor.path[0])
-      ? context.selection.anchor.path[0]._key
+  const key = snapshot.context.selection.backward
+    ? isKeySegment(snapshot.context.selection.anchor.path[0])
+      ? snapshot.context.selection.anchor.path[0]._key
       : undefined
-    : isKeySegment(context.selection.focus.path[0])
-      ? context.selection.focus.path[0]._key
+    : isKeySegment(snapshot.context.selection.focus.path[0])
+      ? snapshot.context.selection.focus.path[0]._key
       : undefined
 
   const node = key
-    ? context.value.find((block) => block._key === key)
+    ? snapshot.context.value.find((block) => block._key === key)
     : undefined
 
   return node && key ? {node, path: [{_key: key}]} : undefined
@@ -257,9 +257,9 @@ export const getSelectionEndBlock: EditorSelector<
  */
 export const getPreviousBlock: EditorSelector<
   {node: PortableTextBlock; path: [KeyedSegment]} | undefined
-> = ({context}) => {
+> = (snapshot) => {
   let previousBlock: {node: PortableTextBlock; path: [KeyedSegment]} | undefined
-  const selectionStartBlock = getSelectionStartBlock({context})
+  const selectionStartBlock = getSelectionStartBlock(snapshot)
 
   if (!selectionStartBlock) {
     return undefined
@@ -267,7 +267,7 @@ export const getPreviousBlock: EditorSelector<
 
   let foundSelectionStartBlock = false
 
-  for (const block of context.value) {
+  for (const block of snapshot.context.value) {
     if (block._key === selectionStartBlock.node._key) {
       foundSelectionStartBlock = true
       break
@@ -288,9 +288,9 @@ export const getPreviousBlock: EditorSelector<
  */
 export const getNextBlock: EditorSelector<
   {node: PortableTextBlock; path: [KeyedSegment]} | undefined
-> = ({context}) => {
+> = (snapshot) => {
   let nextBlock: {node: PortableTextBlock; path: [KeyedSegment]} | undefined
-  const selectionEndBlock = getSelectionEndBlock({context})
+  const selectionEndBlock = getSelectionEndBlock(snapshot)
 
   if (!selectionEndBlock) {
     return undefined
@@ -298,7 +298,7 @@ export const getNextBlock: EditorSelector<
 
   let foundSelectionEndBlock = false
 
-  for (const block of context.value) {
+  for (const block of snapshot.context.value) {
     if (block._key === selectionEndBlock.node._key) {
       foundSelectionEndBlock = true
       continue

package/src/types/block-offset.ts

@@ -0,0 +1,9 @@
+import type {KeyedSegment} from '@sanity/types'
+
+/**
+ * @beta
+ */
+export type BlockOffset = {
+  path: [KeyedSegment]
+  offset: number
+}

package/src/utils/index.ts

@@ -1,4 +1,3 @@
-export type {BlockOffset} from '../behaviors/behavior.types'
 export type {EditorSelection, EditorSelectionPoint} from '../types/editor'
 export {
   blockOffsetToSpanSelectionPoint,

package/src/utils/util.block-offset.ts

@@ -4,7 +4,7 @@ import {
   type KeyedSegment,
   type PortableTextBlock,
 } from '@sanity/types'
-import type {BlockOffset} from '../behaviors/behavior.types'
+import type {BlockOffset} from '../types/block-offset'
 import type {EditorSelectionPoint} from '../types/editor'
 import {isKeyedSegment} from './util.is-keyed-segment'