@portabletext/editor 3.3.2 → 3.3.4

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

@@ -1,134 +0,0 @@
-import type {EditorSelector} from '../editor/editor-selector'
-import type {BlockOffset} from '../types/block-offset'
-import type {EditorSelection} from '../types/editor'
-import {
-  blockOffsetToSpanSelectionPoint,
-  spanSelectionPointToBlockOffset,
-} from '../utils/util.block-offset'
-import {getBlockEndPoint} from '../utils/util.get-block-end-point'
-import {getBlockStartPoint} from '../utils/util.get-block-start-point'
-import {getFocusTextBlock} from './selector.get-focus-text-block'
-import {getNextInlineObject} from './selector.get-next-inline-object'
-import {getPreviousInlineObject} from './selector.get-previous-inline-object'
-import {getSelectionStartPoint} from './selector.get-selection-start-point'
-import {getSelectionText} from './selector.get-selection-text'
-import {isSelectionCollapsed} from './selector.is-selection-collapsed'
-import {isSelectionExpanded} from './selector.is-selection-expanded'
-
-/**
- * @public
- * 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> = (
-  snapshot,
-) => {
-  if (!snapshot.context.selection) {
-    return null
-  }
-
-  if (!isSelectionCollapsed(snapshot)) {
-    return null
-  }
-
-  const focusTextBlock = getFocusTextBlock(snapshot)
-  const selectionStartPoint = getSelectionStartPoint(snapshot)
-  const selectionStartOffset = selectionStartPoint
-    ? spanSelectionPointToBlockOffset({
-        context: snapshot.context,
-        selectionPoint: selectionStartPoint,
-      })
-    : undefined
-
-  if (!focusTextBlock || !selectionStartPoint || !selectionStartOffset) {
-    return null
-  }
-
-  const previousInlineObject = getPreviousInlineObject(snapshot)
-  const blockStartPoint = getBlockStartPoint({
-    context: snapshot.context,
-    block: focusTextBlock,
-  })
-  const textBefore = getSelectionText({
-    ...snapshot,
-    context: {
-      ...snapshot.context,
-      selection: {
-        anchor: previousInlineObject
-          ? {path: previousInlineObject.path, offset: 0}
-          : blockStartPoint,
-        focus: selectionStartPoint,
-      },
-    },
-  })
-  const textDirectlyBefore = textBefore.split(/\s+/).at(-1)
-
-  const nextInlineObject = getNextInlineObject(snapshot)
-  const blockEndPoint = getBlockEndPoint({
-    context: snapshot.context,
-    block: focusTextBlock,
-  })
-  const textAfter = getSelectionText({
-    ...snapshot,
-    context: {
-      ...snapshot.context,
-      selection: {
-        anchor: selectionStartPoint,
-        focus: nextInlineObject
-          ? {path: nextInlineObject.path, offset: 0}
-          : blockEndPoint,
-      },
-    },
-  })
-  const textDirectlyAfter = textAfter.split(/\s+/).at(0)
-
-  if (
-    (textDirectlyBefore === undefined || textDirectlyBefore === '') &&
-    (textDirectlyAfter === undefined || textDirectlyAfter === '')
-  ) {
-    return null
-  }
-
-  const caretWordStartOffset: BlockOffset = textDirectlyBefore
-    ? {
-        ...selectionStartOffset,
-        offset: selectionStartOffset.offset - textDirectlyBefore.length,
-      }
-    : selectionStartOffset
-  const caretWordEndOffset: BlockOffset = textDirectlyAfter
-    ? {
-        ...selectionStartOffset,
-        offset: selectionStartOffset.offset + textDirectlyAfter.length,
-      }
-    : selectionStartOffset
-
-  const caretWordStartSelectionPoint = blockOffsetToSpanSelectionPoint({
-    context: snapshot.context,
-    blockOffset: caretWordStartOffset,
-    direction: 'backward',
-  })
-  const caretWordEndSelectionPoint = blockOffsetToSpanSelectionPoint({
-    context: snapshot.context,
-    blockOffset: caretWordEndOffset,
-    direction: 'forward',
-  })
-
-  if (!caretWordStartSelectionPoint || !caretWordEndSelectionPoint) {
-    return null
-  }
-
-  const caretWordSelection = {
-    anchor: caretWordStartSelectionPoint,
-    focus: caretWordEndSelectionPoint,
-  }
-
-  return isSelectionExpanded({
-    ...snapshot,
-    context: {
-      ...snapshot.context,
-      selection: caretWordSelection,
-    },
-  })
-    ? caretWordSelection
-    : null
-}

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

@@ -1,14 +0,0 @@
-import type {PortableTextBlock} from '@sanity/types'
-import type {EditorSelector} from '../editor/editor-selector'
-import type {BlockPath} from '../types/paths'
-
-/**
- * @public
- */
-export const getFirstBlock: EditorSelector<
-  {node: PortableTextBlock; path: BlockPath} | undefined
-> = (snapshot) => {
-  const node = snapshot.context.value[0]
-
-  return node ? {node, path: [{_key: node._key}]} : undefined
-}

