@portabletext/editor 1.34.1 → 1.35.1

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

@@ -1,11 +1,11 @@
 import type {EditorSelector} from '../editor/editor-selector'
+import type {BlockOffset} from '../types/block-offset'
 import type {EditorSelection} from '../types/editor'
 import {
   blockOffsetToSpanSelectionPoint,
   getBlockEndPoint,
   getBlockStartPoint,
   spanSelectionPointToBlockOffset,
-  type BlockOffset,
 } from '../utils'
 import {getNextInlineObject} from './selector.get-next-inline-object'
 import {getPreviousInlineObject} from './selector.get-previous-inline-object'
@@ -20,22 +20,22 @@ import {getFocusTextBlock} from './selectors'
  * Returns the selection of the of the word the caret is placed in.
  * Note: Only returns a word selection if the current selection is collapsed
  */
-export const getCaretWordSelection: EditorSelector<EditorSelection> = ({
-  context,
-}) => {
-  if (!context.selection) {
+export const getCaretWordSelection: EditorSelector<EditorSelection> = (
+  snapshot,
+) => {
+  if (!snapshot.context.selection) {
     return null
   }
 
-  if (!isSelectionCollapsed({context})) {
+  if (!isSelectionCollapsed(snapshot)) {
     return null
   }
 
-  const focusTextBlock = getFocusTextBlock({context})
-  const selectionStartPoint = getSelectionStartPoint({context})
+  const focusTextBlock = getFocusTextBlock(snapshot)
+  const selectionStartPoint = getSelectionStartPoint(snapshot)
   const selectionStartOffset = selectionStartPoint
     ? spanSelectionPointToBlockOffset({
-        value: context.value,
+        value: snapshot.context.value,
         selectionPoint: selectionStartPoint,
       })
     : undefined
@@ -44,11 +44,12 @@ export const getCaretWordSelection: EditorSelector<EditorSelection> = ({
     return null
   }
 
-  const previousInlineObject = getPreviousInlineObject({context})
+  const previousInlineObject = getPreviousInlineObject(snapshot)
   const blockStartPoint = getBlockStartPoint(focusTextBlock)
   const textBefore = getSelectionText({
+    ...snapshot,
     context: {
-      ...context,
+      ...snapshot.context,
       selection: {
         anchor: previousInlineObject
           ? {path: previousInlineObject.path, offset: 0}
@@ -59,11 +60,12 @@ export const getCaretWordSelection: EditorSelector<EditorSelection> = ({
   })
   const textDirectlyBefore = textBefore.split(/\s+/).at(-1)
 
-  const nextInlineObject = getNextInlineObject({context})
+  const nextInlineObject = getNextInlineObject(snapshot)
   const blockEndPoint = getBlockEndPoint(focusTextBlock)
   const textAfter = getSelectionText({
+    ...snapshot,
     context: {
-      ...context,
+      ...snapshot.context,
       selection: {
         anchor: selectionStartPoint,
         focus: nextInlineObject
@@ -95,12 +97,12 @@ export const getCaretWordSelection: EditorSelector<EditorSelection> = ({
     : selectionStartOffset
 
   const caretWordStartSelectionPoint = blockOffsetToSpanSelectionPoint({
-    value: context.value,
+    value: snapshot.context.value,
     blockOffset: caretWordStartOffset,
     direction: 'backward',
   })
   const caretWordEndSelectionPoint = blockOffsetToSpanSelectionPoint({
-    value: context.value,
+    value: snapshot.context.value,
     blockOffset: caretWordEndOffset,
     direction: 'forward',
   })
@@ -115,8 +117,9 @@ export const getCaretWordSelection: EditorSelector<EditorSelection> = ({
   }
 
   return isSelectionExpanded({
+    ...snapshot,
     context: {
-      ...context,
+      ...snapshot.context,
       selection: caretWordSelection,
     },
   })

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

@@ -17,9 +17,9 @@ export const getNextInlineObject: EditorSelector<
       path: [KeyedSegment, 'children', KeyedSegment]
     }
   | undefined
-> = ({context}) => {
-  const focusTextBlock = getFocusTextBlock({context})
-  const selectionEndPoint = getSelectionEndPoint({context})
+> = (snapshot) => {
+  const focusTextBlock = getFocusTextBlock(snapshot)
+  const selectionEndPoint = getSelectionEndPoint(snapshot)
   const selectionEndPointChildKey =
     selectionEndPoint && isKeySegment(selectionEndPoint.path[2])
       ? selectionEndPoint.path[2]._key
@@ -43,7 +43,7 @@ export const getNextInlineObject: EditorSelector<
       continue
     }
 
-    if (!isSpan(context, child) && endPointChildFound) {
+    if (!isSpan(snapshot.context, child) && endPointChildFound) {
       inlineObject = {
         node: child,
         path: [...focusTextBlock.path, 'children', {_key: child._key}],

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.test.ts

@@ -1,7 +1,7 @@
 import type {PortableTextBlock} from '@sanity/types'
 import {describe, expect, test} from 'vitest'
-import {getSelectedSpans, type EditorSchema, type EditorSelection} from '.'
-import type {EditorSnapshot} from '../editor/editor-snapshot'
+import {getSelectedSpans, type EditorSelection} from '.'
+import {createTestSnapshot} from '../internal-utils/create-test-snapshot'
 
 const fooBar = {
   _type: 'block',
@@ -40,17 +40,13 @@ describe(getSelectedSpans.name, () => {
   function snapshot(
     value: Array<PortableTextBlock>,
     selection: EditorSelection,
-  ): EditorSnapshot {
-    return {
+  ) {
+    return createTestSnapshot({
       context: {
-        converters: [],
-        schema: {} as EditorSchema,
-        keyGenerator: () => '',
-        activeDecorators: [],
         value,
         selection,
       },
-    }
+    })
   }
 
   test('selecting a single span', () => {

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.test.ts

@@ -1,7 +1,8 @@
 import type {PortableTextBlock} from '@sanity/types'
 import {expect, test} from 'vitest'
-import type {EditorSelection, EditorSnapshot} from '.'
+import type {EditorSelection} from '.'
 import {compileSchemaDefinition, defineSchema} from '../editor/define-schema'
+import {createTestSnapshot} from '../internal-utils/create-test-snapshot'
 import {getSelectionText} from './selector.get-selection-text'
 
 const brokenBlock = {
@@ -67,21 +68,18 @@ test(getSelectionText.name, () => {
   function snapshot(
     value: Array<PortableTextBlock>,
     selection: EditorSelection,
-  ): EditorSnapshot {
-    return {
+  ) {
+    return createTestSnapshot({
       context: {
-        converters: [],
         schema: compileSchemaDefinition(
           defineSchema({
             inlineObjects: [{name: 'stock-ticker'}],
           }),
         ),
-        keyGenerator: () => '',
-        activeDecorators: [],
         value,
         selection,
       },
-    }
+    })
   }
 
   expect(

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.test.ts

@@ -1,7 +1,7 @@
 import type {PortableTextBlock} from '@sanity/types'
 import {describe, expect, test} from 'vitest'
 import {compileSchemaDefinition, defineSchema} from '../editor/define-schema'
-import type {EditorSnapshot} from '../editor/editor-snapshot'
+import {createTestSnapshot} from '../internal-utils/create-test-snapshot'
 import {parseBlock} from '../internal-utils/parse-blocks'
 import {createTestKeyGenerator} from '../internal-utils/test-key-generator'
 import type {EditorSelection} from '../types/editor'
@@ -20,10 +20,8 @@ function snapshot(
     }),
   )
 
-  return {
+  return createTestSnapshot({
     context: {
-      activeDecorators: [],
-      converters: [],
       keyGenerator,
       schema,
       selection,
@@ -42,7 +40,7 @@ function snapshot(
         return parsedBlock ? [parsedBlock] : []
       }),
     },
-  } satisfies EditorSnapshot
+  })
 }
 
 function createSpan(text: string, marks: Array<string> = []) {

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-active-decorator.test.ts

@@ -1,16 +1,12 @@
 import {expect, test} from 'vitest'
-import type {EditorSchema, EditorSelection} from '.'
-import type {EditorSnapshot} from '../editor/editor-snapshot'
+import type {EditorSelection} from '.'
+import {createTestSnapshot} from '../internal-utils/create-test-snapshot'
 import {isActiveDecorator} from './selector.is-active-decorator'
 
 test(isActiveDecorator.name, () => {
-  function snapshot(selection: EditorSelection): EditorSnapshot {
-    return {
+  function snapshot(selection: EditorSelection) {
+    return createTestSnapshot({
       context: {
-        converters: [],
-        schema: {} as EditorSchema,
-        keyGenerator: () => '',
-        activeDecorators: [],
         value: [
           {
             _type: '_block',
@@ -32,7 +28,7 @@ test(isActiveDecorator.name, () => {
         ],
         selection,
       },
-    }
+    })
   }
 
   expect(

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)
 }