@portabletext/editor 1.48.7 → 1.48.8

package/src/internal-utils/__tests__/dmpToOperations.test.ts

@@ -1,17 +1,16 @@
 import type {DiffMatchPatch} from '@portabletext/patches'
 import {makeDiff, makePatches, stringifyPatches} from '@sanity/diff-match-patch'
-import {
-  isPortableTextSpan,
-  isPortableTextTextBlock,
-  type Path,
-  type PortableTextBlock,
-  type PortableTextSpan,
-  type PortableTextTextBlock,
+import type {
+  Path,
+  PortableTextBlock,
+  PortableTextSpan,
+  PortableTextTextBlock,
 } from '@sanity/types'
 import type {Descendant, Operation} from 'slate'
 import {describe, expect, test} from 'vitest'
 import type {PortableTextSlateEditor} from '../../types/editor'
 import {diffMatchPatch} from '../applyPatch'
+import {isTypedObject} from '../asserters'
 
 describe('operationToPatches: diffMatchPatch', () => {
   test.todo('skips patches for blocks that cannot be found locally')
@@ -152,13 +151,11 @@ function getMockEditor(options: MockEditorOptions): Pick<
 
   function getText(blockKey?: string) {
     return children
-      .filter((child): child is PortableTextTextBlock =>
-        isPortableTextTextBlock(child),
-      )
+      .filter(isTextBlock)
       .filter((child) => (blockKey ? child._key === blockKey : true))
       .flatMap((block) =>
         block.children
-          .filter((span) => isPortableTextSpan(span))
+          .filter((span) => isSpan(span))
           .map((span) => span.text)
           .join(''),
       )
@@ -166,7 +163,11 @@ function getMockEditor(options: MockEditorOptions): Pick<
   }
 
   function isTextBlock(value: unknown): value is PortableTextTextBlock {
-    return isPortableTextTextBlock(value)
+    return isTypedObject(value) && value._type === 'block'
+  }
+
+  function isSpan(value: unknown): value is PortableTextSpan {
+    return isTypedObject(value) && value._type === 'span'
   }
 
   function apply(operation: Operation): void {

package/src/internal-utils/drag-selection.ts

@@ -55,8 +55,14 @@ export function getDragSelection({
     // Looks like we are dragging an empty span
     // Let's drag the entire block instead
     dragSelection = {
-      anchor: utils.getBlockStartPoint(draggedTextBlock),
-      focus: utils.getBlockEndPoint(draggedTextBlock),
+      anchor: utils.getBlockStartPoint({
+        context: snapshot.context,
+        block: draggedTextBlock,
+      }),
+      focus: utils.getBlockEndPoint({
+        context: snapshot.context,
+        block: draggedTextBlock,
+      }),
     }
   }
 
@@ -74,8 +80,14 @@ export function getDragSelection({
       return dragSelection
     }
 
-    const selectionStartPoint = utils.getBlockStartPoint(selectionStartBlock)
-    const selectionEndPoint = utils.getBlockEndPoint(selectionEndBlock)
+    const selectionStartPoint = utils.getBlockStartPoint({
+      context: snapshot.context,
+      block: selectionStartBlock,
+    })
+    const selectionEndPoint = utils.getBlockEndPoint({
+      context: snapshot.context,
+      block: selectionEndBlock,
+    })
 
     const eventSelectionInsideBlocks = selectors.isOverlappingSelection(
       eventSelection,

package/src/internal-utils/event-position.ts

@@ -59,12 +59,18 @@ export function getEventPosition({
       isEditor: false,
       selection: {
         anchor: utils.getBlockStartPoint({
-          node: block,
-          path: [{_key: block._key}],
+          context: editorActor.getSnapshot().context,
+          block: {
+            node: block,
+            path: [{_key: block._key}],
+          },
         }),
         focus: utils.getBlockEndPoint({
-          node: block,
-          path: [{_key: block._key}],
+          context: editorActor.getSnapshot().context,
+          block: {
+            node: block,
+            path: [{_key: block._key}],
+          },
         }),
       },
     }
@@ -93,12 +99,18 @@ export function getEventPosition({
       isEditor: false,
       selection: {
         anchor: utils.getBlockStartPoint({
-          node: block,
-          path: [{_key: block._key}],
+          context: editorActor.getSnapshot().context,
+          block: {
+            node: block,
+            path: [{_key: block._key}],
+          },
         }),
         focus: utils.getBlockEndPoint({
-          node: block,
-          path: [{_key: block._key}],
+          context: editorActor.getSnapshot().context,
+          block: {
+            node: block,
+            path: [{_key: block._key}],
+          },
         }),
       },
     }

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

@@ -1,5 +1,6 @@
 import type {
   PortableTextBlock,
+  PortableTextListBlock,
   PortableTextObject,
   PortableTextSpan,
   PortableTextTextBlock,
@@ -79,14 +80,25 @@ function parseBlockObject({
   })
 }
 
+export function isListBlock(
+  context: Pick<EditorContext, 'schema'>,
+  block: unknown,
+): block is PortableTextListBlock {
+  return (
+    isTextBlock(context, block) &&
+    block.level !== undefined &&
+    block.listItem !== undefined
+  )
+}
+
 export function isTextBlock(
-  schema: EditorSchema,
+  context: Pick<EditorContext, 'schema'>,
   block: unknown,
 ): block is PortableTextTextBlock {
   return (
     parseTextBlock({
       block,
-      context: {schema, keyGenerator: () => ''},
+      context: {schema: context.schema, keyGenerator: () => ''},
       options: {refreshKeys: false},
     }) !== undefined
   )
@@ -215,14 +227,14 @@ function parseTextBlock({
 }
 
 export function isSpan(
-  schema: EditorSchema,
-  child: PortableTextSpan | PortableTextObject,
+  context: Pick<EditorContext, 'schema'>,
+  child: unknown,
 ): child is PortableTextSpan {
   return (
     parseSpan({
       span: child,
       markDefKeyMap: new Map(),
-      context: {schema, keyGenerator: () => ''},
+      context: {schema: context.schema, keyGenerator: () => ''},
       options: {refreshKeys: false},
     }) !== undefined
   )

package/src/internal-utils/validateValue.ts

@@ -1,13 +1,13 @@
 import {insert, set, setIfMissing, unset} from '@portabletext/patches'
-import {
-  isPortableTextTextBlock,
-  type PortableTextBlock,
-  type PortableTextSpan,
-  type PortableTextTextBlock,
+import type {
+  PortableTextBlock,
+  PortableTextSpan,
+  PortableTextTextBlock,
 } from '@sanity/types'
 import {flatten, isPlainObject, uniq} from 'lodash'
 import type {EditorSchema} from '../editor/editor-schema'
 import type {InvalidValueResolution} from '../types/editor'
+import {isTextBlock} from './parse-blocks'
 
 export interface Validation {
   valid: boolean
@@ -118,7 +118,7 @@ export function validateValue(
         // If the block has no `_type`, but aside from that is a valid Portable Text block
         if (
           !blk._type &&
-          isPortableTextTextBlock({...blk, _type: types.block.name})
+          isTextBlock({schema: types}, {...blk, _type: types.block.name})
         ) {
           resolution = {
             patches: [

package/src/plugins/plugin.decorator-shortcut.ts

@@ -89,11 +89,11 @@ const selectionListenerCallback: CallbackLogicFunction<
         }
 
         const anchor = utils.spanSelectionPointToBlockOffset({
-          value: snapshot.context.value,
+          context: snapshot.context,
           selectionPoint: event.at.anchor,
         })
         const focus = utils.spanSelectionPointToBlockOffset({
-          value: snapshot.context.value,
+          context: snapshot.context,
           selectionPoint: event.at.focus,
         })
 

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

@@ -1,5 +1,6 @@
-import {isPortableTextTextBlock, type PortableTextObject} from '@sanity/types'
+import type {PortableTextObject} from '@sanity/types'
 import type {EditorSelector} from '../editor/editor-selector'
+import {isTextBlock} from '../internal-utils/parse-blocks'
 import {getSelectedSpans} from './selector.get-selected-spans'
 import {isSelectionCollapsed} from './selector.is-selection-collapsed'
 import {getFocusSpan, getSelectedBlocks} from './selectors'
@@ -34,7 +35,9 @@ export const getActiveAnnotations: EditorSelector<Array<PortableTextObject>> = (
   }
 
   const selectionMarkDefs = selectedBlocks.flatMap((block) =>
-    isPortableTextTextBlock(block.node) ? (block.node.markDefs ?? []) : [],
+    isTextBlock(snapshot.context, block.node)
+      ? (block.node.markDefs ?? [])
+      : [],
   )
 
   return selectionMarkDefs.filter((markDef) =>

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

@@ -1,6 +1,6 @@
 import type {PortableTextListBlock} from '@sanity/types'
-import {createGuards} from '../behavior-actions/behavior.guards'
 import type {EditorSelector} from '../editor/editor-selector'
+import {isTextBlock} from '../internal-utils/parse-blocks'
 import {getSelectedBlocks} from './selectors'
 
 /**
@@ -13,9 +13,10 @@ export const getActiveListItem: EditorSelector<
     return undefined
   }
 
-  const guards = createGuards(snapshot.context)
   const selectedBlocks = getSelectedBlocks(snapshot).map((block) => block.node)
-  const selectedTextBlocks = selectedBlocks.filter(guards.isTextBlock)
+  const selectedTextBlocks = selectedBlocks.filter((block) =>
+    isTextBlock(snapshot.context, block),
+  )
 
   const firstTextBlock = selectedTextBlocks.at(0)
 

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

@@ -1,6 +1,6 @@
 import type {PortableTextTextBlock} from '@sanity/types'
-import {createGuards} from '../behavior-actions/behavior.guards'
 import type {EditorSelector} from '../editor/editor-selector'
+import {isTextBlock} from '../internal-utils/parse-blocks'
 import {getSelectedBlocks} from './selectors'
 
 /**
@@ -13,9 +13,10 @@ export const getActiveStyle: EditorSelector<PortableTextTextBlock['style']> = (
     return undefined
   }
 
-  const guards = createGuards(snapshot.context)
   const selectedBlocks = getSelectedBlocks(snapshot).map((block) => block.node)
-  const selectedTextBlocks = selectedBlocks.filter(guards.isTextBlock)
+  const selectedTextBlocks = selectedBlocks.filter((block) =>
+    isTextBlock(snapshot.context, block),
+  )
 
   const firstTextBlock = selectedTextBlocks.at(0)
 

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

@@ -1,9 +1,6 @@
-import {
-  isPortableTextTextBlock,
-  type KeyedSegment,
-  type PortableTextTextBlock,
-} from '@sanity/types'
+import type {KeyedSegment, PortableTextTextBlock} from '@sanity/types'
 import type {EditorSelector} from '../editor/editor-selector'
+import {isTextBlock} from '../internal-utils/parse-blocks'
 import {getAnchorBlock} from './selector.get-anchor-block'
 
 /**
@@ -14,7 +11,7 @@ export const getAnchorTextBlock: EditorSelector<
 > = (snapshot) => {
   const anchorBlock = getAnchorBlock(snapshot)
 
-  return anchorBlock && isPortableTextTextBlock(anchorBlock.node)
+  return anchorBlock && isTextBlock(snapshot.context, anchorBlock.node)
     ? {node: anchorBlock.node, path: anchorBlock.path}
     : undefined
 }

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

@@ -22,11 +22,11 @@ export const getBlockOffsets: EditorSelector<
   }
 
   const start = utils.spanSelectionPointToBlockOffset({
-    value: snapshot.context.value,
+    context: snapshot.context,
     selectionPoint: selectionStartPoint,
   })
   const end = utils.spanSelectionPointToBlockOffset({
-    value: snapshot.context.value,
+    context: snapshot.context,
     selectionPoint: selectionEndPoint,
   })
 

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

@@ -35,7 +35,7 @@ export const getCaretWordSelection: EditorSelector<EditorSelection> = (
   const selectionStartPoint = getSelectionStartPoint(snapshot)
   const selectionStartOffset = selectionStartPoint
     ? spanSelectionPointToBlockOffset({
-        value: snapshot.context.value,
+        context: snapshot.context,
         selectionPoint: selectionStartPoint,
       })
     : undefined
@@ -45,7 +45,10 @@ export const getCaretWordSelection: EditorSelector<EditorSelection> = (
   }
 
   const previousInlineObject = getPreviousInlineObject(snapshot)
-  const blockStartPoint = getBlockStartPoint(focusTextBlock)
+  const blockStartPoint = getBlockStartPoint({
+    context: snapshot.context,
+    block: focusTextBlock,
+  })
   const textBefore = getSelectionText({
     ...snapshot,
     context: {
@@ -61,7 +64,10 @@ export const getCaretWordSelection: EditorSelector<EditorSelection> = (
   const textDirectlyBefore = textBefore.split(/\s+/).at(-1)
 
   const nextInlineObject = getNextInlineObject(snapshot)
-  const blockEndPoint = getBlockEndPoint(focusTextBlock)
+  const blockEndPoint = getBlockEndPoint({
+    context: snapshot.context,
+    block: focusTextBlock,
+  })
   const textAfter = getSelectionText({
     ...snapshot,
     context: {
@@ -97,12 +103,12 @@ export const getCaretWordSelection: EditorSelector<EditorSelection> = (
     : selectionStartOffset
 
   const caretWordStartSelectionPoint = blockOffsetToSpanSelectionPoint({
-    value: snapshot.context.value,
+    context: snapshot.context,
     blockOffset: caretWordStartOffset,
     direction: 'backward',
   })
   const caretWordEndSelectionPoint = blockOffsetToSpanSelectionPoint({
-    value: snapshot.context.value,
+    context: snapshot.context,
     blockOffset: caretWordEndOffset,
     direction: 'forward',
   })

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

@@ -9,7 +9,7 @@ export const getSelectedSlice: EditorSelector<Array<PortableTextBlock>> = (
   snapshot,
 ) => {
   return sliceBlocks({
+    context: snapshot.context,
     blocks: snapshot.context.value,
-    selection: snapshot.context.selection,
   })
 }

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

@@ -1,11 +1,7 @@
-import {
-  isKeySegment,
-  isPortableTextSpan,
-  isPortableTextTextBlock,
-  type KeyedSegment,
-  type PortableTextSpan,
-} from '@sanity/types'
+import type {KeyedSegment, PortableTextSpan} from '@sanity/types'
 import type {EditorSelector} from '../editor/editor-selector'
+import {isSpan, isTextBlock} from '../internal-utils/parse-blocks'
+import {isKeyedSegment} from '../utils'
 
 /**
  * @public
@@ -32,10 +28,10 @@ export const getSelectedSpans: EditorSelector<
     ? snapshot.context.selection.anchor
     : snapshot.context.selection.focus
 
-  const startBlockKey = isKeySegment(startPoint.path[0])
+  const startBlockKey = isKeyedSegment(startPoint.path[0])
     ? startPoint.path[0]._key
     : undefined
-  const endBlockKey = isKeySegment(endPoint.path[0])
+  const endBlockKey = isKeyedSegment(endPoint.path[0])
     ? endPoint.path[0]._key
     : undefined
 
@@ -43,10 +39,10 @@ export const getSelectedSpans: EditorSelector<
     return selectedSpans
   }
 
-  const startSpanKey = isKeySegment(startPoint.path[2])
+  const startSpanKey = isKeyedSegment(startPoint.path[2])
     ? startPoint.path[2]._key
     : undefined
-  const endSpanKey = isKeySegment(endPoint.path[2])
+  const endSpanKey = isKeyedSegment(endPoint.path[2])
     ? endPoint.path[2]._key
     : undefined
 
@@ -57,13 +53,13 @@ export const getSelectedSpans: EditorSelector<
       startBlockFound = true
     }
 
-    if (!isPortableTextTextBlock(block)) {
+    if (!isTextBlock(snapshot.context, block)) {
       continue
     }
 
     if (block._key === startBlockKey) {
       for (const child of block.children) {
-        if (!isPortableTextSpan(child)) {
+        if (!isSpan(snapshot.context, child)) {
           continue
         }
 
@@ -109,7 +105,7 @@ export const getSelectedSpans: EditorSelector<
 
     if (block._key === endBlockKey) {
       for (const child of block.children) {
-        if (!isPortableTextSpan(child)) {
+        if (!isSpan(snapshot.context, child)) {
           continue
         }
 
@@ -134,7 +130,7 @@ export const getSelectedSpans: EditorSelector<
 
     if (startBlockFound) {
       for (const child of block.children) {
-        if (!isPortableTextSpan(child)) {
+        if (!isSpan(snapshot.context, child)) {
           continue
         }
 

package/src/selectors/selector.get-selected-text-blocks.ts

@@ -38,7 +38,7 @@ export const getSelectedTextBlocks: EditorSelector<
 
   for (const block of snapshot.context.value) {
     if (block._key === startKey) {
-      if (isTextBlock(snapshot.context.schema, block)) {
+      if (isTextBlock(snapshot.context, block)) {
         selectedTextBlocks.push({node: block, path: [{_key: block._key}]})
       }
 
@@ -49,7 +49,7 @@ export const getSelectedTextBlocks: EditorSelector<
     }
 
     if (block._key === endKey) {
-      if (isTextBlock(snapshot.context.schema, block)) {
+      if (isTextBlock(snapshot.context, block)) {
         selectedTextBlocks.push({node: block, path: [{_key: block._key}]})
       }
 
@@ -57,7 +57,7 @@ export const getSelectedTextBlocks: EditorSelector<
     }
 
     if (selectedTextBlocks.length > 0) {
-      if (isTextBlock(snapshot.context.schema, block)) {
+      if (isTextBlock(snapshot.context, block)) {
         selectedTextBlocks.push({node: block, path: [{_key: block._key}]})
       }
     }

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

@@ -1,5 +1,5 @@
-import {isPortableTextSpan, isPortableTextTextBlock} from '@sanity/types'
 import type {EditorSelector} from '../editor/editor-selector'
+import {isSpan, isTextBlock} from '../internal-utils/parse-blocks'
 import {getSelectedSlice} from './selector.get-selected-slice'
 
 /**
@@ -9,14 +9,14 @@ export const getSelectionText: EditorSelector<string> = (snapshot) => {
   const selectedSlice = getSelectedSlice(snapshot)
 
   return selectedSlice.reduce((text, block) => {
-    if (!isPortableTextTextBlock(block)) {
+    if (!isTextBlock(snapshot.context, block)) {
       return text
     }
 
     return (
       text +
       block.children.reduce((text, child) => {
-        if (isPortableTextSpan(child)) {
+        if (isSpan(snapshot.context, child)) {
           return text + child.text
         }
 

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

@@ -27,8 +27,11 @@ export const getBlockTextBefore: EditorSelector<string> = (snapshot) => {
   }
 
   const startOfBlock = getBlockStartPoint({
-    node: block,
-    path: [{_key: block._key}],
+    context: snapshot.context,
+    block: {
+      node: block,
+      path: [{_key: block._key}],
+    },
   })
 
   return getSelectionText({

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

@@ -1,9 +1,6 @@
-import {
-  isPortableTextSpan,
-  isPortableTextTextBlock,
-  type PortableTextSpan,
-} from '@sanity/types'
+import type {PortableTextSpan} from '@sanity/types'
 import type {EditorSelector} from '../editor/editor-selector'
+import {isSpan, isTextBlock} from '../internal-utils/parse-blocks'
 import type {EditorSelection, EditorSelectionPoint} from '../types/editor'
 import {isEmptyTextBlock, isKeyedSegment} from '../utils'
 import {getSelectionEndPoint} from './selector.get-selection-end-point'
@@ -58,7 +55,10 @@ export const getTrimmedSelection: EditorSelector<EditorSelection> = (
     if (block._key === startBlockKey) {
       startBlockFound = true
 
-      if (isPortableTextTextBlock(block) && isEmptyTextBlock(block)) {
+      if (
+        isTextBlock(snapshot.context, block) &&
+        isEmptyTextBlock(snapshot.context, block)
+      ) {
         continue
       }
     }
@@ -67,17 +67,20 @@ export const getTrimmedSelection: EditorSelector<EditorSelection> = (
       continue
     }
 
-    if (!isPortableTextTextBlock(block)) {
+    if (!isTextBlock(snapshot.context, block)) {
       continue
     }
 
-    if (block._key === endBlockKey && isEmptyTextBlock(block)) {
+    if (
+      block._key === endBlockKey &&
+      isEmptyTextBlock(snapshot.context, block)
+    ) {
       break
     }
 
     for (const child of block.children) {
       if (child._key === endChildKey) {
-        if (!isPortableTextSpan(child) || endPoint.offset === 0) {
+        if (!isSpan(snapshot.context, child) || endPoint.offset === 0) {
           adjustedEndPoint = previousPotentialEndpoint
             ? {
                 path: [
@@ -96,10 +99,10 @@ export const getTrimmedSelection: EditorSelector<EditorSelection> = (
 
       if (trimStartPoint) {
         const lonelySpan =
-          isPortableTextSpan(child) && block.children.length === 1
+          isSpan(snapshot.context, child) && block.children.length === 1
 
         if (
-          (isPortableTextSpan(child) && child.text.length > 0) ||
+          (isSpan(snapshot.context, child) && child.text.length > 0) ||
           lonelySpan
         ) {
           adjustedStartPoint = {
@@ -114,7 +117,7 @@ export const getTrimmedSelection: EditorSelector<EditorSelection> = (
       }
 
       if (child._key === startChildKey) {
-        if (!isPortableTextSpan(child)) {
+        if (!isSpan(snapshot.context, child)) {
           trimStartPoint = true
           continue
         }
@@ -130,7 +133,7 @@ export const getTrimmedSelection: EditorSelector<EditorSelection> = (
       }
 
       previousPotentialEndpoint =
-        isPortableTextSpan(child) && child.text.length > 0
+        isSpan(snapshot.context, child) && child.text.length > 0
           ? {blockKey: block._key, span: child}
           : previousPotentialEndpoint
     }
@@ -168,7 +171,10 @@ export const getTrimmedSelection: EditorSelector<EditorSelection> = (
       },
     })
 
-    if (focusTextBlock && !isEmptyTextBlock(focusTextBlock.node)) {
+    if (
+      focusTextBlock &&
+      !isEmptyTextBlock(snapshot.context, focusTextBlock.node)
+    ) {
       return null
     }
   }

package/src/selectors/selector.is-active-annotation.ts

@@ -1,5 +1,5 @@
-import {isPortableTextTextBlock} from '@sanity/types'
 import type {EditorSelector} from '../editor/editor-selector'
+import {isTextBlock} from '../internal-utils/parse-blocks'
 import {getSelectedSpans} from './selector.get-selected-spans'
 import {isSelectionExpanded} from './selector.is-selection-expanded'
 import {getFocusSpan, getSelectedBlocks} from './selectors'
@@ -37,7 +37,9 @@ export function isActiveAnnotation(
     }
 
     const selectionMarkDefs = selectedBlocks.flatMap((block) =>
-      isPortableTextTextBlock(block.node) ? (block.node.markDefs ?? []) : [],
+      isTextBlock(snapshot.context, block.node)
+        ? (block.node.markDefs ?? [])
+        : [],
     )
 
     return selectedSpans.every((span) => {

package/src/selectors/selector.is-active-decorator.test.ts

@@ -21,7 +21,7 @@ test(isActiveDecorator.name, () => {
       snapshot(
         [
           {
-            _type: '_block',
+            _type: 'block',
             _key: 'b1',
             children: [
               {
@@ -57,7 +57,7 @@ test(isActiveDecorator.name, () => {
       snapshot(
         [
           {
-            _type: '_block',
+            _type: 'block',
             _key: 'b1',
             children: [
               {
@@ -94,7 +94,7 @@ test(isActiveDecorator.name, () => {
         [
           {_key: 'b0', _type: 'image'},
           {
-            _type: '_block',
+            _type: 'block',
             _key: 'b1',
             children: [
               {