package/src/selectors/selector.get-focus-block-object.ts

@@ -1,18 +0,0 @@
-import {isTextBlock} from '@portabletext/schema'
-import type {PortableTextObject} from '@sanity/types'
-import type {EditorSelector} from '../editor/editor-selector'
-import type {BlockPath} from '../types/paths'
-import {getFocusBlock} from './selector.get-focus-block'
-
-/**
- * @public
- */
-export const getFocusBlockObject: EditorSelector<
-  {node: PortableTextObject; path: BlockPath} | undefined
-> = (snapshot) => {
-  const focusBlock = getFocusBlock(snapshot)
-
-  return focusBlock && !isTextBlock(snapshot.context, focusBlock.node)
-    ? {node: focusBlock.node, path: focusBlock.path}
-    : undefined
-}

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

@@ -1,23 +0,0 @@
-import type {PortableTextBlock} from '@sanity/types'
-import type {EditorSelector} from '../editor/editor-selector'
-import type {BlockPath} from '../types/paths'
-import {getBlockKeyFromSelectionPoint} from '../utils/util.selection-point'
-
-/**
- * @public
- */
-export const getFocusBlock: EditorSelector<
-  {node: PortableTextBlock; path: BlockPath} | undefined
-> = (snapshot) => {
-  if (!snapshot.context.selection) {
-    return undefined
-  }
-
-  const key = getBlockKeyFromSelectionPoint(snapshot.context.selection.focus)
-  const index = key ? snapshot.blockIndexMap.get(key) : undefined
-
-  const node =
-    index !== undefined ? snapshot.context.value.at(index) : undefined
-
-  return node && key ? {node, path: [{_key: key}]} : undefined
-}

package/src/selectors/selector.get-focus-child.ts

@@ -1,36 +0,0 @@
-import type {PortableTextObject, PortableTextSpan} from '@sanity/types'
-import type {EditorSelector} from '../editor/editor-selector'
-import type {ChildPath} from '../types/paths'
-import {getChildKeyFromSelectionPoint} from '../utils/util.selection-point'
-import {getFocusTextBlock} from './selector.get-focus-text-block'
-
-/**
- * @public
- */
-export const getFocusChild: EditorSelector<
-  | {
-      node: PortableTextObject | PortableTextSpan
-      path: ChildPath
-    }
-  | undefined
-> = (snapshot) => {
-  if (!snapshot.context.selection) {
-    return undefined
-  }
-
-  const focusBlock = getFocusTextBlock(snapshot)
-
-  if (!focusBlock) {
-    return undefined
-  }
-
-  const key = getChildKeyFromSelectionPoint(snapshot.context.selection.focus)
-
-  const node = key
-    ? focusBlock.node.children.find((span) => span._key === key)
-    : undefined
-
-  return node && key
-    ? {node, path: [...focusBlock.path, 'children', {_key: key}]}
-    : undefined
-}

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

