@portabletext/editor 3.3.2 → 3.3.4

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

@@ -1,46 +0,0 @@
-import type {EditorSelector} from '../editor/editor-selector'
-import {getBlockEndPoint} from '../utils/util.get-block-end-point'
-import {getSelectionEndPoint} from '../utils/util.get-selection-end-point'
-import {getFocusBlock} from './selector.get-focus-block'
-import {getSelectionText} from './selector.get-selection-text'
-
-/**
- * @public
- */
-export const getBlockTextAfter: EditorSelector<string> = (snapshot) => {
-  if (!snapshot.context.selection) {
-    return ''
-  }
-
-  const endPoint = getSelectionEndPoint(snapshot.context.selection)
-  const block = getFocusBlock({
-    ...snapshot,
-    context: {
-      ...snapshot.context,
-      selection: {
-        anchor: endPoint,
-        focus: endPoint,
-      },
-    },
-  })
-
-  if (!block) {
-    return ''
-  }
-
-  const endOfBlock = getBlockEndPoint({
-    context: snapshot.context,
-    block,
-  })
-
-  return getSelectionText({
-    ...snapshot,
-    context: {
-      ...snapshot.context,
-      selection: {
-        anchor: endPoint,
-        focus: endOfBlock,
-      },
-    },
-  })
-}

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

@@ -1,46 +0,0 @@
-import type {EditorSelector} from '../editor/editor-selector'
-import {getBlockStartPoint} from '../utils/util.get-block-start-point'
-import {getSelectionStartPoint} from '../utils/util.get-selection-start-point'
-import {getFocusBlock} from './selector.get-focus-block'
-import {getSelectionText} from './selector.get-selection-text'
-
-/**
- * @public
- */
-export const getBlockTextBefore: EditorSelector<string> = (snapshot) => {
-  if (!snapshot.context.selection) {
-    return ''
-  }
-
-  const startPoint = getSelectionStartPoint(snapshot.context.selection)
-  const block = getFocusBlock({
-    ...snapshot,
-    context: {
-      ...snapshot.context,
-      selection: {
-        anchor: startPoint,
-        focus: startPoint,
-      },
-    },
-  })
-
-  if (!block) {
-    return ''
-  }
-
-  const startOfBlock = getBlockStartPoint({
-    context: snapshot.context,
-    block,
-  })
-
-  return getSelectionText({
-    ...snapshot,
-    context: {
-      ...snapshot.context,
-      selection: {
-        anchor: startOfBlock,
-        focus: startPoint,
-      },
-    },
-  })
-}

package/src/selectors/selector.get-value.ts

@@ -1,11 +0,0 @@
-import type {PortableTextBlock} from '@sanity/types'
-import type {EditorSelector} from '../editor/editor-selector'
-
-/**
- * @public
- */
-export const getValue: EditorSelector<Array<PortableTextBlock>> = (
-  snapshot,
-) => {
-  return snapshot.context.value
-}

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

