@portabletext/editor 1.34.1 → 1.35.1

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'
 

package/src/utils/util.block-offsets-to-selection.ts

@@ -1,6 +1,6 @@
 import type {PortableTextBlock} from '@sanity/types'
-import type {BlockOffset} from '../behaviors'
 import type {EditorSelection} from '../selectors'
+import type {BlockOffset} from '../types/block-offset'
 import {blockOffsetToSpanSelectionPoint} from './util.block-offset'
 
 /**

package/src/utils/util.child-selection-point-to-block-offset.ts

@@ -3,7 +3,7 @@ import {
   isPortableTextTextBlock,
   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'