@@ -1,17 +0,0 @@
-import {isPortableTextSpan, type PortableTextObject} from '@sanity/types'
-import type {EditorSelector} from '../editor/editor-selector'
-import type {ChildPath} from '../types/paths'
-import {getFocusChild} from './selector.get-focus-child'
-
-/**
- * @public
- */
-export const getFocusInlineObject: EditorSelector<
-  {node: PortableTextObject; path: ChildPath} | undefined
-> = (snapshot) => {
-  const focusChild = getFocusChild(snapshot)
-
-  return focusChild && !isPortableTextSpan(focusChild.node)
-    ? {node: focusChild.node, path: focusChild.path}
-    : undefined
-}

package/src/selectors/selector.get-focus-list-block.ts

@@ -1,18 +0,0 @@
-import type {PortableTextListBlock} from '@sanity/types'
-import type {EditorSelector} from '../editor/editor-selector'
-import type {BlockPath} from '../types/paths'
-import {isListBlock} from '../utils/parse-blocks'
-import {getFocusTextBlock} from './selector.get-focus-text-block'
-
-/**
- * @public
- */
-export const getFocusListBlock: EditorSelector<
-  {node: PortableTextListBlock; path: BlockPath} | undefined
-> = (snapshot) => {
-  const focusTextBlock = getFocusTextBlock(snapshot)
-
-  return focusTextBlock && isListBlock(snapshot.context, focusTextBlock.node)
-    ? {node: focusTextBlock.node, path: focusTextBlock.path}
-    : undefined
-}

package/src/selectors/selector.get-focus-span.ts

@@ -1,18 +0,0 @@
-import {isSpan} from '@portabletext/schema'
-import type {PortableTextSpan} from '@sanity/types'
-import type {EditorSelector} from '../editor/editor-selector'
-import type {ChildPath} from '../types/paths'
-import {getFocusChild} from './selector.get-focus-child'
-
-/**
- * @public
- */
-export const getFocusSpan: EditorSelector<
-  {node: PortableTextSpan; path: ChildPath} | undefined
-> = (snapshot) => {
-  const focusChild = getFocusChild(snapshot)
-
-  return focusChild && isSpan(snapshot.context, focusChild.node)
-    ? {node: focusChild.node, path: focusChild.path}
-    : undefined
-}

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

@@ -1,18 +0,0 @@
-import {isTextBlock} from '@portabletext/schema'
-import type {PortableTextTextBlock} from '@sanity/types'
-import type {EditorSelector} from '../editor/editor-selector'
-import type {BlockPath} from '../types/paths'
-import {getFocusBlock} from './selector.get-focus-block'
-
-/**
- * @public
- */
-export const getFocusTextBlock: EditorSelector<
-  {node: PortableTextTextBlock; path: BlockPath} | undefined
-> = (snapshot) => {
-  const focusBlock = getFocusBlock(snapshot)
-
-  return focusBlock && isTextBlock(snapshot.context, focusBlock.node)
-    ? {node: focusBlock.node, path: focusBlock.path}
-    : undefined
-}

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

@@ -1,16 +0,0 @@
-import type {PortableTextBlock} from '@sanity/types'
-import type {EditorSelector} from '../editor/editor-selector'
-import type {BlockPath} from '../types/paths'
-
-/**
- * @public
- */
-export const getLastBlock: EditorSelector<
-  {node: PortableTextBlock; path: BlockPath} | undefined
-> = (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
-}

package/src/selectors/selector.get-mark-state.test.ts