@@ -1,320 +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 {isActiveAnnotation} from './selector.is-active-annotation'
-
-describe(isActiveAnnotation.name, () => {
-  const keyGenerator = createTestKeyGenerator()
-  const annotationKey = keyGenerator()
-  const blockKey = keyGenerator()
-  const fooKey = keyGenerator()
-  const barKey = keyGenerator()
-  const bazKey = keyGenerator()
-  const value = [
-    {
-      _type: 'block',
-      _key: blockKey,
-      children: [
-        {
-          _type: 'span',
-          _key: fooKey,
-          text: 'foo ',
-          marks: [],
-        },
-        {
-          _type: 'span',
-          _key: barKey,
-          text: 'bar',
-          marks: [annotationKey],
-        },
-        {
-          _type: 'span',
-          _key: bazKey,
-          text: ' baz',
-          marks: [],
-        },
-      ],
-      markDefs: [
-        {_key: annotationKey, _type: 'link', href: 'https://example.com'},
-      ],
-    },
-  ]
-  const schema = compileSchema(
-    defineSchema({
-      annotations: [{name: 'link', fields: [{name: 'href', type: 'string'}]}],
-    }),
-  )
-
-  describe('collapsed selection', () => {
-    test('selection before the annotation', () => {
-      const snapshot = createTestSnapshot({
-        context: {
-          schema,
-          value,
-          selection: {
-            anchor: {
-              path: [{_key: blockKey}, 'children', {_key: fooKey}],
-              offset: 4,
-            },
-            focus: {
-              path: [{_key: blockKey}, 'children', {_key: fooKey}],
-              offset: 4,
-            },
-          },
-        },
-      })
-
-      expect(isActiveAnnotation('link')(snapshot)).toBe(false)
-    })
-
-    test('selection at the start of the annotation', () => {
-      const snapshot = createTestSnapshot({
-        context: {
-          schema,
-          value,
-          selection: {
-            anchor: {
-              path: [{_key: blockKey}, 'children', {_key: barKey}],
-              offset: 0,
-            },
-            focus: {
-              path: [{_key: blockKey}, 'children', {_key: barKey}],
-              offset: 0,
-            },
-          },
-        },
-      })
-
-      expect(isActiveAnnotation('link')(snapshot)).toBe(false)
-    })
-
-    test('selection after the annotation', () => {
-      const snapshot = createTestSnapshot({
-        context: {
-          schema,
-          value,
-          selection: {
-            anchor: {
-              path: [{_key: blockKey}, 'children', {_key: bazKey}],
-              offset: 0,
-            },
-            focus: {
-              path: [{_key: blockKey}, 'children', {_key: bazKey}],
-              offset: 0,
-            },
-          },
-        },
-      })
-
-      expect(isActiveAnnotation('link')(snapshot)).toBe(false)
-    })
-
-    test('selection at the end of the annotation', () => {
-      const snapshot = createTestSnapshot({
-        context: {
-          schema,
-          value,
-          selection: {
-            anchor: {
-              path: [{_key: blockKey}, 'children', {_key: barKey}],
-              offset: 3,
-            },
-            focus: {
-              path: [{_key: blockKey}, 'children', {_key: barKey}],
-              offset: 3,
-            },
-          },
-        },
-      })
-
-      expect(isActiveAnnotation('link')(snapshot)).toBe(false)
-    })
-
-    test('selection in the annotation', () => {
-      const snapshot = createTestSnapshot({
-        context: {
-          schema,
-          value,
-          selection: {
-            anchor: {
-              path: [{_key: blockKey}, 'children', {_key: barKey}],
-              offset: 2,
-            },
-            focus: {
-              path: [{_key: blockKey}, 'children', {_key: barKey}],
-              offset: 2,
-            },
-          },
-        },
-      })
-
-      expect(isActiveAnnotation('link')(snapshot)).toBe(true)
-    })
-  })
-
-  describe('expanded selection', () => {
-    test('selection on the annotation', () => {
-      const snapshot = createTestSnapshot({
-        context: {
-          schema,
-          value,
-          selection: {
-            anchor: {
-              path: [{_key: blockKey}, 'children', {_key: barKey}],
-              offset: 0,
-            },
-            focus: {
-              path: [{_key: blockKey}, 'children', {_key: barKey}],
-              offset: 3,
-            },
-          },
-        },
-      })
-
-      expect(isActiveAnnotation('link')(snapshot)).toBe(true)
-    })
-
-    test('selection in the annotation', () => {
-      const snapshot = createTestSnapshot({
-        context: {
-          schema,
-          value,
-          selection: {
-            anchor: {
-              path: [{_key: blockKey}, 'children', {_key: barKey}],
-              offset: 1,
-            },
-            focus: {
-              path: [{_key: blockKey}, 'children', {_key: barKey}],
-              offset: 2,
-            },
-          },
-        },
-      })
-
-      expect(isActiveAnnotation('link')(snapshot)).toBe(true)
-    })
-
-    describe('selection including the annotation', () => {
-      const snapshot = createTestSnapshot({
-        context: {
-          schema,
-          value,
-          selection: {
-            anchor: {
-              path: [{_key: blockKey}, 'children', {_key: fooKey}],
-              offset: 2,
-            },
-            focus: {
-              path: [{_key: blockKey}, 'children', {_key: bazKey}],
-              offset: 2,
-            },
-          },
-        },
-      })
-
-      test('mode: full', () => {
-        expect(isActiveAnnotation('link')(snapshot)).toBe(false)
-      })
-
-      test('mode: partial', () => {
-        expect(isActiveAnnotation('link', {mode: 'partial'})(snapshot)).toBe(
-          true,
-        )
-      })
-    })
-
-    describe('selection before the annotation', () => {
-      const snapshot = createTestSnapshot({
-        context: {
-          schema,
-          value,
-          selection: {
-            anchor: {
-              path: [{_key: blockKey}, 'children', {_key: fooKey}],
-              offset: 0,
-            },
-            focus: {
-              path: [{_key: blockKey}, 'children', {_key: fooKey}],
-              offset: 4,
-            },
-          },
-        },
-      })
-
-      test('mode: full', () => {
-        expect(isActiveAnnotation('link')(snapshot)).toBe(false)
-      })
-
-      test('mode: partial', () => {
-        expect(isActiveAnnotation('link', {mode: 'partial'})(snapshot)).toBe(
-          false,
-        )
-      })
-    })
-
-    test('selection overlapping from the start', () => {
-      const snapshot = createTestSnapshot({
-        context: {
-          schema,
-          value,
-          selection: {
-            anchor: {
-              path: [{_key: blockKey}, 'children', {_key: fooKey}],
-              offset: 0,
-            },
-            focus: {
-              path: [{_key: blockKey}, 'children', {_key: barKey}],
-              offset: 2,
-            },
-          },
-        },
-      })
-
-      expect(isActiveAnnotation('link')(snapshot)).toBe(false)
-    })
-
-    test('selection after the annotation', () => {
-      const snapshot = createTestSnapshot({
-        context: {
-          schema,
-          value,
-          selection: {
-            anchor: {
-              path: [{_key: blockKey}, 'children', {_key: bazKey}],
-              offset: 0,
-            },
-            focus: {
-              path: [{_key: blockKey}, 'children', {_key: bazKey}],
-              offset: 4,
-            },
-          },
-        },
-      })
-
-      expect(isActiveAnnotation('link')(snapshot)).toBe(false)
-    })
-
-    test('selection overlapping from the end', () => {
-      const snapshot = createTestSnapshot({
-        context: {
-          schema,
-          value,
-          selection: {
-            anchor: {
-              path: [{_key: blockKey}, 'children', {_key: barKey}],
-              offset: 2,
-            },
-            focus: {
-              path: [{_key: blockKey}, 'children', {_key: bazKey}],
-              offset: 4,
-            },
-          },
-        },
-      })
-
-      expect(isActiveAnnotation('link')(snapshot)).toBe(false)
-    })
-  })
-})

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

