@portabletext/editor 1.34.1 → 1.35.0

package/lib/selectors/index.d.cts

@@ -6,8 +6,6 @@ import type {
   BlockStyleDefinition,
   ObjectSchemaType,
   Path,
-  PathSegment,
-  PortableTextChild,
 } from '@sanity/types'
 import {
   KeyedSegment,
@@ -26,51 +24,6 @@ declare type BlockOffset = {
   offset: number
 }
 
-/**
- * @public
- */
-declare function blockOffsetsToSelection({
-  value,
-  offsets,
-  backward,
-}: {
-  value: Array<PortableTextBlock>
-  offsets: {
-    anchor: BlockOffset
-    focus: BlockOffset
-  }
-  backward?: boolean
-}): EditorSelection
-
-/**
- * @public
- */
-declare function blockOffsetToSpanSelectionPoint({
-  value,
-  blockOffset,
-  direction,
-}: {
-  value: Array<PortableTextBlock>
-  blockOffset: BlockOffset
-  direction: 'forward' | 'backward'
-}):
-  | {
-      path: [KeyedSegment, 'children', KeyedSegment]
-      offset: number
-    }
-  | undefined
-
-/**
- * @public
- */
-declare function childSelectionPointToBlockOffset({
-  value,
-  selectionPoint,
-}: {
-  value: Array<PortableTextBlock>
-  selectionPoint: EditorSelectionPoint
-}): BlockOffset | undefined
-
 declare type Converter<TMIMEType extends MIMEType = MIMEType> = {
   mimeType: TMIMEType
   serialize: Serializer<TMIMEType>
@@ -110,10 +63,10 @@ declare type ConverterEvent<TMIMEType extends MIMEType = MIMEType> =
     }
 
 declare type Deserializer<TMIMEType extends MIMEType> = ({
-  context,
+  snapshot,
   event,
 }: {
-  context: EditorContext
+  snapshot: EditorSnapshot
   event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'deserialize'>
 }) => PickFromUnion<
   ConverterEvent<TMIMEType>,
@@ -230,39 +183,17 @@ export declare const getAnchorTextBlock: EditorSelector<
   | undefined
 >
 
-/**
- * @public
- */
-declare function getBlockEndPoint({
-  node,
-  path,
-}: {
-  node: PortableTextBlock
-  path: [KeyedSegment]
-}): EditorSelectionPoint
-
 /**
  * @public
  */
 export declare const getBlockOffsets: EditorSelector<
   | {
-      start: utils.BlockOffset
-      end: utils.BlockOffset
+      start: BlockOffset
+      end: BlockOffset
     }
   | undefined
 >
 
-/**
- * @public
- */
-declare function getBlockStartPoint({
-  node,
-  path,
-}: {
-  node: PortableTextBlock
-  path: [KeyedSegment]
-}): EditorSelectionPoint
-
 /**
  * @public
  */
@@ -479,11 +410,6 @@ export declare const getSelectionStartPoint: EditorSelector<
  */
 export declare const getSelectionText: EditorSelector<string>
 
-/**
- * @public
- */
-declare function getTextBlockText(block: PortableTextTextBlock): string
-
 /**
  * @public
  */
@@ -536,24 +462,6 @@ export declare function isAtTheStartOfBlock(block: {
   path: [KeyedSegment]
 }): EditorSelector<boolean>
 
-/**
- * @public
- */
-declare function isEmptyTextBlock(block: PortableTextBlock): boolean
-
-/**
- * @public
- */
-declare function isEqualSelectionPoints(
-  a: EditorSelectionPoint,
-  b: EditorSelectionPoint,
-): boolean
-
-/**
- * @public
- */
-declare function isKeyedSegment(segment: PathSegment): segment is KeyedSegment
-
 /**
  * @public
  */
@@ -585,35 +493,6 @@ export declare const isSelectionCollapsed: EditorSelector<boolean>
  */
 export declare const isSelectionExpanded: EditorSelector<boolean>
 
-/**
- * @public
- */
-declare function isSpan(
-  context: Pick<EditorContext, 'schema'>,
-  child: PortableTextChild,
-): child is PortableTextSpan
-
-/**
- * @public
- */
-declare function isTextBlock(
-  context: Pick<EditorContext, 'schema'>,
-  block: PortableTextBlock,
-): block is PortableTextTextBlock
-
-/**
- * @beta
- */
-declare function mergeTextBlocks({
-  context,
-  targetBlock,
-  incomingBlock,
-}: {
-  context: Pick<EditorContext, 'keyGenerator' | 'schema'>
-  targetBlock: PortableTextTextBlock
-  incomingBlock: PortableTextTextBlock
-}): PortableTextTextBlock<PortableTextSpan | PortableTextObject>
-
 declare type MIMEType = `${string}/${string}`
 
 /**
@@ -640,18 +519,11 @@ export declare type PortableTextMemberSchemaTypes = {
   lists: BlockListDefinition[]
 }
 
-/**
- * @public
- */
-declare function reverseSelection(
-  selection: NonNullable<EditorSelection>,
-): NonNullable<EditorSelection>
-
 declare type Serializer<TMIMEType extends MIMEType> = ({
-  context,
+  snapshot,
   event,
 }: {
-  context: EditorContext
+  snapshot: EditorSnapshot
   event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'serialize'>
 }) => PickFromUnion<
   ConverterEvent<TMIMEType>,
@@ -659,68 +531,4 @@ declare type Serializer<TMIMEType extends MIMEType> = ({
   'serialization.success' | 'serialization.failure'
 >
 
-/**
- * @public
- */
-declare function sliceBlocks({
-  blocks,
-  selection,
-}: {
-  blocks: Array<PortableTextBlock>
-  selection: EditorSelection
-}): Array<PortableTextBlock>
-
-/**
- * @public
- */
-declare function spanSelectionPointToBlockOffset({
-  value,
-  selectionPoint,
-}: {
-  value: Array<PortableTextBlock>
-  selectionPoint: EditorSelectionPoint
-}): BlockOffset | undefined
-
-/**
- * @beta
- */
-declare function splitTextBlock({
-  context,
-  block,
-  point,
-}: {
-  context: Pick<EditorContext, 'schema'>
-  block: PortableTextTextBlock
-  point: EditorSelectionPoint
-}):
-  | {
-      before: PortableTextTextBlock
-      after: PortableTextTextBlock
-    }
-  | undefined
-
-declare namespace utils {
-  export {
-    BlockOffset,
-    EditorSelection,
-    EditorSelectionPoint,
-    blockOffsetToSpanSelectionPoint,
-    spanSelectionPointToBlockOffset,
-    blockOffsetsToSelection,
-    childSelectionPointToBlockOffset,
-    getBlockEndPoint,
-    getBlockStartPoint,
-    getTextBlockText,
-    isEmptyTextBlock,
-    isEqualSelectionPoints,
-    isKeyedSegment,
-    isSpan,
-    isTextBlock,
-    mergeTextBlocks,
-    reverseSelection,
-    sliceBlocks,
-    splitTextBlock,
-  }
-}
-
 export {}

package/lib/selectors/index.d.ts

@@ -6,8 +6,6 @@ import type {
   BlockStyleDefinition,
   ObjectSchemaType,
   Path,
-  PathSegment,
-  PortableTextChild,
 } from '@sanity/types'
 import {
   KeyedSegment,
@@ -26,51 +24,6 @@ declare type BlockOffset = {
   offset: number
 }
 
-/**
- * @public
- */
-declare function blockOffsetsToSelection({
-  value,
-  offsets,
-  backward,
-}: {
-  value: Array<PortableTextBlock>
-  offsets: {
-    anchor: BlockOffset
-    focus: BlockOffset
-  }
-  backward?: boolean
-}): EditorSelection
-
-/**
- * @public
- */
-declare function blockOffsetToSpanSelectionPoint({
-  value,
-  blockOffset,
-  direction,
-}: {
-  value: Array<PortableTextBlock>
-  blockOffset: BlockOffset
-  direction: 'forward' | 'backward'
-}):
-  | {
-      path: [KeyedSegment, 'children', KeyedSegment]
-      offset: number
-    }
-  | undefined
-
-/**
- * @public
- */
-declare function childSelectionPointToBlockOffset({
-  value,
-  selectionPoint,
-}: {
-  value: Array<PortableTextBlock>
-  selectionPoint: EditorSelectionPoint
-}): BlockOffset | undefined
-
 declare type Converter<TMIMEType extends MIMEType = MIMEType> = {
   mimeType: TMIMEType
   serialize: Serializer<TMIMEType>
@@ -110,10 +63,10 @@ declare type ConverterEvent<TMIMEType extends MIMEType = MIMEType> =
     }
 
 declare type Deserializer<TMIMEType extends MIMEType> = ({
-  context,
+  snapshot,
   event,
 }: {
-  context: EditorContext
+  snapshot: EditorSnapshot
   event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'deserialize'>
 }) => PickFromUnion<
   ConverterEvent<TMIMEType>,
@@ -230,39 +183,17 @@ export declare const getAnchorTextBlock: EditorSelector<
   | undefined
 >
 
-/**
- * @public
- */
-declare function getBlockEndPoint({
-  node,
-  path,
-}: {
-  node: PortableTextBlock
-  path: [KeyedSegment]
-}): EditorSelectionPoint
-
 /**
  * @public
  */
 export declare const getBlockOffsets: EditorSelector<
   | {
-      start: utils.BlockOffset
-      end: utils.BlockOffset
+      start: BlockOffset
+      end: BlockOffset
     }
   | undefined
 >
 
-/**
- * @public
- */
-declare function getBlockStartPoint({
-  node,
-  path,
-}: {
-  node: PortableTextBlock
-  path: [KeyedSegment]
-}): EditorSelectionPoint
-
 /**
  * @public
  */
@@ -479,11 +410,6 @@ export declare const getSelectionStartPoint: EditorSelector<
  */
 export declare const getSelectionText: EditorSelector<string>
 
-/**
- * @public
- */
-declare function getTextBlockText(block: PortableTextTextBlock): string
-
 /**
  * @public
  */
@@ -536,24 +462,6 @@ export declare function isAtTheStartOfBlock(block: {
   path: [KeyedSegment]
 }): EditorSelector<boolean>
 
-/**
- * @public
- */
-declare function isEmptyTextBlock(block: PortableTextBlock): boolean
-
-/**
- * @public
- */
-declare function isEqualSelectionPoints(
-  a: EditorSelectionPoint,
-  b: EditorSelectionPoint,
-): boolean
-
-/**
- * @public
- */
-declare function isKeyedSegment(segment: PathSegment): segment is KeyedSegment
-
 /**
  * @public
  */
@@ -585,35 +493,6 @@ export declare const isSelectionCollapsed: EditorSelector<boolean>
  */
 export declare const isSelectionExpanded: EditorSelector<boolean>
 
-/**
- * @public
- */
-declare function isSpan(
-  context: Pick<EditorContext, 'schema'>,
-  child: PortableTextChild,
-): child is PortableTextSpan
-
-/**
- * @public
- */
-declare function isTextBlock(
-  context: Pick<EditorContext, 'schema'>,
-  block: PortableTextBlock,
-): block is PortableTextTextBlock
-
-/**
- * @beta
- */
-declare function mergeTextBlocks({
-  context,
-  targetBlock,
-  incomingBlock,
-}: {
-  context: Pick<EditorContext, 'keyGenerator' | 'schema'>
-  targetBlock: PortableTextTextBlock
-  incomingBlock: PortableTextTextBlock
-}): PortableTextTextBlock<PortableTextSpan | PortableTextObject>
-
 declare type MIMEType = `${string}/${string}`
 
 /**
@@ -640,18 +519,11 @@ export declare type PortableTextMemberSchemaTypes = {
   lists: BlockListDefinition[]
 }
 
-/**
- * @public
- */
-declare function reverseSelection(
-  selection: NonNullable<EditorSelection>,
-): NonNullable<EditorSelection>
-
 declare type Serializer<TMIMEType extends MIMEType> = ({
-  context,
+  snapshot,
   event,
 }: {
-  context: EditorContext
+  snapshot: EditorSnapshot
   event: PickFromUnion<ConverterEvent<TMIMEType>, 'type', 'serialize'>
 }) => PickFromUnion<
   ConverterEvent<TMIMEType>,
@@ -659,68 +531,4 @@ declare type Serializer<TMIMEType extends MIMEType> = ({
   'serialization.success' | 'serialization.failure'
 >
 
-/**
- * @public
- */
-declare function sliceBlocks({
-  blocks,
-  selection,
-}: {
-  blocks: Array<PortableTextBlock>
-  selection: EditorSelection
-}): Array<PortableTextBlock>
-
-/**
- * @public
- */
-declare function spanSelectionPointToBlockOffset({
-  value,
-  selectionPoint,
-}: {
-  value: Array<PortableTextBlock>
-  selectionPoint: EditorSelectionPoint
-}): BlockOffset | undefined
-
-/**
- * @beta
- */
-declare function splitTextBlock({
-  context,
-  block,
-  point,
-}: {
-  context: Pick<EditorContext, 'schema'>
-  block: PortableTextTextBlock
-  point: EditorSelectionPoint
-}):
-  | {
-      before: PortableTextTextBlock
-      after: PortableTextTextBlock
-    }
-  | undefined
-
-declare namespace utils {
-  export {
-    BlockOffset,
-    EditorSelection,
-    EditorSelectionPoint,
-    blockOffsetToSpanSelectionPoint,
-    spanSelectionPointToBlockOffset,
-    blockOffsetsToSelection,
-    childSelectionPointToBlockOffset,
-    getBlockEndPoint,
-    getBlockStartPoint,
-    getTextBlockText,
-    isEmptyTextBlock,
-    isEqualSelectionPoints,
-    isKeyedSegment,
-    isSpan,
-    isTextBlock,
-    mergeTextBlocks,
-    reverseSelection,
-    sliceBlocks,
-    splitTextBlock,
-  }
-}
-
 export {}

package/lib/selectors/index.js

@@ -11,79 +11,55 @@ const getActiveAnnotations = (snapshot) => {
     return [];
   const selectedBlocks = getSelectedBlocks(snapshot), selectedSpans = getSelectedSpans(snapshot);
   return selectedSpans.length === 0 ? [] : selectedBlocks.flatMap((block) => isPortableTextTextBlock(block.node) ? block.node.markDefs ?? [] : []).filter((markDef) => selectedSpans.some((span) => span.node.marks?.includes(markDef._key)));
-}, getAnchorBlock = ({
-  context
-}) => {
-  const key = context.selection && isKeyedSegment(context.selection.anchor.path[0]) ? context.selection.anchor.path[0]._key : void 0, node = key ? context.value.find((block) => block._key === key) : void 0;
+}, getAnchorBlock = (snapshot) => {
+  const key = snapshot.context.selection && isKeyedSegment(snapshot.context.selection.anchor.path[0]) ? snapshot.context.selection.anchor.path[0]._key : void 0, node = key ? snapshot.context.value.find((block) => block._key === key) : void 0;
   return node && key ? {
     node,
     path: [{
       _key: key
     }]
   } : void 0;
-}, getAnchorTextBlock = ({
-  context
-}) => {
-  const anchorBlock = getAnchorBlock({
-    context
-  });
+}, getAnchorTextBlock = (snapshot) => {
+  const anchorBlock = getAnchorBlock(snapshot);
   return anchorBlock && isPortableTextTextBlock(anchorBlock.node) ? {
     node: anchorBlock.node,
     path: anchorBlock.path
   } : void 0;
-}, getAnchorChild = ({
-  context
-}) => {
-  const anchorBlock = getAnchorTextBlock({
-    context
-  });
+}, getAnchorChild = (snapshot) => {
+  const anchorBlock = getAnchorTextBlock(snapshot);
   if (!anchorBlock)
     return;
-  const key = context.selection && isKeyedSegment(context.selection.anchor.path[2]) ? context.selection.anchor.path[2]._key : void 0, node = key ? anchorBlock.node.children.find((span) => span._key === key) : void 0;
+  const key = snapshot.context.selection && isKeyedSegment(snapshot.context.selection.anchor.path[2]) ? snapshot.context.selection.anchor.path[2]._key : void 0, node = key ? anchorBlock.node.children.find((span) => span._key === key) : void 0;
   return node && key ? {
     node,
     path: [...anchorBlock.path, "children", {
       _key: key
     }]
   } : void 0;
-}, getAnchorSpan = ({
-  context
-}) => {
-  const anchorChild = getAnchorChild({
-    context
-  });
+}, getAnchorSpan = (snapshot) => {
+  const anchorChild = getAnchorChild(snapshot);
   return anchorChild && isPortableTextSpan(anchorChild.node) ? {
     node: anchorChild.node,
     path: anchorChild.path
   } : void 0;
-}, getBlockOffsets = ({
-  context
-}) => {
-  if (!context.selection)
+}, getBlockOffsets = (snapshot) => {
+  if (!snapshot.context.selection)
     return;
-  const selectionStartPoint = getSelectionStartPoint({
-    context
-  }), selectionEndPoint = getSelectionEndPoint({
-    context
-  });
+  const selectionStartPoint = getSelectionStartPoint(snapshot), selectionEndPoint = getSelectionEndPoint(snapshot);
   if (!selectionStartPoint || !selectionEndPoint)
     return;
   const start = spanSelectionPointToBlockOffset({
-    value: context.value,
+    value: snapshot.context.value,
     selectionPoint: selectionStartPoint
   }), end = spanSelectionPointToBlockOffset({
-    value: context.value,
+    value: snapshot.context.value,
     selectionPoint: selectionEndPoint
   });
   return start && end ? {
     start,
     end
   } : void 0;
-}, getSelection = ({
-  context
-}) => context.selection, getValue = ({
-  context
-}) => context.value;
+}, getSelection = (snapshot) => snapshot.context.selection, getValue = (snapshot) => snapshot.context.value;
 function isPointAfterSelection(point) {
   return (snapshot) => {
     if (!snapshot.context.selection)
@@ -155,27 +131,23 @@ function isPointBeforeSelection(point) {
   };
 }
 function isOverlappingSelection(selection) {
-  return ({
-    context
-  }) => {
-    if (!selection || !context.selection)
+  return (snapshot) => {
+    if (!selection || !snapshot.context.selection)
       return !1;
     const selectionStartPoint = getSelectionStartPoint({
+      ...snapshot,
       context: {
-        ...context,
+        ...snapshot.context,
         selection
       }
     }), selectionEndPoint = getSelectionEndPoint({
+      ...snapshot,
       context: {
-        ...context,
+        ...snapshot.context,
         selection
       }
     });
-    return !(!selectionStartPoint || !selectionEndPoint || !isPointAfterSelection(selectionStartPoint)({
-      context
-    }) || !isPointBeforeSelection(selectionEndPoint)({
-      context
-    }));
+    return !(!selectionStartPoint || !selectionEndPoint || !isPointAfterSelection(selectionStartPoint)(snapshot) || !isPointBeforeSelection(selectionEndPoint)(snapshot));
   };
 }
 export {