@@ -1,325 +0,0 @@
-import {compileSchema, defineSchema} from '@portabletext/schema'
-import {createTestKeyGenerator} from '@portabletext/test'
-import {describe, expect, test} from 'vitest'
-import {createTestSnapshot} from '../internal-utils/create-test-snapshot'
-import {getMarkState} from './selector.get-mark-state'
-
-describe(getMarkState.name, () => {
-  test('Scenario: Caret after annotation', () => {
-    const keyGenerator = createTestKeyGenerator()
-    const blockKey = keyGenerator()
-    const fooSpanKey = keyGenerator()
-    const barSpanKey = keyGenerator()
-    const bazSpanKey = keyGenerator()
-    const linkKey = keyGenerator()
-    const snapshot = createTestSnapshot({
-      context: {
-        keyGenerator,
-        value: [
-          {
-            _type: 'block',
-            _key: blockKey,
-            children: [
-              {
-                _type: 'span',
-                _key: fooSpanKey,
-                text: 'foo ',
-                marks: [],
-              },
-              {
-                _type: 'span',
-                _key: barSpanKey,
-                text: 'bar',
-                marks: [linkKey],
-              },
-              {
-                _type: 'span',
-                _key: bazSpanKey,
-                text: ' baz',
-              },
-            ],
-            markDefs: [
-              {
-                _type: 'link',
-                _key: linkKey,
-                href: 'https://portabletext.org',
-              },
-            ],
-          },
-        ],
-        selection: {
-          anchor: {
-            path: [{_key: blockKey}, 'children', {_key: barSpanKey}],
-            offset: 3,
-          },
-          focus: {
-            path: [{_key: blockKey}, 'children', {_key: barSpanKey}],
-            offset: 3,
-          },
-          backward: false,
-        },
-      },
-    })
-
-    expect(getMarkState(snapshot)).toEqual({
-      state: 'changed',
-      marks: [],
-      previousMarks: [linkKey],
-    })
-  })
-
-  test('Scenario: Caret after annotated decorator', () => {
-    const keyGenerator = createTestKeyGenerator()
-    const blockKey = keyGenerator()
-    const fooSpanKey = keyGenerator()
-    const barSpanKey = keyGenerator()
-    const bazSpanKey = keyGenerator()
-    const linkKey = keyGenerator()
-    const snapshot = createTestSnapshot({
-      context: {
-        keyGenerator,
-        value: [
-          {
-            _type: 'block',
-            _key: blockKey,
-            children: [
-              {
-                _type: 'span',
-                _key: fooSpanKey,
-                text: 'foo ',
-              },
-              {
-                _type: 'span',
-                _key: barSpanKey,
-                text: 'bar',
-                marks: [linkKey, 'strong'],
-              },
-              {
-                _type: 'span',
-                _key: bazSpanKey,
-                text: ' baz',
-              },
-            ],
-            markDefs: [
-              {
-                _type: 'link',
-                _key: linkKey,
-                href: 'https://portabletext.org',
-              },
-            ],
-            style: 'normal',
-          },
-        ],
-        selection: {
-          anchor: {
-            path: [{_key: blockKey}, 'children', {_key: bazSpanKey}],
-            offset: 0,
-          },
-          focus: {
-            path: [{_key: blockKey}, 'children', {_key: bazSpanKey}],
-            offset: 0,
-          },
-          backward: false,
-        },
-        schema: compileSchema(
-          defineSchema({
-            annotations: [{name: 'link'}],
-            decorators: [{name: 'strong'}],
-          }),
-        ),
-      },
-    })
-
-    expect(getMarkState(snapshot)).toEqual({
-      state: 'changed',
-      marks: [],
-      previousMarks: [linkKey, 'strong'],
-    })
-  })
-
-  test('Scenario: Caret after annotation inside decorator', () => {
-    const keyGenerator = createTestKeyGenerator()
-    const blockKey = keyGenerator()
-    const fooSpanKey = keyGenerator()
-    const barSpanKey = keyGenerator()
-    const bazSpanKey = keyGenerator()
-    const linkKey = keyGenerator()
-    const snapshot = createTestSnapshot({
-      context: {
-        keyGenerator,
-        value: [
-          {
-            _type: 'block',
-            _key: blockKey,
-            children: [
-              {
-                _type: 'span',
-                _key: fooSpanKey,
-                text: 'foo ',
-                marks: ['strong'],
-              },
-              {
-                _type: 'span',
-                _key: barSpanKey,
-                text: 'bar',
-                marks: [linkKey, 'strong'],
-              },
-              {
-                _type: 'span',
-                _key: bazSpanKey,
-                text: ' baz',
-                marks: ['strong'],
-              },
-            ],
-          },
-        ],
-        selection: {
-          anchor: {
-            path: [{_key: blockKey}, 'children', {_key: bazSpanKey}],
-            offset: 0,
-          },
-          focus: {
-            path: [{_key: blockKey}, 'children', {_key: bazSpanKey}],
-            offset: 0,
-          },
-          backward: false,
-        },
-        schema: compileSchema(
-          defineSchema({
-            annotations: [{name: 'link'}],
-            decorators: [{name: 'strong'}],
-          }),
-        ),
-      },
-    })
-
-    expect(getMarkState(snapshot)).toEqual({
-      state: 'changed',
-      marks: ['strong'],
-      previousMarks: [linkKey, 'strong'],
-    })
-  })
-
-  test('Scenario: Caret in annotation, at the edge of decorator', () => {
-    const keyGenerator = createTestKeyGenerator()
-    const blockKey = keyGenerator()
-    const fooSpanKey = keyGenerator()
-    const barSpanKey = keyGenerator()
-    const linkKey = keyGenerator()
-    const snapshot = createTestSnapshot({
-      context: {
-        keyGenerator,
-        value: [
-          {
-            _type: 'block',
-            _key: blockKey,
-            children: [
-              {
-                _type: 'span',
-                _key: fooSpanKey,
-                text: 'foo',
-                marks: [linkKey],
-              },
-              {
-                _type: 'span',
-                _key: barSpanKey,
-                text: 'bar',
-                marks: [linkKey, 'strong'],
-              },
-            ],
-          },
-        ],
-        selection: {
-          anchor: {
-            path: [{_key: blockKey}, 'children', {_key: fooSpanKey}],
-            offset: 3,
-          },
-          focus: {
-            path: [{_key: blockKey}, 'children', {_key: fooSpanKey}],
-            offset: 3,
-          },
-          backward: false,
-        },
-        schema: compileSchema(
-          defineSchema({
-            annotations: [{name: 'link'}],
-            decorators: [{name: 'strong'}],
-          }),
-        ),
-      },
-    })
-
-    expect(getMarkState(snapshot)).toEqual({
-      state: 'unchanged',
-      marks: [linkKey],
-    })
-  })
-
-  test('Scenario: Caret between two annotations', () => {
-    const keyGenerator = createTestKeyGenerator()
-    const blockKey = keyGenerator()
-    const fooSpanKey = keyGenerator()
-    const barSpanKey = keyGenerator()
-    const linkKey = keyGenerator()
-    const commentKey = keyGenerator()
-    const snapshot = createTestSnapshot({
-      context: {
-        keyGenerator,
-        value: [
-          {
-            _type: 'block',
-            _key: blockKey,
-            children: [
-              {
-                _type: 'span',
-                _key: fooSpanKey,
-                text: 'foo',
-                marks: [linkKey],
-              },
-              {
-                _type: 'span',
-                _key: barSpanKey,
-                text: 'bar',
-                marks: [commentKey],
-              },
-            ],
-            markDefs: [
-              {
-                _type: 'link',
-                _key: linkKey,
-                href: 'https://portabletext.org',
-              },
-              {
-                _type: 'comment',
-                _key: commentKey,
-                text: 'Comment A',
-              },
-            ],
-          },
-        ],
-        selection: {
-          anchor: {
-            path: [{_key: blockKey}, 'children', {_key: fooSpanKey}],
-            offset: 3,
-          },
-          focus: {
-            path: [{_key: blockKey}, 'children', {_key: fooSpanKey}],
-            offset: 3,
-          },
-          backward: false,
-        },
-        schema: compileSchema(
-          defineSchema({
-            annotations: [{name: 'link'}, {name: 'comment'}],
-          }),
-        ),
-      },
-    })
-
-    expect(getMarkState(snapshot)).toEqual({
-      state: 'changed',
-      marks: [],
-      previousMarks: [linkKey],
-    })
-  })
-})