@@ -1,52 +0,0 @@
-import {isTextBlock} from '@portabletext/schema'
-import type {EditorSelector} from '../editor/editor-selector'
-import {getActiveAnnotationsMarks} from './selector.get-active-annotation-marks'
-import {getSelectedBlocks} from './selector.get-selected-blocks'
-import {getSelectedValue} from './selector.get-selected-value'
-
-/**
- * Check whether an annotation is active in the given `snapshot`.
- *
- * @public
- */
-export function isActiveAnnotation(
-  annotation: string,
-  options?: {
-    /**
-     * Choose whether the annotation has to take up the entire selection in the
-     * `snapshot` or if the annotation can be partially selected.
-     *
-     * Defaults to 'full'
-     */
-    mode?: 'partial' | 'full'
-  },
-): EditorSelector<boolean> {
-  return (snapshot) => {
-    const mode = options?.mode ?? 'full'
-
-    if (mode === 'partial') {
-      const selectedValue = getSelectedValue(snapshot)
-
-      const selectionMarkDefs = selectedValue.flatMap((block) =>
-        isTextBlock(snapshot.context, block) ? (block.markDefs ?? []) : [],
-      )
-
-      return selectionMarkDefs.some((markDef) => markDef._type === annotation)
-    }
-
-    const selectedBlocks = getSelectedBlocks(snapshot)
-    const selectionMarkDefs = selectedBlocks.flatMap((block) =>
-      isTextBlock(snapshot.context, block.node)
-        ? (block.node.markDefs ?? [])
-        : [],
-    )
-    const activeAnnotations = getActiveAnnotationsMarks(snapshot)
-    const activeMarkDefs = selectionMarkDefs.filter(
-      (markDef) =>
-        markDef._type === annotation &&
-        activeAnnotations.includes(markDef._key),
-    )
-
-    return activeMarkDefs.length > 0
-  }
-}

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

@@ -1,136 +0,0 @@
-import type {PortableTextBlock} from '@portabletext/schema'
-import {expect, test} from 'vitest'
-import {createTestSnapshot} from '../internal-utils/create-test-snapshot'
-import type {EditorSelection} from '../types/editor'
-import {isActiveDecorator} from './selector.is-active-decorator'
-
-test(isActiveDecorator.name, () => {
-  function snapshot(
-    value: Array<PortableTextBlock>,
-    selection: EditorSelection,
-  ) {
-    return createTestSnapshot({
-      context: {
-        value,
-        selection,
-      },
-    })
-  }
-
-  expect(
-    isActiveDecorator('strong')(
-      snapshot(
-        [
-          {
-            _type: 'block',
-            _key: 'b1',
-            children: [
-              {
-                _type: 'span',
-                _key: 's1',
-                text: 'foo',
-                marks: ['strong'],
-              },
-              {
-                _type: 'span',
-                _key: 's2',
-                text: 'bar',
-              },
-            ],
-          },
-        ],
-        {
-          anchor: {
-            path: [{_key: 'b1'}, 'children', {_key: 's1'}],
-            offset: 0,
-          },
-          focus: {
-            path: [{_key: 'b1'}, 'children', {_key: 's1'}],
-            offset: 3,
-          },
-        },
-      ),
-    ),
-  ).toBe(true)
-
-  expect(
-    isActiveDecorator('strong')(
-      snapshot(
-        [
-          {
-            _type: 'block',
-            _key: 'b1',
-            children: [
-              {
-                _type: 'span',
-                _key: 's1',
-                text: 'foo',
-                marks: ['strong'],
-              },
-              {
-                _type: 'span',
-                _key: 's2',
-                text: 'bar',
-              },
-            ],
-          },
-        ],
-        {
-          anchor: {
-            path: [{_key: 'b1'}, 'children', {_key: 's1'}],
-            offset: 2,
-          },
-          focus: {
-            path: [{_key: 'b1'}, 'children', {_key: 's2'}],
-            offset: 3,
-          },
-        },
-      ),
-    ),
-  ).toBe(false)
-
-  expect(
-    isActiveDecorator('strong')(
-      snapshot(
-        [
-          {_key: 'b0', _type: 'image'},
-          {
-            _type: 'block',
-            _key: 'b1',
-            children: [
-              {
-                _type: 'span',
-                _key: 's1',
-                text: 'foo',
-                marks: ['strong'],
-              },
-              {
-                _type: 'span',
-                _key: 's2',
-                text: 'bar',
-                marks: ['strong'],
-              },
-            ],
-          },
-          {
-            _key: 'b2',
-            _type: 'block',
-            children: [
-              {_key: 's3', _type: 'span', text: '', marks: ['strong']},
-            ],
-          },
-        ],
-        {
-          anchor: {
-            path: [{_key: 'b0'}],
-            offset: 0,
-          },
-          focus: {
-            path: [{_key: 'b2'}, 'children', {_key: 's3'}],
-            offset: 0,
-          },
-        },
-      ),
-    ),
-  ).toBe(true)
-})

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

@@ -1,24 +0,0 @@
-import type {EditorSelector} from '../editor/editor-selector'
-import {getActiveDecorators} from './selector.get-active-decorators'
-import {getSelectedSpans} from './selector.get-selected-spans'
-import {isSelectionExpanded} from './selector.is-selection-expanded'
-
-/**
- * @public
- */
-export function isActiveDecorator(decorator: string): EditorSelector<boolean> {
-  return (snapshot) => {
-    if (isSelectionExpanded(snapshot)) {
-      const selectedSpans = getSelectedSpans(snapshot)
-
-      return (
-        selectedSpans.length > 0 &&
-        selectedSpans.every((span) => span.node.marks?.includes(decorator))
-      )
-    }
-
-    const activeDecorators = getActiveDecorators(snapshot)
-
-    return activeDecorators.includes(decorator)
-  }
-}

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

@@ -1,13 +0,0 @@
-import type {EditorSelector} from '../editor/editor-selector'
-import {getActiveListItem} from './selector.get-active-list-item'
-
-/**
- * @public
- */
-export function isActiveListItem(listItem: string): EditorSelector<boolean> {
-  return (snapshot) => {
-    const activeListItem = getActiveListItem(snapshot)
-
-    return activeListItem === listItem
-  }
-}

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

@@ -1,13 +0,0 @@
-import type {EditorSelector} from '../editor/editor-selector'
-import {getActiveStyle} from './selector.get-active-style'
-
-/**
- * @public
- */
-export function isActiveStyle(style: string): EditorSelector<boolean> {
-  return (snapshot) => {
-    const activeStyle = getActiveStyle(snapshot)
-
-    return activeStyle === style
-  }
-}

package/src/selectors/selector.is-at-the-end-of-block.ts

@@ -1,30 +0,0 @@
-import type {PortableTextBlock} from '@sanity/types'
-import type {EditorSelector} from '../editor/editor-selector'
-import type {BlockPath} from '../types/paths'
-import {getBlockEndPoint} from '../utils/util.get-block-end-point'
-import {isEqualSelectionPoints} from '../utils/util.is-equal-selection-points'
-import {isSelectionCollapsed} from './selector.is-selection-collapsed'
-
-/**
- * @public
- */
-export function isAtTheEndOfBlock(block: {
-  node: PortableTextBlock
-  path: BlockPath
-}): EditorSelector<boolean> {
-  return (snapshot) => {
-    if (!snapshot.context.selection || !isSelectionCollapsed(snapshot)) {
-      return false
-    }
-
-    const blockEndPoint = getBlockEndPoint({
-      context: snapshot.context,
-      block,
-    })
-
-    return isEqualSelectionPoints(
-      snapshot.context.selection.focus,
-      blockEndPoint,
-    )
-  }
-}